From 4fd4c087d358b362c8c32d12e59d9ca32a006c55 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 20 Aug 2026 02:03:34 +0900 Subject: [PATCH 001/428] =?UTF-8?q?=E5=AE=9E=E7=8E=B0Go=E9=9B=86=E6=88=90?= =?UTF-8?q?=E7=9A=84ftml=E6=B8=B2=E6=9F=93?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 添加了状态目录解析，旧用户密码哈希兼容和边界 --- ftml-sidecar/Cargo.lock | 1005 +++++++++++++++++ ftml-sidecar/Cargo.toml | 9 + ftml-sidecar/src/main.rs | 356 ++++++ ftml/Cargo.toml | 7 +- ftml/src/lib.rs | 1 + go.mod | 3 + internal/password/password.go | 135 +++ internal/password/password_test.go | 213 ++++ internal/paths/paths.go | 131 +++ internal/paths/paths_test.go | 225 ++++ internal/renderer/fake.go | 80 ++ internal/renderer/renderer.go | 119 ++ internal/renderer/renderer_test.go | 128 +++ internal/renderer/sidecar/dispatch.go | 198 ++++ internal/renderer/sidecar/integration_test.go | 130 +++ internal/renderer/sidecar/sidecar.go | 233 ++++ internal/renderer/sidecar/sidecar_test.go | 284 +++++ 17 files changed, 3254 insertions(+), 3 deletions(-) create mode 100644 ftml-sidecar/Cargo.lock create mode 100644 ftml-sidecar/Cargo.toml create mode 100644 ftml-sidecar/src/main.rs create mode 100644 go.mod create mode 100644 internal/password/password.go create mode 100644 internal/password/password_test.go create mode 100644 internal/paths/paths.go create mode 100644 internal/paths/paths_test.go create mode 100644 internal/renderer/fake.go create mode 100644 internal/renderer/renderer.go create mode 100644 internal/renderer/renderer_test.go create mode 100644 internal/renderer/sidecar/dispatch.go create mode 100644 internal/renderer/sidecar/integration_test.go create mode 100644 internal/renderer/sidecar/sidecar.go create mode 100644 internal/renderer/sidecar/sidecar_test.go diff --git a/ftml-sidecar/Cargo.lock b/ftml-sidecar/Cargo.lock new file mode 100644 index 00000000..39416df1 --- /dev/null +++ b/ftml-sidecar/Cargo.lock @@ -0,0 +1,1005 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "aho-corasick" +version = "0.7.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e37cfd5e7657ada45f742d6e99ca5788580b5c529dc78faf11ece6dc702656f" +dependencies = [ + "memchr", +] + +[[package]] +name = "android_system_properties" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "819e7219dbd41043ac279b19830f2efc897156490d7fd6ea916720117ee66311" +dependencies = [ + "libc", +] + +[[package]] +name = "autocfg" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "bitflags" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d5dd14596c0e5b954530d0e6f1fd99b89c03e313aa2086e8da4303701a09e1cf" + +[[package]] +name = "block-buffer" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf7fe51849ea569fd452f37822f606a5cabb684dc918707a0193fd4664ff324" +dependencies = [ + "generic-array", +] + +[[package]] +name = "built" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4f346b6890a0dfa7266974910e7df2d5088120dd54721b9b0e5aae1ae5e05715" +dependencies = [ + "cargo-lock", + "chrono", + "git2", +] + +[[package]] +name = "bumpalo" +version = "3.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d261e256854913907f67ed06efbc3338dfe6179796deefc1ff763fc1aee5535" + +[[package]] +name = "cargo-lock" +version = "7.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c408da54db4c50d4693f7e649c299bc9de9c23ead86249e5368830bb32a734b" +dependencies = [ + "semver", + "serde", + "toml", + "url", +] + +[[package]] +name = "cc" +version = "1.0.73" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2fff2a6927b3bb87f9595d67196a70493f627687a71d87a0d692242c33f58c11" +dependencies = [ + "jobserver", +] + +[[package]] +name = "cfg-if" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" + +[[package]] +name = "chrono" +version = "0.4.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bfd4d1b31faaa3a89d7934dbded3111da0d2ef28e3ebccdb4f0179f5929d1ef1" +dependencies = [ + "iana-time-zone", + "js-sys", + "num-integer", + "num-traits", + "serde", + "time", + "wasm-bindgen", + "winapi", +] + +[[package]] +name = "codespan-reporting" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3538270d33cc669650c4b093848450d380def10c331d38c768e34cac80576e6e" +dependencies = [ + "termcolor", + "unicode-width", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5827cebf4670468b8772dd191856768aedcb1b0278a04f989f7766351917b9dc" + +[[package]] +name = "cpufeatures" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "59a6001667ab124aebae2a495118e11d30984c3a653e99d86d58971708cf5e4b" +dependencies = [ + "libc", +] + +[[package]] +name = "crypto-common" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3" +dependencies = [ + "generic-array", + "typenum", +] + +[[package]] +name = "cxx" +version = "1.0.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "90d59d9acd2a682b4e40605a242f6670eaa58c5957471cbf85e8aa6a0b97a5e8" +dependencies = [ + "cc", + "cxxbridge-flags", + "cxxbridge-macro", + "link-cplusplus", +] + +[[package]] +name = "cxx-build" +version = "1.0.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebfa40bda659dd5c864e65f4c9a2b0aff19bea56b017b9b77c73d3766a453a38" +dependencies = [ + "cc", + "codespan-reporting", + "once_cell", + "proc-macro2", + "quote", + "scratch", + "syn", +] + +[[package]] +name = "cxxbridge-flags" +version = "1.0.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "457ce6757c5c70dc6ecdbda6925b958aae7f959bda7d8fb9bde889e34a09dc03" + +[[package]] +name = "cxxbridge-macro" +version = "1.0.90" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebf883b7aacd7b2aeb2a7b338648ee19f57c140d4ee8e52c68979c6b2f7f2263" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "digest" +version = "0.10.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2fb860ca6fafa5552fb6d0e816a69c8e49f0908bf524e30a90d97c85892d506" +dependencies = [ + "block-buffer", + "crypto-common", +] + +[[package]] +name = "entities" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5320ae4c3782150d900b79807611a59a99fc9a1d61d686faafc24b93fc8d7ca" + +[[package]] +name = "enum-map" +version = "2.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f5a56d54c8dd9b3ad34752ed197a4eb2a6601bc010808eb097a04a58ae4c43e1" +dependencies = [ + "enum-map-derive", +] + +[[package]] +name = "enum-map-derive" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a9045e2676cd5af83c3b167d917b0a5c90a4d8e266e2683d6631b235c457fc27" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "form_urlencoded" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5fc25a87fa4fd2094bffb06925852034d90a17f0d1e05197d4956d3555752191" +dependencies = [ + "matches", + "percent-encoding", +] + +[[package]] +name = "ftml" +version = "1.16.3" +dependencies = [ + "bitflags 2.0.1", + "built", + "cfg-if", + "chrono", + "entities", + "enum-map", + "getrandom", + "lazy_static", + "log", + "maplit", + "md5", + "pest", + "pest_derive", + "rand", + "ref-map", + "regex", + "self_cell", + "serde", + "serde_json", + "serde_repr", + "str-macro", + "strum", + "strum_macros", + "tinyvec", + "unicase", + "void", + "wasm-bindgen", + "web-sys", + "wikidot-normalize", +] + +[[package]] +name = "ftml-sidecar" +version = "0.1.0" +dependencies = [ + "ftml", + "serde_json", +] + +[[package]] +name = "generic-array" +version = "0.14.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd48d33ec7f05fbfa152300fdad764757cbded343c1aa1cff2fbaf4134851803" +dependencies = [ + "typenum", + "version_check", +] + +[[package]] +name = "getrandom" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4eb1a864a501629691edf6c15a593b7a51eebaa1e8468e9ddc623de7c9b58ec6" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "wasi 0.11.0+wasi-snapshot-preview1", + "wasm-bindgen", +] + +[[package]] +name = "git2" +version = "0.13.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f29229cc1b24c0e6062f6e742aa3e256492a5323365e5ed3413599f8a5eff7d6" +dependencies = [ + "bitflags 1.3.2", + "libc", + "libgit2-sys", + "log", + "url", +] + +[[package]] +name = "heck" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2540771e65fc8cb83cd6e8a237f70c319bd5c29f78ed1084ba5d50eeac86f7f9" + +[[package]] +name = "iana-time-zone" +version = "0.1.53" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "64c122667b287044802d6ce17ee2ddf13207ed924c712de9a66a5814d5b64765" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "wasm-bindgen", + "winapi", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0703ae284fc167426161c2e3f1da3ea71d94b21bedbcc9494e92b28e334e3dca" +dependencies = [ + "cxx", + "cxx-build", +] + +[[package]] +name = "idna" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "418a0a6fab821475f634efe3ccc45c013f742efe03d853e8d3355d5cb850ecf8" +dependencies = [ + "matches", + "unicode-bidi", + "unicode-normalization", +] + +[[package]] +name = "itoa" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "112c678d4050afce233f4f2852bb2eb519230b3cf12f33585275537d7e41578d" + +[[package]] +name = "jobserver" +version = "0.1.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af25a77299a7f711a01975c35a6a424eb6862092cc2d6c72c4ed6cbc56dfc1fa" +dependencies = [ + "libc", +] + +[[package]] +name = "js-sys" +version = "0.3.59" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "258451ab10b34f8af53416d1fdab72c22e805f0c92a1136d59470ec0b11138b2" +dependencies = [ + "wasm-bindgen", +] + +[[package]] +name = "lazy_static" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" + +[[package]] +name = "libc" +version = "0.2.126" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "349d5a591cd28b49e1d1037471617a32ddcda5731b99419008085f72d5a53836" + +[[package]] +name = "libgit2-sys" +version = "0.12.26+1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "19e1c899248e606fbfe68dcb31d8b0176ebab833b103824af31bddf4b7457494" +dependencies = [ + "cc", + "libc", + "libz-sys", + "pkg-config", +] + +[[package]] +name = "libz-sys" +version = "1.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9702761c3935f8cc2f101793272e202c72b99da8f4224a19ddcf1279a6450bbf" +dependencies = [ + "cc", + "libc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "link-cplusplus" +version = "1.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ecd207c9c713c34f95a097a5b029ac2ce6010530c7b49d7fea24d977dede04f5" +dependencies = [ + "cc", +] + +[[package]] +name = "log" +version = "0.4.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "abb12e687cfb44aa40f41fc3978ef76448f9b6038cad6aef4259d3c095a2382e" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "maplit" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e2e65a1a2e43cfcb47a895c4c8b10d1f4a61097f9f254f183aee60cad9c651d" + +[[package]] +name = "matches" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3e378b66a060d48947b590737b30a1be76706c8dd7b8ba0f2fe3989c68a853f" + +[[package]] +name = "md5" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "490cc448043f947bae3cbee9c203358d62dbee0db12107a74be5c30ccfd09771" + +[[package]] +name = "memchr" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" + +[[package]] +name = "num-integer" +version = "0.1.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "225d3389fb3509a24c93f5c29eb6bde2586b98d9f016636dff58d7c6f7569cd9" +dependencies = [ + "autocfg", + "num-traits", +] + +[[package]] +name = "num-traits" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "578ede34cf02f8924ab9447f50c28075b4d3e5b269972345e7e0372b38c6cdcd" +dependencies = [ + "autocfg", +] + +[[package]] +name = "once_cell" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "18a6dbe30758c9f83eb00cbea4ac95966305f5a7772f3f42ebfc7fc7eddbd8e1" + +[[package]] +name = "percent-encoding" +version = "2.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d4fd5641d01c8f18a23da7b6fe29298ff4b55afcccdf78973b24cf3175fee32e" + +[[package]] +name = "pest" +version = "2.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "69486e2b8c2d2aeb9762db7b4e00b0331156393555cff467f4163ff06821eef8" +dependencies = [ + "thiserror", + "ucd-trie", +] + +[[package]] +name = "pest_derive" +version = "2.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b13570633aff33c6d22ce47dd566b10a3b9122c2fe9d8e7501895905be532b91" +dependencies = [ + "pest", + "pest_generator", +] + +[[package]] +name = "pest_generator" +version = "2.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b3c567e5702efdc79fb18859ea74c3eb36e14c43da7b8c1f098a4ed6514ec7a0" +dependencies = [ + "pest", + "pest_meta", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "pest_meta" +version = "2.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5eb32be5ee3bbdafa8c7a18b0a8a8d962b66cfa2ceee4037f49267a50ee821fe" +dependencies = [ + "once_cell", + "pest", + "sha-1", +] + +[[package]] +name = "pkg-config" +version = "0.3.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1df8c4ec4b0627e53bdf214615ad287367e482558cf84b109250b37464dc03ae" + +[[package]] +name = "ppv-lite86" +version = "0.2.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eb9f9e6e233e5c4a35559a617bf40a4ec447db2e84c20b55a6f83167b7e57872" + +[[package]] +name = "proc-macro2" +version = "1.0.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd96a1e8ed2596c337f8eae5f24924ec83f5ad5ab21ea8e455d3566c69fbcaf7" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3bcdf212e9776fbcb2d23ab029360416bb1706b1aea2d1a5ba002727cbcab804" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "rand" +version = "0.8.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404" +dependencies = [ + "libc", + "rand_chacha", + "rand_core", +] + +[[package]] +name = "rand_chacha" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" +dependencies = [ + "ppv-lite86", + "rand_core", +] + +[[package]] +name = "rand_core" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d34f1408f55294453790c48b2f1ebbb1c5b4b7563eb1f418bcfcfdbb06ebb4e7" +dependencies = [ + "getrandom", +] + +[[package]] +name = "ref-map" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d22b73985e369f260445a5e08ad470117b30e522c91b4820585baa2e0cbf7075" + +[[package]] +name = "regex" +version = "1.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c4eb3267174b8c6c2f654116623910a0fef09c4753f8dd83db29c48a0df988b" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.6.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3f87b73ce11b1619a3c6332f45341e0047173771e8b8b73f87bfeefb7b56244" + +[[package]] +name = "rustversion" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a0a5f7c728f5d284929a1cccb5bc19884422bfe6ef4d6c409da2c41838983fcf" + +[[package]] +name = "ryu" +version = "1.0.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3f6f92acf49d1b98f7a81226834412ada05458b7364277387724a237f062695" + +[[package]] +name = "scratch" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ddccb15bcce173023b3fedd9436f882a0739b8dfb45e4f6b6002bee5929f61b2" + +[[package]] +name = "self_cell" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16c2f82143577edb4921b71ede051dac62ca3c16084e918bf7b40c96ae10eb33" + +[[package]] +name = "semver" +version = "1.0.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2333e6df6d6598f2b1974829f853c2b4c5f4a6e503c10af918081aa6f8564e1" +dependencies = [ + "serde", +] + +[[package]] +name = "serde" +version = "1.0.143" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53e8e5d5b70924f74ff5c6d64d9a5acd91422117c60f48c4e07855238a254553" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.143" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3d8e8de557aee63c26b85b947f5e59b690d0454c753f3adeb5cd7835ab88391" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "serde_json" +version = "1.0.83" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38dd04e3c8279e75b31ef29dbdceebfe5ad89f4d0937213c53f7d49d01b3d5a7" +dependencies = [ + "itoa", + "ryu", + "serde", +] + +[[package]] +name = "serde_repr" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fe39d9fbb0ebf5eb2c7cb7e2a47e4f462fad1379f1166b8ae49ad9eae89a7ca" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "sha-1" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "028f48d513f9678cda28f6e4064755b3fbb2af6acd672f2c209b62323f7aea0f" +dependencies = [ + "cfg-if", + "cpufeatures", + "digest", +] + +[[package]] +name = "str-macro" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b7514866270741c7b03dd36e2c68f71cf064b230e8217c81bbd4d619d564864" + +[[package]] +name = "strum" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "063e6045c0e62079840579a7e47a355ae92f60eb74daaf156fb1e84ba164e63f" + +[[package]] +name = "strum_macros" +version = "0.24.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e385be0d24f186b4ce2f9982191e7101bb737312ad61c1f2f984f34bcf85d59" +dependencies = [ + "heck", + "proc-macro2", + "quote", + "rustversion", + "syn", +] + +[[package]] +name = "syn" +version = "1.0.98" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c50aef8a904de4c23c788f104b7dddc7d6f79c647c7c8ce4cc8f73eb0ca773dd" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "termcolor" +version = "1.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bab24d30b911b2376f3a13cc2cd443142f0c81dda04c118693e35b3835757755" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "thiserror" +version = "1.0.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd829fe32373d27f76265620b5309d0340cb8550f523c1dda251d6298069069a" +dependencies = [ + "thiserror-impl", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0396bc89e626244658bef819e22d0cc459e795a5ebe878e6ec336d1674a8d79a" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "time" +version = "0.1.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6db9e6914ab8b1ae1c260a4ae7a49b6c5611b40328a735b21862567685e73255" +dependencies = [ + "libc", + "wasi 0.10.0+wasi-snapshot-preview1", + "winapi", +] + +[[package]] +name = "tinyvec" +version = "1.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87cc5ceb3875bb20c2890005a4e226a4651264a5c75edb2421b52861a0a0cb50" +dependencies = [ + "tinyvec_macros", +] + +[[package]] +name = "tinyvec_macros" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cda74da7e1a664f795bb1f8a87ec406fb89a02522cf6e50620d016add6dbbf5c" + +[[package]] +name = "toml" +version = "0.5.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8d82e1a7758622a465f8cee077614c73484dac5b836c02ff6a40d5d1010324d7" +dependencies = [ + "serde", +] + +[[package]] +name = "trim-in-place" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "343e926fc669bc8cde4fa3129ab681c63671bae288b1f1081ceee6d9d37904fc" + +[[package]] +name = "typenum" +version = "1.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dcf81ac59edc17cc8697ff311e8f5ef2d99fcbd9817b34cec66f90b6c3dfd987" + +[[package]] +name = "ucd-trie" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "89570599c4fe5585de2b388aab47e99f7fa4e9238a1399f707a02e356058141c" + +[[package]] +name = "unicase" +version = "2.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50f37be617794602aabbeee0be4f259dc1778fabe05e2d67ee8f79326d5cb4f6" +dependencies = [ + "version_check", +] + +[[package]] +name = "unicode-bidi" +version = "0.3.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "099b7128301d285f79ddd55b9a83d5e6b9e97c92e0ea0daebee7263e932de992" + +[[package]] +name = "unicode-ident" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5bd2fe26506023ed7b5e1e315add59d6f584c621d037f9368fea9cfb988f368c" + +[[package]] +name = "unicode-normalization" +version = "0.1.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "854cbdc4f7bc6ae19c820d44abdc3277ac3e1b2b93db20a636825d9322fb60e6" +dependencies = [ + "tinyvec", +] + +[[package]] +name = "unicode-width" +version = "0.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0edd1e5b14653f783770bce4a4dabb4a5108a5370a5f5d8cfe8710c361f6c8b" + +[[package]] +name = "url" +version = "2.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a507c383b2d33b5fc35d1861e77e6b383d158b2da5e14fe51b83dfedf6fd578c" +dependencies = [ + "form_urlencoded", + "idna", + "matches", + "percent-encoding", +] + +[[package]] +name = "vcpkg" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" + +[[package]] +name = "version_check" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" + +[[package]] +name = "void" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6a02e4885ed3bc0f2de90ea6dd45ebcbb66dacffe03547fadbb0eeae2770887d" + +[[package]] +name = "wasi" +version = "0.10.0+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a143597ca7c7793eff794def352d41792a93c481eb1042423ff7ff72ba2c31f" + +[[package]] +name = "wasi" +version = "0.11.0+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" + +[[package]] +name = "wasm-bindgen" +version = "0.2.82" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc7652e3f6c4706c8d9cd54832c4a4ccb9b5336e2c3bd154d5cccfbf1c1f5f7d" +dependencies = [ + "cfg-if", + "serde", + "serde_json", + "wasm-bindgen-macro", +] + +[[package]] +name = "wasm-bindgen-backend" +version = "0.2.82" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "662cd44805586bd52971b9586b1df85cdbbd9112e4ef4d8f41559c334dc6ac3f" +dependencies = [ + "bumpalo", + "log", + "once_cell", + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.82" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b260f13d3012071dfb1512849c033b1925038373aea48ced3012c09df952c602" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.82" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5be8e654bdd9b79216c2929ab90721aa82faf65c48cdf08bdc4e7f51357b80da" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-backend", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.82" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6598dd0bd3c7d51095ff6531a5b23e02acdc81804e30d8f07afb77b7215a140a" + +[[package]] +name = "web-sys" +version = "0.3.59" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed055ab27f941423197eb86b2035720b1a3ce40504df082cac2ecc6ed73335a1" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "wikidot-normalize" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6fb8a6e16ee5d9b390282f1544e7634b4162694e72203ec8a84d63c0695ea97a" +dependencies = [ + "lazy_static", + "maplit", + "regex", + "trim-in-place", + "unicode-normalization", +] + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178" +dependencies = [ + "winapi", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" diff --git a/ftml-sidecar/Cargo.toml b/ftml-sidecar/Cargo.toml new file mode 100644 index 00000000..47f3f3d2 --- /dev/null +++ b/ftml-sidecar/Cargo.toml @@ -0,0 +1,9 @@ +[package] +name = "ftml-sidecar" +version = "0.1.0" +edition = "2021" +publish = false + +[dependencies] +ftml = { path = "../ftml", default-features = false, features = ["html"] } +serde_json = "1" diff --git a/ftml-sidecar/src/main.rs b/ftml-sidecar/src/main.rs new file mode 100644 index 00000000..0d78cd49 --- /dev/null +++ b/ftml-sidecar/src/main.rs @@ -0,0 +1,356 @@ +use std::borrow::Cow; +use std::cell::RefCell; +use std::collections::HashMap; +use std::fmt::{self, Debug, Formatter}; +use std::io::{self, BufReader, Read, Stdin, Stdout, Write}; +use std::rc::Rc; + +use ftml::data::{ExpressionResult, PageCallbacks, PageInfo, PageRef, PartialPageInfo}; +use ftml::includes::{FetchedPage, IncludeRef, Includer}; +use ftml::prelude::remove_noincludes; +use ftml::render::html::HtmlRender; +use ftml::render::text::TextRender; +use ftml::render::Render; +use ftml::settings::{WikitextMode, WikitextSettings}; +use ftml::{include, parse, preprocess, tokenize}; +use serde_json::{json, Map, Value}; + +fn write_msg(w: &mut W, v: &Value) -> io::Result<()> { + let buf = serde_json::to_vec(v).map_err(io::Error::other)?; + let len = u32::try_from(buf.len()).map_err(io::Error::other)?; + w.write_all(&len.to_be_bytes())?; + w.write_all(&buf)?; + w.flush() +} + +fn read_msg(r: &mut R) -> io::Result> { + let mut len = [0u8; 4]; + match r.read_exact(&mut len) { + Ok(()) => {} + Err(e) if e.kind() == io::ErrorKind::UnexpectedEof => return Ok(None), + Err(e) => return Err(e), + } + let mut buf = vec![0u8; u32::from_be_bytes(len) as usize]; + r.read_exact(&mut buf)?; + serde_json::from_slice(&buf) + .map(Some) + .map_err(io::Error::other) +} + +struct Bridge { + input: RefCell>, + output: RefCell, +} + +impl Debug for Bridge { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + write!(f, "") + } +} + +impl Bridge { + fn new() -> Self { + Self { + input: RefCell::new(BufReader::new(io::stdin())), + output: RefCell::new(io::stdout()), + } + } + + fn recv(&self) -> Option { + read_msg(&mut *self.input.borrow_mut()).expect("读入站消息失败") + } + + fn send(&self, v: &Value) { + write_msg(&mut *self.output.borrow_mut(), v).expect("写出站消息失败"); + } + + fn call(&self, method: &str, args: Value) -> Value { + self.send(&json!({"type": "callback", "method": method, "args": args})); + let reply = self.recv().expect("宿主在回调应答前关闭了连接"); + match reply.get("type").and_then(Value::as_str) { + Some("callback_result") => reply.get("value").cloned().unwrap_or(Value::Null), + other => panic!("回调 {method}: type = {other:?}，期望 callback_result"), + } + } + + fn call_str(&self, method: &str, args: Value) -> Cow<'static, str> { + Cow::Owned( + self.call(method, args) + .as_str() + .unwrap_or_default() + .to_owned(), + ) + } + + fn next_include_level(&self) { + self.call("next_include_level", json!({})); + } +} + +impl PageCallbacks for Bridge { + fn module_has_body(&self, module_name: Cow) -> bool { + self.call("module_has_body", json!({ "name": module_name })) + .as_bool() + .unwrap_or(false) + } + + fn render_module( + &self, + module_name: Cow, + params: HashMap, Cow>, + body: Cow, + ) -> Cow<'static, str> { + let params: Map = params + .iter() + .map(|(k, v)| (k.to_string(), Value::String(v.to_string()))) + .collect(); + self.call_str( + "render_module", + json!({"name": module_name, "params": params, "body": body}), + ) + } + + fn render_user(&self, user: Cow, avatar: bool) -> Cow<'static, str> { + self.call_str("render_user", json!({"user": user, "avatar": avatar})) + } + + fn get_i18n_message(&self, message_id: Cow) -> Cow<'static, str> { + self.call_str("get_i18n_message", json!({ "id": message_id })) + } + + fn get_html_injected_code(&self, html_id: Cow) -> Cow<'static, str> { + self.call_str("get_html_injected_code", json!({ "id": html_id })) + } + + fn get_page_info(&self, page_refs: &Vec>) -> Vec> { + let names: Vec = page_refs.iter().map(PageRef::to_string).collect(); + let reply = self.call("get_page_info", json!({ "refs": names })); + + let mut out = Vec::new(); + for item in reply.as_array().map(Vec::as_slice).unwrap_or_default() { + let full_name = item.get("full_name").and_then(Value::as_str).unwrap_or(""); + let Some(idx) = names.iter().position(|n| n == full_name) else { + continue; + }; + out.push(PartialPageInfo { + page_ref: page_refs[idx].to_owned(), + title: item + .get("title") + .and_then(Value::as_str) + .map(|s| Cow::Owned(s.to_owned())), + exists: item.get("exists").and_then(Value::as_bool).unwrap_or(false), + }); + } + out + } + + fn evaluate_expression(&self, expression: Cow) -> ExpressionResult<'static> { + let reply = self.call("evaluate_expression", json!({ "expr": expression })); + match reply.get("kind").and_then(Value::as_str) { + Some("string") => ExpressionResult::String(Cow::Owned( + reply + .get("str") + .and_then(Value::as_str) + .unwrap_or_default() + .to_owned(), + )), + Some("bool") => { + ExpressionResult::Bool(reply.get("bool").and_then(Value::as_bool).unwrap_or(false)) + } + Some("float") => { + ExpressionResult::Float(reply.get("float").and_then(Value::as_f64).unwrap_or(0.0)) + } + Some("int") => { + ExpressionResult::Int(reply.get("int").and_then(Value::as_i64).unwrap_or(0)) + } + _ => ExpressionResult::None, + } + } + + fn normalize_page_name(&self, full_name: Cow) -> Cow<'static, str> { + self.call_str("normalize_page_name", json!({ "full_name": full_name })) + } +} + +struct BridgeIncluder<'b>(&'b Bridge); + +impl<'t, 'b> Includer<'t> for BridgeIncluder<'b> { + type Error = io::Error; + + fn include_pages( + &mut self, + includes: &[IncludeRef<'t>], + ) -> Result>, Self::Error> { + let refs: Vec = includes + .iter() + .map(|inc| { + let vars: Map = inc + .variables() + .iter() + .map(|(k, v)| (k.to_string(), Value::String(v.to_string()))) + .collect(); + json!({"full_name": inc.page_ref().to_string(), "variables": vars}) + }) + .collect(); + + let reply = self.0.call("include_pages", json!({ "includes": refs })); + let items = reply.as_array().map(Vec::as_slice).unwrap_or_default(); + + let mut out = Vec::with_capacity(includes.len()); + for inc in includes { + let name = inc.page_ref().to_string(); + let found = items + .iter() + .find(|it| it.get("full_name").and_then(Value::as_str) == Some(name.as_str())); + out.push(FetchedPage { + page_ref: inc.page_ref().clone(), + content: found + .and_then(|it| it.get("content")) + .and_then(Value::as_str) + .map(|s| Cow::Owned(s.to_owned())), + }); + } + Ok(out) + } + + fn no_such_include(&mut self, page_ref: &PageRef<'t>) -> Result, Self::Error> { + Ok(Cow::Owned( + self.0 + .call_str("no_such_include", json!({"full_name": page_ref.to_string()})) + .into_owned(), + )) + } +} + +fn page_info_from(v: &Value) -> PageInfo<'static> { + let s = |k: &str| -> String { + v.get(k) + .and_then(Value::as_str) + .unwrap_or_default() + .to_owned() + }; + let opt = |k: &str| -> Option { + v.get(k) + .and_then(Value::as_str) + .filter(|x| !x.is_empty()) + .map(str::to_owned) + }; + + let domain = s("domain"); + let page = s("page"); + let site = opt("site") + .unwrap_or_else(|| domain.split('.').next().unwrap_or_default().to_owned()); + + PageInfo { + page: Cow::Owned(page.clone()), + category: Some(Cow::Owned(s("category"))), + site: Cow::Owned(site), + domain: Cow::Owned(domain.clone()), + media_domain: Cow::Owned(opt("media_domain").unwrap_or(domain)), + title: Cow::Owned(opt("title").unwrap_or(page)), + alt_title: None, + rating: v.get("rating").and_then(Value::as_f64).unwrap_or(0.0), + tags: v + .get("tags") + .and_then(Value::as_array) + .map(|a| { + a.iter() + .filter_map(Value::as_str) + .map(|t| Cow::Owned(t.to_owned())) + .collect() + }) + .unwrap_or_default(), + language: Cow::Owned(opt("language").unwrap_or_else(|| "default".to_owned())), + } +} + +fn wikitext_mode(mode: &str) -> WikitextMode { + match mode { + "article" => WikitextMode::Page, + "message" => WikitextMode::ForumPost, + "inline" => WikitextMode::Inline, + "system" => WikitextMode::System, + "system-with-modules" => WikitextMode::SystemWithModules, + _ => WikitextMode::Page, + } +} + +struct Rendered { + output: O, + included_pages: Vec, + linked_pages: Vec, + code: Vec<(String, String)>, + html: Vec, +} + +fn drive( + source: &str, + renderer: &R, + info: &PageInfo, + bridge: Rc, + mode: WikitextMode, +) -> Rendered { + let mut settings = WikitextSettings::from_mode(mode); + settings.use_include_compatibility = true; + + let mut included_text = source.to_owned(); + let mut included_pages: Vec = Vec::new(); + loop { + bridge.next_include_level(); + let mut current = included_text; + preprocess(&mut current); + let allowed = remove_noincludes(¤t); + let (text, pages) = include(&allowed, &settings, BridgeIncluder(&bridge), || { + panic!("Bad includer return") + }) + .unwrap_or((current.clone(), vec![])); + included_text = text; + included_pages.extend(pages.iter().map(PageRef::to_string)); + if pages.is_empty() { + break; + } + } + + let mut text = included_text.clone(); + let tokens = tokenize(&mut text); + let (tree, _warnings) = parse(&tokens, info, bridge.clone(), &settings).into(); + let output = renderer.render(&tree, info, bridge, &settings); + + Rendered { + linked_pages: tree.internal_links.iter().map(PageRef::to_string).collect(), + code: tree.code.clone(), + html: tree.html.clone(), + output, + included_pages, + } +} + +fn main() { + let bridge = Rc::new(Bridge::new()); + + while let Some(msg) = bridge.recv() { + if msg.get("type").and_then(Value::as_str) != Some("render") { + bridge.send(&json!({"type": "error", "message": "期望 type = render"})); + continue; + } + + let source = msg.get("source").and_then(Value::as_str).unwrap_or_default(); + let info = page_info_from(msg.get("page_info").unwrap_or(&Value::Null)); + let mode = wikitext_mode(msg.get("mode").and_then(Value::as_str).unwrap_or("article")); + let op = msg.get("op").and_then(Value::as_str).unwrap_or("html"); + + let reply = match op { + "text" => { + let r = drive(source, &TextRender, &info, bridge.clone(), mode); + json!({"type": "result", "body": r.output, "included_pages": r.included_pages, + "linked_pages": r.linked_pages, "code": r.code, "html": r.html}) + } + _ => { + let r = drive(source, &HtmlRender, &info, bridge.clone(), mode); + json!({"type": "result", "body": r.output.body, "included_pages": r.included_pages, + "linked_pages": r.linked_pages, "code": r.code, "html": r.html}) + } + }; + bridge.send(&reply); + } +} diff --git a/ftml/Cargo.toml b/ftml/Cargo.toml index 7df63430..1ed68b4f 100644 --- a/ftml/Cargo.toml +++ b/ftml/Cargo.toml @@ -14,10 +14,11 @@ edition = "2021" # this is *not* the same as the current year [lib] name = "ftml" -crate-type = ["cdylib", "lib"] +crate-type = ["staticlib", "cdylib", "lib"] [features] -default = ["html"] +default = ["html", "python"] +python = ["pyo3"] # Adds HTML rendering. html = [] # Adds LaTeX -> MathML support for rendering. @@ -36,7 +37,7 @@ maplit = "1" md5 = "0.7.0" pest = "2" pest_derive = "2" -pyo3 = { version = "0.16.5", features = ["extension-module"] } +pyo3 = { version = "0.16.5", features = ["extension-module"], optional = true } rand = { version = "0.8", features = ["small_rng"] } ref-map = "0.1" regex = "1" diff --git a/ftml/src/lib.rs b/ftml/src/lib.rs index bace9555..21298797 100644 --- a/ftml/src/lib.rs +++ b/ftml/src/lib.rs @@ -110,6 +110,7 @@ extern crate str_macro; #[macro_use] mod macros; +#[cfg(feature = "python")] mod python_interface; mod id_prefix; mod next_index; diff --git a/go.mod b/go.mod new file mode 100644 index 00000000..d1a47199 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/WikitTeam/ProjectWikit + +go 1.26 diff --git a/internal/password/password.go b/internal/password/password.go new file mode 100644 index 00000000..c6273324 --- /dev/null +++ b/internal/password/password.go @@ -0,0 +1,135 @@ +package password + +import ( + "crypto/pbkdf2" + "crypto/rand" + "crypto/sha256" + "crypto/subtle" + "encoding/base64" + "errors" + "fmt" + "strconv" + "strings" +) + +const ( + Algorithm = "pbkdf2_sha256" + DefaultIterations = 1000000 +) + +const ( + saltLength = 12 + saltChars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" + unusablePrefix = "!" +) + +var ( + ErrMalformed = errors.New("密码哈希格式不正确") + ErrUnsupported = errors.New("不支持的密码哈希算法") +) + +type parsed struct { + iterations int + salt string + digest []byte +} + +func IsUsable(encoded string) bool { + return !strings.HasPrefix(encoded, unusablePrefix) +} + +func Verify(plain, encoded string) (bool, error) { + if !IsUsable(encoded) { + return false, nil + } + p, err := parse(encoded) + if err != nil { + return false, err + } + got, err := derive(plain, p.salt, p.iterations) + if err != nil { + return false, err + } + return subtle.ConstantTimeCompare(got, p.digest) == 1, nil +} + +func Hash(plain string) (string, error) { + salt, err := newSalt() + if err != nil { + return "", err + } + return encode(plain, salt, DefaultIterations) +} + +func NeedsRehash(encoded string) bool { + if !IsUsable(encoded) { + return false + } + p, err := parse(encoded) + if err != nil { + return true + } + return p.iterations != DefaultIterations +} + +func parse(encoded string) (parsed, error) { + if encoded == "" { + return parsed{}, fmt.Errorf("%w: 空字符串", ErrMalformed) + } + parts := strings.SplitN(encoded, "$", 4) + if parts[0] != Algorithm { + return parsed{}, fmt.Errorf("%w: %q", ErrUnsupported, parts[0]) + } + if len(parts) != 4 { + return parsed{}, fmt.Errorf("%w: 期望 4 段，得到 %d 段", ErrMalformed, len(parts)) + } + iterations, err := strconv.Atoi(parts[1]) + if err != nil || iterations < 1 { + return parsed{}, fmt.Errorf("%w: 迭代次数 %q", ErrMalformed, parts[1]) + } + if parts[2] == "" { + return parsed{}, fmt.Errorf("%w: salt 为空", ErrMalformed) + } + digest, err := base64.StdEncoding.DecodeString(parts[3]) + if err != nil { + return parsed{}, fmt.Errorf("%w: 哈希段不是合法 base64: %v", ErrMalformed, err) + } + return parsed{iterations: iterations, salt: parts[2], digest: digest}, nil +} + +func encode(plain, salt string, iterations int) (string, error) { + if salt == "" || strings.Contains(salt, "$") { + return "", fmt.Errorf("%w: salt %q 不可为空且不可含 $", ErrMalformed, salt) + } + digest, err := derive(plain, salt, iterations) + if err != nil { + return "", err + } + return strings.Join([]string{ + Algorithm, + strconv.Itoa(iterations), + salt, + base64.StdEncoding.EncodeToString(digest), + }, "$"), nil +} + +func derive(plain, salt string, iterations int) ([]byte, error) { + return pbkdf2.Key(sha256.New, plain, []byte(salt), iterations, sha256.Size) +} + +func newSalt() (string, error) { + limit := byte(256 - 256%len(saltChars)) + out := make([]byte, 0, saltLength) + buf := make([]byte, saltLength) + for len(out) < saltLength { + if _, err := rand.Read(buf); err != nil { + return "", fmt.Errorf("生成 salt 失败: %w", err) + } + for _, b := range buf { + if b < limit && len(out) < saltLength { + out = append(out, saltChars[int(b)%len(saltChars)]) + } + } + } + return string(out), nil +} diff --git a/internal/password/password_test.go b/internal/password/password_test.go new file mode 100644 index 00000000..66f4aaa6 --- /dev/null +++ b/internal/password/password_test.go @@ -0,0 +1,213 @@ +package password + +import ( + "errors" + "strings" + "testing" +) + +var djangoVectors = []struct { + plain string + encoded string +}{ + {plain: "correcthorsebatterystaple", encoded: "pbkdf2_sha256$1000$abcdefghijkl$M2T6/VMpP+pv6574Q6rE1HZjkIlFvhvAWQlQFfgUncY="}, + {plain: "p", encoded: "pbkdf2_sha256$1$0123456789ab$ZYeXRJ1IKaitaR+tVMtfwRoaCmtfvWEeGZKPuEHE55w="}, + {plain: "", encoded: "pbkdf2_sha256$100$saltsaltsalt$0dnkxOdo5UI8+lv6MjQ8bizY4JHzDAy3XnoP9bTdlbI="}, + {plain: "密码带中文", encoded: "pbkdf2_sha256$5000$zZ9aA0bB1cC2$AkWlqnlCcYg6ztQSFkj/YOqgMPaLxBgkjEOFSvcL01I="}, + {plain: "emoji😀pw", encoded: "pbkdf2_sha256$260000$qwertyuiopas$Jqj65m/ULEd6isdZMIhEbtRX78bl3yCtXZfdDFbpo9w="}, + {plain: "has$dollar", encoded: "pbkdf2_sha256$1000000$AAAAAAAAAAAA$/JBeAbrjboPXQutZ0T/2o6tweC7dZlPwNHYsJbtX0ow="}, + {plain: strings.Repeat("x", 200), encoded: "pbkdf2_sha256$12345$longpassword$yzqzDvqr/T9CJtexJxNc2dH7YtwOFoYUAom3dauirMA="}, +} + +func TestVerifyAcceptsDjangoHashes(t *testing.T) { + for _, v := range djangoVectors { + ok, err := Verify(v.plain, v.encoded) + if err != nil { + t.Errorf("Verify(%q) err = %v，期望 nil", v.plain, err) + continue + } + if !ok { + t.Errorf("Verify(%q) = false，期望 true", v.plain) + } + } +} + +func TestVerifyRejectsWrongPassword(t *testing.T) { + for _, v := range djangoVectors { + ok, err := Verify(v.plain+"x", v.encoded) + if err != nil { + t.Errorf("Verify(%q+x) err = %v，期望 nil", v.plain, err) + continue + } + if ok { + t.Errorf("Verify(%q+x) = true，期望 false", v.plain) + } + } +} + +func TestVerifyRejectsTamperedFields(t *testing.T) { + v := djangoVectors[0] + parts := strings.Split(v.encoded, "$") + + tampered := []struct { + name string + encoded string + }{ + {"迭代次数被改", strings.Join([]string{parts[0], "1001", parts[2], parts[3]}, "$")}, + {"salt 被改", strings.Join([]string{parts[0], parts[1], "abcdefghijkm", parts[3]}, "$")}, + } + for _, tt := range tampered { + t.Run(tt.name, func(t *testing.T) { + ok, err := Verify(v.plain, tt.encoded) + if err != nil { + t.Fatalf("Verify() err = %v，期望 nil", err) + } + if ok { + t.Error("Verify() = true，期望 false") + } + }) + } +} + +func TestHashRoundTrip(t *testing.T) { + for _, plain := range []string{"", "p", "密码带中文", "emoji😀pw", "has$dollar", strings.Repeat("x", 200)} { + encoded, err := Hash(plain) + if err != nil { + t.Fatalf("Hash(%q) err = %v，期望 nil", plain, err) + } + ok, err := Verify(plain, encoded) + if err != nil { + t.Fatalf("Verify(%q) err = %v，期望 nil", plain, err) + } + if !ok { + t.Errorf("Verify(%q, Hash(%q)) = false，期望 true", plain, plain) + } + if ok, _ := Verify(plain+"x", encoded); ok { + t.Errorf("Verify(%q+x, Hash(%q)) = true，期望 false", plain, plain) + } + } +} + +func TestHashOutputMatchesDjangoFormat(t *testing.T) { + encoded, err := Hash("pw") + if err != nil { + t.Fatal(err) + } + + parts := strings.Split(encoded, "$") + if len(parts) != 4 { + t.Fatalf("段数 = %d，期望 4：%q", len(parts), encoded) + } + if parts[0] != Algorithm { + t.Errorf("算法 = %q，期望 %q", parts[0], Algorithm) + } + if parts[1] != "1000000" { + t.Errorf("迭代次数 = %q，期望 %d", parts[1], DefaultIterations) + } + if len(parts[2]) != saltLength { + t.Errorf("len(salt) = %d，期望 %d", len(parts[2]), saltLength) + } + for _, c := range parts[2] { + if !strings.ContainsRune(saltChars, c) { + t.Errorf("salt = %q，含 saltChars 之外的字符 %q", parts[2], c) + } + } +} + +func TestHashSaltIsUnique(t *testing.T) { + seen := make(map[string]bool) + for range 20 { + encoded, err := Hash("pw") + if err != nil { + t.Fatal(err) + } + salt := strings.Split(encoded, "$")[2] + if seen[salt] { + t.Fatalf("salt = %q，与前一次生成的重复", salt) + } + seen[salt] = true + } +} + +func TestVerifyUnusablePassword(t *testing.T) { + for _, encoded := range []string{"!", "!xyzzy", "!" + djangoVectors[0].encoded} { + if IsUsable(encoded) { + t.Errorf("IsUsable(%q) = true，期望 false", encoded) + } + ok, err := Verify(djangoVectors[0].plain, encoded) + if err != nil { + t.Errorf("Verify(%q) err = %v，期望 nil", encoded, err) + } + if ok { + t.Errorf("Verify(%q) = true，期望 false", encoded) + } + } +} + +func TestVerifyRejectsMalformed(t *testing.T) { + malformed := []string{ + "", + "pbkdf2_sha256", + "pbkdf2_sha256$1000", + "pbkdf2_sha256$1000$salt", + "pbkdf2_sha256$abc$salt$aGFzaA==", + "pbkdf2_sha256$0$salt$aGFzaA==", + "pbkdf2_sha256$-1$salt$aGFzaA==", + "pbkdf2_sha256$1000$$aGFzaA==", + "pbkdf2_sha256$1000$salt$不是base64", + } + for _, encoded := range malformed { + ok, err := Verify("pw", encoded) + if ok { + t.Errorf("Verify(%q) = true，期望 false", encoded) + } + if !errors.Is(err, ErrMalformed) { + t.Errorf("Verify(%q) err = %v，期望 ErrMalformed", encoded, err) + } + } +} + +func TestVerifyRejectsOtherAlgorithms(t *testing.T) { + others := []string{ + "argon2$argon2id$v=19$m=102400,t=2,p=8$c2FsdA$aGFzaA", + "bcrypt_sha256$$2b$12$saltsaltsaltsaltsaltsuhash", + "md5$salt$5f4dcc3b5aa765d61d8327deb882cf99", + "pbkdf2_sha1$260000$salt$aGFzaA==", + "scrypt$16384$salt$8$1$aGFzaA==", + } + for _, encoded := range others { + ok, err := Verify("pw", encoded) + if ok { + t.Errorf("Verify(%q) = true，期望 false", encoded) + } + if !errors.Is(err, ErrUnsupported) { + t.Errorf("Verify(%q) err = %v，期望 ErrUnsupported", encoded, err) + } + } +} + +func TestNeedsRehash(t *testing.T) { + fresh, err := Hash("pw") + if err != nil { + t.Fatal(err) + } + + tests := []struct { + name string + encoded string + want bool + }{ + {"刚生成的", fresh, false}, + {"迭代次数偏低", djangoVectors[0].encoded, true}, + {"迭代次数已达标", djangoVectors[5].encoded, false}, + {"不可用密码", "!xyzzy", false}, + {"格式损坏", "garbage", true}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := NeedsRehash(tt.encoded); got != tt.want { + t.Errorf("NeedsRehash(%q) = %v，期望 %v", tt.encoded, got, tt.want) + } + }) + } +} diff --git a/internal/paths/paths.go b/internal/paths/paths.go new file mode 100644 index 00000000..f0abf869 --- /dev/null +++ b/internal/paths/paths.go @@ -0,0 +1,131 @@ +package paths + +import ( + "errors" + "fmt" + "os" + "path/filepath" + "strings" +) + +const EnvDataDir = "PWIKIT_DATA_DIR" + +type Source string + +const ( + SourceExplicit Source = "explicit" + SourceEnv Source = "env" + SourceExecutable Source = "executable" + SourceGoRun Source = "go-run" +) + +type Paths struct { + root string + source Source +} + +func New(override string) (*Paths, error) { + root, source, err := resolveRoot(override) + if err != nil { + return nil, err + } + + abs, err := filepath.Abs(root) + if err != nil { + return nil, fmt.Errorf("状态目录 %q 无法转为绝对路径: %w", root, err) + } + + return &Paths{root: abs, source: source}, nil +} + +func resolveRoot(override string) (string, Source, error) { + if override != "" { + return override, SourceExplicit, nil + } + if env := os.Getenv(EnvDataDir); env != "" { + return env, SourceEnv, nil + } + return executableDir() +} + +func executableDir() (string, Source, error) { + exe, err := os.Executable() + if err != nil { + return "", "", fmt.Errorf("定位可执行文件失败: %w", err) + } + + if resolved, err := filepath.EvalSymlinks(exe); err == nil { + exe = resolved + } + + dir := filepath.Dir(exe) + if isGoRunTemp(dir) { + cwd, err := os.Getwd() + if err != nil { + return "", "", fmt.Errorf("go run 下取当前目录失败: %w", err) + } + return cwd, SourceGoRun, nil + } + return dir, SourceExecutable, nil +} + +func isGoRunTemp(dir string) bool { + if !strings.Contains(dir, "go-build") { + return false + } + + tmp := os.TempDir() + + if resolved, err := filepath.EvalSymlinks(tmp); err == nil { + tmp = resolved + } + + rel, err := filepath.Rel(tmp, dir) + if err != nil { + return false + } + return rel != ".." && !strings.HasPrefix(rel, ".."+string(filepath.Separator)) +} + +func (p *Paths) Root() string { return p.root } +func (p *Paths) Source() Source { return p.source } + +func (p *Paths) Config() string { return filepath.Join(p.root, "pwikit.toml") } +func (p *Paths) Files() string { return filepath.Join(p.root, "files") } +func (p *Paths) Archive() string { return filepath.Join(p.root, "archive") } +func (p *Paths) Secrets() string { return filepath.Join(p.root, "secrets") } +func (p *Paths) PGData() string { return filepath.Join(p.root, "pgdata") } +func (p *Paths) Postgres() string { return filepath.Join(p.root, "postgres") } + +func (p *Paths) Certs() string { return filepath.Join(p.Secrets(), "certs") } + +func (p *Paths) EnsureBase() error { + if err := os.MkdirAll(p.Secrets(), 0o700); err != nil { + return fmt.Errorf("建立 %s 失败: %w", p.Secrets(), err) + } + for _, dir := range []string{p.Files(), p.Archive()} { + if err := os.MkdirAll(dir, 0o755); err != nil { + return fmt.Errorf("建立 %s 失败: %w", dir, err) + } + } + return nil +} + +var ErrEscapes = errors.New("路径越界") + +func Resolve(base, rel string) (string, error) { + if filepath.IsAbs(rel) { + return "", fmt.Errorf("%w: %q 是绝对路径", ErrEscapes, rel) + } + + joined := filepath.Join(base, rel) + + relToBase, err := filepath.Rel(base, joined) + if err != nil { + return "", fmt.Errorf("%w: %q", ErrEscapes, rel) + } + if relToBase == ".." || strings.HasPrefix(relToBase, ".."+string(filepath.Separator)) { + return "", fmt.Errorf("%w: %q", ErrEscapes, rel) + } + return joined, nil +} diff --git a/internal/paths/paths_test.go b/internal/paths/paths_test.go new file mode 100644 index 00000000..f34d835c --- /dev/null +++ b/internal/paths/paths_test.go @@ -0,0 +1,225 @@ +package paths + +import ( + "errors" + "os" + "path/filepath" + "runtime" + "strings" + "testing" +) + +func TestNewPrefersExplicitOverEnv(t *testing.T) { + t.Setenv(EnvDataDir, t.TempDir()) + explicit := t.TempDir() + + p, err := New(explicit) + if err != nil { + t.Fatal(err) + } + if p.Root() != explicit { + t.Errorf("Root() = %q，期望 %q", p.Root(), explicit) + } + if p.Source() != SourceExplicit { + t.Errorf("Source() = %q，期望 %q", p.Source(), SourceExplicit) + } +} + +func TestNewFallsBackToEnv(t *testing.T) { + dir := t.TempDir() + t.Setenv(EnvDataDir, dir) + + p, err := New("") + if err != nil { + t.Fatal(err) + } + if p.Root() != dir { + t.Errorf("Root() = %q，期望 %q", p.Root(), dir) + } + if p.Source() != SourceEnv { + t.Errorf("Source() = %q，期望 %q", p.Source(), SourceEnv) + } +} + +func TestNewMakesRootAbsolute(t *testing.T) { + p, err := New("data") + if err != nil { + t.Fatal(err) + } + if !filepath.IsAbs(p.Root()) { + t.Errorf("filepath.IsAbs(Root()) = false，Root() = %q", p.Root()) + } +} + +func TestLayoutIsFlat(t *testing.T) { + root := t.TempDir() + p, err := New(root) + if err != nil { + t.Fatal(err) + } + + cases := map[string]string{ + "Config": p.Config(), + "Files": p.Files(), + "Archive": p.Archive(), + "Secrets": p.Secrets(), + "PGData": p.PGData(), + "Postgres": p.Postgres(), + } + for name, got := range cases { + if filepath.Dir(got) != root { + t.Errorf("filepath.Dir(%s()) = %q，期望 %q", name, filepath.Dir(got), root) + } + } + + if filepath.Dir(p.Certs()) != p.Secrets() { + t.Errorf("filepath.Dir(Certs()) = %q，期望 %q", filepath.Dir(p.Certs()), p.Secrets()) + } +} + +func TestEnsureBaseCreatesDirs(t *testing.T) { + p, err := New(t.TempDir()) + if err != nil { + t.Fatal(err) + } + if err := p.EnsureBase(); err != nil { + t.Fatal(err) + } + + for _, dir := range []string{p.Files(), p.Archive(), p.Secrets()} { + info, err := os.Stat(dir) + if err != nil { + t.Errorf("Stat(%s) err = %v，期望 nil", dir, err) + continue + } + if !info.IsDir() { + t.Errorf("%s IsDir() = false，期望 true", dir) + } + } + + if _, err := os.Stat(p.PGData()); !os.IsNotExist(err) { + t.Errorf("EnsureBase() 建立了 %s，期望不建立", p.PGData()) + } + + if runtime.GOOS != "windows" { + info, err := os.Stat(p.Secrets()) + if err != nil { + t.Fatal(err) + } + if perm := info.Mode().Perm(); perm != 0o700 { + t.Errorf("secrets 权限 = %o，期望 700", perm) + } + } +} + +func TestEnsureBaseIsIdempotent(t *testing.T) { + p, err := New(t.TempDir()) + if err != nil { + t.Fatal(err) + } + if err := p.EnsureBase(); err != nil { + t.Fatal(err) + } + if err := p.EnsureBase(); err != nil { + t.Errorf("第二次 EnsureBase() err = %v，期望 nil", err) + } +} + +func TestIsGoRunTemp(t *testing.T) { + tmp := os.TempDir() + if resolved, err := filepath.EvalSymlinks(tmp); err == nil { + tmp = resolved + } + + tests := []struct { + name string + dir string + want bool + }{ + { + name: "go run 的构建目录", + dir: filepath.Join(tmp, "go-build2451739961", "b001", "exe"), + want: true, + }, + { + name: "正常安装位置", + dir: filepath.Join(tmp, "pwikit"), + want: false, + }, + { + name: "临时目录之外的 go-build", + dir: filepath.Join("/opt", "go-build", "pwikit"), + want: false, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := isGoRunTemp(tt.dir); got != tt.want { + t.Errorf("isGoRunTemp(%q) = %v，期望 %v", tt.dir, got, tt.want) + } + }) + } +} + +func TestResolveBlocksEscape(t *testing.T) { + base := filepath.Join(t.TempDir(), "files") + + ok := []struct { + rel string + want string + }{ + {"a.png", filepath.Join(base, "a.png")}, + {"page/a.png", filepath.Join(base, "page", "a.png")}, + {"page/../a.png", filepath.Join(base, "a.png")}, + {"./a.png", filepath.Join(base, "a.png")}, + } + for _, tt := range ok { + got, err := Resolve(base, tt.rel) + if err != nil { + t.Errorf("Resolve(%q) err = %v，期望 nil", tt.rel, err) + continue + } + if got != tt.want { + t.Errorf("Resolve(%q) = %q，期望 %q", tt.rel, got, tt.want) + } + } + + escapes := []string{ + "../secrets/certs/key.pem", + "..", + "page/../../pwikit.toml", + "a/b/c/../../../../etc/passwd", + } + for _, rel := range escapes { + if got, err := Resolve(base, rel); !errors.Is(err, ErrEscapes) { + t.Errorf("Resolve(%q) = %q, err = %v，期望 ErrEscapes", rel, got, err) + } + } +} + +func TestResolveRejectsAbsolute(t *testing.T) { + base := t.TempDir() + + abs := "/etc/passwd" + if runtime.GOOS == "windows" { + abs = `C:\Windows\System32\config\SAM` + } + if _, err := Resolve(base, abs); !errors.Is(err, ErrEscapes) { + t.Errorf("Resolve(%q) err = %v，期望 ErrEscapes", abs, err) + } +} + +func TestResolveEscapeReturnValues(t *testing.T) { + base := filepath.Join(t.TempDir(), "files") + got, err := Resolve(base, "../../pwikit.toml") + if err == nil { + t.Fatalf("Resolve() = %q, err = nil，期望 ErrEscapes", got) + } + if got != "" { + t.Errorf("Resolve() 出错时返回 %q，期望空字符串", got) + } + if !strings.Contains(err.Error(), "pwikit.toml") { + t.Errorf("err = %v，期望包含 %q", err, "pwikit.toml") + } +} diff --git a/internal/renderer/fake.go b/internal/renderer/fake.go new file mode 100644 index 00000000..aa0f2203 --- /dev/null +++ b/internal/renderer/fake.go @@ -0,0 +1,80 @@ +package renderer + +import ( + "context" + "fmt" +) + +type FakeCall struct { + Op string + Source string + Info PageInfo + Mode Mode +} + +type Fake struct { + Result Result + Parts Parts + Err error + Calls []FakeCall +} + +var _ Renderer = (*Fake)(nil) + +func (f *Fake) RenderHTML(ctx context.Context, source string, info PageInfo, cb Callbacks, mode Mode) (Result, error) { + return f.record("RenderHTML", ctx, source, info, mode) +} + +func (f *Fake) RenderText(ctx context.Context, source string, info PageInfo, cb Callbacks, mode Mode) (Result, error) { + return f.record("RenderText", ctx, source, info, mode) +} + +func (f *Fake) CollectBacklinks(ctx context.Context, source string, info PageInfo, cb Callbacks, mode Mode) (Result, error) { + return f.record("CollectBacklinks", ctx, source, info, mode) +} + +func (f *Fake) CollectCodeAndHTML(ctx context.Context, source string, info PageInfo, cb Callbacks, mode Mode) (Parts, error) { + if _, err := f.record("CollectCodeAndHTML", ctx, source, info, mode); err != nil { + return Parts{}, err + } + return f.Parts, nil +} + +func (f *Fake) record(op string, ctx context.Context, source string, info PageInfo, mode Mode) (Result, error) { + f.Calls = append(f.Calls, FakeCall{Op: op, Source: source, Info: info, Mode: mode}) + if err := ctx.Err(); err != nil { + return Result{}, err + } + if f.Err != nil { + return Result{}, f.Err + } + if !mode.Valid() { + return Result{}, fmt.Errorf("未知渲染模式 %q", mode) + } + return f.Result, nil +} + +type NopCallbacks struct{} + +var _ Callbacks = NopCallbacks{} + +func (NopCallbacks) ModuleHasBody(string) (bool, error) { return false, nil } + +func (NopCallbacks) RenderModule(string, map[string]string, string) (string, error) { + return "", nil +} + +func (NopCallbacks) RenderUser(string, bool) (string, error) { return "", nil } +func (NopCallbacks) GetI18nMessage(string) (string, error) { return "", nil } +func (NopCallbacks) GetHTMLInjectedCode(string) (string, error) { return "", nil } +func (NopCallbacks) GetPageInfo([]string) ([]PartialPageInfo, error) { return nil, nil } + +func (NopCallbacks) EvaluateExpression(string) (ExpressionResult, error) { + return ExpressionResult{}, nil +} + +func (NopCallbacks) NormalizePageName(name string) (string, error) { return name, nil } + +func (NopCallbacks) IncludePages([]IncludeRef) ([]FetchedPage, error) { return nil, nil } +func (NopCallbacks) NoSuchInclude(string) (string, error) { return "", nil } +func (NopCallbacks) NextIncludeLevel() (bool, error) { return true, nil } diff --git a/internal/renderer/renderer.go b/internal/renderer/renderer.go new file mode 100644 index 00000000..d43a2389 --- /dev/null +++ b/internal/renderer/renderer.go @@ -0,0 +1,119 @@ +package renderer + +import "context" + +type Mode string + +const ( + ModeArticle Mode = "article" + ModeMessage Mode = "message" + ModeInline Mode = "inline" + ModeSystem Mode = "system" + ModeSystemWithModules Mode = "system-with-modules" +) + +func (m Mode) Valid() bool { + switch m { + case ModeArticle, ModeMessage, ModeInline, ModeSystem, ModeSystemWithModules: + return true + } + return false +} + +type PageInfo struct { + Page string + Category string + Site string + Title string + Domain string + MediaDomain string + Rating float64 + Tags []string + Language string +} + +type IncludeRef struct { + FullName string + Variables map[string]string +} + +type FetchedPage struct { + FullName string + Content *string +} + +type PartialPageInfo struct { + FullName string + Title *string + Exists bool +} + +type CodeBlock struct { + Language string + Source string +} + +type Result struct { + Body string + IncludedPages []string + LinkedPages []string + Code []CodeBlock + HTML []string +} + +type Parts struct { + Code []CodeBlock + HTML []string +} + +type ExpressionKind uint8 + +const ( + ExprNone ExpressionKind = iota + ExprString + ExprBool + ExprFloat + ExprInt +) + +type ExpressionResult struct { + Kind ExpressionKind + Str string + Bool bool + Float float64 + Int int64 +} + +func StringExpr(v string) ExpressionResult { return ExpressionResult{Kind: ExprString, Str: v} } +func BoolExpr(v bool) ExpressionResult { return ExpressionResult{Kind: ExprBool, Bool: v} } +func FloatExpr(v float64) ExpressionResult { return ExpressionResult{Kind: ExprFloat, Float: v} } +func IntExpr(v int64) ExpressionResult { return ExpressionResult{Kind: ExprInt, Int: v} } + +type PageCallbacks interface { + ModuleHasBody(name string) (bool, error) + RenderModule(name string, params map[string]string, body string) (string, error) + RenderUser(user string, avatar bool) (string, error) + GetI18nMessage(id string) (string, error) + GetHTMLInjectedCode(id string) (string, error) + GetPageInfo(refs []string) ([]PartialPageInfo, error) + EvaluateExpression(expr string) (ExpressionResult, error) + NormalizePageName(fullName string) (string, error) +} + +type Includer interface { + IncludePages(refs []IncludeRef) ([]FetchedPage, error) + NoSuchInclude(fullName string) (string, error) +} + +type Callbacks interface { + PageCallbacks + Includer + NextIncludeLevel() (bool, error) +} + +type Renderer interface { + RenderHTML(ctx context.Context, source string, info PageInfo, cb Callbacks, mode Mode) (Result, error) + RenderText(ctx context.Context, source string, info PageInfo, cb Callbacks, mode Mode) (Result, error) + CollectBacklinks(ctx context.Context, source string, info PageInfo, cb Callbacks, mode Mode) (Result, error) + CollectCodeAndHTML(ctx context.Context, source string, info PageInfo, cb Callbacks, mode Mode) (Parts, error) +} diff --git a/internal/renderer/renderer_test.go b/internal/renderer/renderer_test.go new file mode 100644 index 00000000..754db3a0 --- /dev/null +++ b/internal/renderer/renderer_test.go @@ -0,0 +1,128 @@ +package renderer + +import ( + "context" + "errors" + "testing" +) + +func TestModeValid(t *testing.T) { + fromRust := []Mode{"article", "message", "inline", "system", "system-with-modules"} + for _, m := range fromRust { + if !m.Valid() { + t.Errorf("Valid(%q) = false，期望 true", m) + } + } + for _, m := range []Mode{"", "page", "Article", "system_with_modules"} { + if m.Valid() { + t.Errorf("Valid(%q) = true，期望 false", m) + } + } +} + +func TestFakeRecordsCalls(t *testing.T) { + f := &Fake{Result: Result{Body: "

hi

"}} + ctx := context.Background() + info := PageInfo{Page: "173", Category: "scp"} + + if _, err := f.RenderHTML(ctx, "src", info, NopCallbacks{}, ModeArticle); err != nil { + t.Fatal(err) + } + if _, err := f.RenderText(ctx, "src", info, NopCallbacks{}, ModeSystem); err != nil { + t.Fatal(err) + } + + if len(f.Calls) != 2 { + t.Fatalf("len(Calls) = %d，期望 2", len(f.Calls)) + } + if f.Calls[0].Op != "RenderHTML" || f.Calls[0].Mode != ModeArticle { + t.Errorf("Calls[0] = {Op:%s Mode:%s}，期望 {Op:RenderHTML Mode:article}", f.Calls[0].Op, f.Calls[0].Mode) + } + if f.Calls[1].Info.Category != "scp" { + t.Errorf("Calls[1].Info.Category = %q，期望 %q", f.Calls[1].Info.Category, "scp") + } +} + +func TestFakeContextCanceled(t *testing.T) { + ctx, cancel := context.WithCancel(context.Background()) + cancel() + + f := &Fake{Result: Result{Body: "x"}} + if _, err := f.RenderHTML(ctx, "src", PageInfo{}, NopCallbacks{}, ModeArticle); !errors.Is(err, context.Canceled) { + t.Errorf("RenderHTML() err = %v，期望 context.Canceled", err) + } +} + +func TestFakeRejectsUnknownMode(t *testing.T) { + f := &Fake{} + if _, err := f.RenderHTML(context.Background(), "src", PageInfo{}, NopCallbacks{}, "nonsense"); err == nil { + t.Error("RenderHTML(mode=\"nonsense\") err = nil，期望非 nil") + } +} + +func TestNopCallbacksNormalizePageName(t *testing.T) { + got, err := NopCallbacks{}.NormalizePageName("SCP:173") + if err != nil { + t.Fatal(err) + } + if got != "SCP:173" { + t.Errorf("NormalizePageName(%q) = %q，期望 %q", "SCP:173", got, "SCP:173") + } +} + +func TestNopCallbacksNextIncludeLevel(t *testing.T) { + ok, err := NopCallbacks{}.NextIncludeLevel() + if err != nil { + t.Fatal(err) + } + if !ok { + t.Error("NextIncludeLevel() = false，期望 true") + } +} + +func TestCallbacksSatisfiesSubInterfaces(t *testing.T) { + var cb Callbacks = NopCallbacks{} + + if _, ok := cb.(PageCallbacks); !ok { + t.Error("Callbacks 不满足 PageCallbacks") + } + if _, ok := cb.(Includer); !ok { + t.Error("Callbacks 不满足 Includer") + } +} + +func TestExpressionResultZeroValue(t *testing.T) { + if (ExpressionResult{}).Kind != ExprNone { + t.Errorf("ExpressionResult{}.Kind = %v，期望 %v", (ExpressionResult{}).Kind, ExprNone) + } +} + +func TestExpressionConstructors(t *testing.T) { + tests := []struct { + got ExpressionResult + kind ExpressionKind + }{ + {StringExpr("x"), ExprString}, + {BoolExpr(true), ExprBool}, + {FloatExpr(1.5), ExprFloat}, + {IntExpr(-3), ExprInt}, + } + for _, tt := range tests { + if tt.got.Kind != tt.kind { + t.Errorf("Kind = %v，期望 %v", tt.got.Kind, tt.kind) + } + } + + if got := StringExpr("x").Str; got != "x" { + t.Errorf("StringExpr(\"x\").Str = %q，期望 %q", got, "x") + } + if got := BoolExpr(true).Bool; got != true { + t.Errorf("BoolExpr(true).Bool = %v，期望 true", got) + } + if got := FloatExpr(1.5).Float; got != 1.5 { + t.Errorf("FloatExpr(1.5).Float = %v，期望 1.5", got) + } + if got := IntExpr(-3).Int; got != -3 { + t.Errorf("IntExpr(-3).Int = %d，期望 -3", got) + } +} diff --git a/internal/renderer/sidecar/dispatch.go b/internal/renderer/sidecar/dispatch.go new file mode 100644 index 00000000..fba3715c --- /dev/null +++ b/internal/renderer/sidecar/dispatch.go @@ -0,0 +1,198 @@ +package sidecar + +import ( + "encoding/json" + "fmt" + + "github.com/WikitTeam/ProjectWikit/internal/renderer" +) + +func dispatch(cb renderer.Callbacks, method string, raw json.RawMessage) (any, error) { + decode := func(v any) error { + if err := json.Unmarshal(raw, v); err != nil { + return fmt.Errorf("回调 %s 的参数解析失败: %w", method, err) + } + return nil + } + fail := func(err error) (any, error) { + return nil, fmt.Errorf("回调 %s 失败: %w", method, err) + } + + switch method { + case "module_has_body": + var a struct { + Name string `json:"name"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.ModuleHasBody(a.Name) + if err != nil { + return fail(err) + } + return v, nil + + case "render_module": + var a struct { + Name string `json:"name"` + Params map[string]string `json:"params"` + Body string `json:"body"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.RenderModule(a.Name, a.Params, a.Body) + if err != nil { + return fail(err) + } + return v, nil + + case "render_user": + var a struct { + User string `json:"user"` + Avatar bool `json:"avatar"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.RenderUser(a.User, a.Avatar) + if err != nil { + return fail(err) + } + return v, nil + + case "get_i18n_message": + var a struct { + ID string `json:"id"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.GetI18nMessage(a.ID) + if err != nil { + return fail(err) + } + return v, nil + + case "get_html_injected_code": + var a struct { + ID string `json:"id"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.GetHTMLInjectedCode(a.ID) + if err != nil { + return fail(err) + } + return v, nil + + case "get_page_info": + var a struct { + Refs []string `json:"refs"` + } + if err := decode(&a); err != nil { + return nil, err + } + infos, err := cb.GetPageInfo(a.Refs) + if err != nil { + return fail(err) + } + out := make([]map[string]any, 0, len(infos)) + for _, in := range infos { + out = append(out, map[string]any{ + "full_name": in.FullName, + "exists": in.Exists, + "title": in.Title, + }) + } + return out, nil + + case "evaluate_expression": + var a struct { + Expr string `json:"expr"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.EvaluateExpression(a.Expr) + if err != nil { + return fail(err) + } + return encodeExpression(v), nil + + case "normalize_page_name": + var a struct { + FullName string `json:"full_name"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.NormalizePageName(a.FullName) + if err != nil { + return fail(err) + } + return v, nil + + case "include_pages": + var a struct { + Includes []struct { + FullName string `json:"full_name"` + Variables map[string]string `json:"variables"` + } `json:"includes"` + } + if err := decode(&a); err != nil { + return nil, err + } + refs := make([]renderer.IncludeRef, 0, len(a.Includes)) + for _, in := range a.Includes { + refs = append(refs, renderer.IncludeRef{FullName: in.FullName, Variables: in.Variables}) + } + pages, err := cb.IncludePages(refs) + if err != nil { + return fail(err) + } + out := make([]map[string]any, 0, len(pages)) + for _, p := range pages { + out = append(out, map[string]any{"full_name": p.FullName, "content": p.Content}) + } + return out, nil + + case "no_such_include": + var a struct { + FullName string `json:"full_name"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.NoSuchInclude(a.FullName) + if err != nil { + return fail(err) + } + return v, nil + + case "next_include_level": + v, err := cb.NextIncludeLevel() + if err != nil { + return fail(err) + } + return v, nil + } + + return nil, fmt.Errorf("sidecar 请求了未知回调 %q", method) +} + +func encodeExpression(v renderer.ExpressionResult) map[string]any { + switch v.Kind { + case renderer.ExprString: + return map[string]any{"kind": "string", "str": v.Str} + case renderer.ExprBool: + return map[string]any{"kind": "bool", "bool": v.Bool} + case renderer.ExprFloat: + return map[string]any{"kind": "float", "float": v.Float} + case renderer.ExprInt: + return map[string]any{"kind": "int", "int": v.Int} + default: + return map[string]any{"kind": "none"} + } +} diff --git a/internal/renderer/sidecar/integration_test.go b/internal/renderer/sidecar/integration_test.go new file mode 100644 index 00000000..1356550a --- /dev/null +++ b/internal/renderer/sidecar/integration_test.go @@ -0,0 +1,130 @@ +package sidecar + +import ( + "context" + "os" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/renderer" +) + +type stubHost struct { + renderer.NopCallbacks + existing map[string]bool +} + +func (h stubHost) RenderModule(name string, _ map[string]string, _ string) (string, error) { + return `
` + name + `
`, nil +} + +func (h stubHost) NormalizePageName(name string) (string, error) { + return strings.ToLower(strings.ReplaceAll(name, " ", "-")), nil +} + +func (h stubHost) GetPageInfo(refs []string) ([]renderer.PartialPageInfo, error) { + var out []renderer.PartialPageInfo + for _, r := range refs { + if h.existing[r] { + title := r + out = append(out, renderer.PartialPageInfo{FullName: r, Exists: true, Title: &title}) + } + } + return out, nil +} + +func (h stubHost) NoSuchInclude(fullName string) (string, error) { + return "[[include " + fullName + " 不存在]]", nil +} + +func newReal(t *testing.T) *Renderer { + t.Helper() + bin := os.Getenv(EnvBinary) + if bin == "" { + t.Skipf("未设置 %s，跳过真实 sidecar 集成测试", EnvBinary) + } + r, err := New(bin) + if err != nil { + t.Fatalf("New(%q) err = %v，期望 nil", bin, err) + } + t.Cleanup(func() { r.Close() }) + return r +} + +func TestRealSidecarRendersHTML(t *testing.T) { + r := newReal(t) + host := stubHost{existing: map[string]bool{"exists": true}} + info := renderer.PageInfo{Page: "173", Category: "scp", Domain: "example.org"} + + tests := []struct { + name string + source string + want string + }{ + {"行内格式", "//斜体// 和 **粗体**", "

斜体 和 粗体

"}, + {"模块", "[[module Rate]]", `
Rate
`}, + {"注释被去掉", "[!-- 注释 --]文本", "

文本

"}, + {"include 缺失", "[[include :other:page]]", "不存在"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := r.RenderHTML(context.Background(), tt.source, info, host, renderer.ModeArticle) + if err != nil { + t.Fatalf("RenderHTML(%q) err = %v，期望 nil", tt.source, err) + } + if !strings.Contains(got.Body, tt.want) { + t.Errorf("RenderHTML(%q) = %q，期望包含 %q", tt.source, got.Body, tt.want) + } + }) + } +} + +func TestRealSidecarMarksRedLinks(t *testing.T) { + r := newReal(t) + host := stubHost{existing: map[string]bool{"exists": true}} + info := renderer.PageInfo{Page: "173", Domain: "example.org"} + + got, err := r.RenderHTML(context.Background(), "[[[exists|蓝]]] [[[missing|红]]]", info, host, renderer.ModeArticle) + if err != nil { + t.Fatalf("RenderHTML() err = %v，期望 nil", err) + } + if !strings.Contains(got.Body, `红`) { + t.Errorf("Body = %q，期望缺失页链接带 class=newpage", got.Body) + } + if strings.Contains(got.Body, ``) { + t.Errorf("Body = %q，期望已存在的页面不带 class=newpage", got.Body) + } + if len(got.LinkedPages) != 2 { + t.Errorf("LinkedPages = %v，期望两项", got.LinkedPages) + } +} + +func TestRealSidecarRendersText(t *testing.T) { + r := newReal(t) + host := stubHost{} + + got, err := r.RenderText(context.Background(), "**粗体** 文本", renderer.PageInfo{Domain: "example.org"}, host, renderer.ModeArticle) + if err != nil { + t.Fatalf("RenderText() err = %v，期望 nil", err) + } + if strings.TrimSpace(got.Body) != "粗体 文本" { + t.Errorf("RenderText() = %q，期望 %q", got.Body, "粗体 文本") + } +} + +func TestRealSidecarReusesProcess(t *testing.T) { + r := newReal(t) + host := stubHost{} + info := renderer.PageInfo{Domain: "example.org"} + + for i := range 3 { + got, err := r.RenderHTML(context.Background(), "**x**", info, host, renderer.ModeArticle) + if err != nil { + t.Fatalf("第 %d 次 RenderHTML() err = %v，期望 nil", i+1, err) + } + if !strings.Contains(got.Body, "x") { + t.Errorf("第 %d 次 = %q，期望包含 x", i+1, got.Body) + } + } +} diff --git a/internal/renderer/sidecar/sidecar.go b/internal/renderer/sidecar/sidecar.go new file mode 100644 index 00000000..1daf6ade --- /dev/null +++ b/internal/renderer/sidecar/sidecar.go @@ -0,0 +1,233 @@ +package sidecar + +import ( + "bufio" + "bytes" + "context" + "encoding/binary" + "encoding/json" + "fmt" + "io" + "os/exec" + "sync" + + "github.com/WikitTeam/ProjectWikit/internal/renderer" +) + +const EnvBinary = "PWIKIT_FTML_SIDECAR" + +const maxMessageBytes = 64 << 20 + +type Renderer struct { + mu sync.Mutex + in io.Writer + out *bufio.Reader + cmd *exec.Cmd + stop func() error +} + +var _ renderer.Renderer = (*Renderer)(nil) + +func New(binary string) (*Renderer, error) { + cmd := exec.Command(binary) + stdin, err := cmd.StdinPipe() + if err != nil { + return nil, fmt.Errorf("接管 sidecar stdin 失败: %w", err) + } + stdout, err := cmd.StdoutPipe() + if err != nil { + return nil, fmt.Errorf("接管 sidecar stdout 失败: %w", err) + } + if err := cmd.Start(); err != nil { + return nil, fmt.Errorf("启动 sidecar %q 失败: %w", binary, err) + } + + return &Renderer{ + in: stdin, + out: bufio.NewReader(stdout), + cmd: cmd, + stop: func() error { + stdin.Close() + return cmd.Wait() + }, + }, nil +} + +func newOver(w io.Writer, r io.Reader) *Renderer { + return &Renderer{in: w, out: bufio.NewReader(r), stop: func() error { return nil }} +} + +func (r *Renderer) Close() error { + r.mu.Lock() + defer r.mu.Unlock() + if r.stop == nil { + return nil + } + stop := r.stop + r.stop = nil + return stop() +} + +func (r *Renderer) RenderHTML(ctx context.Context, source string, info renderer.PageInfo, cb renderer.Callbacks, mode renderer.Mode) (renderer.Result, error) { + return r.render(ctx, "html", source, info, cb, mode) +} + +func (r *Renderer) RenderText(ctx context.Context, source string, info renderer.PageInfo, cb renderer.Callbacks, mode renderer.Mode) (renderer.Result, error) { + return r.render(ctx, "text", source, info, cb, mode) +} + +func (r *Renderer) CollectBacklinks(ctx context.Context, source string, info renderer.PageInfo, cb renderer.Callbacks, mode renderer.Mode) (renderer.Result, error) { + return r.render(ctx, "html", source, info, cb, mode) +} + +func (r *Renderer) CollectCodeAndHTML(ctx context.Context, source string, info renderer.PageInfo, cb renderer.Callbacks, mode renderer.Mode) (renderer.Parts, error) { + res, err := r.render(ctx, "html", source, info, cb, mode) + if err != nil { + return renderer.Parts{}, err + } + return renderer.Parts{Code: res.Code, HTML: res.HTML}, nil +} + +type wireResult struct { + Type string `json:"type"` + Message string `json:"message"` + Method string `json:"method"` + Args json.RawMessage `json:"args"` + Body string `json:"body"` + IncludedPages []string `json:"included_pages"` + LinkedPages []string `json:"linked_pages"` + Code [][2]string `json:"code"` + HTML []string `json:"html"` +} + +func (r *Renderer) render(ctx context.Context, op, source string, info renderer.PageInfo, cb renderer.Callbacks, mode renderer.Mode) (renderer.Result, error) { + if !mode.Valid() { + return renderer.Result{}, fmt.Errorf("未知渲染模式 %q", mode) + } + if cb == nil { + return renderer.Result{}, fmt.Errorf("Callbacks 为 nil") + } + + r.mu.Lock() + defer r.mu.Unlock() + + req := map[string]any{ + "type": "render", + "op": op, + "mode": string(mode), + "source": source, + "page_info": encodePageInfo(info), + } + if err := r.send(req); err != nil { + return renderer.Result{}, err + } + + for { + if err := ctx.Err(); err != nil { + return renderer.Result{}, err + } + + var msg wireResult + if err := r.recv(&msg); err != nil { + return renderer.Result{}, err + } + + switch msg.Type { + case "result": + code := make([]renderer.CodeBlock, 0, len(msg.Code)) + for _, c := range msg.Code { + code = append(code, renderer.CodeBlock{Language: c[0], Source: c[1]}) + } + return renderer.Result{ + Body: msg.Body, + IncludedPages: msg.IncludedPages, + LinkedPages: msg.LinkedPages, + Code: code, + HTML: msg.HTML, + }, nil + + case "error": + return renderer.Result{}, fmt.Errorf("sidecar 报错: %s", msg.Message) + + case "callback": + value, err := dispatch(cb, msg.Method, msg.Args) + if err != nil { + return renderer.Result{}, err + } + if err := r.send(map[string]any{"type": "callback_result", "value": value}); err != nil { + return renderer.Result{}, err + } + + default: + return renderer.Result{}, fmt.Errorf("sidecar 消息 type = %q，期望 result/error/callback", msg.Type) + } + } +} + +func marshal(v any) ([]byte, error) { + var body bytes.Buffer + enc := json.NewEncoder(&body) + enc.SetEscapeHTML(false) + if err := enc.Encode(v); err != nil { + return nil, err + } + buf := body.Bytes() + if n := len(buf); n > 0 && buf[n-1] == '\n' { + buf = buf[:n-1] + } + return buf, nil +} + +func (r *Renderer) send(v any) error { + buf, err := marshal(v) + if err != nil { + return fmt.Errorf("序列化出站消息失败: %w", err) + } + + var head [4]byte + binary.BigEndian.PutUint32(head[:], uint32(len(buf))) + if _, err := r.in.Write(head[:]); err != nil { + return fmt.Errorf("写消息长度失败: %w", err) + } + if _, err := r.in.Write(buf); err != nil { + return fmt.Errorf("写消息体失败: %w", err) + } + return nil +} + +func (r *Renderer) recv(v any) error { + var head [4]byte + if _, err := io.ReadFull(r.out, head[:]); err != nil { + return fmt.Errorf("读消息长度失败: %w", err) + } + n := binary.BigEndian.Uint32(head[:]) + if n > maxMessageBytes { + return fmt.Errorf("消息长度 %d 超过上限 %d", n, maxMessageBytes) + } + buf := make([]byte, n) + if _, err := io.ReadFull(r.out, buf); err != nil { + return fmt.Errorf("读消息体失败: %w", err) + } + if err := json.Unmarshal(buf, v); err != nil { + return fmt.Errorf("解析入站消息失败: %w", err) + } + return nil +} + +func encodePageInfo(info renderer.PageInfo) map[string]any { + tags := info.Tags + if tags == nil { + tags = []string{} + } + return map[string]any{ + "page": info.Page, + "category": info.Category, + "site": info.Site, + "title": info.Title, + "domain": info.Domain, + "media_domain": info.MediaDomain, + "rating": info.Rating, + "tags": tags, + "language": info.Language, + } +} diff --git a/internal/renderer/sidecar/sidecar_test.go b/internal/renderer/sidecar/sidecar_test.go new file mode 100644 index 00000000..a04d7583 --- /dev/null +++ b/internal/renderer/sidecar/sidecar_test.go @@ -0,0 +1,284 @@ +package sidecar + +import ( + "context" + "encoding/binary" + "encoding/json" + "errors" + "io" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/renderer" +) + +type fakeSidecar struct { + t *testing.T + in io.Reader + out io.Writer +} + +func (f *fakeSidecar) recv() map[string]any { + f.t.Helper() + var head [4]byte + if _, err := io.ReadFull(f.in, head[:]); err != nil { + f.t.Fatalf("假 sidecar 读长度 err = %v，期望 nil", err) + } + buf := make([]byte, binary.BigEndian.Uint32(head[:])) + if _, err := io.ReadFull(f.in, buf); err != nil { + f.t.Fatalf("假 sidecar 读消息体 err = %v，期望 nil", err) + } + var m map[string]any + if err := json.Unmarshal(buf, &m); err != nil { + f.t.Fatalf("假 sidecar 解析 err = %v，期望 nil", err) + } + return m +} + +func (f *fakeSidecar) send(v any) { + f.t.Helper() + buf, err := json.Marshal(v) + if err != nil { + f.t.Fatalf("假 sidecar 序列化 err = %v，期望 nil", err) + } + var head [4]byte + binary.BigEndian.PutUint32(head[:], uint32(len(buf))) + f.out.Write(head[:]) + f.out.Write(buf) +} + +func newPair(t *testing.T, serve func(f *fakeSidecar)) *Renderer { + t.Helper() + toServer, fromClient := io.Pipe() + toClient, fromServer := io.Pipe() + + go func() { + defer fromServer.Close() + serve(&fakeSidecar{t: t, in: toServer, out: fromServer}) + }() + + t.Cleanup(func() { fromClient.Close() }) + return newOver(fromClient, toClient) +} + +func resultMsg(extra map[string]any) map[string]any { + m := map[string]any{"type": "result", "body": "

ok

"} + for k, v := range extra { + m[k] = v + } + return m +} + +func TestRenderHTMLMapsResult(t *testing.T) { + r := newPair(t, func(f *fakeSidecar) { + f.recv() + f.send(resultMsg(map[string]any{ + "included_pages": []string{"a"}, + "linked_pages": []string{"b", "c"}, + "code": [][2]string{{"rust", "fn main() {}"}}, + "html": []string{"x"}, + })) + }) + + got, err := r.RenderHTML(context.Background(), "src", renderer.PageInfo{}, renderer.NopCallbacks{}, renderer.ModeArticle) + if err != nil { + t.Fatalf("RenderHTML() err = %v，期望 nil", err) + } + if got.Body != "

ok

" { + t.Errorf("Body = %q，期望 %q", got.Body, "

ok

") + } + if len(got.LinkedPages) != 2 || got.LinkedPages[1] != "c" { + t.Errorf("LinkedPages = %v，期望 [b c]", got.LinkedPages) + } + if len(got.Code) != 1 || got.Code[0].Language != "rust" || got.Code[0].Source != "fn main() {}" { + t.Errorf("Code = %+v，期望 [{rust fn main() {}}]", got.Code) + } +} + +func TestRenderSendsRequestFields(t *testing.T) { + var req map[string]any + r := newPair(t, func(f *fakeSidecar) { + req = f.recv() + f.send(resultMsg(nil)) + }) + + info := renderer.PageInfo{Page: "173", Category: "scp", Domain: "example.org", Tags: []string{"t"}} + if _, err := r.RenderText(context.Background(), "源码", info, renderer.NopCallbacks{}, renderer.ModeSystem); err != nil { + t.Fatalf("RenderText() err = %v，期望 nil", err) + } + + if req["type"] != "render" { + t.Errorf("type = %v，期望 render", req["type"]) + } + if req["op"] != "text" { + t.Errorf("op = %v，期望 text", req["op"]) + } + if req["mode"] != "system" { + t.Errorf("mode = %v，期望 system", req["mode"]) + } + if req["source"] != "源码" { + t.Errorf("source = %v，期望 源码", req["source"]) + } + pi, _ := req["page_info"].(map[string]any) + if pi["page"] != "173" || pi["category"] != "scp" || pi["domain"] != "example.org" { + t.Errorf("page_info = %v，期望含 page=173 category=scp domain=example.org", pi) + } +} + +func TestRenderRejectsInvalidMode(t *testing.T) { + r := newPair(t, func(f *fakeSidecar) {}) + if _, err := r.RenderHTML(context.Background(), "s", renderer.PageInfo{}, renderer.NopCallbacks{}, "nonsense"); err == nil { + t.Error("RenderHTML(mode=nonsense) err = nil，期望非 nil") + } +} + +func TestRenderRejectsNilCallbacks(t *testing.T) { + r := newPair(t, func(f *fakeSidecar) {}) + if _, err := r.RenderHTML(context.Background(), "s", renderer.PageInfo{}, nil, renderer.ModeArticle); err == nil { + t.Error("RenderHTML(cb=nil) err = nil，期望非 nil") + } +} + +func TestRenderPropagatesSidecarError(t *testing.T) { + r := newPair(t, func(f *fakeSidecar) { + f.recv() + f.send(map[string]any{"type": "error", "message": "炸了"}) + }) + _, err := r.RenderHTML(context.Background(), "s", renderer.PageInfo{}, renderer.NopCallbacks{}, renderer.ModeArticle) + if err == nil || !strings.Contains(err.Error(), "炸了") { + t.Errorf("err = %v，期望包含 %q", err, "炸了") + } +} + +func TestRenderRejectsUnknownMessageType(t *testing.T) { + r := newPair(t, func(f *fakeSidecar) { + f.recv() + f.send(map[string]any{"type": "hello"}) + }) + _, err := r.RenderHTML(context.Background(), "s", renderer.PageInfo{}, renderer.NopCallbacks{}, renderer.ModeArticle) + if err == nil || !strings.Contains(err.Error(), "hello") { + t.Errorf("err = %v，期望包含 %q", err, "hello") + } +} + +func TestRenderContextCanceled(t *testing.T) { + ctx, cancel := context.WithCancel(context.Background()) + cancel() + + r := newPair(t, func(f *fakeSidecar) { f.recv() }) + + _, err := r.RenderHTML(ctx, "s", renderer.PageInfo{}, renderer.NopCallbacks{}, renderer.ModeArticle) + if !errors.Is(err, context.Canceled) { + t.Errorf("err = %v，期望 context.Canceled", err) + } +} + +type recordingCallbacks struct { + renderer.NopCallbacks + moduleName string + userName string + refs []string + includes []renderer.IncludeRef +} + +func (c *recordingCallbacks) RenderModule(name string, params map[string]string, body string) (string, error) { + c.moduleName = name + return "
" + name + "|" + params["k"] + "|" + body + "
", nil +} + +func (c *recordingCallbacks) RenderUser(user string, avatar bool) (string, error) { + c.userName = user + return "" + user + "", nil +} + +func (c *recordingCallbacks) GetPageInfo(refs []string) ([]renderer.PartialPageInfo, error) { + c.refs = refs + title := "标题" + return []renderer.PartialPageInfo{{FullName: refs[0], Exists: true, Title: &title}}, nil +} + +func (c *recordingCallbacks) IncludePages(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) { + c.includes = refs + body := "内容" + return []renderer.FetchedPage{{FullName: refs[0].FullName, Content: &body}}, nil +} + +func (c *recordingCallbacks) EvaluateExpression(string) (renderer.ExpressionResult, error) { + return renderer.IntExpr(42), nil +} + +func (c *recordingCallbacks) NextIncludeLevel() (bool, error) { return false, nil } + +func TestDispatchRoundTrips(t *testing.T) { + cb := &recordingCallbacks{} + + tests := []struct { + method string + args map[string]any + want string + }{ + {"module_has_body", map[string]any{"name": "Rate"}, `false`}, + {"render_module", map[string]any{"name": "Rate", "params": map[string]string{"k": "v"}, "body": "b"}, `"
Rate|v|b
"`}, + {"render_user", map[string]any{"user": "kakushi", "avatar": true}, `"kakushi"`}, + {"get_page_info", map[string]any{"refs": []string{"scp:173"}}, `[{"exists":true,"full_name":"scp:173","title":"标题"}]`}, + {"evaluate_expression", map[string]any{"expr": "1+1"}, `{"int":42,"kind":"int"}`}, + {"include_pages", map[string]any{"includes": []map[string]any{{"full_name": "a", "variables": map[string]string{}}}}, `[{"content":"内容","full_name":"a"}]`}, + {"next_include_level", map[string]any{}, `false`}, + } + + for _, tt := range tests { + t.Run(tt.method, func(t *testing.T) { + raw, err := json.Marshal(tt.args) + if err != nil { + t.Fatalf("marshal err = %v，期望 nil", err) + } + got, err := dispatch(cb, tt.method, raw) + if err != nil { + t.Fatalf("dispatch(%s) err = %v，期望 nil", tt.method, err) + } + encoded, err := marshal(got) + if err != nil { + t.Fatalf("marshal err = %v，期望 nil", err) + } + if string(encoded) != tt.want { + t.Errorf("dispatch(%s) = %s，期望 %s", tt.method, encoded, tt.want) + } + }) + } + + if cb.moduleName != "Rate" { + t.Errorf("moduleName = %q，期望 Rate", cb.moduleName) + } + if len(cb.includes) != 1 || cb.includes[0].FullName != "a" { + t.Errorf("includes = %+v，期望 [{a}]", cb.includes) + } +} + +func TestDispatchUnknownMethod(t *testing.T) { + _, err := dispatch(renderer.NopCallbacks{}, "no_such_callback", json.RawMessage(`{}`)) + if err == nil || !strings.Contains(err.Error(), "no_such_callback") { + t.Errorf("err = %v，期望包含 %q", err, "no_such_callback") + } +} + +func TestEncodeExpression(t *testing.T) { + tests := []struct { + in renderer.ExpressionResult + want string + }{ + {renderer.ExpressionResult{}, `{"kind":"none"}`}, + {renderer.StringExpr("x"), `{"kind":"string","str":"x"}`}, + {renderer.BoolExpr(true), `{"bool":true,"kind":"bool"}`}, + {renderer.FloatExpr(1.5), `{"float":1.5,"kind":"float"}`}, + {renderer.IntExpr(-3), `{"int":-3,"kind":"int"}`}, + } + for _, tt := range tests { + got, err := marshal(encodeExpression(tt.in)) + if err != nil { + t.Fatalf("marshal err = %v，期望 nil", err) + } + if string(got) != tt.want { + t.Errorf("encodeExpression(%+v) = %s，期望 %s", tt.in, got, tt.want) + } + } +} From 331109c86f2194489366c64d00778fb1038fc24a Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 20 Aug 2026 13:56:43 +0900 Subject: [PATCH 002/428] =?UTF-8?q?=E6=96=B0=E5=A2=9Ei18n=E5=A4=9A?= =?UTF-8?q?=E8=AF=AD=E8=A8=80=E9=83=A8=E4=BB=B6=E4=B8=8Ego-CLI=E6=A1=86?= =?UTF-8?q?=E6=9E=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 转发框架、路由表 --- cmd/pwikit/main.go | 115 ++++++++++++++++++++ internal/forward/forward.go | 63 +++++++++++ internal/forward/forward_test.go | 162 +++++++++++++++++++++++++++++ internal/i18n/i18n.go | 134 ++++++++++++++++++++++++ internal/i18n/i18n_test.go | 144 +++++++++++++++++++++++++ internal/i18n/locales/zh-hans.json | 11 ++ internal/paths/paths.go | 1 + internal/paths/paths_test.go | 1 + internal/routing/routing.go | 121 +++++++++++++++++++++ internal/routing/routing_test.go | 126 ++++++++++++++++++++++ 10 files changed, 878 insertions(+) create mode 100644 cmd/pwikit/main.go create mode 100644 internal/forward/forward.go create mode 100644 internal/forward/forward_test.go create mode 100644 internal/i18n/i18n.go create mode 100644 internal/i18n/i18n_test.go create mode 100644 internal/i18n/locales/zh-hans.json create mode 100644 internal/routing/routing.go create mode 100644 internal/routing/routing_test.go diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go new file mode 100644 index 00000000..b6e5c40e --- /dev/null +++ b/cmd/pwikit/main.go @@ -0,0 +1,115 @@ +package main + +import ( + "errors" + "flag" + "fmt" + "log/slog" + "net/http" + "os" + "text/tabwriter" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/forward" + "github.com/WikitTeam/ProjectWikit/internal/paths" + "github.com/WikitTeam/ProjectWikit/internal/routing" +) + +const ( + envUpstream = "PWIKIT_UPSTREAM" + defaultUpstream = "http://127.0.0.1:8000" + defaultListen = "127.0.0.1:8080" +) + +func main() { + if err := run(os.Args[1:]); err != nil { + fmt.Fprintln(os.Stderr, "pwikit: "+err.Error()) + os.Exit(1) + } +} + +func run(args []string) error { + if len(args) == 0 { + usage() + return errors.New("缺少子命令") + } + switch args[0] { + case "serve": + return serve(args[1:]) + case "routes": + return printRoutes() + case "help", "-h", "--help": + usage() + return nil + default: + usage() + return fmt.Errorf("未知子命令 %q", args[0]) + } +} + +func usage() { + fmt.Fprint(os.Stderr, `用法: pwikit <子命令> [选项] + +子命令: + serve 启动 HTTP 服务 + routes 打印静态路由表 + help 显示本帮助 +`) +} + +func serve(args []string) error { + fs := flag.NewFlagSet("serve", flag.ContinueOnError) + listen := fs.String("listen", defaultListen, "监听地址") + upstream := fs.String("upstream", envOr(envUpstream, defaultUpstream), "转发未处理请求的上游地址") + dataDir := fs.String("data-dir", "", "状态目录，默认取可执行文件所在目录") + if err := fs.Parse(args); err != nil { + return err + } + + p, err := paths.New(*dataDir) + if err != nil { + return err + } + if err := p.EnsureBase(); err != nil { + return err + } + + log := slog.Default() + + proxy, err := forward.New(*upstream, log) + if err != nil { + return err + } + mux, err := routing.New(routing.Table, proxy, nil) + if err != nil { + return err + } + + log.Info("pwikit serve", "listen", *listen, "upstream", proxy.Target(), "root", p.Root(), "root_source", string(p.Source())) + + srv := &http.Server{ + Addr: *listen, + Handler: mux, + ReadHeaderTimeout: 20 * time.Second, + } + return srv.ListenAndServe() +} + +func envOr(key, fallback string) string { + if v := os.Getenv(key); v != "" { + return v + } + return fallback +} + +func printRoutes() error { + if err := routing.Validate(routing.Table); err != nil { + return err + } + w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0) + fmt.Fprintln(w, "PREFIX\tOWNER\tLABEL") + for _, r := range routing.Table { + fmt.Fprintf(w, "%s\t%s\t%s\n", r.Prefix, r.Owner, r.Label) + } + return w.Flush() +} diff --git a/internal/forward/forward.go b/internal/forward/forward.go new file mode 100644 index 00000000..a1510851 --- /dev/null +++ b/internal/forward/forward.go @@ -0,0 +1,63 @@ +package forward + +import ( + "context" + "errors" + "fmt" + "log/slog" + "net/http" + "net/http/httputil" + "net/url" +) + +type Proxy struct { + target *url.URL + rp *httputil.ReverseProxy + log *slog.Logger +} + +var _ http.Handler = (*Proxy)(nil) + +func New(target string, log *slog.Logger) (*Proxy, error) { + u, err := url.Parse(target) + if err != nil { + return nil, fmt.Errorf("上游地址 %q 解析失败: %w", target, err) + } + if u.Scheme != "http" && u.Scheme != "https" { + return nil, fmt.Errorf("上游地址 %q 的 scheme = %q，期望 http 或 https", target, u.Scheme) + } + if u.Host == "" { + return nil, fmt.Errorf("上游地址 %q 缺少 host", target) + } + if log == nil { + log = slog.Default() + } + + p := &Proxy{target: u, log: log} + p.rp = &httputil.ReverseProxy{Rewrite: p.rewrite, ErrorHandler: p.handleError} + return p, nil +} + +func (p *Proxy) Target() string { return p.target.String() } + +func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request) { + p.rp.ServeHTTP(w, r) +} + +func (p *Proxy) rewrite(pr *httputil.ProxyRequest) { + pr.Out.Header.Del("X-Forwarded-For") + pr.Out.Header.Del("X-Forwarded-Host") + pr.Out.Header.Del("X-Forwarded-Proto") + pr.SetXForwarded() + + pr.SetURL(p.target) + pr.Out.Host = pr.In.Host +} + +func (p *Proxy) handleError(w http.ResponseWriter, r *http.Request, err error) { + if errors.Is(err, context.Canceled) { + return + } + p.log.Error("转发失败", "path", r.URL.Path, "upstream", p.target.String(), "err", err) + http.Error(w, "无法连接上游 "+p.target.String(), http.StatusBadGateway) +} diff --git a/internal/forward/forward_test.go b/internal/forward/forward_test.go new file mode 100644 index 00000000..d31455a9 --- /dev/null +++ b/internal/forward/forward_test.go @@ -0,0 +1,162 @@ +package forward + +import ( + "io" + "log/slog" + "net/http" + "net/http/httptest" + "strings" + "testing" +) + +func quietLog() *slog.Logger { + return slog.New(slog.NewTextHandler(io.Discard, nil)) +} + +func newProxy(t *testing.T, upstream *httptest.Server) *Proxy { + t.Helper() + p, err := New(upstream.URL, quietLog()) + if err != nil { + t.Fatalf("New(%q) err = %v，期望 nil", upstream.URL, err) + } + return p +} + +func TestNewRejectsBadTarget(t *testing.T) { + tests := []struct { + name string + target string + }{ + {"空串", ""}, + {"缺 scheme", "127.0.0.1:8000"}, + {"scheme 不是 http", "ftp://127.0.0.1:8000"}, + {"缺 host", "http://"}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if _, err := New(tt.target, quietLog()); err == nil { + t.Errorf("New(%q) err = nil，期望非 nil", tt.target) + } + }) + } +} + +func TestProxyPreservesHost(t *testing.T) { + var got string + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + got = r.Host + })) + defer up.Close() + + front := httptest.NewServer(newProxy(t, up)) + defer front.Close() + + req, _ := http.NewRequest(http.MethodGet, front.URL+"/scp-173", nil) + req.Host = "scpfoundation.example" + resp, err := front.Client().Do(req) + if err != nil { + t.Fatalf("Do() err = %v，期望 nil", err) + } + resp.Body.Close() + + if got != "scpfoundation.example" { + t.Errorf("上游收到的 Host = %q，期望 %q", got, "scpfoundation.example") + } +} + +func TestProxyDropsClientForwardedHeaders(t *testing.T) { + var xff, proto string + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + xff = r.Header.Get("X-Forwarded-For") + proto = r.Header.Get("X-Forwarded-Proto") + })) + defer up.Close() + + front := httptest.NewServer(newProxy(t, up)) + defer front.Close() + + req, _ := http.NewRequest(http.MethodGet, front.URL+"/", nil) + req.Header.Set("X-Forwarded-For", "1.2.3.4") + req.Header.Set("X-Forwarded-Proto", "https") + resp, err := front.Client().Do(req) + if err != nil { + t.Fatalf("Do() err = %v，期望 nil", err) + } + resp.Body.Close() + + if strings.Contains(xff, "1.2.3.4") { + t.Errorf("上游收到的 X-Forwarded-For = %q，期望不含客户端伪造的 1.2.3.4", xff) + } + if proto != "http" { + t.Errorf("上游收到的 X-Forwarded-Proto = %q，期望 %q", proto, "http") + } +} + +func TestProxyPassesRequestURIThrough(t *testing.T) { + var got string + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + got = r.RequestURI + })) + defer up.Close() + + front := httptest.NewServer(newProxy(t, up)) + defer front.Close() + + resp, err := front.Client().Get(front.URL + "/local--files/a%2Fb.png?size=200") + if err != nil { + t.Fatalf("Get() err = %v，期望 nil", err) + } + resp.Body.Close() + + if got != "/local--files/a%2Fb.png?size=200" { + t.Errorf("上游收到的 RequestURI = %q，期望 %q", got, "/local--files/a%2Fb.png?size=200") + } +} + +func TestProxyPassesStatusAndBody(t *testing.T) { + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("X-Wikit", "1") + w.WriteHeader(http.StatusTeapot) + io.WriteString(w, "内容") + })) + defer up.Close() + + front := httptest.NewServer(newProxy(t, up)) + defer front.Close() + + resp, err := front.Client().Get(front.URL + "/") + if err != nil { + t.Fatalf("Get() err = %v，期望 nil", err) + } + defer resp.Body.Close() + body, _ := io.ReadAll(resp.Body) + + if resp.StatusCode != http.StatusTeapot { + t.Errorf("StatusCode = %d，期望 %d", resp.StatusCode, http.StatusTeapot) + } + if resp.Header.Get("X-Wikit") != "1" { + t.Errorf("X-Wikit = %q，期望 %q", resp.Header.Get("X-Wikit"), "1") + } + if string(body) != "内容" { + t.Errorf("body = %q，期望 %q", body, "内容") + } +} + +func TestProxyReturns502WhenUpstreamDown(t *testing.T) { + up := httptest.NewServer(http.HandlerFunc(func(http.ResponseWriter, *http.Request) {})) + dead := newProxy(t, up) + up.Close() + + front := httptest.NewServer(dead) + defer front.Close() + + resp, err := front.Client().Get(front.URL + "/") + if err != nil { + t.Fatalf("Get() err = %v，期望 nil", err) + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusBadGateway { + t.Errorf("StatusCode = %d，期望 %d", resp.StatusCode, http.StatusBadGateway) + } +} diff --git a/internal/i18n/i18n.go b/internal/i18n/i18n.go new file mode 100644 index 00000000..4c080ac4 --- /dev/null +++ b/internal/i18n/i18n.go @@ -0,0 +1,134 @@ +package i18n + +import ( + "embed" + "encoding/json" + "errors" + "fmt" + "io/fs" + "os" + "path" + "slices" + "strings" +) + +//go:embed locales/*.json +var embedded embed.FS + +const ( + DefaultLanguage = "zh-hans" + embeddedDir = "locales" + fileSuffix = ".json" +) + +type Bundle struct { + catalogs map[string]map[string]string +} + +func Load(overrideDir string) (*Bundle, error) { + b := &Bundle{catalogs: make(map[string]map[string]string)} + if err := b.merge(embedded, embeddedDir); err != nil { + return nil, err + } + if overrideDir != "" { + if err := b.merge(os.DirFS(overrideDir), "."); err != nil && !errors.Is(err, fs.ErrNotExist) { + return nil, err + } + } + if len(b.catalogs[DefaultLanguage]) == 0 { + return nil, fmt.Errorf("默认语言 %q 的文案表为空", DefaultLanguage) + } + return b, nil +} + +func (b *Bundle) merge(fsys fs.FS, dir string) error { + names, err := fs.Glob(fsys, path.Join(dir, "*"+fileSuffix)) + if err != nil { + return err + } + for _, name := range names { + lang := Normalize(strings.TrimSuffix(path.Base(name), fileSuffix)) + if lang == "" { + return fmt.Errorf("文案表 %s 的文件名不是语言标签", name) + } + raw, err := fs.ReadFile(fsys, name) + if err != nil { + return err + } + var entries map[string]string + if err := json.Unmarshal(raw, &entries); err != nil { + return fmt.Errorf("文案表 %s 解析失败: %w", name, err) + } + catalog, ok := b.catalogs[lang] + if !ok { + catalog = make(map[string]string, len(entries)) + b.catalogs[lang] = catalog + } + for id, text := range entries { + catalog[id] = text + } + } + return nil +} + +func (b *Bundle) Languages() []string { + langs := make([]string, 0, len(b.catalogs)) + for lang := range b.catalogs { + langs = append(langs, lang) + } + slices.Sort(langs) + return langs +} + +func (b *Bundle) Has(lang string) bool { + _, ok := b.catalogs[Normalize(lang)] + return ok +} + +func (b *Bundle) Localizer(lang string) *Localizer { + lang = Normalize(lang) + if !b.Has(lang) { + lang = DefaultLanguage + } + return &Localizer{bundle: b, lang: lang} +} + +type Localizer struct { + bundle *Bundle + lang string +} + +func (l *Localizer) Lang() string { return l.lang } + +func (l *Localizer) T(id string, args ...any) string { + text, ok := l.bundle.catalogs[l.lang][id] + if !ok { + text, ok = l.bundle.catalogs[DefaultLanguage][id] + } + if !ok { + return id + } + return expand(text, args) +} + +func Normalize(lang string) string { + return strings.ToLower(strings.TrimSpace(lang)) +} + +func expand(text string, args []any) string { + if len(args) < 2 || !strings.Contains(text, "{") { + return text + } + pairs := make([]string, 0, len(args)) + for i := 0; i+1 < len(args); i += 2 { + name, ok := args[i].(string) + if !ok { + continue + } + pairs = append(pairs, "{"+name+"}", fmt.Sprint(args[i+1])) + } + if len(pairs) == 0 { + return text + } + return strings.NewReplacer(pairs...).Replace(text) +} diff --git a/internal/i18n/i18n_test.go b/internal/i18n/i18n_test.go new file mode 100644 index 00000000..f848f163 --- /dev/null +++ b/internal/i18n/i18n_test.go @@ -0,0 +1,144 @@ +package i18n + +import ( + "encoding/json" + "os" + "path/filepath" + "slices" + "testing" +) + +func writeCatalog(t *testing.T, dir, lang string, entries map[string]string) { + t.Helper() + raw, err := json.Marshal(entries) + if err != nil { + t.Fatalf("Marshal() err = %v，期望 nil", err) + } + if err := os.WriteFile(filepath.Join(dir, lang+fileSuffix), raw, 0o644); err != nil { + t.Fatalf("WriteFile() err = %v，期望 nil", err) + } +} + +func load(t *testing.T, overrideDir string) *Bundle { + t.Helper() + b, err := Load(overrideDir) + if err != nil { + t.Fatalf("Load(%q) err = %v，期望 nil", overrideDir, err) + } + return b +} + +func TestLoadReadsEmbeddedCatalog(t *testing.T) { + l := load(t, "").Localizer(DefaultLanguage) + if got := l.T("button-copy-clipboard"); got != "复制" { + t.Errorf("T(%q) = %q，期望 %q", "button-copy-clipboard", got, "复制") + } +} + +func TestTReturnsIDWhenMissing(t *testing.T) { + l := load(t, "").Localizer(DefaultLanguage) + if got := l.T("no-such-id"); got != "no-such-id" { + t.Errorf("T(%q) = %q，期望 %q", "no-such-id", got, "no-such-id") + } +} + +func TestTFallsBackToDefaultLanguage(t *testing.T) { + dir := t.TempDir() + writeCatalog(t, dir, "en", map[string]string{"toc-open": "Expand"}) + b := load(t, dir) + + l := b.Localizer("en") + if got := l.T("toc-open"); got != "Expand" { + t.Errorf("T(%q) = %q，期望 %q", "toc-open", got, "Expand") + } + if got := l.T("toc-close"); got != "关闭" { + t.Errorf("T(%q) = %q，期望回退到 %q", "toc-close", got, "关闭") + } +} + +func TestTSubstitutesNamedArgs(t *testing.T) { + dir := t.TempDir() + writeCatalog(t, dir, DefaultLanguage, map[string]string{"greet": "{who} 有 {count} 条消息"}) + l := load(t, dir).Localizer(DefaultLanguage) + + if got := l.T("greet", "who", "Kakushi", "count", 3); got != "Kakushi 有 3 条消息" { + t.Errorf("T(greet) = %q，期望 %q", got, "Kakushi 有 3 条消息") + } +} + +func TestTLeavesUnsuppliedPlaceholders(t *testing.T) { + dir := t.TempDir() + writeCatalog(t, dir, DefaultLanguage, map[string]string{"greet": "{who} 有 {count} 条消息"}) + l := load(t, dir).Localizer(DefaultLanguage) + + if got := l.T("greet", "who", "Kakushi"); got != "Kakushi 有 {count} 条消息" { + t.Errorf("T(greet) = %q，期望 %q", got, "Kakushi 有 {count} 条消息") + } +} + +func TestTIgnoresTrailingOddArg(t *testing.T) { + dir := t.TempDir() + writeCatalog(t, dir, DefaultLanguage, map[string]string{"greet": "{who} 来了"}) + l := load(t, dir).Localizer(DefaultLanguage) + + if got := l.T("greet", "who", "Kakushi", "count"); got != "Kakushi 来了" { + t.Errorf("T(greet) = %q，期望 %q", got, "Kakushi 来了") + } +} + +func TestLoadMergesOverrideDir(t *testing.T) { + dir := t.TempDir() + writeCatalog(t, dir, DefaultLanguage, map[string]string{"toc-open": "打开"}) + l := load(t, dir).Localizer(DefaultLanguage) + + if got := l.T("toc-open"); got != "打开" { + t.Errorf("T(%q) = %q，期望被覆盖为 %q", "toc-open", got, "打开") + } + if got := l.T("toc-close"); got != "关闭" { + t.Errorf("T(%q) = %q，期望保留内置的 %q", "toc-close", got, "关闭") + } +} + +func TestLoadIgnoresMissingOverrideDir(t *testing.T) { + l := load(t, filepath.Join(t.TempDir(), "不存在")).Localizer(DefaultLanguage) + if got := l.T("toc-close"); got != "关闭" { + t.Errorf("T(%q) = %q，期望 %q", "toc-close", got, "关闭") + } +} + +func TestLoadRejectsBadJSON(t *testing.T) { + dir := t.TempDir() + if err := os.WriteFile(filepath.Join(dir, "en"+fileSuffix), []byte("{"), 0o644); err != nil { + t.Fatalf("WriteFile() err = %v，期望 nil", err) + } + if _, err := Load(dir); err == nil { + t.Error("Load() err = nil，期望非 nil") + } +} + +func TestLocalizerFallsBackForUnknownLanguage(t *testing.T) { + l := load(t, "").Localizer("de") + if l.Lang() != DefaultLanguage { + t.Errorf("Lang() = %q，期望 %q", l.Lang(), DefaultLanguage) + } +} + +func TestLocalizerNormalizesLanguageTag(t *testing.T) { + dir := t.TempDir() + writeCatalog(t, dir, "en", map[string]string{"toc-open": "Expand"}) + b := load(t, dir) + + if got := b.Localizer(" EN ").Lang(); got != "en" { + t.Errorf("Localizer(%q).Lang() = %q，期望 %q", " EN ", got, "en") + } +} + +func TestBundleLanguages(t *testing.T) { + dir := t.TempDir() + writeCatalog(t, dir, "en", map[string]string{"toc-open": "Expand"}) + got := load(t, dir).Languages() + + if !slices.Equal(got, []string{"en", "zh-hans"}) { + t.Errorf("Languages() = %v，期望 %v", got, []string{"en", "zh-hans"}) + } +} diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json new file mode 100644 index 00000000..a6a8dcc7 --- /dev/null +++ b/internal/i18n/locales/zh-hans.json @@ -0,0 +1,11 @@ +{ + "button-copy-clipboard": "复制", + "collapsible-hide": "- 关闭折叠", + "collapsible-open": "+ 打开折叠", + "footnote": "脚注", + "footnote-block-title": "脚注", + "image-context-bad": "图像地址不正确", + "table-of-contents": "内容", + "toc-close": "关闭", + "toc-open": "展开" +} diff --git a/internal/paths/paths.go b/internal/paths/paths.go index f0abf869..5130b7a6 100644 --- a/internal/paths/paths.go +++ b/internal/paths/paths.go @@ -96,6 +96,7 @@ func (p *Paths) Archive() string { return filepath.Join(p.root, "archive") } func (p *Paths) Secrets() string { return filepath.Join(p.root, "secrets") } func (p *Paths) PGData() string { return filepath.Join(p.root, "pgdata") } func (p *Paths) Postgres() string { return filepath.Join(p.root, "postgres") } +func (p *Paths) Locales() string { return filepath.Join(p.root, "locales") } func (p *Paths) Certs() string { return filepath.Join(p.Secrets(), "certs") } diff --git a/internal/paths/paths_test.go b/internal/paths/paths_test.go index f34d835c..e13db545 100644 --- a/internal/paths/paths_test.go +++ b/internal/paths/paths_test.go @@ -65,6 +65,7 @@ func TestLayoutIsFlat(t *testing.T) { "Secrets": p.Secrets(), "PGData": p.PGData(), "Postgres": p.Postgres(), + "Locales": p.Locales(), } for name, got := range cases { if filepath.Dir(got) != root { diff --git a/internal/routing/routing.go b/internal/routing/routing.go new file mode 100644 index 00000000..50845824 --- /dev/null +++ b/internal/routing/routing.go @@ -0,0 +1,121 @@ +package routing + +import ( + "fmt" + "net/http" + "slices" + "strings" +) + +type Owner string + +const ( + OwnerGo Owner = "go" + OwnerDjango Owner = "django" +) + +type Route struct { + Prefix string + Owner Owner + Label string +} + +const root = "/" + +var Table = []Route{ + {Prefix: "/", Owner: OwnerDjango, Label: "文章"}, + {Prefix: "/-/", Owner: OwnerDjango, Label: "系统页"}, + {Prefix: "/-/static/", Owner: OwnerDjango, Label: "静态资源"}, + {Prefix: "/api/", Owner: OwnerDjango, Label: "API"}, + {Prefix: "/local--files/", Owner: OwnerDjango, Label: "站点文件"}, + {Prefix: "/local--code/", Owner: OwnerDjango, Label: "代码块"}, + {Prefix: "/local--html/", Owner: OwnerDjango, Label: "内嵌 HTML"}, + {Prefix: "/local--theme/", Owner: OwnerDjango, Label: "页面主题"}, +} + +func Validate(table []Route) error { + seen := make(map[string]bool, len(table)) + hasRoot := false + for _, r := range table { + if !strings.HasPrefix(r.Prefix, "/") { + return fmt.Errorf("路由前缀 %q 不以 / 开头", r.Prefix) + } + if !strings.HasSuffix(r.Prefix, "/") { + return fmt.Errorf("路由前缀 %q 不以 / 结尾", r.Prefix) + } + if seen[r.Prefix] { + return fmt.Errorf("路由前缀 %q 重复", r.Prefix) + } + seen[r.Prefix] = true + if r.Owner != OwnerGo && r.Owner != OwnerDjango { + return fmt.Errorf("路由 %q 的 owner = %q，期望 go 或 django", r.Prefix, r.Owner) + } + if r.Prefix == root { + hasRoot = true + } + } + if !hasRoot { + return fmt.Errorf("路由表缺少兜底前缀 %q", root) + } + return nil +} + +type Mux struct { + routes []Route + fallback Route + handlers map[string]http.Handler +} + +var _ http.Handler = (*Mux)(nil) + +func New(table []Route, django http.Handler, goHandlers map[string]http.Handler) (*Mux, error) { + if err := Validate(table); err != nil { + return nil, err + } + if django == nil { + return nil, fmt.Errorf("django 转发处理器为 nil") + } + + handlers := make(map[string]http.Handler, len(table)) + var fallback Route + for _, r := range table { + switch r.Owner { + case OwnerDjango: + if _, ok := goHandlers[r.Prefix]; ok { + return nil, fmt.Errorf("路由 %q 的 owner = django，却注册了 Go 处理器", r.Prefix) + } + handlers[r.Prefix] = django + case OwnerGo: + h, ok := goHandlers[r.Prefix] + if !ok { + return nil, fmt.Errorf("路由 %q 的 owner = go，却没有注册处理器", r.Prefix) + } + handlers[r.Prefix] = h + } + if r.Prefix == root { + fallback = r + } + } + for prefix := range goHandlers { + if _, ok := handlers[prefix]; !ok { + return nil, fmt.Errorf("注册了 Go 处理器的前缀 %q 不在路由表里", prefix) + } + } + + routes := slices.Clone(table) + slices.SortFunc(routes, func(a, b Route) int { return len(b.Prefix) - len(a.Prefix) }) + return &Mux{routes: routes, fallback: fallback, handlers: handlers}, nil +} + +func (m *Mux) Route(path string) Route { + for _, r := range m.routes { + if strings.HasPrefix(path, r.Prefix) { + return r + } + } + return m.fallback +} + +func (m *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request) { + m.handlers[m.Route(r.URL.Path).Prefix].ServeHTTP(w, r) +} diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go new file mode 100644 index 00000000..0cea06d3 --- /dev/null +++ b/internal/routing/routing_test.go @@ -0,0 +1,126 @@ +package routing + +import ( + "net/http" + "net/http/httptest" + "testing" +) + +func stub(body string) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Write([]byte(body)) + }) +} + +func TestValidateAcceptsTable(t *testing.T) { + if err := Validate(Table); err != nil { + t.Errorf("Validate(Table) err = %v，期望 nil", err) + } +} + +func TestValidateRejectsBadTable(t *testing.T) { + tests := []struct { + name string + table []Route + }{ + {"前缀不以 / 开头", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "api/", Owner: OwnerDjango}}}, + {"前缀不以 / 结尾", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api", Owner: OwnerDjango}}}, + {"前缀重复", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerGo}}}, + {"owner 非法", []Route{{Prefix: "/", Owner: "rust"}}}, + {"缺兜底前缀", []Route{{Prefix: "/api/", Owner: OwnerDjango}}}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if err := Validate(tt.table); err == nil { + t.Error("Validate() err = nil，期望非 nil") + } + }) + } +} + +func TestMuxRouteLongestPrefixWins(t *testing.T) { + m, err := New(Table, stub("django"), nil) + if err != nil { + t.Fatalf("New() err = %v，期望 nil", err) + } + + tests := []struct { + path string + want string + }{ + {"/", "/"}, + {"/scp-173", "/"}, + {"/forum:start", "/"}, + {"/-/login", "/-/"}, + {"/-/static/app.js", "/-/static/"}, + {"/api/articles/scp-173/votes", "/api/"}, + {"/local--files/a/b.png", "/local--files/"}, + {"/local--theme/12/style.css", "/local--theme/"}, + {"/-", "/"}, + {"/apidocs", "/"}, + } + for _, tt := range tests { + t.Run(tt.path, func(t *testing.T) { + if got := m.Route(tt.path).Prefix; got != tt.want { + t.Errorf("Route(%q).Prefix = %q，期望 %q", tt.path, got, tt.want) + } + }) + } +} + +func TestNewRejectsNilDjango(t *testing.T) { + if _, err := New(Table, nil, nil); err == nil { + t.Error("New(django=nil) err = nil，期望非 nil") + } +} + +func TestNewRejectsGoRouteWithoutHandler(t *testing.T) { + table := []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerGo}} + if _, err := New(table, stub("django"), nil); err == nil { + t.Error("New() err = nil，期望非 nil") + } +} + +func TestNewRejectsDjangoRouteWithHandler(t *testing.T) { + table := []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerDjango}} + handlers := map[string]http.Handler{"/api/": stub("go")} + if _, err := New(table, stub("django"), handlers); err == nil { + t.Error("New() err = nil，期望非 nil") + } +} + +func TestNewRejectsHandlerOutsideTable(t *testing.T) { + table := []Route{{Prefix: "/", Owner: OwnerDjango}} + handlers := map[string]http.Handler{"/forum/": stub("go")} + if _, err := New(table, stub("django"), handlers); err == nil { + t.Error("New() err = nil，期望非 nil") + } +} + +func TestMuxServeHTTPDispatches(t *testing.T) { + table := []Route{ + {Prefix: "/", Owner: OwnerDjango}, + {Prefix: "/api/", Owner: OwnerGo}, + } + m, err := New(table, stub("django"), map[string]http.Handler{"/api/": stub("go")}) + if err != nil { + t.Fatalf("New() err = %v，期望 nil", err) + } + + tests := []struct { + path string + want string + }{ + {"/api/articles", "go"}, + {"/scp-173", "django"}, + } + for _, tt := range tests { + t.Run(tt.path, func(t *testing.T) { + rec := httptest.NewRecorder() + m.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, tt.path, nil)) + if got := rec.Body.String(); got != tt.want { + t.Errorf("ServeHTTP(%q) = %q，期望 %q", tt.path, got, tt.want) + } + }) + } +} From 3770b90ec9b7126d3d3f91699dca675b968e2e26 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 20 Aug 2026 14:19:51 +0900 Subject: [PATCH 003/428] =?UTF-8?q?=E7=A7=BB=E6=A4=8Dnormalize=5Farticle?= =?UTF-8?q?=5Fname?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cmd/pwikit/main.go | 13 +- go.mod | 2 + go.sum | 2 + internal/forward/forward.go | 34 +++- internal/forward/forward_test.go | 61 ++++++- internal/proxyheader/proxyheader.go | 118 ++++++++++++++ internal/proxyheader/proxyheader_test.go | 197 +++++++++++++++++++++++ internal/site/site.go | 72 +++++++++ internal/site/site_test.go | 155 ++++++++++++++++++ internal/wikidot/name.go | 128 +++++++++++++++ internal/wikidot/name_test.go | 164 +++++++++++++++++++ 11 files changed, 937 insertions(+), 9 deletions(-) create mode 100644 go.sum create mode 100644 internal/proxyheader/proxyheader.go create mode 100644 internal/proxyheader/proxyheader_test.go create mode 100644 internal/site/site.go create mode 100644 internal/site/site_test.go create mode 100644 internal/wikidot/name.go create mode 100644 internal/wikidot/name_test.go diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index b6e5c40e..15a3a074 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -7,11 +7,13 @@ import ( "log/slog" "net/http" "os" + "strings" "text/tabwriter" "time" "github.com/WikitTeam/ProjectWikit/internal/forward" "github.com/WikitTeam/ProjectWikit/internal/paths" + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" "github.com/WikitTeam/ProjectWikit/internal/routing" ) @@ -62,7 +64,11 @@ func serve(args []string) error { listen := fs.String("listen", defaultListen, "监听地址") upstream := fs.String("upstream", envOr(envUpstream, defaultUpstream), "转发未处理请求的上游地址") dataDir := fs.String("data-dir", "", "状态目录，默认取可执行文件所在目录") + trusted := fs.String("trusted-proxies", "", "可信前置代理的地址或网段，逗号分隔；留空则不信任任何 X-Forwarded-* 头") if err := fs.Parse(args); err != nil { + if errors.Is(err, flag.ErrHelp) { + return nil + } return err } @@ -76,7 +82,12 @@ func serve(args []string) error { log := slog.Default() - proxy, err := forward.New(*upstream, log) + trust, err := proxyheader.NewTrust(strings.Split(*trusted, ",")) + if err != nil { + return err + } + + proxy, err := forward.New(*upstream, trust, log) if err != nil { return err } diff --git a/go.mod b/go.mod index d1a47199..3657ca93 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,5 @@ module github.com/WikitTeam/ProjectWikit go 1.26 + +require golang.org/x/text v0.41.0 diff --git a/go.sum b/go.sum new file mode 100644 index 00000000..5a94f532 --- /dev/null +++ b/go.sum @@ -0,0 +1,2 @@ +golang.org/x/text v0.41.0 h1:vz/seA0lnX87Othu2f/0L24RcgrXD9/YFTSuGjj3rH8= +golang.org/x/text v0.41.0/go.mod h1:jvf1O8ajNzZqhSrQBPbutR/EB83Cc0CFrezNQIwbb5M= diff --git a/internal/forward/forward.go b/internal/forward/forward.go index a1510851..992c5b19 100644 --- a/internal/forward/forward.go +++ b/internal/forward/forward.go @@ -8,17 +8,26 @@ import ( "net/http" "net/http/httputil" "net/url" + + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" +) + +const ( + headerFor = "X-Forwarded-For" + headerHost = "X-Forwarded-Host" + headerProto = "X-Forwarded-Proto" ) type Proxy struct { target *url.URL + trust *proxyheader.Trust rp *httputil.ReverseProxy log *slog.Logger } var _ http.Handler = (*Proxy)(nil) -func New(target string, log *slog.Logger) (*Proxy, error) { +func New(target string, trust *proxyheader.Trust, log *slog.Logger) (*Proxy, error) { u, err := url.Parse(target) if err != nil { return nil, fmt.Errorf("上游地址 %q 解析失败: %w", target, err) @@ -29,11 +38,17 @@ func New(target string, log *slog.Logger) (*Proxy, error) { if u.Host == "" { return nil, fmt.Errorf("上游地址 %q 缺少 host", target) } + if trust == nil { + trust, err = proxyheader.NewTrust(nil) + if err != nil { + return nil, err + } + } if log == nil { log = slog.Default() } - p := &Proxy{target: u, log: log} + p := &Proxy{target: u, trust: trust, log: log} p.rp = &httputil.ReverseProxy{Rewrite: p.rewrite, ErrorHandler: p.handleError} return p, nil } @@ -45,10 +60,17 @@ func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request) { } func (p *Proxy) rewrite(pr *httputil.ProxyRequest) { - pr.Out.Header.Del("X-Forwarded-For") - pr.Out.Header.Del("X-Forwarded-Host") - pr.Out.Header.Del("X-Forwarded-Proto") - pr.SetXForwarded() + client, ok := p.trust.ClientIP(pr.In) + scheme := p.trust.Scheme(pr.In) + + pr.Out.Header.Del(headerFor) + pr.Out.Header.Del(headerHost) + pr.Out.Header.Del(headerProto) + if ok { + pr.Out.Header.Set(headerFor, client.String()) + } + pr.Out.Header.Set(headerHost, pr.In.Host) + pr.Out.Header.Set(headerProto, scheme) pr.SetURL(p.target) pr.Out.Host = pr.In.Host diff --git a/internal/forward/forward_test.go b/internal/forward/forward_test.go index d31455a9..70c13cfc 100644 --- a/internal/forward/forward_test.go +++ b/internal/forward/forward_test.go @@ -7,6 +7,8 @@ import ( "net/http/httptest" "strings" "testing" + + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" ) func quietLog() *slog.Logger { @@ -15,7 +17,7 @@ func quietLog() *slog.Logger { func newProxy(t *testing.T, upstream *httptest.Server) *Proxy { t.Helper() - p, err := New(upstream.URL, quietLog()) + p, err := New(upstream.URL, nil, quietLog()) if err != nil { t.Fatalf("New(%q) err = %v，期望 nil", upstream.URL, err) } @@ -34,7 +36,7 @@ func TestNewRejectsBadTarget(t *testing.T) { } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - if _, err := New(tt.target, quietLog()); err == nil { + if _, err := New(tt.target, nil, quietLog()); err == nil { t.Errorf("New(%q) err = nil，期望非 nil", tt.target) } }) @@ -160,3 +162,58 @@ func TestProxyReturns502WhenUpstreamDown(t *testing.T) { t.Errorf("StatusCode = %d，期望 %d", resp.StatusCode, http.StatusBadGateway) } } + +func TestProxyHonorsForwardedForFromTrustedPeer(t *testing.T) { + var xff string + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + xff = r.Header.Get("X-Forwarded-For") + })) + defer up.Close() + + trust, err := proxyheader.NewTrust([]string{"127.0.0.0/8", "::1/128"}) + if err != nil { + t.Fatalf("NewTrust() err = %v，期望 nil", err) + } + p, err := New(up.URL, trust, quietLog()) + if err != nil { + t.Fatalf("New() err = %v，期望 nil", err) + } + + front := httptest.NewServer(p) + defer front.Close() + + req, _ := http.NewRequest(http.MethodGet, front.URL+"/", nil) + req.Header.Set("X-Forwarded-For", "1.2.3.4") + resp, err := front.Client().Do(req) + if err != nil { + t.Fatalf("Do() err = %v，期望 nil", err) + } + resp.Body.Close() + + if xff != "1.2.3.4" { + t.Errorf("上游收到的 X-Forwarded-For = %q，期望 %q", xff, "1.2.3.4") + } +} + +func TestProxySetsForwardedHostToInboundHost(t *testing.T) { + var got string + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + got = r.Header.Get("X-Forwarded-Host") + })) + defer up.Close() + + front := httptest.NewServer(newProxy(t, up)) + defer front.Close() + + req, _ := http.NewRequest(http.MethodGet, front.URL+"/", nil) + req.Host = "media.example" + resp, err := front.Client().Do(req) + if err != nil { + t.Fatalf("Do() err = %v，期望 nil", err) + } + resp.Body.Close() + + if got != "media.example" { + t.Errorf("上游收到的 X-Forwarded-Host = %q，期望 %q", got, "media.example") + } +} diff --git a/internal/proxyheader/proxyheader.go b/internal/proxyheader/proxyheader.go new file mode 100644 index 00000000..6c4db6a5 --- /dev/null +++ b/internal/proxyheader/proxyheader.go @@ -0,0 +1,118 @@ +package proxyheader + +import ( + "fmt" + "net" + "net/http" + "net/netip" + "strings" +) + +const ( + headerFor = "X-Forwarded-For" + headerProto = "X-Forwarded-Proto" +) + +type Trust struct { + nets []netip.Prefix +} + +func NewTrust(sources []string) (*Trust, error) { + t := &Trust{} + for _, raw := range sources { + s := strings.TrimSpace(raw) + if s == "" { + continue + } + if strings.Contains(s, "/") { + p, err := netip.ParsePrefix(s) + if err != nil { + return nil, fmt.Errorf("可信代理网段 %q 解析失败: %w", s, err) + } + t.nets = append(t.nets, p.Masked()) + continue + } + a, err := netip.ParseAddr(s) + if err != nil { + return nil, fmt.Errorf("可信代理地址 %q 解析失败: %w", s, err) + } + a = a.Unmap() + t.nets = append(t.nets, netip.PrefixFrom(a, a.BitLen())) + } + return t, nil +} + +func (t *Trust) Trusted(addr netip.Addr) bool { + addr = addr.Unmap() + for _, p := range t.nets { + if p.Contains(addr) { + return true + } + } + return false +} + +func (t *Trust) ClientIP(r *http.Request) (netip.Addr, bool) { + peer, ok := PeerAddr(r.RemoteAddr) + if !ok || !t.Trusted(peer) { + return peer, ok + } + + hops := forwardedHops(r.Header) + for i := len(hops) - 1; i >= 0; i-- { + if !t.Trusted(hops[i]) { + return hops[i], true + } + } + if len(hops) > 0 { + return hops[0], true + } + return peer, true +} + +func (t *Trust) Scheme(r *http.Request) string { + direct := "http" + if r.TLS != nil { + direct = "https" + } + peer, ok := PeerAddr(r.RemoteAddr) + if !ok || !t.Trusted(peer) { + return direct + } + switch claimed := firstValue(r.Header.Get(headerProto)); claimed { + case "http", "https": + return claimed + } + return direct +} + +func PeerAddr(remoteAddr string) (netip.Addr, bool) { + host, _, err := net.SplitHostPort(remoteAddr) + if err != nil { + host = remoteAddr + } + a, err := netip.ParseAddr(strings.TrimSpace(host)) + if err != nil { + return netip.Addr{}, false + } + return a.Unmap(), true +} + +func forwardedHops(h http.Header) []netip.Addr { + var hops []netip.Addr + for _, line := range h.Values(headerFor) { + for _, part := range strings.Split(line, ",") { + a, err := netip.ParseAddr(strings.TrimSpace(part)) + if err != nil { + continue + } + hops = append(hops, a.Unmap()) + } + } + return hops +} + +func firstValue(header string) string { + value, _, _ := strings.Cut(header, ",") + return strings.ToLower(strings.TrimSpace(value)) +} diff --git a/internal/proxyheader/proxyheader_test.go b/internal/proxyheader/proxyheader_test.go new file mode 100644 index 00000000..5e9242cb --- /dev/null +++ b/internal/proxyheader/proxyheader_test.go @@ -0,0 +1,197 @@ +package proxyheader + +import ( + "crypto/tls" + "net/http" + "net/http/httptest" + "testing" +) + +func trust(t *testing.T, sources ...string) *Trust { + t.Helper() + tr, err := NewTrust(sources) + if err != nil { + t.Fatalf("NewTrust(%v) err = %v，期望 nil", sources, err) + } + return tr +} + +func request(remoteAddr string, header http.Header) *http.Request { + r := httptest.NewRequest(http.MethodGet, "/", nil) + r.RemoteAddr = remoteAddr + if header != nil { + r.Header = header + } + return r +} + +func headers(pairs ...string) http.Header { + h := http.Header{} + for i := 0; i+1 < len(pairs); i += 2 { + h.Add(pairs[i], pairs[i+1]) + } + return h +} + +func TestNewTrustRejectsBadSource(t *testing.T) { + tests := []struct { + name string + source string + }{ + {"不是地址", "nonsense"}, + {"网段位数越界", "10.0.0.0/33"}, + {"带端口", "10.0.0.1:80"}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if _, err := NewTrust([]string{tt.source}); err == nil { + t.Errorf("NewTrust(%q) err = nil，期望非 nil", tt.source) + } + }) + } +} + +func TestNewTrustSkipsEmptySource(t *testing.T) { + tr := trust(t, "", " ", "10.0.0.0/8") + if len(tr.nets) != 1 { + t.Errorf("len(nets) = %d，期望 1", len(tr.nets)) + } +} + +func TestTrustedMatchesBareAddress(t *testing.T) { + tr := trust(t, "10.0.0.1") + tests := []struct { + addr string + want bool + }{ + {"10.0.0.1", true}, + {"10.0.0.2", false}, + {"::ffff:10.0.0.1", true}, + } + for _, tt := range tests { + t.Run(tt.addr, func(t *testing.T) { + a, ok := PeerAddr(tt.addr) + if !ok { + t.Fatalf("PeerAddr(%q) ok = false，期望 true", tt.addr) + } + if got := tr.Trusted(a); got != tt.want { + t.Errorf("Trusted(%q) = %v，期望 %v", tt.addr, got, tt.want) + } + }) + } +} + +func TestClientIPIgnoresHeaderFromUntrustedPeer(t *testing.T) { + tr := trust(t, "10.0.0.0/8") + r := request("203.0.113.9:1234", headers(headerFor, "1.2.3.4")) + + got, ok := tr.ClientIP(r) + if !ok { + t.Fatalf("ClientIP() ok = false，期望 true") + } + if got.String() != "203.0.113.9" { + t.Errorf("ClientIP() = %q，期望 %q", got, "203.0.113.9") + } +} + +func TestClientIPUsesHeaderFromTrustedPeer(t *testing.T) { + tr := trust(t, "10.0.0.0/8") + r := request("10.0.0.1:1234", headers(headerFor, "1.2.3.4")) + + got, _ := tr.ClientIP(r) + if got.String() != "1.2.3.4" { + t.Errorf("ClientIP() = %q，期望 %q", got, "1.2.3.4") + } +} + +func TestClientIPSkipsTrustedHops(t *testing.T) { + tr := trust(t, "10.0.0.0/8") + r := request("10.0.0.1:1234", headers(headerFor, "1.2.3.4, 10.0.0.9, 10.0.0.8")) + + got, _ := tr.ClientIP(r) + if got.String() != "1.2.3.4" { + t.Errorf("ClientIP() = %q，期望 %q", got, "1.2.3.4") + } +} + +func TestClientIPReadsRepeatedHeaderLines(t *testing.T) { + tr := trust(t, "10.0.0.0/8") + r := request("10.0.0.1:1234", headers(headerFor, "1.2.3.4", headerFor, "10.0.0.9")) + + got, _ := tr.ClientIP(r) + if got.String() != "1.2.3.4" { + t.Errorf("ClientIP() = %q，期望 %q", got, "1.2.3.4") + } +} + +func TestClientIPFallsBackToLeftmostWhenAllHopsTrusted(t *testing.T) { + tr := trust(t, "10.0.0.0/8") + r := request("10.0.0.1:1234", headers(headerFor, "10.0.0.7, 10.0.0.9")) + + got, _ := tr.ClientIP(r) + if got.String() != "10.0.0.7" { + t.Errorf("ClientIP() = %q，期望 %q", got, "10.0.0.7") + } +} + +func TestClientIPSkipsUnparsableHops(t *testing.T) { + tr := trust(t, "10.0.0.0/8") + r := request("10.0.0.1:1234", headers(headerFor, "unknown, 1.2.3.4, 10.0.0.9")) + + got, _ := tr.ClientIP(r) + if got.String() != "1.2.3.4" { + t.Errorf("ClientIP() = %q，期望 %q", got, "1.2.3.4") + } +} + +func TestClientIPWithEmptyTrustAlwaysUsesPeer(t *testing.T) { + tr := trust(t) + r := request("10.0.0.1:1234", headers(headerFor, "1.2.3.4")) + + got, _ := tr.ClientIP(r) + if got.String() != "10.0.0.1" { + t.Errorf("ClientIP() = %q，期望 %q", got, "10.0.0.1") + } +} + +func TestClientIPReportsUnparsablePeer(t *testing.T) { + tr := trust(t, "10.0.0.0/8") + if _, ok := tr.ClientIP(request("@", nil)); ok { + t.Error("ClientIP() ok = true，期望 false") + } +} + +func TestScheme(t *testing.T) { + tests := []struct { + name string + remoteAddr string + proto string + tls bool + want string + }{ + {"无头且非 TLS", "10.0.0.1:1", "", false, "http"}, + {"无头且 TLS", "10.0.0.1:1", "", true, "https"}, + {"可信来源声称 https", "10.0.0.1:1", "https", false, "https"}, + {"不可信来源声称 https", "203.0.113.9:1", "https", false, "http"}, + {"可信来源声称 http 而连接是 TLS", "10.0.0.1:1", "http", true, "http"}, + {"取逗号分隔的第一个", "10.0.0.1:1", "https, http", false, "https"}, + {"大小写不敏感", "10.0.0.1:1", "HTTPS", false, "https"}, + {"取值非法时回退", "10.0.0.1:1", "gopher", false, "http"}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + tr := trust(t, "10.0.0.0/8") + var h http.Header + if tt.proto != "" { + h = headers(headerProto, tt.proto) + } + r := request(tt.remoteAddr, h) + if tt.tls { + r.TLS = &tls.ConnectionState{} + } + if got := tr.Scheme(r); got != tt.want { + t.Errorf("Scheme() = %q，期望 %q", got, tt.want) + } + }) + } +} diff --git a/internal/site/site.go b/internal/site/site.go new file mode 100644 index 00000000..a8069fca --- /dev/null +++ b/internal/site/site.go @@ -0,0 +1,72 @@ +package site + +import ( + "net" + "net/url" + "strings" +) + +type Site struct { + Domain string + MediaDomain string +} + +var MediaPrefixes = []string{ + "/local--files/", + "/local--code/", + "/local--html/", + "/local--theme/", +} + +type Action int + +const ( + Serve Action = iota + Redirect +) + +type Decision struct { + Action Action + Location string +} + +func Decide(s Site, rawHost string, u *url.URL) Decision { + if s.MediaDomain == "" || s.MediaDomain == s.Domain { + return Decision{Action: Serve} + } + + onMediaHost := StripPort(rawHost) == s.MediaDomain + wantsMedia := IsMediaPath(u.Path) + + switch { + case onMediaHost && !wantsMedia: + return Decision{Action: Redirect, Location: "//" + s.Domain + u.RequestURI()} + case !onMediaHost && wantsMedia: + return Decision{Action: Redirect, Location: "//" + s.MediaDomain + u.RequestURI()} + } + return Decision{Action: Serve} +} + +func IsMediaPath(path string) bool { + for _, prefix := range MediaPrefixes { + if strings.HasPrefix(path, prefix) { + return true + } + } + return false +} + +func LookupHosts(rawHost, serverPort string) []string { + var hosts []string + if serverPort != "" && !strings.Contains(rawHost, ":") { + hosts = append(hosts, rawHost+":"+serverPort) + } + return append(hosts, StripPort(rawHost)) +} + +func StripPort(rawHost string) string { + if host, _, err := net.SplitHostPort(rawHost); err == nil { + return host + } + return strings.Trim(rawHost, "[]") +} diff --git a/internal/site/site_test.go b/internal/site/site_test.go new file mode 100644 index 00000000..ee9ce097 --- /dev/null +++ b/internal/site/site_test.go @@ -0,0 +1,155 @@ +package site + +import ( + "net/url" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/routing" +) + +var split = Site{Domain: "wiki.example", MediaDomain: "media.example"} + +func mustURL(t *testing.T, raw string) *url.URL { + t.Helper() + u, err := url.Parse(raw) + if err != nil { + t.Fatalf("Parse(%q) err = %v，期望 nil", raw, err) + } + return u +} + +func TestIsMediaPath(t *testing.T) { + tests := []struct { + path string + want bool + }{ + {"/local--files/a.png", true}, + {"/local--code/12/0", true}, + {"/local--html/12/abc", true}, + {"/local--theme/12/style.css", true}, + {"/scp-173", false}, + {"/", false}, + {"/local--files", false}, + {"/x/local--files/a.png", false}, + {"/local--filesx/a.png", false}, + } + for _, tt := range tests { + t.Run(tt.path, func(t *testing.T) { + if got := IsMediaPath(tt.path); got != tt.want { + t.Errorf("IsMediaPath(%q) = %v，期望 %v", tt.path, got, tt.want) + } + }) + } +} + +func TestStripPort(t *testing.T) { + tests := []struct { + in string + want string + }{ + {"example.org", "example.org"}, + {"example.org:8000", "example.org"}, + {"[::1]:8000", "::1"}, + {"[::1]", "::1"}, + {"::1", "::1"}, + {"", ""}, + } + for _, tt := range tests { + t.Run(tt.in, func(t *testing.T) { + if got := StripPort(tt.in); got != tt.want { + t.Errorf("StripPort(%q) = %q，期望 %q", tt.in, got, tt.want) + } + }) + } +} + +func TestLookupHosts(t *testing.T) { + tests := []struct { + name string + rawHost string + serverPort string + want []string + }{ + {"无端口时先试带端口的", "example.org", "8000", []string{"example.org:8000", "example.org"}}, + {"已带端口时只试去端口的", "example.org:8000", "8000", []string{"example.org"}}, + {"没有端口信息", "example.org", "", []string{"example.org"}}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := LookupHosts(tt.rawHost, tt.serverPort) + if strings.Join(got, ",") != strings.Join(tt.want, ",") { + t.Errorf("LookupHosts(%q, %q) = %v，期望 %v", tt.rawHost, tt.serverPort, got, tt.want) + } + }) + } +} + +func TestDecideServesWhenDomainsAreSame(t *testing.T) { + s := Site{Domain: "wiki.example", MediaDomain: "wiki.example"} + got := Decide(s, "wiki.example", mustURL(t, "/local--files/a.png")) + if got.Action != Serve { + t.Errorf("Decide().Action = %v，期望 Serve", got.Action) + } +} + +func TestDecideServesWhenMediaDomainEmpty(t *testing.T) { + s := Site{Domain: "wiki.example"} + got := Decide(s, "wiki.example", mustURL(t, "/local--files/a.png")) + if got.Action != Serve { + t.Errorf("Decide().Action = %v，期望 Serve", got.Action) + } +} + +func TestDecideRedirects(t *testing.T) { + tests := []struct { + name string + host string + target string + wantLoc string + wantKind Action + }{ + {"媒体路径打在主域上", "wiki.example", "/local--files/a.png", "//media.example/local--files/a.png", Redirect}, + {"非媒体路径打在媒体域上", "media.example", "/scp-173", "//wiki.example/scp-173", Redirect}, + {"媒体路径打在媒体域上", "media.example", "/local--files/a.png", "", Serve}, + {"非媒体路径打在主域上", "wiki.example", "/scp-173", "", Serve}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := Decide(split, tt.host, mustURL(t, tt.target)) + if got.Action != tt.wantKind { + t.Errorf("Decide().Action = %v，期望 %v", got.Action, tt.wantKind) + } + if got.Location != tt.wantLoc { + t.Errorf("Decide().Location = %q，期望 %q", got.Location, tt.wantLoc) + } + }) + } +} + +func TestDecideKeepsQueryAndEscaping(t *testing.T) { + got := Decide(split, "wiki.example", mustURL(t, "/local--files/a%20b.png?size=200")) + want := "//media.example/local--files/a%20b.png?size=200" + if got.Location != want { + t.Errorf("Decide().Location = %q，期望 %q", got.Location, want) + } +} + +func TestDecideIgnoresPortInHost(t *testing.T) { + got := Decide(split, "media.example:8000", mustURL(t, "/local--files/a.png")) + if got.Action != Serve { + t.Errorf("Decide().Action = %v，期望 Serve", got.Action) + } +} + +func TestMediaPrefixesAreInRouteTable(t *testing.T) { + inTable := make(map[string]bool, len(routing.Table)) + for _, r := range routing.Table { + inTable[r.Prefix] = true + } + for _, prefix := range MediaPrefixes { + if !inTable[prefix] { + t.Errorf("routing.Table 缺少媒体前缀 %q", prefix) + } + } +} diff --git a/internal/wikidot/name.go b/internal/wikidot/name.go new file mode 100644 index 00000000..f5ec0fe5 --- /dev/null +++ b/internal/wikidot/name.go @@ -0,0 +1,128 @@ +package wikidot + +import ( + "slices" + "strings" + "unicode" + "unicode/utf8" + + "golang.org/x/text/unicode/norm" +) + +const ( + DefaultCategory = "_default" + maxNameLength = 128 +) + +var translit = map[rune]string{ + 'а': "a", 'б': "b", 'в': "v", 'г': "g", 'д': "d", 'е': "e", 'ж': "z", + 'з': "z", 'и': "i", 'й': "i", 'к': "k", 'л': "l", 'м': "m", 'н': "n", 'о': "o", + 'п': "p", 'р': "r", 'с': "s", 'т': "t", 'у': "u", 'ф': "f", 'х': "h", 'ц': "c", + 'ч': "c", 'ы': "i", 'э': "e", 'ю': "u", 'я': "a", 'і': "i", 'ї': "i", 'є': "e", + 'ь': "", 'ъ': "", +} + +var reserved = []string{"-", "_", "api", "forum", "local--files", "local--code", "local--html", "local--theme"} + +func Normalize(fullName string) string { + var b strings.Builder + for _, r := range stripAccents(strings.ToLower(fullName)) { + if sub, ok := translit[r]; ok { + b.WriteString(sub) + continue + } + b.WriteRune(r) + } + + s := strings.Trim(dashRuns(b.String()), "-") + s = strings.Trim(collapseColons(s), ":") + + category, name := Split(s) + if category == DefaultCategory { + return name + } + return category + ":" + name +} + +func Split(fullName string) (category, name string) { + if c, n, ok := strings.Cut(fullName, ":"); ok { + return c, n + } + return DefaultCategory, fullName +} + +func Denormalize(fullName string) string { + if strings.Contains(fullName, ":") { + return fullName + } + return DefaultCategory + ":" + fullName +} + +func NameAllowed(fullName string) bool { + s := strings.ToLower(fullName) + if s == "" || slices.Contains(reserved, s) { + return false + } + if utf8.RuneCountInString(s) > maxNameLength { + return false + } + for _, r := range s { + if !allowed(r) { + return false + } + } + category, name := Split(s) + return strings.TrimSpace(category) != "" && strings.TrimSpace(name) != "" +} + +func stripAccents(s string) string { + var b strings.Builder + for _, r := range norm.NFD.String(s) { + if unicode.Is(unicode.Mn, r) { + continue + } + b.WriteRune(r) + } + return b.String() +} + +func dashRuns(s string) string { + var b strings.Builder + pending := false + for _, r := range s { + if !allowed(r) { + pending = true + continue + } + if pending { + b.WriteByte('-') + pending = false + } + b.WriteRune(r) + } + if pending { + b.WriteByte('-') + } + return b.String() +} + +func collapseColons(s string) string { + var b strings.Builder + prev := false + for _, r := range s { + if r == ':' && prev { + continue + } + prev = r == ':' + b.WriteRune(r) + } + return b.String() +} + +func allowed(r rune) bool { + switch { + case r >= 'a' && r <= 'z', r >= 'A' && r <= 'Z', r >= '0' && r <= '9': + return true + } + return r == '-' || r == '_' || r == ':' +} diff --git a/internal/wikidot/name_test.go b/internal/wikidot/name_test.go new file mode 100644 index 00000000..d2de6c18 --- /dev/null +++ b/internal/wikidot/name_test.go @@ -0,0 +1,164 @@ +package wikidot + +import ( + "strings" + "testing" +) + +func TestNormalize(t *testing.T) { + tests := []struct { + name string + in string + want string + }{ + {"转小写", "SCP-173", "scp-173"}, + {"保留分类", "SCP:173", "scp:173"}, + {"去掉默认分类", "_default:foo", "foo"}, + {"空格变连字符", "Foo Bar", "foo-bar"}, + {"连续非法字符只出一个连字符", "foo bar", "foo-bar"}, + {"首尾连字符去掉", "--foo--", "foo"}, + {"连续冒号折叠", "a::b", "a:b"}, + {"首尾冒号去掉", "::a::", "a"}, + {"只取第一个冒号做分隔", "a:b:c", "a:b:c"}, + {"空串", "", ""}, + {"拉丁重音字符去重音", "Café", "cafe"}, + {"下划线保留", "foo_bar", "foo_bar"}, + {"数字保留", "scp-001-ex", "scp-001-ex"}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := Normalize(tt.in); got != tt.want { + t.Errorf("Normalize(%q) = %q，期望 %q", tt.in, got, tt.want) + } + }) + } +} + +func TestNormalizeCyrillic(t *testing.T) { + tests := []struct { + name string + in string + want string + }{ + {"逐字转写", "тест", "test"}, + {"ё 经 NFD 退化为 е", "Ёлка", "elka"}, + {"й 有映射", "йод", "iod"}, + {"软硬音符被删除", "тьма", "tma"}, + {"ж 与 з 都映射到 z", "жз", "zz"}, + {"ч 与 ц 都映射到 c", "чц", "cc"}, + {"映射表没有 ш，落到非法字符分支", "Школа", "kola"}, + {"映射表没有 щ", "щи", "i"}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := Normalize(tt.in); got != tt.want { + t.Errorf("Normalize(%q) = %q，期望 %q", tt.in, got, tt.want) + } + }) + } +} + +func TestNormalizeDropsCJK(t *testing.T) { + tests := []struct { + in string + want string + }{ + {"测试", ""}, + {"测试page", "page"}, + {"page 测试", "page"}, + {"前测试后", ""}, + {"a测b", "a-b"}, + } + for _, tt := range tests { + t.Run(tt.in, func(t *testing.T) { + if got := Normalize(tt.in); got != tt.want { + t.Errorf("Normalize(%q) = %q，期望 %q", tt.in, got, tt.want) + } + }) + } +} + +func TestSplit(t *testing.T) { + tests := []struct { + in string + wantCategory string + wantName string + }{ + {"scp:173", "scp", "173"}, + {"173", DefaultCategory, "173"}, + {"a:b:c", "a", "b:c"}, + {"", DefaultCategory, ""}, + {":x", "", "x"}, + } + for _, tt := range tests { + t.Run(tt.in, func(t *testing.T) { + category, name := Split(tt.in) + if category != tt.wantCategory { + t.Errorf("Split(%q) category = %q，期望 %q", tt.in, category, tt.wantCategory) + } + if name != tt.wantName { + t.Errorf("Split(%q) name = %q，期望 %q", tt.in, name, tt.wantName) + } + }) + } +} + +func TestDenormalize(t *testing.T) { + tests := []struct { + in string + want string + }{ + {"173", "_default:173"}, + {"scp:173", "scp:173"}, + {"", "_default:"}, + } + for _, tt := range tests { + t.Run(tt.in, func(t *testing.T) { + if got := Denormalize(tt.in); got != tt.want { + t.Errorf("Denormalize(%q) = %q，期望 %q", tt.in, got, tt.want) + } + }) + } +} + +func TestNameAllowed(t *testing.T) { + tests := []struct { + name string + in string + want bool + }{ + {"普通名字", "scp-173", true}, + {"带分类", "scp:173", true}, + {"大写也认", "SCP-173", true}, + {"空串", "", false}, + {"保留名 api", "api", false}, + {"保留名大写", "API", false}, + {"保留名 local--files", "local--files", false}, + {"中文", "测试", false}, + {"空格", "foo bar", false}, + {"斜杠", "foo/bar", false}, + {"分类为空", ":173", false}, + {"名字为空", "scp:", false}, + {"128 字符", strings.Repeat("a", 128), true}, + {"129 字符", strings.Repeat("a", 129), false}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := NameAllowed(tt.in); got != tt.want { + t.Errorf("NameAllowed(%q) = %v，期望 %v", tt.in, got, tt.want) + } + }) + } +} + +func TestNormalizeOutputIsAllowed(t *testing.T) { + inputs := []string{"SCP-173", "Foo Bar", "тест", "Café", "a::b"} + for _, in := range inputs { + t.Run(in, func(t *testing.T) { + got := Normalize(in) + if !NameAllowed(got) { + t.Errorf("NameAllowed(Normalize(%q)) = NameAllowed(%q) = false，期望 true", in, got) + } + }) + } +} From 3a5c6b83db2ea725c5c214031fa4ce95432f9ccc Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 20 Aug 2026 14:57:08 +0900 Subject: [PATCH 004/428] Implement PageCallbacks and wikidot modules output --- .gitignore | 3 +- cmd/pwikit/main.go | 20 ++ internal/callbacks/callbacks.go | 174 +++++++++++ internal/callbacks/callbacks_test.go | 333 +++++++++++++++++++++ internal/callbacks/injected.js | 57 ++++ internal/callbacks/integration_test.go | 109 +++++++ internal/expr/builtin.go | 269 +++++++++++++++++ internal/expr/eval.go | 229 ++++++++++++++ internal/expr/expr_test.go | 311 +++++++++++++++++++ internal/expr/parse.go | 395 +++++++++++++++++++++++++ internal/expr/value.go | 106 +++++++ internal/i18n/locales/zh-hans.json | 6 +- internal/modules/registry.go | 63 ++++ internal/modules/registry_test.go | 77 +++++ 14 files changed, 2150 insertions(+), 2 deletions(-) create mode 100644 internal/callbacks/callbacks.go create mode 100644 internal/callbacks/callbacks_test.go create mode 100644 internal/callbacks/injected.js create mode 100644 internal/callbacks/integration_test.go create mode 100644 internal/expr/builtin.go create mode 100644 internal/expr/eval.go create mode 100644 internal/expr/expr_test.go create mode 100644 internal/expr/parse.go create mode 100644 internal/expr/value.go create mode 100644 internal/modules/registry.go create mode 100644 internal/modules/registry_test.go diff --git a/.gitignore b/.gitignore index efd6f0e1..d305cfda 100644 --- a/.gitignore +++ b/.gitignore @@ -14,4 +14,5 @@ archive *.env venv .DS_Store -TODOtions.txt \ No newline at end of file +TODOtions.txt +target diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 15a3a074..c4537017 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -12,6 +12,7 @@ import ( "time" "github.com/WikitTeam/ProjectWikit/internal/forward" + "github.com/WikitTeam/ProjectWikit/internal/modules" "github.com/WikitTeam/ProjectWikit/internal/paths" "github.com/WikitTeam/ProjectWikit/internal/proxyheader" "github.com/WikitTeam/ProjectWikit/internal/routing" @@ -38,6 +39,8 @@ func run(args []string) error { switch args[0] { case "serve": return serve(args[1:]) + case "modules": + return printModules() case "routes": return printRoutes() case "help", "-h", "--help": @@ -55,6 +58,7 @@ func usage() { 子命令: serve 启动 HTTP 服务 routes 打印静态路由表 + modules 打印 wikidot 模块清单 help 显示本帮助 `) } @@ -124,3 +128,19 @@ func printRoutes() error { } return w.Flush() } + +func printModules() error { + w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0) + fmt.Fprintln(w, "MODULE\tBODY\tSTATUS") + for _, info := range modules.All() { + status := "pending" + switch { + case info.Removed: + status = "removed" + case info.Ported: + status = "ported" + } + fmt.Fprintf(w, "%s\t%t\t%s\n", info.Name, info.HasContent, status) + } + return w.Flush() +} diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go new file mode 100644 index 00000000..5af6aed4 --- /dev/null +++ b/internal/callbacks/callbacks.go @@ -0,0 +1,174 @@ +package callbacks + +import ( + _ "embed" + "encoding/json" + "errors" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/expr" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/modules" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" +) + +//go:embed injected.js +var injectedCode string + +const MaxIncludeLevel = 25 + +var ( + ErrUserNotFound = errors.New("用户不存在") + ErrNoRepository = errors.New("没有配置数据源") +) + +type ModuleError struct{ Message string } + +func (e *ModuleError) Error() string { return e.Message } + +type Repository interface { + RenderModule(name string, params map[string]string, body string) (string, error) + RenderUser(username string, avatar bool) (string, error) + PageInfo(refs []string) ([]renderer.PartialPageInfo, error) + IncludeSources(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) +} + +type Callbacks struct { + loc *i18n.Localizer + repo Repository + level int + includeErrors map[string]bool +} + +var _ renderer.Callbacks = (*Callbacks)(nil) + +func New(loc *i18n.Localizer, repo Repository) *Callbacks { + return &Callbacks{ + loc: loc, + repo: repo, + level: MaxIncludeLevel, + includeErrors: make(map[string]bool), + } +} + +func (c *Callbacks) ModuleHasBody(name string) (bool, error) { + return modules.HasContent(name), nil +} + +func (c *Callbacks) RenderModule(name string, params map[string]string, body string) (string, error) { + if c.repo == nil { + return "", ErrNoRepository + } + lowered := make(map[string]string, len(params)) + for key, value := range params { + lowered[strings.ToLower(key)] = value + } + html, err := c.repo.RenderModule(name, lowered, body) + var moduleErr *ModuleError + if errors.As(err, &moduleErr) { + return `

` + djangoEscape(moduleErr.Message) + `

`, nil + } + if err != nil { + return "", err + } + return html, nil +} + +func (c *Callbacks) RenderUser(username string, avatar bool) (string, error) { + if c.repo == nil { + return "", ErrNoRepository + } + html, err := c.repo.RenderUser(username, avatar) + if errors.Is(err, ErrUserNotFound) { + return `` + c.text("user-not-found", "name", djangoEscape(username)) + ``, nil + } + if err != nil { + return "", err + } + return html, nil +} + +func (c *Callbacks) GetI18nMessage(id string) (string, error) { + return c.text(id), nil +} + +func (c *Callbacks) GetHTMLInjectedCode(id string) (string, error) { + encoded, err := json.Marshal(id) + if err != nil { + return "", err + } + return strings.Replace(injectedCode, "%s", string(encoded), 1), nil +} + +func (c *Callbacks) GetPageInfo(refs []string) ([]renderer.PartialPageInfo, error) { + if c.repo == nil { + return nil, ErrNoRepository + } + return c.repo.PageInfo(refs) +} + +func (c *Callbacks) EvaluateExpression(source string) (renderer.ExpressionResult, error) { + v := expr.Evaluate(source) + switch v.Kind { + case expr.KindFloat: + return renderer.FloatExpr(v.Float), nil + case expr.KindInt, expr.KindBool: + return renderer.IntExpr(v.AsInt()), nil + case expr.KindStr: + return renderer.StringExpr(v.Str), nil + } + return renderer.ExpressionResult{}, nil +} + +func (c *Callbacks) NormalizePageName(fullName string) (string, error) { + return wikidot.Normalize(fullName), nil +} + +func (c *Callbacks) IncludePages(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) { + if c.level <= 0 { + out := make([]renderer.FetchedPage, 0, len(refs)) + for _, ref := range refs { + c.includeErrors[wikidot.Normalize(ref.FullName)] = true + out = append(out, renderer.FetchedPage{FullName: ref.FullName}) + } + return out, nil + } + if c.repo == nil { + return nil, ErrNoRepository + } + return c.repo.IncludeSources(refs) +} + +func (c *Callbacks) NoSuchInclude(fullName string) (string, error) { + if c.includeErrors[wikidot.Normalize(fullName)] { + return `[[div class="error-block"]]` + c.text("include-loop", "name", fullName) + `[[/div]]`, nil + } + return `[[div class="error-block"]]` + c.text("include-missing", "name", fullName) + + ` ([[a href="/` + fullName + `/edit/true" target="_blank"]]` + c.text("include-create") + `[[/a]])[[/div]]`, nil +} + +func (c *Callbacks) NextIncludeLevel() (bool, error) { + if c.level <= 0 { + return false, nil + } + c.level-- + return true, nil +} + +func (c *Callbacks) text(id string, args ...any) string { + if c.loc == nil { + return id + } + return c.loc.T(id, args...) +} + +var escaper = strings.NewReplacer( + "&", "&", + "<", "<", + ">", ">", + `"`, """, + "'", "'", +) + +func djangoEscape(s string) string { return escaper.Replace(s) } diff --git a/internal/callbacks/callbacks_test.go b/internal/callbacks/callbacks_test.go new file mode 100644 index 00000000..b494ac03 --- /dev/null +++ b/internal/callbacks/callbacks_test.go @@ -0,0 +1,333 @@ +package callbacks + +import ( + "errors" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/renderer" +) + +type fakeRepo struct { + moduleErr error + userErr error + + moduleName string + moduleParam map[string]string + includeSeen []renderer.IncludeRef +} + +func (r *fakeRepo) RenderModule(name string, params map[string]string, body string) (string, error) { + r.moduleName = name + r.moduleParam = params + if r.moduleErr != nil { + return "", r.moduleErr + } + return "
" + name + "
", nil +} + +func (r *fakeRepo) RenderUser(username string, avatar bool) (string, error) { + if r.userErr != nil { + return "", r.userErr + } + return "" + username + "", nil +} + +func (r *fakeRepo) PageInfo(refs []string) ([]renderer.PartialPageInfo, error) { + out := make([]renderer.PartialPageInfo, 0, len(refs)) + for _, ref := range refs { + out = append(out, renderer.PartialPageInfo{FullName: ref, Exists: true}) + } + return out, nil +} + +func (r *fakeRepo) IncludeSources(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) { + r.includeSeen = refs + out := make([]renderer.FetchedPage, 0, len(refs)) + for _, ref := range refs { + body := "内容" + out = append(out, renderer.FetchedPage{FullName: ref.FullName, Content: &body}) + } + return out, nil +} + +func newCallbacks(t *testing.T, repo Repository) *Callbacks { + t.Helper() + bundle, err := i18n.Load("") + if err != nil { + t.Fatalf("i18n.Load() err = %v，期望 nil", err) + } + return New(bundle.Localizer(i18n.DefaultLanguage), repo) +} + +func TestModuleHasBody(t *testing.T) { + c := newCallbacks(t, nil) + tests := []struct { + name string + want bool + }{ + {"css", true}, + {"CSS", true}, + {"rate", false}, + {"interwiki", false}, + {"nosuchmodule", false}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := c.ModuleHasBody(tt.name) + if err != nil { + t.Fatalf("ModuleHasBody(%q) err = %v，期望 nil", tt.name, err) + } + if got != tt.want { + t.Errorf("ModuleHasBody(%q) = %v，期望 %v", tt.name, got, tt.want) + } + }) + } +} + +func TestRenderModuleLowercasesParamKeys(t *testing.T) { + repo := &fakeRepo{} + c := newCallbacks(t, repo) + + if _, err := c.RenderModule("Rate", map[string]string{"ShowVotes": "yes"}, ""); err != nil { + t.Fatalf("RenderModule() err = %v，期望 nil", err) + } + if repo.moduleName != "Rate" { + t.Errorf("moduleName = %q，期望 %q", repo.moduleName, "Rate") + } + if _, ok := repo.moduleParam["showvotes"]; !ok { + t.Errorf("params = %v，期望含键 %q", repo.moduleParam, "showvotes") + } +} + +func TestRenderModuleTurnsModuleErrorIntoErrorBlock(t *testing.T) { + repo := &fakeRepo{moduleErr: &ModuleError{Message: `坏了 &`}} + c := newCallbacks(t, repo) + + got, err := c.RenderModule("rate", nil, "") + if err != nil { + t.Fatalf("RenderModule() err = %v，期望 nil", err) + } + want := `

坏了 <b>&

` + if got != want { + t.Errorf("RenderModule() = %q，期望 %q", got, want) + } +} + +func TestRenderModulePropagatesOtherErrors(t *testing.T) { + boom := errors.New("数据库炸了") + c := newCallbacks(t, &fakeRepo{moduleErr: boom}) + + if _, err := c.RenderModule("rate", nil, ""); !errors.Is(err, boom) { + t.Errorf("RenderModule() err = %v，期望 %v", err, boom) + } +} + +func TestRenderUserNotFound(t *testing.T) { + c := newCallbacks(t, &fakeRepo{userErr: ErrUserNotFound}) + + got, err := c.RenderUser("kaku用户 'kaku<shi' 不存在` + if got != want { + t.Errorf("RenderUser() = %q，期望 %q", got, want) + } +} + +func TestGetI18nMessage(t *testing.T) { + c := newCallbacks(t, nil) + tests := []struct { + id string + want string + }{ + {"button-copy-clipboard", "复制"}, + {"toc-open", "展开"}, + {"no-such-message", "no-such-message"}, + } + for _, tt := range tests { + t.Run(tt.id, func(t *testing.T) { + got, err := c.GetI18nMessage(tt.id) + if err != nil { + t.Fatalf("GetI18nMessage(%q) err = %v，期望 nil", tt.id, err) + } + if got != tt.want { + t.Errorf("GetI18nMessage(%q) = %q，期望 %q", tt.id, got, tt.want) + } + }) + } +} + +func TestGetHTMLInjectedCodeSubstitutesIDOnce(t *testing.T) { + c := newCallbacks(t, nil) + + got, err := c.GetHTMLInjectedCode("abc-12") + if err != nil { + t.Fatalf("GetHTMLInjectedCode() err = %v，期望 nil", err) + } + if !strings.Contains(got, `id: "abc-12"`) { + t.Errorf("输出不含 %q", `id: "abc-12"`) + } + if strings.Contains(got, "%s") { + t.Errorf("输出仍含占位符 %q，期望已被替换", "%s") + } + if !strings.HasPrefix(got, "\n + + \ No newline at end of file diff --git a/internal/callbacks/integration_test.go b/internal/callbacks/integration_test.go new file mode 100644 index 00000000..f80827d1 --- /dev/null +++ b/internal/callbacks/integration_test.go @@ -0,0 +1,109 @@ +package callbacks + +import ( + "context" + "os" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/renderer/sidecar" +) + +type siteRepo struct { + existing map[string]bool +} + +func (r siteRepo) RenderModule(name string, params map[string]string, body string) (string, error) { + return `
` + name + "|" + body + `
`, nil +} + +func (r siteRepo) RenderUser(username string, avatar bool) (string, error) { + if username != "kakushi" { + return "", ErrUserNotFound + } + return `kakushi`, nil +} + +func (r siteRepo) PageInfo(refs []string) ([]renderer.PartialPageInfo, error) { + var out []renderer.PartialPageInfo + for _, ref := range refs { + if r.existing[ref] { + title := ref + out = append(out, renderer.PartialPageInfo{FullName: ref, Exists: true, Title: &title}) + } + } + return out, nil +} + +func (r siteRepo) IncludeSources(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) { + out := make([]renderer.FetchedPage, 0, len(refs)) + for _, ref := range refs { + page := renderer.FetchedPage{FullName: ref.FullName} + if r.existing[ref.FullName] { + body := "**被包含的内容**" + page.Content = &body + } + out = append(out, page) + } + return out, nil +} + +func renderWith(t *testing.T, source string) string { + t.Helper() + binary := os.Getenv(sidecar.EnvBinary) + if binary == "" { + t.Skipf("未设置 %s，跳过真实渲染链路测试", sidecar.EnvBinary) + } + r, err := sidecar.New(binary) + if err != nil { + t.Fatalf("sidecar.New(%q) err = %v，期望 nil", binary, err) + } + t.Cleanup(func() { r.Close() }) + + bundle, err := i18n.Load("") + if err != nil { + t.Fatalf("i18n.Load() err = %v，期望 nil", err) + } + cb := New(bundle.Localizer(i18n.DefaultLanguage), siteRepo{existing: map[string]bool{"exists": true}}) + + info := renderer.PageInfo{Page: "173", Category: "scp", Domain: "example.org"} + got, err := r.RenderHTML(context.Background(), source, info, cb, renderer.ModeArticle) + if err != nil { + t.Fatalf("RenderHTML(%q) err = %v，期望 nil", source, err) + } + return got.Body +} + +func TestRealRenderUsesCallbacks(t *testing.T) { + tests := []struct { + name string + source string + want string + }{ + {"模块", "[[module Rate]]", `
Rate|
`}, + {"带 body 的模块", "[[module CSS]]div{}[[/module]]", `
CSS|div{}
`}, + {"红链", "[[[missing|红]]]", `class="newpage"`}, + {"已存在的链接不是红链", "[[[exists|蓝]]]", `href="/exists"`}, + {"用户", "[[user kakushi]]", `kakushi`}, + {"用户不存在", "[[user nobody]]", "用户 'nobody' 不存在"}, + {"include 缺失", "[[include :other:page]]", "不存在"}, + {"include 存在", "[[include exists]]", "被包含的内容"}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got := renderWith(t, tt.source) + if !strings.Contains(got, tt.want) { + t.Errorf("RenderHTML(%q) = %q，期望包含 %q", tt.source, got, tt.want) + } + }) + } +} + +func TestRealRenderUsesI18nCatalog(t *testing.T) { + got := renderWith(t, "正文[[footnote]]脚注内容[[/footnote]]") + if !strings.Contains(got, "脚注") { + t.Errorf("RenderHTML() = %q，期望包含 %q", got, "脚注") + } +} diff --git a/internal/expr/builtin.go b/internal/expr/builtin.go new file mode 100644 index 00000000..4187678c --- /dev/null +++ b/internal/expr/builtin.go @@ -0,0 +1,269 @@ +package expr + +import ( + "fmt" + "math" + "math/rand/v2" + "strings" +) + +var brokenTrig = map[string]bool{ + "sin": true, "cos": true, "tan": true, + "asin": true, "acos": true, "atan": true, +} + +func evalCall(n *callNode) (Value, error) { + args := make([]Value, 0, len(n.args)) + for _, a := range n.args { + v, err := eval(a) + if err != nil { + return None(), err + } + args = append(args, v) + } + + if brokenTrig[n.name] { + return None(), fmt.Errorf("%w: %s 在 Python 侧就是坏的", errType, n.name) + } + + switch n.name { + case "min", "max": + return extremum(n.name, args) + case "abs": + return absOf(args) + case "round": + return roundOf(args) + case "ceil", "floor": + return ceilFloor(n.name, args) + case "div": + return floorDiv(args) + case "random": + return randomOf(args) + case "sqrt": + return sqrtOf(args) + case "pow": + return powOf(args) + case "unset": + return unsetOf(args) + case "len": + return lenOf(args) + case "lower", "upper": + return changeCase(n.name, args) + case "substr": + return substrOf(args) + } + return None(), fmt.Errorf("%w: 未知函数 %q", errType, n.name) +} + +func arity(args []Value, allowed ...int) error { + for _, n := range allowed { + if len(args) == n { + return nil + } + } + return fmt.Errorf("%w: 参数个数 %d", errType, len(args)) +} + +func extremum(name string, args []Value) (Value, error) { + if len(args) < 2 { + return None(), fmt.Errorf("%w: %s 需要至少两个参数", errType, name) + } + best := args[0] + for _, v := range args[1:] { + cmp, err := order(v, best) + if err != nil { + return None(), err + } + if (name == "min" && cmp < 0) || (name == "max" && cmp > 0) { + best = v + } + } + return best, nil +} + +func absOf(args []Value) (Value, error) { + if err := arity(args, 1); err != nil { + return None(), err + } + x := args[0] + if !x.numeric() { + return None(), errType + } + if x.Kind == KindFloat { + return FloatOf(math.Abs(x.Float)), nil + } + if n := x.toInt(); n < 0 { + return IntOf(-n), nil + } + return IntOf(x.toInt()), nil +} + +func roundOf(args []Value) (Value, error) { + if err := arity(args, 1, 2); err != nil { + return None(), err + } + x := args[0] + if !x.numeric() { + return None(), errType + } + var digits int64 + if len(args) == 2 { + if !args[1].integral() { + return None(), errType + } + digits = args[1].toInt() + } + + if x.integral() { + if digits >= 0 { + return IntOf(x.toInt()), nil + } + shift := math.Pow(10, float64(-digits)) + return IntOf(int64(math.RoundToEven(float64(x.toInt())/shift) * shift)), nil + } + shift := math.Pow(10, float64(digits)) + return FloatOf(math.RoundToEven(x.Float*shift) / shift), nil +} + +func ceilFloor(name string, args []Value) (Value, error) { + if err := arity(args, 1); err != nil { + return None(), err + } + x := args[0] + if !x.numeric() { + return None(), errType + } + if x.integral() { + return IntOf(x.toInt()), nil + } + if name == "ceil" { + return IntOf(int64(math.Ceil(x.Float))), nil + } + return IntOf(int64(math.Floor(x.Float))), nil +} + +func floorDiv(args []Value) (Value, error) { + if err := arity(args, 2); err != nil { + return None(), err + } + x, y := args[0], args[1] + if !x.numeric() || !y.numeric() { + return None(), errType + } + if y.toFloat() == 0 { + return None(), fmt.Errorf("%w: 除以零", errType) + } + if x.integral() && y.integral() { + a, b := x.toInt(), y.toInt() + q := a / b + if (a%b != 0) && ((a < 0) != (b < 0)) { + q-- + } + return IntOf(q), nil + } + return FloatOf(math.Floor(x.toFloat() / y.toFloat())), nil +} + +func randomOf(args []Value) (Value, error) { + if err := arity(args, 2); err != nil { + return None(), err + } + if !args[0].integral() || !args[1].integral() { + return None(), errType + } + low, high := args[0].toInt(), args[1].toInt() + if low > high { + return None(), fmt.Errorf("%w: random 的下界大于上界", errType) + } + return IntOf(low + rand.Int64N(high-low+1)), nil +} + +func sqrtOf(args []Value) (Value, error) { + if err := arity(args, 1); err != nil { + return None(), err + } + if !args[0].numeric() { + return None(), errType + } + f := args[0].toFloat() + if f < 0 { + return None(), fmt.Errorf("%w: sqrt 的参数为负", errType) + } + return FloatOf(math.Sqrt(f)), nil +} + +func powOf(args []Value) (Value, error) { + if err := arity(args, 2); err != nil { + return None(), err + } + if !args[0].numeric() || !args[1].numeric() { + return None(), errType + } + return FloatOf(math.Pow(args[0].toFloat(), args[1].toFloat())), nil +} + +func unsetOf(args []Value) (Value, error) { + if err := arity(args, 1); err != nil { + return None(), err + } + s := args[0].PyStr() + return BoolOf(strings.HasPrefix(s, "%%") && strings.HasSuffix(s, "%%")), nil +} + +func lenOf(args []Value) (Value, error) { + if err := arity(args, 1); err != nil { + return None(), err + } + if args[0].Kind != KindStr { + return None(), errType + } + return IntOf(int64(len([]rune(args[0].Str)))), nil +} + +func changeCase(name string, args []Value) (Value, error) { + if err := arity(args, 1); err != nil { + return None(), err + } + if args[0].Kind != KindStr { + return None(), errType + } + if name == "lower" { + return StrOf(strings.ToLower(args[0].Str)), nil + } + return StrOf(strings.ToUpper(args[0].Str)), nil +} + +func substrOf(args []Value) (Value, error) { + if err := arity(args, 2, 3); err != nil { + return None(), err + } + if args[0].Kind != KindStr || !args[1].integral() { + return None(), errType + } + runes := []rune(args[0].Str) + start := clampIndex(args[1].toInt(), len(runes)) + stop := len(runes) + if len(args) == 3 { + if !args[2].integral() { + return None(), errType + } + stop = clampIndex(args[2].toInt(), len(runes)) + } + if stop <= start { + return StrOf(""), nil + } + return StrOf(string(runes[start:stop])), nil +} + +func clampIndex(i int64, n int) int { + if i < 0 { + i += int64(n) + if i < 0 { + return 0 + } + } + if i > int64(n) { + return n + } + return int(i) +} diff --git a/internal/expr/eval.go b/internal/expr/eval.go new file mode 100644 index 00000000..19dfa9b7 --- /dev/null +++ b/internal/expr/eval.go @@ -0,0 +1,229 @@ +package expr + +import ( + "fmt" + "strings" +) + +func Evaluate(src string) Value { + n, err := parse(src) + if err != nil { + return None() + } + v, err := eval(n) + if err != nil { + return None() + } + return v +} + +func eval(n node) (Value, error) { + switch n := n.(type) { + case *constNode: + return n.v, nil + case *unaryNode: + return evalUnary(n) + case *binNode: + return evalBinary(n) + case *cmpNode: + return evalCompare(n) + case *boolNode: + return evalBool(n) + case *callNode: + return evalCall(n) + } + return None(), fmt.Errorf("%w: 未知节点", errType) +} + +func evalUnary(n *unaryNode) (Value, error) { + if n.op != "-" { + return None(), fmt.Errorf("%w: 一元运算 %q", errType, n.op) + } + x, err := eval(n.x) + if err != nil { + return None(), err + } + if !x.numeric() { + return None(), errType + } + if x.Kind == KindFloat { + return FloatOf(-x.Float), nil + } + return IntOf(-x.toInt()), nil +} + +func evalBinary(n *binNode) (Value, error) { + x, err := eval(n.x) + if err != nil { + return None(), err + } + y, err := eval(n.y) + if err != nil { + return None(), err + } + + switch n.op { + case "+": + if x.Kind == KindStr && y.Kind == KindStr { + return StrOf(x.Str + y.Str), nil + } + return arith(x, y, func(a, b int64) int64 { return a + b }, func(a, b float64) float64 { return a + b }) + case "-": + return arith(x, y, func(a, b int64) int64 { return a - b }, func(a, b float64) float64 { return a - b }) + case "*": + if repeated, ok := repeat(x, y); ok { + return repeated, nil + } + return arith(x, y, func(a, b int64) int64 { return a * b }, func(a, b float64) float64 { return a * b }) + case "/": + if !x.numeric() || !y.numeric() { + return None(), errType + } + if y.toFloat() == 0 { + return None(), fmt.Errorf("%w: 除以零", errType) + } + return FloatOf(x.toFloat() / y.toFloat()), nil + case "^": + if !x.integral() || !y.integral() { + return None(), errType + } + if x.Kind == KindBool && y.Kind == KindBool { + return BoolOf(x.Bool != y.Bool), nil + } + return IntOf(x.toInt() ^ y.toInt()), nil + } + return None(), fmt.Errorf("%w: 二元运算 %q", errType, n.op) +} + +func arith(x, y Value, ints func(a, b int64) int64, floats func(a, b float64) float64) (Value, error) { + if !x.numeric() || !y.numeric() { + return None(), errType + } + if x.Kind == KindFloat || y.Kind == KindFloat { + return FloatOf(floats(x.toFloat(), y.toFloat())), nil + } + return IntOf(ints(x.toInt(), y.toInt())), nil +} + +func repeat(x, y Value) (Value, bool) { + str, count := x, y + if str.Kind != KindStr { + str, count = y, x + } + if str.Kind != KindStr || !count.integral() { + return None(), false + } + n := count.toInt() + if n <= 0 { + return StrOf(""), true + } + return StrOf(strings.Repeat(str.Str, int(n))), true +} + +func evalCompare(n *cmpNode) (Value, error) { + for i, op := range n.ops { + left, err := eval(n.items[i]) + if err != nil { + return None(), err + } + right, err := eval(n.items[i+1]) + if err != nil { + return None(), err + } + ok, err := compare(left, op, right) + if err != nil { + return None(), err + } + if !ok { + return BoolOf(false), nil + } + } + return BoolOf(true), nil +} + +func compare(x Value, op string, y Value) (bool, error) { + switch op { + case "==": + return equal(x, y), nil + case "!=": + return !equal(x, y), nil + } + cmp, err := order(x, y) + if err != nil { + return false, err + } + switch op { + case "<": + return cmp < 0, nil + case "<=": + return cmp <= 0, nil + case ">": + return cmp > 0, nil + case ">=": + return cmp >= 0, nil + } + return false, fmt.Errorf("%w: 比较运算 %q", errType, op) +} + +func equal(x, y Value) bool { + switch { + case x.integral() && y.integral(): + return x.toInt() == y.toInt() + case x.numeric() && y.numeric(): + return x.toFloat() == y.toFloat() + case x.Kind == KindStr && y.Kind == KindStr: + return x.Str == y.Str + case x.Kind == KindNone && y.Kind == KindNone: + return true + } + return false +} + +func order(x, y Value) (int, error) { + switch { + case x.integral() && y.integral(): + return cmpInt(x.toInt(), y.toInt()), nil + case x.numeric() && y.numeric(): + return cmpFloat(x.toFloat(), y.toFloat()), nil + case x.Kind == KindStr && y.Kind == KindStr: + return strings.Compare(x.Str, y.Str), nil + } + return 0, errType +} + +func cmpInt(a, b int64) int { + switch { + case a < b: + return -1 + case a > b: + return 1 + } + return 0 +} + +func cmpFloat(a, b float64) int { + switch { + case a < b: + return -1 + case a > b: + return 1 + } + return 0 +} + +func evalBool(n *boolNode) (Value, error) { + truthy := 0 + for _, item := range n.items { + v, err := eval(item) + if err != nil { + return None(), err + } + if v.Truthy() { + truthy++ + } + } + if n.op == "and" { + return BoolOf(truthy == len(n.items)), nil + } + return BoolOf(truthy > 0), nil +} diff --git a/internal/expr/expr_test.go b/internal/expr/expr_test.go new file mode 100644 index 00000000..6d3f401b --- /dev/null +++ b/internal/expr/expr_test.go @@ -0,0 +1,311 @@ +package expr + +import "testing" + +func check(t *testing.T, src string, want Value) { + t.Helper() + got := Evaluate(src) + if got != want { + t.Errorf("Evaluate(%q) = %+v，期望 %+v", src, got, want) + } +} + +func TestEvaluateLiterals(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"1", IntOf(1)}, + {"-1", IntOf(-1)}, + {"1.5", FloatOf(1.5)}, + {".5", FloatOf(0.5)}, + {"1e3", FloatOf(1000)}, + {"1e-3", FloatOf(0.001)}, + {"'abc'", StrOf("abc")}, + {`"abc"`, StrOf("abc")}, + {`'a\nb'`, StrOf("a\nb")}, + {"True", BoolOf(true)}, + {"False", BoolOf(false)}, + {"None", None()}, + {" 1 ", IntOf(1)}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateArithmetic(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"1 + 2", IntOf(3)}, + {"5 - 8", IntOf(-3)}, + {"3 * 4", IntOf(12)}, + {"1 + 2 * 3", IntOf(7)}, + {"(1 + 2) * 3", IntOf(9)}, + {"1.5 + 1", FloatOf(2.5)}, + {"True + True", IntOf(2)}, + {"-True", IntOf(-1)}, + {"'a' + 'b'", StrOf("ab")}, + {"'ab' * 3", StrOf("ababab")}, + {"3 * 'ab'", StrOf("ababab")}, + {"'ab' * 0", StrOf("")}, + {"'a' + 1", None()}, + {"-'a'", None()}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateDivisionIsAlwaysFloat(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"6 / 3", FloatOf(2)}, + {"7 / 2", FloatOf(3.5)}, + {"1 / 0", None()}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateCaretIsXorNotPower(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"2 ^ 3", IntOf(1)}, + {"1 ^ 2 + 3", IntOf(4)}, + {"True ^ False", BoolOf(true)}, + {"True ^ 1", IntOf(0)}, + {"1.0 ^ 2", None()}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateComparison(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"1 == 1", BoolOf(true)}, + {"1 != 2", BoolOf(true)}, + {"1 < 2 < 3", BoolOf(true)}, + {"1 < 2 > 5", BoolOf(false)}, + {"'a' < 'b'", BoolOf(true)}, + {"1 == True", BoolOf(true)}, + {"1 == '1'", BoolOf(false)}, + {"None == None", BoolOf(true)}, + {"None == 0", BoolOf(false)}, + {"1 < 'a'", None()}, + {"1 <= 1.0", BoolOf(true)}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateBoolOpsReturnBoolNotOperand(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"1 and 2", BoolOf(true)}, + {"0 and 2", BoolOf(false)}, + {"0 or 2", BoolOf(true)}, + {"0 or ''", BoolOf(false)}, + {"'x' or 0", BoolOf(true)}, + {"1 or 0 and 0", BoolOf(true)}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateUnsupportedUnary(t *testing.T) { + for _, src := range []string{"not True", "+1", "not 0"} { + t.Run(src, func(t *testing.T) { check(t, src, None()) }) + } +} + +func TestEvaluateNumericBuiltins(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"min(3, 1, 2)", IntOf(1)}, + {"max(3, 1, 2)", IntOf(3)}, + {"min(5)", None()}, + {"min(1, 'a')", None()}, + {"abs(-3)", IntOf(3)}, + {"abs(-3.5)", FloatOf(3.5)}, + {"abs('a')", None()}, + {"ceil(1.2)", IntOf(2)}, + {"floor(1.8)", IntOf(1)}, + {"ceil(2)", IntOf(2)}, + {"div(7, 2)", IntOf(3)}, + {"div(-7, 2)", IntOf(-4)}, + {"div(7, 0)", None()}, + {"sqrt(9)", FloatOf(3)}, + {"sqrt(-1)", None()}, + {"pow(2, 3)", FloatOf(8)}, + {"pow(2, 0.5)", FloatOf(1.4142135623730951)}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateRoundUsesBankersRoundingAndReturnsFloat(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"round(2.5)", FloatOf(2)}, + {"round(3.5)", FloatOf(4)}, + {"round(-2.5)", FloatOf(-2)}, + {"round(2.34, 1)", FloatOf(2.3)}, + {"round(7)", IntOf(7)}, + {"round('a')", None()}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateTrigAlwaysFails(t *testing.T) { + for _, src := range []string{"sin(0)", "cos(0)", "tan(0)", "asin(0)", "acos(1)", "atan(0)"} { + t.Run(src, func(t *testing.T) { check(t, src, None()) }) + } +} + +func TestEvaluateStringBuiltins(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"len('abc')", IntOf(3)}, + {"len('中文')", IntOf(2)}, + {"len(3)", None()}, + {"lower('ABC')", StrOf("abc")}, + {"upper('abc')", StrOf("ABC")}, + {"upper(3)", None()}, + {"substr('abcdef', 1, 3)", StrOf("bc")}, + {"substr('abcdef', 2)", StrOf("cdef")}, + {"substr('abcdef', -2)", StrOf("ef")}, + {"substr('abcdef', 4, 2)", StrOf("")}, + {"substr('abcdef', 0, 99)", StrOf("abcdef")}, + {"substr('中文字', 1, 2)", StrOf("文")}, + {"substr(3, 1)", None()}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateUnset(t *testing.T) { + tests := []struct { + src string + want Value + }{ + {"unset('%%title%%')", BoolOf(true)}, + {"unset('title')", BoolOf(false)}, + {"unset('%%')", BoolOf(true)}, + {"unset(1)", BoolOf(false)}, + } + for _, tt := range tests { + t.Run(tt.src, func(t *testing.T) { check(t, tt.src, tt.want) }) + } +} + +func TestEvaluateFunctionNamesAreCaseInsensitive(t *testing.T) { + check(t, "MIN(1, 2)", IntOf(1)) + check(t, "Upper('a')", StrOf("A")) +} + +func TestEvaluateConstantNamesAreCaseSensitive(t *testing.T) { + for _, src := range []string{"true", "false", "none"} { + t.Run(src, func(t *testing.T) { check(t, src, None()) }) + } +} + +func TestEvaluateMalformedInput(t *testing.T) { + tests := []string{ + "", + " ", + "1 +", + "1 2", + "(1", + "1)", + "foo", + "foo(1)", + "1 % 2", + "7 // 2", + "'unterminated", + "1, 2", + "min(1,)", + } + for _, src := range tests { + t.Run(src, func(t *testing.T) { check(t, src, None()) }) + } +} + +func TestEvaluateRandomStaysInRange(t *testing.T) { + for range 50 { + got := Evaluate("random(1, 3)") + if got.Kind != KindInt || got.Int < 1 || got.Int > 3 { + t.Fatalf("Evaluate(\"random(1, 3)\") = %+v，期望 1..3 的整数", got) + } + } + check(t, "random(3, 1)", None()) +} + +func TestPyStr(t *testing.T) { + tests := []struct { + in Value + want string + }{ + {None(), "None"}, + {BoolOf(true), "True"}, + {BoolOf(false), "False"}, + {IntOf(-7), "-7"}, + {FloatOf(1), "1.0"}, + {FloatOf(1.5), "1.5"}, + {StrOf("x"), "x"}, + } + for _, tt := range tests { + t.Run(tt.want, func(t *testing.T) { + if got := tt.in.PyStr(); got != tt.want { + t.Errorf("PyStr(%+v) = %q，期望 %q", tt.in, got, tt.want) + } + }) + } +} + +func TestTruthy(t *testing.T) { + tests := []struct { + in Value + want bool + }{ + {None(), false}, + {BoolOf(false), false}, + {IntOf(0), false}, + {IntOf(1), true}, + {FloatOf(0), false}, + {StrOf(""), false}, + {StrOf("0"), true}, + } + for _, tt := range tests { + t.Run(tt.in.PyStr(), func(t *testing.T) { + if got := tt.in.Truthy(); got != tt.want { + t.Errorf("Truthy(%+v) = %v，期望 %v", tt.in, got, tt.want) + } + }) + } +} diff --git a/internal/expr/parse.go b/internal/expr/parse.go new file mode 100644 index 00000000..cff3f296 --- /dev/null +++ b/internal/expr/parse.go @@ -0,0 +1,395 @@ +package expr + +import ( + "errors" + "fmt" + "strconv" + "strings" +) + +var errSyntax = errors.New("表达式语法错误") + +type node interface{} + +type constNode struct{ v Value } + +type unaryNode struct { + op string + x node +} + +type binNode struct { + op string + x, y node +} + +type cmpNode struct { + ops []string + items []node +} + +type boolNode struct { + op string + items []node +} + +type callNode struct { + name string + args []node +} + +type tokenKind uint8 + +const ( + tokEOF tokenKind = iota + tokNumber + tokString + tokIdent + tokOp +) + +type token struct { + kind tokenKind + text string + v Value +} + +var operators = []string{"==", "!=", "<=", ">=", "<", ">", "+", "-", "*", "/", "^", "(", ")", ","} + +const ( + quoteSingle = '\'' + quoteDouble = '"' + backslash = '\\' +) + +func lex(src string) ([]token, error) { + var out []token + i := 0 + for i < len(src) { + c := src[i] + switch { + case c == ' ' || c == '\t' || c == '\n' || c == '\r': + i++ + case c == '#': + for i < len(src) && src[i] != '\n' { + i++ + } + case c == quoteSingle || c == quoteDouble: + s, next, err := lexString(src, i) + if err != nil { + return nil, err + } + out = append(out, token{kind: tokString, v: StrOf(s)}) + i = next + case isDigit(c) || (c == '.' && i+1 < len(src) && isDigit(src[i+1])): + v, next, err := lexNumber(src, i) + if err != nil { + return nil, err + } + out = append(out, token{kind: tokNumber, v: v}) + i = next + case isIdentStart(c): + j := i + for j < len(src) && isIdentPart(src[j]) { + j++ + } + out = append(out, token{kind: tokIdent, text: src[i:j]}) + i = j + default: + op := matchOperator(src[i:]) + if op == "" { + return nil, fmt.Errorf("%w: 无法识别的字符 %q", errSyntax, string(c)) + } + out = append(out, token{kind: tokOp, text: op}) + i += len(op) + } + } + return append(out, token{kind: tokEOF}), nil +} + +func matchOperator(s string) string { + for _, op := range operators { + if strings.HasPrefix(s, op) { + return op + } + } + return "" +} + +func isDigit(c byte) bool { return c >= '0' && c <= '9' } + +func isIdentStart(c byte) bool { + return c == '_' || (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || c >= 0x80 +} + +func isIdentPart(c byte) bool { return isIdentStart(c) || isDigit(c) } + +func lexString(src string, start int) (string, int, error) { + quote := src[start] + var b strings.Builder + i := start + 1 + for i < len(src) { + switch src[i] { + case quote: + return b.String(), i + 1, nil + case backslash: + if i+1 >= len(src) { + return "", 0, fmt.Errorf("%w: 字符串以反斜杠结尾", errSyntax) + } + switch src[i+1] { + case 'n': + b.WriteByte('\n') + case 't': + b.WriteByte('\t') + case 'r': + b.WriteByte('\r') + default: + b.WriteByte(src[i+1]) + } + i += 2 + default: + b.WriteByte(src[i]) + i++ + } + } + return "", 0, fmt.Errorf("%w: 字符串没有闭合", errSyntax) +} + +func lexNumber(src string, start int) (Value, int, error) { + i := start + isFloat := false + for i < len(src) { + c := src[i] + if isDigit(c) { + i++ + continue + } + if c == '.' && !isFloat { + isFloat = true + i++ + continue + } + if (c == 'e' || c == 'E') && i > start && exponentFollows(src, i) { + isFloat = true + i += 2 + continue + } + break + } + + text := src[start:i] + if isFloat { + f, err := strconv.ParseFloat(text, 64) + if err != nil { + return None(), 0, fmt.Errorf("%w: %q 不是数字", errSyntax, text) + } + return FloatOf(f), i, nil + } + n, err := strconv.ParseInt(text, 10, 64) + if err != nil { + return None(), 0, fmt.Errorf("%w: %q 不是整数", errSyntax, text) + } + return IntOf(n), i, nil +} + +func exponentFollows(src string, i int) bool { + if i+1 >= len(src) { + return false + } + if isDigit(src[i+1]) { + return true + } + return (src[i+1] == '+' || src[i+1] == '-') && i+2 < len(src) && isDigit(src[i+2]) +} + +type parser struct { + tokens []token + pos int +} + +func parse(src string) (node, error) { + tokens, err := lex(src) + if err != nil { + return nil, err + } + p := &parser{tokens: tokens} + n, err := p.parseOr() + if err != nil { + return nil, err + } + if p.peek().kind != tokEOF { + return nil, fmt.Errorf("%w: 表达式结尾有多余内容", errSyntax) + } + return n, nil +} + +func (p *parser) peek() token { return p.tokens[p.pos] } + +func (p *parser) acceptOp(ops ...string) (string, bool) { + t := p.peek() + if t.kind != tokOp { + return "", false + } + for _, op := range ops { + if t.text == op { + p.pos++ + return op, true + } + } + return "", false +} + +func (p *parser) acceptWord(word string) bool { + if t := p.peek(); t.kind == tokIdent && t.text == word { + p.pos++ + return true + } + return false +} + +func (p *parser) parseOr() (node, error) { return p.parseBool("or", p.parseAnd) } +func (p *parser) parseAnd() (node, error) { return p.parseBool("and", p.parseCompare) } + +func (p *parser) parseBool(word string, next func() (node, error)) (node, error) { + first, err := next() + if err != nil { + return nil, err + } + items := []node{first} + for p.acceptWord(word) { + operand, err := next() + if err != nil { + return nil, err + } + items = append(items, operand) + } + if len(items) == 1 { + return first, nil + } + return &boolNode{op: word, items: items}, nil +} + +func (p *parser) parseCompare() (node, error) { + first, err := p.parseXor() + if err != nil { + return nil, err + } + var ops []string + items := []node{first} + for { + op, ok := p.acceptOp("==", "!=", "<=", ">=", "<", ">") + if !ok { + break + } + operand, err := p.parseXor() + if err != nil { + return nil, err + } + ops = append(ops, op) + items = append(items, operand) + } + if len(ops) == 0 { + return first, nil + } + return &cmpNode{ops: ops, items: items}, nil +} + +func (p *parser) parseXor() (node, error) { return p.parseBinary(p.parseAdd, "^") } +func (p *parser) parseAdd() (node, error) { return p.parseBinary(p.parseMul, "+", "-") } +func (p *parser) parseMul() (node, error) { return p.parseBinary(p.parseUnary, "*", "/") } + +func (p *parser) parseBinary(next func() (node, error), ops ...string) (node, error) { + left, err := next() + if err != nil { + return nil, err + } + for { + op, ok := p.acceptOp(ops...) + if !ok { + return left, nil + } + right, err := next() + if err != nil { + return nil, err + } + left = &binNode{op: op, x: left, y: right} + } +} + +func (p *parser) parseUnary() (node, error) { + if op, ok := p.acceptOp("-", "+"); ok { + operand, err := p.parseUnary() + if err != nil { + return nil, err + } + return &unaryNode{op: op, x: operand}, nil + } + if p.acceptWord("not") { + operand, err := p.parseUnary() + if err != nil { + return nil, err + } + return &unaryNode{op: "not", x: operand}, nil + } + return p.parseAtom() +} + +func (p *parser) parseAtom() (node, error) { + t := p.peek() + switch t.kind { + case tokNumber, tokString: + p.pos++ + return &constNode{v: t.v}, nil + case tokIdent: + p.pos++ + switch t.text { + case "True": + return &constNode{v: BoolOf(true)}, nil + case "False": + return &constNode{v: BoolOf(false)}, nil + case "None": + return &constNode{v: None()}, nil + } + if _, ok := p.acceptOp("("); !ok { + return nil, fmt.Errorf("%w: 名字 %q 不是常量也不是函数调用", errSyntax, t.text) + } + args, err := p.parseArgs() + if err != nil { + return nil, err + } + return &callNode{name: strings.ToLower(t.text), args: args}, nil + case tokOp: + if _, ok := p.acceptOp("("); ok { + inner, err := p.parseOr() + if err != nil { + return nil, err + } + if _, ok := p.acceptOp(")"); !ok { + return nil, fmt.Errorf("%w: 括号没有闭合", errSyntax) + } + return inner, nil + } + } + return nil, fmt.Errorf("%w: 意料之外的 %q", errSyntax, t.text) +} + +func (p *parser) parseArgs() ([]node, error) { + var args []node + if _, ok := p.acceptOp(")"); ok { + return args, nil + } + for { + arg, err := p.parseOr() + if err != nil { + return nil, err + } + args = append(args, arg) + if _, ok := p.acceptOp(","); ok { + continue + } + if _, ok := p.acceptOp(")"); ok { + return args, nil + } + return nil, fmt.Errorf("%w: 参数列表没有闭合", errSyntax) + } +} diff --git a/internal/expr/value.go b/internal/expr/value.go new file mode 100644 index 00000000..871feeba --- /dev/null +++ b/internal/expr/value.go @@ -0,0 +1,106 @@ +package expr + +import ( + "errors" + "math" + "strconv" +) + +type Kind uint8 + +const ( + KindNone Kind = iota + KindBool + KindInt + KindFloat + KindStr +) + +type Value struct { + Kind Kind + Bool bool + Int int64 + Float float64 + Str string +} + +var errType = errors.New("类型不支持该运算") + +func None() Value { return Value{Kind: KindNone} } +func BoolOf(b bool) Value { return Value{Kind: KindBool, Bool: b} } +func IntOf(i int64) Value { return Value{Kind: KindInt, Int: i} } +func FloatOf(f float64) Value { return Value{Kind: KindFloat, Float: f} } +func StrOf(s string) Value { return Value{Kind: KindStr, Str: s} } + +func (v Value) numeric() bool { + return v.Kind == KindBool || v.Kind == KindInt || v.Kind == KindFloat +} + +func (v Value) integral() bool { + return v.Kind == KindBool || v.Kind == KindInt +} + +func (v Value) toInt() int64 { + switch v.Kind { + case KindBool: + if v.Bool { + return 1 + } + return 0 + case KindInt: + return v.Int + } + return 0 +} + +func (v Value) toFloat() float64 { + if v.Kind == KindFloat { + return v.Float + } + return float64(v.toInt()) +} + +func (v Value) Truthy() bool { + switch v.Kind { + case KindBool: + return v.Bool + case KindInt: + return v.Int != 0 + case KindFloat: + return v.Float != 0 + case KindStr: + return v.Str != "" + } + return false +} + +func (v Value) PyStr() string { + switch v.Kind { + case KindBool: + if v.Bool { + return "True" + } + return "False" + case KindInt: + return strconv.FormatInt(v.Int, 10) + case KindFloat: + if math.IsInf(v.Float, 1) { + return "inf" + } + if math.IsInf(v.Float, -1) { + return "-inf" + } + if math.IsNaN(v.Float) { + return "nan" + } + if v.Float == math.Trunc(v.Float) && math.Abs(v.Float) < 1e16 { + return strconv.FormatFloat(v.Float, 'f', 1, 64) + } + return strconv.FormatFloat(v.Float, 'g', -1, 64) + case KindStr: + return v.Str + } + return "None" +} + +func (v Value) AsInt() int64 { return v.toInt() } diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index a6a8dcc7..b8f3e36a 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -5,7 +5,11 @@ "footnote": "脚注", "footnote-block-title": "脚注", "image-context-bad": "图像地址不正确", + "include-create": "立刻创建", + "include-loop": "插入的页面 \"{name}\" 导致了无限包含循环", + "include-missing": "插入的页面 \"{name}\" 不存在", "table-of-contents": "内容", "toc-close": "关闭", - "toc-open": "展开" + "toc-open": "展开", + "user-not-found": "用户 '{name}' 不存在" } diff --git a/internal/modules/registry.go b/internal/modules/registry.go new file mode 100644 index 00000000..8f359c95 --- /dev/null +++ b/internal/modules/registry.go @@ -0,0 +1,63 @@ +package modules + +import ( + "slices" + "strings" +) + +type Info struct { + Name string + HasContent bool + Ported bool + Removed bool +} + +var registry = map[string]Info{ + "countpages": {Name: "countpages", HasContent: true}, + "css": {Name: "css", HasContent: true}, + "forumcategory": {Name: "forumcategory"}, + "forumnewpost": {Name: "forumnewpost"}, + "forumnewthread": {Name: "forumnewthread"}, + "forumpost": {Name: "forumpost"}, + "forumstart": {Name: "forumstart"}, + "forumthread": {Name: "forumthread"}, + "interwiki": {Name: "interwiki", HasContent: true, Removed: true}, + "listpages": {Name: "listpages", HasContent: true}, + "listusers": {Name: "listusers", HasContent: true}, + "newpage": {Name: "newpage"}, + "pagedescription": {Name: "pagedescription", HasContent: true}, + "pageimage": {Name: "pageimage"}, + "pagesbytag": {Name: "pagesbytag"}, + "rat": {Name: "rat"}, + "rate": {Name: "rate"}, + "recentposts": {Name: "recentposts"}, + "redirect": {Name: "redirect"}, + "search": {Name: "search"}, + "sitechanges": {Name: "sitechanges"}, + "tagcloud": {Name: "tagcloud"}, + "wantedpages": {Name: "wantedpages"}, +} + +func Lookup(name string) (Info, bool) { + info, ok := registry[strings.ToLower(strings.TrimSpace(name))] + return info, ok +} + +func HasContent(name string) bool { + info, ok := Lookup(name) + return ok && !info.Removed && info.HasContent +} + +func Ported(name string) bool { + info, ok := Lookup(name) + return ok && info.Ported +} + +func All() []Info { + out := make([]Info, 0, len(registry)) + for _, info := range registry { + out = append(out, info) + } + slices.SortFunc(out, func(a, b Info) int { return strings.Compare(a.Name, b.Name) }) + return out +} diff --git a/internal/modules/registry_test.go b/internal/modules/registry_test.go new file mode 100644 index 00000000..82b7eb54 --- /dev/null +++ b/internal/modules/registry_test.go @@ -0,0 +1,77 @@ +package modules + +import "testing" + +func TestRegistryCovers23Modules(t *testing.T) { + if got := len(All()); got != 23 { + t.Errorf("len(All()) = %d，期望 23", got) + } +} + +func TestHasContent(t *testing.T) { + tests := []struct { + name string + want bool + }{ + {"countpages", true}, + {"css", true}, + {"listpages", true}, + {"listusers", true}, + {"pagedescription", true}, + {"rate", false}, + {"forumthread", false}, + {"pageimage", false}, + {"tagcloud", false}, + {"nosuchmodule", false}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := HasContent(tt.name); got != tt.want { + t.Errorf("HasContent(%q) = %v，期望 %v", tt.name, got, tt.want) + } + }) + } +} + +func TestHasContentIgnoresCaseAndSpace(t *testing.T) { + for _, name := range []string{"CSS", " css ", "Css"} { + t.Run(name, func(t *testing.T) { + if !HasContent(name) { + t.Errorf("HasContent(%q) = false，期望 true", name) + } + }) + } +} + +func TestRemovedModuleReportsNoContent(t *testing.T) { + info, ok := Lookup("interwiki") + if !ok { + t.Fatal("Lookup(\"interwiki\") ok = false，期望 true") + } + if !info.Removed { + t.Error("Lookup(\"interwiki\").Removed = false，期望 true") + } + if !info.HasContent { + t.Error("Lookup(\"interwiki\").HasContent = false，期望 true") + } + if HasContent("interwiki") { + t.Error("HasContent(\"interwiki\") = true，期望 false") + } +} + +func TestNothingPortedYet(t *testing.T) { + for _, info := range All() { + if info.Ported { + t.Errorf("Lookup(%q).Ported = true，期望 false", info.Name) + } + } +} + +func TestAllIsSortedByName(t *testing.T) { + all := All() + for i := 1; i < len(all); i++ { + if all[i-1].Name >= all[i].Name { + t.Errorf("All()[%d].Name = %q，期望排在 %q 之前", i, all[i].Name, all[i-1].Name) + } + } +} From 8e1e269a1729847112dd0ef38bafafe833186853 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 20 Aug 2026 15:18:51 +0900 Subject: [PATCH 005/428] fix --- cmd/pwikit/main.go | 24 ++--- internal/callbacks/callbacks.go | 4 +- internal/callbacks/callbacks_test.go | 92 +++++++++---------- internal/callbacks/integration_test.go | 28 +++--- internal/expr/builtin.go | 15 ++- internal/expr/eval.go | 11 +-- internal/expr/expr_test.go | 8 +- internal/expr/parse.go | 23 +++-- internal/expr/value.go | 2 +- internal/forward/forward.go | 10 +- internal/forward/forward_test.go | 50 +++++----- internal/i18n/i18n.go | 6 +- internal/i18n/i18n_test.go | 38 ++++---- internal/modules/registry_test.go | 18 ++-- internal/password/password.go | 18 ++-- internal/password/password_test.go | 62 ++++++------- internal/paths/paths.go | 14 +-- internal/paths/paths_test.go | 46 +++++----- internal/proxyheader/proxyheader.go | 4 +- internal/proxyheader/proxyheader_test.go | 52 +++++------ internal/renderer/fake.go | 2 +- internal/renderer/renderer_test.go | 34 +++---- internal/renderer/sidecar/dispatch.go | 6 +- internal/renderer/sidecar/integration_test.go | 34 +++---- internal/renderer/sidecar/sidecar.go | 28 +++--- internal/renderer/sidecar/sidecar_test.go | 60 ++++++------ internal/routing/routing.go | 32 +++---- internal/routing/routing_test.go | 30 +++--- internal/site/site_test.go | 36 ++++---- internal/wikidot/name_test.go | 86 ++++++++--------- 30 files changed, 435 insertions(+), 438 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index c4537017..b5debf8d 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -34,7 +34,7 @@ func main() { func run(args []string) error { if len(args) == 0 { usage() - return errors.New("缺少子命令") + return errors.New("missing subcommand") } switch args[0] { case "serve": @@ -48,27 +48,27 @@ func run(args []string) error { return nil default: usage() - return fmt.Errorf("未知子命令 %q", args[0]) + return fmt.Errorf("unknown subcommand %q", args[0]) } } func usage() { - fmt.Fprint(os.Stderr, `用法: pwikit <子命令> [选项] + fmt.Fprint(os.Stderr, `Usage: pwikit [options] -子命令: - serve 启动 HTTP 服务 - routes 打印静态路由表 - modules 打印 wikidot 模块清单 - help 显示本帮助 +Commands: + serve start the HTTP server + routes print the static route table + modules print the wikidot module list + help show this help `) } func serve(args []string) error { fs := flag.NewFlagSet("serve", flag.ContinueOnError) - listen := fs.String("listen", defaultListen, "监听地址") - upstream := fs.String("upstream", envOr(envUpstream, defaultUpstream), "转发未处理请求的上游地址") - dataDir := fs.String("data-dir", "", "状态目录，默认取可执行文件所在目录") - trusted := fs.String("trusted-proxies", "", "可信前置代理的地址或网段，逗号分隔；留空则不信任任何 X-Forwarded-* 头") + listen := fs.String("listen", defaultListen, "listen address") + upstream := fs.String("upstream", envOr(envUpstream, defaultUpstream), "upstream address for requests pwikit does not handle") + dataDir := fs.String("data-dir", "", "state directory; defaults to the directory holding the executable") + trusted := fs.String("trusted-proxies", "", "trusted reverse proxy addresses or CIDRs, comma separated; empty trusts no X-Forwarded-* header") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go index 5af6aed4..44763941 100644 --- a/internal/callbacks/callbacks.go +++ b/internal/callbacks/callbacks.go @@ -19,8 +19,8 @@ var injectedCode string const MaxIncludeLevel = 25 var ( - ErrUserNotFound = errors.New("用户不存在") - ErrNoRepository = errors.New("没有配置数据源") + ErrUserNotFound = errors.New("user not found") + ErrNoRepository = errors.New("no repository configured") ) type ModuleError struct{ Message string } diff --git a/internal/callbacks/callbacks_test.go b/internal/callbacks/callbacks_test.go index b494ac03..d9b6af2c 100644 --- a/internal/callbacks/callbacks_test.go +++ b/internal/callbacks/callbacks_test.go @@ -56,7 +56,7 @@ func newCallbacks(t *testing.T, repo Repository) *Callbacks { t.Helper() bundle, err := i18n.Load("") if err != nil { - t.Fatalf("i18n.Load() err = %v，期望 nil", err) + t.Fatalf("i18n.Load() err = %v, want nil", err) } return New(bundle.Localizer(i18n.DefaultLanguage), repo) } @@ -77,10 +77,10 @@ func TestModuleHasBody(t *testing.T) { t.Run(tt.name, func(t *testing.T) { got, err := c.ModuleHasBody(tt.name) if err != nil { - t.Fatalf("ModuleHasBody(%q) err = %v，期望 nil", tt.name, err) + t.Fatalf("ModuleHasBody(%q) err = %v, want nil", tt.name, err) } if got != tt.want { - t.Errorf("ModuleHasBody(%q) = %v，期望 %v", tt.name, got, tt.want) + t.Errorf("ModuleHasBody(%q) = %v, want %v", tt.name, got, tt.want) } }) } @@ -91,13 +91,13 @@ func TestRenderModuleLowercasesParamKeys(t *testing.T) { c := newCallbacks(t, repo) if _, err := c.RenderModule("Rate", map[string]string{"ShowVotes": "yes"}, ""); err != nil { - t.Fatalf("RenderModule() err = %v，期望 nil", err) + t.Fatalf("RenderModule() err = %v, want nil", err) } if repo.moduleName != "Rate" { - t.Errorf("moduleName = %q，期望 %q", repo.moduleName, "Rate") + t.Errorf("moduleName = %q, want %q", repo.moduleName, "Rate") } if _, ok := repo.moduleParam["showvotes"]; !ok { - t.Errorf("params = %v，期望含键 %q", repo.moduleParam, "showvotes") + t.Errorf("params = %v, want key %q", repo.moduleParam, "showvotes") } } @@ -107,20 +107,20 @@ func TestRenderModuleTurnsModuleErrorIntoErrorBlock(t *testing.T) { got, err := c.RenderModule("rate", nil, "") if err != nil { - t.Fatalf("RenderModule() err = %v，期望 nil", err) + t.Fatalf("RenderModule() err = %v, want nil", err) } want := `

坏了 <b>&

` if got != want { - t.Errorf("RenderModule() = %q，期望 %q", got, want) + t.Errorf("RenderModule() = %q, want %q", got, want) } } func TestRenderModulePropagatesOtherErrors(t *testing.T) { - boom := errors.New("数据库炸了") + boom := errors.New("boom") c := newCallbacks(t, &fakeRepo{moduleErr: boom}) if _, err := c.RenderModule("rate", nil, ""); !errors.Is(err, boom) { - t.Errorf("RenderModule() err = %v，期望 %v", err, boom) + t.Errorf("RenderModule() err = %v, want %v", err, boom) } } @@ -129,11 +129,11 @@ func TestRenderUserNotFound(t *testing.T) { got, err := c.RenderUser("kaku用户 'kaku<shi' 不存在` if got != want { - t.Errorf("RenderUser() = %q，期望 %q", got, want) + t.Errorf("RenderUser() = %q, want %q", got, want) } } @@ -151,10 +151,10 @@ func TestGetI18nMessage(t *testing.T) { t.Run(tt.id, func(t *testing.T) { got, err := c.GetI18nMessage(tt.id) if err != nil { - t.Fatalf("GetI18nMessage(%q) err = %v，期望 nil", tt.id, err) + t.Fatalf("GetI18nMessage(%q) err = %v, want nil", tt.id, err) } if got != tt.want { - t.Errorf("GetI18nMessage(%q) = %q，期望 %q", tt.id, got, tt.want) + t.Errorf("GetI18nMessage(%q) = %q, want %q", tt.id, got, tt.want) } }) } @@ -165,16 +165,16 @@ func TestGetHTMLInjectedCodeSubstitutesIDOnce(t *testing.T) { got, err := c.GetHTMLInjectedCode("abc-12") if err != nil { - t.Fatalf("GetHTMLInjectedCode() err = %v，期望 nil", err) + t.Fatalf("GetHTMLInjectedCode() err = %v, want nil", err) } if !strings.Contains(got, `id: "abc-12"`) { - t.Errorf("输出不含 %q", `id: "abc-12"`) + t.Errorf("output has no %q", `id: "abc-12"`) } if strings.Contains(got, "%s") { - t.Errorf("输出仍含占位符 %q，期望已被替换", "%s") + t.Errorf("output still contains placeholder %q, want it substituted", "%s") } if !strings.HasPrefix(got, "\n ` + p.SiteIcon = `-/sites/it's.png` + p.Title = `A & B ` + p.OGTitle = `A & B ` + p.OGDescription = `it's "quoted" & ` + p.OGURL = "https://wiki.example/main?a=1&b=2" + p.ThemeURL = "/-/theme/dark.css?v=1&x=2" + p.Breadcrumbs = []crumbSpec{ + {URL: "/a?x=1&y=2", Title: `it's `}, + {URL: "/b", Title: `"last" & final`}, + } + p.TagCategories = []tagCategorySpec{ + {Name: `cat & "co"`, Tags: []tagSpec{{Name: "a&b", FullName: "x:a&b"}}}, + } + p.LoginStatusConfig = `{"user": {"name": "it's "}}` + p.OptionsConfig = `{"pageId": "a&b"}` + }), + withPage("noindex", func(p *pageSpec) { p.NoIndex = true }), + withPage("google_tag", func(p *pageSpec) { p.GoogleTagID = "G-AB1'2-3" }), + withPage("one_breadcrumb", func(p *pageSpec) { p.Breadcrumbs = crumbs[:1] }), + withPage("two_breadcrumbs", func(p *pageSpec) { p.Breadcrumbs = crumbs[:2] }), + withPage("hidden_tags_only", func(p *pageSpec) { + p.TagCategories = []tagCategorySpec{ + {Name: "attribute", Tags: []tagSpec{{Name: "_hidden", FullName: "attribute:_hidden"}}}, + } + }), + withPage("unpadded_date", func(p *pageSpec) { + p.RevNumber = 0 + p.UpdatedAt = "2026-01-05T09:07:00+08:00" + }), + withPage("date_crosses_midnight_in_utc", func(p *pageSpec) { + p.RevNumber = 3 + p.UpdatedAt = "2026-03-01T00:30:00+08:00" + }), + withPage("unicode", func(p *pageSpec) { + p.SiteName = "维基" + p.SiteHeadline = "一个维基站点" + p.SiteTitle = "首页 - 维基" + p.Title = "首页" + p.TagCategories = []tagCategorySpec{ + {Name: "分类", Tags: []tagSpec{{Name: "中文标签", FullName: "分类:中文标签"}}}, + } + }), + {Name: "not_found", Kind: "not_found", PageID: "no-such-page"}, + {Name: "not_found_escaped", Kind: "not_found", PageID: `a&b'd'`}, + { + Name: "not_found_create", + Kind: "not_found", + PageID: "new-page", + AllowCreate: true, + Options: `{"page_id": "new-page", "pathParams": {"a": "b"}}`, + }, + {Name: "forbidden", Kind: "forbidden", PageID: "secret:page"}, + {Name: "forbidden_escaped", Kind: "forbidden", PageID: `a&b'd'`}, + }, + } +} + +func dataFor(t *testing.T, p *pageSpec) Data { + t.Helper() + d := Data{ + SiteName: p.SiteName, + SiteHeadline: p.SiteHeadline, + SiteTitle: p.SiteTitle, + SiteIcon: p.SiteIcon, + OGTitle: p.OGTitle, + OGDescription: p.OGDescription, + OGImage: p.OGImage, + OGURL: p.OGURL, + NoIndex: p.NoIndex, + GoogleTagID: p.GoogleTagID, + ThemeURL: p.ThemeURL, + ComputedStyle: p.ComputedStyle, + NavTop: p.NavTop, + NavSide: p.NavSide, + Title: p.Title, + Content: p.Content, + RevNumber: p.RevNumber, + LoginStatusConfig: p.LoginStatusConfig, + OptionsConfig: p.OptionsConfig, + } + for _, c := range p.Breadcrumbs { + d.Breadcrumbs = append(d.Breadcrumbs, Breadcrumb{URL: c.URL, Title: c.Title}) + } + for _, c := range p.TagCategories { + cat := TagCategory{Name: c.Name} + for _, tag := range c.Tags { + cat.Tags = append(cat.Tags, Tag{Name: tag.Name, FullName: tag.FullName}) + } + d.TagCategories = append(d.TagCategories, cat) + } + if p.UpdatedAt != "" { + at, err := time.Parse(time.RFC3339, p.UpdatedAt) + if err != nil { + t.Fatalf("Parse(%q) err = %v, want nil", p.UpdatedAt, err) + } + d.UpdatedAt = at + } + return d +} + +func render(t *testing.T, r *Renderer, c caseSpec) string { + t.Helper() + switch c.Kind { + case "page": + var b strings.Builder + if err := r.Page(&b, dataFor(t, c.Page)); err != nil { + t.Fatalf("Page(%s) err = %v, want nil", c.Name, err) + } + return b.String() + case "not_found": + html, err := r.NotFound(NotFound{PageID: c.PageID, AllowCreate: c.AllowCreate, Options: c.Options}) + if err != nil { + t.Fatalf("NotFound(%s) err = %v, want nil", c.Name, err) + } + return html + case "forbidden": + html, err := r.Forbidden(c.PageID) + if err != nil { + t.Fatalf("Forbidden(%s) err = %v, want nil", c.Name, err) + } + return html + } + t.Fatalf("case %s has kind %q, want one of page, not_found, forbidden", c.Name, c.Kind) + return "" +} + +func TestRenderMatchesGolden(t *testing.T) { + c := corpus() + r := testRenderer(t) + + var b strings.Builder + for _, spec := range c.Cases { + fmt.Fprintf(&b, "=== %s\n%s\n", spec.Name, render(t, r, spec)) + } + got := b.String() + + if *update { + writeCorpus(t, c) + if err := os.WriteFile(filepath.FromSlash(goldenPath), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", goldenPath, err) + } + return + } + + want, err := os.ReadFile(filepath.FromSlash(goldenPath)) + if err != nil { + t.Fatalf("ReadFile(%s) err = %v, want nil", goldenPath, err) + } + if got != string(want) { + gotAt, wantAt := firstDiff(got, string(want)) + t.Errorf("render = %q, want %q", gotAt, wantAt) + } +} + +func firstDiff(got, want string) (string, string) { + for i := 0; i < len(got) && i < len(want); i++ { + if got[i] != want[i] { + return excerpt(got, i), excerpt(want, i) + } + } + return excerpt(got, min(len(got), len(want))), excerpt(want, min(len(got), len(want))) +} + +func excerpt(s string, at int) string { + start := max(0, at-40) + end := min(len(s), at+40) + return s[start:end] +} + +func writeCorpus(t *testing.T, c corpusFile) { + t.Helper() + data, err := json.MarshalIndent(c, "", " ") + if err != nil { + t.Fatalf("Marshal(corpus) err = %v, want nil", err) + } + if err := os.WriteFile(filepath.FromSlash(corpusPath), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", corpusPath, err) + } +} diff --git a/internal/shell/templates/page.html b/internal/shell/templates/page.html new file mode 100644 index 00000000..0cea8c9c --- /dev/null +++ b/internal/shell/templates/page.html @@ -0,0 +1,153 @@ +{{/* Django's two load tags print nothing and leave these two newlines behind. */}} + + + + + + + + + + + + + + + {{if .OGImage}} + + + {{else}} + + {{end}} + + {{if .NoIndex}} + + {{end}} + + {{esc .SiteTitle}} + + + + + + + + + + + + {{if .ComputedStyle}} + + {{end}} + + {{if .GoogleTagID}} + + + + {{end}} + + + + +
+ + diff --git a/internal/shell/templates/page_403.html b/internal/shell/templates/page_403.html new file mode 100644 index 00000000..e92287a3 --- /dev/null +++ b/internal/shell/templates/page_403.html @@ -0,0 +1 @@ +

{{.Message}} diff --git a/internal/shell/templates/page_404.html b/internal/shell/templates/page_404.html new file mode 100644 index 00000000..7e955ea6 --- /dev/null +++ b/internal/shell/templates/page_404.html @@ -0,0 +1,5 @@ +{{if .AllowCreate}} +

+{{else}} +

{{.Message}} +{{end}} \ No newline at end of file diff --git a/internal/shell/testdata/oracle_shell.py b/internal/shell/testdata/oracle_shell.py new file mode 100644 index 00000000..1085aad6 --- /dev/null +++ b/internal/shell/testdata/oracle_shell.py @@ -0,0 +1,95 @@ +"""Render the page shell templates in the running Django, one case at a time. + + SHELL_CORPUS="$(cat internal/shell/testdata/shell_corpus.json)" \ + docker compose exec -T -e SHELL_CORPUS \ + web python manage.py shell < internal/shell/testdata/oracle_shell.py \ + > shell.django.golden + +Then compare it with internal/shell/testdata/shell.golden. + +The asset URLs and the theme URL are fed in from the corpus instead of being +computed here, so the comparison stays about the templates. Line endings are +normalised because a Windows checkout carries CRLF into the container. +""" + +import io +import json +import os +import sys +from datetime import datetime +from django.template.loader import render_to_string +from django.utils.safestring import mark_safe + +import web.models.site as site_models +import web.templatetags.md5url as md5url_tags + +CORPUS = json.loads(os.environ['SHELL_CORPUS']) + +sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8', newline='\n') + +md5url_tags.UrlCache._md5_sum = dict(CORPUS['assets']) + +THEME_URL = '' +site_models.get_site_theme_url = lambda: THEME_URL + + +class Named: + def __init__(self, **fields): + self.__dict__.update(fields) + + +def tags_categories(specs): + return { + Named(name=spec['name']): [ + Named(name=tag['name'], full_name=tag['full_name']) + for tag in spec['tags'] + ] + for spec in specs + } + + +def page_context(spec): + return { + 'site_name': spec['site_name'], + 'site_headline': spec['site_headline'], + 'site_title': spec['site_title'], + 'site_icon': spec['site_icon'], + 'og_title': spec['og_title'], + 'og_description': spec['og_description'], + 'og_image': spec['og_image'], + 'og_url': spec['og_url'], + 'noindex': spec['noindex'], + 'google_tag_id': spec['google_tag_id'], + 'computed_style': spec['computed_style'], + 'nav_top': mark_safe(spec['nav_top']), + 'nav_side': mark_safe(spec['nav_side']), + 'title': spec['title'], + 'content': mark_safe(spec['content']), + 'breadcrumbs': list(spec['breadcrumbs'] or []), + 'tags_categories': tags_categories(spec['tags_categories'] or []), + 'rev_number': spec['rev_number'], + 'updated_at': datetime.fromisoformat(spec['updated_at']) if spec['updated_at'] else None, + 'login_status_config': spec['login_status_config'], + 'options_config': spec['options_config'], + } + + +def render(case): + global THEME_URL + if case['kind'] == 'page': + THEME_URL = case['page']['theme_url'] + return render_to_string('page.html', page_context(case['page'])) + if case['kind'] == 'not_found': + return render_to_string('page_404.html', { + 'page_id': case.get('page_id', ''), + 'allow_create': case.get('allow_create', False), + 'options': case.get('options', ''), + }) + if case['kind'] == 'forbidden': + return render_to_string('page_403.html', {'page_id': case.get('page_id', '')}) + raise SystemExit('case %s has kind %r, want one of page, not_found, forbidden' + % (case['name'], case['kind'])) + + +for case in CORPUS['cases']: + sys.stdout.write('=== %s\n%s\n' % (case['name'], render(case).replace('\r\n', '\n'))) diff --git a/internal/shell/testdata/shell.golden b/internal/shell/testdata/shell.golden new file mode 100644 index 00000000..4381f04c --- /dev/null +++ b/internal/shell/testdata/shell.golden @@ -0,0 +1,1408 @@ +=== minimal + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + +

+ +
+
+
+ +
+ +
+
+ + +
+ +
+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== full + + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Main page +
+ + + +
+

hello world

+
+
+ +
+ +
+ 默认: + + + scp + + + + euclid + + +
+ +
+ attribute: + + + co-authored + + + + +
+ +
+ +
+
+ +
页面版本: 12, 最后编辑: 8月25日, 2026年 14:03
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== escaping + + + + + + + + + + + + + + + + + + + + + + <script>alert(1)</script> + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ A & B <b> +
+ + + +
+

hello world

+
+
+ +
+ +
+ cat & "co": + + + a&b + + +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== noindex + + + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+

hello world

+
+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== google_tag + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+

hello world

+
+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== one_breadcrumb + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+

hello world

+
+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== two_breadcrumbs + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + + + +
+

hello world

+
+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== hidden_tags_only + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+

hello world

+
+
+ +
+ +
+ attribute: + + + +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== unpadded_date + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+

hello world

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 1月5日, 2026年 09:07
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== date_crosses_midnight_in_utc + + + + + + + + + + + + + + + + + + + + + + Wikit + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+

hello world

+
+
+ +
+ +
+ +
+
+ +
页面版本: 3, 最后编辑: 3月1日, 2026年 00:30
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== unicode + + + + + + + + + + + + + + + + + + + + + + 首页 - 维基 + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 首页 +
+ +
+

hello world

+
+
+ +
+ +
+ 分类: + + + 中文标签 + + +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + + +=== not_found + +

您请求的页面 no-such-page 不存在 + +=== not_found_escaped + +

您请求的页面 a&b<c>'d' 不存在 + +=== not_found_create + +

+ +=== forbidden +

您没有查看此页面的权限 secret:page. + +=== forbidden_escaped +

您没有查看此页面的权限 a&b<c>'d'. + diff --git a/internal/shell/testdata/shell_corpus.json b/internal/shell/testdata/shell_corpus.json new file mode 100644 index 00000000..5b2ea9b0 --- /dev/null +++ b/internal/shell/testdata/shell_corpus.json @@ -0,0 +1,438 @@ +{ + "assets": { + "app.css": "/-/static/app.css?v=d3e803eb", + "app.js": "/-/static/app.js?v=6cd23731", + "fontawesome/css/all.css": "/-/static/fontawesome/css/all.css?v=50b966c2", + "wikidot-base.css": "/-/static/wikidot-base.css?v=42062692" + }, + "cases": [ + { + "name": "minimal", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "", + "nav_side": "", + "title": "", + "content": "", + "breadcrumbs": null, + "tags_categories": null, + "rev_number": 0, + "updated_at": "", + "login_status_config": "{}", + "options_config": "{}" + } + }, + { + "name": "full", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Main page", + "og_description": "an excerpt", + "og_image": "https://wiki.example/local--files/main/cover.png", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "#page-content .x { color: red }", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "Main page", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": [ + { + "url": "/main", + "title": "Main" + }, + { + "url": "/main:parent", + "title": "Parent" + }, + { + "url": "/main:child", + "title": "Child" + } + ], + "tags_categories": [ + { + "name": "默认", + "tags": [ + { + "name": "scp", + "full_name": "scp" + }, + { + "name": "euclid", + "full_name": "euclid" + } + ] + }, + { + "name": "attribute", + "tags": [ + { + "name": "co-authored", + "full_name": "attribute:co-authored" + }, + { + "name": "_hidden", + "full_name": "attribute:_hidden" + } + ] + } + ], + "rev_number": 12, + "updated_at": "2026-08-25T14:03:07+08:00", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "escaping", + "kind": "page", + "page": { + "site_name": "Wik\u003cit\u003e \u0026 \"co\"", + "site_headline": "it's a wiki", + "site_title": "\u003cscript\u003ealert(1)\u003c/script\u003e", + "site_icon": "-/sites/it's.png", + "og_title": "A \u0026 B \u003cb\u003e", + "og_description": "it's \"quoted\" \u0026 \u003cmarked\u003e", + "og_image": "", + "og_url": "https://wiki.example/main?a=1\u0026b=2", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/theme/dark.css?v=1\u0026x=2", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "A \u0026 B \u003cb\u003e", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": [ + { + "url": "/a?x=1\u0026y=2", + "title": "it's \u003cfirst\u003e" + }, + { + "url": "/b", + "title": "\"last\" \u0026 final" + } + ], + "tags_categories": [ + { + "name": "cat \u0026 \"co\"", + "tags": [ + { + "name": "a\u0026b", + "full_name": "x:a\u0026b" + } + ] + } + ], + "rev_number": 0, + "updated_at": "", + "login_status_config": "{\"user\": {\"name\": \"it's \u003cme\u003e\"}}", + "options_config": "{\"pageId\": \"a\u0026b\"}" + } + }, + { + "name": "noindex", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "an excerpt", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": true, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": null, + "tags_categories": null, + "rev_number": 0, + "updated_at": "", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "google_tag", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "an excerpt", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "G-AB1'2-3", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": null, + "tags_categories": null, + "rev_number": 0, + "updated_at": "", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "one_breadcrumb", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "an excerpt", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": [ + { + "url": "/main", + "title": "Main" + } + ], + "tags_categories": null, + "rev_number": 0, + "updated_at": "", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "two_breadcrumbs", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "an excerpt", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": [ + { + "url": "/main", + "title": "Main" + }, + { + "url": "/main:parent", + "title": "Parent" + } + ], + "tags_categories": null, + "rev_number": 0, + "updated_at": "", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "hidden_tags_only", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "an excerpt", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": null, + "tags_categories": [ + { + "name": "attribute", + "tags": [ + { + "name": "_hidden", + "full_name": "attribute:_hidden" + } + ] + } + ], + "rev_number": 0, + "updated_at": "", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "unpadded_date", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "an excerpt", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": null, + "tags_categories": null, + "rev_number": 0, + "updated_at": "2026-01-05T09:07:00+08:00", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "date_crosses_midnight_in_utc", + "kind": "page", + "page": { + "site_name": "Wikit", + "site_headline": "a wiki", + "site_title": "Wikit", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "an excerpt", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": null, + "tags_categories": null, + "rev_number": 3, + "updated_at": "2026-03-01T00:30:00+08:00", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "unicode", + "kind": "page", + "page": { + "site_name": "维基", + "site_headline": "一个维基站点", + "site_title": "首页 - 维基", + "site_icon": "-/sites/icon.png", + "og_title": "Wikit", + "og_description": "an excerpt", + "og_image": "", + "og_url": "https://wiki.example/main", + "noindex": false, + "google_tag_id": "", + "theme_url": "/-/static/theme.css", + "computed_style": "", + "nav_top": "\u003cdiv class=\"top-bar\"\u003e\u003cul\u003e\u003cli\u003e\u003ca href=\"/main\"\u003eMain\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/div\u003e", + "nav_side": "\u003cdiv class=\"side-block\"\u003e\u003cp\u003eside\u003c/p\u003e\u003c/div\u003e", + "title": "首页", + "content": "\u003cp\u003ehello \u003cem\u003eworld\u003c/em\u003e\u003c/p\u003e", + "breadcrumbs": null, + "tags_categories": [ + { + "name": "分类", + "tags": [ + { + "name": "中文标签", + "full_name": "分类:中文标签" + } + ] + } + ], + "rev_number": 0, + "updated_at": "", + "login_status_config": "{\"user\": {\"type\": \"anonymous\"}, \"notificationCount\": 0}", + "options_config": "{\"optionsEnabled\": true, \"pageId\": \"main\"}" + } + }, + { + "name": "not_found", + "kind": "not_found", + "page_id": "no-such-page" + }, + { + "name": "not_found_escaped", + "kind": "not_found", + "page_id": "a\u0026b\u003cc\u003e'd'" + }, + { + "name": "not_found_create", + "kind": "not_found", + "page_id": "new-page", + "allow_create": true, + "options": "{\"page_id\": \"new-page\", \"pathParams\": {\"a\": \"b\"}}" + }, + { + "name": "forbidden", + "kind": "forbidden", + "page_id": "secret:page" + }, + { + "name": "forbidden_escaped", + "kind": "forbidden", + "page_id": "a\u0026b\u003cc\u003e'd'" + } + ] +} From d2fe80bf0bf634592cc054b4a116dac91f5f7de3 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 26 Aug 2026 20:34:28 +0900 Subject: [PATCH 040/428] add the page shell's queries --- internal/db/article_row.go | 2 + internal/db/chrome.go | 176 ++++++++++++++++++++++++++ internal/db/chrome_test.go | 132 +++++++++++++++++++ internal/db/site.go | 7 +- internal/db/testdata/oracle_chrome.py | 42 ++++++ internal/page/testdata/oracle_seed.py | 1 + internal/site/theme.go | 26 ++++ internal/site/theme_test.go | 37 ++++++ 8 files changed, 421 insertions(+), 2 deletions(-) create mode 100644 internal/db/chrome.go create mode 100644 internal/db/chrome_test.go create mode 100644 internal/db/testdata/oracle_chrome.py create mode 100644 internal/site/theme.go create mode 100644 internal/site/theme_test.go diff --git a/internal/db/article_row.go b/internal/db/article_row.go index 6c45b840..873377d9 100644 --- a/internal/db/article_row.go +++ b/internal/db/article_row.go @@ -44,6 +44,8 @@ const DefaultCategory = "_default" const articleColumns = `id, category, name, title, parent_id, locked, created_at, updated_at, media_name` +const prefixedArticleColumns = `a.id, a.category, a.name, a.title, a.parent_id, a.locked, a.created_at, a.updated_at, a.media_name` + var qArticleByName = register("ArticleByName", ` SELECT `+articleColumns+` FROM web_article diff --git a/internal/db/chrome.go b/internal/db/chrome.go new file mode 100644 index 00000000..afa1a17a --- /dev/null +++ b/internal/db/chrome.go @@ -0,0 +1,176 @@ +package db + +import ( + "context" + "errors" + "fmt" + "sort" + "time" + + "github.com/jackc/pgx/v5" +) + +var qBreadcrumbs = register("Breadcrumbs", ` +WITH RECURSIVE chain AS ( + SELECT id, parent_id, ARRAY[id] AS seen, 0 AS depth + FROM web_article + WHERE id = $1 + UNION ALL + SELECT p.id, p.parent_id, chain.seen || p.id, chain.depth + 1 + FROM web_article p + JOIN chain ON p.id = chain.parent_id + WHERE NOT p.id = ANY(chain.seen) +) +SELECT `+prefixedArticleColumns+` +FROM chain +JOIN web_article a ON a.id = chain.id +ORDER BY chain.depth DESC`) + +// Breadcrumbs walks up the parent chain and returns the root first. The seen +// array is what keeps a page that is its own ancestor from looping forever. +func (d *DB) Breadcrumbs(ctx context.Context, articleID int64) ([]Article, error) { + rows, err := d.pool.Query(ctx, qBreadcrumbs, articleID) + if err != nil { + return nil, fmt.Errorf("query breadcrumbs of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []Article + for rows.Next() { + var a Article + if err := rows.Scan(&a.ID, &a.Category, &a.Name, &a.Title, &a.ParentID, + &a.Locked, &a.CreatedAt, &a.UpdatedAt, &a.MediaName); err != nil { + return nil, fmt.Errorf("scan breadcrumb of article %d: %w", articleID, err) + } + out = append(out, a) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read breadcrumbs of article %d: %w", articleID, err) + } + return out, nil +} + +type Tag struct { + Name string + FullName string +} + +type TagCategory struct { + ID int64 + Name string + Priority *int + Tags []Tag +} + +// The tie-break is the category id because the order Django gets there falls out +// of iterating a set of model objects, which for small ids is ascending. +var qArticleTagCategories = register("ArticleTagCategories", ` +SELECT c.id, c.name, c.priority, t.name, + CASE WHEN c.slug = '_default' THEN t.name ELSE c.slug || ':' || t.name END +FROM web_article_tags link +JOIN web_tag t ON t.id = link.tag_id +JOIN web_tagscategory c ON c.id = t.category_id +WHERE link.article_id = $1 AND t.name NOT LIKE '\_%' +ORDER BY c.id, link.id`) + +// ArticleTagCategories returns the tag block in display order. A category with no +// priority sorts under the page's tag count, the number Django compares it with. +func (d *DB) ArticleTagCategories(ctx context.Context, articleID int64) ([]TagCategory, error) { + rows, err := d.pool.Query(ctx, qArticleTagCategories, articleID) + if err != nil { + return nil, fmt.Errorf("query tag categories of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []TagCategory + byID := make(map[int64]int) + total := 0 + for rows.Next() { + var cat TagCategory + var tag Tag + if err := rows.Scan(&cat.ID, &cat.Name, &cat.Priority, &tag.Name, &tag.FullName); err != nil { + return nil, fmt.Errorf("scan tag category of article %d: %w", articleID, err) + } + at, ok := byID[cat.ID] + if !ok { + at = len(out) + byID[cat.ID] = at + out = append(out, cat) + } + out[at].Tags = append(out[at].Tags, tag) + total++ + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read tag categories of article %d: %w", articleID, err) + } + + priority := func(c TagCategory) int { + if c.Priority != nil { + return *c.Priority + } + return total + } + sort.SliceStable(out, func(i, j int) bool { return priority(out[i]) < priority(out[j]) }) + return out, nil +} + +var qLatestRevNumber = register("LatestRevNumber", ` +SELECT COALESCE(MAX(rev_number), 0) +FROM web_articlelogentry +WHERE article_id = $1`) + +func (d *DB) LatestRevNumber(ctx context.Context, articleID int64) (int, error) { + var n int + if err := d.pool.QueryRow(ctx, qLatestRevNumber, articleID).Scan(&n); err != nil { + return 0, fmt.Errorf("query latest revision number of article %d: %w", articleID, err) + } + return n, nil +} + +var qCategoryIndexed = register("CategoryIndexed", ` +SELECT is_indexed +FROM web_category +WHERE name = $1`) + +// CategoryIndexed answers for categories with no row of their own too, where the +// model default decides. +func (d *DB) CategoryIndexed(ctx context.Context, name string) (bool, error) { + var indexed bool + err := d.pool.QueryRow(ctx, qCategoryIndexed, name).Scan(&indexed) + if errors.Is(err, pgx.ErrNoRows) { + return true, nil + } + if err != nil { + return false, fmt.Errorf("query category %q: %w", name, err) + } + return indexed, nil +} + +const ( + ThemeInline = "inline" + ThemeExternal = "external" +) + +type Theme struct { + Slug string + Mode string + ExternalURL string + UpdatedAt time.Time +} + +var qThemeByID = register("ThemeByID", ` +SELECT slug, mode, external_url, updated_at +FROM web_theme +WHERE id = $1`) + +func (d *DB) ThemeByID(ctx context.Context, id int64) (*Theme, error) { + var t Theme + err := d.pool.QueryRow(ctx, qThemeByID, id).Scan(&t.Slug, &t.Mode, &t.ExternalURL, &t.UpdatedAt) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("lookup theme %d: %w", id, err) + } + return &t, nil +} diff --git a/internal/db/chrome_test.go b/internal/db/chrome_test.go new file mode 100644 index 00000000..1c759894 --- /dev/null +++ b/internal/db/chrome_test.go @@ -0,0 +1,132 @@ +package db + +import ( + "context" + "testing" +) + +func articleID(t *testing.T, d *DB, ref string) int64 { + t.Helper() + a, err := d.ArticleByName(context.Background(), ref) + if err != nil { + t.Fatalf("ArticleByName(%q) err = %v, want nil", ref, err) + } + return a.ID +} + +func TestBreadcrumbsReturnsRootFirst(t *testing.T) { + d := newTestDB(t) + + got, err := d.Breadcrumbs(context.Background(), articleID(t, d, "probe:full")) + if err != nil { + t.Fatalf("Breadcrumbs() err = %v, want nil", err) + } + want := []string{"probe:parent", "probe:full"} + if len(got) != len(want) { + t.Fatalf("len(Breadcrumbs(probe:full)) = %d, want %d", len(got), len(want)) + } + for i, name := range want { + if got[i].FullName() != name { + t.Errorf("Breadcrumbs(probe:full)[%d] = %q, want %q", i, got[i].FullName(), name) + } + } +} + +func TestBreadcrumbsOfPageWithoutParent(t *testing.T) { + d := newTestDB(t) + + got, err := d.Breadcrumbs(context.Background(), articleID(t, d, "probe:parent")) + if err != nil { + t.Fatalf("Breadcrumbs() err = %v, want nil", err) + } + if len(got) != 1 { + t.Fatalf("len(Breadcrumbs(probe:parent)) = %d, want 1", len(got)) + } + if got[0].FullName() != "probe:parent" { + t.Errorf("Breadcrumbs(probe:parent)[0] = %q, want %q", got[0].FullName(), "probe:parent") + } +} + +func TestArticleTagCategoriesOrdersPriorityBeforeUnset(t *testing.T) { + d := newTestDB(t) + + got, err := d.ArticleTagCategories(context.Background(), articleID(t, d, "probe:full")) + if err != nil { + t.Fatalf("ArticleTagCategories() err = %v, want nil", err) + } + if len(got) != 2 { + t.Fatalf("len(ArticleTagCategories(probe:full)) = %d, want 2", len(got)) + } + if got[0].Name != "lang" { + t.Errorf("ArticleTagCategories(probe:full)[0].Name = %q, want %q", got[0].Name, "lang") + } + if got[0].Priority == nil || *got[0].Priority != 1 { + t.Errorf("ArticleTagCategories(probe:full)[0].Priority = %v, want 1", got[0].Priority) + } + if got[1].Priority != nil { + t.Errorf("ArticleTagCategories(probe:full)[1].Priority = %v, want nil", got[1].Priority) + } +} + +func TestArticleTagCategoriesKeepsTagOrder(t *testing.T) { + d := newTestDB(t) + + got, err := d.ArticleTagCategories(context.Background(), articleID(t, d, "probe:full")) + if err != nil { + t.Fatalf("ArticleTagCategories() err = %v, want nil", err) + } + if len(got) != 2 { + t.Fatalf("len(ArticleTagCategories(probe:full)) = %d, want 2", len(got)) + } + want := []string{"lang:en", "zeta", "alpha"} + var full []string + for _, category := range got { + for _, tag := range category.Tags { + full = append(full, tag.FullName) + } + } + if len(full) != len(want) { + t.Fatalf("len(tags of probe:full) = %d, want %d", len(full), len(want)) + } + for i := range want { + if full[i] != want[i] { + t.Errorf("tags of probe:full [%d] = %q, want %q", i, full[i], want[i]) + } + } +} + +func TestArticleTagCategoriesOfUntaggedPage(t *testing.T) { + d := newTestDB(t) + + got, err := d.ArticleTagCategories(context.Background(), articleID(t, d, "probe:bare")) + if err != nil { + t.Fatalf("ArticleTagCategories() err = %v, want nil", err) + } + if len(got) != 0 { + t.Errorf("len(ArticleTagCategories(probe:bare)) = %d, want 0", len(got)) + } +} + +func TestLatestRevNumber(t *testing.T) { + d := newTestDB(t) + + got, err := d.LatestRevNumber(context.Background(), articleID(t, d, "probe:full")) + if err != nil { + t.Fatalf("LatestRevNumber() err = %v, want nil", err) + } + if got != 0 { + t.Errorf("LatestRevNumber(probe:full) = %d, want 0", got) + } +} + +func TestCategoryIndexedOfUnknownCategory(t *testing.T) { + d := newTestDB(t) + + got, err := d.CategoryIndexed(context.Background(), "no-such-category") + if err != nil { + t.Fatalf("CategoryIndexed() err = %v, want nil", err) + } + if !got { + t.Errorf("CategoryIndexed(no-such-category) = false, want true") + } +} diff --git a/internal/db/site.go b/internal/db/site.go index 90c38ddc..2118033d 100644 --- a/internal/db/site.go +++ b/internal/db/site.go @@ -16,10 +16,12 @@ type Site struct { Domain string MediaDomain string HomePage string + Icon string + ThemeID *int64 } var qSiteByHost = register("SiteByHost", ` -SELECT id, slug, title, headline, domain, media_domain, home_page +SELECT id, slug, title, headline, domain, media_domain, home_page, COALESCE(icon, ''), active_theme_id FROM web_site WHERE domain = $1 OR media_domain = $1 ORDER BY id @@ -32,7 +34,8 @@ func (d *DB) SiteByHosts(ctx context.Context, hosts []string) (*Site, error) { for _, host := range hosts { var s Site err := d.pool.QueryRow(ctx, qSiteByHost, host).Scan( - &s.ID, &s.Slug, &s.Title, &s.Headline, &s.Domain, &s.MediaDomain, &s.HomePage) + &s.ID, &s.Slug, &s.Title, &s.Headline, &s.Domain, &s.MediaDomain, &s.HomePage, + &s.Icon, &s.ThemeID) if errors.Is(err, pgx.ErrNoRows) { continue } diff --git a/internal/db/testdata/oracle_chrome.py b/internal/db/testdata/oracle_chrome.py new file mode 100644 index 00000000..7bd22408 --- /dev/null +++ b/internal/db/testdata/oracle_chrome.py @@ -0,0 +1,42 @@ +"""Print what Django answers for the page shell's own queries. + + docker compose exec -T web python manage.py shell < internal/db/testdata/oracle_chrome.py + +It reads the pages oracle_seed.py creates, so run that one first. The answers +here are what internal/db/chrome_test.go asserts. +""" + +from web.controllers import articles +from web.models.articles import Category + + +def show_breadcrumbs(full_name): + crumbs = articles.get_breadcrumbs(full_name) + print('breadcrumbs %s = %s' % (full_name, [articles.get_full_name(a) for a in crumbs])) + + +def show_tags(full_name): + block = articles.get_tags_categories(full_name) + print('tags %s = %s' % (full_name, [ + (category.name, category.priority, [tag.full_name for tag in tags]) + for category, tags in block.items() + ])) + + +def show_rev(full_name): + article = articles.get_article(full_name) + entry = articles.get_latest_log_entry(article) + print('rev %s = %s' % (full_name, entry.rev_number if entry else None)) + + +def show_indexed(name): + print('indexed %s = %s' % (name, Category.get_or_default_category(name).is_indexed)) + + +for name in ('probe:full', 'probe:parent', 'probe:bare'): + show_breadcrumbs(name) + show_tags(name) + show_rev(name) + +for name in ('probe', 'no-such-category', '_default'): + show_indexed(name) diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index cb32c766..be9ef9ba 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -95,6 +95,7 @@ def vote(article, user, rate): full.authors.set([author, coauthor]) bare.authors.clear() full.tags.set([make_tag('_default', 'Zeta'), make_tag('_default', 'alpha'), make_tag('lang', 'en')]) +TagsCategory.objects.filter(slug='lang').update(priority=1) bare.tags.clear() vote(full, author, 1) diff --git a/internal/site/theme.go b/internal/site/theme.go new file mode 100644 index 00000000..ed6c9ac3 --- /dev/null +++ b/internal/site/theme.go @@ -0,0 +1,26 @@ +package site + +import ( + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/static" +) + +const DefaultThemeURL = static.Prefix + "theme.css" + +// ThemeURL is the stylesheet a page loads after the base one. A theme that is +// gone or points at nothing falls back rather than leaving the page unstyled. +func ThemeURL(t *db.Theme) string { + if t == nil { + return DefaultThemeURL + } + if t.Mode == db.ThemeExternal { + if url := strings.TrimSpace(t.ExternalURL); url != "" { + return url + } + return DefaultThemeURL + } + return "/-/theme/" + t.Slug + ".css?v=" + strconv.FormatInt(t.UpdatedAt.Unix(), 10) +} diff --git a/internal/site/theme_test.go b/internal/site/theme_test.go new file mode 100644 index 00000000..8d076951 --- /dev/null +++ b/internal/site/theme_test.go @@ -0,0 +1,37 @@ +package site + +import ( + "testing" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func TestThemeURLWithoutTheme(t *testing.T) { + if got := ThemeURL(nil); got != DefaultThemeURL { + t.Errorf("ThemeURL(nil) = %q, want %q", got, DefaultThemeURL) + } +} + +func TestThemeURLOfInlineTheme(t *testing.T) { + theme := &db.Theme{Slug: "dark", Mode: db.ThemeInline, UpdatedAt: time.Unix(1700000000, 0)} + want := "/-/theme/dark.css?v=1700000000" + if got := ThemeURL(theme); got != want { + t.Errorf("ThemeURL(inline) = %q, want %q", got, want) + } +} + +func TestThemeURLOfExternalTheme(t *testing.T) { + theme := &db.Theme{Slug: "dark", Mode: db.ThemeExternal, ExternalURL: " https://cdn.example/x.css "} + want := "https://cdn.example/x.css" + if got := ThemeURL(theme); got != want { + t.Errorf("ThemeURL(external) = %q, want %q", got, want) + } +} + +func TestThemeURLOfExternalThemeWithoutURL(t *testing.T) { + theme := &db.Theme{Slug: "dark", Mode: db.ThemeExternal, ExternalURL: " "} + if got := ThemeURL(theme); got != DefaultThemeURL { + t.Errorf("ThemeURL(external without url) = %q, want %q", got, DefaultThemeURL) + } +} From 5f5ab3904d0e9691513bc331f6ba4067ef377d6f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 26 Aug 2026 21:28:18 +0900 Subject: [PATCH 041/428] port python's json.dumps byte format --- internal/pyjson/pyjson.go | 148 ++++++++++++++ internal/pyjson/pyjson_test.go | 208 ++++++++++++++++++++ internal/pyjson/testdata/oracle_pyjson.py | 29 +++ internal/pyjson/testdata/pyjson.golden | 68 +++++++ internal/pyjson/testdata/pyjson_corpus.json | 36 ++++ 5 files changed, 489 insertions(+) create mode 100644 internal/pyjson/pyjson.go create mode 100644 internal/pyjson/pyjson_test.go create mode 100644 internal/pyjson/testdata/oracle_pyjson.py create mode 100644 internal/pyjson/testdata/pyjson.golden create mode 100644 internal/pyjson/testdata/pyjson_corpus.json diff --git a/internal/pyjson/pyjson.go b/internal/pyjson/pyjson.go new file mode 100644 index 00000000..fd3020cc --- /dev/null +++ b/internal/pyjson/pyjson.go @@ -0,0 +1,148 @@ +// Package pyjson spells values the way Python's json.dumps does. +package pyjson + +import ( + "fmt" + "math" + "strconv" + "strings" +) + +// Field is one key of an object. Objects are slices rather than maps because +// Python writes a dict in insertion order and these are compared byte for byte. +type Field struct { + Key string + Value any +} + +type Object []Field + +type Array []any + +// Marshal writes v with Python's separators, which carry a space that +// encoding/json never writes. +func Marshal(v any) (string, error) { + var b strings.Builder + if err := write(&b, v); err != nil { + return "", err + } + return b.String(), nil +} + +func write(b *strings.Builder, v any) error { + switch value := v.(type) { + case nil: + b.WriteString("null") + case bool: + if value { + b.WriteString("true") + } else { + b.WriteString("false") + } + case string: + b.WriteString(String(value)) + case int: + b.WriteString(strconv.Itoa(value)) + case int64: + b.WriteString(strconv.FormatInt(value, 10)) + case float64: + s, err := Float(value) + if err != nil { + return err + } + b.WriteString(s) + case Object: + return writeObject(b, value) + case Array: + return writeArray(b, value) + case []string: + items := make(Array, len(value)) + for i, item := range value { + items[i] = item + } + return writeArray(b, items) + default: + return fmt.Errorf("pyjson: cannot write %T", v) + } + return nil +} + +func writeObject(b *strings.Builder, o Object) error { + b.WriteByte('{') + for i, field := range o { + if i > 0 { + b.WriteString(", ") + } + b.WriteString(String(field.Key)) + b.WriteString(": ") + if err := write(b, field.Value); err != nil { + return err + } + } + b.WriteByte('}') + return nil +} + +func writeArray(b *strings.Builder, a Array) error { + b.WriteByte('[') + for i, item := range a { + if i > 0 { + b.WriteString(", ") + } + if err := write(b, item); err != nil { + return err + } + } + b.WriteByte(']') + return nil +} + +// Float writes what Python's repr gives. Go drops the fraction of a whole +// number and Python keeps it, so 4.0 must not come out as 4. +func Float(f float64) (string, error) { + if math.IsInf(f, 0) || math.IsNaN(f) { + return "", fmt.Errorf("pyjson: cannot write %v", f) + } + s := strconv.FormatFloat(f, 'g', -1, 64) + if !strings.ContainsAny(s, ".e") { + s += ".0" + } + return s, nil +} + +// String escapes every character outside printable ASCII, which is what +// ensure_ascii does, and leaves the HTML ones alone. +func String(s string) string { + var b strings.Builder + b.WriteByte('"') + for _, r := range s { + switch r { + case '"': + b.WriteString(`\"`) + case '\\': + b.WriteString(`\\`) + case '\n': + b.WriteString(`\n`) + case '\r': + b.WriteString(`\r`) + case '\t': + b.WriteString(`\t`) + case '\b': + b.WriteString(`\b`) + case '\f': + b.WriteString(`\f`) + default: + switch { + case r >= 0x20 && r <= 0x7e: + b.WriteRune(r) + case r > 0xffff: + r -= 0x10000 + fmt.Fprintf(&b, `\u%04x\u%04x`, 0xd800+(r>>10), 0xdc00+(r&0x3ff)) + default: + fmt.Fprintf(&b, `\u%04x`, r) + } + } + } + b.WriteByte('"') + return b.String() +} diff --git a/internal/pyjson/pyjson_test.go b/internal/pyjson/pyjson_test.go new file mode 100644 index 00000000..e5dccf42 --- /dev/null +++ b/internal/pyjson/pyjson_test.go @@ -0,0 +1,208 @@ +package pyjson + +import ( + "encoding/json" + "flag" + "fmt" + "io" + "os" + "path/filepath" + "strings" + "testing" +) + +var update = flag.Bool("update", false, "rewrite the golden file and the corpus the oracle reads") + +const ( + goldenPath = "testdata/pyjson.golden" + corpusPath = "testdata/pyjson_corpus.json" +) + +func escaped(r rune) string { return fmt.Sprintf(`\u%04x`, r) } + +func corpus() []string { + return []string{ + `null`, + `true`, + `false`, + `0`, + `-17`, + `4.0`, + `3.5`, + `-0.25`, + `0.1`, + `100.0`, + `1e-05`, + `""`, + `"plain"`, + `"with \"quotes\" and \\ backslash"`, + `"tab\there"`, + `"line\nbreak"`, + `"` + escaped(0x07) + `bell"`, + `"` + escaped(0x7f) + `del"`, + `"&"`, + `"it's"`, + `"中文"`, + `"emoji 😀"`, + `"` + escaped(0xa0) + `nbsp"`, + `[]`, + `[1, 2, 3]`, + `["a", null, true, 2.0]`, + `[[1], [], [null]]`, + `{}`, + `{"a": 1}`, + `{"b": 1, "a": 2}`, + `{"user": {"type": "anonymous", "name": "匿名用户", "username": null}, "notificationCount": 0}`, + `{"nested": {"list": [{"k": "v"}, {}]}}`, + `{"键": "值"}`, + `{"rating": 4.0, "votes": 12, "popularity": 92, "mode": "updown"}`, + } +} + +// decode turns one corpus document into the pyjson values that spell it, which +// is where an int stays an int and 4.0 stays a float. +func decode(t *testing.T, doc string) any { + t.Helper() + dec := json.NewDecoder(strings.NewReader(doc)) + dec.UseNumber() + value, err := decodeValue(t, dec) + if err != nil { + t.Fatalf("decode(%s) err = %v, want nil", doc, err) + } + return value +} + +func decodeValue(t *testing.T, dec *json.Decoder) (any, error) { + t.Helper() + token, err := dec.Token() + if err != nil { + return nil, err + } + return decodeToken(t, dec, token) +} + +func decodeToken(t *testing.T, dec *json.Decoder, token json.Token) (any, error) { + t.Helper() + switch value := token.(type) { + case nil: + return nil, nil + case bool: + return value, nil + case string: + return value, nil + case json.Number: + if strings.ContainsAny(value.String(), ".eE") { + return value.Float64() + } + return value.Int64() + case json.Delim: + if value == '{' { + return decodeObject(t, dec) + } + return decodeArray(t, dec) + } + return nil, fmt.Errorf("unexpected token %v", token) +} + +func decodeObject(t *testing.T, dec *json.Decoder) (Object, error) { + t.Helper() + out := Object{} + for { + token, err := dec.Token() + if err != nil { + return nil, err + } + if delim, ok := token.(json.Delim); ok && delim == '}' { + return out, nil + } + key, ok := token.(string) + if !ok { + return nil, fmt.Errorf("object key %v is not a string", token) + } + value, err := decodeValue(t, dec) + if err != nil { + return nil, err + } + out = append(out, Field{Key: key, Value: value}) + } +} + +func decodeArray(t *testing.T, dec *json.Decoder) (Array, error) { + t.Helper() + out := Array{} + for { + token, err := dec.Token() + if err == io.EOF { + return nil, err + } + if err != nil { + return nil, err + } + if delim, ok := token.(json.Delim); ok && delim == ']' { + return out, nil + } + value, err := decodeToken(t, dec, token) + if err != nil { + return nil, err + } + out = append(out, value) + } +} + +func TestMarshalMatchesGolden(t *testing.T) { + docs := corpus() + + var b strings.Builder + for _, doc := range docs { + got, err := Marshal(decode(t, doc)) + if err != nil { + t.Fatalf("Marshal(%s) err = %v, want nil", doc, err) + } + fmt.Fprintf(&b, "=== %s\n%s\n", doc, got) + } + got := b.String() + + if *update { + writeCorpus(t, docs) + if err := os.WriteFile(filepath.FromSlash(goldenPath), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", goldenPath, err) + } + return + } + + want, err := os.ReadFile(filepath.FromSlash(goldenPath)) + if err != nil { + t.Fatalf("ReadFile(%s) err = %v, want nil", goldenPath, err) + } + if got != string(want) { + t.Errorf("Marshal(corpus) = %q, want %q", got, string(want)) + } +} + +func writeCorpus(t *testing.T, docs []string) { + t.Helper() + data, err := json.MarshalIndent(docs, "", " ") + if err != nil { + t.Fatalf("Marshal(corpus) err = %v, want nil", err) + } + if err := os.WriteFile(filepath.FromSlash(corpusPath), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", corpusPath, err) + } +} + +func TestMarshalRejectsUnknownType(t *testing.T) { + if _, err := Marshal(struct{}{}); err == nil { + t.Error("Marshal(struct{}{}) err = nil, want an error") + } +} + +func TestMarshalKeepsObjectOrder(t *testing.T) { + got, err := Marshal(Object{{Key: "b", Value: 1}, {Key: "a", Value: 2}}) + if err != nil { + t.Fatalf("Marshal() err = %v, want nil", err) + } + want := `{"b": 1, "a": 2}` + if got != want { + t.Errorf("Marshal() = %q, want %q", got, want) + } +} diff --git a/internal/pyjson/testdata/oracle_pyjson.py b/internal/pyjson/testdata/oracle_pyjson.py new file mode 100644 index 00000000..3b16292f --- /dev/null +++ b/internal/pyjson/testdata/oracle_pyjson.py @@ -0,0 +1,29 @@ +"""Dump the same corpus with Python's own json.dumps. + + PYJSON_CORPUS="$(cat internal/pyjson/testdata/pyjson_corpus.json)" \ + python internal/pyjson/testdata/oracle_pyjson.py > pyjson.python.golden + +It needs no Django, so a host Python does. To check the version the server runs: + + PYJSON_CORPUS="$(cat internal/pyjson/testdata/pyjson_corpus.json)" \ + docker compose exec -T -e PYJSON_CORPUS web python \ + < internal/pyjson/testdata/oracle_pyjson.py + +Then compare with internal/pyjson/testdata/pyjson.golden. Each corpus entry is a +JSON document; json.loads keeps the key order and tells an int from a float, +which is what the comparison is about. +""" + +import io +import json +import os +import sys + +corpus = os.environ.get('PYJSON_CORPUS') +if not corpus: + raise SystemExit(__doc__) + +out = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8', newline='\n') +for doc in json.loads(corpus): + out.write('=== %s\n%s\n' % (doc, json.dumps(json.loads(doc)))) +out.flush() diff --git a/internal/pyjson/testdata/pyjson.golden b/internal/pyjson/testdata/pyjson.golden new file mode 100644 index 00000000..8de3903e --- /dev/null +++ b/internal/pyjson/testdata/pyjson.golden @@ -0,0 +1,68 @@ +=== null +null +=== true +true +=== false +false +=== 0 +0 +=== -17 +-17 +=== 4.0 +4.0 +=== 3.5 +3.5 +=== -0.25 +-0.25 +=== 0.1 +0.1 +=== 100.0 +100.0 +=== 1e-05 +1e-05 +=== "" +"" +=== "plain" +"plain" +=== "with \"quotes\" and \\ backslash" +"with \"quotes\" and \\ backslash" +=== "tab\there" +"tab\there" +=== "line\nbreak" +"line\nbreak" +=== "\u0007bell" +"\u0007bell" +=== "\u007fdel" +"\u007fdel" +=== "&" +"&" +=== "it's" +"it's" +=== "中文" +"\u4e2d\u6587" +=== "emoji 😀" +"emoji \ud83d\ude00" +=== "\u00a0nbsp" +"\u00a0nbsp" +=== [] +[] +=== [1, 2, 3] +[1, 2, 3] +=== ["a", null, true, 2.0] +["a", null, true, 2.0] +=== [[1], [], [null]] +[[1], [], [null]] +=== {} +{} +=== {"a": 1} +{"a": 1} +=== {"b": 1, "a": 2} +{"b": 1, "a": 2} +=== {"user": {"type": "anonymous", "name": "匿名用户", "username": null}, "notificationCount": 0} +{"user": {"type": "anonymous", "name": "\u533f\u540d\u7528\u6237", "username": null}, "notificationCount": 0} +=== {"nested": {"list": [{"k": "v"}, {}]}} +{"nested": {"list": [{"k": "v"}, {}]}} +=== {"键": "值"} +{"\u952e": "\u503c"} +=== {"rating": 4.0, "votes": 12, "popularity": 92, "mode": "updown"} +{"rating": 4.0, "votes": 12, "popularity": 92, "mode": "updown"} diff --git a/internal/pyjson/testdata/pyjson_corpus.json b/internal/pyjson/testdata/pyjson_corpus.json new file mode 100644 index 00000000..bb6252a8 --- /dev/null +++ b/internal/pyjson/testdata/pyjson_corpus.json @@ -0,0 +1,36 @@ +[ + "null", + "true", + "false", + "0", + "-17", + "4.0", + "3.5", + "-0.25", + "0.1", + "100.0", + "1e-05", + "\"\"", + "\"plain\"", + "\"with \\\"quotes\\\" and \\\\ backslash\"", + "\"tab\\there\"", + "\"line\\nbreak\"", + "\"\\u0007bell\"", + "\"\\u007fdel\"", + "\"\u003cb\u003e\u0026amp;\u003c/b\u003e\"", + "\"it's\"", + "\"中文\"", + "\"emoji 😀\"", + "\"\\u00a0nbsp\"", + "[]", + "[1, 2, 3]", + "[\"a\", null, true, 2.0]", + "[[1], [], [null]]", + "{}", + "{\"a\": 1}", + "{\"b\": 1, \"a\": 2}", + "{\"user\": {\"type\": \"anonymous\", \"name\": \"匿名用户\", \"username\": null}, \"notificationCount\": 0}", + "{\"nested\": {\"list\": [{\"k\": \"v\"}, {}]}}", + "{\"键\": \"值\"}", + "{\"rating\": 4.0, \"votes\": 12, \"popularity\": 92, \"mode\": \"updown\"}" +] From 64b17c6d5a98b68422e649a7fee127b706465869 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 26 Aug 2026 21:47:02 +0900 Subject: [PATCH 042/428] use pyjson for the path_expr variable --- internal/article/vars.go | 43 +++------------------------------- internal/pyjson/pyjson_test.go | 2 -- 2 files changed, 3 insertions(+), 42 deletions(-) diff --git a/internal/article/vars.go b/internal/article/vars.go index 49b4ca52..6e29c53e 100644 --- a/internal/article/vars.go +++ b/internal/article/vars.go @@ -1,10 +1,10 @@ package article import ( - "fmt" "strings" "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" ) const ( @@ -24,11 +24,11 @@ func ThisPage(params Params, canonicalURL string) func(string) (string, bool) { param, ok := params.Lookup(lookupKey(name, prefixExpr)) switch { case !ok: - return jsonString(literal(name)), true + return pyjson.String(literal(name)), true case param.Bare: return "null", true } - return jsonString(param.Value), true + return pyjson.String(param.Value), true case strings.HasPrefix(name, prefixURL): param, ok := params.Lookup(lookupKey(name, prefixURL)) @@ -58,40 +58,3 @@ func lookupKey(name, prefix string) string { } func literal(name string) string { return "%%" + name + "%%" } - -// jsonString spells a string the way Python's json.dumps does, which escapes -// every character outside printable ASCII and leaves the HTML ones alone. -func jsonString(s string) string { - var b strings.Builder - b.WriteByte('"') - for _, r := range s { - switch r { - case '"': - b.WriteString(`\"`) - case '\\': - b.WriteString(`\\`) - case '\n': - b.WriteString(`\n`) - case '\r': - b.WriteString(`\r`) - case '\t': - b.WriteString(`\t`) - case '\b': - b.WriteString(`\b`) - case '\f': - b.WriteString(`\f`) - default: - switch { - case r >= 0x20 && r <= 0x7e: - b.WriteRune(r) - case r > 0xffff: - r -= 0x10000 - fmt.Fprintf(&b, `\u%04x\u%04x`, 0xd800+(r>>10), 0xdc00+(r&0x3ff)) - default: - fmt.Fprintf(&b, `\u%04x`, r) - } - } - } - b.WriteByte('"') - return b.String() -} diff --git a/internal/pyjson/pyjson_test.go b/internal/pyjson/pyjson_test.go index e5dccf42..f7185603 100644 --- a/internal/pyjson/pyjson_test.go +++ b/internal/pyjson/pyjson_test.go @@ -59,8 +59,6 @@ func corpus() []string { } } -// decode turns one corpus document into the pyjson values that spell it, which -// is where an int stays an int and 4.0 stays a float. func decode(t *testing.T, doc string) any { t.Helper() dec := json.NewDecoder(strings.NewReader(doc)) From 6a1cd0d4d94cfe9024ff5addd9f3939d0b99c268 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 26 Aug 2026 21:49:50 +0900 Subject: [PATCH 043/428] add the fields login status needs --- internal/db/chrome_test.go | 16 +++ internal/db/notification.go | 19 +++ internal/db/user.go | 23 ++++ internal/pageconfig/user.go | 121 ++++++++++++++++ internal/pageconfig/user_test.go | 228 +++++++++++++++++++++++++++++++ internal/roles/roles.go | 4 + 6 files changed, 411 insertions(+) create mode 100644 internal/db/notification.go create mode 100644 internal/pageconfig/user.go create mode 100644 internal/pageconfig/user_test.go diff --git a/internal/db/chrome_test.go b/internal/db/chrome_test.go index 1c759894..39712151 100644 --- a/internal/db/chrome_test.go +++ b/internal/db/chrome_test.go @@ -130,3 +130,19 @@ func TestCategoryIndexedOfUnknownCategory(t *testing.T) { t.Errorf("CategoryIndexed(no-such-category) = false, want true") } } + +func TestUnreadNotificationsCountsOnlyUnviewed(t *testing.T) { + d := newTestDB(t) + + u, err := d.UserByName(context.Background(), "probeauthor") + if err != nil { + t.Fatalf("UserByName() err = %v, want nil", err) + } + got, err := d.UnreadNotifications(context.Background(), u.ID) + if err != nil { + t.Fatalf("UnreadNotifications() err = %v, want nil", err) + } + if got != 1 { + t.Errorf("UnreadNotifications(probeauthor) = %d, want 1", got) + } +} diff --git a/internal/db/notification.go b/internal/db/notification.go new file mode 100644 index 00000000..23b397ef --- /dev/null +++ b/internal/db/notification.go @@ -0,0 +1,19 @@ +package db + +import ( + "context" + "fmt" +) + +var qUnreadNotifications = register("UnreadNotifications", ` +SELECT count(*) +FROM web_usernotificationmapping +WHERE recipient_id = $1 AND is_viewed = false`) + +func (d *DB) UnreadNotifications(ctx context.Context, userID int64) (int, error) { + var n int + if err := d.pool.QueryRow(ctx, qUnreadNotifications, userID).Scan(&n); err != nil { + return 0, fmt.Errorf("count unread notifications of user %d: %w", userID, err) + } + return n, nil +} diff --git a/internal/db/user.go b/internal/db/user.go index e446fe2c..c5c5b171 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -38,6 +38,29 @@ func (u *User) ActiveAt(now time.Time) bool { return now.After(*u.InactiveUntil) } +func (u *User) DisplayLabel() string { + if u.Type == UserTypeWikidot { + return "wd:" + firstNonEmpty(u.DisplayName, u.WikidotUsername, u.Username) + } + return firstNonEmpty(u.DisplayName, u.Username) +} + +func (u *User) URLName() string { + if u.Type == UserTypeWikidot { + return firstNonEmpty(u.WikidotUsername, u.Username) + } + return u.Username +} + +func firstNonEmpty(values ...string) string { + for _, value := range values { + if value != "" { + return value + } + } + return "" +} + const userColumns = `id, type, username, wikidot_username, display_name, avatar, is_active, inactive_until, is_superuser` // Django's QuerySet.first() falls back to ordering by primary key when the diff --git a/internal/pageconfig/user.go b/internal/pageconfig/user.go new file mode 100644 index 00000000..c11531c2 --- /dev/null +++ b/internal/pageconfig/user.go @@ -0,0 +1,121 @@ +package pageconfig + +import ( + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/roles" +) + +const ( + typeAnonymous = "anonymous" + typeSystem = "system" +) + +type UserJSON struct { + Type string + ID any + Name any + Username any + URLName any + IsActive bool + Avatar any + ShowAvatar bool + Admin bool + Staff bool + Editor any + Roles any +} + +func (u UserJSON) object() pyjson.Object { + return pyjson.Object{ + {Key: "type", Value: u.Type}, + {Key: "id", Value: u.ID}, + {Key: "name", Value: u.Name}, + {Key: "username", Value: u.Username}, + {Key: "urlName", Value: u.URLName}, + {Key: "isActive", Value: u.IsActive}, + {Key: "avatar", Value: u.Avatar}, + {Key: "showAvatar", Value: u.ShowAvatar}, + {Key: "admin", Value: u.Admin}, + {Key: "staff", Value: u.Staff}, + {Key: "editor", Value: u.Editor}, + {Key: "roles", Value: u.Roles}, + } +} + +func (u UserJSON) JSON() (string, error) { return pyjson.Marshal(u.object()) } + +func SystemUserJSON() UserJSON { + return UserJSON{Type: typeSystem, IsActive: true, Editor: false} +} + +func AnonymousUserJSON(loc *i18n.Localizer, showAvatar bool) UserJSON { + return UserJSON{ + Type: typeAnonymous, + Name: loc.T("user-anonymous"), + IsActive: true, + ShowAvatar: showAvatar, + Editor: false, + } +} + +func SignedInUserJSON(u *db.User, userRoles []roles.Role, showAvatar, editor bool) UserJSON { + out := UserJSON{ + Type: u.Type, + ID: u.ID, + Name: u.DisplayLabel(), + Username: u.Username, + URLName: u.URLName(), + IsActive: u.IsActive, + ShowAvatar: showAvatar, + Admin: u.IsSuperuser, + Staff: IsStaff(u, userRoles), + Editor: editor, + Roles: visualSlugs(userRoles), + } + if u.Avatar != "" { + out.Avatar = "/local--files/" + u.Avatar + } + return out +} + +func IsStaff(u *db.User, userRoles []roles.Role) bool { + if u.IsSuperuser { + return true + } + for _, role := range userRoles { + if role.IsStaff { + return true + } + } + return false +} + +func visualSlugs(userRoles []roles.Role) []string { + out := []string{} + for _, role := range userRoles { + if role.IsVisual() { + out = append(out, role.Slug) + } + } + return out +} + +type LoginStatus struct { + User *db.User + Roles []roles.Role + CanEditArticles bool + NotificationCount int +} + +func (l LoginStatus) JSON(loc *i18n.Localizer) (string, error) { + user := AnonymousUserJSON(loc, true) + if l.User != nil { + user = SignedInUserJSON(l.User, l.Roles, true, l.CanEditArticles) + } + return pyjson.Marshal(pyjson.Object{ + {Key: "user", Value: user.object()}, + {Key: "notificationCount", Value: l.NotificationCount}, + }) +} diff --git a/internal/pageconfig/user_test.go b/internal/pageconfig/user_test.go new file mode 100644 index 00000000..5f74c4c1 --- /dev/null +++ b/internal/pageconfig/user_test.go @@ -0,0 +1,228 @@ +package pageconfig + +import ( + "encoding/json" + "flag" + "fmt" + "os" + "path/filepath" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/roles" +) + +var update = flag.Bool("update", false, "rewrite the golden file and the corpus the oracle reads") + +const ( + goldenPath = "testdata/pageconfig.golden" + corpusPath = "testdata/login_corpus.json" +) + +type roleSpec struct { + Slug string `json:"slug"` + Index int `json:"index"` + IsStaff bool `json:"is_staff"` + GroupVotes bool `json:"group_votes"` + InlineMode string `json:"inline_visual_mode"` + ProfileMode string `json:"profile_visual_mode"` + CanEdit bool `json:"can_edit_articles"` +} + +type userSpec struct { + Username string `json:"username"` + Type string `json:"type"` + DisplayName string `json:"display_name"` + WikidotUsername string `json:"wikidot_username"` + Avatar string `json:"avatar"` + IsActive bool `json:"is_active"` + IsSuperuser bool `json:"is_superuser"` +} + +type caseSpec struct { + Name string `json:"name"` + Kind string `json:"kind"` + User *userSpec `json:"user,omitempty"` + Roles []roleSpec `json:"roles,omitempty"` + Editor bool `json:"editor"` + NotificationCount int `json:"notification_count"` +} + +func corpus() []caseSpec { + normal := func() *userSpec { + return &userSpec{Username: "loginprobe", Type: db.UserTypeNormal, IsActive: true} + } + badge := roleSpec{Slug: "probebadged", Index: 1, InlineMode: "badge", ProfileMode: "hidden"} + hidden := roleSpec{Slug: "probeinvisible", Index: 2, InlineMode: "hidden", ProfileMode: "hidden"} + staff := roleSpec{Slug: "probemoderator", Index: 3, IsStaff: true, InlineMode: "hidden", ProfileMode: "hidden"} + grouped := roleSpec{Slug: "probegrouped", Index: 4, GroupVotes: true, InlineMode: "hidden", ProfileMode: "hidden"} + profile := roleSpec{Slug: "probeprofiled", Index: 5, InlineMode: "hidden", ProfileMode: "status"} + + return []caseSpec{ + {Name: "anonymous", Kind: "anonymous"}, + {Name: "system", Kind: "system"}, + {Name: "plain", Kind: "user", User: normal()}, + { + Name: "with display name and avatar", + Kind: "user", + User: &userSpec{ + Username: "loginprobe", Type: db.UserTypeNormal, IsActive: true, + DisplayName: "Login Probe", Avatar: "-/users/loginprobe.png", + }, + }, + { + Name: "wikidot with display name", + Kind: "user", + User: &userSpec{ + Username: "loginprobe", Type: db.UserTypeWikidot, IsActive: true, + DisplayName: "Wd Display", WikidotUsername: "Wd Original", + }, + }, + { + Name: "wikidot without display name", + Kind: "user", + User: &userSpec{ + Username: "loginprobe", Type: db.UserTypeWikidot, IsActive: true, + WikidotUsername: "Wd Original", + }, + }, + { + Name: "inactive", + Kind: "user", + User: &userSpec{Username: "loginprobe", Type: db.UserTypeNormal, IsActive: false}, + }, + { + Name: "superuser", + Kind: "user", + User: &userSpec{Username: "loginprobe", Type: db.UserTypeNormal, IsActive: true, IsSuperuser: true}, + Editor: true, + }, + {Name: "staff by role", Kind: "user", User: normal(), Roles: []roleSpec{staff}}, + {Name: "visual roles", Kind: "user", User: normal(), Roles: []roleSpec{badge, hidden, grouped, profile}}, + {Name: "only hidden roles", Kind: "user", User: normal(), Roles: []roleSpec{hidden}}, + { + Name: "editor", + Kind: "user", + User: normal(), + Roles: []roleSpec{{Slug: "probeeditor", Index: 6, InlineMode: "hidden", ProfileMode: "hidden", CanEdit: true}}, + Editor: true, + }, + {Name: "with notifications", Kind: "user", User: normal(), NotificationCount: 7}, + { + Name: "unicode display name", + Kind: "user", + User: &userSpec{ + Username: "loginprobe", Type: db.UserTypeNormal, IsActive: true, DisplayName: "中文 名字", + }, + }, + } +} + +func localizer(t *testing.T) *i18n.Localizer { + t.Helper() + b, err := i18n.Load("") + if err != nil { + t.Fatalf("i18n.Load() err = %v, want nil", err) + } + return b.Localizer(i18n.DefaultLanguage) +} + +func toRoles(specs []roleSpec) []roles.Role { + out := make([]roles.Role, len(specs)) + for i, spec := range specs { + out[i] = roles.Role{ + Slug: spec.Slug, + Index: spec.Index, + IsStaff: spec.IsStaff, + GroupVotes: spec.GroupVotes, + InlineVisualMode: roles.InlineVisualMode(spec.InlineMode), + ProfileVisualMode: roles.ProfileVisualMode(spec.ProfileMode), + } + } + return out +} + +func toUser(spec *userSpec) *db.User { + return &db.User{ + ID: 424242, + Type: spec.Type, + Username: spec.Username, + WikidotUsername: spec.WikidotUsername, + DisplayName: spec.DisplayName, + Avatar: spec.Avatar, + IsActive: spec.IsActive, + IsSuperuser: spec.IsSuperuser, + } +} + +func render(t *testing.T, loc *i18n.Localizer, c caseSpec) string { + t.Helper() + if c.Kind == "system" { + got, err := SystemUserJSON().JSON() + if err != nil { + t.Fatalf("SystemUserJSON().JSON() err = %v, want nil", err) + } + return got + } + status := LoginStatus{Roles: toRoles(c.Roles), CanEditArticles: c.Editor, NotificationCount: c.NotificationCount} + if c.Kind == "user" { + status.User = toUser(c.User) + } + got, err := status.JSON(loc) + if err != nil { + t.Fatalf("LoginStatus(%s).JSON() err = %v, want nil", c.Name, err) + } + return got +} + +func TestLoginStatusMatchesGolden(t *testing.T) { + cases := corpus() + loc := localizer(t) + + var b strings.Builder + for _, c := range cases { + fmt.Fprintf(&b, "=== %s\n%s\n", c.Name, render(t, loc, c)) + } + got := b.String() + + if *update { + writeCorpus(t, cases) + if err := os.WriteFile(filepath.FromSlash(goldenPath), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", goldenPath, err) + } + return + } + + want, err := os.ReadFile(filepath.FromSlash(goldenPath)) + if err != nil { + t.Fatalf("ReadFile(%s) err = %v, want nil", goldenPath, err) + } + if got != string(want) { + t.Errorf("LoginStatus(corpus) = %q, want %q", got, string(want)) + } +} + +func writeCorpus(t *testing.T, cases []caseSpec) { + t.Helper() + data, err := json.MarshalIndent(cases, "", " ") + if err != nil { + t.Fatalf("Marshal(corpus) err = %v, want nil", err) + } + if err := os.WriteFile(filepath.FromSlash(corpusPath), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", corpusPath, err) + } +} + +func TestIsStaffOfSuperuserWithoutRoles(t *testing.T) { + if !IsStaff(&db.User{IsSuperuser: true}, nil) { + t.Error("IsStaff(superuser, nil) = false, want true") + } +} + +func TestIsStaffOfPlainUser(t *testing.T) { + if IsStaff(&db.User{}, []roles.Role{{Slug: "reader"}}) { + t.Error("IsStaff(user, reader) = true, want false") + } +} diff --git a/internal/roles/roles.go b/internal/roles/roles.go index 52971df2..e88303a1 100644 --- a/internal/roles/roles.go +++ b/internal/roles/roles.go @@ -46,6 +46,10 @@ type Role struct { BadgeShowBorder bool } +func (r Role) IsVisual() bool { + return r.GroupVotes || r.InlineVisualMode != InlineHidden || r.ProfileVisualMode != ProfileHidden +} + type Badge struct { Text string Bg string From 9a0a5e61840794e3d31ad65c3eb427c191880e47 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 26 Aug 2026 21:50:22 +0900 Subject: [PATCH 044/428] port login_status_config --- internal/page/testdata/oracle_seed.py | 11 + .../pageconfig/testdata/login_corpus.json | 265 ++++++++++++++++++ internal/pageconfig/testdata/oracle_login.py | 102 +++++++ .../pageconfig/testdata/pageconfig.golden | 28 ++ 4 files changed, 406 insertions(+) create mode 100644 internal/pageconfig/testdata/login_corpus.json create mode 100644 internal/pageconfig/testdata/oracle_login.py create mode 100644 internal/pageconfig/testdata/pageconfig.golden diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index be9ef9ba..e17193ae 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -17,6 +17,7 @@ from web.controllers import articles from web.models.articles import Article, Category, Tag, TagsCategory, Vote +from web.models.notifications import UserNotification, UserNotificationMapping from web.models.settings import Settings from web.models.site import Site from web.models.users import User @@ -54,6 +55,13 @@ def make_tag(slug, name): return tag +def notify(user, kind, viewed): + notification, _ = UserNotification.objects.get_or_create(type=kind, meta={'probe': kind}) + UserNotificationMapping.objects.update_or_create( + recipient=user, notification=notification, defaults=dict(is_viewed=viewed), + ) + + def vote(article, user, rate): Vote.objects.update_or_create( article=article, user=user, @@ -98,6 +106,9 @@ def vote(article, user, rate): TagsCategory.objects.filter(slug='lang').update(priority=1) bare.tags.clear() +notify(author, UserNotification.NotificationType.Welcome, False) +notify(author, UserNotification.NotificationType.DirectMessage, True) + vote(full, author, 1) vote(full, coauthor, 1) vote(full, voter, -1) diff --git a/internal/pageconfig/testdata/login_corpus.json b/internal/pageconfig/testdata/login_corpus.json new file mode 100644 index 00000000..29f664ff --- /dev/null +++ b/internal/pageconfig/testdata/login_corpus.json @@ -0,0 +1,265 @@ +[ + { + "name": "anonymous", + "kind": "anonymous", + "editor": false, + "notification_count": 0 + }, + { + "name": "system", + "kind": "system", + "editor": false, + "notification_count": 0 + }, + { + "name": "plain", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "", + "wikidot_username": "", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "editor": false, + "notification_count": 0 + }, + { + "name": "with display name and avatar", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "Login Probe", + "wikidot_username": "", + "avatar": "-/users/loginprobe.png", + "is_active": true, + "is_superuser": false + }, + "editor": false, + "notification_count": 0 + }, + { + "name": "wikidot with display name", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "wikidot", + "display_name": "Wd Display", + "wikidot_username": "Wd Original", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "editor": false, + "notification_count": 0 + }, + { + "name": "wikidot without display name", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "wikidot", + "display_name": "", + "wikidot_username": "Wd Original", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "editor": false, + "notification_count": 0 + }, + { + "name": "inactive", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "", + "wikidot_username": "", + "avatar": "", + "is_active": false, + "is_superuser": false + }, + "editor": false, + "notification_count": 0 + }, + { + "name": "superuser", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "", + "wikidot_username": "", + "avatar": "", + "is_active": true, + "is_superuser": true + }, + "editor": true, + "notification_count": 0 + }, + { + "name": "staff by role", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "", + "wikidot_username": "", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "roles": [ + { + "slug": "probemoderator", + "index": 3, + "is_staff": true, + "group_votes": false, + "inline_visual_mode": "hidden", + "profile_visual_mode": "hidden", + "can_edit_articles": false + } + ], + "editor": false, + "notification_count": 0 + }, + { + "name": "visual roles", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "", + "wikidot_username": "", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "roles": [ + { + "slug": "probebadged", + "index": 1, + "is_staff": false, + "group_votes": false, + "inline_visual_mode": "badge", + "profile_visual_mode": "hidden", + "can_edit_articles": false + }, + { + "slug": "probeinvisible", + "index": 2, + "is_staff": false, + "group_votes": false, + "inline_visual_mode": "hidden", + "profile_visual_mode": "hidden", + "can_edit_articles": false + }, + { + "slug": "probegrouped", + "index": 4, + "is_staff": false, + "group_votes": true, + "inline_visual_mode": "hidden", + "profile_visual_mode": "hidden", + "can_edit_articles": false + }, + { + "slug": "probeprofiled", + "index": 5, + "is_staff": false, + "group_votes": false, + "inline_visual_mode": "hidden", + "profile_visual_mode": "status", + "can_edit_articles": false + } + ], + "editor": false, + "notification_count": 0 + }, + { + "name": "only hidden roles", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "", + "wikidot_username": "", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "roles": [ + { + "slug": "probeinvisible", + "index": 2, + "is_staff": false, + "group_votes": false, + "inline_visual_mode": "hidden", + "profile_visual_mode": "hidden", + "can_edit_articles": false + } + ], + "editor": false, + "notification_count": 0 + }, + { + "name": "editor", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "", + "wikidot_username": "", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "roles": [ + { + "slug": "probeeditor", + "index": 6, + "is_staff": false, + "group_votes": false, + "inline_visual_mode": "hidden", + "profile_visual_mode": "hidden", + "can_edit_articles": true + } + ], + "editor": true, + "notification_count": 0 + }, + { + "name": "with notifications", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "", + "wikidot_username": "", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "editor": false, + "notification_count": 7 + }, + { + "name": "unicode display name", + "kind": "user", + "user": { + "username": "loginprobe", + "type": "normal", + "display_name": "中文 名字", + "wikidot_username": "", + "avatar": "", + "is_active": true, + "is_superuser": false + }, + "editor": false, + "notification_count": 0 + } +] diff --git a/internal/pageconfig/testdata/oracle_login.py b/internal/pageconfig/testdata/oracle_login.py new file mode 100644 index 00000000..7889b96c --- /dev/null +++ b/internal/pageconfig/testdata/oracle_login.py @@ -0,0 +1,102 @@ +"""Record what Django puts in login_status_config, one case at a time. + + LOGIN_CORPUS="$(cat internal/pageconfig/testdata/login_corpus.json)" \ + docker compose exec -T -e LOGIN_CORPUS \ + web python manage.py shell < internal/pageconfig/testdata/oracle_login.py \ + > pageconfig.django.golden + +Then compare it with internal/pageconfig/testdata/pageconfig.golden. + +Every case builds its roles and user inside a transaction that is rolled back +afterwards, so the development database keeps its own rows and every case can +reuse the same username and pk. json.dumps is patched the way wsgi.py patches +it, which is what teaches it these dataclasses. notificationCount comes from the +corpus rather than from rows, because the count itself is what +internal/db/chrome_test.go checks. +""" + +import io +import json +import os +import sys + +from django.contrib.auth.models import Permission +from django.db import transaction + +from web.models.roles import Role +from web.models.users import ExtendedAnonymousUser, User +from web.permissions import get_role_permissions_content_type +from renderer.utils import render_user_to_json +from web.util.json import replace_json_dumps_default + +replace_json_dumps_default() + +CORPUS = json.loads(os.environ['LOGIN_CORPUS']) +CONTENT_TYPE = get_role_permissions_content_type() + +sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8', newline='\n') + + +class Rollback(Exception): + pass + + +def build_roles(specs): + built = [] + for spec in specs or []: + role, _ = Role.objects.get_or_create(slug=spec['slug']) + role.index = spec['index'] + role.is_staff = spec['is_staff'] + role.group_votes = spec['group_votes'] + role.inline_visual_mode = spec['inline_visual_mode'] + role.profile_visual_mode = spec['profile_visual_mode'] + role.save() + if spec['can_edit_articles']: + role.permissions.set([Permission.objects.get( + codename='edit_articles', content_type=CONTENT_TYPE)]) + else: + role.permissions.set([]) + built.append(role) + return built + + +def build_user(spec): + user = User.objects.create( + id=424242, + username=spec['username'], + type=spec['type'], + display_name=spec['display_name'], + wikidot_username=spec['wikidot_username'] or None, + avatar=spec['avatar'], + is_active=spec['is_active'], + is_superuser=spec['is_superuser'], + api_key='login-probe-key', + ) + return user + + +def config(case): + if case['kind'] == 'system': + return json.dumps(render_user_to_json(None)) + out = None + try: + with transaction.atomic(): + roles = build_roles(case.get('roles')) + if case['kind'] == 'anonymous': + user = ExtendedAnonymousUser() + else: + user = build_user(case['user']) + user.roles.set(roles) + user = User.objects.get(pk=user.pk) + out = json.dumps({ + 'user': render_user_to_json(user), + 'notificationCount': case['notification_count'], + }) + raise Rollback + except Rollback: + pass + return out + + +for case in CORPUS: + sys.stdout.write('=== %s\n%s\n' % (case['name'], config(case))) diff --git a/internal/pageconfig/testdata/pageconfig.golden b/internal/pageconfig/testdata/pageconfig.golden new file mode 100644 index 00000000..64c24b10 --- /dev/null +++ b/internal/pageconfig/testdata/pageconfig.golden @@ -0,0 +1,28 @@ +=== anonymous +{"user": {"type": "anonymous", "id": null, "name": "\u533f\u540d\u7528\u6237", "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": null}, "notificationCount": 0} +=== system +{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null} +=== plain +{"user": {"type": "normal", "id": 424242, "name": "loginprobe", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "notificationCount": 0} +=== with display name and avatar +{"user": {"type": "normal", "id": 424242, "name": "Login Probe", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": "/local--files/-/users/loginprobe.png", "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "notificationCount": 0} +=== wikidot with display name +{"user": {"type": "wikidot", "id": 424242, "name": "wd:Wd Display", "username": "loginprobe", "urlName": "Wd Original", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "notificationCount": 0} +=== wikidot without display name +{"user": {"type": "wikidot", "id": 424242, "name": "wd:Wd Original", "username": "loginprobe", "urlName": "Wd Original", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "notificationCount": 0} +=== inactive +{"user": {"type": "normal", "id": 424242, "name": "loginprobe", "username": "loginprobe", "urlName": "loginprobe", "isActive": false, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "notificationCount": 0} +=== superuser +{"user": {"type": "normal", "id": 424242, "name": "loginprobe", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": null, "showAvatar": true, "admin": true, "staff": true, "editor": true, "roles": []}, "notificationCount": 0} +=== staff by role +{"user": {"type": "normal", "id": 424242, "name": "loginprobe", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": true, "editor": false, "roles": []}, "notificationCount": 0} +=== visual roles +{"user": {"type": "normal", "id": 424242, "name": "loginprobe", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": ["probebadged", "probegrouped", "probeprofiled"]}, "notificationCount": 0} +=== only hidden roles +{"user": {"type": "normal", "id": 424242, "name": "loginprobe", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "notificationCount": 0} +=== editor +{"user": {"type": "normal", "id": 424242, "name": "loginprobe", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": true, "roles": []}, "notificationCount": 0} +=== with notifications +{"user": {"type": "normal", "id": 424242, "name": "loginprobe", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "notificationCount": 7} +=== unicode display name +{"user": {"type": "normal", "id": 424242, "name": "\u4e2d\u6587 \u540d\u5b57", "username": "loginprobe", "urlName": "loginprobe", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "notificationCount": 0} From 0853eefc356e5f5a3bd1c335e35ae26ade563313 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:21 +0900 Subject: [PATCH 045/428] add the rating tuple the options carry --- internal/page/rating.go | 52 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 internal/page/rating.go diff --git a/internal/page/rating.go b/internal/page/rating.go new file mode 100644 index 00000000..097fb3cc --- /dev/null +++ b/internal/page/rating.go @@ -0,0 +1,52 @@ +package page + +import ( + "strconv" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +// Rating is what the page options carry. Value is an int under updown and a +// float under stars, and the difference reaches the frontend as written. +type Rating struct { + Value any + Votes int + Popularity int + Mode string +} + +func RatingOf(mode string, stats db.VoteStats) Rating { + if mode == RatingModeDisabled { + return Rating{Value: 0, Mode: mode} + } + good := stats.GoodUpDown + value := any(int(stats.Sum)) + if mode == RatingModeStars { + good = stats.GoodStars + value = round1(stats.Average) + } + count := stats.Count + if count == 0 { + count = 1 + } + return Rating{ + Value: value, + Votes: stats.Count, + Popularity: pyRound(float64(good) / float64(count) * 100), + Mode: mode, + } +} + +// round1 is Python's round(x, 1). Both languages round the exact binary value +// to nearest with ties going to the even digit, so the text round trip agrees. +func round1(x float64) float64 { + rounded, err := strconv.ParseFloat(strconv.FormatFloat(x, 'f', 1, 64), 64) + if err != nil { + return x + } + return rounded +} + +func DisabledRating() Rating { + return Rating{Value: 0, Mode: RatingModeDisabled} +} From bfc95f55d007a6b67472cd1d81c0cd61f53c3f18 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:22 +0900 Subject: [PATCH 046/428] add the queries the page options need --- internal/db/options.go | 177 ++++++++++++++++++++++++++ internal/db/options_test.go | 128 +++++++++++++++++++ internal/page/testdata/oracle_seed.py | 56 +++++++- 3 files changed, 355 insertions(+), 6 deletions(-) create mode 100644 internal/db/options.go create mode 100644 internal/db/options_test.go diff --git a/internal/db/options.go b/internal/db/options.go new file mode 100644 index 00000000..01d12196 --- /dev/null +++ b/internal/db/options.go @@ -0,0 +1,177 @@ +package db + +import ( + "context" + "errors" + "fmt" + + "github.com/jackc/pgx/v5" +) + +const ( + CreateTagsDefault = "default" + CreateTagsDisabled = "disabled" + CreateTagsEnabled = "enabled" +) + +var qSiteCanCreateTags = register("SiteCanCreateTags", ` +SELECT can_user_create_tags +FROM web_settings +WHERE site_id = $1`) + +// SiteCanCreateTags reads the site row alone. The page asks Site.settings, +// which never merges the category or the built-in defaults into it. +func (d *DB) SiteCanCreateTags(ctx context.Context, siteID int64) (string, error) { + var mode string + err := d.pool.QueryRow(ctx, qSiteCanCreateTags, siteID).Scan(&mode) + if errors.Is(err, pgx.ErrNoRows) { + return "", ErrNotFound + } + if err != nil { + return "", fmt.Errorf("query tag setting of site %d: %w", siteID, err) + } + return mode, nil +} + +type CommentInfo struct { + ThreadID int64 + Count int +} + +var qCommentInfo = register("CommentInfo", ` +SELECT t.id, (SELECT count(*) FROM web_forumpost p WHERE p.thread_id = t.id) +FROM web_forumthread t +WHERE t.article_id = $1`) + +// CommentInfo reports the zero value for a page whose thread has never been +// created. Django creates one here instead, which is a write on a read. +func (d *DB) CommentInfo(ctx context.Context, articleID int64) (CommentInfo, error) { + var info CommentInfo + err := d.pool.QueryRow(ctx, qCommentInfo, articleID).Scan(&info.ThreadID, &info.Count) + if errors.Is(err, pgx.ErrNoRows) { + return CommentInfo{}, nil + } + if err != nil { + return CommentInfo{}, fmt.Errorf("query comment thread of article %d: %w", articleID, err) + } + return info, nil +} + +var qSubscribedToArticle = register("SubscribedToArticle", ` +SELECT EXISTS( + SELECT 1 FROM web_usernotificationsubscription + WHERE subscriber_id = $1 AND article_id = $2 AND forum_thread_id IS NULL)`) + +func (d *DB) SubscribedToArticle(ctx context.Context, userID, articleID int64) (bool, error) { + var yes bool + if err := d.pool.QueryRow(ctx, qSubscribedToArticle, userID, articleID).Scan(&yes); err != nil { + return false, fmt.Errorf("check article subscription of user %d: %w", userID, err) + } + return yes, nil +} + +var qSubscribedToThread = register("SubscribedToThread", ` +SELECT EXISTS( + SELECT 1 FROM web_usernotificationsubscription + WHERE subscriber_id = $1 AND forum_thread_id = $2 AND article_id IS NULL)`) + +func (d *DB) SubscribedToThread(ctx context.Context, userID, threadID int64) (bool, error) { + var yes bool + if err := d.pool.QueryRow(ctx, qSubscribedToThread, userID, threadID).Scan(&yes); err != nil { + return false, fmt.Errorf("check thread subscription of user %d: %w", userID, err) + } + return yes, nil +} + +var qUserPreference = register("UserPreference", ` +SELECT raw_value +FROM dynamic_preferences_users_userpreferencemodel +WHERE instance_id = $1 AND section = $2 AND name = $3`) + +func (d *DB) UserPreference(ctx context.Context, userID int64, section, name string) (string, error) { + var raw string + err := d.pool.QueryRow(ctx, qUserPreference, userID, section, name).Scan(&raw) + if errors.Is(err, pgx.ErrNoRows) { + return "", ErrNotFound + } + if err != nil { + return "", fmt.Errorf("query preference %s.%s of user %d: %w", section, name, userID, err) + } + return raw, nil +} + +var qTagCategoryBySlug = register("TagCategoryBySlug", ` +SELECT id, name, priority +FROM web_tagscategory +WHERE slug = $1`) + +func (d *DB) TagCategoryBySlug(ctx context.Context, slug string) (TagCategory, error) { + var c TagCategory + err := d.pool.QueryRow(ctx, qTagCategoryBySlug, slug).Scan(&c.ID, &c.Name, &c.Priority) + if errors.Is(err, pgx.ErrNoRows) { + return TagCategory{}, ErrNotFound + } + if err != nil { + return TagCategory{}, fmt.Errorf("lookup tag category %q: %w", slug, err) + } + return c, nil +} + +var qCategoryNames = register("CategoryNames", `SELECT name FROM web_category`) + +func (d *DB) CategoryNames(ctx context.Context) ([]string, error) { + rows, err := d.pool.Query(ctx, qCategoryNames) + if err != nil { + return nil, fmt.Errorf("list categories: %w", err) + } + defer rows.Close() + + var out []string + for rows.Next() { + var name string + if err := rows.Scan(&name); err != nil { + return nil, fmt.Errorf("scan category name: %w", err) + } + out = append(out, name) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read categories: %w", err) + } + return out, nil +} + +var qArticlesByTag = register("ArticlesByTag", ` +SELECT `+prefixedArticleColumns+` +FROM web_article a +JOIN web_article_tags link ON link.article_id = a.id +JOIN web_tag t ON t.id = link.tag_id +JOIN web_tagscategory c ON c.id = t.category_id +WHERE c.slug = $1 AND t.name = $2 AND NOT (a.category = ANY($3)) +ORDER BY a.title`) + +// ArticlesByTag leaves out the categories the visitor cannot see, which the +// caller resolves because permissions are not a database question. +func (d *DB) ArticlesByTag(ctx context.Context, categorySlug, name string, hidden []string) ([]Article, error) { + if hidden == nil { + hidden = []string{} + } + rows, err := d.pool.Query(ctx, qArticlesByTag, categorySlug, name, hidden) + if err != nil { + return nil, fmt.Errorf("query articles tagged %q: %w", name, err) + } + defer rows.Close() + + var out []Article + for rows.Next() { + var a Article + if err := rows.Scan(&a.ID, &a.Category, &a.Name, &a.Title, &a.ParentID, + &a.Locked, &a.CreatedAt, &a.UpdatedAt, &a.MediaName); err != nil { + return nil, fmt.Errorf("scan article tagged %q: %w", name, err) + } + out = append(out, a) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read articles tagged %q: %w", name, err) + } + return out, nil +} diff --git a/internal/db/options_test.go b/internal/db/options_test.go new file mode 100644 index 00000000..fe0eb229 --- /dev/null +++ b/internal/db/options_test.go @@ -0,0 +1,128 @@ +package db + +import ( + "context" + "errors" + "testing" +) + +func TestCommentInfoOfPageWithPosts(t *testing.T) { + d := newTestDB(t) + + got, err := d.CommentInfo(context.Background(), articleID(t, d, "probe:full")) + if err != nil { + t.Fatalf("CommentInfo() err = %v, want nil", err) + } + if got.ThreadID == 0 { + t.Errorf("CommentInfo(probe:full).ThreadID = 0, want a thread id") + } + if got.Count != 2 { + t.Errorf("CommentInfo(probe:full).Count = %d, want 2", got.Count) + } +} + +func TestCommentInfoOfPageWithoutThread(t *testing.T) { + d := newTestDB(t) + + got, err := d.CommentInfo(context.Background(), 0) + if err != nil { + t.Fatalf("CommentInfo() err = %v, want nil", err) + } + if got != (CommentInfo{}) { + t.Errorf("CommentInfo(0) = %+v, want the zero value", got) + } +} + +func TestCommentInfoOfPageWithoutPosts(t *testing.T) { + d := newTestDB(t) + + got, err := d.CommentInfo(context.Background(), articleID(t, d, "probe:bare")) + if err != nil { + t.Fatalf("CommentInfo() err = %v, want nil", err) + } + if got.Count != 0 { + t.Errorf("CommentInfo(probe:bare).Count = %d, want 0", got.Count) + } +} + +func TestSubscribedToArticle(t *testing.T) { + d := newTestDB(t) + author := userID(t, d, "probe-author") + + got, err := d.SubscribedToArticle(context.Background(), author, articleID(t, d, "probe:full")) + if err != nil { + t.Fatalf("SubscribedToArticle() err = %v, want nil", err) + } + if !got { + t.Errorf("SubscribedToArticle(probe-author, probe:full) = false, want true") + } +} + +func TestSubscribedToArticleOfAnotherPage(t *testing.T) { + d := newTestDB(t) + author := userID(t, d, "probe-author") + + got, err := d.SubscribedToArticle(context.Background(), author, articleID(t, d, "probe:bare")) + if err != nil { + t.Fatalf("SubscribedToArticle() err = %v, want nil", err) + } + if got { + t.Errorf("SubscribedToArticle(probe-author, probe:bare) = true, want false") + } +} + +func TestSubscribedToThread(t *testing.T) { + d := newTestDB(t) + author := userID(t, d, "probe-author") + + info, err := d.CommentInfo(context.Background(), articleID(t, d, "probe:full")) + if err != nil { + t.Fatalf("CommentInfo() err = %v, want nil", err) + } + got, err := d.SubscribedToThread(context.Background(), author, info.ThreadID) + if err != nil { + t.Fatalf("SubscribedToThread() err = %v, want nil", err) + } + if !got { + t.Errorf("SubscribedToThread(probe-author, %d) = false, want true", info.ThreadID) + } +} + +func TestUserPreferenceStoresPythonRepr(t *testing.T) { + d := newTestDB(t) + + got, err := d.UserPreference(context.Background(), userID(t, d, "probe-author"), + "qol", "advanced_source_editor_enabled") + if err != nil { + t.Fatalf("UserPreference() err = %v, want nil", err) + } + if got != "True" { + t.Errorf("UserPreference(probe-author) = %q, want %q", got, "True") + } +} + +func TestUserPreferenceUnset(t *testing.T) { + d := newTestDB(t) + + _, err := d.UserPreference(context.Background(), userID(t, d, "probevoter"), + "qol", "advanced_source_editor_enabled") + if !errors.Is(err, ErrNotFound) { + t.Errorf("UserPreference(probevoter) err = %v, want ErrNotFound", err) + } +} + +func TestSiteCanCreateTagsReadsTheSiteRowAlone(t *testing.T) { + d := newTestDB(t) + + site, err := d.SiteByHosts(context.Background(), []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts() err = %v, want nil", err) + } + got, err := d.SiteCanCreateTags(context.Background(), site.ID) + if err != nil { + t.Fatalf("SiteCanCreateTags() err = %v, want nil", err) + } + if got != CreateTagsDefault { + t.Errorf("SiteCanCreateTags() = %q, want %q", got, CreateTagsDefault) + } +} diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index e17193ae..6df935aa 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -17,11 +17,14 @@ from web.controllers import articles from web.models.articles import Article, Category, Tag, TagsCategory, Vote -from web.models.notifications import UserNotification, UserNotificationMapping +from web.models.forum import ForumPost, ForumThread +from web.models.notifications import UserNotification, UserNotificationMapping, UserNotificationSubscription from web.models.settings import Settings from web.models.site import Site from web.models.users import User +NL = chr(10) + CREATED_AT = datetime.datetime(2021, 3, 4, 5, 6, 7, tzinfo=datetime.timezone.utc) UPDATED_AT = datetime.datetime(2022, 7, 8, 9, 10, 11, tzinfo=datetime.timezone.utc) @@ -62,6 +65,21 @@ def notify(user, kind, viewed): ) +def comment_thread(article, user, posts): + thread, _ = ForumThread.objects.get_or_create(article=article, defaults=dict(name=article.title)) + for i in range(posts): + ForumPost.objects.get_or_create( + thread=thread, name='probe post %d' % i, defaults=dict(author=user), + ) + return thread + + +def subscribe(user, article=None, forum_thread=None): + UserNotificationSubscription.objects.get_or_create( + subscriber=user, article=article, forum_thread=forum_thread, + ) + + def vote(article, user, rate): Vote.objects.update_or_create( article=article, user=user, @@ -70,16 +88,19 @@ def vote(article, user, rate): author = make_user( - 'probeauthor', + 'probe-author', display_name='Probe Author', type=User.UserType.Normal, api_key='probe-key-author', ) +# An imported Wikidot account nobody has claimed yet. The uuid is fixed rather +# than generated so the golden stays put; the importer generates one per user. coauthor = make_user( - 'probewd', + '576c0df3-8a28-4468-9770-ede851d88c67', display_name='Probe WD', - wikidot_username='Probe WD Original', + wikidot_username='probe-wd-original', type=User.UserType.Wikidot, + is_active=False, api_key='probe-key-wd', ) voter = make_user('probevoter', type=User.UserType.Normal, api_key='probe-key-voter') @@ -97,6 +118,21 @@ def vote(article, user, rate): 'probe:included', 'Included Page', 'host=%%this|title%% full=%%this|fullname%% own=%%title%% miss=%%this|nosuchvar%%', None) host = make_article('probe:host', 'Probe Host', '[[include probe:included]]', None) +redirect = make_article('probe:redirect', 'Probe Redirect', + NL.join(['before', '[[module Redirect destination="/probe:full"]]', 'after']), None) +described = make_article('probe:described', 'Probe Described', + NL.join(['visible text', '[[module PageDescription]]custom description[[/module]]']), None) +imaged = make_article('probe:imaged', 'Probe Imaged', + '[[module PageImage src="probe:full/cover.png"]]body text', None) +tagged = make_article('probe:tagged', 'Probe Tagged', '[[module PagesByTag tag="lang:en"]]', None) +taggedplain = make_article('probe:taggedplain', 'Probe Tagged Plain', + '[[module PagesByTag tag="zeta"]]', None) +unknownmodule = make_article('probe:unknownmodule', 'Probe Unknown Module', + '[[module NoSuchModule]]', None) +# pwikit resolves a display name here and Django does not, so this page is the +# one the corpus carries the exemption for. +bydisplay = make_article('probe:bydisplay', 'Probe By Display Name', + '[[*user Probe WD]]', None) full.parent = parent full.save() @@ -106,6 +142,11 @@ def vote(article, user, rate): TagsCategory.objects.filter(slug='lang').update(priority=1) bare.tags.clear() +thread = comment_thread(full, author, 2) +subscribe(author, article=full) +subscribe(author, forum_thread=thread) +author.preferences['qol__advanced_source_editor_enabled'] = True + notify(author, UserNotification.NotificationType.Welcome, False) notify(author, UserNotification.NotificationType.DirectMessage, True) @@ -124,8 +165,11 @@ def vote(article, user, rate): ) site_settings, _ = Settings.objects.get_or_create(site=Site.objects.first()) -for article in (parent, full, bare, rated, half, included, host): +for article in (parent, full, bare, rated, half, included, host, redirect, described, + imaged, tagged, taggedplain, unknownmodule, bydisplay): freeze(article) print('site rating_mode =', site_settings.rating_mode) -print('seeded', ', '.join(a.full_name for a in (parent, full, bare, rated, half, included, host))) +print('seeded', ', '.join(a.full_name for a in (parent, full, bare, rated, half, included, host, + redirect, described, imaged, tagged, taggedplain, + unknownmodule, bydisplay))) From 528457e313561b1dfe48ed92f746389acd9db253 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:22 +0900 Subject: [PATCH 047/428] port options_config --- internal/pageconfig/options.go | 96 +++++++ internal/pageconfig/options_test.go | 260 ++++++++++++++++++ internal/pageconfig/testdata/options.golden | 54 ++++ .../pageconfig/testdata/oracle_options.py | 153 +++++++++++ 4 files changed, 563 insertions(+) create mode 100644 internal/pageconfig/options.go create mode 100644 internal/pageconfig/options_test.go create mode 100644 internal/pageconfig/testdata/options.golden create mode 100644 internal/pageconfig/testdata/oracle_options.py diff --git a/internal/pageconfig/options.go b/internal/pageconfig/options.go new file mode 100644 index 00000000..592a2f5b --- /dev/null +++ b/internal/pageconfig/options.go @@ -0,0 +1,96 @@ +package pageconfig + +import ( + "github.com/WikitTeam/ProjectWikit/internal/article" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" +) + +type Options struct { + PageID string + NormalizedName string + HasArticle bool + Anonymous bool + + Perms perms.Set + Rating page.Rating + + PathParams article.Params + CommentCount int + CanCreateTags bool + IsWatching bool + Preferences Preferences +} + +// Preferences is every preference the registry carries, which today is one. +// The frontend reads them under the section__name key Django writes. +type Preferences struct { + AdvancedSourceEditor bool +} + +const ( + PreferenceSection = "qol" + PreferenceAdvancedSourceEditor = "advanced_source_editor_enabled" + preferenceKey = PreferenceSection + "__" + PreferenceAdvancedSourceEditor +) + +// PreferenceEnabled reads the value Django stores, which is the Python repr of +// the boolean rather than a JSON one. +func PreferenceEnabled(raw string) bool { return raw == "True" } + +func (o Options) JSON() (string, error) { + return pyjson.Marshal(pyjson.Object{ + {Key: "optionsEnabled", Value: o.HasArticle}, + {Key: "editable", Value: o.Perms.Has(perms.EditArticles)}, + {Key: "lockable", Value: o.Perms.Has(perms.LockArticles)}, + {Key: "tagable", Value: o.Perms.Has(perms.TagArticles)}, + {Key: "pageId", Value: o.PageID}, + {Key: "rating", Value: o.Rating.Value}, + {Key: "ratingMode", Value: o.Rating.Mode}, + {Key: "ratingVotes", Value: o.Rating.Votes}, + {Key: "ratingPopularity", Value: o.Rating.Popularity}, + {Key: "pathParams", Value: pathParams(o.PathParams)}, + {Key: "canRate", Value: o.Perms.Has(perms.RateArticles)}, + {Key: "canComment", Value: o.HasArticle && o.Perms.Has(perms.CommentArticles)}, + {Key: "canViewComments", Value: o.HasArticle && o.Perms.Has(perms.ViewArticleComments)}, + {Key: "commentThread", Value: o.commentThread()}, + {Key: "commentCount", Value: o.CommentCount}, + {Key: "canDelete", Value: o.Perms.Has(perms.DeleteArticles)}, + {Key: "canCreateTags", Value: o.CanCreateTags}, + {Key: "canManageFiles", Value: o.Perms.Has(perms.ManageArticleFiles)}, + {Key: "canRename", Value: o.Perms.Has(perms.MoveArticles)}, + {Key: "canCreateHere", Value: o.Perms.Has(perms.CreateArticles)}, + {Key: "canManageAuthors", Value: o.Perms.Has(perms.ManageArticleAuthors)}, + {Key: "canResetVotes", Value: o.Perms.Has(perms.ResetArticleVotes)}, + {Key: "canWatch", Value: !o.Anonymous}, + {Key: "preferences", Value: o.preferences()}, + {Key: "isWatching", Value: o.IsWatching}, + }) +} + +func (o Options) commentThread() any { + if !o.HasArticle { + return nil + } + return "/" + o.NormalizedName + "/comments/show" +} + +func (o Options) preferences() pyjson.Object { + if o.Anonymous { + return pyjson.Object{} + } + return pyjson.Object{{Key: preferenceKey, Value: o.Preferences.AdvancedSourceEditor}} +} + +func pathParams(params article.Params) pyjson.Object { + out := make(pyjson.Object, 0, len(params)) + for _, param := range params { + var value any + if !param.Bare { + value = param.Value + } + out = append(out, pyjson.Field{Key: param.Key, Value: value}) + } + return out +} diff --git a/internal/pageconfig/options_test.go b/internal/pageconfig/options_test.go new file mode 100644 index 00000000..1561e2f0 --- /dev/null +++ b/internal/pageconfig/options_test.go @@ -0,0 +1,260 @@ +package pageconfig + +import ( + "encoding/json" + "fmt" + "os" + "path/filepath" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/article" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" +) + +const ( + optionsGoldenPath = "testdata/options.golden" + optionsCorpusPath = "testdata/options_corpus.json" +) + +type permRoleSpec struct { + Slug string `json:"slug"` + Permissions []string `json:"permissions"` + Restrictions []string `json:"restrictions"` +} + +type votesSpec struct { + Rates []int `json:"rates"` +} + +type optionsCase struct { + Name string `json:"name"` + PageID string `json:"page_id"` + HasArticle bool `json:"has_article"` + Anonymous bool `json:"anonymous"` + Superuser bool `json:"superuser"` + Inactive bool `json:"inactive"` + Roles []permRoleSpec `json:"roles"` + Locked bool `json:"locked"` + Author bool `json:"author"` + RatingMode string `json:"rating_mode"` + Votes votesSpec `json:"votes"` + Path string `json:"path"` + CommentCount int `json:"comment_count"` + CanCreateTags bool `json:"can_create_tags"` + IsWatching bool `json:"is_watching"` + SourceEditor bool `json:"advanced_source_editor"` +} + +func optionsCorpus() []optionsCase { + reader := permRoleSpec{Slug: "everyone", Permissions: []string{perms.ViewArticles, perms.ViewArticleComments}} + member := permRoleSpec{Slug: "registered", Permissions: []string{perms.CommentArticles, perms.RateArticles}} + editor := permRoleSpec{ + Slug: "editor", + Permissions: []string{ + perms.EditArticles, perms.TagArticles, perms.MoveArticles, perms.DeleteArticles, + perms.LockArticles, perms.ManageArticleFiles, perms.ManageArticleAuthors, + perms.ResetArticleVotes, perms.CreateArticles, + }, + } + + single := func(name string) optionsCase { + return optionsCase{ + Name: "only " + name, PageID: "main", HasArticle: true, + Roles: []permRoleSpec{{Slug: "everyone", Permissions: []string{name}}}, + RatingMode: page.RatingModeUpDown, + } + } + granted := []string{ + perms.ViewArticles, perms.RateArticles, perms.CreateArticles, perms.EditArticles, + perms.TagArticles, perms.MoveArticles, perms.LockArticles, perms.ManageArticleFiles, + perms.DeleteArticles, perms.ResetArticleVotes, perms.CommentArticles, + perms.ViewArticleComments, perms.ManageArticleAuthors, + } + + cases := []optionsCase{ + { + Name: "anonymous reader", PageID: "main", HasArticle: true, Anonymous: true, + Roles: []permRoleSpec{reader}, RatingMode: page.RatingModeUpDown, + Votes: votesSpec{Rates: []int{1, 1, -1}}, + }, + { + Name: "signed in member", PageID: "main", HasArticle: true, + Roles: []permRoleSpec{reader, member}, RatingMode: page.RatingModeUpDown, + Votes: votesSpec{Rates: []int{1, 1, -1}}, CommentCount: 4, + }, + { + Name: "editor", PageID: "scp-173", HasArticle: true, + Roles: []permRoleSpec{reader, member, editor}, RatingMode: page.RatingModeUpDown, + Votes: votesSpec{Rates: []int{1, 1, 1, -1}}, CommentCount: 1, CanCreateTags: true, + }, + { + Name: "superuser on a locked page", PageID: "main", HasArticle: true, Superuser: true, + Roles: []permRoleSpec{reader}, Locked: true, RatingMode: page.RatingModeUpDown, + }, + { + Name: "author of a page", PageID: "main", HasArticle: true, Author: true, + Roles: []permRoleSpec{reader, member}, RatingMode: page.RatingModeUpDown, + }, + { + Name: "inactive user", PageID: "main", HasArticle: true, Inactive: true, + Roles: []permRoleSpec{reader, member}, RatingMode: page.RatingModeUpDown, + }, + { + Name: "missing page", PageID: "no-such-page", Anonymous: true, + Roles: []permRoleSpec{reader}, RatingMode: page.RatingModeDisabled, + }, + { + Name: "stars", PageID: "probestars:rated", HasArticle: true, Anonymous: true, + Roles: []permRoleSpec{reader}, RatingMode: page.RatingModeStars, + Votes: votesSpec{Rates: []int{4, 5}}, + }, + { + Name: "stars without votes", PageID: "probestars:rated", HasArticle: true, Anonymous: true, + Roles: []permRoleSpec{reader}, RatingMode: page.RatingModeStars, + }, + { + Name: "stars rounding to a whole number", PageID: "probestars:rated", HasArticle: true, Anonymous: true, + Roles: []permRoleSpec{reader}, RatingMode: page.RatingModeStars, + Votes: votesSpec{Rates: []int{4, 4}}, + }, + { + Name: "rating disabled", PageID: "main", HasArticle: true, Anonymous: true, + Roles: []permRoleSpec{reader}, RatingMode: page.RatingModeDisabled, + Votes: votesSpec{Rates: []int{1, 1}}, + }, + { + Name: "path params", PageID: "main", HasArticle: true, Anonymous: true, + Roles: []permRoleSpec{reader}, RatingMode: page.RatingModeUpDown, + Path: "main/offset/20/tag/中文/bare", + }, + { + Name: "watching", PageID: "main", HasArticle: true, + Roles: []permRoleSpec{reader, member}, RatingMode: page.RatingModeUpDown, + IsWatching: true, + }, + { + Name: "advanced source editor", PageID: "main", HasArticle: true, + Roles: []permRoleSpec{reader, member}, RatingMode: page.RatingModeUpDown, + SourceEditor: true, + }, + } + for _, name := range granted { + cases = append(cases, single(name)) + } + return cases +} + +func toSubject(c optionsCase) perms.Subject { + subject := perms.Subject{ + Anonymous: c.Anonymous, + Active: !c.Inactive, + Superuser: c.Superuser, + } + for i, spec := range c.Roles { + subject.Roles = append(subject.Roles, perms.Role{ + ID: int64(i + 1), + Permissions: spec.Permissions, + Restrictions: spec.Restrictions, + }) + } + return subject +} + +func toStats(spec votesSpec) db.VoteStats { + stats := db.VoteStats{Count: len(spec.Rates)} + for _, rate := range spec.Rates { + stats.Sum += float64(rate) + if rate == 1 { + stats.GoodUpDown++ + } + if rate >= 3 { + stats.GoodStars++ + } + } + if stats.Count > 0 { + stats.Average = stats.Sum / float64(stats.Count) + } + return stats +} + +func toOptions(c optionsCase) Options { + var object *perms.Object + if c.HasArticle { + object = &perms.Object{Locked: c.Locked, Author: c.Author} + } + _, params := article.ParsePath(c.Path, "main") + if c.Path == "" { + params = nil + } + rating := page.DisabledRating() + if c.HasArticle { + rating = page.RatingOf(c.RatingMode, toStats(c.Votes)) + } + return Options{ + PageID: c.PageID, + NormalizedName: c.PageID, + HasArticle: c.HasArticle, + Anonymous: c.Anonymous, + Perms: perms.Resolve(toSubject(c), object), + Rating: rating, + PathParams: params, + CommentCount: c.CommentCount, + CanCreateTags: c.CanCreateTags, + IsWatching: c.IsWatching, + Preferences: Preferences{AdvancedSourceEditor: c.SourceEditor}, + } +} + +func TestOptionsMatchesGolden(t *testing.T) { + cases := optionsCorpus() + + var b strings.Builder + for _, c := range cases { + got, err := toOptions(c).JSON() + if err != nil { + t.Fatalf("Options(%s).JSON() err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\n%s\n", c.Name, got) + } + got := b.String() + + if *update { + writeOptionsCorpus(t, cases) + if err := os.WriteFile(filepath.FromSlash(optionsGoldenPath), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", optionsGoldenPath, err) + } + return + } + + want, err := os.ReadFile(filepath.FromSlash(optionsGoldenPath)) + if err != nil { + t.Fatalf("ReadFile(%s) err = %v, want nil", optionsGoldenPath, err) + } + if got != string(want) { + t.Errorf("Options(corpus) = %q, want %q", got, string(want)) + } +} + +func writeOptionsCorpus(t *testing.T, cases []optionsCase) { + t.Helper() + data, err := json.MarshalIndent(cases, "", " ") + if err != nil { + t.Fatalf("Marshal(corpus) err = %v, want nil", err) + } + if err := os.WriteFile(filepath.FromSlash(optionsCorpusPath), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", optionsCorpusPath, err) + } +} + +func TestOptionsOfMissingPageHasNoCommentThread(t *testing.T) { + got, err := Options{PageID: "gone", NormalizedName: "gone"}.JSON() + if err != nil { + t.Fatalf("JSON() err = %v, want nil", err) + } + if !strings.Contains(got, `"commentThread": null`) { + t.Errorf("Options(missing page) = %q, want it to carry \"commentThread\": null", got) + } +} diff --git a/internal/pageconfig/testdata/options.golden b/internal/pageconfig/testdata/options.golden new file mode 100644 index 00000000..416a47dd --- /dev/null +++ b/internal/pageconfig/testdata/options.golden @@ -0,0 +1,54 @@ +=== anonymous reader +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 1, "ratingMode": "updown", "ratingVotes": 3, "ratingPopularity": 67, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": false, "preferences": {}, "isWatching": false} +=== signed in member +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 1, "ratingMode": "updown", "ratingVotes": 3, "ratingPopularity": 67, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 4, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== editor +{"optionsEnabled": true, "editable": true, "lockable": true, "tagable": true, "pageId": "scp-173", "rating": 2, "ratingMode": "updown", "ratingVotes": 4, "ratingPopularity": 75, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/scp-173/comments/show", "commentCount": 1, "canDelete": true, "canCreateTags": true, "canManageFiles": true, "canRename": true, "canCreateHere": true, "canManageAuthors": true, "canResetVotes": true, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== superuser on a locked page +{"optionsEnabled": true, "editable": true, "lockable": true, "tagable": true, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": true, "canCreateTags": false, "canManageFiles": true, "canRename": true, "canCreateHere": true, "canManageAuthors": true, "canResetVotes": true, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== author of a page +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": true, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== inactive user +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== missing page +{"optionsEnabled": false, "editable": false, "lockable": false, "tagable": false, "pageId": "no-such-page", "rating": 0, "ratingMode": "disabled", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": null, "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": false, "preferences": {}, "isWatching": false} +=== stars +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "probestars:rated", "rating": 4.5, "ratingMode": "stars", "ratingVotes": 2, "ratingPopularity": 100, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": true, "commentThread": "/probestars:rated/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": false, "preferences": {}, "isWatching": false} +=== stars without votes +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "probestars:rated", "rating": 0.0, "ratingMode": "stars", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": true, "commentThread": "/probestars:rated/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": false, "preferences": {}, "isWatching": false} +=== stars rounding to a whole number +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "probestars:rated", "rating": 4.0, "ratingMode": "stars", "ratingVotes": 2, "ratingPopularity": 100, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": true, "commentThread": "/probestars:rated/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": false, "preferences": {}, "isWatching": false} +=== rating disabled +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "disabled", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": false, "preferences": {}, "isWatching": false} +=== path params +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {"offset": "20", "tag": "\u4e2d\u6587", "bare": null}, "canRate": false, "canComment": false, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": false, "preferences": {}, "isWatching": false} +=== watching +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": true} +=== advanced source editor +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": true}, "isWatching": false} +=== only view_articles +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only rate_articles +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": true, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only create_articles +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": true, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only edit_articles +{"optionsEnabled": true, "editable": true, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only tag_articles +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": true, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only move_articles +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": true, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only lock_articles +{"optionsEnabled": true, "editable": false, "lockable": true, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only manage_article_files +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": true, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only delete_articles +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": true, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only reset_article_votes +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": true, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only comment_articles +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": true, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only view_article_comments +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +=== only manage_article_authors +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": false, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": true, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} diff --git a/internal/pageconfig/testdata/oracle_options.py b/internal/pageconfig/testdata/oracle_options.py new file mode 100644 index 00000000..2e26cdb6 --- /dev/null +++ b/internal/pageconfig/testdata/oracle_options.py @@ -0,0 +1,153 @@ +"""Record what Django puts in options_config, one case at a time. + + OPTIONS_CORPUS="$(cat internal/pageconfig/testdata/options_corpus.json)" \ + docker compose exec -T -e OPTIONS_CORPUS \ + web python manage.py shell < internal/pageconfig/testdata/oracle_options.py \ + > options.django.golden + +Then compare it with internal/pageconfig/testdata/options.golden. + +The dict below is copied from ArticleView.get_context_data, since the view +builds it inline and there is no function to call. Everything it reads is real: +the roles, the article, the votes and the settings are created in a transaction +that is rolled back afterwards. Every case gets its own pk because the +preferences manager caches by pk and the cache outlives the rollback. +Only commentCount, canCreateTags and isWatching +come from the corpus, because each of those has its own check in +internal/db/chrome_test.go. +""" + +import io +import json +import os +import sys + +from django.contrib.auth.models import Permission +from django.db import transaction + +from web import threadvars +from web.controllers import articles +from web.models.articles import Article, Category, Vote +from web.models.roles import Role +from web.models.settings import Settings +from web.models.site import Site +from web.models.users import ExtendedAnonymousUser, User +from web.permissions import get_role_permissions_content_type +from web.util.json import replace_json_dumps_default + +replace_json_dumps_default() + +CORPUS = json.loads(os.environ['OPTIONS_CORPUS']) +CONTENT_TYPE = get_role_permissions_content_type() + +sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8', newline='\n') + + +class Rollback(Exception): + pass + + +def permissions(codenames): + return [Permission.objects.get(codename=code, content_type=CONTENT_TYPE) for code in codenames or []] + + +def build_roles(specs): + built = [] + for spec in specs or []: + role, _ = Role.objects.get_or_create(slug=spec['slug']) + role.permissions.set(permissions(spec.get('permissions'))) + role.restrictions.set(permissions(spec.get('restrictions'))) + built.append(role) + return built + + +def build_user(case, roles, index): + if case['anonymous']: + return ExtendedAnonymousUser() + user = User.objects.create( + id=424242 + index * 100, + username='optionsprobe%d' % index, + type='normal', + is_active=not case['inactive'], + is_superuser=case['superuser'], + api_key='options-probe-key-%d' % index, + ) + user.roles.set(roles) + if case['advanced_source_editor']: + user.preferences['qol__advanced_source_editor_enabled'] = True + return User.objects.get(pk=user.pk) + + +def build_article(case, user, index): + if not case['has_article']: + return None + category = Category.objects.create(name='optionsprobe%d' % index) + Settings.objects.create(category=category, rating_mode=case['rating_mode']) + article = Article.objects.create( + category=category.name, + name='probe', + title='probe', + locked=case['locked'], + ) + if case['author'] and not user.is_anonymous: + article.authors.add(user) + for i, rate in enumerate(case['votes'].get('rates') or []): + voter = User.objects.create( + id=424243 + index * 100 + i, username='optionsvoter%d-%d' % (index, i), type='normal', + api_key='options-voter-key-%d-%d' % (index, i), + ) + Vote.objects.create(article=article, user=voter, rate=rate) + return Article.objects.get(pk=article.pk) + + +def path_params(path): + from web.views.article import ArticleView + return ArticleView.get_path_params(path)[1] if path else {} + + +def config(case, index): + out = None + try: + with transaction.atomic(): + roles = build_roles(case['roles']) + user = build_user(case, roles, index) + article = build_article(case, user, index) + rating, votes, popularity, mode = articles.get_rating(article) + params = path_params(case['path']) + out = json.dumps({ + 'optionsEnabled': article is not None, + 'editable': user.has_perm('roles.edit_articles', article), + 'lockable': user.has_perm('roles.lock_articles', article), + 'tagable': user.has_perm('roles.tag_articles', article), + 'pageId': case['page_id'], + 'rating': rating, + 'ratingMode': mode, + 'ratingVotes': votes, + 'ratingPopularity': popularity, + 'pathParams': params, + 'canRate': user.has_perm('roles.rate_articles', article), + 'canComment': user.has_perm('roles.comment_articles', article) if article else False, + 'canViewComments': user.has_perm('roles.view_article_comments', article) if article else False, + 'commentThread': ('/%s/comments/show' % case['page_id']) if article else None, + 'commentCount': case['comment_count'], + 'canDelete': user.has_perm('roles.delete_articles', article), + 'canCreateTags': case['can_create_tags'], + 'canManageFiles': user.has_perm('roles.manage_article_files', article), + 'canRename': user.has_perm('roles.move_articles', article), + 'canCreateHere': user.has_perm('roles.create_articles', article), + 'canManageAuthors': user.has_perm('roles.manage_article_authors', article), + 'canResetVotes': user.has_perm('roles.reset_article_votes', article), + 'canWatch': not user.is_anonymous, + 'preferences': {} if user.is_anonymous else user.preferences.all(), + 'isWatching': case['is_watching'], + }) + raise Rollback + except Rollback: + pass + return out + + +with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + for index, case in enumerate(CORPUS): + sys.stdout.write('=== %s\n%s\n' % (case['name'], config(case, index))) From 254feb6a44991652b11ef8dc5e77666a2507149e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:22 +0900 Subject: [PATCH 048/428] record the options corpus --- .../pageconfig/testdata/options_corpus.json | 857 ++++++++++++++++++ 1 file changed, 857 insertions(+) create mode 100644 internal/pageconfig/testdata/options_corpus.json diff --git a/internal/pageconfig/testdata/options_corpus.json b/internal/pageconfig/testdata/options_corpus.json new file mode 100644 index 00000000..2c92b387 --- /dev/null +++ b/internal/pageconfig/testdata/options_corpus.json @@ -0,0 +1,857 @@ +[ + { + "name": "anonymous reader", + "page_id": "main", + "has_article": true, + "anonymous": true, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": [ + 1, + 1, + -1 + ] + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "signed in member", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": [ + 1, + 1, + -1 + ] + }, + "path": "", + "comment_count": 4, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "editor", + "page_id": "scp-173", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles", + "delete_articles", + "lock_articles", + "manage_article_files", + "manage_article_authors", + "reset_article_votes", + "create_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": [ + 1, + 1, + 1, + -1 + ] + }, + "path": "", + "comment_count": 1, + "can_create_tags": true, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "superuser on a locked page", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": true, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": true, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "author of a page", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": true, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "inactive user", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": true, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "missing page", + "page_id": "no-such-page", + "has_article": false, + "anonymous": true, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "disabled", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "stars", + "page_id": "probestars:rated", + "has_article": true, + "anonymous": true, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "stars", + "votes": { + "rates": [ + 4, + 5 + ] + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "stars without votes", + "page_id": "probestars:rated", + "has_article": true, + "anonymous": true, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "stars", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "stars rounding to a whole number", + "page_id": "probestars:rated", + "has_article": true, + "anonymous": true, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "stars", + "votes": { + "rates": [ + 4, + 4 + ] + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "rating disabled", + "page_id": "main", + "has_article": true, + "anonymous": true, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "disabled", + "votes": { + "rates": [ + 1, + 1 + ] + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "path params", + "page_id": "main", + "has_article": true, + "anonymous": true, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "main/offset/20/tag/中文/bare", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "watching", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": true, + "advanced_source_editor": false + }, + { + "name": "advanced source editor", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": true + }, + { + "name": "only view_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only rate_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "rate_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only create_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "create_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only edit_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "edit_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only tag_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "tag_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only move_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "move_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only lock_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "lock_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only manage_article_files", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "manage_article_files" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only delete_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "delete_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only reset_article_votes", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "reset_article_votes" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only comment_articles", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "comment_articles" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only view_article_comments", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_article_comments" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + }, + { + "name": "only manage_article_authors", + "page_id": "main", + "has_article": true, + "anonymous": false, + "superuser": false, + "inactive": false, + "roles": [ + { + "slug": "everyone", + "permissions": [ + "manage_article_authors" + ], + "restrictions": null + } + ], + "locked": false, + "author": false, + "rating_mode": "updown", + "votes": { + "rates": null + }, + "path": "", + "comment_count": 0, + "can_create_tags": false, + "is_watching": false, + "advanced_source_editor": false + } +] From 1573aa5ed0ec3e7c284b23ad4fca4df86e861420 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:22 +0900 Subject: [PATCH 049/428] add the queries the page shell still needed --- internal/db/chrome.go | 50 +++++++++++++++++++++++++-- internal/db/chrome_test.go | 71 ++++++++++++++++++++++++++++++++++---- 2 files changed, 113 insertions(+), 8 deletions(-) diff --git a/internal/db/chrome.go b/internal/db/chrome.go index afa1a17a..ebff64f6 100644 --- a/internal/db/chrome.go +++ b/internal/db/chrome.go @@ -127,13 +127,24 @@ func (d *DB) LatestRevNumber(ctx context.Context, articleID int64) (int, error) return n, nil } +var qCategoryExists = register("CategoryExists", ` +SELECT EXISTS(SELECT 1 FROM web_category WHERE name = $1)`) + +// The page skips the permission check entirely when neither it nor its category +// has a row, which is how a 404 wins over a 403 there. +func (d *DB) CategoryExists(ctx context.Context, name string) (bool, error) { + var exists bool + if err := d.pool.QueryRow(ctx, qCategoryExists, name).Scan(&exists); err != nil { + return false, fmt.Errorf("check category %q: %w", name, err) + } + return exists, nil +} + var qCategoryIndexed = register("CategoryIndexed", ` SELECT is_indexed FROM web_category WHERE name = $1`) -// CategoryIndexed answers for categories with no row of their own too, where the -// model default decides. func (d *DB) CategoryIndexed(ctx context.Context, name string) (bool, error) { var indexed bool err := d.pool.QueryRow(ctx, qCategoryIndexed, name).Scan(&indexed) @@ -174,3 +185,38 @@ func (d *DB) ThemeByID(ctx context.Context, id int64) (*Theme, error) { } return &t, nil } + +var qArticleTagNames = register("ArticleTagNames", ` +SELECT CASE WHEN c.slug = '_default' THEN t.name ELSE c.slug || ':' || t.name END, + CASE WHEN c.slug = '_default' THEN '' ELSE t.name END +FROM web_article_tags link +JOIN web_tag t ON t.id = link.tag_id +JOIN web_tagscategory c ON c.id = t.category_id +WHERE link.article_id = $1 +ORDER BY link.id`) + +// ArticleTagNames is the list ftml is told about, where a tag outside the +// default category appears twice, prefixed and bare. Hidden tags stay in. +func (d *DB) ArticleTagNames(ctx context.Context, articleID int64) ([]string, error) { + rows, err := d.pool.Query(ctx, qArticleTagNames, articleID) + if err != nil { + return nil, fmt.Errorf("query tag names of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []string + for rows.Next() { + var full, bare string + if err := rows.Scan(&full, &bare); err != nil { + return nil, fmt.Errorf("scan tag name of article %d: %w", articleID, err) + } + out = append(out, full) + if bare != "" { + out = append(out, bare) + } + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read tag names of article %d: %w", articleID, err) + } + return out, nil +} diff --git a/internal/db/chrome_test.go b/internal/db/chrome_test.go index 39712151..06c81090 100644 --- a/internal/db/chrome_test.go +++ b/internal/db/chrome_test.go @@ -134,15 +134,74 @@ func TestCategoryIndexedOfUnknownCategory(t *testing.T) { func TestUnreadNotificationsCountsOnlyUnviewed(t *testing.T) { d := newTestDB(t) - u, err := d.UserByName(context.Background(), "probeauthor") - if err != nil { - t.Fatalf("UserByName() err = %v, want nil", err) - } - got, err := d.UnreadNotifications(context.Background(), u.ID) + got, err := d.UnreadNotifications(context.Background(), userID(t, d, "probe-author")) if err != nil { t.Fatalf("UnreadNotifications() err = %v, want nil", err) } if got != 1 { - t.Errorf("UnreadNotifications(probeauthor) = %d, want 1", got) + t.Errorf("UnreadNotifications(probe-author) = %d, want 1", got) + } +} + +func userID(t *testing.T, d *DB, name string) int64 { + t.Helper() + u, err := d.UserByName(context.Background(), name) + if err != nil { + t.Fatalf("UserByName(%q) err = %v, want nil", name, err) + } + return u.ID +} + +func TestArticleTagNamesRepeatsPrefixedTags(t *testing.T) { + d := newTestDB(t) + + got, err := d.ArticleTagNames(context.Background(), articleID(t, d, "probe:full")) + if err != nil { + t.Fatalf("ArticleTagNames() err = %v, want nil", err) + } + want := []string{"zeta", "alpha", "lang:en", "en"} + if len(got) != len(want) { + t.Fatalf("len(ArticleTagNames(probe:full)) = %d, want %d", len(got), len(want)) + } + for i := range want { + if got[i] != want[i] { + t.Errorf("ArticleTagNames(probe:full)[%d] = %q, want %q", i, got[i], want[i]) + } + } +} + +func TestArticleTagNamesOfUntaggedPage(t *testing.T) { + d := newTestDB(t) + + got, err := d.ArticleTagNames(context.Background(), articleID(t, d, "probe:bare")) + if err != nil { + t.Fatalf("ArticleTagNames() err = %v, want nil", err) + } + if len(got) != 0 { + t.Errorf("len(ArticleTagNames(probe:bare)) = %d, want 0", len(got)) + } +} + +func TestCategoryExists(t *testing.T) { + d := newTestDB(t) + + got, err := d.CategoryExists(context.Background(), "probestars") + if err != nil { + t.Fatalf("CategoryExists() err = %v, want nil", err) + } + if !got { + t.Errorf("CategoryExists(probestars) = false, want true") + } +} + +func TestCategoryExistsOfUnknownCategory(t *testing.T) { + d := newTestDB(t) + + got, err := d.CategoryExists(context.Background(), "no-such-category") + if err != nil { + t.Fatalf("CategoryExists() err = %v, want nil", err) + } + if got { + t.Errorf("CategoryExists(no-such-category) = true, want false") } } From 932a20d9bab3e0cf585d89037b3ce2e0b22ed45d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:22 +0900 Subject: [PATCH 050/428] resolve the rating mode outside the page variables --- internal/page/vars.go | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/internal/page/vars.go b/internal/page/vars.go index 8b3e6e56..4727fa0c 100644 --- a/internal/page/vars.go +++ b/internal/page/vars.go @@ -323,22 +323,28 @@ func (v *Vars) voteStats() (db.VoteStats, bool) { } func (v *Vars) ratingMode() (string, bool) { - mode := RatingModeUpDown site, err := v.src.SiteRatingMode() if err != nil && !errors.Is(err, db.ErrNotFound) { return "", v.fail(err) } - if site != "" && site != RatingModeDefault { - mode = site - } category, err := v.src.CategoryRatingMode(v.article.Category) if err != nil && !errors.Is(err, db.ErrNotFound) { return "", v.fail(err) } - if category != "" && category != RatingModeDefault { - mode = category + return RatingMode(site, category), true +} + +// RatingMode walks the settings chain, where the built-in default is updown and +// a level that says default hands the question to the level above it. +func RatingMode(siteMode, categoryMode string) string { + mode := RatingModeUpDown + if siteMode != "" && siteMode != RatingModeDefault { + mode = siteMode + } + if categoryMode != "" && categoryMode != RatingModeDefault { + mode = categoryMode } - return mode, true + return mode } func (v *Vars) formattedRating() (string, bool) { From f0afa30ea5b23d5c0ecc8793292472d1b99d75ff Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:23 +0900 Subject: [PATCH 051/428] put the resolved site on the request context --- internal/site/context.go | 20 ++++++++++++++++++++ internal/site/host.go | 2 +- 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 internal/site/context.go diff --git a/internal/site/context.go b/internal/site/context.go new file mode 100644 index 00000000..f5b279c9 --- /dev/null +++ b/internal/site/context.go @@ -0,0 +1,20 @@ +package site + +import ( + "context" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +type contextKey struct{} + +func WithSite(ctx context.Context, s *db.Site) context.Context { + return context.WithValue(ctx, contextKey{}, s) +} + +// FromContext returns nil when the request never passed through HostRules, +// which is every request in a test that builds its own. +func FromContext(ctx context.Context) *db.Site { + s, _ := ctx.Value(contextKey{}).(*db.Site) + return s +} diff --git a/internal/site/host.go b/internal/site/host.go index 43d78911..52c82b11 100644 --- a/internal/site/host.go +++ b/internal/site/host.go @@ -62,5 +62,5 @@ func (h *HostRules) ServeHTTP(w http.ResponseWriter, r *http.Request) { for name, value := range decision.Headers { w.Header().Set(name, value) } - h.next.ServeHTTP(w, r) + h.next.ServeHTTP(w, r.WithContext(WithSite(r.Context(), found))) } From 3b9864cfc44c49588f225faa0e1442a9039564ec Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:23 +0900 Subject: [PATCH 052/428] let one route change hands at startup --- internal/routing/routing.go | 12 ++++++++++++ internal/routing/routing_test.go | 17 +++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/internal/routing/routing.go b/internal/routing/routing.go index fb5fc8ab..64a01824 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -33,6 +33,18 @@ var Table = []Route{ {Prefix: "/local--theme/", Owner: OwnerDjango, Label: "page theme"}, } +// WithOwner copies the table with one prefix handed to someone else, which is +// how a route moves while the code answering it is still being written. +func WithOwner(table []Route, prefix string, owner Owner) []Route { + out := slices.Clone(table) + for i := range out { + if out[i].Prefix == prefix { + out[i].Owner = owner + } + } + return out +} + func Validate(table []Route) error { seen := make(map[string]bool, len(table)) hasRoot := false diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go index 63da597f..819aef9e 100644 --- a/internal/routing/routing_test.go +++ b/internal/routing/routing_test.go @@ -136,3 +136,20 @@ func TestMuxServeHTTPDispatches(t *testing.T) { }) } } + +func TestWithOwnerLeavesTheOriginalAlone(t *testing.T) { + got := WithOwner(Table, "/", OwnerGo) + if got[0].Owner != OwnerGo { + t.Errorf("WithOwner(Table, %q, go)[0].Owner = %q, want %q", "/", got[0].Owner, OwnerGo) + } + if Table[0].Owner != OwnerDjango { + t.Errorf("Table[0].Owner = %q, want %q", Table[0].Owner, OwnerDjango) + } +} + +func TestWithOwnerOfUnknownPrefix(t *testing.T) { + got := WithOwner(Table, "/no-such-prefix/", OwnerGo) + if len(got) != len(Table) { + t.Errorf("len(WithOwner(Table, unknown, go)) = %d, want %d", len(got), len(Table)) + } +} From bc60d2c3ffb09f3390de6d75d62b8b1b20dafa6b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:23 +0900 Subject: [PATCH 053/428] port django's gzip middleware --- internal/compress/compress.go | 137 +++++++++++++++++++++++ internal/compress/compress_test.go | 169 +++++++++++++++++++++++++++++ 2 files changed, 306 insertions(+) create mode 100644 internal/compress/compress.go create mode 100644 internal/compress/compress_test.go diff --git a/internal/compress/compress.go b/internal/compress/compress.go new file mode 100644 index 00000000..38f4d4c2 --- /dev/null +++ b/internal/compress/compress.go @@ -0,0 +1,137 @@ +// Package compress gzips a response the way Django's GZipMiddleware does. +package compress + +import ( + "bytes" + "compress/gzip" + "crypto/rand" + "math/big" + "net/http" + "regexp" + "strconv" + "strings" +) + +// Below this size Django returns the response untouched, Vary included, so the +// header is not a reliable sign that compression was considered. +const minSize = 200 + +const ( + maxPadding = 100 + headerSize = 10 + flagName = 0b00001000 + level = 6 +) + +var acceptsGzip = regexp.MustCompile(`\bgzip\b`) + +func New(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + buf := &buffer{header: make(http.Header), status: http.StatusOK} + next.ServeHTTP(buf, r) + + body := buf.body.Bytes() + for name, values := range buf.header { + w.Header()[name] = values + } + + if len(body) < minSize || buf.header.Get("Content-Encoding") != "" { + write(w, buf.status, body) + return + } + patchVary(w.Header()) + if !acceptsGzip.MatchString(r.Header.Get("Accept-Encoding")) { + write(w, buf.status, body) + return + } + packed, err := pack(body) + if err != nil || len(packed) >= len(body) { + write(w, buf.status, body) + return + } + if tag := w.Header().Get("ETag"); strings.HasPrefix(tag, `"`) { + w.Header().Set("ETag", "W/"+tag) + } + w.Header().Set("Content-Encoding", "gzip") + write(w, buf.status, packed) + }) +} + +func write(w http.ResponseWriter, status int, body []byte) { + w.Header().Set("Content-Length", strconv.Itoa(len(body))) + w.WriteHeader(status) + w.Write(body) +} + +func patchVary(h http.Header) { + const name = "Accept-Encoding" + current := h.Get("Vary") + for _, part := range strings.Split(current, ",") { + if strings.EqualFold(strings.TrimSpace(part), name) { + return + } + } + if strings.TrimSpace(current) == "" { + h.Set("Vary", name) + return + } + h.Set("Vary", current+", "+name) +} + +// pack writes the gzip stream Django writes, down to the zero timestamp and +// the padding it hides in the filename field. +func pack(body []byte) ([]byte, error) { + var out bytes.Buffer + zw, err := gzip.NewWriterLevel(&out, level) + if err != nil { + return nil, err + } + if _, err := zw.Write(body); err != nil { + return nil, err + } + if err := zw.Close(); err != nil { + return nil, err + } + return withPadding(out.Bytes()) +} + +// withPadding hides a run of filler in the header. Only its length is random, +// which is all it takes to stop a compressed length from measuring the page. +func withPadding(packed []byte) ([]byte, error) { + if len(packed) < headerSize { + return packed, nil + } + size, err := rand.Int(rand.Reader, big.NewInt(maxPadding)) + if err != nil { + return nil, err + } + + out := make([]byte, 0, len(packed)+int(size.Int64())+1) + out = append(out, packed[:3]...) + out = append(out, flagName) + out = append(out, packed[4:headerSize]...) + out = append(out, bytes.Repeat([]byte("a"), int(size.Int64()))...) + out = append(out, 0) + return append(out, packed[headerSize:]...), nil +} + +type buffer struct { + header http.Header + status int + body bytes.Buffer + wrote bool +} + +func (b *buffer) Header() http.Header { return b.header } + +func (b *buffer) WriteHeader(status int) { + if !b.wrote { + b.status = status + b.wrote = true + } +} + +func (b *buffer) Write(p []byte) (int, error) { + b.wrote = true + return b.body.Write(p) +} diff --git a/internal/compress/compress_test.go b/internal/compress/compress_test.go new file mode 100644 index 00000000..51e7c5a6 --- /dev/null +++ b/internal/compress/compress_test.go @@ -0,0 +1,169 @@ +package compress + +import ( + "compress/gzip" + "crypto/rand" + "io" + "net/http" + "net/http/httptest" + "strconv" + "strings" + "testing" +) + +func handlerOf(body string, headers map[string]string, status int) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + for name, value := range headers { + w.Header().Set(name, value) + } + w.WriteHeader(status) + w.Write([]byte(body)) + }) +} + +func serve(t *testing.T, next http.Handler, accept string) *http.Response { + t.Helper() + req := httptest.NewRequest(http.MethodGet, "/main", nil) + if accept != "" { + req.Header.Set("Accept-Encoding", accept) + } + rec := httptest.NewRecorder() + New(next).ServeHTTP(rec, req) + return rec.Result() +} + +func unpack(t *testing.T, res *http.Response) string { + t.Helper() + zr, err := gzip.NewReader(res.Body) + if err != nil { + t.Fatalf("gzip.NewReader() err = %v, want nil", err) + } + out, err := io.ReadAll(zr) + if err != nil { + t.Fatalf("ReadAll() err = %v, want nil", err) + } + return string(out) +} + +func TestCompressesALongBody(t *testing.T) { + body := strings.Repeat("hello wiki ", 100) + res := serve(t, handlerOf(body, nil, http.StatusOK), "gzip, deflate") + + if got := res.Header.Get("Content-Encoding"); got != "gzip" { + t.Errorf("Content-Encoding = %q, want %q", got, "gzip") + } + if got := unpack(t, res); got != body { + t.Errorf("body = %q, want %q", got, body) + } +} + +func TestContentLengthCountsTheCompressedBody(t *testing.T) { + body := strings.Repeat("hello wiki ", 100) + res := serve(t, handlerOf(body, nil, http.StatusOK), "gzip") + + length, err := strconv.Atoi(res.Header.Get("Content-Length")) + if err != nil { + t.Fatalf("Atoi(Content-Length) err = %v, want nil", err) + } + if length >= len(body) { + t.Errorf("Content-Length = %d, want less than %d", length, len(body)) + } +} + +func TestShortBodyIsLeftAlone(t *testing.T) { + res := serve(t, handlerOf("short", nil, http.StatusOK), "gzip") + + if got := res.Header.Get("Content-Encoding"); got != "" { + t.Errorf("Content-Encoding = %q, want %q", got, "") + } + if got := res.Header.Get("Vary"); got != "" { + t.Errorf("Vary = %q, want %q", got, "") + } +} + +func TestVaryIsSetWithoutCompressing(t *testing.T) { + body := strings.Repeat("hello wiki ", 100) + res := serve(t, handlerOf(body, nil, http.StatusOK), "deflate") + + if got := res.Header.Get("Vary"); got != "Accept-Encoding" { + t.Errorf("Vary = %q, want %q", got, "Accept-Encoding") + } + if got := res.Header.Get("Content-Encoding"); got != "" { + t.Errorf("Content-Encoding = %q, want %q", got, "") + } +} + +func TestVaryKeepsWhatTheHandlerSet(t *testing.T) { + body := strings.Repeat("hello wiki ", 100) + res := serve(t, handlerOf(body, map[string]string{"Vary": "Cookie"}, http.StatusOK), "gzip") + + if got := res.Header.Get("Vary"); got != "Cookie, Accept-Encoding" { + t.Errorf("Vary = %q, want %q", got, "Cookie, Accept-Encoding") + } +} + +func TestVaryIsNotRepeated(t *testing.T) { + body := strings.Repeat("hello wiki ", 100) + res := serve(t, handlerOf(body, map[string]string{"Vary": "Cookie, accept-encoding"}, http.StatusOK), "gzip") + + if got := res.Header.Get("Vary"); got != "Cookie, accept-encoding" { + t.Errorf("Vary = %q, want %q", got, "Cookie, accept-encoding") + } +} + +func TestAlreadyEncodedBodyIsLeftAlone(t *testing.T) { + body := strings.Repeat("hello wiki ", 100) + res := serve(t, handlerOf(body, map[string]string{"Content-Encoding": "br"}, http.StatusOK), "gzip") + + if got := res.Header.Get("Content-Encoding"); got != "br" { + t.Errorf("Content-Encoding = %q, want %q", got, "br") + } + if got := res.Header.Get("Vary"); got != "" { + t.Errorf("Vary = %q, want %q", got, "") + } +} + +func TestIncompressibleBodyIsLeftAlone(t *testing.T) { + raw := make([]byte, 512) + if _, err := rand.Read(raw); err != nil { + t.Fatalf("rand.Read() err = %v, want nil", err) + } + res := serve(t, handlerOf(string(raw), nil, http.StatusOK), "gzip") + + if got := res.Header.Get("Content-Encoding"); got != "" { + t.Errorf("Content-Encoding = %q, want %q", got, "") + } + if got := res.Header.Get("Vary"); got != "Accept-Encoding" { + t.Errorf("Vary = %q, want %q", got, "Accept-Encoding") + } +} + +func TestStrongETagBecomesWeak(t *testing.T) { + body := strings.Repeat("hello wiki ", 100) + res := serve(t, handlerOf(body, map[string]string{"ETag": `"abc"`}, http.StatusOK), "gzip") + + if got := res.Header.Get("ETag"); got != `W/"abc"` { + t.Errorf("ETag = %q, want %q", got, `W/"abc"`) + } +} + +func TestStatusIsKept(t *testing.T) { + body := strings.Repeat("missing page ", 100) + res := serve(t, handlerOf(body, nil, http.StatusNotFound), "gzip") + + if res.StatusCode != http.StatusNotFound { + t.Errorf("status = %d, want %d", res.StatusCode, http.StatusNotFound) + } +} + +func TestPaddingVariesBetweenResponses(t *testing.T) { + body := strings.Repeat("hello wiki ", 100) + lengths := make(map[string]bool) + for i := 0; i < 20; i++ { + res := serve(t, handlerOf(body, nil, http.StatusOK), "gzip") + lengths[res.Header.Get("Content-Length")] = true + } + if len(lengths) < 2 { + t.Errorf("len(distinct Content-Length over 20 responses) = %d, want more than 1", len(lengths)) + } +} From 19a25f5d861670860d405a0317565216057b8188 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:23 +0900 Subject: [PATCH 054/428] answer article pages --- internal/articlepage/articlepage.go | 83 ++++ internal/articlepage/articlepage_test.go | 85 ++++ internal/articlepage/build.go | 144 +++++++ internal/articlepage/render.go | 526 +++++++++++++++++++++++ 4 files changed, 838 insertions(+) create mode 100644 internal/articlepage/articlepage.go create mode 100644 internal/articlepage/articlepage_test.go create mode 100644 internal/articlepage/build.go create mode 100644 internal/articlepage/render.go diff --git a/internal/articlepage/articlepage.go b/internal/articlepage/articlepage.go new file mode 100644 index 00000000..7cf91ad1 --- /dev/null +++ b/internal/articlepage/articlepage.go @@ -0,0 +1,83 @@ +// Package articlepage answers the article URLs, which is every path the wiki +// has not claimed for something else. +package articlepage + +import ( + "errors" + "net/http" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/shell" + "github.com/WikitTeam/ProjectWikit/internal/static" +) + +type Deps struct { + DB *db.DB + Engine renderer.Renderer + Bundle *i18n.Bundle + Icons roles.IconLoader + Assets *static.Assets + TimeZone *time.Location + GoogleTagID string + + // Now exists so a test can pin the moment an inactive account comes back. + Now func() time.Time +} + +type Handler struct { + deps Deps + shell func(loc *i18n.Localizer) *shell.Renderer +} + +var _ http.Handler = (*Handler)(nil) + +func New(d Deps) *Handler { + if d.Now == nil { + d.Now = time.Now + } + if d.TimeZone == nil { + d.TimeZone = time.UTC + } + return &Handler{ + deps: d, + shell: func(loc *i18n.Localizer) *shell.Renderer { + return shell.New(loc, d.Assets, d.TimeZone) + }, + } +} + +func (h *Handler) now() time.Time { return h.deps.Now() } + +func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + if r.Method != http.MethodGet && r.Method != http.MethodHead { + w.Header().Set("Allow", "GET, HEAD") + http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) + return + } + + out, err := h.build(r) + if err != nil { + http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) + return + } + if out.Location != "" { + w.Header().Set("Location", out.Location) + w.Header().Set("Content-Type", "text/html; charset=utf-8") + w.Header().Set("Content-Length", "0") + w.WriteHeader(out.Status) + return + } + + w.Header().Set("Content-Type", "text/html; charset=utf-8") + w.WriteHeader(out.Status) + if r.Method == http.MethodHead { + return + } + if _, err := w.Write([]byte(out.Body)); err != nil && !errors.Is(err, http.ErrBodyNotAllowed) { + return + } +} diff --git a/internal/articlepage/articlepage_test.go b/internal/articlepage/articlepage_test.go new file mode 100644 index 00000000..fe834a5b --- /dev/null +++ b/internal/articlepage/articlepage_test.go @@ -0,0 +1,85 @@ +package articlepage + +import ( + "net/http" + "net/http/httptest" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/article" +) + +func TestExcerpt(t *testing.T) { + cases := []struct{ in, want string }{ + {"", ""}, + {"one line", "one line"}, + {" padded ", "padded"}, + {"a\n\n\nb", "a\nb"}, + {" a \n \n b ", "a\nb"}, + {"a\nb\nc", "a\nb\nc"}, + } + for _, c := range cases { + if got := excerpt(c.in); got != c.want { + t.Errorf("excerpt(%q) = %q, want %q", c.in, got, c.want) + } + } +} + +func TestExcerptTruncatesByRunes(t *testing.T) { + got := excerpt(strings.Repeat("中", 500)) + want := strings.Repeat("中", excerptLimit) + "..." + if got != want { + t.Errorf("len([]rune(excerpt(500 runes))) = %d, want %d", len([]rune(got)), len([]rune(want))) + } +} + +func TestExcerptKeepsAnExactFit(t *testing.T) { + got := excerpt(strings.Repeat("a", excerptLimit)) + if strings.HasSuffix(got, "...") { + t.Errorf("excerpt(%d chars) ends with an ellipsis, want none", excerptLimit) + } +} + +func TestPathParamsWritesBareKeysAsNull(t *testing.T) { + _, params := article.ParsePath("main/offset/20/bare", "main") + got := pathParams(params) + if len(got) != 2 { + t.Fatalf("len(pathParams()) = %d, want 2", len(got)) + } + if got[0].Key != "offset" || got[0].Value != "20" { + t.Errorf("pathParams()[0] = %v, want offset=20", got[0]) + } + if got[1].Key != "bare" || got[1].Value != nil { + t.Errorf("pathParams()[1] = %v, want bare=nil", got[1]) + } +} + +func TestFirstNonEmpty(t *testing.T) { + if got := firstNonEmpty("", "second", "third"); got != "second" { + t.Errorf("firstNonEmpty() = %q, want %q", got, "second") + } + if got := firstNonEmpty("", ""); got != "" { + t.Errorf("firstNonEmpty() = %q, want %q", got, "") + } +} + +func TestPostIsNotAllowed(t *testing.T) { + rec := httptest.NewRecorder() + New(Deps{}).ServeHTTP(rec, httptest.NewRequest(http.MethodPost, "/main", nil)) + + if rec.Code != http.StatusMethodNotAllowed { + t.Errorf("POST /main = %d, want %d", rec.Code, http.StatusMethodNotAllowed) + } + if got := rec.Header().Get("Allow"); got != "GET, HEAD" { + t.Errorf("Allow = %q, want %q", got, "GET, HEAD") + } +} + +func TestRequestWithoutASiteFails(t *testing.T) { + rec := httptest.NewRecorder() + New(Deps{}).ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/main", nil)) + + if rec.Code != http.StatusInternalServerError { + t.Errorf("GET /main without a site = %d, want %d", rec.Code, http.StatusInternalServerError) + } +} diff --git a/internal/articlepage/build.go b/internal/articlepage/build.go new file mode 100644 index 00000000..0ec222bc --- /dev/null +++ b/internal/articlepage/build.go @@ -0,0 +1,144 @@ +package articlepage + +import ( + "context" + "errors" + "net/http" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/article" + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" +) + +type result struct { + Status int + Location string + Body string +} + +type request struct { + ctx context.Context + loc *i18n.Localizer + site *db.Site + user *db.User + + name string + params article.Params + encoded string + + article *db.Article + forbidden bool + perms perms.Set +} + +func (h *Handler) build(r *http.Request) (*result, error) { + ctx := r.Context() + found := site.FromContext(ctx) + if found == nil { + return nil, errors.New("articlepage: the request carries no site") + } + + req := &request{ + ctx: ctx, + loc: h.deps.Bundle.Localizer(i18n.DefaultLanguage), + site: found, + user: auth.FromContext(ctx), + } + req.name, req.params = article.ParsePath(strings.TrimPrefix(r.URL.EscapedPath(), "/"), found.HomePage) + req.encoded = req.params.Encode() + + if target, ok := article.RedirectTarget(req.name, req.params); ok { + return &result{Status: http.StatusFound, Location: target}, nil + } + + if err := h.load(req); err != nil { + return nil, err + } + + if req.article != nil && req.params.Get("comments") == "show" { + target, err := h.commentsRedirect(req) + if err != nil { + return nil, err + } + if target != "" { + return &result{Status: http.StatusFound, Location: target}, nil + } + } + + return h.render(req) +} + +// A page the visitor may not see is dropped here, which is what leaves every +// layer below working on nothing at all. +func (h *Handler) load(req *request) error { + found, err := h.deps.DB.ArticleByName(req.ctx, req.name) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return err + } + req.article = found + + perm := repo.NewPerms(req.ctx, h.deps.DB) + subject, err := perm.Subject(req.user, h.now()) + if err != nil { + return err + } + + object, checked, err := h.permsObject(req, perm) + if err != nil { + return err + } + req.perms = perms.Resolve(subject, object) + if checked && !req.perms.Has(perms.ViewArticles) { + req.forbidden = true + req.article = nil + } + return nil +} + +// permsObject reports checked=false when neither the page nor a row for its +// category exists, where Django asks nothing and lets the response be a 404. +func (h *Handler) permsObject(req *request, perm *repo.Perms) (*perms.Object, bool, error) { + if req.article != nil { + object, err := perm.Article(req.article, req.user) + return object, true, err + } + category, _ := wikidot.Split(req.name) + exists, err := h.deps.DB.CategoryExists(req.ctx, category) + if err != nil { + return nil, false, err + } + if !exists { + return nil, false, nil + } + object, err := perm.Category(category) + return object, true, err +} + +// Django creates the thread on the way past. This only reads, so a page nobody +// has commented on stays where it is. +func (h *Handler) commentsRedirect(req *request) (string, error) { + info, err := h.deps.DB.CommentInfo(req.ctx, req.article.ID) + if err != nil { + return "", err + } + if info.ThreadID == 0 { + return "", nil + } + return "/forum/t-" + strconv.FormatInt(info.ThreadID, 10) + "/" + + wikidot.Normalize(req.article.DisplayName()), nil +} + +func (h *Handler) canonicalURL(req *request) string { + name := req.name + if req.article != nil { + name = req.article.FullName() + } + return "https://" + req.site.Domain + "/" + name + req.encoded +} diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go new file mode 100644 index 00000000..e66748dc --- /dev/null +++ b/internal/articlepage/render.go @@ -0,0 +1,526 @@ +package articlepage + +import ( + "errors" + "net/http" + "regexp" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/article" + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pageconfig" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/printuser" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/shell" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" +) + +const ( + templateName = "_template" + excerptLimit = 384 +) + +type body struct { + html string + status int + excerpt string + image string + title string + rev int + updatedAt time.Time + style string + redirect string +} + +func (h *Handler) render(req *request) (*result, error) { + navTop, topStyle, err := h.nav(req, "nav:top") + if err != nil { + return nil, err + } + navSide, sideStyle, err := h.nav(req, "nav:side") + if err != nil { + return nil, err + } + + canonical := h.canonicalURL(req) + out, err := h.body(req, canonical) + if err != nil { + return nil, err + } + if out.redirect != "" { + return &result{Status: http.StatusFound, Location: out.redirect}, nil + } + out.style = topStyle + sideStyle + out.style + + data, err := h.shellData(req, out, canonical, navTop, navSide) + if err != nil { + return nil, err + } + + var page strings.Builder + if err := h.shell(req.loc).Page(&page, data); err != nil { + return nil, err + } + return &result{Status: out.status, Body: page.String()}, nil +} + +func (h *Handler) body(req *request, canonical string) (body, error) { + switch { + case req.forbidden: + html, err := h.shell(req.loc).Forbidden(req.name) + return body{html: html, status: http.StatusForbidden}, err + case req.article != nil: + return h.articleBody(req, canonical) + default: + return h.missingBody(req) + } +} + +func (h *Handler) articleBody(req *request, canonical string) (body, error) { + source, err := h.source(req) + if err != nil { + return body{}, err + } + vars := h.vars(req, req.article) + source = page.PageVars(source, vars, 1, 1) + source = page.ApplyTemplate(source, article.ThisPage(req.params, canonical)) + source = page.ThisVars(source, vars) + + info, err := h.pageInfo(req, req.article) + if err != nil { + return body{}, err + } + + pc := h.context(req, req.article) + html, err := h.deps.Engine.RenderHTML(req.ctx, source, info, h.callbacks(req, vars, pc), renderer.ModeArticle) + if err != nil { + return body{}, err + } + // The text pass gets a context of its own. Sharing one would let a module + // that writes to it do so twice. + text, err := h.deps.Engine.RenderText(req.ctx, source, info, + h.callbacks(req, vars, h.context(req, req.article)), renderer.ModeArticle) + if err != nil { + return body{}, err + } + + rev, err := h.deps.DB.LatestRevNumber(req.ctx, req.article.ID) + if err != nil { + return body{}, err + } + out := body{ + html: html.Body, + status: pc.Status, + excerpt: excerpt(text.Body), + title: pc.Title, + rev: rev, + updatedAt: req.article.UpdatedAt, + style: pc.ComputedStyle, + redirect: pc.RedirectTo, + image: pc.OGImage, + } + if pc.OGDescription != "" { + out.excerpt = pc.OGDescription + } + return out, nil +} + +func (h *Handler) context(req *request, source *db.Article) *page.Context { + return page.NewContext(req.article, source, paramsMap(req.params), req.user) +} + +func paramsMap(params article.Params) map[string]string { + out := make(map[string]string, len(params)) + for _, param := range params { + out[param.Key] = param.Value + } + return out +} + +// A page named _template is its own content, which is what keeps the template +// from wrapping itself. +func (h *Handler) source(req *request) (string, error) { + if req.article.Name == templateName { + return "%%content%%", nil + } + found, err := h.deps.DB.ArticleByName(req.ctx, req.article.Category+":"+templateName) + if errors.Is(err, db.ErrNotFound) { + return "%%content%%", nil + } + if err != nil { + return "", err + } + source, err := h.deps.DB.LatestSource(req.ctx, found.ID) + if errors.Is(err, db.ErrNotFound) { + return "%%content%%", nil + } + if err != nil { + return "", err + } + return source, nil +} + +func (h *Handler) missingBody(req *request) (body, error) { + options, err := pyjson.Marshal(pyjson.Object{ + {Key: "page_id", Value: req.name}, + {Key: "pathParams", Value: pathParams(req.params)}, + }) + if err != nil { + return body{}, err + } + category, _ := wikidot.Split(req.name) + object, err := repo.NewPerms(req.ctx, h.deps.DB).Category(category) + if err != nil { + return body{}, err + } + subject, err := h.subject(req) + if err != nil { + return body{}, err + } + allow := wikidot.NameAllowed(req.name) && perms.Resolve(subject, object).Has(perms.CreateArticles) + + // The name is left out because the view never puts it in this template's + // context, so the message it renders has an empty slot where it goes. + html, err := h.shell(req.loc).NotFound(shell.NotFound{ + AllowCreate: allow, + Options: options, + }) + return body{html: html, status: http.StatusNotFound}, err +} + +// nav renders one of the two navigation pages. It gets its own callbacks and +// its own PageInfo, since the page it decorates is a different row. +func (h *Handler) nav(req *request, name string) (string, string, error) { + found, err := h.deps.DB.ArticleByName(req.ctx, name) + if errors.Is(err, db.ErrNotFound) { + return "", "", nil + } + if err != nil { + return "", "", err + } + source, err := h.deps.DB.LatestSource(req.ctx, found.ID) + if errors.Is(err, db.ErrNotFound) { + return "", "", nil + } + if err != nil { + return "", "", err + } + + vars := h.vars(req, req.article) + info, err := h.pageInfo(req, found) + if err != nil { + return "", "", err + } + pc := h.context(req, found) + html, err := h.deps.Engine.RenderHTML(req.ctx, page.ThisVars(source, vars), info, + h.callbacks(req, vars, pc), renderer.ModeArticle) + if err != nil { + return "", "", err + } + return html.Body, pc.ComputedStyle, nil +} + +func (h *Handler) callbacks(req *request, vars *page.Vars, pc *page.Context) *callbacks.Callbacks { + users := printuser.New(req.loc, h.deps.Icons) + store := repo.New(req.ctx, h.deps.DB, users, repo.Options{ + Loc: req.loc, + Site: req.site, + User: req.user, + }) + cb := callbacks.New(req.loc, store) + cb.SetPageVars(vars) + cb.SetContext(pc) + return cb +} + +func (h *Handler) vars(req *request, of *db.Article) *page.Vars { + if of == nil { + return nil + } + return page.NewVars(of, req.user, repo.NewVarSource(req.ctx, h.deps.DB, req.site.ID), req.loc) +} + +func (h *Handler) pageInfo(req *request, source *db.Article) (renderer.PageInfo, error) { + info := renderer.PageInfo{ + Site: req.site.Slug, + Domain: req.site.Domain, + MediaDomain: req.site.MediaDomain, + } + if source == nil { + return info, nil + } + info.Page = source.Name + info.Category = source.Category + tags, err := h.deps.DB.ArticleTagNames(req.ctx, source.ID) + if err != nil { + return renderer.PageInfo{}, err + } + info.Tags = tags + return info, nil +} + +func (h *Handler) subject(req *request) (perms.Subject, error) { + return repo.NewPerms(req.ctx, h.deps.DB).Subject(req.user, h.now()) +} + +var newlines = regexp.MustCompile(`\n+`) + +// excerpt trims every line and collapses the blank ones, which is the shape +// og:description carries. +func excerpt(text string) string { + lines := strings.Split(text, "\n") + for i, line := range lines { + lines[i] = strings.TrimSpace(line) + } + joined := newlines.ReplaceAllString(strings.Join(lines, "\n"), "\n") + runes := []rune(joined) + if len(runes) > excerptLimit { + return string(runes[:excerptLimit]) + "..." + } + return joined +} + +func pathParams(params article.Params) pyjson.Object { + out := make(pyjson.Object, 0, len(params)) + for _, param := range params { + var value any + if !param.Bare { + value = param.Value + } + out = append(out, pyjson.Field{Key: param.Key, Value: value}) + } + return out +} + +func firstNonEmpty(values ...string) string { + for _, value := range values { + if value != "" { + return value + } + } + return "" +} + +func (h *Handler) shellData(req *request, out body, canonical, navTop, navSide string) (shell.Data, error) { + theme, err := h.themeURL(req) + if err != nil { + return shell.Data{}, err + } + indexed, err := h.indexed(req) + if err != nil { + return shell.Data{}, err + } + crumbs, err := h.breadcrumbs(req) + if err != nil { + return shell.Data{}, err + } + tags, err := h.tagBlock(req) + if err != nil { + return shell.Data{}, err + } + login, err := h.loginStatus(req) + if err != nil { + return shell.Data{}, err + } + options, err := h.options(req) + if err != nil { + return shell.Data{}, err + } + + title := firstNonEmpty(out.title, req.site.Title) + return shell.Data{ + SiteName: req.site.Title, + SiteHeadline: req.site.Headline, + SiteTitle: title, + SiteIcon: req.site.Icon, + OGTitle: title, + OGDescription: out.excerpt, + OGImage: out.image, + OGURL: canonical, + NoIndex: !indexed, + GoogleTagID: h.deps.GoogleTagID, + ThemeURL: theme, + ComputedStyle: out.style, + NavTop: navTop, + NavSide: navSide, + Title: out.title, + Content: out.html, + Breadcrumbs: crumbs, + TagCategories: tags, + RevNumber: out.rev, + UpdatedAt: out.updatedAt, + LoginStatusConfig: login, + OptionsConfig: options, + }, nil +} + +func (h *Handler) themeURL(req *request) (string, error) { + if req.site.ThemeID == nil { + return site.DefaultThemeURL, nil + } + theme, err := h.deps.DB.ThemeByID(req.ctx, *req.site.ThemeID) + if errors.Is(err, db.ErrNotFound) { + return site.DefaultThemeURL, nil + } + if err != nil { + return "", err + } + return site.ThemeURL(theme), nil +} + +func (h *Handler) indexed(req *request) (bool, error) { + category, _ := wikidot.Split(req.name) + return h.deps.DB.CategoryIndexed(req.ctx, category) +} + +func (h *Handler) breadcrumbs(req *request) ([]shell.Breadcrumb, error) { + if req.article == nil { + return nil, nil + } + chain, err := h.deps.DB.Breadcrumbs(req.ctx, req.article.ID) + if err != nil { + return nil, err + } + out := make([]shell.Breadcrumb, 0, len(chain)) + for i := range chain { + out = append(out, shell.Breadcrumb{URL: "/" + chain[i].FullName(), Title: chain[i].Title}) + } + return out, nil +} + +func (h *Handler) tagBlock(req *request) ([]shell.TagCategory, error) { + if req.article == nil { + return nil, nil + } + categories, err := h.deps.DB.ArticleTagCategories(req.ctx, req.article.ID) + if err != nil { + return nil, err + } + out := make([]shell.TagCategory, 0, len(categories)) + for _, category := range categories { + one := shell.TagCategory{Name: category.Name} + for _, tag := range category.Tags { + one.Tags = append(one.Tags, shell.Tag{Name: tag.Name, FullName: tag.FullName}) + } + out = append(out, one) + } + return out, nil +} + +func (h *Handler) loginStatus(req *request) (string, error) { + status := pageconfig.LoginStatus{User: req.user} + if req.user != nil { + userRoles, err := h.deps.DB.RolesByUser(req.ctx, req.user.ID) + if err != nil { + return "", err + } + count, err := h.deps.DB.UnreadNotifications(req.ctx, req.user.ID) + if err != nil { + return "", err + } + subject, err := h.subject(req) + if err != nil { + return "", err + } + status.Roles = userRoles + status.NotificationCount = count + status.CanEditArticles = perms.Resolve(subject, nil).Has(perms.EditArticles) + } + return status.JSON(req.loc) +} + +func (h *Handler) options(req *request) (string, error) { + options := pageconfig.Options{ + PageID: req.name, + NormalizedName: req.name, + HasArticle: req.article != nil, + Anonymous: req.user == nil, + Perms: req.perms, + PathParams: req.params, + Rating: page.DisabledRating(), + } + + tags, err := h.deps.DB.SiteCanCreateTags(req.ctx, req.site.ID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", err + } + options.CanCreateTags = tags == db.CreateTagsEnabled + + if req.user != nil { + raw, err := h.deps.DB.UserPreference(req.ctx, req.user.ID, + pageconfig.PreferenceSection, pageconfig.PreferenceAdvancedSourceEditor) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", err + } + options.Preferences.AdvancedSourceEditor = pageconfig.PreferenceEnabled(raw) + } + + if req.article != nil { + rating, err := h.rating(req) + if err != nil { + return "", err + } + options.Rating = rating + + info, err := h.deps.DB.CommentInfo(req.ctx, req.article.ID) + if err != nil { + return "", err + } + options.CommentCount = info.Count + + watching, err := h.watching(req, info.ThreadID) + if err != nil { + return "", err + } + options.IsWatching = watching + } + return options.JSON() +} + +func (h *Handler) rating(req *request) (page.Rating, error) { + siteMode, err := h.deps.DB.SiteRatingMode(req.ctx, req.site.ID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return page.Rating{}, err + } + categoryMode, err := h.deps.DB.CategoryRatingMode(req.ctx, req.article.Category) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return page.Rating{}, err + } + mode := page.RatingMode(siteMode, categoryMode) + if mode == page.RatingModeDisabled { + return page.RatingOf(mode, db.VoteStats{}), nil + } + stats, err := h.deps.DB.VoteStats(req.ctx, req.article.ID) + if err != nil { + return page.Rating{}, err + } + return page.RatingOf(mode, stats), nil +} + +// watching asks about the page and about the thread the path names. A t that is +// not a number leaves the second question unasked, where Django raises. +func (h *Handler) watching(req *request, threadID int64) (bool, error) { + if req.user == nil { + return false, nil + } + onArticle, err := h.deps.DB.SubscribedToArticle(req.ctx, req.user.ID, req.article.ID) + if err != nil { + return false, err + } + if onArticle { + return true, nil + } + fromPath, err := strconv.ParseInt(req.params.Get("t"), 10, 64) + if err != nil { + return false, nil + } + return h.deps.DB.SubscribedToThread(req.ctx, req.user.ID, fromPath) +} From 838bdcbdfe9cf23ceb3058ac97cb5a0a0ed843b6 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:23 +0900 Subject: [PATCH 055/428] add the article handler's wiring --- cmd/pwikit/articles.go | 52 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 cmd/pwikit/articles.go diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go new file mode 100644 index 00000000..288c29f9 --- /dev/null +++ b/cmd/pwikit/articles.go @@ -0,0 +1,52 @@ +package main + +import ( + "io/fs" + "log/slog" + "net/http" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/articlepage" + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/paths" + "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/session" + "github.com/WikitTeam/ProjectWikit/internal/static" +) + +func articleHandler(conn *db.DB, p *paths.Paths, assets fs.FS, sidecar, secret, timezone string, log *slog.Logger) (http.Handler, func(), error) { + engine, closeEngine, err := newRenderer(sidecar) + if err != nil { + return nil, nil, err + } + bundle, err := i18n.Load(p.Locales()) + if err != nil { + closeEngine() + return nil, nil, err + } + location, err := time.LoadLocation(timezone) + if err != nil { + closeEngine() + return nil, nil, err + } + + pages := articlepage.New(articlepage.Deps{ + DB: conn, + Engine: engine, + Bundle: bundle, + Icons: roles.FileIcons(p.Files()), + Assets: static.NewAssets(assets), + TimeZone: location, + GoogleTagID: envOr(envGoogleTag, ""), + }) + + // Without the key nothing can be verified, so every visitor stays + // anonymous rather than being trusted on the cookie alone. + if secret == "" { + return pages, closeEngine, nil + } + resolver := auth.NewResolver(session.New(secret), conn, conn, log) + return resolver.Middleware(pages), closeEngine, nil +} From 08e9e0c0daed4b2404e2f6f7547a2e254d1193b4 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:23 +0900 Subject: [PATCH 056/428] normalize the language tag when comparing --- internal/difftest/difftest.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/internal/difftest/difftest.go b/internal/difftest/difftest.go index e2035bd2..ebdf5005 100644 --- a/internal/difftest/difftest.go +++ b/internal/difftest/difftest.go @@ -49,6 +49,11 @@ var DefaultScrubbers = []Scrubber{ Pattern: regexp.MustCompile(`(name="csrfmiddlewaretoken"\s+value=")[^"]*(")`), Repl: "${1}SCRUBBED${2}", }, + { + Name: "html-lang", + Pattern: regexp.MustCompile(`( Date: Thu, 27 Aug 2026 14:57:24 +0900 Subject: [PATCH 057/428] look a user up by the name they are shown under --- internal/db/user.go | 13 +++++++++++++ internal/db/user_test.go | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/internal/db/user.go b/internal/db/user.go index c5c5b171..3a4f7ffa 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -85,6 +85,19 @@ func (d *DB) UserByName(ctx context.Context, canonical string) (*User, error) { return d.scanUser(ctx, qUserByName, canonical) } +var qUserByDisplayName = register("UserByDisplayName", ` +SELECT `+userColumns+` +FROM web_user +WHERE lower(display_name) = lower($1) +ORDER BY id +LIMIT 1`) + +// The oldest row wins so a later account cannot take over a name a page already +// points at. +func (d *DB) UserByDisplayName(ctx context.Context, name string) (*User, error) { + return d.scanUser(ctx, qUserByDisplayName, name) +} + // UserByWikidotName resolves the wd: prefix, which may only ever match an // imported Wikidot account. func (d *DB) UserByWikidotName(ctx context.Context, canonical string) (*User, error) { diff --git a/internal/db/user_test.go b/internal/db/user_test.go index b0e4720d..dc0afa8e 100644 --- a/internal/db/user_test.go +++ b/internal/db/user_test.go @@ -29,3 +29,36 @@ func TestUserByNameUnknown(t *testing.T) { t.Errorf("UserByName(\"no-such-user\") err = %v, want ErrNotFound", err) } } + +func TestUserByDisplayName(t *testing.T) { + d := newTestDB(t) + + got, err := d.UserByDisplayName(context.Background(), "Probe WD") + if err != nil { + t.Fatalf("UserByDisplayName() err = %v, want nil", err) + } + if got.WikidotUsername != "probe-wd-original" { + t.Errorf("UserByDisplayName(Probe WD).WikidotUsername = %q, want %q", got.WikidotUsername, "probe-wd-original") + } +} + +func TestUserByDisplayNameIgnoresCase(t *testing.T) { + d := newTestDB(t) + + got, err := d.UserByDisplayName(context.Background(), "pRoBe wD") + if err != nil { + t.Fatalf("UserByDisplayName() err = %v, want nil", err) + } + if got.DisplayName != "Probe WD" { + t.Errorf("UserByDisplayName(pRoBe wD).DisplayName = %q, want %q", got.DisplayName, "Probe WD") + } +} + +func TestUserByDisplayNameUnknown(t *testing.T) { + d := newTestDB(t) + + _, err := d.UserByDisplayName(context.Background(), "No Such Display Name") + if !errors.Is(err, ErrNotFound) { + t.Errorf("UserByDisplayName(unknown) err = %v, want ErrNotFound", err) + } +} From 2a74a6404ae4974c69604391ae2fc8fd813569f9 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:24 +0900 Subject: [PATCH 058/428] answer modules from a package that holds nothing else --- cmd/pwikit/main.go | 34 +++++-- cmd/pwikit/render.go | 4 +- internal/callbacks/callbacks.go | 13 ++- internal/callbacks/callbacks_test.go | 2 +- internal/callbacks/integration_test.go | 3 +- internal/i18n/locales/zh-hans.json | 5 ++ internal/module/module.go | 109 +++++++++++++++++++++++ internal/{modules => module}/registry.go | 11 ++- internal/module/registry_test.go | 77 ++++++++++++++++ internal/modules/pagedescription.go | 25 ++++++ internal/modules/pageimage.go | 41 +++++++++ internal/modules/pagesbytag.go | 62 +++++++++++++ internal/modules/redirect.go | 41 +++++++++ internal/modules/registry_test.go | 87 ------------------ internal/repo/modules.go | 44 +++++++++ internal/repo/repo.go | 42 ++++++++- internal/repo/repo_test.go | 29 +++++- 17 files changed, 521 insertions(+), 108 deletions(-) create mode 100644 internal/module/module.go rename internal/{modules => module}/registry.go (89%) create mode 100644 internal/module/registry_test.go create mode 100644 internal/modules/pagedescription.go create mode 100644 internal/modules/pageimage.go create mode 100644 internal/modules/pagesbytag.go create mode 100644 internal/modules/redirect.go delete mode 100644 internal/modules/registry_test.go create mode 100644 internal/repo/modules.go diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 648148b2..b7ae0f2d 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -14,10 +14,11 @@ import ( "text/tabwriter" "time" + "github.com/WikitTeam/ProjectWikit/internal/compress" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/forward" "github.com/WikitTeam/ProjectWikit/internal/media" - "github.com/WikitTeam/ProjectWikit/internal/modules" + "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/paths" "github.com/WikitTeam/ProjectWikit/internal/proxyheader" "github.com/WikitTeam/ProjectWikit/internal/respheader" @@ -29,6 +30,9 @@ import ( const ( envDatabase = "DATABASE_URL" envUpstream = "PWIKIT_UPSTREAM" + envSecretKey = "SECRET_KEY" + envTimeZone = "PWIKIT_TIMEZONE" + envGoogleTag = "GOOGLE_TAG_ID" defaultUpstream = "http://127.0.0.1:8000" defaultListen = "127.0.0.1:8080" ) @@ -83,6 +87,10 @@ func serve(args []string) error { trusted := fs.String("trusted-proxies", "", "trusted reverse proxy addresses or CIDRs, comma separated; empty trusts no X-Forwarded-* header") staticDir := fs.String("static-dir", "", "directory holding the frontend asset bundle; without it every asset request goes upstream") database := fs.String("database", os.Getenv(envDatabase), "PostgreSQL connection string; without it every request needing the database goes upstream") + secret := fs.String("secret-key", os.Getenv(envSecretKey), "key the session cookie is signed with; without it every visitor is anonymous") + sidecar := fs.String("sidecar", os.Getenv(envSidecar), "path to the ftml sidecar binary; without it the linked-in ftml is used") + timezone := fs.String("timezone", envOr(envTimeZone, "UTC"), "time zone dates are shown in") + articles := fs.Bool("articles-from-go", false, "answer article pages here instead of passing them upstream") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -129,12 +137,28 @@ func serve(args []string) error { mediaHandler = site.NewHostRules(conn, listenPort(*listen), media.New(p.Files(), conn), proxy) } - mux, err := routing.New(routing.Table, proxy, map[string]http.Handler{ + table := routing.Table + goHandlers := map[string]http.Handler{ // The bundle is the one route answered above the session layer, so it // is also the one that does not vary on the cookie. static.Prefix: static.New(assets, proxy), media.Prefix: respheader.VaryCookie(mediaHandler), - }) + } + + if *articles { + if conn == nil { + return errors.New("-articles-from-go needs a database") + } + pages, closeEngine, err := articleHandler(conn, p, assets, *sidecar, *secret, *timezone, log) + if err != nil { + return err + } + defer closeEngine() + table = routing.WithOwner(table, "/", routing.OwnerGo) + goHandlers["/"] = compress.New(respheader.VaryCookie(site.NewHostRules(conn, listenPort(*listen), pages, proxy))) + } + + mux, err := routing.New(table, proxy, goHandlers) if err != nil { return err } @@ -199,12 +223,12 @@ func printRoutes() error { func printModules() error { w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0) fmt.Fprintln(w, "MODULE\tBODY\tSTATUS") - for _, info := range modules.All() { + for _, info := range module.All() { status := "pending" switch { case info.Removed: status = "removed" - case info.Ported: + case module.Ported(info.Name): status = "ported" } fmt.Fprintf(w, "%s\t%t\t%s\n", info.Name, info.HasContent, status) diff --git a/cmd/pwikit/render.go b/cmd/pwikit/render.go index 4e0fdff3..e2c79740 100644 --- a/cmd/pwikit/render.go +++ b/cmd/pwikit/render.go @@ -76,7 +76,7 @@ func render(args []string) error { return err } users := printuser.New(bundle.Localizer(i18n.DefaultLanguage), roles.FileIcons(p.Files())) - store.data = repo.New(ctx, conn, users) + store.data = repo.New(ctx, conn, users, repo.Options{Loc: bundle.Localizer(i18n.DefaultLanguage)}) vars, err = cliPageVars(ctx, conn, bundle.Localizer(i18n.DefaultLanguage), *category, *pageName, *domain) if err != nil { return err @@ -198,7 +198,7 @@ type cliRepository struct { var _ callbacks.Repository = cliRepository{} -func (r cliRepository) RenderModule(name string, params map[string]string, _ string) (string, error) { +func (r cliRepository) RenderModule(pc *page.Context, name string, params map[string]string, _ string) (string, error) { keys := make([]string, 0, len(params)) for key := range params { keys = append(keys, key) diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go index 72fad584..0acfc488 100644 --- a/internal/callbacks/callbacks.go +++ b/internal/callbacks/callbacks.go @@ -9,7 +9,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/escape" "github.com/WikitTeam/ProjectWikit/internal/expr" "github.com/WikitTeam/ProjectWikit/internal/i18n" - "github.com/WikitTeam/ProjectWikit/internal/modules" + "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/wikidot" @@ -30,7 +30,7 @@ type ModuleError struct{ Message string } func (e *ModuleError) Error() string { return e.Message } type Repository interface { - RenderModule(name string, params map[string]string, body string) (string, error) + RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) RenderUser(username string, avatar bool) (string, error) PageInfo(refs []string) ([]renderer.PartialPageInfo, error) IncludeSources(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) @@ -40,6 +40,7 @@ type Callbacks struct { loc *i18n.Localizer repo Repository vars *page.Vars + pageCtx *page.Context level int includeErrors map[string]bool } @@ -51,6 +52,10 @@ var _ renderer.Callbacks = (*Callbacks)(nil) // of its own gets in Django too. func (c *Callbacks) SetPageVars(vars *page.Vars) { c.vars = vars } +// SetContext hands the modules the page they are rendering into, which is what +// lets one of them redirect the whole request or set the description. +func (c *Callbacks) SetContext(pc *page.Context) { c.pageCtx = pc } + func New(loc *i18n.Localizer, repo Repository) *Callbacks { return &Callbacks{ loc: loc, @@ -61,7 +66,7 @@ func New(loc *i18n.Localizer, repo Repository) *Callbacks { } func (c *Callbacks) ModuleHasBody(name string) (bool, error) { - return modules.HasContent(name), nil + return module.HasContent(name), nil } func (c *Callbacks) RenderModule(name string, params map[string]string, body string) (string, error) { @@ -72,7 +77,7 @@ func (c *Callbacks) RenderModule(name string, params map[string]string, body str for key, value := range params { lowered[strings.ToLower(key)] = value } - html, err := c.repo.RenderModule(name, lowered, body) + html, err := c.repo.RenderModule(c.pageCtx, name, lowered, body) var moduleErr *ModuleError if errors.As(err, &moduleErr) { return `

` + escape.HTML(moduleErr.Message) + `

`, nil diff --git a/internal/callbacks/callbacks_test.go b/internal/callbacks/callbacks_test.go index 237242d4..064370fb 100644 --- a/internal/callbacks/callbacks_test.go +++ b/internal/callbacks/callbacks_test.go @@ -21,7 +21,7 @@ type fakeRepo struct { includeBody string } -func (r *fakeRepo) RenderModule(name string, params map[string]string, body string) (string, error) { +func (r *fakeRepo) RenderModule(_ *page.Context, name string, params map[string]string, body string) (string, error) { r.moduleName = name r.moduleParam = params if r.moduleErr != nil { diff --git a/internal/callbacks/integration_test.go b/internal/callbacks/integration_test.go index 01631e44..19a502d1 100644 --- a/internal/callbacks/integration_test.go +++ b/internal/callbacks/integration_test.go @@ -2,6 +2,7 @@ package callbacks import ( "context" + "github.com/WikitTeam/ProjectWikit/internal/page" "os" "strings" "testing" @@ -15,7 +16,7 @@ type siteRepo struct { existing map[string]bool } -func (r siteRepo) RenderModule(name string, params map[string]string, body string) (string, error) { +func (r siteRepo) RenderModule(_ *page.Context, name string, params map[string]string, body string) (string, error) { return `
` + name + "|" + body + `
`, nil } diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 83b20a5d..6f88894e 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -8,6 +8,11 @@ "include-create": "立刻创建", "include-loop": "插入的页面 \"{name}\" 导致了无限包含循环", "include-missing": "插入的页面 \"{name}\" 不存在", + "module-disabled": "模块处理已禁用", + "module-failed": "处理模块 '{name}' 时出错", + "module-pagesbytag-category": " 来自分类 {category}", + "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", + "module-unknown": "模块 '{name}' 不存在", "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", "page.forbidden": "您没有查看此页面的权限 {page}.", diff --git a/internal/module/module.go b/internal/module/module.go new file mode 100644 index 00000000..2987a09e --- /dev/null +++ b/internal/module/module.go @@ -0,0 +1,109 @@ +// Package module is what a wikidot module is written against. The modules +// themselves live in internal/modules, one file each. +package module + +import ( + "errors" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +// Error is the failure that reaches the reader as a block on the page rather +// than as a broken response. +type Error struct{ Message string } + +func (e *Error) Error() string { return e.Message } + +// ErrNotPorted is not an Error on purpose. A module nobody has written yet is +// a hole in pwikit, not something to tell the reader about. +var ErrNotPorted = errors.New("module: not ported yet") + +type Data interface { + TagArticles(categorySlug, name string, hiddenCategories []string) ([]db.Article, error) + TagCategory(slug string) (db.TagCategory, error) + HiddenCategories(user *db.User) ([]string, error) +} + +type Env struct { + Page *page.Context + Loc *i18n.Localizer + Site *db.Site + User *db.User + Data Data +} + +func (e Env) Text(id string, args ...any) string { + if e.Loc == nil { + return id + } + return e.Loc.T(id, args...) +} + +func (e Env) MediaDomain() string { + if e.Site == nil { + return "" + } + return e.Site.MediaDomain +} + +type Renderer func(env Env, params map[string]string, body string) (string, error) + +var renderers = map[string]Renderer{} + +// Register is called from each module's own file. A name the registry does not +// know is a typo, so it panics rather than registering something unreachable. +func Register(name string, r Renderer) { + if _, ok := registry[name]; !ok { + panic("module: " + name + " is not in the registry") + } + renderers[name] = r +} + +// Render answers one [[module]]. The page's own parameters go underneath the +// module's own, which is what lets a URL override what the page asked for. +func Render(env Env, name string, params map[string]string, body string) (string, error) { + if env.Page != nil && env.Page.PathParams["nomodule"] == "true" { + return "", &Error{Message: env.Text("module-disabled")} + } + info, ok := Lookup(name) + if !ok || info.Removed { + return "", &Error{Message: env.Text("module-unknown", "name", name)} + } + render, ok := renderers[info.Name] + if !ok { + return "", ErrNotPorted + } + return render(env, merge(env.Page, params), body) +} + +func merge(ctx *page.Context, params map[string]string) map[string]string { + out := make(map[string]string, len(params)) + if ctx != nil { + for key, value := range ctx.PathParams { + out[key] = value + } + } + for key, value := range params { + out[key] = value + } + return out +} + +// BoolParam is get_boolean_param, where anything the list does not name reads +// as the default rather than as false. +func BoolParam(params map[string]string, key string, def bool) bool { + value, ok := params[key] + if !ok { + return def + } + switch strings.ToLower(value) { + case "true", "t", "1", "yes": + return true + case "false", "f", "0", "no": + return false + } + return def +} diff --git a/internal/modules/registry.go b/internal/module/registry.go similarity index 89% rename from internal/modules/registry.go rename to internal/module/registry.go index a2e815c0..4cf6365e 100644 --- a/internal/modules/registry.go +++ b/internal/module/registry.go @@ -1,4 +1,4 @@ -package modules +package module import ( "slices" @@ -8,7 +8,6 @@ import ( type Info struct { Name string HasContent bool - Ported bool Removed bool } @@ -48,9 +47,15 @@ func HasContent(name string) bool { return ok && !info.Removed && info.HasContent } +// Ported is derived from the renderers that registered themselves, so the list +// cannot drift from the code that answers. func Ported(name string) bool { info, ok := Lookup(name) - return ok && info.Ported + if !ok { + return false + } + _, has := renderers[info.Name] + return has } func All() []Info { diff --git a/internal/module/registry_test.go b/internal/module/registry_test.go new file mode 100644 index 00000000..40a86e3c --- /dev/null +++ b/internal/module/registry_test.go @@ -0,0 +1,77 @@ +package module + +import "testing" + +func TestLookupIsCaseInsensitive(t *testing.T) { + for _, name := range []string{"ListPages", "listpages", " LISTPAGES "} { + if _, ok := Lookup(name); !ok { + t.Errorf("Lookup(%q) = false, want true", name) + } + } +} + +func TestLookupOfAnUnknownName(t *testing.T) { + if _, ok := Lookup("no-such-module"); ok { + t.Error("Lookup(\"no-such-module\") = true, want false") + } +} + +func TestHasContentOfARemovedModule(t *testing.T) { + info, ok := Lookup("interwiki") + if !ok || !info.HasContent { + t.Fatalf("Lookup(\"interwiki\").HasContent = %v, want true", ok && info.HasContent) + } + if HasContent("interwiki") { + t.Error("HasContent(\"interwiki\") = true, want false") + } +} + +func TestAllIsSortedByName(t *testing.T) { + all := All() + for i := 1; i < len(all); i++ { + if all[i-1].Name >= all[i].Name { + t.Errorf("All()[%d].Name = %q, want it sorted after %q", i, all[i].Name, all[i-1].Name) + } + } +} + +func TestBoolParam(t *testing.T) { + params := map[string]string{ + "yes": "YES", "one": "1", "t": "t", "true": "true", + "no": "no", "zero": "0", "f": "F", "false": "false", + "junk": "maybe", "empty": "", + } + cases := []struct { + key string + def bool + want bool + }{ + {"yes", false, true}, + {"one", false, true}, + {"t", false, true}, + {"true", false, true}, + {"no", true, false}, + {"zero", true, false}, + {"f", true, false}, + {"false", true, false}, + {"junk", true, true}, + {"junk", false, false}, + {"empty", true, true}, + {"missing", true, true}, + {"missing", false, false}, + } + for _, c := range cases { + if got := BoolParam(params, c.key, c.def); got != c.want { + t.Errorf("BoolParam(%q, %v) = %v, want %v", c.key, c.def, got, c.want) + } + } +} + +func TestRegisterRejectsAnUnknownName(t *testing.T) { + defer func() { + if recover() == nil { + t.Error("Register(\"no-such-module\") did not panic, want a panic") + } + }() + Register("no-such-module", func(Env, map[string]string, string) (string, error) { return "", nil }) +} diff --git a/internal/modules/pagedescription.go b/internal/modules/pagedescription.go new file mode 100644 index 00000000..5a99845e --- /dev/null +++ b/internal/modules/pagedescription.go @@ -0,0 +1,25 @@ +package modules + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/module" +) + +func init() { module.Register("pagedescription", renderPageDescription) } + +const ( + nbsp = string(rune(0xa0)) + // The description reaches a JSON string, where a raw < would close the + // script tag that carries it. + lessThan = `\u003c` +) + +func renderPageDescription(env module.Env, _ map[string]string, body string) (string, error) { + text := strings.ReplaceAll(body, nbsp, " ") + text = strings.ReplaceAll(text, "<", lessThan) + if text != "" && env.Page != nil { + env.Page.OGDescription = text + } + return "", nil +} diff --git a/internal/modules/pageimage.go b/internal/modules/pageimage.go new file mode 100644 index 00000000..cef6dc39 --- /dev/null +++ b/internal/modules/pageimage.go @@ -0,0 +1,41 @@ +package modules + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/module" +) + +func init() { module.Register("pageimage", renderPageImage) } + +func renderPageImage(env module.Env, params map[string]string, _ string) (string, error) { + src, ok := params["src"] + if !ok { + return "", nil + } + if env.Page != nil { + env.Page.OGImage = resourceURL(src, env.MediaDomain()) + } + return "", nil +} + +// resourceURL turns what an author wrote into a link the browser can follow. A +// name with no slash in it belongs to the page being rendered, so it cannot be +// resolved here and is handed back untouched. +func resourceURL(raw, mediaDomain string) string { + uri, err := validateURL(raw) + if err != nil { + uri = "#invalid-url" + } + if uri == "" { + return "" + } + if strings.Contains(uri, "//") { + return uri + } + uri = strings.TrimPrefix(uri, "/") + if !strings.Contains(uri, "/") { + return uri + } + return "https://" + mediaDomain + "/local--files/" + uri +} diff --git a/internal/modules/pagesbytag.go b/internal/modules/pagesbytag.go new file mode 100644 index 00000000..68df126b --- /dev/null +++ b/internal/modules/pagesbytag.go @@ -0,0 +1,62 @@ +package modules + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" +) + +func init() { module.Register("pagesbytag", renderPagesByTag) } + +const defaultTagCategory = "_default" + +func renderPagesByTag(env module.Env, params map[string]string, _ string) (string, error) { + name, ok := params["tag"] + if !ok { + return "", nil + } + categorySlug, tagName := splitTag(name) + category, err := env.Data.TagCategory(categorySlug) + if err != nil { + return "", nil + } + hidden, err := env.Data.HiddenCategories(env.User) + if err != nil { + return "", err + } + articles, err := env.Data.TagArticles(categorySlug, tagName, hidden) + if err != nil { + return "", err + } + + var b strings.Builder + b.WriteString(`` + "\n

") + from := "" + if categorySlug != defaultTagCategory { + from = env.Text("module-pagesbytag-category", "category", ""+escape.HTML(category.Name)+"") + } + b.WriteString(env.Text("module-pagesbytag-heading", + "tag", ""+escape.HTML(tagName)+"", "category", from)) + b.WriteString("

\n " + `
` + "\n ") + for i := range articles { + title := articles[i].Title + if title == "" { + title = articles[i].FullName() + } + b.WriteString("\n " + `
` + + "\n " + `
` + + "\n " + `` + + escape.HTML(title) + "\n
\n
\n ") + } + b.WriteString("\n
") + return b.String(), nil +} + +func splitTag(fullName string) (categorySlug, name string) { + lowered := strings.ToLower(fullName) + if category, rest, found := strings.Cut(lowered, ":"); found { + return category, rest + } + return defaultTagCategory, lowered +} diff --git a/internal/modules/redirect.go b/internal/modules/redirect.go new file mode 100644 index 00000000..8e4d46e6 --- /dev/null +++ b/internal/modules/redirect.go @@ -0,0 +1,41 @@ +package modules + +import ( + "net/url" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/module" +) + +func init() { module.Register("redirect", renderRedirect) } + +func renderRedirect(env module.Env, params map[string]string, _ string) (string, error) { + if module.BoolParam(params, "noredirect", false) { + return "", nil + } + target, err := validateURL(params["destination"]) + if err != nil { + return "", &module.Error{Message: env.Text("module-failed", "name", "redirect")} + } + if env.Page != nil { + env.Page.RedirectTo = target + } + return "", nil +} + +// validateURL keeps out the two schemes that would run as soon as a reader +// followed the link. Everything else, valid or not, is passed through. +func validateURL(raw string) (string, error) { + trimmed := strings.TrimSpace(raw) + parsed, err := url.Parse(trimmed) + if err != nil { + return "", err + } + switch strings.ToLower(parsed.Scheme) { + case "javascript", "data": + return "", errURLScheme + } + return trimmed, nil +} + +var errURLScheme = &module.Error{Message: "url scheme is not allowed"} diff --git a/internal/modules/registry_test.go b/internal/modules/registry_test.go deleted file mode 100644 index 17dd0fb7..00000000 --- a/internal/modules/registry_test.go +++ /dev/null @@ -1,87 +0,0 @@ -package modules - -import "testing" - -func TestRegistryCovers23Modules(t *testing.T) { - if got := len(All()); got != 23 { - t.Errorf("len(All()) = %d, want 23", got) - } -} - -func TestHasContent(t *testing.T) { - tests := []struct { - name string - want bool - }{ - {"countpages", true}, - {"css", true}, - {"listpages", true}, - {"listusers", true}, - {"pagedescription", true}, - {"rate", false}, - {"forumthread", false}, - {"pageimage", false}, - {"tagcloud", false}, - {"nosuchmodule", false}, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - if got := HasContent(tt.name); got != tt.want { - t.Errorf("HasContent(%q) = %v, want %v", tt.name, got, tt.want) - } - }) - } -} - -func TestHasContentIgnoresCaseAndSpace(t *testing.T) { - for _, name := range []string{"CSS", " css ", "Css"} { - t.Run(name, func(t *testing.T) { - if !HasContent(name) { - t.Errorf("HasContent(%q) = false, want true", name) - } - }) - } -} - -func TestRemovedModuleReportsNoContent(t *testing.T) { - info, ok := Lookup("interwiki") - if !ok { - t.Fatal("Lookup(\"interwiki\") ok = false, want true") - } - if !info.Removed { - t.Error("Lookup(\"interwiki\").Removed = false, want true") - } - if !info.HasContent { - t.Error("Lookup(\"interwiki\").HasContent = false, want true") - } - if HasContent("interwiki") { - t.Error("HasContent(\"interwiki\") = true, want false") - } -} - -func TestNothingPortedYet(t *testing.T) { - for _, info := range All() { - if info.Ported { - t.Errorf("Lookup(%q).Ported = true, want false", info.Name) - } - } -} - -func TestAllIsSortedByName(t *testing.T) { - all := All() - for i := 1; i < len(all); i++ { - if all[i-1].Name >= all[i].Name { - t.Errorf("All()[%d].Name = %q, want it sorted before %q", i, all[i].Name, all[i-1].Name) - } - } -} - -func TestRatIsRemoved(t *testing.T) { - info, ok := Lookup("rat") - if !ok { - t.Fatal("Lookup(\"rat\") ok = false, want true") - } - if !info.Removed { - t.Error("Lookup(\"rat\").Removed = false, want true") - } -} diff --git a/internal/repo/modules.go b/internal/repo/modules.go new file mode 100644 index 00000000..82c4ae5a --- /dev/null +++ b/internal/repo/modules.go @@ -0,0 +1,44 @@ +package repo + +import ( + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/perms" +) + +type moduleData struct{ repo *Repository } + +func (m moduleData) TagCategory(slug string) (db.TagCategory, error) { + return m.repo.db.TagCategoryBySlug(m.repo.ctx, slug) +} + +func (m moduleData) TagArticles(categorySlug, name string, hidden []string) ([]db.Article, error) { + return m.repo.db.ArticlesByTag(m.repo.ctx, categorySlug, name, hidden) +} + +// HiddenCategories asks the same question once per category, the way the page +// list does. There is no query for it because permissions are resolved in Go. +func (m moduleData) HiddenCategories(user *db.User) ([]string, error) { + names, err := m.repo.db.CategoryNames(m.repo.ctx) + if err != nil { + return nil, err + } + resolver := NewPerms(m.repo.ctx, m.repo.db) + subject, err := resolver.Subject(user, time.Now()) + if err != nil { + return nil, err + } + + var hidden []string + for _, name := range names { + object, err := resolver.Category(name) + if err != nil { + return nil, err + } + if !perms.Resolve(subject, object).Has(perms.ViewArticles) { + hidden = append(hidden, name) + } + } + return hidden, nil +} diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 40b8abb6..e9dceb94 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -9,6 +9,13 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/callbacks" "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/module" + + // The modules register themselves; without this nothing answers a + // [[module]] and every one of them reads as not ported. + _ "github.com/WikitTeam/ProjectWikit/internal/modules" + "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/printuser" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/wikidot" @@ -20,12 +27,20 @@ type Repository struct { ctx context.Context db *db.DB users *printuser.Renderer + opts Options +} + +// Options is what the modules read besides the database. +type Options struct { + Loc *i18n.Localizer + Site *db.Site + User *db.User } var _ callbacks.Repository = (*Repository)(nil) -func New(ctx context.Context, d *db.DB, users *printuser.Renderer) *Repository { - return &Repository{ctx: ctx, db: d, users: users} +func New(ctx context.Context, d *db.DB, users *printuser.Renderer, opts Options) *Repository { + return &Repository{ctx: ctx, db: d, users: users, opts: opts} } func (r *Repository) PageInfo(refs []string) ([]renderer.PartialPageInfo, error) { @@ -66,8 +81,22 @@ func (r *Repository) IncludeSources(refs []renderer.IncludeRef) ([]renderer.Fetc return out, nil } -func (r *Repository) RenderModule(name string, params map[string]string, body string) (string, error) { - return "", ErrNotPorted +func (r *Repository) RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) { + html, err := module.Render(module.Env{ + Page: pc, + Loc: r.opts.Loc, + Site: r.opts.Site, + User: r.opts.User, + Data: moduleData{repo: r}, + }, name, params, body) + var moduleErr *module.Error + if errors.As(err, &moduleErr) { + return "", &callbacks.ModuleError{Message: moduleErr.Message} + } + if errors.Is(err, module.ErrNotPorted) { + return "", ErrNotPorted + } + return html, err } // RenderUser mirrors the prefix handling in renderer/__init__.py: external: @@ -88,6 +117,11 @@ func (r *Repository) RenderUser(username string, avatar bool) (string, error) { user, err = r.db.UserByWikidotName(r.ctx, wikidot.CanonicalizeUsername(wd)) } else { user, err = r.db.UserByName(r.ctx, wikidot.CanonicalizeUsername(username)) + // An imported account keeps the name it had on the other site, which + // need not fold into the name it is shown under here. + if errors.Is(err, db.ErrNotFound) { + user, err = r.db.UserByDisplayName(r.ctx, username) + } } if errors.Is(err, db.ErrNotFound) { return "", callbacks.ErrUserNotFound diff --git a/internal/repo/repo_test.go b/internal/repo/repo_test.go index 79b07795..80db4965 100644 --- a/internal/repo/repo_test.go +++ b/internal/repo/repo_test.go @@ -31,7 +31,7 @@ func newTestRepo(t *testing.T) *Repository { t.Fatalf("i18n.Load() err = %v, want nil", err) } users := printuser.New(bundle.Localizer(i18n.DefaultLanguage), nil) - return New(context.Background(), d, users) + return New(context.Background(), d, users, Options{}) } func TestPageInfoDropsMissingPages(t *testing.T) { @@ -154,3 +154,30 @@ func TestRenderUserFromTheDatabase(t *testing.T) { t.Errorf("RenderUser() = %q, want it to contain %q", got, `seeduser`) } } + +func TestRenderUserFallsBackToTheDisplayName(t *testing.T) { + r := newTestRepo(t) + + html, err := r.RenderUser("Probe WD", true) + if err != nil { + t.Fatalf("RenderUser(Probe WD) err = %v, want nil", err) + } + if !strings.Contains(html, "wd:Probe WD") { + t.Errorf("RenderUser(Probe WD) = %q, want it to carry %q", html, "wd:Probe WD") + } + if !strings.Contains(html, "wikidot_avatar.png") { + t.Errorf("RenderUser(Probe WD) = %q, want the wikidot avatar", html) + } +} + +func TestRenderUserPrefersTheIdentityName(t *testing.T) { + r := newTestRepo(t) + + html, err := r.RenderUser("probe-author", true) + if err != nil { + t.Fatalf("RenderUser(probe-author) err = %v, want nil", err) + } + if strings.Contains(html, "wd:") { + t.Errorf("RenderUser(probe-author) = %q, want the local account", html) + } +} From 17858827a39ec22704a6815f31e3e555964aa956 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 14:57:24 +0900 Subject: [PATCH 059/428] check the modules through the dispatch they go out by --- internal/module/render_test.go | 229 +++++++++++++++++++++++++++++++++ 1 file changed, 229 insertions(+) create mode 100644 internal/module/render_test.go diff --git a/internal/module/render_test.go b/internal/module/render_test.go new file mode 100644 index 00000000..84d2e07a --- /dev/null +++ b/internal/module/render_test.go @@ -0,0 +1,229 @@ +package module_test + +import ( + "errors" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + _ "github.com/WikitTeam/ProjectWikit/internal/modules" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +type fakeData struct { + category db.TagCategory + articles []db.Article + hidden []string + err error +} + +func (f fakeData) TagCategory(string) (db.TagCategory, error) { return f.category, f.err } + +func (f fakeData) TagArticles(string, string, []string) ([]db.Article, error) { + return f.articles, f.err +} + +func (f fakeData) HiddenCategories(*db.User) ([]string, error) { return f.hidden, f.err } + +func TestEveryPortedModuleAnswers(t *testing.T) { + ported := []string{"pagedescription", "pageimage", "pagesbytag", "redirect"} + for _, name := range ported { + if !module.Ported(name) { + t.Errorf("Ported(%q) = false, want true", name) + } + } + for _, info := range module.All() { + want := false + for _, name := range ported { + if info.Name == name { + want = true + } + } + if module.Ported(info.Name) != want { + t.Errorf("Ported(%q) = %v, want %v", info.Name, module.Ported(info.Name), want) + } + } +} + +func TestRenderRefusesWhenTheUrlSaysSo(t *testing.T) { + ctx := page.NewContext(nil, nil, map[string]string{"nomodule": "true"}, nil) + _, err := module.Render(module.Env{Page: ctx}, "redirect", nil, "") + + var moduleErr *module.Error + if !errors.As(err, &moduleErr) { + t.Fatalf("Render() err = %v, want a module error", err) + } + if moduleErr.Message != "module-disabled" { + t.Errorf("Render() message = %q, want %q", moduleErr.Message, "module-disabled") + } +} + +func TestRenderOfAnUnknownModule(t *testing.T) { + var moduleErr *module.Error + if _, err := module.Render(module.Env{}, "no-such-module", nil, ""); !errors.As(err, &moduleErr) { + t.Fatalf("Render(no-such-module) err = %v, want a module error", err) + } +} + +func TestRenderOfARemovedModule(t *testing.T) { + var moduleErr *module.Error + if _, err := module.Render(module.Env{}, "interwiki", nil, ""); !errors.As(err, &moduleErr) { + t.Fatalf("Render(interwiki) err = %v, want a module error", err) + } +} + +func TestRenderOfAModuleNobodyWroteYet(t *testing.T) { + if _, err := module.Render(module.Env{}, "listpages", nil, ""); !errors.Is(err, module.ErrNotPorted) { + t.Errorf("Render(listpages) err = %v, want ErrNotPorted", err) + } +} + +func TestPathParametersGoUnderTheModulesOwn(t *testing.T) { + ctx := page.NewContext(nil, nil, map[string]string{"destination": "/from-path"}, nil) + if _, err := module.Render(module.Env{Page: ctx}, "redirect", map[string]string{"destination": "/from-module"}, ""); err != nil { + t.Fatalf("Render(redirect) err = %v, want nil", err) + } + if ctx.RedirectTo != "/from-module" { + t.Errorf("RedirectTo = %q, want %q", ctx.RedirectTo, "/from-module") + } +} + +func TestPathParametersReachAModuleThatAskedForNothing(t *testing.T) { + ctx := page.NewContext(nil, nil, map[string]string{"destination": "/from-path"}, nil) + if _, err := module.Render(module.Env{Page: ctx}, "redirect", nil, ""); err != nil { + t.Fatalf("Render(redirect) err = %v, want nil", err) + } + if ctx.RedirectTo != "/from-path" { + t.Errorf("RedirectTo = %q, want %q", ctx.RedirectTo, "/from-path") + } +} + +func TestRedirectSetsTheTarget(t *testing.T) { + ctx := page.NewContext(nil, nil, nil, nil) + if _, err := module.Render(module.Env{Page: ctx}, "redirect", map[string]string{"destination": "/main"}, ""); err != nil { + t.Fatalf("Render(redirect) err = %v, want nil", err) + } + if ctx.RedirectTo != "/main" { + t.Errorf("RedirectTo = %q, want %q", ctx.RedirectTo, "/main") + } +} + +func TestRedirectHonoursNoredirect(t *testing.T) { + ctx := page.NewContext(nil, nil, nil, nil) + params := map[string]string{"destination": "/main", "noredirect": "true"} + if _, err := module.Render(module.Env{Page: ctx}, "redirect", params, ""); err != nil { + t.Fatalf("Render(redirect) err = %v, want nil", err) + } + if ctx.RedirectTo != "" { + t.Errorf("RedirectTo = %q, want %q", ctx.RedirectTo, "") + } +} + +func TestRedirectRefusesARunnableScheme(t *testing.T) { + for _, target := range []string{"javascript:alert(1)", "JavaScript:alert(1)", "data:text/html,x"} { + ctx := page.NewContext(nil, nil, nil, nil) + _, err := module.Render(module.Env{Page: ctx}, "redirect", map[string]string{"destination": target}, "") + + var moduleErr *module.Error + if !errors.As(err, &moduleErr) { + t.Errorf("Render(redirect, %q) err = %v, want a module error", target, err) + } + if ctx.RedirectTo != "" { + t.Errorf("RedirectTo after %q = %q, want %q", target, ctx.RedirectTo, "") + } + } +} + +func TestPageDescriptionOfEmptyBody(t *testing.T) { + ctx := page.NewContext(nil, nil, nil, nil) + if _, err := module.Render(module.Env{Page: ctx}, "pagedescription", nil, ""); err != nil { + t.Fatalf("Render(pagedescription) err = %v, want nil", err) + } + if ctx.OGDescription != "" { + t.Errorf("OGDescription = %q, want %q", ctx.OGDescription, "") + } +} + +func TestPageDescriptionEscapesTheAngleBracket(t *testing.T) { + ctx := page.NewContext(nil, nil, nil, nil) + if _, err := module.Render(module.Env{Page: ctx}, "pagedescription", nil, "a c"); err != nil { + t.Fatalf("Render(pagedescription) err = %v, want nil", err) + } + if !strings.HasPrefix(ctx.OGDescription, "a ") || !strings.HasSuffix(ctx.OGDescription, "b> c") { + t.Errorf("OGDescription = %q, want the angle bracket replaced", ctx.OGDescription) + } + if strings.Contains(ctx.OGDescription, "") { + t.Errorf("OGDescription = %q, want no raw angle bracket", ctx.OGDescription) + } +} + +func TestPageImageResolvesTheSource(t *testing.T) { + cases := []struct{ src, want string }{ + {"probe:full/cover.png", "https://media.example/local--files/probe:full/cover.png"}, + {"/probe:full/cover.png", "https://media.example/local--files/probe:full/cover.png"}, + {"https://example.org/x.png", "https://example.org/x.png"}, + {"cover.png", "cover.png"}, + } + for _, c := range cases { + ctx := page.NewContext(nil, nil, nil, nil) + env := module.Env{Page: ctx, Site: &db.Site{MediaDomain: "media.example"}} + if _, err := module.Render(env, "pageimage", map[string]string{"src": c.src}, ""); err != nil { + t.Fatalf("Render(pageimage, %q) err = %v, want nil", c.src, err) + } + if ctx.OGImage != c.want { + t.Errorf("OGImage after %q = %q, want %q", c.src, ctx.OGImage, c.want) + } + } +} + +func TestPageImageWithoutASource(t *testing.T) { + ctx := page.NewContext(nil, nil, nil, nil) + env := module.Env{Page: ctx, Site: &db.Site{MediaDomain: "media.example"}} + if _, err := module.Render(env, "pageimage", nil, ""); err != nil { + t.Fatalf("Render(pageimage) err = %v, want nil", err) + } + if ctx.OGImage != "" { + t.Errorf("OGImage = %q, want %q", ctx.OGImage, "") + } +} + +func TestPagesByTagWithoutATag(t *testing.T) { + got, err := module.Render(module.Env{Data: fakeData{}}, "pagesbytag", nil, "") + if err != nil { + t.Fatalf("Render(pagesbytag) err = %v, want nil", err) + } + if got != "" { + t.Errorf("Render(pagesbytag) = %q, want %q", got, "") + } +} + +func TestPagesByTagListsTheArticles(t *testing.T) { + data := fakeData{ + category: db.TagCategory{Name: "lang"}, + articles: []db.Article{ + {Category: "_default", Name: "one", Title: "One"}, + {Category: "probe", Name: "two"}, + }, + } + got, err := module.Render(module.Env{Data: data}, "pagesbytag", map[string]string{"tag": "lang:en"}, "") + if err != nil { + t.Fatalf("Render(pagesbytag) err = %v, want nil", err) + } + for _, want := range []string{`One`, `probe:two`, `id="tagged-pages-list"`} { + if !strings.Contains(got, want) { + t.Errorf("Render(pagesbytag) = %q, want it to carry %q", got, want) + } + } +} + +func TestPagesByTagOfTheDefaultCategory(t *testing.T) { + data := fakeData{category: db.TagCategory{Name: "默认"}} + got, err := module.Render(module.Env{Data: data}, "pagesbytag", map[string]string{"tag": "scp"}, "") + if err != nil { + t.Fatalf("Render(pagesbytag) err = %v, want nil", err) + } + if strings.Contains(got, "module-pagesbytag-category") { + t.Errorf("Render(pagesbytag) = %q, want no category clause", got) + } +} From a71a14b22b1383be3cc01ff3e92af6ae9ac16015 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 15:12:07 +0900 Subject: [PATCH 060/428] add the corpus for a pwikit that answers article pages --- internal/difftest/corpus/articles.txt | 33 +++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 internal/difftest/corpus/articles.txt diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt new file mode 100644 index 00000000..66532fd1 --- /dev/null +++ b/internal/difftest/corpus/articles.txt @@ -0,0 +1,33 @@ +# The corpus for a pwikit that answers article pages itself. +# Run it with serve -articles-from-go; the default corpus is for the forwarding shape. +# ! = known to differ; still run and reported, just not failed. + +/probe:bare +/probe:parent +/probe:full +/probe:full/offset/2/bare +/probe:host +/probe:included +/probe:half +/probestars:rated +/component:box +/nav:top +/nav:side +/no-such-page +/this-page-does-not-exist + +/probe:described +/probe:imaged +/probe:tagged +/probe:taggedplain +/probe:unknownmodule +/probe:full/nomodule/true +/probe:redirect + +!/probe:bydisplay +# pwikit resolves [[user ]] and Django does not. deliberate. + +!/main +!/scp-173 +# both carry a module, and modules are not ported yet, so pwikit leaves a gap +# where the widget goes. drop the ! once the modules land. From f159fa0d74009e185c23edffe6693e69b6cda528 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 15:12:07 +0900 Subject: [PATCH 061/428] record the page variables again --- internal/page/corpus_test.go | 2 +- internal/page/testdata/vars.golden | 40 ++++++++++++------------- internal/page/testdata/vars_corpus.json | 2 +- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/internal/page/corpus_test.go b/internal/page/corpus_test.go index 3eb5d73c..42b3e2c5 100644 --- a/internal/page/corpus_test.go +++ b/internal/page/corpus_test.go @@ -34,7 +34,7 @@ type corpusArticle struct { var corpus = varsCorpus{ Articles: []corpusArticle{ - {Name: "probe:full", Viewer: "probeauthor"}, + {Name: "probe:full", Viewer: "probe-author"}, {Name: "probe:full", Viewer: ""}, {Name: "probe:bare", Viewer: ""}, {Name: "probe:parent", Viewer: ""}, diff --git a/internal/page/testdata/vars.golden b/internal/page/testdata/vars.golden index 4c4d6f1e..6a199164 100644 --- a/internal/page/testdata/vars.golden +++ b/internal/page/testdata/vars.golden @@ -28,15 +28,15 @@ True === probe:full created_by [[span]]Probe Author[[/span]] [[span]]wd:Probe WD[[/span]] === probe:full created_by_linked -[[*user probeauthor]] [[*user probewd]] +[[*user probe-author]] [[*user 576c0df3-8a28-4468-9770-ede851d88c67]] === probe:full created_by_linked_plain -[[user probeauthor]] [[user probewd]] +[[user probe-author]] [[user 576c0df3-8a28-4468-9770-ede851d88c67]] === probe:full updated_by Probe Author === probe:full updated_by_linked -[[*user probeauthor]] +[[*user probe-author]] === probe:full updated_by_linked_plain -[[user probeauthor]] +[[user probe-author]] === probe:full authors_count 2 === probe:full tags @@ -105,15 +105,15 @@ False === probe:full created_by [[span]]Probe Author[[/span]] [[span]]wd:Probe WD[[/span]] === probe:full created_by_linked -[[*user probeauthor]] [[*user probewd]] +[[*user probe-author]] [[*user 576c0df3-8a28-4468-9770-ede851d88c67]] === probe:full created_by_linked_plain -[[user probeauthor]] [[user probewd]] +[[user probe-author]] [[user 576c0df3-8a28-4468-9770-ede851d88c67]] === probe:full updated_by Probe Author === probe:full updated_by_linked -[[*user probeauthor]] +[[*user probe-author]] === probe:full updated_by_linked_plain -[[user probeauthor]] +[[user probe-author]] === probe:full authors_count 2 === probe:full tags @@ -257,15 +257,15 @@ False === probe:parent created_by [[span]]Probe Author[[/span]] === probe:parent created_by_linked -[[*user probeauthor]] +[[*user probe-author]] === probe:parent created_by_linked_plain -[[user probeauthor]] +[[user probe-author]] === probe:parent updated_by Probe Author === probe:parent updated_by_linked -[[*user probeauthor]] +[[*user probe-author]] === probe:parent updated_by_linked_plain -[[user probeauthor]] +[[user probe-author]] === probe:parent authors_count 1 === probe:parent tags @@ -333,15 +333,15 @@ True === probestars:rated created_by [[span]]Probe Author[[/span]] === probestars:rated created_by_linked -[[*user probeauthor]] +[[*user probe-author]] === probestars:rated created_by_linked_plain -[[user probeauthor]] +[[user probe-author]] === probestars:rated updated_by Probe Author === probestars:rated updated_by_linked -[[*user probeauthor]] +[[*user probe-author]] === probestars:rated updated_by_linked_plain -[[user probeauthor]] +[[user probe-author]] === probestars:rated authors_count 1 === probestars:rated tags @@ -409,15 +409,15 @@ False === probe:half created_by [[span]]Probe Author[[/span]] === probe:half created_by_linked -[[*user probeauthor]] +[[*user probe-author]] === probe:half created_by_linked_plain -[[user probeauthor]] +[[user probe-author]] === probe:half updated_by Probe Author === probe:half updated_by_linked -[[*user probeauthor]] +[[*user probe-author]] === probe:half updated_by_linked_plain -[[user probeauthor]] +[[user probe-author]] === probe:half authors_count 1 === probe:half tags diff --git a/internal/page/testdata/vars_corpus.json b/internal/page/testdata/vars_corpus.json index 17863387..ce92c05f 100644 --- a/internal/page/testdata/vars_corpus.json +++ b/internal/page/testdata/vars_corpus.json @@ -2,7 +2,7 @@ "articles": [ { "name": "probe:full", - "viewer": "probeauthor" + "viewer": "probe-author" }, { "name": "probe:full", From 449103bf0dee30b2dfe7a53605dd1aee55df8f4a Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 27 Aug 2026 15:12:07 +0900 Subject: [PATCH 062/428] fix --- cmd/pwikit/main.go | 6 +++--- internal/db/db.go | 2 +- internal/db/site.go | 2 +- internal/difftest/corpus_test.go | 2 +- internal/forward/forward.go | 2 +- internal/static/static.go | 4 ++-- internal/wikidot/username.go | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index b7ae0f2d..22ba33f9 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -184,9 +184,9 @@ func listenPort(addr string) string { return port } -// assetFS is the development shape of the bundle. D8 puts it inside the -// binary; until the build produces it, an empty path means every asset -// request falls through to the upstream. +// assetFS is the development shape of the bundle, which ends up inside the +// binary. Until the build produces it, an empty path means every asset request +// falls through to the upstream. func assetFS(dir string) (iofs.FS, error) { if dir == "" { return nil, nil diff --git a/internal/db/db.go b/internal/db/db.go index 7d9d6db1..a0c1f325 100644 --- a/internal/db/db.go +++ b/internal/db/db.go @@ -1,4 +1,4 @@ -// Package db is the only place in pwikit that issues SQL (D5). +// Package db is the only place in pwikit that issues SQL. package db import ( diff --git a/internal/db/site.go b/internal/db/site.go index 2118033d..1270a301 100644 --- a/internal/db/site.go +++ b/internal/db/site.go @@ -29,7 +29,7 @@ LIMIT 1`) // SiteByHosts tries each host in turn and returns the first that matches. // Callers pass site.LookupHosts, whose ordering carries the host:port round -// that has to run before the bare-host one (FINDINGS §13). +// that has to run before the bare-host one. func (d *DB) SiteByHosts(ctx context.Context, hosts []string) (*Site, error) { for _, host := range hosts { var s Site diff --git a/internal/difftest/corpus_test.go b/internal/difftest/corpus_test.go index 7ebc5574..4bde5f5b 100644 --- a/internal/difftest/corpus_test.go +++ b/internal/difftest/corpus_test.go @@ -91,7 +91,7 @@ func TestCorpusDiff(t *testing.T) { } if known > 0 { t.Logf("%d known differences were reported but not failed; "+ - "each one needs a reason in the TODO ledger of PROGRESS.md", known) + "each one needs a recorded reason", known) } } diff --git a/internal/forward/forward.go b/internal/forward/forward.go index 0833c550..b729996e 100644 --- a/internal/forward/forward.go +++ b/internal/forward/forward.go @@ -83,6 +83,6 @@ func (p *Proxy) handleError(w http.ResponseWriter, r *http.Request, err error) { p.log.Error("forward failed", "path", r.URL.Path, "upstream", p.target.String(), "err", err) // The visitor gets the bare status phrase: the upstream address is // internal, and prose here would have to go through i18n in a package - // that ships no user-facing text of its own (D6). + // that ships no user-facing text of its own. http.Error(w, http.StatusText(http.StatusBadGateway), http.StatusBadGateway) } diff --git a/internal/static/static.go b/internal/static/static.go index 3d7b05a3..744b88e2 100644 --- a/internal/static/static.go +++ b/internal/static/static.go @@ -46,8 +46,8 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", contentType(name)) w.Header().Set("Cache-Control", cacheControl) - // Pages on media_domain load these from the other origin (FINDINGS 4.5), - // so the bundle has to be readable cross-origin. + // Pages on media_domain load these from the other origin, so the bundle has + // to be readable cross-origin. w.Header().Set("Access-Control-Allow-Origin", "*") w.Header().Set("ETag", etag(data)) diff --git a/internal/wikidot/username.go b/internal/wikidot/username.go index 79689b19..dbcab8ec 100644 --- a/internal/wikidot/username.go +++ b/internal/wikidot/username.go @@ -9,7 +9,7 @@ import ( // CanonicalizeUsername mirrors canonicalize_username in web/models/users.py. // Unlike Normalize it keeps non-Latin letters, so a Chinese name canonicalizes -// to itself rather than to an empty string (FINDINGS §12). +// to itself rather than to an empty string. // // Python's [\W_]+ is every run that is neither a letter nor a number, because // \W excludes the underscore that the class then adds back. From 73466dbba4af2e7b21a7eb71a8c1f40f5f43ace2 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 28 Aug 2026 20:31:07 +0900 Subject: [PATCH 063/428] give the sidecar a process per render --- internal/renderer/sidecar/sidecar.go | 121 +++++++++++++++++++++------ 1 file changed, 95 insertions(+), 26 deletions(-) diff --git a/internal/renderer/sidecar/sidecar.go b/internal/renderer/sidecar/sidecar.go index 6ff3400d..32728b7f 100644 --- a/internal/renderer/sidecar/sidecar.go +++ b/internal/renderer/sidecar/sidecar.go @@ -18,18 +18,38 @@ const EnvBinary = "PWIKIT_FTML_SIDECAR" const maxMessageBytes = 64 << 20 +// Renderer keeps a pool rather than one process because a module may render +// again while the render that called it is still waiting for an answer. type Renderer struct { - mu sync.Mutex + binary string + + mu sync.Mutex + idle []*session + fixed bool +} + +type session struct { in io.Writer out *bufio.Reader - cmd *exec.Cmd stop func() error } var _ renderer.Renderer = (*Renderer)(nil) +// New starts one process straight away so a wrong path is reported here rather +// than on the first page that needs it. func New(binary string) (*Renderer, error) { - cmd := exec.Command(binary) + r := &Renderer{binary: binary} + first, err := r.start() + if err != nil { + return nil, err + } + r.idle = append(r.idle, first) + return r, nil +} + +func (r *Renderer) start() (*session, error) { + cmd := exec.Command(r.binary) stdin, err := cmd.StdinPipe() if err != nil { return nil, fmt.Errorf("open sidecar stdin: %w", err) @@ -39,13 +59,11 @@ func New(binary string) (*Renderer, error) { return nil, fmt.Errorf("open sidecar stdout: %w", err) } if err := cmd.Start(); err != nil { - return nil, fmt.Errorf("start sidecar %q: %w", binary, err) + return nil, fmt.Errorf("start sidecar %q: %w", r.binary, err) } - - return &Renderer{ + return &session{ in: stdin, out: bufio.NewReader(stdout), - cmd: cmd, stop: func() error { stdin.Close() return cmd.Wait() @@ -53,19 +71,59 @@ func New(binary string) (*Renderer, error) { }, nil } -func newOver(w io.Writer, r io.Reader) *Renderer { - return &Renderer{in: w, out: bufio.NewReader(r), stop: func() error { return nil }} +// The caller owns the pipes, so a render that nests inside another one has to +// wait its turn. +func newOver(w io.Writer, rd io.Reader) *Renderer { + return &Renderer{ + fixed: true, + idle: []*session{{in: w, out: bufio.NewReader(rd), stop: func() error { return nil }}}, + } +} + +func (r *Renderer) acquire() (*session, error) { + r.mu.Lock() + if n := len(r.idle); n > 0 { + s := r.idle[n-1] + r.idle = r.idle[:n-1] + r.mu.Unlock() + return s, nil + } + r.mu.Unlock() + if r.fixed { + return nil, fmt.Errorf("sidecar: nested render has no second process") + } + return r.start() +} + +func (r *Renderer) release(s *session) { + r.mu.Lock() + r.idle = append(r.idle, s) + r.mu.Unlock() +} + +// Retired rather than reused, since the protocol is no longer at a message +// boundary. +func (r *Renderer) drop(s *session) { + if r.fixed { + r.release(s) + return + } + s.stop() } func (r *Renderer) Close() error { r.mu.Lock() - defer r.mu.Unlock() - if r.stop == nil { - return nil + idle := r.idle + r.idle = nil + r.mu.Unlock() + + var err error + for _, s := range idle { + if stopErr := s.stop(); stopErr != nil && err == nil { + err = stopErr + } } - stop := r.stop - r.stop = nil - return stop() + return err } func (r *Renderer) RenderHTML(ctx context.Context, source string, info renderer.PageInfo, cb renderer.Callbacks, mode renderer.Mode) (renderer.Result, error) { @@ -108,8 +166,18 @@ func (r *Renderer) render(ctx context.Context, op, source string, info renderer. return renderer.Result{}, fmt.Errorf("callbacks is nil") } - r.mu.Lock() - defer r.mu.Unlock() + s, err := r.acquire() + if err != nil { + return renderer.Result{}, err + } + done := false + defer func() { + if done { + r.release(s) + return + } + r.drop(s) + }() req := map[string]any{ "type": "render", @@ -118,7 +186,7 @@ func (r *Renderer) render(ctx context.Context, op, source string, info renderer. "source": source, "page_info": encodePageInfo(info), } - if err := r.send(req); err != nil { + if err := s.send(req); err != nil { return renderer.Result{}, err } @@ -128,7 +196,7 @@ func (r *Renderer) render(ctx context.Context, op, source string, info renderer. } var msg wireResult - if err := r.recv(&msg); err != nil { + if err := s.recv(&msg); err != nil { return renderer.Result{}, err } @@ -138,6 +206,7 @@ func (r *Renderer) render(ctx context.Context, op, source string, info renderer. for _, c := range msg.Code { code = append(code, renderer.CodeBlock{Language: c[0], Source: c[1]}) } + done = true return renderer.Result{ Body: msg.Body, IncludedPages: msg.IncludedPages, @@ -154,7 +223,7 @@ func (r *Renderer) render(ctx context.Context, op, source string, info renderer. if err != nil { return renderer.Result{}, err } - if err := r.send(map[string]any{"type": "callback_result", "value": value}); err != nil { + if err := s.send(map[string]any{"type": "callback_result", "value": value}); err != nil { return renderer.Result{}, err } @@ -178,7 +247,7 @@ func marshal(v any) ([]byte, error) { return buf, nil } -func (r *Renderer) send(v any) error { +func (s *session) send(v any) error { buf, err := marshal(v) if err != nil { return fmt.Errorf("encode outbound message: %w", err) @@ -186,18 +255,18 @@ func (r *Renderer) send(v any) error { var head [4]byte binary.BigEndian.PutUint32(head[:], uint32(len(buf))) - if _, err := r.in.Write(head[:]); err != nil { + if _, err := s.in.Write(head[:]); err != nil { return fmt.Errorf("write message length: %w", err) } - if _, err := r.in.Write(buf); err != nil { + if _, err := s.in.Write(buf); err != nil { return fmt.Errorf("write message body: %w", err) } return nil } -func (r *Renderer) recv(v any) error { +func (s *session) recv(v any) error { var head [4]byte - if _, err := io.ReadFull(r.out, head[:]); err != nil { + if _, err := io.ReadFull(s.out, head[:]); err != nil { return fmt.Errorf("read message length: %w", err) } n := binary.BigEndian.Uint32(head[:]) @@ -205,7 +274,7 @@ func (r *Renderer) recv(v any) error { return fmt.Errorf("message length %d exceeds limit %d", n, maxMessageBytes) } buf := make([]byte, n) - if _, err := io.ReadFull(r.out, buf); err != nil { + if _, err := io.ReadFull(s.out, buf); err != nil { return fmt.Errorf("read message body: %w", err) } if err := json.Unmarshal(buf, v); err != nil { From 93972839269970e490a3da3c438c7a8a793c40b9 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 28 Aug 2026 20:31:11 +0900 Subject: [PATCH 064/428] add the queries a page listing needs --- internal/db/listpages.go | 377 ++++++++++++++++++++++++++++++++++ internal/db/listpages_test.go | 112 ++++++++++ internal/db/tag.go | 71 +++++++ internal/db/user.go | 13 ++ 4 files changed, 573 insertions(+) create mode 100644 internal/db/listpages.go create mode 100644 internal/db/listpages_test.go create mode 100644 internal/db/tag.go diff --git a/internal/db/listpages.go b/internal/db/listpages.go new file mode 100644 index 00000000..d96ef678 --- /dev/null +++ b/internal/db/listpages.go @@ -0,0 +1,377 @@ +package db + +import ( + "context" + "fmt" + "strconv" + "strings" + "time" +) + +// Range and ExcludeRange read both ends, the rest read only the end the +// operator names. +type TimeFilter struct { + Op string + Start time.Time + End time.Time +} + +const ( + TimeRange = "range" + TimeExcludeRange = "exclude_range" + TimeLT = "lt" + TimeLTE = "lte" + TimeGT = "gt" + TimeGTE = "gte" +) + +type NumFilter struct { + Op string + Value float64 +} + +const ( + NumEQ = "eq" + NumNE = "ne" + NumLT = "lt" + NumLTE = "lte" + NumGT = "gt" + NumGTE = "gte" +) + +const ( + SortCreatedAt = "created_at" + SortCreatedBy = "created_by" + SortName = "name" + SortTitle = "title" + SortUpdatedAt = "updated_at" + SortFullName = "fullname" + SortRating = "rating" + SortVotes = "votes" + SortPopularity = "popularity" + SortRandom = "random" +) + +type Sort struct { + Column string + Ascending bool +} + +type ListFilter struct { + Hidden []string + + PageType string + Name string + HasName bool + NamePrefix string + HasNamePrefix bool + + NoTags bool + RequiredTags []int64 + PresentTags []int64 + AbsentTags []int64 + ExactTags []int64 + + Categories []string + NotCategories []string + + HasParent bool + ParentID *int64 + HasNotParent bool + NotParentID *int64 + + AuthorID *int64 + + CreatedAt *TimeFilter + + Rating *NumFilter + Votes *NumFilter + Popularity *NumFilter + + RatingMode string + + Sort Sort +} + +const ( + PageTypeNormal = "normal" + PageTypeHidden = "hidden" +) + +type listBuilder struct { + args []any + where []string +} + +func (b *listBuilder) arg(v any) string { + b.args = append(b.args, v) + return "$" + strconv.Itoa(len(b.args)) +} + +// A site that rates nothing still has to sort by something, and Django picks +// the id. +func ratingExpr(mode string) string { + switch mode { + case "updown": + return "COALESCE(v.sum_rate, 0.0)" + case "stars": + return "COALESCE(v.avg_rate, 0.0)" + } + return "a.id" +} + +// The rounding is Postgres' own, which breaks ties away from zero and so does +// not agree with the popularity the page variables compute. +func popularityExpr(mode string) string { + good := "COALESCE(v.good_updown, 0)" + if mode == "stars" { + good = "COALESCE(v.good_stars, 0)" + } + return "CASE WHEN COALESCE(v.num_votes, 0) > 0 THEN ROUND(" + + good + "::float / COALESCE(v.num_votes, 0)::float * 100) ELSE 0 END" +} + +const votesExpr = "COALESCE(v.num_votes, 0)" + +const voteJoin = ` +LEFT JOIN ( + SELECT article_id, + COUNT(*) AS num_votes, + COALESCE(SUM(rate), 0.0) AS sum_rate, + COALESCE(AVG(rate), 0.0) AS avg_rate, + COUNT(*) FILTER (WHERE rate > 0) AS good_updown, + COUNT(*) FILTER (WHERE rate >= 3.0) AS good_stars + FROM web_vote + GROUP BY article_id +) v ON v.article_id = a.id` + +const authorJoin = ` +LEFT JOIN ( + SELECT link.article_id, u.username + FROM web_article_authors link + JOIN web_user u ON u.id = link.user_id +) au ON au.article_id = a.id` + +func (f ListFilter) build(b *listBuilder) string { + if len(f.Hidden) > 0 { + b.where = append(b.where, "NOT (a.category = ANY("+b.arg(f.Hidden)+"))") + } + switch f.PageType { + case PageTypeNormal: + b.where = append(b.where, `a.name NOT LIKE '\_%'`) + case PageTypeHidden: + b.where = append(b.where, `a.name LIKE '\_%'`) + } + if f.HasName { + b.where = append(b.where, "a.name = "+b.arg(f.Name)) + } + if f.HasNamePrefix { + b.where = append(b.where, "a.name LIKE "+b.arg(likePrefix(f.NamePrefix))) + } + if f.NoTags { + b.where = append(b.where, "NOT EXISTS (SELECT 1 FROM web_article_tags t WHERE t.article_id = a.id)") + } + f.buildTags(b) + if len(f.Categories) > 0 { + b.where = append(b.where, "a.category = ANY("+b.arg(f.Categories)+")") + } + if len(f.NotCategories) > 0 { + b.where = append(b.where, "NOT (a.category = ANY("+b.arg(f.NotCategories)+"))") + } + if f.HasParent { + if f.ParentID == nil { + b.where = append(b.where, "a.parent_id IS NULL") + } else { + b.where = append(b.where, "a.parent_id = "+b.arg(*f.ParentID)) + } + } + if f.HasNotParent { + if f.NotParentID == nil { + b.where = append(b.where, "a.parent_id IS NOT NULL") + } else { + b.where = append(b.where, "a.parent_id IS DISTINCT FROM "+b.arg(*f.NotParentID)) + } + } + if f.AuthorID != nil { + b.where = append(b.where, "EXISTS (SELECT 1 FROM web_article_authors au"+ + " WHERE au.article_id = a.id AND au.user_id = "+b.arg(*f.AuthorID)+")") + } + f.buildCreatedAt(b) + f.buildNumbers(b) + + sql := "FROM web_article a" + voteJoin + // Sorting by author multiplies the row rather than picking one of them, so + // a page with two authors is listed twice. + if f.Sort.Column == SortCreatedBy { + sql += authorJoin + } + if len(b.where) > 0 { + sql += "\nWHERE " + strings.Join(b.where, "\n AND ") + } + return sql +} + +func (f ListFilter) buildTags(b *listBuilder) { + hasAll := func(ids []int64) { + if len(ids) == 0 { + return + } + b.where = append(b.where, "(SELECT COUNT(DISTINCT t.tag_id) FROM web_article_tags t"+ + " WHERE t.article_id = a.id AND t.tag_id = ANY("+b.arg(ids)+")) = "+b.arg(len(ids))) + } + hasAll(f.ExactTags) + hasAll(f.RequiredTags) + if len(f.PresentTags) > 0 { + b.where = append(b.where, "EXISTS (SELECT 1 FROM web_article_tags t"+ + " WHERE t.article_id = a.id AND t.tag_id = ANY("+b.arg(f.PresentTags)+"))") + } + if len(f.AbsentTags) > 0 { + b.where = append(b.where, "NOT EXISTS (SELECT 1 FROM web_article_tags t"+ + " WHERE t.article_id = a.id AND t.tag_id = ANY("+b.arg(f.AbsentTags)+"))") + } +} + +func (f ListFilter) buildCreatedAt(b *listBuilder) { + c := f.CreatedAt + if c == nil { + return + } + switch c.Op { + case TimeRange: + b.where = append(b.where, "a.created_at >= "+b.arg(c.Start)+" AND a.created_at <= "+b.arg(c.End)) + case TimeExcludeRange: + b.where = append(b.where, "(a.created_at < "+b.arg(c.Start)+" OR a.created_at > "+b.arg(c.End)+")") + case TimeLT: + b.where = append(b.where, "a.created_at < "+b.arg(c.Start)) + case TimeLTE: + b.where = append(b.where, "a.created_at <= "+b.arg(c.Start)) + case TimeGT: + b.where = append(b.where, "a.created_at > "+b.arg(c.End)) + case TimeGTE: + b.where = append(b.where, "a.created_at >= "+b.arg(c.End)) + } +} + +func (f ListFilter) buildNumbers(b *listBuilder) { + add := func(expr string, n *NumFilter) { + if n == nil { + return + } + arg := b.arg(n.Value) + switch n.Op { + case NumEQ: + b.where = append(b.where, expr+" = "+arg) + case NumNE: + b.where = append(b.where, "NOT ("+expr+" = "+arg+")") + case NumLT: + b.where = append(b.where, expr+" < "+arg) + case NumLTE: + b.where = append(b.where, expr+" <= "+arg) + case NumGT: + b.where = append(b.where, expr+" > "+arg) + case NumGTE: + b.where = append(b.where, expr+" >= "+arg) + } + } + add(ratingExpr(f.RatingMode), f.Rating) + add(votesExpr, f.Votes) + add(popularityExpr(f.RatingMode), f.Popularity) +} + +func likePrefix(prefix string) string { + r := strings.NewReplacer(`\`, `\\`, `%`, `\%`, `_`, `\_`) + return r.Replace(prefix) + "%" +} + +// orderBy puts the sort column in the select list too, which SELECT DISTINCT +// requires of anything it orders by. +func (f ListFilter) orderBy() (expr, extra string) { + direction := " ASC" + if !f.Sort.Ascending { + direction = " DESC" + } + switch f.Sort.Column { + case SortCreatedBy: + return "author_name" + direction, ", au.username AS author_name" + case SortName: + return "a.name" + direction, "" + case SortTitle: + return "a.title" + direction, "" + case SortUpdatedAt: + return "a.updated_at" + direction, "" + case SortFullName: + return "full_name" + direction, ", a.complete_full_name AS full_name" + case SortRating: + return "rating" + direction, ", " + ratingExpr(f.RatingMode) + " AS rating" + case SortVotes: + return "num_votes" + direction, ", " + votesExpr + " AS num_votes" + case SortPopularity: + return "popularity" + direction, ", " + popularityExpr(f.RatingMode) + " AS popularity" + case SortRandom: + return "shuffled", ", RANDOM() AS shuffled" + } + // A column nobody recognises falls back to the newest first, direction and + // all, so asking for one is not the same as asking for created_at. + return "a.created_at DESC", "" +} + +func (f ListFilter) selectSQL(b *listBuilder, offset int, limit *int) string { + body := f.build(b) + order, extra := f.orderBy() + sql := "SELECT DISTINCT " + prefixedArticleColumns + extra + "\n" + body + "\nORDER BY " + order + if limit != nil { + sql += "\nLIMIT " + b.arg(*limit) + } + if offset > 0 { + sql += "\nOFFSET " + b.arg(offset) + } + return sql +} + +// Exposed so the schema-drift test can send a built statement to Postgres the +// way it sends the ones written out by hand. +func (f ListFilter) SelectSQL(offset int, limit *int) (string, []any) { + b := &listBuilder{} + return f.selectSQL(b, offset, limit), b.args +} + +func (d *DB) ListArticles(ctx context.Context, f ListFilter, offset int, limit *int) ([]Article, error) { + b := &listBuilder{} + sql := f.selectSQL(b, offset, limit) + + rows, err := d.pool.Query(ctx, sql, b.args...) + if err != nil { + return nil, fmt.Errorf("query listed articles: %w", err) + } + defer rows.Close() + + var out []Article + for rows.Next() { + var a Article + dest := []any{&a.ID, &a.Category, &a.Name, &a.Title, &a.ParentID, + &a.Locked, &a.CreatedAt, &a.UpdatedAt, &a.MediaName} + for i := len(dest); i < len(rows.FieldDescriptions()); i++ { + dest = append(dest, new(any)) + } + if err := rows.Scan(dest...); err != nil { + return nil, fmt.Errorf("scan listed article: %w", err) + } + out = append(out, a) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read listed articles: %w", err) + } + return out, nil +} + +// Counted before pagination narrows it, so offset and limit still apply. +func (d *DB) CountArticles(ctx context.Context, f ListFilter, offset int, limit *int) (int, error) { + b := &listBuilder{} + inner := f.selectSQL(b, offset, limit) + + var n int + if err := d.pool.QueryRow(ctx, "SELECT COUNT(*) FROM ("+inner+") sub", b.args...).Scan(&n); err != nil { + return 0, fmt.Errorf("count listed articles: %w", err) + } + return n, nil +} diff --git a/internal/db/listpages_test.go b/internal/db/listpages_test.go new file mode 100644 index 00000000..2a0b9be5 --- /dev/null +++ b/internal/db/listpages_test.go @@ -0,0 +1,112 @@ +package db + +import ( + "context" + "strconv" + "strings" + "testing" + "time" +) + +func int64s(v ...int64) []int64 { return v } + +// listFilterVariants covers every branch that puts SQL together, since a +// generated statement escapes the check the registered ones go through. +func listFilterVariants() map[string]ListFilter { + parent := int64(3) + return map[string]ListFilter{ + "empty": {}, + "hidden": {Hidden: []string{"admin"}}, + "normal-pages": {PageType: PageTypeNormal}, + "hidden-pages": {PageType: PageTypeHidden}, + "name": {Name: "main", HasName: true}, + "name-prefix": {NamePrefix: "scp-", HasNamePrefix: true}, + "no-tags": {NoTags: true}, + "exact-tags": {ExactTags: int64s(1, 2)}, + "required-tags": {RequiredTags: int64s(1, 2)}, + "present-tags": {PresentTags: int64s(3)}, + "absent-tags": {AbsentTags: int64s(4)}, + "categories": {Categories: []string{"scp"}, NotCategories: []string{"meta"}}, + "no-parent": {HasParent: true}, + "parent": {HasParent: true, ParentID: &parent}, + "not-parent": {HasNotParent: true, NotParentID: &parent}, + "any-parent": {HasNotParent: true}, + "author": {AuthorID: &parent}, + "created-range": {CreatedAt: &TimeFilter{Op: TimeRange, Start: time.Unix(0, 0), End: time.Unix(1, 0)}}, + "created-out": {CreatedAt: &TimeFilter{Op: TimeExcludeRange, Start: time.Unix(0, 0), End: time.Unix(1, 0)}}, + "created-lt": {CreatedAt: &TimeFilter{Op: TimeLT, Start: time.Unix(0, 0)}}, + "created-lte": {CreatedAt: &TimeFilter{Op: TimeLTE, Start: time.Unix(0, 0)}}, + "created-gt": {CreatedAt: &TimeFilter{Op: TimeGT, End: time.Unix(0, 0)}}, + "created-gte": {CreatedAt: &TimeFilter{Op: TimeGTE, End: time.Unix(0, 0)}}, + "rating-updown": {RatingMode: "updown", Rating: &NumFilter{Op: NumGTE, Value: 3}}, + "rating-stars": {RatingMode: "stars", Rating: &NumFilter{Op: NumLT, Value: 3}}, + "rating-off": {RatingMode: "disabled", Rating: &NumFilter{Op: NumNE, Value: 0}}, + "votes": {Votes: &NumFilter{Op: NumEQ, Value: 2}}, + "popularity": {RatingMode: "updown", Popularity: &NumFilter{Op: NumGT, Value: 50}}, + "sort-created": {Sort: Sort{Column: SortCreatedAt}}, + "sort-author": {Sort: Sort{Column: SortCreatedBy, Ascending: true}}, + "sort-name": {Sort: Sort{Column: SortName, Ascending: true}}, + "sort-title": {Sort: Sort{Column: SortTitle}}, + "sort-updated": {Sort: Sort{Column: SortUpdatedAt}}, + "sort-fullname": {Sort: Sort{Column: SortFullName}}, + "sort-rating": {RatingMode: "stars", Sort: Sort{Column: SortRating}}, + "sort-votes": {Sort: Sort{Column: SortVotes}}, + "sort-pop": {RatingMode: "updown", Sort: Sort{Column: SortPopularity}}, + "sort-random": {Sort: Sort{Column: SortRandom}}, + } +} + +// TestListFilterSQLMatchesSchema sends every shape the builder can produce to +// Postgres. The registered statements get this from TestQueriesMatchSchema, and +// without it the built ones would only fail on a page load. +func TestListFilterSQLMatchesSchema(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + limit := 20 + + for name, filter := range listFilterVariants() { + for _, window := range []struct { + label string + offset int + limit *int + }{{"plain", 0, nil}, {"windowed", 5, &limit}} { + if _, err := d.ListArticles(ctx, filter, window.offset, window.limit); err != nil { + t.Errorf("ListArticles(%s, %s) err = %v, want nil", name, window.label, err) + } + if _, err := d.CountArticles(ctx, filter, window.offset, window.limit); err != nil { + t.Errorf("CountArticles(%s, %s) err = %v, want nil", name, window.label, err) + } + } + } +} + +func TestLikePrefixEscapesWildcards(t *testing.T) { + cases := map[string]string{ + "scp-": "scp-%", + "a_b": `a\_b%`, + "a%b": `a\%b%`, + `a\b`: `a\\b%`, + "": "%", + } + for in, want := range cases { + if got := likePrefix(in); got != want { + t.Errorf("likePrefix(%q) = %q, want %q", in, got, want) + } + } +} + +func TestSelectSQLNamesEveryArgument(t *testing.T) { + for name, filter := range listFilterVariants() { + limit := 10 + sql, args := filter.SelectSQL(3, &limit) + for i := range args { + if !strings.Contains(sql, placeholder(i+1)) { + t.Errorf("SelectSQL(%s) leaves %s unused", name, placeholder(i+1)) + } + } + } +} + +func placeholder(n int) string { + return "$" + strconv.Itoa(n) +} diff --git a/internal/db/tag.go b/internal/db/tag.go new file mode 100644 index 00000000..29100f24 --- /dev/null +++ b/internal/db/tag.go @@ -0,0 +1,71 @@ +package db + +import ( + "context" + "fmt" +) + +var qTagIDsByName = register("TagIDsByName", ` +SELECT t.id +FROM web_tag t +JOIN web_tagscategory c ON c.id = t.category_id +WHERE c.slug = $1 AND t.name = $2 +ORDER BY t.id`) + +var qTagIDsByBareName = register("TagIDsByBareName", ` +SELECT id +FROM web_tag +WHERE name = $1 +ORDER BY id`) + +func (d *DB) TagIDsByName(ctx context.Context, categorySlug, name string) ([]int64, error) { + sql, args := qTagIDsByBareName, []any{name} + if categorySlug != "" { + sql, args = qTagIDsByName, []any{categorySlug, name} + } + rows, err := d.pool.Query(ctx, sql, args...) + if err != nil { + return nil, fmt.Errorf("query tag %q: %w", name, err) + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + return nil, fmt.Errorf("scan tag %q: %w", name, err) + } + out = append(out, id) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read tag %q: %w", name, err) + } + return out, nil +} + +var qArticleTagIDs = register("ArticleTagIDs", ` +SELECT tag_id +FROM web_article_tags +WHERE article_id = $1 +ORDER BY tag_id`) + +func (d *DB) ArticleTagIDs(ctx context.Context, articleID int64) ([]int64, error) { + rows, err := d.pool.Query(ctx, qArticleTagIDs, articleID) + if err != nil { + return nil, fmt.Errorf("query tags of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + return nil, fmt.Errorf("scan tag of article %d: %w", articleID, err) + } + out = append(out, id) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read tags of article %d: %w", articleID, err) + } + return out, nil +} diff --git a/internal/db/user.go b/internal/db/user.go index 3a4f7ffa..1c070bc7 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -85,6 +85,19 @@ func (d *DB) UserByName(ctx context.Context, canonical string) (*User, error) { return d.scanUser(ctx, qUserByName, canonical) } +var qUserByUsername = register("UserByUsername", ` +SELECT `+userColumns+` +FROM web_user +WHERE username = $1 +ORDER BY id +LIMIT 1`) + +// A page list that filters by author names the account as it is spelled here, +// never as it was on the site an imported account came from. +func (d *DB) UserByUsername(ctx context.Context, name string) (*User, error) { + return d.scanUser(ctx, qUserByUsername, name) +} + var qUserByDisplayName = register("UserByDisplayName", ` SELECT `+userColumns+` FROM web_user From 891748bdc30967bf113f28349c54208966f7f5eb Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 28 Aug 2026 20:31:24 +0900 Subject: [PATCH 065/428] hand modules the path in the order the url gave --- internal/article/params_test.go | 2 +- internal/article/path.go | 45 ++++----------------------------- internal/articlepage/build.go | 2 +- internal/articlepage/render.go | 34 ++++++++++++++++--------- internal/module/module.go | 36 +++++++++++++------------- internal/module/render_test.go | 36 +++++++++++++++++++++----- internal/modules/pagesbytag.go | 2 +- internal/modules/pathparams.go | 33 ++++++++++++++++++++++++ internal/modules/redirect.go | 1 + internal/page/context.go | 12 ++++----- internal/page/context_test.go | 3 --- internal/page/path.go | 40 +++++++++++++++++++++++++++++ internal/repo/modules.go | 43 +++++++++++++++++++++++++++++++ internal/repo/repo.go | 17 +++++++++---- 14 files changed, 214 insertions(+), 92 deletions(-) create mode 100644 internal/modules/pathparams.go create mode 100644 internal/page/path.go diff --git a/internal/article/params_test.go b/internal/article/params_test.go index 1808329d..a6f3aaf8 100644 --- a/internal/article/params_test.go +++ b/internal/article/params_test.go @@ -85,7 +85,7 @@ func TestParamsGetAnswersEmptyForMissingKey(t *testing.T) { func TestParamsEncodeKeepsOnlyOneBareKey(t *testing.T) { params := Params{{Key: "z", Value: "1"}, {Key: "first", Bare: true}, {Key: "a", Value: "2"}, {Key: "second", Bare: true}} - if got, want := params.Encode(), "/a/2/z/1/first"; got != want { + if got, want := Encode(params), "/a/2/z/1/first"; got != want { t.Errorf("Encode() = %q, want %q", got, want) } } diff --git a/internal/article/path.go b/internal/article/path.go index bc474cf4..02ab523b 100644 --- a/internal/article/path.go +++ b/internal/article/path.go @@ -14,18 +14,9 @@ import ( const defaultHomePage = "main" -// Param is one key/value pair out of the path. A trailing key with nothing -// after it arrives Bare, which the substitutions answer differently from a key -// whose value is the empty string. -type Param struct { - Key string - Value string - Bare bool -} +type Param = page.PathParam -// Params keeps the order the path gave, which decides which bare key the -// redirect target carries. -type Params []Param +type Params = page.PathParams var ( forumStart = regexp.MustCompile(`^forum/start(.*)$`) @@ -58,7 +49,7 @@ func ParsePath(raw, homePage string) (string, Params) { if key == "" && value == "" { continue } - params = params.put(Param{Key: key, Value: value, Bare: bare}) + params = params.Put(Param{Key: key, Value: value, Bare: bare}) } return name, params } @@ -84,35 +75,9 @@ func rewriteForum(path string) string { // put keeps the position of the first occurrence, the way assigning to a // Python dict does. -func (p Params) put(param Param) Params { - for i := range p { - if p[i].Key == param.Key { - p[i] = param - return p - } - } - return append(p, param) -} - -func (p Params) Lookup(key string) (Param, bool) { - for _, param := range p { - if param.Key == key { - return param, true - } - } - return Param{}, false -} - -// Get answers the empty string for a key that is missing and for one that -// carries no value, which is what reading a Python dict of these gives. -func (p Params) Get(key string) string { - param, _ := p.Lookup(key) - return param.Value -} - // Encode writes the parameters back as a path, sorted by key. Only the values // are escaped, and only the first bare key survives. -func (p Params) Encode() string { +func Encode(p Params) string { var named []Param bare := "" hasBare := false @@ -147,7 +112,7 @@ func RedirectTarget(name string, params Params) (target string, ok bool) { } // Escaped once more on the way out because Encode leaves the keys alone, // and a key may hold anything the path did. - return iriToURI("/" + normalized + params.Encode()), true + return iriToURI("/" + normalized + Encode(params)), true } // iriSafe is what Django leaves alone when it writes a Location, on top of the diff --git a/internal/articlepage/build.go b/internal/articlepage/build.go index 0ec222bc..ae7eef01 100644 --- a/internal/articlepage/build.go +++ b/internal/articlepage/build.go @@ -52,7 +52,7 @@ func (h *Handler) build(r *http.Request) (*result, error) { user: auth.FromContext(ctx), } req.name, req.params = article.ParsePath(strings.TrimPrefix(r.URL.EscapedPath(), "/"), found.HomePage) - req.encoded = req.params.Encode() + req.encoded = article.Encode(req.params) if target, ok := article.RedirectTarget(req.name, req.params); ok { return &result{Status: http.StatusFound, Location: target}, nil diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index e66748dc..950379fa 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -134,15 +134,7 @@ func (h *Handler) articleBody(req *request, canonical string) (body, error) { } func (h *Handler) context(req *request, source *db.Article) *page.Context { - return page.NewContext(req.article, source, paramsMap(req.params), req.user) -} - -func paramsMap(params article.Params) map[string]string { - out := make(map[string]string, len(params)) - for _, param := range params { - out[param.Key] = param.Value - } - return out + return page.NewContext(req.article, source, req.params, req.user) } // A page named _template is its own content, which is what keeps the template @@ -231,9 +223,11 @@ func (h *Handler) nav(req *request, name string) (string, string, error) { func (h *Handler) callbacks(req *request, vars *page.Vars, pc *page.Context) *callbacks.Callbacks { users := printuser.New(req.loc, h.deps.Icons) store := repo.New(req.ctx, h.deps.DB, users, repo.Options{ - Loc: req.loc, - Site: req.site, - User: req.user, + Loc: req.loc, + Site: req.site, + User: req.user, + Render: func(source string, into *page.Context) (string, error) { return h.nested(req, source, into) }, + Vars: repo.NewVarSource(req.ctx, h.deps.DB, req.site.ID), }) cb := callbacks.New(req.loc, store) cb.SetPageVars(vars) @@ -241,6 +235,22 @@ func (h *Handler) callbacks(req *request, vars *page.Vars, pc *page.Context) *ca return cb } +// The page it renders against is the one the module put in the context, which +// for a listing is the row and not the page the listing sits on. +func (h *Handler) nested(req *request, source string, pc *page.Context) (string, error) { + vars := h.vars(req, pc.Article) + info, err := h.pageInfo(req, pc.SourceArticle) + if err != nil { + return "", err + } + html, err := h.deps.Engine.RenderHTML(req.ctx, page.ThisVars(source, vars), info, + h.callbacks(req, vars, pc), renderer.ModeArticle) + if err != nil { + return "", err + } + return html.Body, nil +} + func (h *Handler) vars(req *request, of *db.Article) *page.Vars { if of == nil { return nil diff --git a/internal/module/module.go b/internal/module/module.go index 2987a09e..acbfced2 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -25,6 +25,16 @@ type Data interface { TagArticles(categorySlug, name string, hiddenCategories []string) ([]db.Article, error) TagCategory(slug string) (db.TagCategory, error) HiddenCategories(user *db.User) ([]string, error) + TagIDsByName(categorySlug, name string) ([]int64, error) + ArticleTagIDs(articleID int64) ([]int64, error) + ArticleByRef(ref string) (*db.Article, error) + UserByUsername(name string) (*db.User, error) + UserByWikidotName(name string) (*db.User, error) + SiteRatingMode() (string, error) + CategoryRatingMode(category string) (string, error) + VoteStats(articleID int64) (db.VoteStats, error) + ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) + CountArticles(f db.ListFilter, offset int, limit *int) (int, error) } type Env struct { @@ -33,6 +43,11 @@ type Env struct { Site *db.Site User *db.User Data Data + + // Render runs the wikitext a module produced through ftml. A module that + // lists pages has to, since what it writes is source and not markup. + Render func(source string, pc *page.Context) (string, error) + Vars page.VarSource } func (e Env) Text(id string, args ...any) string { @@ -62,10 +77,10 @@ func Register(name string, r Renderer) { renderers[name] = r } -// Render answers one [[module]]. The page's own parameters go underneath the -// module's own, which is what lets a URL override what the page asked for. +// The path parameters are not folded in here, since the modules that want +// them disagree on which side wins. func Render(env Env, name string, params map[string]string, body string) (string, error) { - if env.Page != nil && env.Page.PathParams["nomodule"] == "true" { + if env.Page != nil && env.Page.PathParams.Get("nomodule") == "true" { return "", &Error{Message: env.Text("module-disabled")} } info, ok := Lookup(name) @@ -76,20 +91,7 @@ func Render(env Env, name string, params map[string]string, body string) (string if !ok { return "", ErrNotPorted } - return render(env, merge(env.Page, params), body) -} - -func merge(ctx *page.Context, params map[string]string) map[string]string { - out := make(map[string]string, len(params)) - if ctx != nil { - for key, value := range ctx.PathParams { - out[key] = value - } - } - for key, value := range params { - out[key] = value - } - return out + return render(env, params, body) } // BoolParam is get_boolean_param, where anything the list does not name reads diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 84d2e07a..3adaf45f 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -26,8 +26,32 @@ func (f fakeData) TagArticles(string, string, []string) ([]db.Article, error) { func (f fakeData) HiddenCategories(*db.User) ([]string, error) { return f.hidden, f.err } +func (f fakeData) TagIDsByName(string, string) ([]int64, error) { return nil, f.err } + +func (f fakeData) ArticleTagIDs(int64) ([]int64, error) { return nil, f.err } + +func (f fakeData) ArticleByRef(string) (*db.Article, error) { return nil, db.ErrNotFound } + +func (f fakeData) UserByUsername(string) (*db.User, error) { return nil, db.ErrNotFound } + +func (f fakeData) UserByWikidotName(string) (*db.User, error) { return nil, db.ErrNotFound } + +func (f fakeData) SiteRatingMode() (string, error) { return "", db.ErrNotFound } + +func (f fakeData) CategoryRatingMode(string) (string, error) { return "", db.ErrNotFound } + +func (f fakeData) VoteStats(int64) (db.VoteStats, error) { return db.VoteStats{}, f.err } + +func (f fakeData) ListArticles(db.ListFilter, int, *int) ([]db.Article, error) { + return f.articles, f.err +} + +func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { + return len(f.articles), f.err +} + func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"pagedescription", "pageimage", "pagesbytag", "redirect"} + ported := []string{"listpages", "pagedescription", "pageimage", "pagesbytag", "redirect"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) @@ -47,7 +71,7 @@ func TestEveryPortedModuleAnswers(t *testing.T) { } func TestRenderRefusesWhenTheUrlSaysSo(t *testing.T) { - ctx := page.NewContext(nil, nil, map[string]string{"nomodule": "true"}, nil) + ctx := page.NewContext(nil, nil, page.PathParams{{Key: "nomodule", Value: "true"}}, nil) _, err := module.Render(module.Env{Page: ctx}, "redirect", nil, "") var moduleErr *module.Error @@ -74,13 +98,13 @@ func TestRenderOfARemovedModule(t *testing.T) { } func TestRenderOfAModuleNobodyWroteYet(t *testing.T) { - if _, err := module.Render(module.Env{}, "listpages", nil, ""); !errors.Is(err, module.ErrNotPorted) { - t.Errorf("Render(listpages) err = %v, want ErrNotPorted", err) + if _, err := module.Render(module.Env{}, "rate", nil, ""); !errors.Is(err, module.ErrNotPorted) { + t.Errorf("Render(rate) err = %v, want ErrNotPorted", err) } } func TestPathParametersGoUnderTheModulesOwn(t *testing.T) { - ctx := page.NewContext(nil, nil, map[string]string{"destination": "/from-path"}, nil) + ctx := page.NewContext(nil, nil, page.PathParams{{Key: "destination", Value: "/from-path"}}, nil) if _, err := module.Render(module.Env{Page: ctx}, "redirect", map[string]string{"destination": "/from-module"}, ""); err != nil { t.Fatalf("Render(redirect) err = %v, want nil", err) } @@ -90,7 +114,7 @@ func TestPathParametersGoUnderTheModulesOwn(t *testing.T) { } func TestPathParametersReachAModuleThatAskedForNothing(t *testing.T) { - ctx := page.NewContext(nil, nil, map[string]string{"destination": "/from-path"}, nil) + ctx := page.NewContext(nil, nil, page.PathParams{{Key: "destination", Value: "/from-path"}}, nil) if _, err := module.Render(module.Env{Page: ctx}, "redirect", nil, ""); err != nil { t.Fatalf("Render(redirect) err = %v, want nil", err) } diff --git a/internal/modules/pagesbytag.go b/internal/modules/pagesbytag.go index 68df126b..f0c1fdbe 100644 --- a/internal/modules/pagesbytag.go +++ b/internal/modules/pagesbytag.go @@ -12,7 +12,7 @@ func init() { module.Register("pagesbytag", renderPagesByTag) } const defaultTagCategory = "_default" func renderPagesByTag(env module.Env, params map[string]string, _ string) (string, error) { - name, ok := params["tag"] + name, ok := pathOver(env, params)["tag"] if !ok { return "", nil } diff --git a/internal/modules/pathparams.go b/internal/modules/pathparams.go new file mode 100644 index 00000000..9eed69e6 --- /dev/null +++ b/internal/modules/pathparams.go @@ -0,0 +1,33 @@ +package modules + +import "github.com/WikitTeam/ProjectWikit/internal/module" + +// pathUnder puts the path parameters underneath the module's own, so what the +// page wrote wins over what the reader appended to the URL. +func pathUnder(env module.Env, params map[string]string) map[string]string { + out := make(map[string]string, len(params)) + if env.Page != nil { + for _, param := range env.Page.PathParams { + out[param.Key] = param.Value + } + } + for key, value := range params { + out[key] = value + } + return out +} + +// pathOver lets the path parameters replace the module's own. Only pagesbytag +// reads them this way round. +func pathOver(env module.Env, params map[string]string) map[string]string { + out := make(map[string]string, len(params)) + for key, value := range params { + out[key] = value + } + if env.Page != nil { + for _, param := range env.Page.PathParams { + out[param.Key] = param.Value + } + } + return out +} diff --git a/internal/modules/redirect.go b/internal/modules/redirect.go index 8e4d46e6..b0dfbd6e 100644 --- a/internal/modules/redirect.go +++ b/internal/modules/redirect.go @@ -10,6 +10,7 @@ import ( func init() { module.Register("redirect", renderRedirect) } func renderRedirect(env module.Env, params map[string]string, _ string) (string, error) { + params = pathUnder(env, params) if module.BoolParam(params, "noredirect", false) { return "", nil } diff --git a/internal/page/context.go b/internal/page/context.go index fac4b1f5..f21063ae 100644 --- a/internal/page/context.go +++ b/internal/page/context.go @@ -12,20 +12,22 @@ import ( type Context struct { Article *db.Article SourceArticle *db.Article - PathParams map[string]string + PathParams PathParams User *db.User Title string Status int RedirectTo string + Depth int + AddCSS string ComputedStyle string OGDescription string OGImage string } -func NewContext(article, sourceArticle *db.Article, pathParams map[string]string, user *db.User) *Context { +func NewContext(article, sourceArticle *db.Article, pathParams PathParams, user *db.User) *Context { c := &Context{ Article: article, SourceArticle: sourceArticle, @@ -33,9 +35,6 @@ func NewContext(article, sourceArticle *db.Article, pathParams map[string]string User: user, Status: http.StatusOK, } - if pathParams == nil { - c.PathParams = map[string]string{} - } if article != nil { c.Title = article.Title } @@ -45,8 +44,9 @@ func NewContext(article, sourceArticle *db.Article, pathParams map[string]string // CloneWith starts a nested render. Only the three fields listed carry over: // the styles and the Open Graph fields belong to the page that produced them, // and Merge is what brings the styles back. -func (c *Context) CloneWith(article, sourceArticle *db.Article, pathParams map[string]string, user *db.User) *Context { +func (c *Context) CloneWith(article, sourceArticle *db.Article, pathParams PathParams, user *db.User) *Context { clone := NewContext(article, sourceArticle, pathParams, user) + clone.Depth = c.Depth + 1 clone.Status = c.Status clone.RedirectTo = c.RedirectTo clone.Title = c.Title diff --git a/internal/page/context_test.go b/internal/page/context_test.go index 5a734c43..d1b47b55 100644 --- a/internal/page/context_test.go +++ b/internal/page/context_test.go @@ -20,9 +20,6 @@ func TestNewContextDefaults(t *testing.T) { if c.Title != "Main Page" { t.Errorf("NewContext(...).Title = %q, want %q", c.Title, "Main Page") } - if c.PathParams == nil { - t.Error("NewContext(..., nil, ...).PathParams = nil, want an empty map") - } if c.RedirectTo != "" { t.Errorf("NewContext(...).RedirectTo = %q, want %q", c.RedirectTo, "") } diff --git a/internal/page/path.go b/internal/page/path.go new file mode 100644 index 00000000..21cfa43f --- /dev/null +++ b/internal/page/path.go @@ -0,0 +1,40 @@ +package page + +// A trailing key with nothing after it arrives Bare, which the substitutions +// answer differently from a key whose value is the empty string. +type PathParam struct { + Key string + Value string + Bare bool +} + +type PathParams []PathParam + +func (p PathParams) Lookup(key string) (PathParam, bool) { + for _, param := range p { + if param.Key == key { + return param, true + } + } + return PathParam{}, false +} + +func (p PathParams) Get(key string) string { + param, _ := p.Lookup(key) + return param.Value +} + +func (p PathParams) Has(key string) bool { + _, ok := p.Lookup(key) + return ok +} + +func (p PathParams) Put(param PathParam) PathParams { + for i := range p { + if p[i].Key == param.Key { + p[i] = param + return p + } + } + return append(p, param) +} diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 82c4ae5a..79e6bec5 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -42,3 +42,46 @@ func (m moduleData) HiddenCategories(user *db.User) ([]string, error) { } return hidden, nil } + +func (m moduleData) TagIDsByName(categorySlug, name string) ([]int64, error) { + return m.repo.db.TagIDsByName(m.repo.ctx, categorySlug, name) +} + +func (m moduleData) ArticleTagIDs(articleID int64) ([]int64, error) { + return m.repo.db.ArticleTagIDs(m.repo.ctx, articleID) +} + +func (m moduleData) ArticleByRef(ref string) (*db.Article, error) { + return m.repo.db.ArticleByName(m.repo.ctx, ref) +} + +func (m moduleData) UserByUsername(name string) (*db.User, error) { + return m.repo.db.UserByUsername(m.repo.ctx, name) +} + +func (m moduleData) UserByWikidotName(name string) (*db.User, error) { + return m.repo.db.UserByWikidotName(m.repo.ctx, name) +} + +func (m moduleData) SiteRatingMode() (string, error) { + if m.repo.opts.Site == nil { + return "", db.ErrNotFound + } + return m.repo.db.SiteRatingMode(m.repo.ctx, m.repo.opts.Site.ID) +} + +func (m moduleData) CategoryRatingMode(category string) (string, error) { + return m.repo.db.CategoryRatingMode(m.repo.ctx, category) +} + +func (m moduleData) VoteStats(articleID int64) (db.VoteStats, error) { + return m.repo.db.VoteStats(m.repo.ctx, articleID) +} + +func (m moduleData) ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) { + return m.repo.db.ListArticles(m.repo.ctx, f, offset, limit) +} + +func (m moduleData) CountArticles(f db.ListFilter, offset int, limit *int) (int, error) { + return m.repo.db.CountArticles(m.repo.ctx, f, offset, limit) +} diff --git a/internal/repo/repo.go b/internal/repo/repo.go index e9dceb94..0c4d67d2 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -35,6 +35,11 @@ type Options struct { Loc *i18n.Localizer Site *db.Site User *db.User + + // Render is how a module runs the wikitext it produced. The engine is not + // reachable from here, so the caller that owns it supplies this. + Render func(source string, pc *page.Context) (string, error) + Vars page.VarSource } var _ callbacks.Repository = (*Repository)(nil) @@ -83,11 +88,13 @@ func (r *Repository) IncludeSources(refs []renderer.IncludeRef) ([]renderer.Fetc func (r *Repository) RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) { html, err := module.Render(module.Env{ - Page: pc, - Loc: r.opts.Loc, - Site: r.opts.Site, - User: r.opts.User, - Data: moduleData{repo: r}, + Page: pc, + Loc: r.opts.Loc, + Site: r.opts.Site, + User: r.opts.User, + Data: moduleData{repo: r}, + Render: r.opts.Render, + Vars: r.opts.Vars, }, name, params, body) var moduleErr *module.Error if errors.As(err, &moduleErr) { From b90e8eecec0239afff595193d19f5b28de8ed917 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 28 Aug 2026 20:31:33 +0900 Subject: [PATCH 066/428] parse what a listpages module was given --- internal/listpages/params.go | 689 ++++++ internal/listpages/params_db_test.go | 338 +++ internal/listpages/params_test.go | 581 +++++ internal/listpages/testdata/oracle_params.py | 127 ++ internal/listpages/testdata/params.golden | 2002 +++++++++++++++++ .../listpages/testdata/params_corpus.json | 763 +++++++ 6 files changed, 4500 insertions(+) create mode 100644 internal/listpages/params.go create mode 100644 internal/listpages/params_db_test.go create mode 100644 internal/listpages/params_test.go create mode 100644 internal/listpages/testdata/oracle_params.py create mode 100644 internal/listpages/testdata/params.golden create mode 100644 internal/listpages/testdata/params_corpus.json diff --git a/internal/listpages/params.go b/internal/listpages/params.go new file mode 100644 index 00000000..abdb2976 --- /dev/null +++ b/internal/listpages/params.go @@ -0,0 +1,689 @@ +// Package listpages answers [[module ListPages]]. +package listpages + +import ( + "errors" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +type Source interface { + TagIDsByName(categorySlug, name string) ([]int64, error) + ArticleTagIDs(articleID int64) ([]int64, error) + ArticleByRef(ref string) (*db.Article, error) + UserByUsername(name string) (*db.User, error) + UserByWikidotName(name string) (*db.User, error) + SiteRatingMode() (string, error) + CategoryRatingMode(category string) (string, error) + VoteStats(articleID int64) (db.VoteStats, error) + HiddenCategories(user *db.User) ([]string, error) + ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) + CountArticles(f db.ListFilter, offset int, limit *int) (int, error) +} + +type Query struct { + Invalid bool + + Only *db.Article + HasOnly bool + FullName string + HasFullName bool + + Filter db.ListFilter + HasSort bool + Offset int + Limit *int + Page int + PerPage int +} + +const defaultPerPage = 20 + +type parser struct { + src Source + article *db.Article + viewer *db.User + params map[string]string + path page.PathParams + out Query + err error +} + +func Parse(src Source, article *db.Article, viewer *db.User, params map[string]string, pathParams page.PathParams) (Query, error) { + p := &parser{src: src, article: article, viewer: viewer, params: params, path: pathParams} + if p.params == nil { + p.params = map[string]string{} + } + p.out.Page = 1 + p.out.PerPage = defaultPerPage + + if p.parseSinglePage() { + return p.out, p.err + } + p.parseType() + p.parseName() + p.parseTags() + p.parseCategory() + p.parseParent() + p.parseCreatedBy() + p.parseCreatedAt() + p.parseRating() + p.parseVotes() + p.parsePopularity() + p.parseSort() + p.parseWindow() + if err := p.resolveRatingMode(); err != nil { + return p.out, err + } + return p.out, p.err +} + +func (p *parser) get(key string) string { return p.params[key] } + +func (p *parser) invalid() { p.out.Invalid = true } + +func (p *parser) fail(err error) { + if p.err == nil { + p.err = err + } +} + +func (p *parser) parseSinglePage() bool { + if p.get("name") == "." || p.get("range") == "." || p.get("fullname") == "." { + if p.article != nil { + p.out.Only, p.out.HasOnly = p.article, true + } else { + p.invalid() + } + return true + } + if full := p.get("fullname"); full != "" { + p.out.FullName, p.out.HasFullName = full, true + return true + } + return false +} + +func (p *parser) parseType() { + pageType := p.get("pagetype") + if _, ok := p.params["pagetype"]; !ok { + pageType = db.PageTypeNormal + } + if pageType == db.PageTypeNormal || pageType == db.PageTypeHidden { + p.out.Filter.PageType = pageType + } +} + +func (p *parser) parseName() { + name, ok := p.params["name"] + if !ok { + return + } + if name == "*" { + return + } + name = strings.ToLower(strings.ReplaceAll(name, "%", "*")) + switch { + case name == "=": + if p.article == nil { + p.invalid() + return + } + p.out.Filter.Name, p.out.Filter.HasName = p.article.Name, true + case strings.Contains(name, "*"): + p.out.Filter.NamePrefix = name[:strings.Index(name, "*")] + p.out.Filter.HasNamePrefix = true + default: + p.out.Filter.Name, p.out.Filter.HasName = name, true + } +} + +func (p *parser) parseTags() { + raw, ok := p.params["tags"] + if !ok || raw == "*" { + return + } + raw = strings.ToLower(strings.ReplaceAll(raw, ",", " ")) + switch raw { + case "-": + p.out.Filter.NoTags = true + return + case "=", "==": + if p.article == nil { + p.invalid() + return + } + ids, err := p.src.ArticleTagIDs(p.article.ID) + if err != nil { + p.fail(err) + return + } + if raw == "=" { + p.out.Filter.RequiredTags = ids + } else { + p.out.Filter.ExactTags = ids + } + return + } + + var ( + requiredMissing bool + presentNamed int + presentFound int + ) + for _, tag := range splitFields(raw) { + switch { + case strings.HasPrefix(tag, "-"): + ids, err := p.tagIDs(tag[1:]) + if err != nil { + p.fail(err) + return + } + p.out.Filter.AbsentTags = append(p.out.Filter.AbsentTags, ids...) + case strings.HasPrefix(tag, "+"): + ids, err := p.tagIDs(tag[1:]) + if err != nil { + p.fail(err) + return + } + if len(ids) == 0 { + requiredMissing = true + } + p.out.Filter.RequiredTags = append(p.out.Filter.RequiredTags, ids...) + default: + ids, err := p.tagIDs(tag) + if err != nil { + p.fail(err) + return + } + presentNamed++ + presentFound += len(ids) + p.out.Filter.PresentTags = append(p.out.Filter.PresentTags, ids...) + } + } + // A tag nobody has ever used empties the listing only when it was required + // or when it was the only thing asked for. + if requiredMissing || (presentNamed > 0 && presentFound == 0) { + p.invalid() + } +} + +func (p *parser) tagIDs(name string) ([]int64, error) { + if strings.Contains(name, ":") { + category, bare := splitName(name) + return p.src.TagIDsByName(category, bare) + } + return p.src.TagIDsByName("", name) +} + +func splitName(fullName string) (category, name string) { + if before, after, found := strings.Cut(fullName, ":"); found { + return before, after + } + return db.DefaultCategory, fullName +} + +// The default is the page's own category, which is why a bare +// [[module ListPages]] lists siblings rather than the whole site. +func (p *parser) parseCategory() { + raw, ok := p.params["category"] + if !ok { + raw = "." + } + if raw == "*" { + return + } + raw = strings.ToLower(strings.ReplaceAll(raw, ",", " ")) + if raw == "." { + if p.article == nil { + p.invalid() + return + } + p.out.Filter.Categories = []string{p.article.Category} + return + } + for _, token := range strings.Split(raw, " ") { + token, _, _ = strings.Cut(token, ":") + if token == "" { + continue + } + if token == "." { + if p.article == nil { + continue + } + token = p.article.Category + } + if strings.HasPrefix(token, "-") { + p.out.Filter.NotCategories = append(p.out.Filter.NotCategories, token[1:]) + } else { + p.out.Filter.Categories = append(p.out.Filter.Categories, token) + } + } +} + +func (p *parser) parseParent() { + raw := p.get("parent") + if raw == "" { + return + } + f := &p.out.Filter + switch raw { + case "-": + f.HasParent = true + case "=": + f.HasParent, f.ParentID = true, p.articleParentID() + case "-=": + f.HasNotParent, f.NotParentID = true, p.articleParentID() + case ".": + if p.article == nil { + p.invalid() + return + } + f.HasParent, f.ParentID = true, &p.article.ID + default: + parent, err := p.src.ArticleByRef(strings.ToLower(raw)) + if errors.Is(err, db.ErrNotFound) { + p.invalid() + return + } + if err != nil { + p.fail(err) + return + } + f.HasParent, f.ParentID = true, &parent.ID + } +} + +func (p *parser) articleParentID() *int64 { + if p.article == nil { + return nil + } + return p.article.ParentID +} + +func (p *parser) parseCreatedBy() { + raw := p.get("created_by") + if raw == "" { + return + } + var ( + user *db.User + err error + ) + if raw == "." { + user = p.viewer + } else { + raw = strings.TrimSpace(raw) + if wd, ok := strings.CutPrefix(raw, "wd:"); ok { + user, err = p.src.UserByWikidotName(wd) + } else { + user, err = p.src.UserByUsername(raw) + } + if errors.Is(err, db.ErrNotFound) { + user, err = nil, nil + } + if err != nil { + p.fail(err) + return + } + } + if user == nil { + p.invalid() + return + } + p.out.Filter.AuthorID = &user.ID +} + +func (p *parser) parseCreatedAt() { + raw := p.get("created_at") + if raw == "" { + return + } + if strings.TrimSpace(raw) == "=" { + if p.article == nil { + p.invalid() + return + } + y, m, d := p.article.CreatedAt.UTC().Date() + dayStart := time.Date(y, m, d, 0, 0, 0, 0, time.UTC) + dayEnd := time.Date(y, m, d, 23, 59, 59, 0, time.UTC) + p.out.Filter.CreatedAt = &db.TimeFilter{Op: db.TimeRange, Start: dayStart, End: dayEnd} + return + } + + op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") + first, last, ok := parseDateBounds(strings.TrimSpace(rest)) + if !ok { + p.invalid() + return + } + p.out.Filter.CreatedAt = &db.TimeFilter{Op: timeOp(op), Start: first, End: last} +} + +func timeOp(op string) string { + switch op { + case "<>": + return db.TimeExcludeRange + case "<": + return db.TimeLT + case ">": + return db.TimeGT + case "<=": + return db.TimeLTE + case ">=": + return db.TimeGTE + } + return db.TimeRange +} + +// Month and day are clamped rather than rejected, so 2020-13-99 is the last +// day of 2020-12. +func parseDateBounds(text string) (first, last time.Time, ok bool) { + parts := strings.Split(text, "-") + year, err := pyInt(parts[0]) + if err != nil || year < 1 || year > 9999 { + return time.Time{}, time.Time{}, false + } + month, day := 1, 1 + lastMonth, lastDay := 12, 31 + + if len(parts) >= 2 { + m, err := pyInt(parts[1]) + if err != nil { + return time.Time{}, time.Time{}, false + } + month = clamp(m, 1, 12) + lastMonth = month + lastDay = daysIn(year, month) + } + if len(parts) >= 3 { + d, err := pyInt(parts[2]) + if err != nil { + return time.Time{}, time.Time{}, false + } + day = clamp(d, 1, daysIn(year, month)) + lastDay = day + } + first = time.Date(year, time.Month(month), day, 0, 0, 0, 0, time.UTC) + last = time.Date(year, time.Month(lastMonth), lastDay, 0, 0, 0, 0, time.UTC) + return first, last, true +} + +func daysIn(year, month int) int { + return time.Date(year, time.Month(month)+1, 0, 0, 0, 0, 0, time.UTC).Day() +} + +func clamp(v, lo, hi int) int { + if v < lo { + return lo + } + if v > hi { + return hi + } + return v +} + +func (p *parser) parseRating() { + raw := p.get("rating") + if raw == "" { + return + } + if strings.TrimSpace(raw) == "=" { + rating, ok := p.currentRating() + if !ok { + return + } + p.out.Filter.Rating = &db.NumFilter{Op: db.NumEQ, Value: ratingValue(rating)} + return + } + op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") + value, err := pyFloat(strings.TrimSpace(rest)) + if err != nil { + p.invalid() + return + } + p.out.Filter.Rating = &db.NumFilter{Op: numOp(op), Value: value} +} + +func (p *parser) parseVotes() { + raw := p.get("votes") + if raw == "" { + return + } + if strings.TrimSpace(raw) == "=" { + rating, ok := p.currentRating() + if !ok { + return + } + p.out.Filter.Votes = &db.NumFilter{Op: db.NumEQ, Value: float64(rating.Votes)} + return + } + op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") + value, err := pyInt(strings.TrimSpace(rest)) + if err != nil { + p.invalid() + return + } + p.out.Filter.Votes = &db.NumFilter{Op: numOp(op), Value: float64(value)} +} + +func (p *parser) parsePopularity() { + raw := p.get("popularity") + if raw == "" { + return + } + if strings.TrimSpace(raw) == "=" { + rating, ok := p.currentRating() + if !ok { + return + } + p.out.Filter.Popularity = &db.NumFilter{Op: db.NumEQ, Value: float64(rating.Popularity)} + return + } + op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") + value, err := pyInt(strings.TrimSpace(rest)) + if err != nil { + p.invalid() + return + } + p.out.Filter.Popularity = &db.NumFilter{Op: numOp(op), Value: float64(value)} +} + +func (p *parser) currentRating() (page.Rating, bool) { + if p.article == nil { + p.invalid() + return page.Rating{}, false + } + mode, err := p.ratingModeOf(p.article.Category) + if err != nil { + p.fail(err) + return page.Rating{}, false + } + if mode == page.RatingModeDisabled { + return page.DisabledRating(), true + } + stats, err := p.src.VoteStats(p.article.ID) + if err != nil { + p.fail(err) + return page.Rating{}, false + } + return page.RatingOf(mode, stats), true +} + +func ratingValue(r page.Rating) float64 { + switch value := r.Value.(type) { + case int: + return float64(value) + case float64: + return value + } + return 0 +} + +// Python splits on a single space and strips each piece, which keeps a tab +// inside a tag name rather than breaking on it. +func splitFields(s string) []string { + var out []string + for _, part := range strings.Split(s, " ") { + if part = strings.TrimSpace(part); part != "" { + out = append(out, part) + } + } + return out +} + +func numOp(op string) string { + switch op { + case "<>": + return db.NumNE + case "<": + return db.NumLT + case ">": + return db.NumGT + case "<=": + return db.NumLTE + case ">=": + return db.NumGTE + } + return db.NumEQ +} + +func (p *parser) parseSort() { + raw, ok := p.params["order"] + if !ok { + raw = "created_at desc" + } + fields := strings.Split(raw, " ") + ascending := true + if len(fields) == 2 && fields[1] == "desc" { + ascending = false + } + p.out.Filter.Sort = db.Sort{Column: fields[0], Ascending: ascending} + p.out.HasSort = true +} + +func (p *parser) parseWindow() { + if offset, err := pyInt(p.getOr("offset", "0")); err == nil { + p.out.Offset = offset + } + if raw, ok := p.params["limit"]; ok { + if limit, err := pyInt(raw); err == nil { + p.out.Limit = &limit + } + } + perPage, err := pyInt(p.getOr("perpage", "20")) + if err != nil { + perPage = defaultPerPage + } + pageNum, err := pyInt(p.pathOr("p", "1")) + if err != nil || pageNum < 1 { + pageNum = 1 + } + p.out.Page = pageNum + p.out.PerPage = perPage +} + +func (p *parser) getOr(key, def string) string { + if value, ok := p.params[key]; ok { + return value + } + return def +} + +func (p *parser) pathOr(key, def string) string { + if param, ok := p.path.Lookup(key); ok { + return param.Value + } + return def +} + +// The first named category decides, which is how one listing can rate its +// pages differently from the page it sits on. +func (p *parser) resolveRatingMode() error { + f := &p.out.Filter + needs := f.Rating != nil || f.Popularity != nil || + f.Sort.Column == db.SortRating || f.Sort.Column == db.SortPopularity + if !needs { + return nil + } + category := db.DefaultCategory + if len(f.Categories) > 0 && f.Categories[0] != "" { + category = f.Categories[0] + } + mode, err := p.ratingModeOf(category) + if err != nil { + return err + } + f.RatingMode = mode + return nil +} + +func (p *parser) ratingModeOf(category string) (string, error) { + site, err := p.src.SiteRatingMode() + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", err + } + own, err := p.src.CategoryRatingMode(category) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", err + } + return page.RatingMode(site, own), nil +} + +// The prefixes are tried in the order given, so the two-character ones have +// to come first. +func splitArgOperator(arg string, allowed []string, def string) (op, rest string) { + for _, candidate := range allowed { + if strings.HasPrefix(arg, candidate) { + return candidate, arg[len(candidate):] + } + } + return def, arg +} + +var errNotANumber = errors.New("listpages: not a number") + +// Python's int() tolerates surrounding space, a sign and underscores between +// digits. Non-ASCII digits are the one thing it takes that this does not. +func pyInt(s string) (int, error) { + s = strings.TrimSpace(s) + body := strings.TrimPrefix(strings.TrimPrefix(s, "+"), "-") + if body == "" || strings.HasPrefix(body, "_") || strings.HasSuffix(body, "_") { + return 0, errNotANumber + } + if strings.Contains(body, "__") { + return 0, errNotANumber + } + for _, r := range body { + if r != '_' && (r < '0' || r > '9') { + return 0, errNotANumber + } + } + n, err := strconv.Atoi(strings.ReplaceAll(s, "_", "")) + if err != nil { + return 0, errNotANumber + } + return n, nil +} + +// Go would take a hexadecimal float that Python rejects, so the digits are +// checked first. +func pyFloat(s string) (float64, error) { + if n, err := pyInt(s); err == nil { + return float64(n), nil + } + s = strings.TrimSpace(s) + lowered := strings.ToLower(s) + if strings.Contains(lowered, "x") || strings.Contains(lowered, "p") { + return 0, errNotANumber + } + f, err := strconv.ParseFloat(strings.ReplaceAll(s, "_", ""), 64) + if err != nil { + return 0, errNotANumber + } + return f, nil +} diff --git a/internal/listpages/params_db_test.go b/internal/listpages/params_db_test.go new file mode 100644 index 00000000..3d4a9f58 --- /dev/null +++ b/internal/listpages/params_db_test.go @@ -0,0 +1,338 @@ +package listpages + +import ( + "context" + "fmt" + "os" + "sort" + "strconv" + "strings" + "testing" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +const ( + paramsGolden = "testdata/params.golden" + paramsCorpus = "testdata/params_corpus.json" +) + +type paramCase struct { + Name string `json:"name"` + Page string `json:"page"` + Viewer string `json:"viewer"` + Params map[string]string `json:"params"` + Path map[string]string `json:"path"` +} + +func paramCases() []paramCase { + on := func(name string, params map[string]string) paramCase { + return paramCase{Name: name, Page: "main", Params: params} + } + return []paramCase{ + {Name: "no-page", Params: map[string]string{"category": "*"}}, + {Name: "no-page-dot-category", Params: map[string]string{}}, + on("bare", nil), + on("whole-site", map[string]string{"category": "*"}), + on("this-page", map[string]string{"name": "."}), + on("this-range", map[string]string{"range": "."}), + on("full-name", map[string]string{"fullname": "nav:side"}), + on("full-name-missing", map[string]string{"fullname": "no-such-page"}), + on("hidden-pages", map[string]string{"pagetype": "hidden", "category": "*"}), + on("bogus-pagetype", map[string]string{"pagetype": "sideways", "category": "*"}), + on("name-prefix", map[string]string{"name": "NAV%", "category": "*"}), + on("name-star-prefix", map[string]string{"name": "nav*", "category": "*"}), + on("name-exact", map[string]string{"name": "Main", "category": "*"}), + on("name-equals", map[string]string{"name": "=", "category": "*"}), + on("name-star", map[string]string{"name": "*", "category": "*"}), + on("category-list", map[string]string{"category": "forum, nav"}), + on("category-negated", map[string]string{"category": "* -forum"}), + on("category-with-colon", map[string]string{"category": "forum:thing"}), + on("category-dot-in-list", map[string]string{"category": ". forum"}), + on("tags-none", map[string]string{"tags": "-", "category": "*"}), + on("tags-own", map[string]string{"tags": "=", "category": "*"}), + on("tags-own-exact", map[string]string{"tags": "==", "category": "*"}), + on("tags-unknown", map[string]string{"tags": "nosuchtag", "category": "*"}), + on("tags-unknown-required", map[string]string{"tags": "+nosuchtag", "category": "*"}), + on("tags-unknown-absent", map[string]string{"tags": "-nosuchtag", "category": "*"}), + on("parent-none", map[string]string{"parent": "-", "category": "*"}), + on("parent-own", map[string]string{"parent": "=", "category": "*"}), + on("parent-not-own", map[string]string{"parent": "-=", "category": "*"}), + on("parent-self", map[string]string{"parent": ".", "category": "*"}), + on("parent-named", map[string]string{"parent": "NAV:side", "category": "*"}), + on("parent-missing", map[string]string{"parent": "no-such-page", "category": "*"}), + on("created-by-missing", map[string]string{"created_by": "nobody", "category": "*"}), + on("created-by-anonymous", map[string]string{"created_by": ".", "category": "*"}), + on("created-by-wikidot", map[string]string{"created_by": "wd:nobody", "category": "*"}), + on("created-at-year", map[string]string{"created_at": "2021", "category": "*"}), + on("created-at-month", map[string]string{"created_at": "2021-02", "category": "*"}), + on("created-at-leap", map[string]string{"created_at": "2020-02", "category": "*"}), + on("created-at-day", map[string]string{"created_at": "2021-02-09", "category": "*"}), + on("created-at-clamped", map[string]string{"created_at": "2021-13-99", "category": "*"}), + on("created-at-zeroes", map[string]string{"created_at": "2021-00-00", "category": "*"}), + on("created-at-gt", map[string]string{"created_at": ">2021", "category": "*"}), + on("created-at-gte", map[string]string{"created_at": ">=2021", "category": "*"}), + on("created-at-lt", map[string]string{"created_at": "<2021", "category": "*"}), + on("created-at-lte", map[string]string{"created_at": "<=2021", "category": "*"}), + on("created-at-outside", map[string]string{"created_at": "<>2021", "category": "*"}), + on("created-at-own-day", map[string]string{"created_at": "=", "category": "*"}), + on("created-at-junk", map[string]string{"created_at": "twenty", "category": "*"}), + on("created-at-trailing-dash", map[string]string{"created_at": "2021-", "category": "*"}), + on("created-at-negative", map[string]string{"created_at": "-5", "category": "*"}), + on("created-at-zero-year", map[string]string{"created_at": "0", "category": "*"}), + on("created-at-too-far", map[string]string{"created_at": "10000", "category": "*"}), + on("created-at-leading-space", map[string]string{"created_at": " >2021", "category": "*"}), + on("legacy-date", map[string]string{"date": "2021", "category": "*"}), + on("rating-int", map[string]string{"rating": "5", "category": "*"}), + on("rating-float", map[string]string{"rating": "3.5", "category": "*"}), + on("rating-negative", map[string]string{"rating": "-2", "category": "*"}), + on("rating-gte", map[string]string{"rating": ">=5", "category": "*"}), + on("rating-ne", map[string]string{"rating": "<>5", "category": "*"}), + on("rating-junk", map[string]string{"rating": "high", "category": "*"}), + on("rating-own", map[string]string{"rating": "=", "category": "*"}), + on("votes-int", map[string]string{"votes": "2", "category": "*"}), + on("votes-float", map[string]string{"votes": "2.5", "category": "*"}), + on("votes-own", map[string]string{"votes": "=", "category": "*"}), + on("popularity-gt", map[string]string{"popularity": ">50", "category": "*"}), + on("popularity-own", map[string]string{"popularity": "=", "category": "*"}), + on("order-name", map[string]string{"order": "name", "category": "*"}), + on("order-name-desc", map[string]string{"order": "name desc", "category": "*"}), + on("order-name-asc", map[string]string{"order": "name asc", "category": "*"}), + on("order-three-words", map[string]string{"order": "name desc extra", "category": "*"}), + on("order-unknown", map[string]string{"order": "nosuchcolumn", "category": "*"}), + on("order-empty", map[string]string{"order": "", "category": "*"}), + on("order-rating", map[string]string{"order": "rating", "category": "*"}), + on("window", map[string]string{"offset": "5", "limit": "40", "perpage": "300", "category": "*"}), + on("window-junk", map[string]string{"offset": "x", "limit": "y", "perpage": "z", "category": "*"}), + {Name: "window-page", Page: "main", Params: map[string]string{"category": "*"}, Path: map[string]string{"p": "3"}}, + {Name: "window-page-zero", Page: "main", Params: map[string]string{"category": "*"}, Path: map[string]string{"p": "0"}}, + {Name: "window-page-junk", Page: "main", Params: map[string]string{"category": "*"}, Path: map[string]string{"p": "x"}}, + } +} + +type dbSource struct { + ctx context.Context + d *db.DB + siteID int64 +} + +func (s dbSource) TagIDsByName(categorySlug, name string) ([]int64, error) { + return s.d.TagIDsByName(s.ctx, categorySlug, name) +} + +func (s dbSource) ArticleTagIDs(articleID int64) ([]int64, error) { + return s.d.ArticleTagIDs(s.ctx, articleID) +} + +func (s dbSource) ArticleByRef(ref string) (*db.Article, error) { + return s.d.ArticleByName(s.ctx, ref) +} + +func (s dbSource) UserByUsername(name string) (*db.User, error) { + return s.d.UserByUsername(s.ctx, name) +} + +func (s dbSource) UserByWikidotName(name string) (*db.User, error) { + return s.d.UserByWikidotName(s.ctx, name) +} + +func (s dbSource) SiteRatingMode() (string, error) { + return s.d.SiteRatingMode(s.ctx, s.siteID) +} + +func (s dbSource) CategoryRatingMode(category string) (string, error) { + return s.d.CategoryRatingMode(s.ctx, category) +} + +func (s dbSource) VoteStats(articleID int64) (db.VoteStats, error) { + return s.d.VoteStats(s.ctx, articleID) +} + +func (s dbSource) HiddenCategories(*db.User) ([]string, error) { return nil, nil } + +func (s dbSource) ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) { + return s.d.ListArticles(s.ctx, f, offset, limit) +} + +func (s dbSource) CountArticles(f db.ListFilter, offset int, limit *int) (int, error) { + return s.d.CountArticles(s.ctx, f, offset, limit) +} + +func testSource(t *testing.T) dbSource { + t.Helper() + dsn := os.Getenv(db.EnvDSN) + if dsn == "" { + t.Skipf("%s not set, skipping the database test", db.EnvDSN) + } + ctx := context.Background() + d, err := db.Open(ctx, dsn) + if err != nil { + t.Fatalf("db.Open() err = %v, want nil", err) + } + t.Cleanup(d.Close) + site, err := d.SiteByHosts(ctx, []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts([localhost]) err = %v, want nil", err) + } + return dbSource{ctx: ctx, d: d, siteID: site.ID} +} + +// TestParseMatchesGolden records what every parameter resolves to against the +// live database. The row ids in it are the database's own, which is what lets +// the oracle print the same thing without a fixture of its own. +func TestParseMatchesGolden(t *testing.T) { + src := testSource(t) + cases := paramCases() + + var b strings.Builder + for _, c := range cases { + var host *db.Article + if c.Page != "" { + found, err := src.ArticleByRef(c.Page) + if err != nil { + t.Fatalf("ArticleByRef(%q) err = %v, want nil", c.Page, err) + } + host = found + } + var viewer *db.User + if c.Viewer != "" { + found, err := src.UserByUsername(c.Viewer) + if err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + viewer = found + } + q, err := Parse(src, host, viewer, copyParams(c.Params), pathOf(c.Path)) + if err != nil { + t.Fatalf("Parse(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\n%s", c.Name, dumpQuery(q)) + } + compareGolden(t, paramsGolden, b.String(), paramsCorpus, cases) +} + +func copyParams(in map[string]string) map[string]string { + out := make(map[string]string, len(in)) + for k, v := range in { + out[k] = v + } + return out +} + +func pathOf(in map[string]string) page.PathParams { + keys := make([]string, 0, len(in)) + for k := range in { + keys = append(keys, k) + } + sort.Strings(keys) + out := make(page.PathParams, 0, len(keys)) + for _, k := range keys { + out = append(out, page.PathParam{Key: k, Value: in[k]}) + } + return out +} + +func dumpQuery(q Query) string { + f := q.Filter + var b strings.Builder + line := func(key, value string) { fmt.Fprintf(&b, "%s=%s\n", key, value) } + + line("invalid", strconv.FormatBool(q.Invalid)) + line("only", optionalID(q.HasOnly, articleID(q.Only))) + line("fullname", optional(q.HasFullName, q.FullName)) + line("pagetype", optional(f.PageType != "", f.PageType)) + line("name", optional(f.HasName, f.Name)) + line("nameprefix", optional(f.HasNamePrefix, f.NamePrefix)) + line("notags", strconv.FormatBool(f.NoTags)) + line("required", ids(f.RequiredTags)) + line("present", ids(f.PresentTags)) + line("absent", ids(f.AbsentTags)) + line("exact", ids(f.ExactTags)) + line("categories", strings.Join(f.Categories, ",")) + line("notcategories", strings.Join(f.NotCategories, ",")) + line("parent", pointerID(f.HasParent, f.ParentID)) + line("notparent", pointerID(f.HasNotParent, f.NotParentID)) + line("author", pointerID(f.AuthorID != nil, f.AuthorID)) + line("created_at", dumpTime(f.CreatedAt)) + line("rating", dumpNum(f.Rating)) + line("votes", dumpNum(f.Votes)) + line("popularity", dumpNum(f.Popularity)) + line("sort", optional(q.HasSort, f.Sort.Column+" "+direction(f.Sort.Ascending))) + line("offset", strconv.Itoa(q.Offset)) + line("limit", optionalInt(q.Limit)) + line("page", strconv.Itoa(q.Page)) + line("perpage", strconv.Itoa(q.PerPage)) + return b.String() +} + +func articleID(a *db.Article) int64 { + if a == nil { + return 0 + } + return a.ID +} + +func optional(present bool, value string) string { + if !present { + return "-" + } + return value +} + +func optionalID(present bool, id int64) string { + return optional(present, strconv.FormatInt(id, 10)) +} + +func optionalInt(v *int) string { + if v == nil { + return "-" + } + return strconv.Itoa(*v) +} + +func pointerID(present bool, id *int64) string { + if !present { + return "-" + } + if id == nil { + return "null" + } + return strconv.FormatInt(*id, 10) +} + +func ids(v []int64) string { + if len(v) == 0 { + return "" + } + sorted := append([]int64(nil), v...) + sort.Slice(sorted, func(i, j int) bool { return sorted[i] < sorted[j] }) + parts := make([]string, len(sorted)) + for i, id := range sorted { + parts[i] = strconv.FormatInt(id, 10) + } + return strings.Join(parts, ",") +} + +func dumpTime(f *db.TimeFilter) string { + if f == nil { + return "-" + } + stamp := func(t time.Time) string { return t.UTC().Format("2006-01-02T15:04:05") } + return f.Op + " " + stamp(f.Start) + " " + stamp(f.End) +} + +func dumpNum(f *db.NumFilter) string { + if f == nil { + return "-" + } + return f.Op + " " + strconv.FormatFloat(f.Value, 'f', 6, 64) +} + +func direction(ascending bool) string { + if ascending { + return "asc" + } + return "desc" +} diff --git a/internal/listpages/params_test.go b/internal/listpages/params_test.go new file mode 100644 index 00000000..c96f343e --- /dev/null +++ b/internal/listpages/params_test.go @@ -0,0 +1,581 @@ +package listpages + +import ( + "testing" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +type fakeSource struct { + tags map[string][]int64 + articleTags map[int64][]int64 + articles map[string]*db.Article + users map[string]*db.User + wikidotUsers map[string]*db.User + siteMode string + categoryMode map[string]string + votes db.VoteStats + hidden []string + + listed []db.Article + total int + + gotFilter db.ListFilter + gotOffset int + gotLimit *int + listCalls int +} + +func newFakeSource() *fakeSource { + return &fakeSource{ + tags: map[string][]int64{ + ":euclid": {1}, + "_default:.": nil, + "_default:hub": {2}, + "meta:hub": {2}, + ":hub": {2, 3}, + "scp:hub": {3}, + ":safe": {4}, + "_default:safe": {4}, + }, + articleTags: map[int64][]int64{7: {1, 4}}, + articles: map[string]*db.Article{ + "scp:scp-173": {ID: 7, Category: "scp", Name: "scp-173", Title: "173"}, + "main": {ID: 3, Category: db.DefaultCategory, Name: "main", Title: "Main"}, + }, + users: map[string]*db.User{"alice": {ID: 11, Username: "alice"}}, + wikidotUsers: map[string]*db.User{"Bob": {ID: 12, Username: "bob-1", WikidotUsername: "Bob"}}, + categoryMode: map[string]string{}, + } +} + +func (f *fakeSource) TagIDsByName(categorySlug, name string) ([]int64, error) { + return f.tags[categorySlug+":"+name], nil +} + +func (f *fakeSource) ArticleTagIDs(articleID int64) ([]int64, error) { + return f.articleTags[articleID], nil +} + +func (f *fakeSource) ArticleByRef(ref string) (*db.Article, error) { + if a, ok := f.articles[ref]; ok { + return a, nil + } + return nil, db.ErrNotFound +} + +func (f *fakeSource) UserByUsername(name string) (*db.User, error) { + if u, ok := f.users[name]; ok { + return u, nil + } + return nil, db.ErrNotFound +} + +func (f *fakeSource) UserByWikidotName(name string) (*db.User, error) { + if u, ok := f.wikidotUsers[name]; ok { + return u, nil + } + return nil, db.ErrNotFound +} + +func (f *fakeSource) SiteRatingMode() (string, error) { + if f.siteMode == "" { + return "", db.ErrNotFound + } + return f.siteMode, nil +} + +func (f *fakeSource) CategoryRatingMode(category string) (string, error) { + if mode, ok := f.categoryMode[category]; ok { + return mode, nil + } + return "", db.ErrNotFound +} + +func (f *fakeSource) VoteStats(int64) (db.VoteStats, error) { return f.votes, nil } + +func (f *fakeSource) HiddenCategories(*db.User) ([]string, error) { return f.hidden, nil } + +func (f *fakeSource) ListArticles(filter db.ListFilter, offset int, limit *int) ([]db.Article, error) { + f.gotFilter, f.gotOffset, f.gotLimit = filter, offset, limit + f.listCalls++ + return f.listed, nil +} + +func (f *fakeSource) CountArticles(db.ListFilter, int, *int) (int, error) { return f.total, nil } + +func article173() *db.Article { + parent := int64(3) + return &db.Article{ + ID: 7, Category: "scp", Name: "scp-173", Title: "173", ParentID: &parent, + CreatedAt: time.Date(2021, 6, 5, 14, 30, 0, 0, time.UTC), + } +} + +func parse(t *testing.T, src Source, a *db.Article, viewer *db.User, params map[string]string) Query { + t.Helper() + q, err := Parse(src, a, viewer, params, nil) + if err != nil { + t.Fatalf("Parse(%v) err = %v, want nil", params, err) + } + return q +} + +func TestParseDefaultsToTheOwnCategoryAndNormalPages(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, nil) + + if q.Filter.PageType != db.PageTypeNormal { + t.Errorf("PageType = %q, want %q", q.Filter.PageType, db.PageTypeNormal) + } + if len(q.Filter.Categories) != 1 || q.Filter.Categories[0] != "scp" { + t.Errorf("Categories = %v, want [scp]", q.Filter.Categories) + } + if q.Filter.Sort != (db.Sort{Column: db.SortCreatedAt}) { + t.Errorf("Sort = %+v, want created_at desc", q.Filter.Sort) + } + if q.PerPage != 20 || q.Page != 1 { + t.Errorf("Page, PerPage = %d, %d, want 1, 20", q.Page, q.PerPage) + } +} + +func TestParseWithoutAnArticleHasNoCategory(t *testing.T) { + q := parse(t, newFakeSource(), nil, nil, nil) + if !q.Invalid { + t.Error("Parse(nil article).Invalid = false, want true") + } +} + +func TestParseNameDot(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"name": "."}) + if !q.HasOnly || q.Only.ID != 7 { + t.Errorf("Parse(name=.).Only = %+v, want article 7", q.Only) + } +} + +func TestParseRangeDotAndFullNameDotMeanTheSame(t *testing.T) { + for _, key := range []string{"range", "fullname"} { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{key: "."}) + if !q.HasOnly { + t.Errorf("Parse(%s=.).HasOnly = false, want true", key) + } + } +} + +func TestParseFullName(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"fullname": "main"}) + if !q.HasFullName || q.FullName != "main" { + t.Errorf("Parse(fullname=main).FullName = %q, want %q", q.FullName, "main") + } +} + +func TestParseNamePercentBecomesAPrefix(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"name": "SCP-%"}) + if !q.Filter.HasNamePrefix || q.Filter.NamePrefix != "scp-" { + t.Errorf("NamePrefix = %q, want %q", q.Filter.NamePrefix, "scp-") + } +} + +func TestParseNameEqualsTakesTheOwnName(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"name": "="}) + if !q.Filter.HasName || q.Filter.Name != "scp-173" { + t.Errorf("Name = %q, want %q", q.Filter.Name, "scp-173") + } +} + +func TestParseNameStarListsEverything(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"name": "*"}) + if q.Filter.HasName || q.Filter.HasNamePrefix { + t.Errorf("Name, NamePrefix set = %v, %v, want false, false", q.Filter.HasName, q.Filter.HasNamePrefix) + } +} + +func TestParseTagsSplitsBySign(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "+euclid,safe,-scp:hub"}) + if len(q.Filter.RequiredTags) != 1 || q.Filter.RequiredTags[0] != 1 { + t.Errorf("RequiredTags = %v, want [1]", q.Filter.RequiredTags) + } + if len(q.Filter.PresentTags) != 1 || q.Filter.PresentTags[0] != 4 { + t.Errorf("PresentTags = %v, want [4]", q.Filter.PresentTags) + } + if len(q.Filter.AbsentTags) != 1 || q.Filter.AbsentTags[0] != 3 { + t.Errorf("AbsentTags = %v, want [3]", q.Filter.AbsentTags) + } +} + +func TestParseTagsWithAnUnknownRequiredTag(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "+nosuchtag"}) + if !q.Invalid { + t.Error("Parse(tags=+nosuchtag).Invalid = false, want true") + } +} + +func TestParseTagsWithOnlyUnknownPresentTags(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "nosuchtag"}) + if !q.Invalid { + t.Error("Parse(tags=nosuchtag).Invalid = false, want true") + } +} + +func TestParseTagsKeepsGoingWhenOneOfSeveralIsUnknown(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "nosuchtag euclid"}) + if q.Invalid { + t.Error("Parse(tags=nosuchtag euclid).Invalid = true, want false") + } + if len(q.Filter.PresentTags) != 1 || q.Filter.PresentTags[0] != 1 { + t.Errorf("PresentTags = %v, want [1]", q.Filter.PresentTags) + } +} + +func TestParseTagsWithAnUnknownAbsentTag(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "-nosuchtag"}) + if q.Invalid { + t.Error("Parse(tags=-nosuchtag).Invalid = true, want false") + } + if len(q.Filter.AbsentTags) != 0 { + t.Errorf("AbsentTags = %v, want []", q.Filter.AbsentTags) + } +} + +func TestParseTagsDash(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "-"}) + if !q.Filter.NoTags { + t.Error("Parse(tags=-).NoTags = false, want true") + } +} + +func TestParseTagsEqualsTakesTheOwnTags(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "="}) + if len(q.Filter.RequiredTags) != 2 { + t.Errorf("RequiredTags = %v, want two entries", q.Filter.RequiredTags) + } + if len(q.Filter.ExactTags) != 0 { + t.Errorf("ExactTags = %v, want []", q.Filter.ExactTags) + } +} + +func TestParseTagsDoubleEqualsTakesTheOwnTags(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "=="}) + if len(q.Filter.ExactTags) != 2 { + t.Errorf("ExactTags = %v, want two entries", q.Filter.ExactTags) + } +} + +func TestParseTagsWithoutACategoryMatchesEveryCategory(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"tags": "hub"}) + if len(q.Filter.PresentTags) != 2 { + t.Errorf("PresentTags = %v, want two entries", q.Filter.PresentTags) + } +} + +func TestParseCategoryStarListsTheWholeSite(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"category": "*"}) + if len(q.Filter.Categories) != 0 || len(q.Filter.NotCategories) != 0 { + t.Errorf("Categories, NotCategories = %v, %v, want empty", q.Filter.Categories, q.Filter.NotCategories) + } +} + +func TestParseCategoryDropsWhatFollowsAColon(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"category": "scp:page -meta:page"}) + if len(q.Filter.Categories) != 1 || q.Filter.Categories[0] != "scp" { + t.Errorf("Categories = %v, want [scp]", q.Filter.Categories) + } + if len(q.Filter.NotCategories) != 1 || q.Filter.NotCategories[0] != "meta" { + t.Errorf("NotCategories = %v, want [meta]", q.Filter.NotCategories) + } +} + +func TestParseCategoryDotInAList(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"category": ". meta"}) + want := []string{"scp", "meta"} + if len(q.Filter.Categories) != 2 || q.Filter.Categories[0] != want[0] || q.Filter.Categories[1] != want[1] { + t.Errorf("Categories = %v, want %v", q.Filter.Categories, want) + } +} + +func TestParseParentDash(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"parent": "-"}) + if !q.Filter.HasParent || q.Filter.ParentID != nil { + t.Errorf("HasParent, ParentID = %v, %v, want true, nil", q.Filter.HasParent, q.Filter.ParentID) + } +} + +func TestParseParentEqualsTakesTheOwnParent(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"parent": "="}) + if q.Filter.ParentID == nil || *q.Filter.ParentID != 3 { + t.Errorf("ParentID = %v, want 3", q.Filter.ParentID) + } +} + +func TestParseParentDashEquals(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"parent": "-="}) + if !q.Filter.HasNotParent || q.Filter.NotParentID == nil || *q.Filter.NotParentID != 3 { + t.Errorf("NotParentID = %v, want 3", q.Filter.NotParentID) + } +} + +func TestParseParentDotIsThePageItself(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"parent": "."}) + if q.Filter.ParentID == nil || *q.Filter.ParentID != 7 { + t.Errorf("ParentID = %v, want 7", q.Filter.ParentID) + } +} + +func TestParseParentByName(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"parent": "MAIN"}) + if q.Filter.ParentID == nil || *q.Filter.ParentID != 3 { + t.Errorf("ParentID = %v, want 3", q.Filter.ParentID) + } +} + +func TestParseParentThatDoesNotExist(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"parent": "no-such-page"}) + if !q.Invalid { + t.Error("Parse(parent=no-such-page).Invalid = false, want true") + } +} + +func TestParseCreatedByDotWithoutAViewer(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"created_by": "."}) + if !q.Invalid { + t.Error("Parse(created_by=.).Invalid = false, want true") + } +} + +func TestParseCreatedByDotTakesTheViewer(t *testing.T) { + viewer := &db.User{ID: 99, Username: "carol"} + q := parse(t, newFakeSource(), article173(), viewer, map[string]string{"created_by": "."}) + if q.Filter.AuthorID == nil || *q.Filter.AuthorID != 99 { + t.Errorf("AuthorID = %v, want 99", q.Filter.AuthorID) + } +} + +func TestParseCreatedByWikidotPrefix(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"created_by": "wd:Bob"}) + if q.Filter.AuthorID == nil || *q.Filter.AuthorID != 12 { + t.Errorf("AuthorID = %v, want 12", q.Filter.AuthorID) + } +} + +func TestParseCreatedByUnknownUser(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"created_by": "nobody"}) + if !q.Invalid { + t.Error("Parse(created_by=nobody).Invalid = false, want true") + } +} + +func TestParseCreatedAtBounds(t *testing.T) { + cases := []struct { + in string + op string + start, end string + }{ + {"2021", db.TimeRange, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, + {"2021-02", db.TimeRange, "2021-02-01T00:00:00Z", "2021-02-28T00:00:00Z"}, + {"2020-02", db.TimeRange, "2020-02-01T00:00:00Z", "2020-02-29T00:00:00Z"}, + {"2021-02-09", db.TimeRange, "2021-02-09T00:00:00Z", "2021-02-09T00:00:00Z"}, + {"2021-13-99", db.TimeRange, "2021-12-31T00:00:00Z", "2021-12-31T00:00:00Z"}, + {"2021-00-00", db.TimeRange, "2021-01-01T00:00:00Z", "2021-01-01T00:00:00Z"}, + {">2021", db.TimeGT, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, + {">=2021", db.TimeGTE, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, + {"<2021", db.TimeLT, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, + {"<=2021", db.TimeLTE, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, + {"<>2021", db.TimeExcludeRange, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, + } + for _, c := range cases { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"created_at": c.in}) + got := q.Filter.CreatedAt + if got == nil { + t.Errorf("Parse(created_at=%q).CreatedAt = nil, want a filter", c.in) + continue + } + if got.Op != c.op { + t.Errorf("Parse(created_at=%q).Op = %q, want %q", c.in, got.Op, c.op) + } + if start := got.Start.Format(time.RFC3339); start != c.start { + t.Errorf("Parse(created_at=%q).Start = %q, want %q", c.in, start, c.start) + } + if end := got.End.Format(time.RFC3339); end != c.end { + t.Errorf("Parse(created_at=%q).End = %q, want %q", c.in, end, c.end) + } + } +} + +func TestParseCreatedAtEqualsIsTheOwnDay(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"created_at": "="}) + got := q.Filter.CreatedAt + if got == nil { + t.Fatal("Parse(created_at==).CreatedAt = nil, want a filter") + } + if start := got.Start.Format(time.RFC3339); start != "2021-06-05T00:00:00Z" { + t.Errorf("Start = %q, want %q", start, "2021-06-05T00:00:00Z") + } + if end := got.End.Format(time.RFC3339); end != "2021-06-05T23:59:59Z" { + t.Errorf("End = %q, want %q", end, "2021-06-05T23:59:59Z") + } +} + +func TestParseCreatedAtThatDoesNotParse(t *testing.T) { + for _, in := range []string{"twenty", "2021-", "-5", "0", "10000", " >2021"} { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"created_at": in}) + if !q.Invalid { + t.Errorf("Parse(created_at=%q).Invalid = false, want true", in) + } + } +} + +func TestParseIgnoresTheLegacyDateSpelling(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"date": "2021"}) + if q.Filter.CreatedAt != nil { + t.Errorf("Parse(date=2021).CreatedAt = %+v, want nil", q.Filter.CreatedAt) + } +} + +func TestParseRatingOperators(t *testing.T) { + cases := []struct { + in string + op string + value float64 + }{ + {"5", db.NumEQ, 5}, + {"=5", db.NumEQ, 5}, + {">5", db.NumGT, 5}, + {">=5", db.NumGTE, 5}, + {"<5", db.NumLT, 5}, + {"<=5", db.NumLTE, 5}, + {"<>5", db.NumNE, 5}, + {"3.5", db.NumEQ, 3.5}, + {"-2", db.NumEQ, -2}, + } + for _, c := range cases { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"rating": c.in}) + got := q.Filter.Rating + if got == nil { + t.Errorf("Parse(rating=%q).Rating = nil, want a filter", c.in) + continue + } + if got.Op != c.op || got.Value != c.value { + t.Errorf("Parse(rating=%q) = %s %v, want %s %v", c.in, got.Op, got.Value, c.op, c.value) + } + } +} + +func TestParseVotesRejectsAFraction(t *testing.T) { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"votes": "3.5"}) + if !q.Invalid { + t.Error("Parse(votes=3.5).Invalid = false, want true") + } +} + +func TestParseRatingModeComesFromTheFirstCategory(t *testing.T) { + src := newFakeSource() + src.siteMode = page.RatingModeUpDown + src.categoryMode["meta"] = page.RatingModeStars + + q := parse(t, src, article173(), nil, map[string]string{"rating": ">1", "category": "meta scp"}) + if q.Filter.RatingMode != page.RatingModeStars { + t.Errorf("RatingMode = %q, want %q", q.Filter.RatingMode, page.RatingModeStars) + } +} + +func TestParseRatingModeIsLeftUnsetWhenNothingReadsIt(t *testing.T) { + src := newFakeSource() + src.siteMode = page.RatingModeStars + q := parse(t, src, article173(), nil, nil) + if q.Filter.RatingMode != "" { + t.Errorf("RatingMode = %q, want %q", q.Filter.RatingMode, "") + } +} + +func TestParseSort(t *testing.T) { + cases := []struct { + in string + column string + ascending bool + }{ + {"name", db.SortName, true}, + {"name desc", db.SortName, false}, + {"name asc", db.SortName, true}, + {"name desc extra", db.SortName, true}, + {"nosuchcolumn", "nosuchcolumn", true}, + {"", "", true}, + {"random", db.SortRandom, true}, + } + for _, c := range cases { + q := parse(t, newFakeSource(), article173(), nil, map[string]string{"order": c.in}) + if q.Filter.Sort.Column != c.column || q.Filter.Sort.Ascending != c.ascending { + t.Errorf("Parse(order=%q).Sort = %+v, want %s %v", c.in, q.Filter.Sort, c.column, c.ascending) + } + } +} + +func TestParseWindow(t *testing.T) { + src := newFakeSource() + q, err := Parse(src, article173(), nil, + map[string]string{"offset": "5", "limit": "40", "perpage": "300"}, + page.PathParams{{Key: "p", Value: "3"}}) + if err != nil { + t.Fatalf("Parse() err = %v, want nil", err) + } + if q.Offset != 5 { + t.Errorf("Offset = %d, want 5", q.Offset) + } + if q.Limit == nil || *q.Limit != 40 { + t.Errorf("Limit = %v, want 40", q.Limit) + } + if q.PerPage != 300 { + t.Errorf("PerPage = %d, want 300", q.PerPage) + } + if q.Page != 3 { + t.Errorf("Page = %d, want 3", q.Page) + } +} + +func TestParseWindowFallsBackOnJunk(t *testing.T) { + src := newFakeSource() + q, err := Parse(src, article173(), nil, + map[string]string{"offset": "x", "limit": "y", "perpage": "z"}, + page.PathParams{{Key: "p", Value: "0"}}) + if err != nil { + t.Fatalf("Parse() err = %v, want nil", err) + } + if q.Offset != 0 { + t.Errorf("Offset = %d, want 0", q.Offset) + } + if q.Limit != nil { + t.Errorf("Limit = %v, want nil", q.Limit) + } + if q.PerPage != 20 { + t.Errorf("PerPage = %d, want 20", q.PerPage) + } + if q.Page != 1 { + t.Errorf("Page = %d, want 1", q.Page) + } +} + +func TestPyInt(t *testing.T) { + good := map[string]int{"5": 5, " 5 ": 5, "+5": 5, "-5": -5, "1_000": 1000, "0": 0} + for in, want := range good { + got, err := pyInt(in) + if err != nil || got != want { + t.Errorf("pyInt(%q) = %d, %v, want %d, nil", in, got, err, want) + } + } + for _, in := range []string{"", " ", "_5", "5_", "1__0", "5.0", "0x10", "５", "+"} { + if got, err := pyInt(in); err == nil { + t.Errorf("pyInt(%q) = %d, nil, want an error", in, got) + } + } +} + +func TestPyFloatRejectsWhatPythonRejects(t *testing.T) { + for _, in := range []string{"0x1p-2", "", "abc"} { + if got, err := pyFloat(in); err == nil { + t.Errorf("pyFloat(%q) = %v, nil, want an error", in, got) + } + } + if got, err := pyFloat("3.5"); err != nil || got != 3.5 { + t.Errorf("pyFloat(3.5) = %v, %v, want 3.5, nil", got, err) + } +} diff --git a/internal/listpages/testdata/oracle_params.py b/internal/listpages/testdata/oracle_params.py new file mode 100644 index 00000000..a85cdc49 --- /dev/null +++ b/internal/listpages/testdata/oracle_params.py @@ -0,0 +1,127 @@ +"""Record what Django's ListPagesParams makes of each corpus case. + + docker compose exec -T -e PARAMS_CORPUS="$(cat params_corpus.json)" \ + web python manage.py shell < oracle_params.py > params.django + +The corpus is exported by `go test ./internal/listpages -update`, which needs +PWIKIT_TEST_DSN pointing at the same database this runs against. Row ids are +printed raw, so the two sides only line up when both read that one database. +Compare the output with testdata/params.golden. +""" + +import json +import os +import sys + +from web import threadvars +from web.controllers import articles +from web.models.site import Site +from web.models.users import User +from modules.listpages import param +from modules.listpages.params import ListPagesParams + +try: + CORPUS = json.loads(os.environ['PARAMS_CORPUS']) +except KeyError: + raise SystemExit(__doc__) + + +def one(parsed, kind): + found = parsed.get_type(kind) + return found[0] if found else None + + +def ids(tags): + return ','.join(str(t.pk) for t in sorted(tags, key=lambda t: t.pk)) + + +def optional(value): + return '-' if value is None else str(value) + + +def pointer_id(holder, attr): + if holder is None: + return '-' + value = getattr(holder, attr) + return 'null' if value is None else str(value.pk) + + +def stamp(value): + return value.strftime('%Y-%m-%dT%H:%M:%S') + + +def dump_time(created): + if created is None: + return '-' + return '%s %s %s' % (created.type, stamp(created.start), stamp(created.end)) + + +def dump_num(holder, attr): + if holder is None: + return '-' + return '%s %.6f' % (holder.type, getattr(holder, attr)) + + +def dump(parsed): + article_param = one(parsed, param.Article) + full_name = one(parsed, param.FullName) + page_type = one(parsed, param.Type) + name = one(parsed, param.Name) + prefix = one(parsed, param.NamePrefix) + tags = one(parsed, param.Tags) + exact = one(parsed, param.ExactTags) + category = one(parsed, param.Category) + parent = one(parsed, param.Parent) + not_parent = one(parsed, param.NotParent) + created_by = one(parsed, param.CreatedBy) + sort = one(parsed, param.Sort) + offset = one(parsed, param.Offset) + limit = one(parsed, param.Limit) + pagination = one(parsed, param.Pagination) + + lines = [ + ('invalid', 'true' if parsed.has_type(param.Invalid) else 'false'), + ('only', '-' if article_param is None else str(article_param.article.pk)), + ('fullname', '-' if full_name is None else full_name.full_name), + ('pagetype', '-' if page_type is None else page_type.type), + ('name', '-' if name is None else name.name), + ('nameprefix', '-' if prefix is None else prefix.prefix), + ('notags', 'true' if parsed.has_type(param.NoTags) else 'false'), + ('required', '' if tags is None else ids(tags.required)), + ('present', '' if tags is None else ids(tags.present)), + ('absent', '' if tags is None else ids(tags.absent)), + ('exact', '' if exact is None else ids(exact.tags)), + ('categories', '' if category is None else ','.join(str(c) for c in category.allowed)), + ('notcategories', '' if category is None else ','.join(str(c) for c in category.not_allowed)), + ('parent', pointer_id(parent, 'parent')), + ('notparent', pointer_id(not_parent, 'parent')), + ('author', '-' if created_by is None else str(created_by.user.pk)), + ('created_at', dump_time(one(parsed, param.CreatedAt))), + ('rating', dump_num(one(parsed, param.Rating), 'rating')), + ('votes', dump_num(one(parsed, param.Votes), 'votes')), + ('popularity', dump_num(one(parsed, param.Popularity), 'popularity')), + ('sort', '-' if sort is None else '%s %s' % (sort.column, sort.direction)), + ('offset', '0' if offset is None else str(offset.offset)), + ('limit', '-' if limit is None else str(limit.limit)), + ('page', '1' if pagination is None else str(pagination.page)), + ('perpage', '20' if pagination is None else str(pagination.per_page)), + ] + return ''.join('%s=%s\n' % pair for pair in lines) + + +def main(): + out = [] + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + for case in CORPUS: + article = articles.get_article(case['page']) if case.get('page') else None + viewer = None + if case.get('viewer'): + viewer = User.objects.filter(username=case['viewer']).first() + parsed = ListPagesParams(article, viewer, dict(case.get('params') or {}), + dict(case.get('path') or {})) + out.append('=== %s\n%s' % (case['name'], dump(parsed))) + sys.stdout.write(''.join(out)) + + +main() diff --git a/internal/listpages/testdata/params.golden b/internal/listpages/testdata/params.golden new file mode 100644 index 00000000..3739c7d6 --- /dev/null +++ b/internal/listpages/testdata/params.golden @@ -0,0 +1,2002 @@ +=== no-page +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== no-page-dot-category +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== bare +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories=_default +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== whole-site +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== this-page +invalid=false +only=4 +fullname=- +pagetype=- +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=- +offset=0 +limit=- +page=1 +perpage=20 +=== this-range +invalid=false +only=4 +fullname=- +pagetype=- +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=- +offset=0 +limit=- +page=1 +perpage=20 +=== full-name +invalid=false +only=- +fullname=nav:side +pagetype=- +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=- +offset=0 +limit=- +page=1 +perpage=20 +=== full-name-missing +invalid=false +only=- +fullname=no-such-page +pagetype=- +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=- +offset=0 +limit=- +page=1 +perpage=20 +=== hidden-pages +invalid=false +only=- +fullname=- +pagetype=hidden +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== bogus-pagetype +invalid=false +only=- +fullname=- +pagetype=- +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== name-prefix +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=nav +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== name-star-prefix +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=nav +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== name-exact +invalid=false +only=- +fullname=- +pagetype=normal +name=main +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== name-equals +invalid=false +only=- +fullname=- +pagetype=normal +name=main +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== name-star +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== category-list +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories=forum,nav +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== category-negated +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories=* +notcategories=forum +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== category-with-colon +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories=forum +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== category-dot-in-list +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories=_default,forum +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== tags-none +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=true +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== tags-own +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== tags-own-exact +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== tags-unknown +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== tags-unknown-required +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== tags-unknown-absent +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== parent-none +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=null +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== parent-own +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=null +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== parent-not-own +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=null +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== parent-self +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=4 +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== parent-named +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=2 +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== parent-missing +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-by-missing +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-by-anonymous +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-by-wikidot +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-year +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=range 2021-01-01T00:00:00 2021-12-31T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-month +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=range 2021-02-01T00:00:00 2021-02-28T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-leap +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=range 2020-02-01T00:00:00 2020-02-29T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-day +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=range 2021-02-09T00:00:00 2021-02-09T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-clamped +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=range 2021-12-31T00:00:00 2021-12-31T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-zeroes +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=range 2021-01-01T00:00:00 2021-01-01T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-gt +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=gt 2021-01-01T00:00:00 2021-12-31T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-gte +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=gte 2021-01-01T00:00:00 2021-12-31T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-lt +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=lt 2021-01-01T00:00:00 2021-12-31T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-lte +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=lte 2021-01-01T00:00:00 2021-12-31T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-outside +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=exclude_range 2021-01-01T00:00:00 2021-12-31T00:00:00 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-own-day +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=range 2026-08-20T00:00:00 2026-08-20T23:59:59 +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-junk +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-trailing-dash +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-negative +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-zero-year +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-too-far +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== created-at-leading-space +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== legacy-date +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== rating-int +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=eq 5.000000 +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== rating-float +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=eq 3.500000 +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== rating-negative +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=eq -2.000000 +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== rating-gte +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=gte 5.000000 +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== rating-ne +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=ne 5.000000 +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== rating-junk +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== rating-own +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=eq 0.000000 +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== votes-int +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=eq 2.000000 +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== votes-float +invalid=true +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== votes-own +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=eq 0.000000 +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== popularity-gt +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=gt 50.000000 +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== popularity-own +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=eq 0.000000 +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== order-name +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=name asc +offset=0 +limit=- +page=1 +perpage=20 +=== order-name-desc +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=name desc +offset=0 +limit=- +page=1 +perpage=20 +=== order-name-asc +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=name asc +offset=0 +limit=- +page=1 +perpage=20 +=== order-three-words +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=name asc +offset=0 +limit=- +page=1 +perpage=20 +=== order-unknown +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=nosuchcolumn asc +offset=0 +limit=- +page=1 +perpage=20 +=== order-empty +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort= asc +offset=0 +limit=- +page=1 +perpage=20 +=== order-rating +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=rating asc +offset=0 +limit=- +page=1 +perpage=20 +=== window +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=5 +limit=40 +page=1 +perpage=300 +=== window-junk +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== window-page +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=3 +perpage=20 +=== window-page-zero +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 +=== window-page-junk +invalid=false +only=- +fullname=- +pagetype=normal +name=- +nameprefix=- +notags=false +required= +present= +absent= +exact= +categories= +notcategories= +parent=- +notparent=- +author=- +created_at=- +rating=- +votes=- +popularity=- +sort=created_at desc +offset=0 +limit=- +page=1 +perpage=20 diff --git a/internal/listpages/testdata/params_corpus.json b/internal/listpages/testdata/params_corpus.json new file mode 100644 index 00000000..99a28266 --- /dev/null +++ b/internal/listpages/testdata/params_corpus.json @@ -0,0 +1,763 @@ +[ + { + "name": "no-page", + "page": "", + "viewer": "", + "params": { + "category": "*" + }, + "path": null + }, + { + "name": "no-page-dot-category", + "page": "", + "viewer": "", + "params": {}, + "path": null + }, + { + "name": "bare", + "page": "main", + "viewer": "", + "params": null, + "path": null + }, + { + "name": "whole-site", + "page": "main", + "viewer": "", + "params": { + "category": "*" + }, + "path": null + }, + { + "name": "this-page", + "page": "main", + "viewer": "", + "params": { + "name": "." + }, + "path": null + }, + { + "name": "this-range", + "page": "main", + "viewer": "", + "params": { + "range": "." + }, + "path": null + }, + { + "name": "full-name", + "page": "main", + "viewer": "", + "params": { + "fullname": "nav:side" + }, + "path": null + }, + { + "name": "full-name-missing", + "page": "main", + "viewer": "", + "params": { + "fullname": "no-such-page" + }, + "path": null + }, + { + "name": "hidden-pages", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "pagetype": "hidden" + }, + "path": null + }, + { + "name": "bogus-pagetype", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "pagetype": "sideways" + }, + "path": null + }, + { + "name": "name-prefix", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "name": "NAV%" + }, + "path": null + }, + { + "name": "name-star-prefix", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "name": "nav*" + }, + "path": null + }, + { + "name": "name-exact", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "name": "Main" + }, + "path": null + }, + { + "name": "name-equals", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "name": "=" + }, + "path": null + }, + { + "name": "name-star", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "name": "*" + }, + "path": null + }, + { + "name": "category-list", + "page": "main", + "viewer": "", + "params": { + "category": "forum, nav" + }, + "path": null + }, + { + "name": "category-negated", + "page": "main", + "viewer": "", + "params": { + "category": "* -forum" + }, + "path": null + }, + { + "name": "category-with-colon", + "page": "main", + "viewer": "", + "params": { + "category": "forum:thing" + }, + "path": null + }, + { + "name": "category-dot-in-list", + "page": "main", + "viewer": "", + "params": { + "category": ". forum" + }, + "path": null + }, + { + "name": "tags-none", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "tags": "-" + }, + "path": null + }, + { + "name": "tags-own", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "tags": "=" + }, + "path": null + }, + { + "name": "tags-own-exact", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "tags": "==" + }, + "path": null + }, + { + "name": "tags-unknown", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "tags": "nosuchtag" + }, + "path": null + }, + { + "name": "tags-unknown-required", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "tags": "+nosuchtag" + }, + "path": null + }, + { + "name": "tags-unknown-absent", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "tags": "-nosuchtag" + }, + "path": null + }, + { + "name": "parent-none", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "parent": "-" + }, + "path": null + }, + { + "name": "parent-own", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "parent": "=" + }, + "path": null + }, + { + "name": "parent-not-own", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "parent": "-=" + }, + "path": null + }, + { + "name": "parent-self", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "parent": "." + }, + "path": null + }, + { + "name": "parent-named", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "parent": "NAV:side" + }, + "path": null + }, + { + "name": "parent-missing", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "parent": "no-such-page" + }, + "path": null + }, + { + "name": "created-by-missing", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_by": "nobody" + }, + "path": null + }, + { + "name": "created-by-anonymous", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_by": "." + }, + "path": null + }, + { + "name": "created-by-wikidot", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_by": "wd:nobody" + }, + "path": null + }, + { + "name": "created-at-year", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "2021" + }, + "path": null + }, + { + "name": "created-at-month", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "2021-02" + }, + "path": null + }, + { + "name": "created-at-leap", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "2020-02" + }, + "path": null + }, + { + "name": "created-at-day", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "2021-02-09" + }, + "path": null + }, + { + "name": "created-at-clamped", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "2021-13-99" + }, + "path": null + }, + { + "name": "created-at-zeroes", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "2021-00-00" + }, + "path": null + }, + { + "name": "created-at-gt", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "\u003e2021" + }, + "path": null + }, + { + "name": "created-at-gte", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "\u003e=2021" + }, + "path": null + }, + { + "name": "created-at-lt", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "\u003c2021" + }, + "path": null + }, + { + "name": "created-at-lte", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "\u003c=2021" + }, + "path": null + }, + { + "name": "created-at-outside", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "\u003c\u003e2021" + }, + "path": null + }, + { + "name": "created-at-own-day", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "=" + }, + "path": null + }, + { + "name": "created-at-junk", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "twenty" + }, + "path": null + }, + { + "name": "created-at-trailing-dash", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "2021-" + }, + "path": null + }, + { + "name": "created-at-negative", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "-5" + }, + "path": null + }, + { + "name": "created-at-zero-year", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "0" + }, + "path": null + }, + { + "name": "created-at-too-far", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": "10000" + }, + "path": null + }, + { + "name": "created-at-leading-space", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "created_at": " \u003e2021" + }, + "path": null + }, + { + "name": "legacy-date", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "date": "2021" + }, + "path": null + }, + { + "name": "rating-int", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "rating": "5" + }, + "path": null + }, + { + "name": "rating-float", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "rating": "3.5" + }, + "path": null + }, + { + "name": "rating-negative", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "rating": "-2" + }, + "path": null + }, + { + "name": "rating-gte", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "rating": "\u003e=5" + }, + "path": null + }, + { + "name": "rating-ne", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "rating": "\u003c\u003e5" + }, + "path": null + }, + { + "name": "rating-junk", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "rating": "high" + }, + "path": null + }, + { + "name": "rating-own", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "rating": "=" + }, + "path": null + }, + { + "name": "votes-int", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "votes": "2" + }, + "path": null + }, + { + "name": "votes-float", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "votes": "2.5" + }, + "path": null + }, + { + "name": "votes-own", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "votes": "=" + }, + "path": null + }, + { + "name": "popularity-gt", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "popularity": "\u003e50" + }, + "path": null + }, + { + "name": "popularity-own", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "popularity": "=" + }, + "path": null + }, + { + "name": "order-name", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "order": "name" + }, + "path": null + }, + { + "name": "order-name-desc", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "order": "name desc" + }, + "path": null + }, + { + "name": "order-name-asc", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "order": "name asc" + }, + "path": null + }, + { + "name": "order-three-words", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "order": "name desc extra" + }, + "path": null + }, + { + "name": "order-unknown", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "order": "nosuchcolumn" + }, + "path": null + }, + { + "name": "order-empty", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "order": "" + }, + "path": null + }, + { + "name": "order-rating", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "order": "rating" + }, + "path": null + }, + { + "name": "window", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "limit": "40", + "offset": "5", + "perpage": "300" + }, + "path": null + }, + { + "name": "window-junk", + "page": "main", + "viewer": "", + "params": { + "category": "*", + "limit": "y", + "offset": "x", + "perpage": "z" + }, + "path": null + }, + { + "name": "window-page", + "page": "main", + "viewer": "", + "params": { + "category": "*" + }, + "path": { + "p": "3" + } + }, + { + "name": "window-page-zero", + "page": "main", + "viewer": "", + "params": { + "category": "*" + }, + "path": { + "p": "0" + } + }, + { + "name": "window-page-junk", + "page": "main", + "viewer": "", + "params": { + "category": "*" + }, + "path": { + "p": "x" + } + } +] From a88577046cb4ad5f03beeb9eaa8824c82027381c Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 28 Aug 2026 20:31:39 +0900 Subject: [PATCH 067/428] answer the listing and draw its pager --- internal/listpages/query.go | 118 + internal/listpages/query_test.go | 170 ++ internal/listpages/render.go | 197 ++ internal/listpages/render_test.go | 224 ++ .../listpages/testdata/oracle_pagination.py | 30 + .../listpages/testdata/oracle_sections.py | 56 + internal/listpages/testdata/pagination.golden | 2443 +++++++++++++++++ .../listpages/testdata/pagination_corpus.json | 404 +++ internal/listpages/testdata/sections.golden | 48 + .../listpages/testdata/sections_corpus.json | 50 + 10 files changed, 3740 insertions(+) create mode 100644 internal/listpages/query.go create mode 100644 internal/listpages/query_test.go create mode 100644 internal/listpages/render.go create mode 100644 internal/listpages/render_test.go create mode 100644 internal/listpages/testdata/oracle_pagination.py create mode 100644 internal/listpages/testdata/oracle_sections.py create mode 100644 internal/listpages/testdata/pagination.golden create mode 100644 internal/listpages/testdata/pagination_corpus.json create mode 100644 internal/listpages/testdata/sections.golden create mode 100644 internal/listpages/testdata/sections_corpus.json diff --git a/internal/listpages/query.go b/internal/listpages/query.go new file mode 100644 index 00000000..4daed886 --- /dev/null +++ b/internal/listpages/query.go @@ -0,0 +1,118 @@ +package listpages + +import ( + "errors" + "slices" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +const maxPerPage = 250 + +// PageIndex is what the first row's %%index%% counts from, so it moves with +// the pagination rather than with the offset. +type Result struct { + Pages []db.Article + PageIndex int + Page int + TotalPages int + Total int +} + +func Run(src Source, q Query, viewer *db.User, paginate bool) (Result, error) { + // The cap belongs here rather than in the parsing, because what the reader + // asked for is what the frontend gets handed back. + q.PerPage = min(q.PerPage, maxPerPage) + empty := Result{Page: 1, TotalPages: 1} + if q.Invalid { + return empty, nil + } + hidden, err := src.HiddenCategories(viewer) + if err != nil { + return Result{}, err + } + + if q.HasOnly { + if containsFold(hidden, q.Only.Category) { + return empty, nil + } + return Result{Pages: []db.Article{*q.Only}, Page: 1, TotalPages: 1, Total: 1}, nil + } + if q.HasFullName { + found, err := src.ArticleByRef(strings.ToLower(q.FullName)) + if errors.Is(err, db.ErrNotFound) { + return empty, nil + } + if err != nil { + return Result{}, err + } + if containsFold(hidden, found.Category) { + return empty, nil + } + return Result{Pages: []db.Article{*found}, Page: 1, TotalPages: 1, Total: 1}, nil + } + + filter := q.Filter + filter.Hidden = hidden + + total, err := src.CountArticles(filter, q.Offset, q.Limit) + if err != nil { + return Result{}, err + } + + if !paginate { + pages, err := src.ListArticles(filter, q.Offset, q.Limit) + if err != nil { + return Result{}, err + } + return Result{Pages: pages, Page: 1, TotalPages: 1, Total: total}, nil + } + + offset, limit, skip := window(q) + var pages []db.Article + if !skip { + pages, err = src.ListArticles(filter, offset, limit) + if err != nil { + return Result{}, err + } + } + return Result{ + Pages: pages, + PageIndex: (q.Page - 1) * q.PerPage, + Page: q.Page, + TotalPages: totalPages(total, q.PerPage), + Total: total, + }, nil +} + +func window(q Query) (offset int, limit *int, skip bool) { + if q.PerPage <= 0 { + return 0, nil, true + } + start := (q.Page - 1) * q.PerPage + offset = q.Offset + start + perPage := q.PerPage + if q.Limit == nil { + return offset, &perPage, false + } + remaining := *q.Limit - start + if remaining <= 0 { + return offset, nil, true + } + bounded := min(perPage, remaining) + return offset, &bounded, false +} + +// A per-page of zero would divide by zero in Django, so this reports no pages +// at all rather than failing the request. +func totalPages(total, perPage int) int { + if perPage <= 0 { + return 0 + } + return (total + perPage - 1) / perPage +} + +func containsFold(values []string, want string) bool { + return slices.ContainsFunc(values, func(v string) bool { return strings.EqualFold(v, want) }) +} diff --git a/internal/listpages/query_test.go b/internal/listpages/query_test.go new file mode 100644 index 00000000..c1f35563 --- /dev/null +++ b/internal/listpages/query_test.go @@ -0,0 +1,170 @@ +package listpages + +import ( + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func intPtr(n int) *int { return &n } + +func TestWindowStacksPaginationOnTheOffset(t *testing.T) { + offset, limit, skip := window(Query{Offset: 5, Page: 3, PerPage: 20}) + if skip { + t.Fatal("window().skip = true, want false") + } + if offset != 45 { + t.Errorf("window().offset = %d, want 45", offset) + } + if limit == nil || *limit != 20 { + t.Errorf("window().limit = %v, want 20", limit) + } +} + +func TestWindowNarrowsTheLastPageToTheLimit(t *testing.T) { + offset, limit, skip := window(Query{Offset: 0, Limit: intPtr(25), Page: 2, PerPage: 20}) + if skip { + t.Fatal("window().skip = true, want false") + } + if offset != 20 { + t.Errorf("window().offset = %d, want 20", offset) + } + if limit == nil || *limit != 5 { + t.Errorf("window().limit = %v, want 5", limit) + } +} + +func TestWindowSkipsAPageBeyondTheLimit(t *testing.T) { + if _, _, skip := window(Query{Limit: intPtr(10), Page: 2, PerPage: 20}); !skip { + t.Error("window().skip = false, want true") + } +} + +func TestWindowSkipsWhenNoPageHasRoom(t *testing.T) { + if _, _, skip := window(Query{Page: 1, PerPage: 0}); !skip { + t.Error("window(perpage=0).skip = false, want true") + } +} + +func TestTotalPagesRoundsUp(t *testing.T) { + cases := []struct{ total, perPage, want int }{ + {0, 20, 0}, + {1, 20, 1}, + {20, 20, 1}, + {21, 20, 2}, + {40, 20, 2}, + {5, 0, 0}, + } + for _, c := range cases { + if got := totalPages(c.total, c.perPage); got != c.want { + t.Errorf("totalPages(%d, %d) = %d, want %d", c.total, c.perPage, got, c.want) + } + } +} + +func TestRunCapsThePageSize(t *testing.T) { + src := newFakeSource() + src.total = 1000 + got, err := Run(src, Query{Page: 1, PerPage: 300}, nil, true) + if err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if src.gotLimit == nil || *src.gotLimit != 250 { + t.Errorf("limit = %v, want 250", src.gotLimit) + } + if got.TotalPages != 4 { + t.Errorf("TotalPages = %d, want 4", got.TotalPages) + } +} + +func TestRunOfAnInvalidQueryListsNothing(t *testing.T) { + src := newFakeSource() + got, err := Run(src, Query{Invalid: true}, nil, true) + if err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if len(got.Pages) != 0 || got.Total != 0 || got.Page != 1 || got.TotalPages != 1 { + t.Errorf("Run(invalid) = %+v, want an empty first page", got) + } + if src.listCalls != 0 { + t.Errorf("listCalls = %d, want 0", src.listCalls) + } +} + +func TestRunOfASinglePage(t *testing.T) { + src := newFakeSource() + only := article173() + got, err := Run(src, Query{HasOnly: true, Only: only}, nil, true) + if err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if len(got.Pages) != 1 || got.Pages[0].ID != 7 || got.Total != 1 { + t.Errorf("Run(only) = %+v, want the one article", got) + } +} + +func TestRunOfASinglePageInAHiddenCategory(t *testing.T) { + src := newFakeSource() + src.hidden = []string{"SCP"} + got, err := Run(src, Query{HasOnly: true, Only: article173()}, nil, true) + if err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if len(got.Pages) != 0 { + t.Errorf("Run(only, hidden) = %+v, want nothing", got) + } +} + +func TestRunOfAFullNameThatDoesNotExist(t *testing.T) { + src := newFakeSource() + got, err := Run(src, Query{HasFullName: true, FullName: "no-such-page"}, nil, true) + if err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if len(got.Pages) != 0 || got.Total != 0 { + t.Errorf("Run(fullname) = %+v, want nothing", got) + } +} + +func TestRunPassesTheHiddenCategoriesToTheFilter(t *testing.T) { + src := newFakeSource() + src.hidden = []string{"admin"} + src.total = 3 + if _, err := Run(src, Query{Page: 1, PerPage: 20}, nil, true); err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if len(src.gotFilter.Hidden) != 1 || src.gotFilter.Hidden[0] != "admin" { + t.Errorf("Hidden = %v, want [admin]", src.gotFilter.Hidden) + } +} + +func TestRunReportsThePageIndexOfTheFirstRow(t *testing.T) { + src := newFakeSource() + src.total = 45 + src.listed = []db.Article{*article173()} + got, err := Run(src, Query{Page: 3, PerPage: 20}, nil, true) + if err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if got.PageIndex != 40 { + t.Errorf("PageIndex = %d, want 40", got.PageIndex) + } + if got.TotalPages != 3 { + t.Errorf("TotalPages = %d, want 3", got.TotalPages) + } +} + +func TestRunWithoutPaginationIgnoresThePageNumber(t *testing.T) { + src := newFakeSource() + src.total = 45 + got, err := Run(src, Query{Offset: 2, Page: 3, PerPage: 20}, nil, false) + if err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if src.gotOffset != 2 { + t.Errorf("offset = %d, want 2", src.gotOffset) + } + if got.TotalPages != 1 || got.Page != 1 { + t.Errorf("Run(no pagination) page, total = %d, %d, want 1, 1", got.Page, got.TotalPages) + } +} diff --git a/internal/listpages/render.go b/internal/listpages/render.go new file mode 100644 index 00000000..29b6267f --- /dev/null +++ b/internal/listpages/render.go @@ -0,0 +1,197 @@ +package listpages + +import ( + "regexp" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +type Sections struct { + Head string + Body string + Foot string +} + +// The two characters this eats around each part are not a mistake to fix. They +// are what the running site's output already has, so removing them would move +// every listing by two characters. +var sectionPattern = regexp.MustCompile(`(?is)\A(?:.*\s*(\[\[head]]\n?.(?P.*?).\[\[/head]])|)` + + `(?:.*\s*(\[\[body]]\n?.(?P.*?).\[\[/body]])|)` + + `(?:.*\s*(\[\[foot]]\n?.(?P.*?).\[\[/foot]])|)`) + +func Split(content string) Sections { + match := sectionPattern.FindStringSubmatch(content) + if match == nil { + return Sections{} + } + var out Sections + for i, name := range sectionPattern.SubexpNames() { + switch name { + case "head": + out.Head = match[i] + case "body": + out.Body = match[i] + case "foot": + out.Foot = match[i] + } + } + return out +} + +const urlParamPrefix = "@url|" + +func URLParams(params map[string]string, path page.PathParams) (values map[string]string, null map[string]bool) { + null = map[string]bool{} + for key, value := range params { + if len(value) < len(urlParamPrefix) || + !strings.EqualFold(value[:len(urlParamPrefix)], urlParamPrefix) { + continue + } + if param, ok := path.Lookup(key); ok { + params[key] = param.Value + if param.Bare { + null[key] = true + } + continue + } + params[key] = value[len(urlParamPrefix):] + } + return params, null +} + +func BasePath(fullName string, path page.PathParams) string { + if fullName == "" { + return "#" + } + out := "/" + fullName + for _, param := range path { + if param.Key == "p" { + continue + } + out += "/" + quotePlus(param.Key) + "/" + quotePlus(pathValue(param)) + } + return out +} + +// A key that arrived without a value is spelled the way Python spells the +// None it stores for one. +func pathValue(param page.PathParam) string { + if param.Bare { + return "None" + } + return param.Value +} + +func quotePlus(s string) string { + return strings.ReplaceAll(page.QuoteAll(s), "%20", "+") +} + +const ( + ind12 = " " + ind16 = " " + ind20 = " " + ind24 = " " +) + +func Pagination(loc *i18n.Localizer, basePath string, current, total int) string { + if total <= 1 { + return "" + } + const around = 2 + + leftFrom := 1 + leftTo := leftFrom + 1 + if current < around*2+1 { + leftTo = around + 1 + } + if leftTo > total-1 { + leftTo = total - 1 + } + rightTo := total + rightFrom := max(leftTo+1, rightTo-1) + if current > rightTo-(around*2+1) { + rightFrom = max(leftTo+1, total-(around+1)) + } + centerFrom := max(leftTo+1, current-around) + centerTo := min(rightFrom-1, current+around) + + var b strings.Builder + b.WriteString(`
` + "\n" + ind16) + b.WriteString(`` + + text(loc, "module-listpages-pager-count", "page", strconv.Itoa(current), "total", strconv.Itoa(total)) + + `` + "\n" + ind16) + + if current > 1 { + b.WriteString("\n" + ind20 + step(loc, basePath, current-1, "module-listpages-pager-prev") + "\n" + ind16) + } + b.WriteString("\n" + ind16) + + writeRange := func(class string, from, to int) { + for p := from; p <= to; p++ { + b.WriteString("\n" + ind20 + "\n" + ind24 + number(basePath, class, p, p == current) + "\n" + ind20 + "\n" + ind16) + } + } + writeDots := func(show bool) { + if show { + b.WriteString("\n" + ind20 + `...` + "\n" + ind16) + } + b.WriteString("\n" + ind16) + } + + writeRange("1", leftFrom, leftTo) + b.WriteString("\n" + ind16) + writeDots(centerFrom > leftTo+1) + writeRange("2", centerFrom, centerTo) + b.WriteString("\n" + ind16) + writeDots(centerTo < rightFrom-1) + writeRange("3", rightFrom, rightTo) + b.WriteString("\n" + ind16) + + if current < total { + b.WriteString("\n" + ind20 + step(loc, basePath, current+1, "module-listpages-pager-next") + "\n" + ind16) + } + b.WriteString("\n" + ind12 + "
") + return b.String() +} + +func step(loc *i18n.Localizer, basePath string, target int, label string) string { + return `` + text(loc, label) + `` +} + +func number(basePath, class string, p int, current bool) string { + if current { + return `` + strconv.Itoa(p) + `` + } + return `` + strconv.Itoa(p) + `` +} + +func pageHref(basePath string, p int) string { + if basePath == "" { + return "#" + } + return escape.HTML(basePath) + "/p/" + strconv.Itoa(p) +} + +func text(loc *i18n.Localizer, id string, args ...any) string { + if loc == nil { + return id + } + return loc.T(id, args...) +} + +func Wrap(content, pagination, pathParams, params, body, pageID string) string { + return `
` + "\n" + + ind16 + content + "\n" + + ind16 + pagination + "\n" + + ind16 + "
" +} diff --git a/internal/listpages/render_test.go b/internal/listpages/render_test.go new file mode 100644 index 00000000..b3759b97 --- /dev/null +++ b/internal/listpages/render_test.go @@ -0,0 +1,224 @@ +package listpages + +import ( + "encoding/json" + "flag" + "fmt" + "os" + "path/filepath" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" +) + +var update = flag.Bool("update", false, "rewrite the golden files and the corpora the oracles read") + +const ( + pagerGolden = "testdata/pagination.golden" + pagerCorpus = "testdata/pagination_corpus.json" + sectionsGolden = "testdata/sections.golden" + sectionsCorpus = "testdata/sections_corpus.json" +) + +type pagerCase struct { + Name string `json:"name"` + BasePath string `json:"base_path"` + Page int `json:"page"` + Total int `json:"total_pages"` +} + +func pagerCases() []pagerCase { + var out []pagerCase + add := func(name, basePath string, page, total int) { + out = append(out, pagerCase{Name: name, BasePath: basePath, Page: page, Total: total}) + } + add("single-page", "/main", 1, 1) + add("no-pages", "/main", 1, 0) + for _, total := range []int{2, 3, 4, 5, 6, 7, 9, 12, 30} { + for _, current := range []int{1, 2, 3, 4, 5, 6, total - 1, total} { + if current < 1 || current > total { + continue + } + add(fmt.Sprintf("total-%d-page-%d", total, current), "/main", current, total) + } + } + add("hash-base", "#", 3, 9) + add("base-with-params", "/scp:series/tag/euclid", 2, 4) + add("base-needing-escape", `/main/q/a"b&c`, 2, 4) + return out +} + +func localizer(t *testing.T) *i18n.Localizer { + t.Helper() + bundle, err := i18n.Load("") + if err != nil { + t.Fatalf("i18n.Load() err = %v, want nil", err) + } + return bundle.Localizer(i18n.DefaultLanguage) +} + +func TestPaginationMatchesGolden(t *testing.T) { + loc := localizer(t) + cases := pagerCases() + + var b strings.Builder + for _, c := range cases { + fmt.Fprintf(&b, "=== %s\n%s\n", c.Name, Pagination(loc, c.BasePath, c.Page, c.Total)) + } + compareGolden(t, pagerGolden, b.String(), pagerCorpus, cases) +} + +type sectionCase struct { + Name string `json:"name"` + Content string `json:"content"` +} + +func sectionCases() []sectionCase { + return []sectionCase{ + {"empty", ""}, + {"plain", "%%title%%"}, + {"head-only", "[[head]]\nbefore\n[[/head]]"}, + {"body-only", "[[body]]\n%%title%%\n[[/body]]"}, + {"foot-only", "[[foot]]\nafter\n[[/foot]]"}, + {"all-three", "[[head]]\nbefore\n[[/head]]\n[[body]]\n%%title%%\n[[/body]]\n[[foot]]\nafter\n[[/foot]]"}, + {"no-newline-after-open", "[[head]]before[[/head]]"}, + {"uppercase-tags", "[[HEAD]]\nbefore\n[[/HEAD]]"}, + {"multiline-body", "[[body]]\none\ntwo\nthree\n[[/body]]"}, + {"leading-text", "junk\n[[body]]\nrow\n[[/body]]"}, + {"empty-body", "[[body]]\n[[/body]]"}, + {"body-before-head", "[[body]]\nrow\n[[/body]]\n[[head]]\ntop\n[[/head]]"}, + } +} + +func TestSplitMatchesGolden(t *testing.T) { + cases := sectionCases() + + var b strings.Builder + for _, c := range cases { + s := Split(c.Content) + fmt.Fprintf(&b, "=== %s\nhead=%s\nbody=%s\nfoot=%s\n", c.Name, + pyjson.String(s.Head), pyjson.String(s.Body), pyjson.String(s.Foot)) + } + compareGolden(t, sectionsGolden, b.String(), sectionsCorpus, cases) +} + +func compareGolden(t *testing.T, goldenPath, got, corpusPath string, corpus any) { + t.Helper() + if *update { + writeJSON(t, corpusPath, corpus) + if err := os.WriteFile(filepath.FromSlash(goldenPath), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", goldenPath, err) + } + return + } + want, err := os.ReadFile(filepath.FromSlash(goldenPath)) + if err != nil { + t.Fatalf("ReadFile(%s) err = %v, want nil", goldenPath, err) + } + if got != string(want) { + gotAt, wantAt := firstDiff(got, string(want)) + t.Errorf("render = %q, want %q", gotAt, wantAt) + } +} + +func writeJSON(t *testing.T, path string, v any) { + t.Helper() + data, err := json.MarshalIndent(v, "", " ") + if err != nil { + t.Fatalf("Marshal(%s) err = %v, want nil", path, err) + } + if err := os.WriteFile(filepath.FromSlash(path), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", path, err) + } +} + +func firstDiff(got, want string) (string, string) { + for i := 0; i < len(got) && i < len(want); i++ { + if got[i] != want[i] { + return excerpt(got, i), excerpt(want, i) + } + } + at := min(len(got), len(want)) + return excerpt(got, at), excerpt(want, at) +} + +func excerpt(s string, at int) string { + return s[max(0, at-40):min(len(s), at+40)] +} + +func TestBasePathDropsThePageNumber(t *testing.T) { + params := page.PathParams{ + {Key: "tag", Value: "euclid"}, + {Key: "p", Value: "3"}, + {Key: "sort", Value: "a b"}, + } + got := BasePath("scp:series", params) + want := "/scp:series/tag/euclid/sort/a+b" + if got != want { + t.Errorf("BasePath(scp:series, ...) = %q, want %q", got, want) + } +} + +func TestBasePathSpellsABareKeyAsNone(t *testing.T) { + got := BasePath("main", page.PathParams{{Key: "edit", Bare: true}}) + if want := "/main/edit/None"; got != want { + t.Errorf("BasePath(main, edit) = %q, want %q", got, want) + } +} + +func TestBasePathWithoutAPage(t *testing.T) { + if got := BasePath("", nil); got != "#" { + t.Errorf("BasePath(\"\", nil) = %q, want %q", got, "#") + } +} + +func TestURLParamsReadsThePath(t *testing.T) { + params := map[string]string{"tags": "@url|default", "category": "scp"} + got, null := URLParams(params, page.PathParams{{Key: "tags", Value: "euclid"}}) + if got["tags"] != "euclid" { + t.Errorf("URLParams()[tags] = %q, want %q", got["tags"], "euclid") + } + if got["category"] != "scp" { + t.Errorf("URLParams()[category] = %q, want %q", got["category"], "scp") + } + if len(null) != 0 { + t.Errorf("len(null) = %d, want 0", len(null)) + } +} + +func TestURLParamsFallsBackToTheDefault(t *testing.T) { + got, _ := URLParams(map[string]string{"tags": "@url|euclid"}, nil) + if got["tags"] != "euclid" { + t.Errorf("URLParams()[tags] = %q, want %q", got["tags"], "euclid") + } +} + +func TestURLParamsMarksABareKeyAsNull(t *testing.T) { + _, null := URLParams(map[string]string{"tags": "@url|x"}, page.PathParams{{Key: "tags", Bare: true}}) + if !null["tags"] { + t.Errorf("null[tags] = false, want true") + } +} + +func TestURLParamsIgnoresCaseOfThePrefix(t *testing.T) { + got, _ := URLParams(map[string]string{"tags": "@URL|euclid"}, nil) + if got["tags"] != "euclid" { + t.Errorf("URLParams()[tags] = %q, want %q", got["tags"], "euclid") + } +} + +func TestWrapEscapesTheDataAttributes(t *testing.T) { + got := Wrap("body", "", `{"a": "b"}`, `{}`, `"x"`, "main") + if !strings.Contains(got, `data-list-pages-path-params="{"a": "b"}"`) { + t.Errorf("Wrap() = %q, want the path params escaped", got) + } + if !strings.HasPrefix(got, `
") { + t.Errorf("Wrap() = %q, want the box to close indented", got) + } +} diff --git a/internal/listpages/testdata/oracle_pagination.py b/internal/listpages/testdata/oracle_pagination.py new file mode 100644 index 00000000..b26cffac --- /dev/null +++ b/internal/listpages/testdata/oracle_pagination.py @@ -0,0 +1,30 @@ +"""Record Django's own pager for the cases the Go golden covers. + + docker compose exec -T -e PAGINATION_CORPUS="$(cat pagination_corpus.json)" \ + web python manage.py shell < oracle_pagination.py > pagination.django + +The corpus is exported by `go test ./internal/listpages -update`. Compare the +output with testdata/pagination.golden; they have to be byte for byte the same. +""" + +import json +import os +import sys + +from modules.listpages import render_pagination + +try: + CORPUS = json.loads(os.environ['PAGINATION_CORPUS']) +except KeyError: + raise SystemExit(__doc__) + + +def main(): + out = [] + for case in CORPUS: + html = render_pagination(case['base_path'], case['page'], case['total_pages']) + out.append('=== %s\n%s\n' % (case['name'], html)) + sys.stdout.write(''.join(out)) + + +main() diff --git a/internal/listpages/testdata/oracle_sections.py b/internal/listpages/testdata/oracle_sections.py new file mode 100644 index 00000000..111e3125 --- /dev/null +++ b/internal/listpages/testdata/oracle_sections.py @@ -0,0 +1,56 @@ +"""Record what Python's regex pulls out of a module body. + + docker compose exec -T -e SECTIONS_CORPUS="$(cat sections_corpus.json)" \ + web python manage.py shell < oracle_sections.py > sections.django + +The pattern is lifted out of the module source rather than copied here, so a +transcription slip in this script cannot make the two sides agree by accident. +Compare the output with testdata/sections.golden. +""" + +import ast +import json +import os +import re +import sys + +try: + CORPUS = json.loads(os.environ['SECTIONS_CORPUS']) +except KeyError: + raise SystemExit(__doc__) + +SOURCE = 'modules/listpages/__init__.py' + + +def find_pattern(): + tree = ast.parse(open(SOURCE, encoding='utf-8').read()) + for node in ast.walk(tree): + if not isinstance(node, ast.Call): + continue + func = node.func + if not isinstance(func, ast.Attribute) or func.attr != 'match': + continue + if not isinstance(func.value, ast.Name) or func.value.id != 're': + continue + first = node.args[0] + if isinstance(first, ast.Constant) and 'head]]' in first.value: + return first.value + raise SystemExit('no head/body/foot pattern found in %s' % SOURCE) + + +def main(): + pattern = re.compile(find_pattern(), re.S | re.I | re.M) + out = [] + for case in CORPUS: + selection = pattern.match(case['content']) + head = body = foot = '' + if selection: + head = selection.group('head') or '' + body = selection.group('body') or '' + foot = selection.group('foot') or '' + out.append('=== %s\nhead=%s\nbody=%s\nfoot=%s\n' % ( + case['name'], json.dumps(head), json.dumps(body), json.dumps(foot))) + sys.stdout.write(''.join(out)) + + +main() diff --git a/internal/listpages/testdata/pagination.golden b/internal/listpages/testdata/pagination.golden new file mode 100644 index 00000000..29c95496 --- /dev/null +++ b/internal/listpages/testdata/pagination.golden @@ -0,0 +1,2443 @@ +=== single-page + +=== no-pages + +=== total-2-page-1 +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+=== total-2-page-2 +
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+=== total-2-page-1 +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+=== total-2-page-2 +
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+=== total-3-page-1 +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+=== total-3-page-2 +
+ 第 2 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+=== total-3-page-3 +
+ 第 3 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + +
+=== total-3-page-2 +
+ 第 2 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+=== total-3-page-3 +
+ 第 3 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + +
+=== total-4-page-1 +
+ 第 1 页; 共 4 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+=== total-4-page-2 +
+ 第 2 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+=== total-4-page-3 +
+ 第 3 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+=== total-4-page-4 +
+ 第 4 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + +
+=== total-4-page-3 +
+ 第 3 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+=== total-4-page-4 +
+ 第 4 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + +
+=== total-5-page-1 +
+ 第 1 页; 共 5 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+=== total-5-page-2 +
+ 第 2 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+=== total-5-page-3 +
+ 第 3 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+=== total-5-page-4 +
+ 第 4 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+=== total-5-page-5 +
+ 第 5 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 4 + + + + 5 + + + +
+=== total-5-page-4 +
+ 第 4 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+=== total-5-page-5 +
+ 第 5 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 4 + + + + 5 + + + +
+=== total-6-page-1 +
+ 第 1 页; 共 6 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 5 + + + + 6 + + + + 下一页 » + +
+=== total-6-page-2 +
+ 第 2 页; 共 6 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 6 + + + + 下一页 » + +
+=== total-6-page-3 +
+ 第 3 页; 共 6 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 6 + + + + 下一页 » + +
+=== total-6-page-4 +
+ 第 4 页; 共 6 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 6 + + + + 下一页 » + +
+=== total-6-page-5 +
+ 第 5 页; 共 6 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 4 + + + + 5 + + + + 6 + + + + 下一页 » + +
+=== total-6-page-6 +
+ 第 6 页; 共 6 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 3 + + + + 4 + + + + 5 + + + + 6 + + + +
+=== total-6-page-5 +
+ 第 5 页; 共 6 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 4 + + + + 5 + + + + 6 + + + + 下一页 » + +
+=== total-6-page-6 +
+ 第 6 页; 共 6 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 3 + + + + 4 + + + + 5 + + + + 6 + + + +
+=== total-7-page-1 +
+ 第 1 页; 共 7 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 6 + + + + 7 + + + + 下一页 » + +
+=== total-7-page-2 +
+ 第 2 页; 共 7 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + ... + + + + 6 + + + + 7 + + + + 下一页 » + +
+=== total-7-page-3 +
+ 第 3 页; 共 7 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + 下一页 » + +
+=== total-7-page-4 +
+ 第 4 页; 共 7 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + 下一页 » + +
+=== total-7-page-5 +
+ 第 5 页; 共 7 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + 3 + + + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + 下一页 » + +
+=== total-7-page-6 +
+ 第 6 页; 共 7 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + 下一页 » + +
+=== total-7-page-6 +
+ 第 6 页; 共 7 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + 下一页 » + +
+=== total-7-page-7 +
+ 第 7 页; 共 7 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + +
+=== total-9-page-1 +
+ 第 1 页; 共 9 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 8 + + + + 9 + + + + 下一页 » + +
+=== total-9-page-2 +
+ 第 2 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + ... + + + + 8 + + + + 9 + + + + 下一页 » + +
+=== total-9-page-3 +
+ 第 3 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + ... + + + + 8 + + + + 9 + + + + 下一页 » + +
+=== total-9-page-4 +
+ 第 4 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + 6 + + + + ... + + + + 8 + + + + 9 + + + + 下一页 » + +
+=== total-9-page-5 +
+ 第 5 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + 3 + + + + 4 + + + + 5 + + + + + + 6 + + + + 7 + + + + 8 + + + + 9 + + + + 下一页 » + +
+=== total-9-page-6 +
+ 第 6 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + 4 + + + + 5 + + + + + + 6 + + + + 7 + + + + 8 + + + + 9 + + + + 下一页 » + +
+=== total-9-page-8 +
+ 第 8 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 6 + + + + 7 + + + + 8 + + + + 9 + + + + 下一页 » + +
+=== total-9-page-9 +
+ 第 9 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 6 + + + + 7 + + + + 8 + + + + 9 + + + +
+=== total-12-page-1 +
+ 第 1 页; 共 12 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 11 + + + + 12 + + + + 下一页 » + +
+=== total-12-page-2 +
+ 第 2 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + ... + + + + 11 + + + + 12 + + + + 下一页 » + +
+=== total-12-page-3 +
+ 第 3 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + ... + + + + 11 + + + + 12 + + + + 下一页 » + +
+=== total-12-page-4 +
+ 第 4 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + 6 + + + + ... + + + + 11 + + + + 12 + + + + 下一页 » + +
+=== total-12-page-5 +
+ 第 5 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + 3 + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + ... + + + + 11 + + + + 12 + + + + 下一页 » + +
+=== total-12-page-6 +
+ 第 6 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + 8 + + + + ... + + + + 11 + + + + 12 + + + + 下一页 » + +
+=== total-12-page-11 +
+ 第 11 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 9 + + + + 10 + + + + 11 + + + + 12 + + + + 下一页 » + +
+=== total-12-page-12 +
+ 第 12 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 9 + + + + 10 + + + + 11 + + + + 12 + + + +
+=== total-30-page-1 +
+ 第 1 页; 共 30 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 29 + + + + 30 + + + + 下一页 » + +
+=== total-30-page-2 +
+ 第 2 页; 共 30 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + ... + + + + 29 + + + + 30 + + + + 下一页 » + +
+=== total-30-page-3 +
+ 第 3 页; 共 30 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + ... + + + + 29 + + + + 30 + + + + 下一页 » + +
+=== total-30-page-4 +
+ 第 4 页; 共 30 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + 6 + + + + ... + + + + 29 + + + + 30 + + + + 下一页 » + +
+=== total-30-page-5 +
+ 第 5 页; 共 30 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + 3 + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + ... + + + + 29 + + + + 30 + + + + 下一页 » + +
+=== total-30-page-6 +
+ 第 6 页; 共 30 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + 4 + + + + 5 + + + + 6 + + + + 7 + + + + 8 + + + + ... + + + + 29 + + + + 30 + + + + 下一页 » + +
+=== total-30-page-29 +
+ 第 29 页; 共 30 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 27 + + + + 28 + + + + 29 + + + + 30 + + + + 下一页 » + +
+=== total-30-page-30 +
+ 第 30 页; 共 30 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 27 + + + + 28 + + + + 29 + + + + 30 + + + +
+=== hash-base +
+ 第 3 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + ... + + + + 8 + + + + 9 + + + + 下一页 » + +
+=== base-with-params +
+ 第 2 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+=== base-needing-escape +
+ 第 2 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
diff --git a/internal/listpages/testdata/pagination_corpus.json b/internal/listpages/testdata/pagination_corpus.json new file mode 100644 index 00000000..8f2f3aad --- /dev/null +++ b/internal/listpages/testdata/pagination_corpus.json @@ -0,0 +1,404 @@ +[ + { + "name": "single-page", + "base_path": "/main", + "page": 1, + "total_pages": 1 + }, + { + "name": "no-pages", + "base_path": "/main", + "page": 1, + "total_pages": 0 + }, + { + "name": "total-2-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 2 + }, + { + "name": "total-2-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 2 + }, + { + "name": "total-2-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 2 + }, + { + "name": "total-2-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 2 + }, + { + "name": "total-3-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 3 + }, + { + "name": "total-3-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 3 + }, + { + "name": "total-3-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 3 + }, + { + "name": "total-3-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 3 + }, + { + "name": "total-3-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 3 + }, + { + "name": "total-4-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 4 + }, + { + "name": "total-4-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 4 + }, + { + "name": "total-4-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 4 + }, + { + "name": "total-4-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 4 + }, + { + "name": "total-4-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 4 + }, + { + "name": "total-4-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 4 + }, + { + "name": "total-5-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 5 + }, + { + "name": "total-5-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 5 + }, + { + "name": "total-5-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 5 + }, + { + "name": "total-5-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 5 + }, + { + "name": "total-5-page-5", + "base_path": "/main", + "page": 5, + "total_pages": 5 + }, + { + "name": "total-5-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 5 + }, + { + "name": "total-5-page-5", + "base_path": "/main", + "page": 5, + "total_pages": 5 + }, + { + "name": "total-6-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 6 + }, + { + "name": "total-6-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 6 + }, + { + "name": "total-6-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 6 + }, + { + "name": "total-6-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 6 + }, + { + "name": "total-6-page-5", + "base_path": "/main", + "page": 5, + "total_pages": 6 + }, + { + "name": "total-6-page-6", + "base_path": "/main", + "page": 6, + "total_pages": 6 + }, + { + "name": "total-6-page-5", + "base_path": "/main", + "page": 5, + "total_pages": 6 + }, + { + "name": "total-6-page-6", + "base_path": "/main", + "page": 6, + "total_pages": 6 + }, + { + "name": "total-7-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 7 + }, + { + "name": "total-7-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 7 + }, + { + "name": "total-7-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 7 + }, + { + "name": "total-7-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 7 + }, + { + "name": "total-7-page-5", + "base_path": "/main", + "page": 5, + "total_pages": 7 + }, + { + "name": "total-7-page-6", + "base_path": "/main", + "page": 6, + "total_pages": 7 + }, + { + "name": "total-7-page-6", + "base_path": "/main", + "page": 6, + "total_pages": 7 + }, + { + "name": "total-7-page-7", + "base_path": "/main", + "page": 7, + "total_pages": 7 + }, + { + "name": "total-9-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 9 + }, + { + "name": "total-9-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 9 + }, + { + "name": "total-9-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 9 + }, + { + "name": "total-9-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 9 + }, + { + "name": "total-9-page-5", + "base_path": "/main", + "page": 5, + "total_pages": 9 + }, + { + "name": "total-9-page-6", + "base_path": "/main", + "page": 6, + "total_pages": 9 + }, + { + "name": "total-9-page-8", + "base_path": "/main", + "page": 8, + "total_pages": 9 + }, + { + "name": "total-9-page-9", + "base_path": "/main", + "page": 9, + "total_pages": 9 + }, + { + "name": "total-12-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 12 + }, + { + "name": "total-12-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 12 + }, + { + "name": "total-12-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 12 + }, + { + "name": "total-12-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 12 + }, + { + "name": "total-12-page-5", + "base_path": "/main", + "page": 5, + "total_pages": 12 + }, + { + "name": "total-12-page-6", + "base_path": "/main", + "page": 6, + "total_pages": 12 + }, + { + "name": "total-12-page-11", + "base_path": "/main", + "page": 11, + "total_pages": 12 + }, + { + "name": "total-12-page-12", + "base_path": "/main", + "page": 12, + "total_pages": 12 + }, + { + "name": "total-30-page-1", + "base_path": "/main", + "page": 1, + "total_pages": 30 + }, + { + "name": "total-30-page-2", + "base_path": "/main", + "page": 2, + "total_pages": 30 + }, + { + "name": "total-30-page-3", + "base_path": "/main", + "page": 3, + "total_pages": 30 + }, + { + "name": "total-30-page-4", + "base_path": "/main", + "page": 4, + "total_pages": 30 + }, + { + "name": "total-30-page-5", + "base_path": "/main", + "page": 5, + "total_pages": 30 + }, + { + "name": "total-30-page-6", + "base_path": "/main", + "page": 6, + "total_pages": 30 + }, + { + "name": "total-30-page-29", + "base_path": "/main", + "page": 29, + "total_pages": 30 + }, + { + "name": "total-30-page-30", + "base_path": "/main", + "page": 30, + "total_pages": 30 + }, + { + "name": "hash-base", + "base_path": "#", + "page": 3, + "total_pages": 9 + }, + { + "name": "base-with-params", + "base_path": "/scp:series/tag/euclid", + "page": 2, + "total_pages": 4 + }, + { + "name": "base-needing-escape", + "base_path": "/main/q/a\"b\u0026c", + "page": 2, + "total_pages": 4 + } +] diff --git a/internal/listpages/testdata/sections.golden b/internal/listpages/testdata/sections.golden new file mode 100644 index 00000000..4f397643 --- /dev/null +++ b/internal/listpages/testdata/sections.golden @@ -0,0 +1,48 @@ +=== empty +head="" +body="" +foot="" +=== plain +head="" +body="" +foot="" +=== head-only +head="efore" +body="" +foot="" +=== body-only +head="" +body="%title%%" +foot="" +=== foot-only +head="" +body="" +foot="fter" +=== all-three +head="efore" +body="%title%%" +foot="fter" +=== no-newline-after-open +head="efor" +body="" +foot="" +=== uppercase-tags +head="efore" +body="" +foot="" +=== multiline-body +head="" +body="ne\ntwo\nthree" +foot="" +=== leading-text +head="" +body="ow" +foot="" +=== empty-body +head="" +body="" +foot="" +=== body-before-head +head="op" +body="" +foot="" diff --git a/internal/listpages/testdata/sections_corpus.json b/internal/listpages/testdata/sections_corpus.json new file mode 100644 index 00000000..092780ad --- /dev/null +++ b/internal/listpages/testdata/sections_corpus.json @@ -0,0 +1,50 @@ +[ + { + "name": "empty", + "content": "" + }, + { + "name": "plain", + "content": "%%title%%" + }, + { + "name": "head-only", + "content": "[[head]]\nbefore\n[[/head]]" + }, + { + "name": "body-only", + "content": "[[body]]\n%%title%%\n[[/body]]" + }, + { + "name": "foot-only", + "content": "[[foot]]\nafter\n[[/foot]]" + }, + { + "name": "all-three", + "content": "[[head]]\nbefore\n[[/head]]\n[[body]]\n%%title%%\n[[/body]]\n[[foot]]\nafter\n[[/foot]]" + }, + { + "name": "no-newline-after-open", + "content": "[[head]]before[[/head]]" + }, + { + "name": "uppercase-tags", + "content": "[[HEAD]]\nbefore\n[[/HEAD]]" + }, + { + "name": "multiline-body", + "content": "[[body]]\none\ntwo\nthree\n[[/body]]" + }, + { + "name": "leading-text", + "content": "junk\n[[body]]\nrow\n[[/body]]" + }, + { + "name": "empty-body", + "content": "[[body]]\n[[/body]]" + }, + { + "name": "body-before-head", + "content": "[[body]]\nrow\n[[/body]]\n[[head]]\ntop\n[[/head]]" + } +] From 4c8f6edb6e82212e21f2875ba9b2e8c19be398eb Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 28 Aug 2026 20:31:43 +0900 Subject: [PATCH 068/428] answer listpages --- internal/i18n/locales/zh-hans.json | 3 + internal/modules/listpages.go | 194 +++++++++++++++++++ internal/modules/listpages_test.go | 300 +++++++++++++++++++++++++++++ 3 files changed, 497 insertions(+) create mode 100644 internal/modules/listpages.go create mode 100644 internal/modules/listpages_test.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 6f88894e..75fb8191 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -10,6 +10,9 @@ "include-missing": "插入的页面 \"{name}\" 不存在", "module-disabled": "模块处理已禁用", "module-failed": "处理模块 '{name}' 时出错", + "module-listpages-pager-count": "第 {page} 页; 共 {total} 页", + "module-listpages-pager-next": "下一页 »", + "module-listpages-pager-prev": "« 上一页", "module-pagesbytag-category": " 来自分类 {category}", "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", "module-unknown": "模块 '{name}' 不存在", diff --git a/internal/modules/listpages.go b/internal/modules/listpages.go new file mode 100644 index 00000000..7f031d87 --- /dev/null +++ b/internal/modules/listpages.go @@ -0,0 +1,194 @@ +package modules + +import ( + "slices" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" +) + +func init() { module.Register("listpages", renderListPages) } + +// The two interfaces are kept apart, and this is what stops them drifting. +var _ listpages.Source = (module.Data)(nil) + +// Python runs out of stack and loses one request, while Go would lose the +// whole process. +const maxNesting = 10 + +func renderListPages(env module.Env, params map[string]string, body string) (string, error) { + if env.Render == nil || env.Data == nil { + return "", module.ErrNotPorted + } + pc := env.Page + if pc == nil { + pc = page.NewContext(nil, nil, nil, env.User) + } + if pc.Depth >= maxNesting { + return "", &module.Error{Message: env.Text("module-failed", "name", "listpages")} + } + + body = strings.TrimSpace(body) + params, nullParams := listpages.URLParams(params, pc.PathParams) + + prepend := params["prependline"] + appendix := params["appendline"] + separate := module.BoolParam(params, "separate", true) + wrapper := module.BoolParam(params, "wrapper", true) + + if body != "" { + sections := listpages.Split(body) + if sections.Head != "" { + prepend = sections.Head + } + if sections.Body != "" { + body = sections.Body + } + if sections.Foot != "" { + appendix = sections.Foot + } + } + + // The legacy spelling is copied into the parameters rather than read + // alongside them, so the frontend gets back what the query actually used. + if _, ok := params["created_at"]; !ok { + if legacy, ok := params["date"]; ok { + params["created_at"] = legacy + } + } + + query, err := listpages.Parse(env.Data, pc.Article, env.User, params, pc.PathParams) + if err != nil { + return "", err + } + result, err := listpages.Run(env.Data, query, env.User, true) + if err != nil { + return "", err + } + listed := result.Pages + if module.BoolParam(params, "reverse", false) { + listed = slices.Clone(listed) + slices.Reverse(listed) + } + + common := pc.CloneWith(pc.Article, pc.Article, pc.PathParams, pc.User) + out, err := renderListed(env, common, listed, body, prepend, appendix, result, separate) + if err != nil { + return "", err + } + pc.Merge(common) + + if !wrapper { + return out, nil + } + return wrap(env, pc, out, result, params, body, nullParams) +} + +func renderListed(env module.Env, common *page.Context, listed []db.Article, + body, prepend, appendix string, result listpages.Result, separate bool) (string, error) { + + index := result.PageIndex + next := func(a *db.Article) string { + index++ + vars := page.NewVars(a, env.User, env.Vars, env.Loc) + return page.PageVars(body, vars, index, result.Total) + } + + if !separate { + var source strings.Builder + if prepend != "" { + source.WriteString(prepend + "\n") + } + for i := range listed { + source.WriteString(next(&listed[i]) + "\n") + } + source.WriteString(appendix) + return env.Render(source.String(), common) + } + + var out strings.Builder + if prepend != "" { + html, err := env.Render(prepend+"\n", common) + if err != nil { + return "", err + } + out.WriteString(html) + } + for i := range listed { + source := next(&listed[i]) + nested := common.CloneWith(&listed[i], &listed[i], common.PathParams, common.User) + html, err := env.Render(source+"\n", nested) + if err != nil { + return "", err + } + out.WriteString(html) + common.Merge(nested) + } + if appendix != "" { + html, err := env.Render(appendix, common) + if err != nil { + return "", err + } + out.WriteString(html) + } + return out.String(), nil +} + +func wrap(env module.Env, pc *page.Context, out string, result listpages.Result, + params map[string]string, body string, nullParams map[string]bool) (string, error) { + + pageID := "" + basePath := "#" + if pc.Article != nil { + pageID = pc.Article.FullName() + basePath = listpages.BasePath(pageID, pc.PathParams) + } + + pathJSON, err := pyjson.Marshal(pathParamsObject(pc.PathParams)) + if err != nil { + return "", err + } + paramsJSON, err := pyjson.Marshal(paramsObject(params, nullParams)) + if err != nil { + return "", err + } + + pagination := listpages.Pagination(env.Loc, basePath, result.Page, result.TotalPages) + return listpages.Wrap(out, pagination, pathJSON, paramsJSON, pyjson.String(body), pageID), nil +} + +func pathParamsObject(params page.PathParams) pyjson.Object { + out := make(pyjson.Object, 0, len(params)) + for _, param := range params { + var value any + if !param.Bare { + value = param.Value + } + out = append(out, pyjson.Field{Key: param.Key, Value: value}) + } + return out +} + +// The keys are sorted because the order ftml hands them over in is not stable, +// and an attribute that changes between two renders cannot be compared. +func paramsObject(params map[string]string, null map[string]bool) pyjson.Object { + keys := make([]string, 0, len(params)) + for key := range params { + keys = append(keys, key) + } + slices.Sort(keys) + + out := make(pyjson.Object, 0, len(keys)) + for _, key := range keys { + var value any + if !null[key] { + value = params[key] + } + out = append(out, pyjson.Field{Key: key, Value: value}) + } + return out +} diff --git a/internal/modules/listpages_test.go b/internal/modules/listpages_test.go new file mode 100644 index 00000000..37bdda8c --- /dev/null +++ b/internal/modules/listpages_test.go @@ -0,0 +1,300 @@ +package modules + +import ( + "strings" + "testing" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +type listData struct { + listed []db.Article + total int + filter db.ListFilter + offset int + limit *int +} + +func (d *listData) TagArticles(string, string, []string) ([]db.Article, error) { return nil, nil } + +func (d *listData) TagCategory(string) (db.TagCategory, error) { + return db.TagCategory{}, db.ErrNotFound +} + +func (d *listData) HiddenCategories(*db.User) ([]string, error) { return nil, nil } + +func (d *listData) TagIDsByName(string, string) ([]int64, error) { return nil, nil } + +func (d *listData) ArticleTagIDs(int64) ([]int64, error) { return nil, nil } + +func (d *listData) ArticleByRef(string) (*db.Article, error) { return nil, db.ErrNotFound } + +func (d *listData) UserByUsername(string) (*db.User, error) { return nil, db.ErrNotFound } + +func (d *listData) UserByWikidotName(string) (*db.User, error) { return nil, db.ErrNotFound } + +func (d *listData) SiteRatingMode() (string, error) { return "", db.ErrNotFound } + +func (d *listData) CategoryRatingMode(string) (string, error) { return "", db.ErrNotFound } + +func (d *listData) VoteStats(int64) (db.VoteStats, error) { return db.VoteStats{}, nil } + +func (d *listData) ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) { + d.filter, d.offset, d.limit = f, offset, limit + return d.listed, nil +} + +func (d *listData) CountArticles(db.ListFilter, int, *int) (int, error) { return d.total, nil } + +type nopVars struct{} + +func (nopVars) LatestSource(int64) (string, error) { return "", db.ErrNotFound } +func (nopVars) Authors(int64) ([]db.User, error) { return nil, nil } +func (nopVars) LatestEditor(int64) (*db.User, error) { return nil, db.ErrNotFound } +func (nopVars) RevisionCount(int64) (int, error) { return 0, nil } +func (nopVars) Tags(int64) ([]string, error) { return nil, nil } +func (nopVars) VoteStats(int64) (db.VoteStats, error) { return db.VoteStats{}, nil } +func (nopVars) SiteRatingMode() (string, error) { return "", db.ErrNotFound } +func (nopVars) CategoryRatingMode(string) (string, error) { return "", db.ErrNotFound } +func (nopVars) HasVoted(int64, *int64) (bool, error) { return false, nil } +func (nopVars) ArticleByID(int64) (*db.Article, error) { return nil, db.ErrNotFound } + +func listedArticles(names ...string) []db.Article { + out := make([]db.Article, len(names)) + for i, name := range names { + out[i] = db.Article{ + ID: int64(i + 100), Category: db.DefaultCategory, Name: name, Title: strings.ToUpper(name), + CreatedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC), + UpdatedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC), + } + } + return out +} + +func listEnv(t *testing.T, data *listData, ctx *page.Context) (module.Env, *[]string) { + t.Helper() + var seen []string + return module.Env{ + Page: ctx, + Data: data, + Vars: nopVars{}, + Render: func(source string, pc *page.Context) (string, error) { + seen = append(seen, source) + return "<" + source + ">", nil + }, + }, &seen +} + +func hostPage() *db.Article { + return &db.Article{ID: 1, Category: db.DefaultCategory, Name: "main", Title: "Main"} +} + +func TestListPagesRendersOneSourcePerRow(t *testing.T) { + data := &listData{listed: listedArticles("a", "b"), total: 2} + ctx := page.NewContext(hostPage(), hostPage(), nil, nil) + env, seen := listEnv(t, data, ctx) + + got, err := module.Render(env, "listpages", map[string]string{"wrapper": "no"}, "%%name%% %%index%%/%%total%%") + if err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + want := []string{"a 1/2\n", "b 2/2\n"} + if len(*seen) != len(want) { + t.Fatalf("rendered sources = %q, want %q", *seen, want) + } + for i := range want { + if (*seen)[i] != want[i] { + t.Errorf("rendered source %d = %q, want %q", i, (*seen)[i], want[i]) + } + } + if got != "" { + t.Errorf("Render(listpages) = %q, want the two rows concatenated", got) + } +} + +func TestListPagesJoinsTheRowsWhenSeparateIsOff(t *testing.T) { + data := &listData{listed: listedArticles("a", "b"), total: 2} + ctx := page.NewContext(hostPage(), hostPage(), nil, nil) + env, seen := listEnv(t, data, ctx) + + params := map[string]string{"wrapper": "no", "separate": "no"} + if _, err := module.Render(env, "listpages", params, "%%name%%"); err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + if len(*seen) != 1 { + t.Fatalf("rendered sources = %q, want one pass", *seen) + } + if (*seen)[0] != "a\nb\n" { + t.Errorf("rendered source = %q, want %q", (*seen)[0], "a\nb\n") + } +} + +func TestListPagesReversesTheRows(t *testing.T) { + data := &listData{listed: listedArticles("a", "b"), total: 2} + ctx := page.NewContext(hostPage(), hostPage(), nil, nil) + env, seen := listEnv(t, data, ctx) + + params := map[string]string{"wrapper": "no", "reverse": "yes"} + if _, err := module.Render(env, "listpages", params, "%%name%%"); err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + if (*seen)[0] != "b\n" || (*seen)[1] != "a\n" { + t.Errorf("rendered sources = %q, want [b a]", *seen) + } +} + +func TestListPagesIndexCountsFromThePaginationOffset(t *testing.T) { + data := &listData{listed: listedArticles("a"), total: 45} + ctx := page.NewContext(hostPage(), hostPage(), page.PathParams{{Key: "p", Value: "3"}}, nil) + env, seen := listEnv(t, data, ctx) + + if _, err := module.Render(env, "listpages", map[string]string{"wrapper": "no"}, "%%index%%"); err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + if (*seen)[0] != "41\n" { + t.Errorf("rendered source = %q, want %q", (*seen)[0], "41\n") + } +} + +func TestListPagesPrependAndAppendRenderApart(t *testing.T) { + data := &listData{listed: listedArticles("a"), total: 1} + ctx := page.NewContext(hostPage(), hostPage(), nil, nil) + env, seen := listEnv(t, data, ctx) + + params := map[string]string{"wrapper": "no", "prependline": "top", "appendline": "bottom"} + if _, err := module.Render(env, "listpages", params, "%%name%%"); err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + want := []string{"top\n", "a\n", "bottom"} + if len(*seen) != 3 { + t.Fatalf("rendered sources = %q, want %q", *seen, want) + } + for i := range want { + if (*seen)[i] != want[i] { + t.Errorf("rendered source %d = %q, want %q", i, (*seen)[i], want[i]) + } + } +} + +func TestListPagesBodySectionsOverrideTheParameters(t *testing.T) { + data := &listData{listed: listedArticles("a"), total: 1} + ctx := page.NewContext(hostPage(), hostPage(), nil, nil) + env, seen := listEnv(t, data, ctx) + + params := map[string]string{"wrapper": "no", "prependline": "ignored"} + body := "[[head]]\nXtop\n[[/head]]\n[[body]]\nX%%name%%\n[[/body]]" + if _, err := module.Render(env, "listpages", params, body); err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + if (*seen)[0] != "top\n" { + t.Errorf("rendered source 0 = %q, want %q", (*seen)[0], "top\n") + } + if (*seen)[1] != "a\n" { + t.Errorf("rendered source 1 = %q, want %q", (*seen)[1], "a\n") + } +} + +func TestListPagesWrapperCarriesTheParameters(t *testing.T) { + data := &listData{listed: listedArticles("a"), total: 1} + ctx := page.NewContext(hostPage(), hostPage(), page.PathParams{{Key: "tag", Value: "x"}}, nil) + env, _ := listEnv(t, data, ctx) + + got, err := module.Render(env, "listpages", map[string]string{"category": "*"}, "%%name%%") + if err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + if !strings.Contains(got, `data-list-pages-path-params="{"tag": "x"}"`) { + t.Errorf("Render(listpages) = %q, want the path params in an attribute", got) + } + if !strings.Contains(got, `data-list-pages-params="{"category": "*"}"`) { + t.Errorf("Render(listpages) = %q, want the module params in an attribute", got) + } + if !strings.Contains(got, `data-list-pages-page-id="main"`) { + t.Errorf("Render(listpages) = %q, want the page id in an attribute", got) + } +} + +func TestListPagesWrapperSortsTheParameterKeys(t *testing.T) { + data := &listData{listed: nil, total: 0} + ctx := page.NewContext(hostPage(), hostPage(), nil, nil) + env, _ := listEnv(t, data, ctx) + + params := map[string]string{"zebra": "1", "alpha": "2", "middle": "3", "category": "*"} + got, err := module.Render(env, "listpages", params, "") + if err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + want := `data-list-pages-params="{"alpha": "2", "category": "*",` + + ` "middle": "3", "zebra": "1"}"` + if !strings.Contains(got, want) { + t.Errorf("Render(listpages) = %q, want %q", got, want) + } +} + +func TestListPagesUrlParameterReachesTheQuery(t *testing.T) { + data := &listData{listed: nil, total: 0} + ctx := page.NewContext(hostPage(), hostPage(), page.PathParams{{Key: "name", Value: "from-url"}}, nil) + env, _ := listEnv(t, data, ctx) + + params := map[string]string{"name": "@url|fallback", "category": "*"} + if _, err := module.Render(env, "listpages", params, ""); err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + if !data.filter.HasName || data.filter.Name != "from-url" { + t.Errorf("filter name = %q, want %q", data.filter.Name, "from-url") + } +} + +func TestListPagesLeavesThePathParametersAlone(t *testing.T) { + data := &listData{listed: nil, total: 0} + ctx := page.NewContext(hostPage(), hostPage(), page.PathParams{{Key: "name", Value: "from-url"}}, nil) + env, _ := listEnv(t, data, ctx) + + if _, err := module.Render(env, "listpages", map[string]string{"category": "*"}, ""); err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + if data.filter.HasName { + t.Errorf("filter name = %q, want the path parameter ignored", data.filter.Name) + } +} + +func TestListPagesPagerAppearsOnlyWhenThereIsMoreThanOnePage(t *testing.T) { + data := &listData{listed: listedArticles("a"), total: 45} + ctx := page.NewContext(hostPage(), hostPage(), nil, nil) + env, _ := listEnv(t, data, ctx) + + got, err := module.Render(env, "listpages", map[string]string{"category": "*"}, "") + if err != nil { + t.Fatalf("Render(listpages) err = %v, want nil", err) + } + if !strings.Contains(got, `
`) { + t.Errorf("Render(listpages) = %q, want a pager", got) + } + if !strings.Contains(got, `href="/main/p/2"`) { + t.Errorf("Render(listpages) = %q, want a link to the next page", got) + } +} + +func TestListPagesStopsRecursing(t *testing.T) { + data := &listData{listed: listedArticles("a"), total: 1} + ctx := page.NewContext(hostPage(), hostPage(), nil, nil) + ctx.Depth = maxNesting + env, _ := listEnv(t, data, ctx) + + _, err := module.Render(env, "listpages", nil, "") + var moduleErr *module.Error + if !asModuleError(err, &moduleErr) { + t.Fatalf("Render(listpages) err = %v, want a module error", err) + } +} + +func asModuleError(err error, target **module.Error) bool { + if e, ok := err.(*module.Error); ok { + *target = e + return true + } + return false +} From aacddf276657f03a4f1b8a42fe537576de9053d1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 28 Aug 2026 20:31:58 +0900 Subject: [PATCH 069/428] check listpages against django --- internal/difftest/corpus/articles.txt | 21 ++++++-- internal/difftest/difftest.go | 10 ++++ internal/difftest/listpages.go | 47 ++++++++++++++++++ internal/difftest/listpages_test.go | 39 +++++++++++++++ internal/page/testdata/oracle_seed.py | 71 ++++++++++++++++++++++++++- 5 files changed, 183 insertions(+), 5 deletions(-) create mode 100644 internal/difftest/listpages.go create mode 100644 internal/difftest/listpages_test.go diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 66532fd1..7f3d63cf 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -27,7 +27,22 @@ !/probe:bydisplay # pwikit resolves [[user ]] and Django does not. deliberate. -!/main +/main + !/scp-173 -# both carry a module, and modules are not ported yet, so pwikit leaves a gap -# where the widget goes. drop the ! once the modules land. +# carries [[module Rate]], which nobody has ported. an unported module fails the +# whole render, so this is a 500 and not a gap. drop the ! once rate lands. + +/probe:listed +/probe:listed/p/2 +/probe:listed/p/9 +/probe:listjoined +/probe:listnowrap +/probe:listsections +/probe:listsections/p/2 +/probe:listtags +/probe:listempty +/probe:listurl +/probe:listurl/name/probe:listed +/probe:listbyvotes +/probe:listed/p/2/tag/euclid diff --git a/internal/difftest/difftest.go b/internal/difftest/difftest.go index ebdf5005..932f0d14 100644 --- a/internal/difftest/difftest.go +++ b/internal/difftest/difftest.go @@ -41,6 +41,7 @@ type Scrubber struct { Name string Pattern *regexp.Regexp Repl string + Rewrite func(match []byte) []byte } var DefaultScrubbers = []Scrubber{ @@ -49,6 +50,11 @@ var DefaultScrubbers = []Scrubber{ Pattern: regexp.MustCompile(`(name="csrfmiddlewaretoken"\s+value=")[^"]*(")`), Repl: "${1}SCRUBBED${2}", }, + { + Name: "listpages-params", + Pattern: regexp.MustCompile(`data-list-pages-params="[^"]*"`), + Rewrite: sortListPagesParams, + }, { Name: "html-lang", Pattern: regexp.MustCompile(`(", + """, `"`, + "'", "'", + "&", "&", +) + +func sortListPagesParams(match []byte) []byte { + const prefix = `data-list-pages-params="` + body := string(match) + if !strings.HasPrefix(body, prefix) || !strings.HasSuffix(body, `"`) { + return match + } + raw := attrUnescape.Replace(body[len(prefix) : len(body)-1]) + + var decoded map[string]any + if err := json.Unmarshal([]byte(raw), &decoded); err != nil { + return match + } + keys := make([]string, 0, len(decoded)) + for key := range decoded { + keys = append(keys, key) + } + sort.Strings(keys) + + out := make(pyjson.Object, 0, len(keys)) + for _, key := range keys { + out = append(out, pyjson.Field{Key: key, Value: decoded[key]}) + } + sorted, err := pyjson.Marshal(out) + if err != nil { + return match + } + return []byte(prefix + escape.HTML(sorted) + `"`) +} diff --git a/internal/difftest/listpages_test.go b/internal/difftest/listpages_test.go new file mode 100644 index 00000000..b66add9f --- /dev/null +++ b/internal/difftest/listpages_test.go @@ -0,0 +1,39 @@ +package difftest + +import "testing" + +func TestSortListPagesParamsIsOrderBlind(t *testing.T) { + a := `data-list-pages-params="{"zebra": "1", "alpha": "2"}"` + b := `data-list-pages-params="{"alpha": "2", "zebra": "1"}"` + + got, want := string(sortListPagesParams([]byte(a))), string(sortListPagesParams([]byte(b))) + if got != want { + t.Errorf("sortListPagesParams(a) = %q, want %q", got, want) + } + if want != b { + t.Errorf("sortListPagesParams(b) = %q, want %q", want, b) + } +} + +func TestSortListPagesParamsKeepsADifferentValue(t *testing.T) { + a := `data-list-pages-params="{"alpha": "1"}"` + b := `data-list-pages-params="{"alpha": "2"}"` + + if string(sortListPagesParams([]byte(a))) == string(sortListPagesParams([]byte(b))) { + t.Error("sortListPagesParams(a) = sortListPagesParams(b), want them to differ") + } +} + +func TestSortListPagesParamsLeavesJunkAlone(t *testing.T) { + in := `data-list-pages-params="not json"` + if got := string(sortListPagesParams([]byte(in))); got != in { + t.Errorf("sortListPagesParams(%q) = %q, want it unchanged", in, got) + } +} + +func TestSortListPagesParamsKeepsANull(t *testing.T) { + in := `data-list-pages-params="{"alpha": null}"` + if got := string(sortListPagesParams([]byte(in))); got != in { + t.Errorf("sortListPagesParams(%q) = %q, want it unchanged", in, got) + } +} diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index 6df935aa..e3a3e64a 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -134,6 +134,70 @@ def vote(article, user, rate): bydisplay = make_article('probe:bydisplay', 'Probe By Display Name', '[[*user Probe WD]]', None) +listrow = NL.join([ + '[[module ListPages category="probe" order="name" perPage="3" separate="yes"]]', + '%%index%%/%%total%% [[[%%fullname%%|%%title%%]]] %%rating%%', + '[[/module]]', +]) +listed = make_article('probe:listed', 'Probe Listed', listrow, None) +listjoined = make_article( + 'probe:listjoined', 'Probe List Joined', + NL.join([ + '[[module ListPages category="probe" order="name" separate="no" prependline="||~ page||" appendline="end"]]', + '||%%name%%||', + '[[/module]]', + ]), None) +listnowrap = make_article( + 'probe:listnowrap', 'Probe List No Wrapper', + NL.join([ + '[[module ListPages category="probe" order="name" wrapper="no" limit="2"]]', + '%%name%%', + '[[/module]]', + ]), None) +listsections = make_article( + 'probe:listsections', 'Probe List Sections', + NL.join([ + '[[module ListPages category="probe" order="name" perPage="2"]]', + '[[head]]', + 'top', + '[[/head]]', + '[[body]]', + '%%name%%', + '[[/body]]', + '[[foot]]', + 'bottom', + '[[/foot]]', + '[[/module]]', + ]), None) +listtags = make_article( + 'probe:listtags', 'Probe List Tags', + NL.join([ + '[[module ListPages category="*" tags="+lang:en -zeta" order="fullname"]]', + '%%fullname%%', + '[[/module]]', + ]), None) +listempty = make_article( + 'probe:listempty', 'Probe List Empty', + NL.join([ + '[[module ListPages category="probe" name="no-such-name-at-all"]]', + '%%name%%', + '[[/module]]', + ]), None) +listurl = make_article( + 'probe:listurl', 'Probe List Url', + NL.join([ + '[[module ListPages category="probe" order="name" name="@url|probe*"]]', + '%%name%%', + '[[/module]]', + ]), None) +listbyvotes = make_article( + 'probe:listbyvotes', 'Probe List By Votes', + NL.join([ + '[[module ListPages category="*" order="votes desc" perPage="5" rating=">-10"]]', + '%%fullname%% %%rating%% %%rating_votes%% %%popularity%%', + '[[/module]]', + ]), None) + full.parent = parent full.save() full.authors.set([author, coauthor]) @@ -166,10 +230,13 @@ def vote(article, user, rate): site_settings, _ = Settings.objects.get_or_create(site=Site.objects.first()) for article in (parent, full, bare, rated, half, included, host, redirect, described, - imaged, tagged, taggedplain, unknownmodule, bydisplay): + imaged, tagged, taggedplain, unknownmodule, bydisplay, listed, listjoined, + listnowrap, listsections, listtags, listempty, listurl, listbyvotes): freeze(article) print('site rating_mode =', site_settings.rating_mode) print('seeded', ', '.join(a.full_name for a in (parent, full, bare, rated, half, included, host, redirect, described, imaged, tagged, taggedplain, - unknownmodule, bydisplay))) + unknownmodule, bydisplay, listed, listjoined, + listnowrap, listsections, listtags, listempty, + listurl, listbyvotes))) From 435dc31dce64897e68f1d55f7cf67f8d20f8e86e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 29 Aug 2026 13:07:06 +0900 Subject: [PATCH 070/428] answer the rate module --- internal/difftest/corpus/articles.txt | 5 +- internal/i18n/locales/zh-hans.json | 7 + internal/module/module.go | 1 + internal/module/render_test.go | 4 +- internal/modules/listpages_test.go | 2 + internal/modules/rate.go | 115 ++++++++++++++ internal/modules/rate_db_test.go | 176 +++++++++++++++++++++ internal/modules/rate_test.go | 136 ++++++++++++++++ internal/modules/testdata/oracle_rate.py | 45 ++++++ internal/modules/testdata/rate.golden | 64 ++++++++ internal/modules/testdata/rate_corpus.json | 162 +++++++++++++++++++ internal/page/testdata/oracle_seed.py | 20 ++- internal/repo/modules.go | 4 + 13 files changed, 735 insertions(+), 6 deletions(-) create mode 100644 internal/modules/rate.go create mode 100644 internal/modules/rate_db_test.go create mode 100644 internal/modules/rate_test.go create mode 100644 internal/modules/testdata/oracle_rate.py create mode 100644 internal/modules/testdata/rate.golden create mode 100644 internal/modules/testdata/rate_corpus.json diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 7f3d63cf..a722f58c 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -29,9 +29,8 @@ /main -!/scp-173 -# carries [[module Rate]], which nobody has ported. an unported module fails the -# whole render, so this is a 500 and not a gap. drop the ! once rate lands. +/scp-173 +/probestars:third /probe:listed /probe:listed/p/2 diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 75fb8191..dd156872 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -15,6 +15,13 @@ "module-listpages-pager-prev": "« 上一页", "module-pagesbytag-category": " 来自分类 {category}", "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", + "module-rate-cancel": "取消", + "module-rate-down": "不喜欢", + "module-rate-label": "评分:", + "module-rate-no-page": "未指定页面", + "module-rate-popularity": "人气值（3.0分及以上评分占比）", + "module-rate-up": "喜欢", + "module-rate-votes": "评分数", "module-unknown": "模块 '{name}' 不存在", "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", diff --git a/internal/module/module.go b/internal/module/module.go index acbfced2..e3bd2647 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -33,6 +33,7 @@ type Data interface { SiteRatingMode() (string, error) CategoryRatingMode(category string) (string, error) VoteStats(articleID int64) (db.VoteStats, error) + HasVoted(articleID int64, userID *int64) (bool, error) ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) CountArticles(f db.ListFilter, offset int, limit *int) (int, error) } diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 3adaf45f..4216dcfc 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -42,6 +42,8 @@ func (f fakeData) CategoryRatingMode(string) (string, error) { return "", db.Err func (f fakeData) VoteStats(int64) (db.VoteStats, error) { return db.VoteStats{}, f.err } +func (f fakeData) HasVoted(int64, *int64) (bool, error) { return false, f.err } + func (f fakeData) ListArticles(db.ListFilter, int, *int) ([]db.Article, error) { return f.articles, f.err } @@ -51,7 +53,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"listpages", "pagedescription", "pageimage", "pagesbytag", "redirect"} + ported := []string{"listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/listpages_test.go b/internal/modules/listpages_test.go index 37bdda8c..ba1f02e9 100644 --- a/internal/modules/listpages_test.go +++ b/internal/modules/listpages_test.go @@ -42,6 +42,8 @@ func (d *listData) CategoryRatingMode(string) (string, error) { return "", db.Er func (d *listData) VoteStats(int64) (db.VoteStats, error) { return db.VoteStats{}, nil } +func (d *listData) HasVoted(int64, *int64) (bool, error) { return false, nil } + func (d *listData) ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) { d.filter, d.offset, d.limit = f, offset, limit return d.listed, nil diff --git a/internal/modules/rate.go b/internal/modules/rate.go new file mode 100644 index 00000000..e3caea7c --- /dev/null +++ b/internal/modules/rate.go @@ -0,0 +1,115 @@ +package modules + +import ( + "errors" + "fmt" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +func init() { module.Register("rate", renderRate) } + +const ( + starColorRated = "#f0ac00" + starColorUnrated = "#4e6b6b" +) + +func renderRate(env module.Env, _ map[string]string, _ string) (string, error) { + if env.Data == nil { + return "", module.ErrNotPorted + } + var article *db.Article + if env.Page != nil { + article = env.Page.Article + } + if article == nil { + return "", &module.Error{Message: env.Text("module-rate-no-page")} + } + + mode, err := articleRatingMode(env, article.Category) + if err != nil { + return "", err + } + if mode != page.RatingModeUpDown && mode != page.RatingModeStars { + return "", nil + } + stats, err := env.Data.VoteStats(article.ID) + if err != nil { + return "", err + } + rating := page.RatingOf(mode, stats) + + if mode == page.RatingModeUpDown { + return upDownWidget(env, article.FullName(), rating), nil + } + + // Django only reaches the vote lookup for a signed-in reader, so the + // anonymous votes a null user id would match are never asked about. + voted := false + if env.User != nil { + voted, err = env.Data.HasVoted(article.ID, &env.User.ID) + if err != nil { + return "", err + } + } + return starsWidget(env, article.FullName(), rating, voted), nil +} + +func articleRatingMode(env module.Env, category string) (string, error) { + site, err := env.Data.SiteRatingMode() + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", err + } + own, err := env.Data.CategoryRatingMode(category) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", err + } + return page.RatingMode(site, own), nil +} + +func upDownWidget(env module.Env, pageID string, rating page.Rating) string { + value, _ := rating.Value.(int) + label := env.Text("module-rate-label") + + var b strings.Builder + b.WriteString(`
`) + b.WriteString(`` + label + ` ` + + fmt.Sprintf("%+d", value) + ``) + b.WriteString(`+`) + b.WriteString(`–`) + b.WriteString(`x`) + b.WriteString(`
`) + return b.String() +} + +func starsWidget(env module.Env, pageID string, rating page.Rating, voted bool) string { + average, _ := rating.Value.(float64) + shown := "—" + if rating.Votes != 0 { + shown = fmt.Sprintf("%.1f", average) + } + color := starColorUnrated + if voted { + color = starColorRated + } + label := env.Text("module-rate-label") + + var b strings.Builder + b.WriteString(`
`) + b.WriteString(`
` + label + ` ` + shown + `
`) + b.WriteString(`
`) + b.WriteString(`
`) + b.WriteString(`
`) + b.WriteString(`
`) + b.WriteString(`
` + strconv.Itoa(rating.Votes) + `/` + strconv.Itoa(rating.Popularity) + `%
`) + b.WriteString(`
`) + return b.String() +} diff --git a/internal/modules/rate_db_test.go b/internal/modules/rate_db_test.go new file mode 100644 index 00000000..e5fad8c5 --- /dev/null +++ b/internal/modules/rate_db_test.go @@ -0,0 +1,176 @@ +package modules + +import ( + "context" + "encoding/json" + "flag" + "fmt" + "os" + "path/filepath" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +var update = flag.Bool("update", false, "rewrite the golden file and the corpus the oracle reads") + +const ( + rateGolden = "testdata/rate.golden" + rateCorpus = "testdata/rate_corpus.json" +) + +type rateCase struct { + Name string `json:"name"` + Page string `json:"page"` + Viewer string `json:"viewer"` +} + +func rateCases() []rateCase { + pages := []string{ + "probe:full", + "probe:half", + "probe:bare", + "probestars:rated", + "probestars:unrated", + "probestars:third", + "probestars:quarter", + "probeoff:unratable", + } + viewers := []string{"", "probevoter", "probe-author", "probecrowd0"} + + var out []rateCase + for _, p := range pages { + for _, v := range viewers { + name := strings.ReplaceAll(p, ":", "-") + if v == "" { + name += "-anonymous" + } else { + name += "-" + v + } + out = append(out, rateCase{Name: name, Page: p, Viewer: v}) + } + } + return out +} + +type rateData struct { + ctx context.Context + d *db.DB + siteID int64 + module.Data +} + +func (r rateData) SiteRatingMode() (string, error) { + return r.d.SiteRatingMode(r.ctx, r.siteID) +} + +func (r rateData) CategoryRatingMode(category string) (string, error) { + return r.d.CategoryRatingMode(r.ctx, category) +} + +func (r rateData) VoteStats(articleID int64) (db.VoteStats, error) { + return r.d.VoteStats(r.ctx, articleID) +} + +func (r rateData) HasVoted(articleID int64, userID *int64) (bool, error) { + return r.d.HasVoted(r.ctx, articleID, userID) +} + +func rateSource(t *testing.T) rateData { + t.Helper() + dsn := os.Getenv(db.EnvDSN) + if dsn == "" { + t.Skipf("%s not set, skipping the database test", db.EnvDSN) + } + ctx := context.Background() + d, err := db.Open(ctx, dsn) + if err != nil { + t.Fatalf("db.Open() err = %v, want nil", err) + } + t.Cleanup(d.Close) + site, err := d.SiteByHosts(ctx, []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts([localhost]) err = %v, want nil", err) + } + return rateData{ctx: ctx, d: d, siteID: site.ID} +} + +func TestRenderRateMatchesGolden(t *testing.T) { + src := rateSource(t) + loc := rateLocalizer(t) + cases := rateCases() + + var b strings.Builder + for _, c := range cases { + article, err := src.d.ArticleByName(src.ctx, c.Page) + if err != nil { + t.Fatalf("ArticleByName(%q) err = %v, want nil", c.Page, err) + } + var viewer *db.User + if c.Viewer != "" { + viewer, err = src.d.UserByUsername(src.ctx, c.Viewer) + if err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + } + env := module.Env{ + Page: page.NewContext(article, article, nil, viewer), + Loc: loc, + User: viewer, + Data: src, + } + got, err := renderRate(env, nil, "") + if err != nil { + t.Fatalf("renderRate(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\n%s\n", c.Name, got) + } + compareRateGolden(t, b.String(), cases) +} + +func rateLocalizer(t *testing.T) *i18n.Localizer { + t.Helper() + bundle, err := i18n.Load("") + if err != nil { + t.Fatalf("i18n.Load() err = %v, want nil", err) + } + return bundle.Localizer(i18n.DefaultLanguage) +} + +func compareRateGolden(t *testing.T, got string, corpus any) { + t.Helper() + if *update { + data, err := json.MarshalIndent(corpus, "", " ") + if err != nil { + t.Fatalf("Marshal(%s) err = %v, want nil", rateCorpus, err) + } + if err := os.WriteFile(filepath.FromSlash(rateCorpus), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", rateCorpus, err) + } + if err := os.WriteFile(filepath.FromSlash(rateGolden), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", rateGolden, err) + } + return + } + want, err := os.ReadFile(filepath.FromSlash(rateGolden)) + if err != nil { + t.Fatalf("ReadFile(%s) err = %v, want nil", rateGolden, err) + } + if got != string(want) { + gotAt, wantAt := firstRateDiff(got, string(want)) + t.Errorf("renderRate = %q, want %q", gotAt, wantAt) + } +} + +func firstRateDiff(got, want string) (string, string) { + at := 0 + for at < len(got) && at < len(want) && got[at] == want[at] { + at++ + } + cut := func(s string) string { return s[max(0, at-40):min(len(s), at+40)] } + return cut(got), cut(want) +} diff --git a/internal/modules/rate_test.go b/internal/modules/rate_test.go new file mode 100644 index 00000000..0a53f9fb --- /dev/null +++ b/internal/modules/rate_test.go @@ -0,0 +1,136 @@ +package modules + +import ( + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +type fakeRateData struct { + module.Data + siteMode string + categoryMode string + stats db.VoteStats + voted bool + askedVoted bool + askedUserID *int64 +} + +func (f *fakeRateData) SiteRatingMode() (string, error) { return f.siteMode, nil } + +func (f *fakeRateData) CategoryRatingMode(string) (string, error) { return f.categoryMode, nil } + +func (f *fakeRateData) VoteStats(int64) (db.VoteStats, error) { return f.stats, nil } + +func (f *fakeRateData) HasVoted(_ int64, userID *int64) (bool, error) { + f.askedVoted = true + f.askedUserID = userID + return f.voted, nil +} + +func rateEnv(data *fakeRateData, article *db.Article, user *db.User) module.Env { + var pc *page.Context + if article != nil { + pc = page.NewContext(article, article, nil, user) + } + return module.Env{Page: pc, User: user, Data: data} +} + +func TestRenderRateWithoutAPage(t *testing.T) { + _, err := renderRate(rateEnv(&fakeRateData{}, nil, nil), nil, "") + var blocked *module.Error + if !asModuleError(err, &blocked) { + t.Fatalf("renderRate() err = %v, want *module.Error", err) + } + if blocked.Message != "module-rate-no-page" { + t.Errorf("renderRate() message = %q, want %q", blocked.Message, "module-rate-no-page") + } +} + +func TestRenderRateDisabledRendersNothing(t *testing.T) { + data := &fakeRateData{siteMode: page.RatingModeDisabled} + got, err := renderRate(rateEnv(data, &db.Article{ID: 1, Category: "probe", Name: "x"}, nil), nil, "") + if err != nil { + t.Fatalf("renderRate() err = %v, want nil", err) + } + if got != "" { + t.Errorf("renderRate() = %q, want %q", got, "") + } +} + +func TestRenderRateEscapesThePageID(t *testing.T) { + data := &fakeRateData{siteMode: page.RatingModeUpDown} + article := &db.Article{ID: 1, Category: "probe", Name: `a"b&c`} + got, err := renderRate(rateEnv(data, article, nil), nil, "") + if err != nil { + t.Fatalf("renderRate() err = %v, want nil", err) + } + want := `data-page-id="probe:a"b&c"` + if !strings.Contains(got, want) { + t.Errorf("renderRate() = %q, want it to contain %q", got, want) + } +} + +func TestRenderRateLeavesAnAnonymousVoteUnasked(t *testing.T) { + data := &fakeRateData{siteMode: page.RatingModeStars} + _, err := renderRate(rateEnv(data, &db.Article{ID: 1, Category: "probe", Name: "x"}, nil), nil, "") + if err != nil { + t.Fatalf("renderRate() err = %v, want nil", err) + } + if data.askedVoted { + t.Error("HasVoted called = true, want false") + } +} + +func TestRenderRateAsksAboutTheSignedInVote(t *testing.T) { + data := &fakeRateData{siteMode: page.RatingModeStars, voted: true} + user := &db.User{ID: 7} + got, err := renderRate(rateEnv(data, &db.Article{ID: 1, Category: "probe", Name: "x"}, user), nil, "") + if err != nil { + t.Fatalf("renderRate() err = %v, want nil", err) + } + if data.askedUserID == nil || *data.askedUserID != user.ID { + t.Errorf("HasVoted user id = %v, want %d", data.askedUserID, user.ID) + } + if !strings.Contains(got, starColorRated) { + t.Errorf("renderRate() = %q, want it to contain %q", got, starColorRated) + } +} + +func TestRenderRateStarsWithoutVotes(t *testing.T) { + data := &fakeRateData{siteMode: page.RatingModeStars} + got, err := renderRate(rateEnv(data, &db.Article{ID: 1, Category: "probe", Name: "x"}, nil), nil, "") + if err != nil { + t.Fatalf("renderRate() err = %v, want nil", err) + } + if want := `—`; !strings.Contains(got, want) { + t.Errorf("renderRate() = %q, want it to contain %q", got, want) + } + if want := `width: 0%`; !strings.Contains(got, want) { + t.Errorf("renderRate() = %q, want it to contain %q", got, want) + } +} + +func TestStarsWidgetTruncatesTheWidth(t *testing.T) { + cases := []struct { + average float64 + want string + }{ + {0, "width: 0%"}, + {0.8, "width: 16%"}, + {2.5, "width: 50%"}, + {3.3, "width: 66%"}, + {4.5, "width: 90%"}, + {5, "width: 100%"}, + } + for _, c := range cases { + rating := page.Rating{Value: c.average, Votes: 1, Mode: page.RatingModeStars} + got := starsWidget(module.Env{}, "main", rating, false) + if !strings.Contains(got, c.want) { + t.Errorf("starsWidget(%v) = %q, want it to contain %q", c.average, got, c.want) + } + } +} diff --git a/internal/modules/testdata/oracle_rate.py b/internal/modules/testdata/oracle_rate.py new file mode 100644 index 00000000..7480c1b5 --- /dev/null +++ b/internal/modules/testdata/oracle_rate.py @@ -0,0 +1,45 @@ +"""Records what the rate module renders for a page a reader is looking at. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e RATE_CORPUS="$(cat internal/modules/testdata/rate_corpus.json)" \ + web python manage.py shell < internal/modules/testdata/oracle_rate.py + +The module's own render is called, so the templates and the number formatting +come from the source and not from a copy here. Compare the output with +internal/modules/testdata/rate.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules.rate +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.site import Site +from web.models.users import User + +CORPUS = json.loads(os.environ['RATE_CORPUS']) + + +def main(): + out = [] + for case in CORPUS: + article = articles.get_article(case['page']) + if article is None: + raise SystemExit('%s is missing; run oracle_seed.py first' % case['page']) + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + if case['viewer']: + viewer = User.objects.get(username=case['viewer']) + threadvars.put('current_user', viewer) + context = RenderContext(article, article, {}, viewer) + out.append('=== %s\n%s\n' % (case['name'], modules.rate.render(context, {}))) + sys.stdout.write(''.join(out)) + + +main() diff --git a/internal/modules/testdata/rate.golden b/internal/modules/testdata/rate.golden new file mode 100644 index 00000000..6b69a085 --- /dev/null +++ b/internal/modules/testdata/rate.golden @@ -0,0 +1,64 @@ +=== probe-full-anonymous +
评分: +1+–x
+=== probe-full-probevoter +
评分: +1+–x
+=== probe-full-probe-author +
评分: +1+–x
+=== probe-full-probecrowd0 +
评分: +1+–x
+=== probe-half-anonymous +
评分: -6+–x
+=== probe-half-probevoter +
评分: -6+–x
+=== probe-half-probe-author +
评分: -6+–x
+=== probe-half-probecrowd0 +
评分: -6+–x
+=== probe-bare-anonymous +
评分: +0+–x
+=== probe-bare-probevoter +
评分: +0+–x
+=== probe-bare-probe-author +
评分: +0+–x
+=== probe-bare-probecrowd0 +
评分: +0+–x
+=== probestars-rated-anonymous +
评分: 4.5
2/100%
+=== probestars-rated-probevoter +
评分: 4.5
2/100%
+=== probestars-rated-probe-author +
评分: 4.5
2/100%
+=== probestars-rated-probecrowd0 +
评分: 4.5
2/100%
+=== probestars-unrated-anonymous +
评分: —
0/0%
+=== probestars-unrated-probevoter +
评分: —
0/0%
+=== probestars-unrated-probe-author +
评分: —
0/0%
+=== probestars-unrated-probecrowd0 +
评分: —
0/0%
+=== probestars-third-anonymous +
评分: 3.3
3/100%
+=== probestars-third-probevoter +
评分: 3.3
3/100%
+=== probestars-third-probe-author +
评分: 3.3
3/100%
+=== probestars-third-probecrowd0 +
评分: 3.3
3/100%
+=== probestars-quarter-anonymous +
评分: 0.8
2/0%
+=== probestars-quarter-probevoter +
评分: 0.8
2/0%
+=== probestars-quarter-probe-author +
评分: 0.8
2/0%
+=== probestars-quarter-probecrowd0 +
评分: 0.8
2/0%
+=== probeoff-unratable-anonymous + +=== probeoff-unratable-probevoter + +=== probeoff-unratable-probe-author + +=== probeoff-unratable-probecrowd0 + diff --git a/internal/modules/testdata/rate_corpus.json b/internal/modules/testdata/rate_corpus.json new file mode 100644 index 00000000..db3df5ca --- /dev/null +++ b/internal/modules/testdata/rate_corpus.json @@ -0,0 +1,162 @@ +[ + { + "name": "probe-full-anonymous", + "page": "probe:full", + "viewer": "" + }, + { + "name": "probe-full-probevoter", + "page": "probe:full", + "viewer": "probevoter" + }, + { + "name": "probe-full-probe-author", + "page": "probe:full", + "viewer": "probe-author" + }, + { + "name": "probe-full-probecrowd0", + "page": "probe:full", + "viewer": "probecrowd0" + }, + { + "name": "probe-half-anonymous", + "page": "probe:half", + "viewer": "" + }, + { + "name": "probe-half-probevoter", + "page": "probe:half", + "viewer": "probevoter" + }, + { + "name": "probe-half-probe-author", + "page": "probe:half", + "viewer": "probe-author" + }, + { + "name": "probe-half-probecrowd0", + "page": "probe:half", + "viewer": "probecrowd0" + }, + { + "name": "probe-bare-anonymous", + "page": "probe:bare", + "viewer": "" + }, + { + "name": "probe-bare-probevoter", + "page": "probe:bare", + "viewer": "probevoter" + }, + { + "name": "probe-bare-probe-author", + "page": "probe:bare", + "viewer": "probe-author" + }, + { + "name": "probe-bare-probecrowd0", + "page": "probe:bare", + "viewer": "probecrowd0" + }, + { + "name": "probestars-rated-anonymous", + "page": "probestars:rated", + "viewer": "" + }, + { + "name": "probestars-rated-probevoter", + "page": "probestars:rated", + "viewer": "probevoter" + }, + { + "name": "probestars-rated-probe-author", + "page": "probestars:rated", + "viewer": "probe-author" + }, + { + "name": "probestars-rated-probecrowd0", + "page": "probestars:rated", + "viewer": "probecrowd0" + }, + { + "name": "probestars-unrated-anonymous", + "page": "probestars:unrated", + "viewer": "" + }, + { + "name": "probestars-unrated-probevoter", + "page": "probestars:unrated", + "viewer": "probevoter" + }, + { + "name": "probestars-unrated-probe-author", + "page": "probestars:unrated", + "viewer": "probe-author" + }, + { + "name": "probestars-unrated-probecrowd0", + "page": "probestars:unrated", + "viewer": "probecrowd0" + }, + { + "name": "probestars-third-anonymous", + "page": "probestars:third", + "viewer": "" + }, + { + "name": "probestars-third-probevoter", + "page": "probestars:third", + "viewer": "probevoter" + }, + { + "name": "probestars-third-probe-author", + "page": "probestars:third", + "viewer": "probe-author" + }, + { + "name": "probestars-third-probecrowd0", + "page": "probestars:third", + "viewer": "probecrowd0" + }, + { + "name": "probestars-quarter-anonymous", + "page": "probestars:quarter", + "viewer": "" + }, + { + "name": "probestars-quarter-probevoter", + "page": "probestars:quarter", + "viewer": "probevoter" + }, + { + "name": "probestars-quarter-probe-author", + "page": "probestars:quarter", + "viewer": "probe-author" + }, + { + "name": "probestars-quarter-probecrowd0", + "page": "probestars:quarter", + "viewer": "probecrowd0" + }, + { + "name": "probeoff-unratable-anonymous", + "page": "probeoff:unratable", + "viewer": "" + }, + { + "name": "probeoff-unratable-probevoter", + "page": "probeoff:unratable", + "viewer": "probevoter" + }, + { + "name": "probeoff-unratable-probe-author", + "page": "probeoff:unratable", + "viewer": "probe-author" + }, + { + "name": "probeoff-unratable-probecrowd0", + "page": "probeoff:unratable", + "viewer": "probecrowd0" + } +] diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index e3a3e64a..146905fb 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -113,6 +113,10 @@ def vote(article, user, rate): full = make_article('probe:full', 'Probe Full', 'full source\nsecond line', author) bare = make_article('probe:bare', 'Probe Bare', 'bare source', None) rated = make_article('probestars:rated', 'Probe Rated', 'rated source', author) +unrated = make_article('probestars:unrated', 'Probe Unrated', 'unrated source', author) +third = make_article('probestars:third', 'Probe Third', '[[module Rate]]', author) +quarter = make_article('probestars:quarter', 'Probe Quarter', 'quarter source', author) +unratable = make_article('probeoff:unratable', 'Probe Unratable', 'unratable source', author) half = make_article('probe:half', 'Probe Half', 'half source', author) included = make_article( 'probe:included', 'Included Page', @@ -219,6 +223,11 @@ def vote(article, user, rate): vote(full, voter, -1) vote(rated, author, 4) vote(rated, voter, 5) +vote(third, author, 3) +vote(third, voter, 3) +vote(third, coauthor, 4) +vote(quarter, author, 0.5) +vote(quarter, voter, 1) for index, member in enumerate(crowd): vote(half, member, 1 if index == 0 else -1) @@ -227,15 +236,22 @@ def vote(article, user, rate): category=stars_category, defaults=dict(rating_mode=Settings.RatingMode.Stars), ) +off_category, _ = Category.objects.get_or_create(name='probeoff') +Settings.objects.update_or_create( + category=off_category, + defaults=dict(rating_mode=Settings.RatingMode.Disabled), +) site_settings, _ = Settings.objects.get_or_create(site=Site.objects.first()) -for article in (parent, full, bare, rated, half, included, host, redirect, described, +for article in (parent, full, bare, rated, unrated, third, quarter, unratable, half, + included, host, redirect, described, imaged, tagged, taggedplain, unknownmodule, bydisplay, listed, listjoined, listnowrap, listsections, listtags, listempty, listurl, listbyvotes): freeze(article) print('site rating_mode =', site_settings.rating_mode) -print('seeded', ', '.join(a.full_name for a in (parent, full, bare, rated, half, included, host, +print('seeded', ', '.join(a.full_name for a in (parent, full, bare, rated, unrated, third, + quarter, unratable, half, included, host, redirect, described, imaged, tagged, taggedplain, unknownmodule, bydisplay, listed, listjoined, listnowrap, listsections, listtags, listempty, diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 79e6bec5..761d36eb 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -78,6 +78,10 @@ func (m moduleData) VoteStats(articleID int64) (db.VoteStats, error) { return m.repo.db.VoteStats(m.repo.ctx, articleID) } +func (m moduleData) HasVoted(articleID int64, userID *int64) (bool, error) { + return m.repo.db.HasVoted(m.repo.ctx, articleID, userID) +} + func (m moduleData) ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) { return m.repo.db.ListArticles(m.repo.ctx, f, offset, limit) } From 41f8fe2af6175932e4ba787a47b7e60b28df4f5b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 29 Aug 2026 13:29:51 +0900 Subject: [PATCH 071/428] hand the article route to go --- cmd/pwikit/main.go | 32 ++++++++++-------------- internal/articlepage/articlepage.go | 11 +++++++- internal/articlepage/articlepage_test.go | 22 ++++++++++++++-- internal/difftest/corpus/articles.txt | 7 +++++- internal/difftest/corpus/default.txt | 8 +++--- internal/routing/routing.go | 14 +---------- internal/routing/routing_test.go | 17 ------------- 7 files changed, 53 insertions(+), 58 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 22ba33f9..0500d3e5 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -90,7 +90,6 @@ func serve(args []string) error { secret := fs.String("secret-key", os.Getenv(envSecretKey), "key the session cookie is signed with; without it every visitor is anonymous") sidecar := fs.String("sidecar", os.Getenv(envSidecar), "path to the ftml sidecar binary; without it the linked-in ftml is used") timezone := fs.String("timezone", envOr(envTimeZone, "UTC"), "time zone dates are shown in") - articles := fs.Bool("articles-from-go", false, "answer article pages here instead of passing them upstream") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -131,34 +130,30 @@ func serve(args []string) error { defer conn.Close() } - // Without a database the whole prefix goes upstream, host rules included. var mediaHandler http.Handler = proxy if conn != nil { mediaHandler = site.NewHostRules(conn, listenPort(*listen), media.New(p.Files(), conn), proxy) } - table := routing.Table - goHandlers := map[string]http.Handler{ - // The bundle is the one route answered above the session layer, so it - // is also the one that does not vary on the cookie. - static.Prefix: static.New(assets, proxy), - media.Prefix: respheader.VaryCookie(mediaHandler), - } - - if *articles { - if conn == nil { - return errors.New("-articles-from-go needs a database") - } + var articles http.Handler = proxy + if conn != nil { pages, closeEngine, err := articleHandler(conn, p, assets, *sidecar, *secret, *timezone, log) if err != nil { return err } defer closeEngine() - table = routing.WithOwner(table, "/", routing.OwnerGo) - goHandlers["/"] = compress.New(respheader.VaryCookie(site.NewHostRules(conn, listenPort(*listen), pages, proxy))) + articles = compress.New(respheader.VaryCookie(site.NewHostRules(conn, listenPort(*listen), pages, proxy))) + } + + goHandlers := map[string]http.Handler{ + // The bundle is the one route answered above the session layer, so it + // is also the one that does not vary on the cookie. + static.Prefix: static.New(assets, proxy), + media.Prefix: respheader.VaryCookie(mediaHandler), + "/": articles, } - mux, err := routing.New(table, proxy, goHandlers) + mux, err := routing.New(routing.Table, proxy, goHandlers) if err != nil { return err } @@ -184,8 +179,7 @@ func listenPort(addr string) string { return port } -// assetFS is the development shape of the bundle, which ends up inside the -// binary. Until the build produces it, an empty path means every asset request +// Until the build produces a bundle, an empty path means every asset request // falls through to the upstream. func assetFS(dir string) (iofs.FS, error) { if dir == "" { diff --git a/internal/articlepage/articlepage.go b/internal/articlepage/articlepage.go index 7cf91ad1..7f417fa2 100644 --- a/internal/articlepage/articlepage.go +++ b/internal/articlepage/articlepage.go @@ -33,6 +33,8 @@ type Handler struct { shell func(loc *i18n.Localizer) *shell.Renderer } +const allowedMethods = "GET, HEAD, OPTIONS" + var _ http.Handler = (*Handler)(nil) func New(d Deps) *Handler { @@ -53,8 +55,15 @@ func New(d Deps) *Handler { func (h *Handler) now() time.Time { return h.deps.Now() } func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + if r.Method == http.MethodOptions { + w.Header().Set("Allow", allowedMethods) + w.Header().Set("Content-Type", "text/html; charset=utf-8") + w.Header().Set("Content-Length", "0") + w.WriteHeader(http.StatusOK) + return + } if r.Method != http.MethodGet && r.Method != http.MethodHead { - w.Header().Set("Allow", "GET, HEAD") + w.Header().Set("Allow", allowedMethods) http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) return } diff --git a/internal/articlepage/articlepage_test.go b/internal/articlepage/articlepage_test.go index fe834a5b..2eea55d0 100644 --- a/internal/articlepage/articlepage_test.go +++ b/internal/articlepage/articlepage_test.go @@ -70,8 +70,26 @@ func TestPostIsNotAllowed(t *testing.T) { if rec.Code != http.StatusMethodNotAllowed { t.Errorf("POST /main = %d, want %d", rec.Code, http.StatusMethodNotAllowed) } - if got := rec.Header().Get("Allow"); got != "GET, HEAD" { - t.Errorf("Allow = %q, want %q", got, "GET, HEAD") + if got := rec.Header().Get("Allow"); got != allowedMethods { + t.Errorf("Allow = %q, want %q", got, allowedMethods) + } +} + +func TestOptionsIsAnswered(t *testing.T) { + rec := httptest.NewRecorder() + New(Deps{}).ServeHTTP(rec, httptest.NewRequest(http.MethodOptions, "/main", nil)) + + if rec.Code != http.StatusOK { + t.Errorf("OPTIONS /main = %d, want %d", rec.Code, http.StatusOK) + } + if got := rec.Header().Get("Allow"); got != allowedMethods { + t.Errorf("Allow = %q, want %q", got, allowedMethods) + } + if got := rec.Header().Get("Content-Length"); got != "0" { + t.Errorf("Content-Length = %q, want %q", got, "0") + } + if got := rec.Body.String(); got != "" { + t.Errorf("OPTIONS /main body = %q, want %q", got, "") } } diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index a722f58c..71b7169b 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -1,5 +1,5 @@ # The corpus for a pwikit that answers article pages itself. -# Run it with serve -articles-from-go; the default corpus is for the forwarding shape. +# The default corpus covers one request per prefix; this one goes deep on articles. # ! = known to differ; still run and reported, just not failed. /probe:bare @@ -27,6 +27,11 @@ !/probe:bydisplay # pwikit resolves [[user ]] and Django does not. deliberate. +OPTIONS /probe:full +!POST /probe:full +# django answers POST with the CSRF middleware's 403 before the view runs. pwikit +# has no CSRF yet and says 405. drop the ! when phase 4 lands it. + /main /scp-173 diff --git a/internal/difftest/corpus/default.txt b/internal/difftest/corpus/default.txt index 2f5fdb49..fdfc73da 100644 --- a/internal/difftest/corpus/default.txt +++ b/internal/difftest/corpus/default.txt @@ -2,11 +2,9 @@ # ! = known to differ; still run and reported, just not failed. # PWIKIT_DIFF_CORPUS points at another file instead of this one. -!/ -!/main -!/main/norender/true -# these three render main, which has [[module ListPages]] -- its params come out of a -# Rust HashMap so the JSON key order moves around. drop the ! once sort_keys lands. +/ +/main +/main/norender/true /scp-173 /scp-173/edit/true diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 64a01824..974f620b 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -23,7 +23,7 @@ type Route struct { const root = "/" var Table = []Route{ - {Prefix: "/", Owner: OwnerDjango, Label: "articles"}, + {Prefix: "/", Owner: OwnerGo, Label: "articles"}, {Prefix: "/-/", Owner: OwnerDjango, Label: "system pages"}, {Prefix: "/-/static/", Owner: OwnerGo, Label: "static assets"}, {Prefix: "/api/", Owner: OwnerDjango, Label: "API"}, @@ -33,18 +33,6 @@ var Table = []Route{ {Prefix: "/local--theme/", Owner: OwnerDjango, Label: "page theme"}, } -// WithOwner copies the table with one prefix handed to someone else, which is -// how a route moves while the code answering it is still being written. -func WithOwner(table []Route, prefix string, owner Owner) []Route { - out := slices.Clone(table) - for i := range out { - if out[i].Prefix == prefix { - out[i].Owner = owner - } - } - return out -} - func Validate(table []Route) error { seen := make(map[string]bool, len(table)) hasRoot := false diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go index 819aef9e..63da597f 100644 --- a/internal/routing/routing_test.go +++ b/internal/routing/routing_test.go @@ -136,20 +136,3 @@ func TestMuxServeHTTPDispatches(t *testing.T) { }) } } - -func TestWithOwnerLeavesTheOriginalAlone(t *testing.T) { - got := WithOwner(Table, "/", OwnerGo) - if got[0].Owner != OwnerGo { - t.Errorf("WithOwner(Table, %q, go)[0].Owner = %q, want %q", "/", got[0].Owner, OwnerGo) - } - if Table[0].Owner != OwnerDjango { - t.Errorf("Table[0].Owner = %q, want %q", Table[0].Owner, OwnerDjango) - } -} - -func TestWithOwnerOfUnknownPrefix(t *testing.T) { - got := WithOwner(Table, "/no-such-prefix/", OwnerGo) - if len(got) != len(Table) { - t.Errorf("len(WithOwner(Table, unknown, go)) = %d, want %d", len(got), len(Table)) - } -} From 965e190141ff8c8181a34402e2028b07ec056997 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 29 Aug 2026 13:54:31 +0900 Subject: [PATCH 072/428] draw an unported module the way django draws a typo --- internal/difftest/corpus/articles.txt | 10 ++++++++++ internal/module/module.go | 17 +++++------------ internal/module/render_test.go | 8 ++++++-- internal/modules/listpages.go | 2 +- internal/modules/rate.go | 2 +- internal/repo/repo.go | 7 +------ 6 files changed, 24 insertions(+), 22 deletions(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 71b7169b..bebd387d 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -50,3 +50,13 @@ OPTIONS /probe:full /probe:listurl/name/probe:listed /probe:listbyvotes /probe:listed/p/2/tag/euclid + +!/forum:start +!/forum:recent-posts +!/forum:category +!/forum:thread +!/forum:new-thread +!/search:site +# the pages the wiki ships with. each is one unported module, so pwikit draws the +# error block where django draws the module. the three that django 404s do it from +# inside the module, which pwikit cannot reach yet. drop each ! as its module lands. diff --git a/internal/module/module.go b/internal/module/module.go index e3bd2647..a91cff00 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -3,7 +3,6 @@ package module import ( - "errors" "strings" "github.com/WikitTeam/ProjectWikit/internal/db" @@ -17,10 +16,6 @@ type Error struct{ Message string } func (e *Error) Error() string { return e.Message } -// ErrNotPorted is not an Error on purpose. A module nobody has written yet is -// a hole in pwikit, not something to tell the reader about. -var ErrNotPorted = errors.New("module: not ported yet") - type Data interface { TagArticles(categorySlug, name string, hiddenCategories []string) ([]db.Article, error) TagCategory(slug string) (db.TagCategory, error) @@ -85,14 +80,12 @@ func Render(env Env, name string, params map[string]string, body string) (string return "", &Error{Message: env.Text("module-disabled")} } info, ok := Lookup(name) - if !ok || info.Removed { - return "", &Error{Message: env.Text("module-unknown", "name", name)} - } - render, ok := renderers[info.Name] - if !ok { - return "", ErrNotPorted + if ok && !info.Removed { + if render, ok := renderers[info.Name]; ok { + return render(env, params, body) + } } - return render(env, params, body) + return "", &Error{Message: env.Text("module-unknown", "name", name)} } // BoolParam is get_boolean_param, where anything the list does not name reads diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 4216dcfc..d5011dd5 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -100,8 +100,12 @@ func TestRenderOfARemovedModule(t *testing.T) { } func TestRenderOfAModuleNobodyWroteYet(t *testing.T) { - if _, err := module.Render(module.Env{}, "rate", nil, ""); !errors.Is(err, module.ErrNotPorted) { - t.Errorf("Render(rate) err = %v, want ErrNotPorted", err) + var moduleErr *module.Error + if _, err := module.Render(module.Env{}, "tagcloud", nil, ""); !errors.As(err, &moduleErr) { + t.Fatalf("Render(tagcloud) err = %v, want a module error", err) + } + if moduleErr.Message != "module-unknown" { + t.Errorf("Render(tagcloud) message = %q, want %q", moduleErr.Message, "module-unknown") } } diff --git a/internal/modules/listpages.go b/internal/modules/listpages.go index 7f031d87..2057a547 100644 --- a/internal/modules/listpages.go +++ b/internal/modules/listpages.go @@ -22,7 +22,7 @@ const maxNesting = 10 func renderListPages(env module.Env, params map[string]string, body string) (string, error) { if env.Render == nil || env.Data == nil { - return "", module.ErrNotPorted + return "", &module.Error{Message: env.Text("module-failed", "name", "listpages")} } pc := env.Page if pc == nil { diff --git a/internal/modules/rate.go b/internal/modules/rate.go index e3caea7c..c29a2cb0 100644 --- a/internal/modules/rate.go +++ b/internal/modules/rate.go @@ -21,7 +21,7 @@ const ( func renderRate(env module.Env, _ map[string]string, _ string) (string, error) { if env.Data == nil { - return "", module.ErrNotPorted + return "", &module.Error{Message: env.Text("module-failed", "name", "rate")} } var article *db.Article if env.Page != nil { diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 0c4d67d2..941ab964 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -13,7 +13,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" // The modules register themselves; without this nothing answers a - // [[module]] and every one of them reads as not ported. + // [[module]] and every page carrying one draws an error block instead. _ "github.com/WikitTeam/ProjectWikit/internal/modules" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/printuser" @@ -21,8 +21,6 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/wikidot" ) -var ErrNotPorted = errors.New("repo: not ported yet") - type Repository struct { ctx context.Context db *db.DB @@ -100,9 +98,6 @@ func (r *Repository) RenderModule(pc *page.Context, name string, params map[stri if errors.As(err, &moduleErr) { return "", &callbacks.ModuleError{Message: moduleErr.Message} } - if errors.Is(err, module.ErrNotPorted) { - return "", ErrNotPorted - } return html, err } From 53cb3a74273c23e8d8f959351b7b5985e515f1fa Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 29 Aug 2026 13:54:55 +0900 Subject: [PATCH 073/428] answer the search widget --- internal/difftest/corpus/articles.txt | 5 ++- internal/i18n/locales/zh-hans.json | 1 + internal/module/render_test.go | 2 +- internal/modules/search.go | 44 ++++++++++++++++++++ internal/modules/search_test.go | 59 +++++++++++++++++++++++++++ 5 files changed, 109 insertions(+), 2 deletions(-) create mode 100644 internal/modules/search.go create mode 100644 internal/modules/search_test.go diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index bebd387d..83a83934 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -56,7 +56,10 @@ OPTIONS /probe:full !/forum:category !/forum:thread !/forum:new-thread -!/search:site +/search:site +/search:site/q/scp +/search:site/q/%20spaced%20/author/probe-author +/search:site/datefrom/2021-01-01/dateto/2021-12-31 # the pages the wiki ships with. each is one unported module, so pwikit draws the # error block where django draws the module. the three that django 404s do it from # inside the module, which pwikit cannot reach yet. drop each ! as its module lands. diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index dd156872..6e9ffd9a 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -22,6 +22,7 @@ "module-rate-popularity": "人气值（3.0分及以上评分占比）", "module-rate-up": "喜欢", "module-rate-votes": "评分数", + "module-search-placeholder": "搜索文章标题或内容…", "module-unknown": "模块 '{name}' 不存在", "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", diff --git a/internal/module/render_test.go b/internal/module/render_test.go index d5011dd5..1aa63583 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -53,7 +53,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect"} + ported := []string{"listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/search.go b/internal/modules/search.go new file mode 100644 index 00000000..ddf38c23 --- /dev/null +++ b/internal/modules/search.go @@ -0,0 +1,44 @@ +package modules + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" +) + +func init() { module.Register("search", renderSearch) } + +func renderSearch(env module.Env, params map[string]string, _ string) (string, error) { + var path page.PathParams + if env.Page != nil { + path = env.Page.PathParams + } + fromPath := func(key string) string { return strings.TrimSpace(path.Get(key)) } + + config := pyjson.Object{ + {Key: "placeholder", Value: firstNonBlank(params["placeholder"], env.Text("module-search-placeholder"))}, + {Key: "tags", Value: params["tags"]}, + {Key: "category", Value: params["category"]}, + {Key: "q", Value: strings.TrimSpace(firstNonBlank(path.Get("q"), params["q"]))}, + {Key: "author", Value: fromPath("author")}, + {Key: "datefrom", Value: fromPath("datefrom")}, + {Key: "dateto", Value: fromPath("dateto")}, + } + encoded, err := pyjson.Marshal(config) + if err != nil { + return "", err + } + return `
`, nil +} + +func firstNonBlank(values ...string) string { + for _, v := range values { + if v != "" { + return v + } + } + return "" +} diff --git a/internal/modules/search_test.go b/internal/modules/search_test.go new file mode 100644 index 00000000..d976f75f --- /dev/null +++ b/internal/modules/search_test.go @@ -0,0 +1,59 @@ +package modules + +import ( + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +func searchEnv(path page.PathParams) module.Env { + return module.Env{Page: page.NewContext(&db.Article{ID: 1, Name: "site", Category: "search"}, nil, path, nil)} +} + +func searchConfig(t *testing.T, path page.PathParams, params map[string]string) string { + t.Helper() + got, err := renderSearch(searchEnv(path), params, "") + if err != nil { + t.Fatalf("renderSearch() err = %v, want nil", err) + } + return got +} + +func TestRenderSearchFallsBackToTheDefaultPlaceholder(t *testing.T) { + got := searchConfig(t, nil, nil) + want := `"placeholder": "module-search-placeholder"` + if !strings.Contains(got, want) { + t.Errorf("renderSearch() = %q, want it to contain %q", got, want) + } +} + +func TestRenderSearchKeepsTheGivenPlaceholder(t *testing.T) { + got := searchConfig(t, nil, map[string]string{"placeholder": "find"}) + if want := `"placeholder": "find"`; !strings.Contains(got, want) { + t.Errorf("renderSearch() = %q, want it to contain %q", got, want) + } +} + +func TestRenderSearchPrefersThePathQuery(t *testing.T) { + got := searchConfig(t, page.PathParams{{Key: "q", Value: "from-path"}}, map[string]string{"q": "from-module"}) + if want := `"q": "from-path"`; !strings.Contains(got, want) { + t.Errorf("renderSearch() = %q, want it to contain %q", got, want) + } +} + +func TestRenderSearchTrimsThePathValues(t *testing.T) { + got := searchConfig(t, page.PathParams{{Key: "author", Value: " probe-author "}}, nil) + if want := `"author": "probe-author"`; !strings.Contains(got, want) { + t.Errorf("renderSearch() = %q, want it to contain %q", got, want) + } +} + +func TestRenderSearchLeavesTheModuleParamsUntrimmed(t *testing.T) { + got := searchConfig(t, nil, map[string]string{"tags": " a b "}) + if want := `"tags": " a b "`; !strings.Contains(got, want) { + t.Errorf("renderSearch() = %q, want it to contain %q", got, want) + } +} From 28b9c407de0647b675f1eef1359897d4365a8dfb Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 29 Aug 2026 18:12:45 +0900 Subject: [PATCH 074/428] add the permissions the forum needs --- internal/db/user.go | 13 +- internal/perms/perms.go | 92 +- internal/perms/perms_test.go | 155 ++- internal/perms/testdata/oracle_perms.py | 30 + internal/perms/testdata/perms.golden | 694 +++++++++++++ internal/perms/testdata/perms_corpus.json | 1126 +++++++++++++++++++-- internal/repo/perms.go | 1 + 7 files changed, 2022 insertions(+), 89 deletions(-) diff --git a/internal/db/user.go b/internal/db/user.go index 1c070bc7..991a1f5f 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -26,6 +26,9 @@ type User struct { IsActive bool InactiveUntil *time.Time IsSuperuser bool + + IsForumActive bool + ForumInactiveUntil *time.Time } // ActiveAt reproduces User.__init__, where a deadline in the future overrides @@ -38,6 +41,13 @@ func (u *User) ActiveAt(now time.Time) bool { return now.After(*u.InactiveUntil) } +func (u *User) ForumActiveAt(now time.Time) bool { + if u.ForumInactiveUntil == nil { + return u.IsForumActive + } + return now.After(*u.ForumInactiveUntil) +} + func (u *User) DisplayLabel() string { if u.Type == UserTypeWikidot { return "wd:" + firstNonEmpty(u.DisplayName, u.WikidotUsername, u.Username) @@ -61,7 +71,7 @@ func firstNonEmpty(values ...string) string { return "" } -const userColumns = `id, type, username, wikidot_username, display_name, avatar, is_active, inactive_until, is_superuser` +const userColumns = `id, type, username, wikidot_username, display_name, avatar, is_active, inactive_until, is_superuser, is_forum_active, forum_inactive_until` // Django's QuerySet.first() falls back to ordering by primary key when the // queryset carries no ordering of its own, so these two are not stray sorts. @@ -138,6 +148,7 @@ func userDest(u *User) (dest []any, finish func()) { dest = []any{ &u.ID, &u.Type, &u.Username, &wikidotUsername, &displayName, &avatar, &u.IsActive, &u.InactiveUntil, &u.IsSuperuser, + &u.IsForumActive, &u.ForumInactiveUntil, } return dest, func() { u.WikidotUsername = deref(wikidotUsername) diff --git a/internal/perms/perms.go b/internal/perms/perms.go index 05314d7c..85275d55 100644 --- a/internal/perms/perms.go +++ b/internal/perms/perms.go @@ -1,4 +1,4 @@ -// Package perms answers what one user may do to one page. +// Package perms answers what one user may do to one page or forum object. package perms import "sort" @@ -17,11 +17,29 @@ const ( CommentArticles = "comment_articles" ViewArticleComments = "view_article_comments" ManageArticleAuthors = "manage_article_authors" + + ViewForumPosts = "view_forum_posts" + CreateForumPosts = "create_forum_posts" + EditForumPosts = "edit_forum_posts" + DeleteForumPosts = "delete_forum_posts" + ViewForumThreads = "view_forum_threads" + CreateForumThreads = "create_forum_threads" + EditForumThreads = "edit_forum_threads" + PinForumThreads = "pin_forum_threads" + LockForumThreads = "lock_forum_threads" + MoveForumThreads = "move_forum_threads" + ViewForumSections = "view_forum_sections" + ViewHiddenForumSections = "view_hidden_forum_sections" + ViewForumCategories = "view_forum_categories" ) // lockable is what a locked page takes away from anyone who cannot unlock it. var lockable = []string{EditArticles, ManageArticleAuthors, ManageArticleFiles, TagArticles, MoveArticles, DeleteArticles} +// Commenting on an article is in this list because an article's comments are +// forum posts underneath. +var silenced = []string{CommentArticles, CreateForumPosts, EditForumPosts, DeleteForumPosts, EditForumThreads, PinForumThreads, MoveForumThreads} + // Set answers one question at a time. A superuser gets a set that says yes to // every name, which is the shortcut Django takes before any backend runs. type Set struct { @@ -60,18 +78,36 @@ type Override struct { // Subject is the user asking. Roles arrive already assembled: the default role // first, then the registered one and the user's own. type Subject struct { - Anonymous bool - Active bool - Superuser bool - Roles []Role + Anonymous bool + Active bool + ForumActive bool + Superuser bool + Roles []Role } -// Object is the page being asked about. A category fills in Overrides alone, -// since the two remaining fields describe an article. +type Kind int + +const ( + KindArticle Kind = iota + KindForumSection + KindForumThread + KindForumPost +) + +// Object is the thing being asked about. A category fills in Overrides alone, +// which is why the article kind is the zero value. type Object struct { Overrides []Override - Locked bool - Author bool + Kind Kind + + Locked bool + Author bool + + HiddenForUsers bool + + // Django reaches this through the post's override pipeline, so a thread's + // rules run after the post's own. + Thread *Object } // Resolve answers for one user against one object. A nil object is the @@ -102,7 +138,7 @@ func Resolve(s Subject, o *Object) Set { } } if o != nil { - applyObject(granted, o) + applyObject(granted, o, s) } return Set{named: granted} } @@ -122,7 +158,27 @@ func applyOverride(final map[string]bool, overrides []Override, roleID int64) { } } -func applyObject(granted map[string]bool, o *Object) { +func applyObject(granted map[string]bool, o *Object, s Subject) { + switch o.Kind { + case KindForumSection: + if o.HiddenForUsers && granted[ViewForumSections] && !granted[ViewHiddenForumSections] { + delete(granted, ViewForumSections) + } + return + case KindForumThread: + applyThread(granted, o, s) + return + case KindForumPost: + // The grant reads the site-wide answer rather than what this thread + // has left, so a locked thread still lets its author keep the post. + if o.Author && Resolve(s, nil).Has(CreateForumPosts) { + granted[EditForumPosts] = true + } + if o.Thread != nil { + applyThread(granted, o.Thread, s) + } + return + } if o.Locked { if !granted[LockArticles] { for _, name := range lockable { @@ -135,3 +191,17 @@ func applyObject(granted map[string]bool, o *Object) { granted[ManageArticleAuthors] = true } } + +func applyThread(granted map[string]bool, o *Object, s Subject) { + if o.Author { + granted[EditForumThreads] = true + } + barred := !s.Anonymous && !s.ForumActive + locked := o.Locked && !granted[LockForumThreads] + if !barred && !locked { + return + } + for _, name := range silenced { + delete(granted, name) + } +} diff --git a/internal/perms/perms_test.go b/internal/perms/perms_test.go index a21325c6..791d7db4 100644 --- a/internal/perms/perms_test.go +++ b/internal/perms/perms_test.go @@ -25,15 +25,18 @@ type overrideSpec struct { } type objectSpec struct { - Kind string `json:"kind"` - Overrides []overrideSpec `json:"overrides"` - Locked bool `json:"locked"` - Author bool `json:"author"` + Kind string `json:"kind"` + Overrides []overrideSpec `json:"overrides"` + Locked bool `json:"locked"` + Author bool `json:"author"` + HiddenForUsers bool `json:"hidden_for_users"` + ThreadAuthor bool `json:"thread_author"` } type userSpec struct { - Kind string `json:"kind"` - Roles []string `json:"roles"` + Kind string `json:"kind"` + Roles []string `json:"roles"` + ForumBarred bool `json:"forum_barred"` } type scenario struct { @@ -47,11 +50,15 @@ var queried = []string{ ViewArticles, RateArticles, CreateArticles, EditArticles, TagArticles, MoveArticles, LockArticles, ManageArticleFiles, DeleteArticles, ResetArticleVotes, CommentArticles, ViewArticleComments, ManageArticleAuthors, + ViewForumPosts, CreateForumPosts, EditForumPosts, DeleteForumPosts, + ViewForumThreads, CreateForumThreads, EditForumThreads, PinForumThreads, + LockForumThreads, MoveForumThreads, ViewForumSections, + ViewHiddenForumSections, ViewForumCategories, } var baseRoles = []roleSpec{ - {Slug: "everyone", Permissions: []string{ViewArticles, ViewArticleComments}}, - {Slug: "registered", Permissions: []string{CommentArticles, RateArticles}}, + {Slug: "everyone", Permissions: []string{ViewArticles, ViewArticleComments, ViewForumSections, ViewForumCategories, ViewForumThreads, ViewForumPosts}}, + {Slug: "registered", Permissions: []string{CommentArticles, RateArticles, CreateForumThreads, CreateForumPosts}}, {Slug: "editor", Permissions: []string{EditArticles, TagArticles, MoveArticles}}, } @@ -156,6 +163,114 @@ var scenarios = []scenario{ User: userSpec{Kind: "inactive_superuser"}, Object: &objectSpec{Kind: "article"}, }, + { + Name: "a plain forum section", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_section"}, + }, + { + Name: "a section hidden for users takes browsing away", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_section", HiddenForUsers: true}, + }, + { + Name: "a hidden section keeps browsing for whoever may see hidden ones", + Roles: withRoles(roleSpec{Slug: "moderator", Permissions: []string{ViewHiddenForumSections}}), + User: userSpec{Kind: "normal", Roles: []string{"moderator"}}, + Object: &objectSpec{Kind: "forum_section", HiddenForUsers: true}, + }, + { + Name: "a hidden section takes nothing from someone who could not browse anyway", + Roles: []roleSpec{{Slug: "everyone"}, {Slug: "registered"}}, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_section", HiddenForUsers: true}, + }, + { + Name: "a plain thread", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_thread"}, + }, + { + Name: "the author of a thread may edit it", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_thread", Author: true}, + }, + { + Name: "a locked thread silences whoever cannot unlock", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_thread", Locked: true}, + }, + { + Name: "a locked thread silences its own author too", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_thread", Locked: true, Author: true}, + }, + { + Name: "a locked thread leaves everything to whoever may unlock", + Roles: withRoles(roleSpec{Slug: "moderator", Permissions: []string{LockForumThreads}}), + User: userSpec{Kind: "normal", Roles: []string{"moderator"}}, + Object: &objectSpec{Kind: "forum_thread", Locked: true}, + }, + { + Name: "a user barred from the forum is silenced on an open thread", + Roles: baseRoles, + User: userSpec{Kind: "normal", ForumBarred: true}, + Object: &objectSpec{Kind: "forum_thread"}, + }, + { + Name: "an anonymous visitor is never barred from the forum", + Roles: baseRoles, + User: userSpec{Kind: "anonymous"}, + Object: &objectSpec{Kind: "forum_thread"}, + }, + { + Name: "an anonymous visitor keeps what everyone grants on a thread", + Roles: []roleSpec{{Slug: "everyone", Permissions: []string{ViewForumThreads, CommentArticles, CreateForumPosts}}, {Slug: "registered"}}, + User: userSpec{Kind: "anonymous"}, + Object: &objectSpec{Kind: "forum_thread"}, + }, + { + Name: "a plain post", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_post"}, + }, + { + Name: "the author of a post may edit it", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_post", Author: true}, + }, + { + Name: "the author of a post who may not write posts gains nothing", + Roles: []roleSpec{{Slug: "everyone", Permissions: []string{ViewForumPosts}}, {Slug: "registered"}}, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_post", Author: true}, + }, + { + Name: "a locked thread silences the author of a post under it", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_post", Author: true, Locked: true}, + }, + { + Name: "the author of a thread keeps editing it while reading a post under it", + Roles: baseRoles, + User: userSpec{Kind: "normal"}, + Object: &objectSpec{Kind: "forum_post", ThreadAuthor: true}, + }, + { + Name: "a superuser is not silenced by a locked thread", + Roles: baseRoles, + User: userSpec{Kind: "superuser"}, + Object: &objectSpec{Kind: "forum_thread", Locked: true}, + }, } func (s scenario) roleID(slug string) int64 { @@ -178,9 +293,10 @@ func (s scenario) role(slug string) Role { func (s scenario) subject() Subject { sub := Subject{ - Anonymous: s.User.Kind == "anonymous", - Active: s.User.Kind != "inactive" && s.User.Kind != "inactive_superuser", - Superuser: s.User.Kind == "superuser" || s.User.Kind == "inactive_superuser", + Anonymous: s.User.Kind == "anonymous", + Active: s.User.Kind != "inactive" && s.User.Kind != "inactive_superuser", + ForumActive: s.User.Kind != "anonymous" && !s.User.ForumBarred, + Superuser: s.User.Kind == "superuser" || s.User.Kind == "inactive_superuser", } sub.Roles = append(sub.Roles, s.role("everyone")) if !sub.Anonymous { @@ -197,8 +313,13 @@ func (s scenario) object() *Object { return nil } o := &Object{ - Locked: s.Object.Kind == "article" && s.Object.Locked, - Author: s.Object.Kind == "article" && s.Object.Author, + Kind: objectKinds[s.Object.Kind], + Locked: s.Object.Kind != "category" && s.Object.Locked, + Author: s.Object.Kind != "category" && s.Object.Author, + HiddenForUsers: s.Object.HiddenForUsers, + } + if o.Kind == KindForumPost { + o.Thread = &Object{Kind: KindForumThread, Locked: s.Object.Locked, Author: s.Object.ThreadAuthor} } for _, spec := range s.Object.Overrides { o.Overrides = append(o.Overrides, Override{RoleID: s.roleID(spec.Role), Permissions: spec.Permissions, Restrictions: spec.Restrictions}) @@ -206,6 +327,14 @@ func (s scenario) object() *Object { return o } +var objectKinds = map[string]Kind{ + "article": KindArticle, + "category": KindArticle, + "forum_section": KindForumSection, + "forum_thread": KindForumThread, + "forum_post": KindForumPost, +} + func TestResolveMatchesGolden(t *testing.T) { var b strings.Builder for _, s := range scenarios { diff --git a/internal/perms/testdata/oracle_perms.py b/internal/perms/testdata/oracle_perms.py index b9ce0440..1baa7ddf 100644 --- a/internal/perms/testdata/oracle_perms.py +++ b/internal/perms/testdata/oracle_perms.py @@ -15,6 +15,7 @@ from django.db import transaction from web.models.articles import Article, Category +from web.models.forum import ForumCategory, ForumPost, ForumSection, ForumThread from web.models.roles import Role, RolePermissionsOverride from web.models.users import ExtendedAnonymousUser, User from web.permissions import get_role_permissions_content_type @@ -49,14 +50,43 @@ def build_user(spec, roles, index): type='normal', is_active=spec['kind'] not in ('inactive', 'inactive_superuser'), is_superuser=spec['kind'] in ('superuser', 'inactive_superuser'), + is_forum_active=not spec.get('forum_barred'), ) user.roles.set([roles[slug] for slug in (spec.get('roles') or [])]) return user +def build_forum_object(spec, user, index): + section = ForumSection.objects.create( + name='permprobe%d' % index, + is_hidden_for_users=bool(spec.get('hidden_for_users')), + ) + if spec['kind'] == 'forum_section': + return ForumSection.objects.get(pk=section.pk) + category = ForumCategory.objects.create(name='permprobe%d' % index, section=section) + author = None if user.is_anonymous else user + thread_author = spec.get('author') if spec['kind'] == 'forum_thread' else spec.get('thread_author') + thread = ForumThread.objects.create( + name='permprobe%d' % index, + category=category, + author=author if thread_author else None, + is_locked=bool(spec.get('locked')), + ) + if spec['kind'] == 'forum_thread': + return ForumThread.objects.get(pk=thread.pk) + post = ForumPost.objects.create( + name='permprobe%d' % index, + thread=thread, + author=author if spec.get('author') else None, + ) + return ForumPost.objects.get(pk=post.pk) + + def build_object(spec, roles, user, index): if spec is None: return None + if spec['kind'].startswith('forum_'): + return build_forum_object(spec, user, index) category = Category.objects.create(name='permprobe%d' % index) for override_spec in spec.get('overrides') or []: override = RolePermissionsOverride.objects.create(role=roles[override_spec['role']]) diff --git a/internal/perms/testdata/perms.golden b/internal/perms/testdata/perms.golden index fd18d8d0..89c61ae8 100644 --- a/internal/perms/testdata/perms.golden +++ b/internal/perms/testdata/perms.golden @@ -12,6 +12,19 @@ reset_article_votes = false comment_articles = false view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = false +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === anonymous on an article view_articles = true rate_articles = false @@ -26,6 +39,19 @@ reset_article_votes = false comment_articles = false view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = false +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === registered user takes the union of three roles view_articles = true rate_articles = true @@ -40,6 +66,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === a restriction beats a permission inside one role view_articles = true rate_articles = true @@ -54,6 +93,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === a restriction in one role does not take away what another grants view_articles = true rate_articles = true @@ -68,6 +120,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === a category override grants to one role view_articles = true rate_articles = true @@ -82,6 +147,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === a category override restricts the role that granted it view_articles = false rate_articles = true @@ -96,6 +174,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === a category override restricting one role leaves the others view_articles = true rate_articles = true @@ -110,6 +201,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === the override reaches a category asked about directly view_articles = true rate_articles = true @@ -124,6 +228,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === a locked article takes six permissions from whoever cannot unlock view_articles = true rate_articles = true @@ -138,6 +255,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === a locked article keeps everything for whoever can unlock view_articles = true rate_articles = true @@ -152,6 +282,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === an author gains authorship management view_articles = true rate_articles = true @@ -166,6 +309,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = true +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === a lock beats authorship view_articles = true rate_articles = true @@ -180,6 +336,19 @@ reset_article_votes = false comment_articles = true view_article_comments = true manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true === an inactive user gets nothing view_articles = false rate_articles = false @@ -194,6 +363,19 @@ reset_article_votes = false comment_articles = false view_article_comments = false manage_article_authors = false +view_forum_posts = false +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = false +create_forum_threads = false +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = false +view_hidden_forum_sections = false +view_forum_categories = false === a superuser gets everything view_articles = true rate_articles = true @@ -208,6 +390,19 @@ reset_article_votes = true comment_articles = true view_article_comments = true manage_article_authors = true +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = true +delete_forum_posts = true +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = true +pin_forum_threads = true +lock_forum_threads = true +move_forum_threads = true +view_forum_sections = true +view_hidden_forum_sections = true +view_forum_categories = true === an inactive superuser gets nothing view_articles = false rate_articles = false @@ -222,3 +417,502 @@ reset_article_votes = false comment_articles = false view_article_comments = false manage_article_authors = false +view_forum_posts = false +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = false +create_forum_threads = false +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = false +view_hidden_forum_sections = false +view_forum_categories = false +=== a plain forum section +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== a section hidden for users takes browsing away +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = false +view_hidden_forum_sections = false +view_forum_categories = true +=== a hidden section keeps browsing for whoever may see hidden ones +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = true +view_forum_categories = true +=== a hidden section takes nothing from someone who could not browse anyway +view_articles = false +rate_articles = false +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = false +view_article_comments = false +manage_article_authors = false +view_forum_posts = false +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = false +create_forum_threads = false +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = false +view_hidden_forum_sections = false +view_forum_categories = false +=== a plain thread +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== the author of a thread may edit it +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = true +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== a locked thread silences whoever cannot unlock +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = false +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== a locked thread silences its own author too +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = false +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== a locked thread leaves everything to whoever may unlock +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = true +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== a user barred from the forum is silenced on an open thread +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = false +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== an anonymous visitor is never barred from the forum +view_articles = true +rate_articles = false +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = false +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = false +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== an anonymous visitor keeps what everyone grants on a thread +view_articles = false +rate_articles = false +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = false +manage_article_authors = false +view_forum_posts = false +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = false +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = false +view_hidden_forum_sections = false +view_forum_categories = false +=== a plain post +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== the author of a post may edit it +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = true +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== the author of a post who may not write posts gains nothing +view_articles = false +rate_articles = false +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = false +view_article_comments = false +manage_article_authors = false +view_forum_posts = true +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = false +create_forum_threads = false +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = false +view_hidden_forum_sections = false +view_forum_categories = false +=== a locked thread silences the author of a post under it +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = false +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = false +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== the author of a thread keeps editing it while reading a post under it +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = true +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = false +view_forum_categories = true +=== a superuser is not silenced by a locked thread +view_articles = true +rate_articles = true +create_articles = true +edit_articles = true +tag_articles = true +move_articles = true +lock_articles = true +manage_article_files = true +delete_articles = true +reset_article_votes = true +comment_articles = true +view_article_comments = true +manage_article_authors = true +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = true +delete_forum_posts = true +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = true +pin_forum_threads = true +lock_forum_threads = true +move_forum_threads = true +view_forum_sections = true +view_hidden_forum_sections = true +view_forum_categories = true diff --git a/internal/perms/testdata/perms_corpus.json b/internal/perms/testdata/perms_corpus.json index 490ffdbb..07e542f1 100644 --- a/internal/perms/testdata/perms_corpus.json +++ b/internal/perms/testdata/perms_corpus.json @@ -12,7 +12,20 @@ "reset_article_votes", "comment_articles", "view_article_comments", - "manage_article_authors" + "manage_article_authors", + "view_forum_posts", + "create_forum_posts", + "edit_forum_posts", + "delete_forum_posts", + "view_forum_threads", + "create_forum_threads", + "edit_forum_threads", + "pin_forum_threads", + "lock_forum_threads", + "move_forum_threads", + "view_forum_sections", + "view_hidden_forum_sections", + "view_forum_categories" ], "scenarios": [ { @@ -22,7 +35,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -30,7 +47,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -46,7 +65,8 @@ ], "user": { "kind": "anonymous", - "roles": null + "roles": null, + "forum_barred": false }, "object": null }, @@ -57,7 +77,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -65,7 +89,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -81,13 +107,16 @@ ], "user": { "kind": "anonymous", - "roles": null + "roles": null, + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -97,7 +126,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -105,7 +138,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -123,13 +158,16 @@ "kind": "normal", "roles": [ "editor" - ] + ], + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -139,7 +177,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -147,7 +189,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -175,13 +219,16 @@ "kind": "normal", "roles": [ "half" - ] + ], + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -191,7 +238,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -199,7 +250,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -224,13 +277,16 @@ "kind": "normal", "roles": [ "half" - ] + ], + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -240,7 +296,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -248,7 +308,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -266,7 +328,8 @@ "kind": "normal", "roles": [ "editor" - ] + ], + "forum_barred": false }, "object": { "kind": "article", @@ -280,7 +343,9 @@ } ], "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -290,7 +355,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -298,7 +367,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -316,7 +387,8 @@ "kind": "normal", "roles": [ "editor" - ] + ], + "forum_barred": false }, "object": { "kind": "article", @@ -330,7 +402,9 @@ } ], "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -340,7 +414,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -348,7 +426,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -373,7 +453,8 @@ "kind": "normal", "roles": [ "viewer" - ] + ], + "forum_barred": false }, "object": { "kind": "article", @@ -387,7 +468,9 @@ } ], "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -397,7 +480,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -405,7 +492,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -423,7 +512,8 @@ "kind": "normal", "roles": [ "editor" - ] + ], + "forum_barred": false }, "object": { "kind": "category", @@ -437,7 +527,9 @@ } ], "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -447,7 +539,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -455,7 +551,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -473,13 +571,16 @@ "kind": "normal", "roles": [ "editor" - ] + ], + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": true, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -489,7 +590,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -497,7 +602,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -523,13 +630,16 @@ "roles": [ "editor", "locker" - ] + ], + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": true, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -539,7 +649,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -547,7 +661,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -565,13 +681,16 @@ "kind": "normal", "roles": [ "editor" - ] + ], + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": false, - "author": true + "author": true, + "hidden_for_users": false, + "thread_author": false } }, { @@ -581,7 +700,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -589,7 +712,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -607,13 +732,16 @@ "kind": "normal", "roles": [ "editor" - ] + ], + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": true, - "author": true + "author": true, + "hidden_for_users": false, + "thread_author": false } }, { @@ -623,7 +751,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -631,7 +763,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -649,13 +783,16 @@ "kind": "inactive", "roles": [ "editor" - ] + ], + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -665,7 +802,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -673,7 +814,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -689,13 +832,16 @@ ], "user": { "kind": "superuser", - "roles": null + "roles": null, + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": true, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false } }, { @@ -705,7 +851,11 @@ "slug": "everyone", "permissions": [ "view_articles", - "view_article_comments" + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" ], "restrictions": null }, @@ -713,7 +863,9 @@ "slug": "registered", "permissions": [ "comment_articles", - "rate_articles" + "rate_articles", + "create_forum_threads", + "create_forum_posts" ], "restrictions": null }, @@ -729,13 +881,859 @@ ], "user": { "kind": "inactive_superuser", - "roles": null + "roles": null, + "forum_barred": false }, "object": { "kind": "article", "overrides": null, "locked": false, - "author": false + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "a plain forum section", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_section", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "a section hidden for users takes browsing away", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_section", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": true, + "thread_author": false + } + }, + { + "name": "a hidden section keeps browsing for whoever may see hidden ones", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + }, + { + "slug": "moderator", + "permissions": [ + "view_hidden_forum_sections" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": [ + "moderator" + ], + "forum_barred": false + }, + "object": { + "kind": "forum_section", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": true, + "thread_author": false + } + }, + { + "name": "a hidden section takes nothing from someone who could not browse anyway", + "roles": [ + { + "slug": "everyone", + "permissions": null, + "restrictions": null + }, + { + "slug": "registered", + "permissions": null, + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_section", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": true, + "thread_author": false + } + }, + { + "name": "a plain thread", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "the author of a thread may edit it", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": false, + "author": true, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "a locked thread silences whoever cannot unlock", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": true, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "a locked thread silences its own author too", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": true, + "author": true, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "a locked thread leaves everything to whoever may unlock", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + }, + { + "slug": "moderator", + "permissions": [ + "lock_forum_threads" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": [ + "moderator" + ], + "forum_barred": false + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": true, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "a user barred from the forum is silenced on an open thread", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": true + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "an anonymous visitor is never barred from the forum", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "anonymous", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "an anonymous visitor keeps what everyone grants on a thread", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_forum_threads", + "comment_articles", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": null, + "restrictions": null + } + ], + "user": { + "kind": "anonymous", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "a plain post", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_post", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "the author of a post may edit it", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_post", + "overrides": null, + "locked": false, + "author": true, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "the author of a post who may not write posts gains nothing", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": null, + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_post", + "overrides": null, + "locked": false, + "author": true, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "a locked thread silences the author of a post under it", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_post", + "overrides": null, + "locked": true, + "author": true, + "hidden_for_users": false, + "thread_author": false + } + }, + { + "name": "the author of a thread keeps editing it while reading a post under it", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_post", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": false, + "thread_author": true + } + }, + { + "name": "a superuser is not silenced by a locked thread", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + } + ], + "user": { + "kind": "superuser", + "roles": null, + "forum_barred": false + }, + "object": { + "kind": "forum_thread", + "overrides": null, + "locked": true, + "author": false, + "hidden_for_users": false, + "thread_author": false } } ] diff --git a/internal/repo/perms.go b/internal/repo/perms.go index a43ab97c..38bb4054 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -58,6 +58,7 @@ func (p *Perms) Subject(u *db.User, now time.Time) (perms.Subject, error) { subject := perms.Subject{Anonymous: u == nil, Roles: roles} if u != nil { subject.Active = u.ActiveAt(now) + subject.ForumActive = u.ForumActiveAt(now) subject.Superuser = u.IsSuperuser } return subject, nil From e5dc14f87aef84d8389481a628c5d2fb64704422 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 02:49:26 +0900 Subject: [PATCH 075/428] add the queries a forum listing needs --- internal/db/forum.go | 178 +++++++++++++++++ internal/db/forum_test.go | 227 ++++++++++++++++++++++ internal/db/testdata/oracle_forum.py | 47 +++++ internal/db/user.go | 19 ++ internal/page/testdata/oracle_seed.py | 55 +++++- internal/perms/perms_test.go | 8 +- internal/perms/testdata/oracle_perms.py | 2 + internal/perms/testdata/perms.golden | 27 +++ internal/perms/testdata/perms_corpus.json | 58 ++++++ internal/repo/perms.go | 6 + 10 files changed, 625 insertions(+), 2 deletions(-) create mode 100644 internal/db/forum.go create mode 100644 internal/db/forum_test.go create mode 100644 internal/db/testdata/oracle_forum.py diff --git a/internal/db/forum.go b/internal/db/forum.go new file mode 100644 index 00000000..0a3082fd --- /dev/null +++ b/internal/db/forum.go @@ -0,0 +1,178 @@ +package db + +import ( + "context" + "errors" + "fmt" + "time" + + "github.com/jackc/pgx/v5" +) + +type ForumSection struct { + ID int64 + Name string + Description string + IsHidden bool + IsHiddenForUsers bool +} + +type ForumCategory struct { + ID int64 + SectionID int64 + Name string + Description string + IsForComments bool +} + +// ForumLastPost carries ids rather than rows so the caller can reach for the +// article and the author through the lookups it already has. +type ForumLastPost struct { + ID int64 + CreatedAt time.Time + ThreadID int64 + ThreadName string + ThreadArticleID *int64 + AuthorID *int64 +} + +type ForumCounts struct { + Threads int + Posts int +} + +const forumSectionColumns = `id, name, description, is_hidden, is_hidden_for_users` + +var qForumSections = register("ForumSections", ` +SELECT `+forumSectionColumns+` +FROM web_forumsection +ORDER BY "order", id`) + +func (d *DB) ForumSections(ctx context.Context) ([]ForumSection, error) { + rows, err := d.pool.Query(ctx, qForumSections) + if err != nil { + return nil, fmt.Errorf("query forum sections: %w", err) + } + defer rows.Close() + + var out []ForumSection + for rows.Next() { + var s ForumSection + if err := rows.Scan(&s.ID, &s.Name, &s.Description, &s.IsHidden, &s.IsHiddenForUsers); err != nil { + return nil, fmt.Errorf("scan forum section: %w", err) + } + out = append(out, s) + } + return out, rows.Err() +} + +var qForumSection = register("ForumSection", ` +SELECT `+forumSectionColumns+` +FROM web_forumsection +WHERE id = $1`) + +func (d *DB) ForumSection(ctx context.Context, id int64) (*ForumSection, error) { + var s ForumSection + err := d.pool.QueryRow(ctx, qForumSection, id).Scan( + &s.ID, &s.Name, &s.Description, &s.IsHidden, &s.IsHiddenForUsers) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("query forum section %d: %w", id, err) + } + return &s, nil +} + +var qForumCategories = register("ForumCategories", ` +SELECT id, section_id, name, description, is_for_comments +FROM web_forumcategory +ORDER BY "order", id`) + +func (d *DB) ForumCategories(ctx context.Context) ([]ForumCategory, error) { + rows, err := d.pool.Query(ctx, qForumCategories) + if err != nil { + return nil, fmt.Errorf("query forum categories: %w", err) + } + defer rows.Close() + + var out []ForumCategory + for rows.Next() { + var c ForumCategory + if err := rows.Scan(&c.ID, &c.SectionID, &c.Name, &c.Description, &c.IsForComments); err != nil { + return nil, fmt.Errorf("scan forum category: %w", err) + } + out = append(out, c) + } + return out, rows.Err() +} + +var qForumCategoryCounts = register("ForumCategoryCounts", ` +SELECT (SELECT count(*) FROM web_forumthread WHERE category_id = $1), + (SELECT count(*) FROM web_forumpost p + JOIN web_forumthread t ON t.id = p.thread_id + WHERE t.category_id = $1)`) + +func (d *DB) ForumCategoryCounts(ctx context.Context, categoryID int64) (ForumCounts, error) { + var c ForumCounts + if err := d.pool.QueryRow(ctx, qForumCategoryCounts, categoryID).Scan(&c.Threads, &c.Posts); err != nil { + return ForumCounts{}, fmt.Errorf("count forum category %d: %w", categoryID, err) + } + return c, nil +} + +// A category marked for comments counts every article's thread, whichever +// category the reader is looking at. +var qForumCommentCounts = register("ForumCommentCounts", ` +SELECT (SELECT count(*) FROM web_forumthread WHERE article_id IS NOT NULL), + (SELECT count(*) FROM web_forumpost p + JOIN web_forumthread t ON t.id = p.thread_id + WHERE t.article_id IS NOT NULL)`) + +func (d *DB) ForumCommentCounts(ctx context.Context) (ForumCounts, error) { + var c ForumCounts + if err := d.pool.QueryRow(ctx, qForumCommentCounts).Scan(&c.Threads, &c.Posts); err != nil { + return ForumCounts{}, fmt.Errorf("count forum comments: %w", err) + } + return c, nil +} + +const forumLastPostColumns = `p.id, p.created_at, t.id, t.name, t.article_id, p.author_id` + +// Ties are left to the database because Django orders on the timestamp alone. +var qForumCategoryLastPost = register("ForumCategoryLastPost", ` +SELECT `+forumLastPostColumns+` +FROM web_forumpost p +JOIN web_forumthread t ON t.id = p.thread_id +WHERE t.category_id = $1 +ORDER BY p.created_at DESC +LIMIT 1`) + +func (d *DB) ForumCategoryLastPost(ctx context.Context, categoryID int64) (*ForumLastPost, error) { + return d.scanLastPost(ctx, qForumCategoryLastPost, categoryID) +} + +var qForumCommentLastPost = register("ForumCommentLastPost", ` +SELECT `+forumLastPostColumns+` +FROM web_forumpost p +JOIN web_forumthread t ON t.id = p.thread_id +WHERE t.article_id IS NOT NULL +ORDER BY p.created_at DESC +LIMIT 1`) + +func (d *DB) ForumCommentLastPost(ctx context.Context) (*ForumLastPost, error) { + return d.scanLastPost(ctx, qForumCommentLastPost) +} + +func (d *DB) scanLastPost(ctx context.Context, sql string, args ...any) (*ForumLastPost, error) { + var p ForumLastPost + err := d.pool.QueryRow(ctx, sql, args...).Scan( + &p.ID, &p.CreatedAt, &p.ThreadID, &p.ThreadName, &p.ThreadArticleID, &p.AuthorID) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("query last forum post: %w", err) + } + return &p, nil +} diff --git a/internal/db/forum_test.go b/internal/db/forum_test.go new file mode 100644 index 00000000..4ed75d16 --- /dev/null +++ b/internal/db/forum_test.go @@ -0,0 +1,227 @@ +package db + +import ( + "context" + "errors" + "os" + "testing" + "time" +) + +func forumDB(t *testing.T) (*DB, context.Context) { + t.Helper() + dsn := os.Getenv(EnvDSN) + if dsn == "" { + t.Skipf("%s not set, skipping the database test", EnvDSN) + } + ctx := context.Background() + d, err := Open(ctx, dsn) + if err != nil { + t.Fatalf("Open() err = %v, want nil", err) + } + t.Cleanup(d.Close) + return d, ctx +} + +func TestForumSectionsComeBackInOrder(t *testing.T) { + d, ctx := forumDB(t) + sections, err := d.ForumSections(ctx) + if err != nil { + t.Fatalf("ForumSections() err = %v, want nil", err) + } + + want := []struct { + name string + hidden bool + hiddenForUsers bool + }{ + {"Probe Open", false, false}, + {"Probe Hidden", true, false}, + {"Probe Staff", false, true}, + } + if len(sections) != len(want) { + t.Fatalf("len(ForumSections()) = %d, want %d", len(sections), len(want)) + } + for i, w := range want { + if sections[i].Name != w.name { + t.Errorf("ForumSections()[%d].Name = %q, want %q", i, sections[i].Name, w.name) + } + if sections[i].IsHidden != w.hidden { + t.Errorf("ForumSections()[%d].IsHidden = %t, want %t", i, sections[i].IsHidden, w.hidden) + } + if sections[i].IsHiddenForUsers != w.hiddenForUsers { + t.Errorf("ForumSections()[%d].IsHiddenForUsers = %t, want %t", i, sections[i].IsHiddenForUsers, w.hiddenForUsers) + } + } +} + +func TestForumSectionByID(t *testing.T) { + d, ctx := forumDB(t) + sections, err := d.ForumSections(ctx) + if err != nil { + t.Fatalf("ForumSections() err = %v, want nil", err) + } + got, err := d.ForumSection(ctx, sections[0].ID) + if err != nil { + t.Fatalf("ForumSection(%d) err = %v, want nil", sections[0].ID, err) + } + if got.Name != sections[0].Name { + t.Errorf("ForumSection(%d).Name = %q, want %q", sections[0].ID, got.Name, sections[0].Name) + } +} + +func TestForumSectionOfAnUnknownID(t *testing.T) { + d, ctx := forumDB(t) + if _, err := d.ForumSection(ctx, -1); !errors.Is(err, ErrNotFound) { + t.Errorf("ForumSection(-1) err = %v, want ErrNotFound", err) + } +} + +func TestForumCategoriesComeBackInOrder(t *testing.T) { + d, ctx := forumDB(t) + categories, err := d.ForumCategories(ctx) + if err != nil { + t.Fatalf("ForumCategories() err = %v, want nil", err) + } + + want := []string{"Probe Chat", "Probe Hidden Chat", "Probe Staff Chat", "Probe Comments", "Probe Quiet"} + if len(categories) != len(want) { + t.Fatalf("len(ForumCategories()) = %d, want %d", len(categories), len(want)) + } + for i, name := range want { + if categories[i].Name != name { + t.Errorf("ForumCategories()[%d].Name = %q, want %q", i, categories[i].Name, name) + } + } +} + +func categoryNamed(t *testing.T, d *DB, ctx context.Context, name string) ForumCategory { + t.Helper() + categories, err := d.ForumCategories(ctx) + if err != nil { + t.Fatalf("ForumCategories() err = %v, want nil", err) + } + for _, c := range categories { + if c.Name == name { + return c + } + } + t.Fatalf("ForumCategories() has no %q, want it; run oracle_seed.py first", name) + return ForumCategory{} +} + +func TestForumCategoryCounts(t *testing.T) { + d, ctx := forumDB(t) + chat := categoryNamed(t, d, ctx, "Probe Chat") + got, err := d.ForumCategoryCounts(ctx, chat.ID) + if err != nil { + t.Fatalf("ForumCategoryCounts(chat) err = %v, want nil", err) + } + if got.Threads != 2 { + t.Errorf("ForumCategoryCounts(chat).Threads = %d, want %d", got.Threads, 2) + } + if got.Posts != 4 { + t.Errorf("ForumCategoryCounts(chat).Posts = %d, want %d", got.Posts, 4) + } +} + +func TestForumCategoryCountsOfAnEmptyCategory(t *testing.T) { + d, ctx := forumDB(t) + quiet := categoryNamed(t, d, ctx, "Probe Quiet") + got, err := d.ForumCategoryCounts(ctx, quiet.ID) + if err != nil { + t.Fatalf("ForumCategoryCounts(quiet) err = %v, want nil", err) + } + if got.Threads != 0 || got.Posts != 0 { + t.Errorf("ForumCategoryCounts(quiet) = %+v, want zeroes", got) + } +} + +func TestForumCategoryLastPost(t *testing.T) { + d, ctx := forumDB(t) + chat := categoryNamed(t, d, ctx, "Probe Chat") + got, err := d.ForumCategoryLastPost(ctx, chat.ID) + if err != nil { + t.Fatalf("ForumCategoryLastPost(chat) err = %v, want nil", err) + } + if got.ThreadName != "Probe Locked Thread" { + t.Errorf("ForumCategoryLastPost(chat).ThreadName = %q, want %q", got.ThreadName, "Probe Locked Thread") + } + want := time.Date(2023, 9, 10, 11, 15, 13, 0, time.UTC) + if !got.CreatedAt.Equal(want) { + t.Errorf("ForumCategoryLastPost(chat).CreatedAt = %v, want %v", got.CreatedAt.UTC(), want) + } + if got.ThreadArticleID != nil { + t.Errorf("ForumCategoryLastPost(chat).ThreadArticleID = %v, want nil", *got.ThreadArticleID) + } + if got.AuthorID == nil { + t.Error("ForumCategoryLastPost(chat).AuthorID = nil, want an id") + } +} + +func TestForumCategoryLastPostOfAnEmptyCategory(t *testing.T) { + d, ctx := forumDB(t) + quiet := categoryNamed(t, d, ctx, "Probe Quiet") + if _, err := d.ForumCategoryLastPost(ctx, quiet.ID); !errors.Is(err, ErrNotFound) { + t.Errorf("ForumCategoryLastPost(quiet) err = %v, want ErrNotFound", err) + } +} + +func TestForumCommentCountsReachEveryArticle(t *testing.T) { + d, ctx := forumDB(t) + comments := categoryNamed(t, d, ctx, "Probe Comments") + byCategory, err := d.ForumCategoryCounts(ctx, comments.ID) + if err != nil { + t.Fatalf("ForumCategoryCounts(comments) err = %v, want nil", err) + } + if byCategory.Threads != 0 || byCategory.Posts != 0 { + t.Errorf("ForumCategoryCounts(comments) = %+v, want zeroes", byCategory) + } + + got, err := d.ForumCommentCounts(ctx) + if err != nil { + t.Fatalf("ForumCommentCounts() err = %v, want nil", err) + } + if got.Threads < 1 { + t.Errorf("ForumCommentCounts().Threads = %d, want at least 1", got.Threads) + } + if got.Posts != 2 { + t.Errorf("ForumCommentCounts().Posts = %d, want %d", got.Posts, 2) + } +} + +func TestForumCommentLastPostComesFromAnArticleThread(t *testing.T) { + d, ctx := forumDB(t) + got, err := d.ForumCommentLastPost(ctx) + if err != nil { + t.Fatalf("ForumCommentLastPost() err = %v, want nil", err) + } + if got.ThreadArticleID == nil { + t.Error("ForumCommentLastPost().ThreadArticleID = nil, want an id") + } + if got.ThreadName != "Probe Full" { + t.Errorf("ForumCommentLastPost().ThreadName = %q, want %q", got.ThreadName, "Probe Full") + } +} + +func TestUserByIDRoundTrips(t *testing.T) { + d, ctx := forumDB(t) + want, err := d.UserByUsername(ctx, "probe-author") + if err != nil { + t.Fatalf("UserByUsername(probe-author) err = %v, want nil", err) + } + got, err := d.UserByID(ctx, want.ID) + if err != nil { + t.Fatalf("UserByID(%d) err = %v, want nil", want.ID, err) + } + if got.Username != want.Username { + t.Errorf("UserByID(%d).Username = %q, want %q", want.ID, got.Username, want.Username) + } +} + +func TestUserByIDOfAnUnknownID(t *testing.T) { + d, ctx := forumDB(t) + if _, err := d.UserByID(ctx, -1); !errors.Is(err, ErrNotFound) { + t.Errorf("UserByID(-1) err = %v, want ErrNotFound", err) + } +} diff --git a/internal/db/testdata/oracle_forum.py b/internal/db/testdata/oracle_forum.py new file mode 100644 index 00000000..8dfd6875 --- /dev/null +++ b/internal/db/testdata/oracle_forum.py @@ -0,0 +1,47 @@ +"""Print what Django answers for the forum listing's own queries. + + docker compose exec -T web python manage.py shell < internal/db/testdata/oracle_forum.py + +It reads the rows oracle_seed.py creates, so run that one first. The expressions +are the ones modules/forumstart.py uses. The answers here are what +internal/db/forum_test.go asserts. +""" + +from web.models.forum import ForumCategory, ForumPost, ForumSection, ForumThread + + +def show_sections(): + for section in ForumSection.objects.all().order_by('order', 'id'): + print('section %s hidden=%s hidden_for_users=%s' % ( + section.name, section.is_hidden, section.is_hidden_for_users)) + + +def show_categories(): + sections = {s.id: s.name for s in ForumSection.objects.all()} + for category in ForumCategory.objects.all().order_by('order', 'id'): + print('category %s section=%s for_comments=%s' % ( + category.name, sections[category.section_id], category.is_for_comments)) + + +def show_counts(category): + if category.is_for_comments: + threads = ForumThread.objects.filter(article_id__isnull=False).count() + posts = ForumPost.objects.filter(thread__article_id__isnull=False).count() + last = ForumPost.objects.filter(thread__article_id__isnull=False).order_by('-created_at')[:1] + else: + threads = ForumThread.objects.filter(category=category).count() + posts = ForumPost.objects.filter(thread__category=category).count() + last = ForumPost.objects.filter(thread__category=category).order_by('-created_at')[:1] + if last: + post = last[0] + tail = 'last=%s thread=%s article=%s' % ( + post.name, post.thread.name, post.thread.article_id is not None) + else: + tail = 'last=None' + print('counts %s threads=%d posts=%d %s' % (category.name, threads, posts, tail)) + + +show_sections() +show_categories() +for category in ForumCategory.objects.all().order_by('order', 'id'): + show_counts(category) diff --git a/internal/db/user.go b/internal/db/user.go index 991a1f5f..7d212324 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -108,6 +108,25 @@ func (d *DB) UserByUsername(ctx context.Context, name string) (*User, error) { return d.scanUser(ctx, qUserByUsername, name) } +var qUserByID = register("UserByID", ` +SELECT `+userColumns+` +FROM web_user +WHERE id = $1`) + +func (d *DB) UserByID(ctx context.Context, id int64) (*User, error) { + var u User + dest, finish := userDest(&u) + err := d.pool.QueryRow(ctx, qUserByID, id).Scan(dest...) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("lookup user %d: %w", id, err) + } + finish() + return &u, nil +} + var qUserByDisplayName = register("UserByDisplayName", ` SELECT `+userColumns+` FROM web_user diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index 146905fb..fd421cf8 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -12,12 +12,13 @@ source with pwikit render -page host -category probe. """ import datetime +import itertools from django.utils import timezone from web.controllers import articles from web.models.articles import Article, Category, Tag, TagsCategory, Vote -from web.models.forum import ForumPost, ForumThread +from web.models.forum import ForumCategory, ForumPost, ForumPostVersion, ForumSection, ForumThread from web.models.notifications import UserNotification, UserNotificationMapping, UserNotificationSubscription from web.models.settings import Settings from web.models.site import Site @@ -27,6 +28,8 @@ CREATED_AT = datetime.datetime(2021, 3, 4, 5, 6, 7, tzinfo=datetime.timezone.utc) UPDATED_AT = datetime.datetime(2022, 7, 8, 9, 10, 11, tzinfo=datetime.timezone.utc) +POSTED_AT = datetime.datetime(2023, 9, 10, 11, 12, 13, tzinfo=datetime.timezone.utc) +POSTED_MINUTES = itertools.count() def make_user(username, **kwargs): @@ -74,6 +77,41 @@ def comment_thread(article, user, posts): return thread +def forum_section(name, order, **kwargs): + section, _ = ForumSection.objects.get_or_create(name=name) + section.order = order + for key, value in kwargs.items(): + setattr(section, key, value) + section.save() + return section + + +def forum_category(section, name, order, **kwargs): + category, _ = ForumCategory.objects.get_or_create(section=section, name=name) + category.order = order + for key, value in kwargs.items(): + setattr(category, key, value) + category.save() + return category + + +def forum_thread(category, name, user, posts): + thread, _ = ForumThread.objects.get_or_create( + category=category, name=name, defaults=dict(author=user, description='%s description' % name)) + made = [] + for i in range(posts): + post, created = ForumPost.objects.get_or_create( + thread=thread, name='%s post %d' % (name, i), defaults=dict(author=user)) + if created: + ForumPostVersion.objects.create(post=post, source='%s body %d' % (name, i), author=user) + made.append(post) + ForumThread.objects.filter(pk=thread.pk).update(created_at=CREATED_AT, updated_at=UPDATED_AT) + for post in made: + at = POSTED_AT + datetime.timedelta(minutes=next(POSTED_MINUTES)) + ForumPost.objects.filter(pk=post.pk).update(created_at=at, updated_at=at) + return thread + + def subscribe(user, article=None, forum_thread=None): UserNotificationSubscription.objects.get_or_create( subscriber=user, article=article, forum_thread=forum_thread, @@ -210,6 +248,20 @@ def vote(article, user, rate): TagsCategory.objects.filter(slug='lang').update(priority=1) bare.tags.clear() +open_section = forum_section('Probe Open', 0, description='an open section') +hidden_section = forum_section('Probe Hidden', 1, description='hidden from the listing', is_hidden=True) +staff_section = forum_section('Probe Staff', 2, description='only staff may browse', is_hidden_for_users=True) + +chat = forum_category(open_section, 'Probe Chat', 0, description='ordinary threads') +comments = forum_category(open_section, 'Probe Comments', 1, description='article comments', is_for_comments=True) +quiet = forum_category(open_section, 'Probe Quiet', 2, description='nobody has posted here') +forum_category(hidden_section, 'Probe Hidden Chat', 0, description='inside the hidden section') +forum_category(staff_section, 'Probe Staff Chat', 0, description='inside the staff section') + +forum_thread(chat, 'Probe Thread', author, 3) +forum_thread(chat, 'Probe Locked Thread', voter, 1).is_locked = True +ForumThread.objects.filter(category=chat, name='Probe Locked Thread').update(is_locked=True) + thread = comment_thread(full, author, 2) subscribe(author, article=full) subscribe(author, forum_thread=thread) @@ -250,6 +302,7 @@ def vote(article, user, rate): freeze(article) print('site rating_mode =', site_settings.rating_mode) +print('forum sections =', ForumSection.objects.count(), 'categories =', ForumCategory.objects.count()) print('seeded', ', '.join(a.full_name for a in (parent, full, bare, rated, unrated, third, quarter, unratable, half, included, host, redirect, described, imaged, tagged, taggedplain, diff --git a/internal/perms/perms_test.go b/internal/perms/perms_test.go index 791d7db4..11280359 100644 --- a/internal/perms/perms_test.go +++ b/internal/perms/perms_test.go @@ -187,6 +187,12 @@ var scenarios = []scenario{ User: userSpec{Kind: "normal"}, Object: &objectSpec{Kind: "forum_section", HiddenForUsers: true}, }, + { + Name: "a forum category answers as if there were no object", + Roles: withRoles(roleSpec{Slug: "moderator", Permissions: []string{ViewHiddenForumSections}}), + User: userSpec{Kind: "normal", Roles: []string{"moderator"}}, + Object: &objectSpec{Kind: "forum_category"}, + }, { Name: "a plain thread", Roles: baseRoles, @@ -309,7 +315,7 @@ func (s scenario) subject() Subject { } func (s scenario) object() *Object { - if s.Object == nil { + if s.Object == nil || s.Object.Kind == "forum_category" { return nil } o := &Object{ diff --git a/internal/perms/testdata/oracle_perms.py b/internal/perms/testdata/oracle_perms.py index 1baa7ddf..59e92b55 100644 --- a/internal/perms/testdata/oracle_perms.py +++ b/internal/perms/testdata/oracle_perms.py @@ -64,6 +64,8 @@ def build_forum_object(spec, user, index): if spec['kind'] == 'forum_section': return ForumSection.objects.get(pk=section.pk) category = ForumCategory.objects.create(name='permprobe%d' % index, section=section) + if spec['kind'] == 'forum_category': + return ForumCategory.objects.get(pk=category.pk) author = None if user.is_anonymous else user thread_author = spec.get('author') if spec['kind'] == 'forum_thread' else spec.get('thread_author') thread = ForumThread.objects.create( diff --git a/internal/perms/testdata/perms.golden b/internal/perms/testdata/perms.golden index 89c61ae8..7ab15219 100644 --- a/internal/perms/testdata/perms.golden +++ b/internal/perms/testdata/perms.golden @@ -538,6 +538,33 @@ move_forum_threads = false view_forum_sections = false view_hidden_forum_sections = false view_forum_categories = false +=== a forum category answers as if there were no object +view_articles = true +rate_articles = true +create_articles = false +edit_articles = false +tag_articles = false +move_articles = false +lock_articles = false +manage_article_files = false +delete_articles = false +reset_article_votes = false +comment_articles = true +view_article_comments = true +manage_article_authors = false +view_forum_posts = true +create_forum_posts = true +edit_forum_posts = false +delete_forum_posts = false +view_forum_threads = true +create_forum_threads = true +edit_forum_threads = false +pin_forum_threads = false +lock_forum_threads = false +move_forum_threads = false +view_forum_sections = true +view_hidden_forum_sections = true +view_forum_categories = true === a plain thread view_articles = true rate_articles = true diff --git a/internal/perms/testdata/perms_corpus.json b/internal/perms/testdata/perms_corpus.json index 07e542f1..3774fdbe 100644 --- a/internal/perms/testdata/perms_corpus.json +++ b/internal/perms/testdata/perms_corpus.json @@ -1077,6 +1077,64 @@ "thread_author": false } }, + { + "name": "a forum category answers as if there were no object", + "roles": [ + { + "slug": "everyone", + "permissions": [ + "view_articles", + "view_article_comments", + "view_forum_sections", + "view_forum_categories", + "view_forum_threads", + "view_forum_posts" + ], + "restrictions": null + }, + { + "slug": "registered", + "permissions": [ + "comment_articles", + "rate_articles", + "create_forum_threads", + "create_forum_posts" + ], + "restrictions": null + }, + { + "slug": "editor", + "permissions": [ + "edit_articles", + "tag_articles", + "move_articles" + ], + "restrictions": null + }, + { + "slug": "moderator", + "permissions": [ + "view_hidden_forum_sections" + ], + "restrictions": null + } + ], + "user": { + "kind": "normal", + "roles": [ + "moderator" + ], + "forum_barred": false + }, + "object": { + "kind": "forum_category", + "overrides": null, + "locked": false, + "author": false, + "hidden_for_users": false, + "thread_author": false + } + }, { "name": "a plain thread", "roles": [ diff --git a/internal/repo/perms.go b/internal/repo/perms.go index 38bb4054..94ed1466 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -91,3 +91,9 @@ func (p *Perms) Category(name string) (*perms.Object, error) { } return &perms.Object{Overrides: overrides}, nil } + +// The forum models sit outside the per-role override table, so nothing but the +// hidden flag reaches the answer. +func (p *Perms) ForumSection(s *db.ForumSection) *perms.Object { + return &perms.Object{Kind: perms.KindForumSection, HiddenForUsers: s.IsHiddenForUsers} +} From c90c4df84ef6aa00ae739f384775edc910e71155 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 15:13:42 +0900 Subject: [PATCH 076/428] share python's number parsing between modules --- internal/listpages/params.go | 65 ++++++------------------------- internal/listpages/params_test.go | 26 ------------- internal/pynum/pynum.go | 52 +++++++++++++++++++++++++ internal/pynum/pynum_test.go | 29 ++++++++++++++ 4 files changed, 92 insertions(+), 80 deletions(-) create mode 100644 internal/pynum/pynum.go create mode 100644 internal/pynum/pynum_test.go diff --git a/internal/listpages/params.go b/internal/listpages/params.go index abdb2976..049c7dec 100644 --- a/internal/listpages/params.go +++ b/internal/listpages/params.go @@ -3,12 +3,12 @@ package listpages import ( "errors" - "strconv" "strings" "time" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pynum" ) type Source interface { @@ -384,7 +384,7 @@ func timeOp(op string) string { // day of 2020-12. func parseDateBounds(text string) (first, last time.Time, ok bool) { parts := strings.Split(text, "-") - year, err := pyInt(parts[0]) + year, err := pynum.Int(parts[0]) if err != nil || year < 1 || year > 9999 { return time.Time{}, time.Time{}, false } @@ -392,7 +392,7 @@ func parseDateBounds(text string) (first, last time.Time, ok bool) { lastMonth, lastDay := 12, 31 if len(parts) >= 2 { - m, err := pyInt(parts[1]) + m, err := pynum.Int(parts[1]) if err != nil { return time.Time{}, time.Time{}, false } @@ -401,7 +401,7 @@ func parseDateBounds(text string) (first, last time.Time, ok bool) { lastDay = daysIn(year, month) } if len(parts) >= 3 { - d, err := pyInt(parts[2]) + d, err := pynum.Int(parts[2]) if err != nil { return time.Time{}, time.Time{}, false } @@ -441,7 +441,7 @@ func (p *parser) parseRating() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pyFloat(strings.TrimSpace(rest)) + value, err := pynum.Float(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -463,7 +463,7 @@ func (p *parser) parseVotes() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pyInt(strings.TrimSpace(rest)) + value, err := pynum.Int(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -485,7 +485,7 @@ func (p *parser) parsePopularity() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pyInt(strings.TrimSpace(rest)) + value, err := pynum.Int(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -567,19 +567,19 @@ func (p *parser) parseSort() { } func (p *parser) parseWindow() { - if offset, err := pyInt(p.getOr("offset", "0")); err == nil { + if offset, err := pynum.Int(p.getOr("offset", "0")); err == nil { p.out.Offset = offset } if raw, ok := p.params["limit"]; ok { - if limit, err := pyInt(raw); err == nil { + if limit, err := pynum.Int(raw); err == nil { p.out.Limit = &limit } } - perPage, err := pyInt(p.getOr("perpage", "20")) + perPage, err := pynum.Int(p.getOr("perpage", "20")) if err != nil { perPage = defaultPerPage } - pageNum, err := pyInt(p.pathOr("p", "1")) + pageNum, err := pynum.Int(p.pathOr("p", "1")) if err != nil || pageNum < 1 { pageNum = 1 } @@ -644,46 +644,3 @@ func splitArgOperator(arg string, allowed []string, def string) (op, rest string } return def, arg } - -var errNotANumber = errors.New("listpages: not a number") - -// Python's int() tolerates surrounding space, a sign and underscores between -// digits. Non-ASCII digits are the one thing it takes that this does not. -func pyInt(s string) (int, error) { - s = strings.TrimSpace(s) - body := strings.TrimPrefix(strings.TrimPrefix(s, "+"), "-") - if body == "" || strings.HasPrefix(body, "_") || strings.HasSuffix(body, "_") { - return 0, errNotANumber - } - if strings.Contains(body, "__") { - return 0, errNotANumber - } - for _, r := range body { - if r != '_' && (r < '0' || r > '9') { - return 0, errNotANumber - } - } - n, err := strconv.Atoi(strings.ReplaceAll(s, "_", "")) - if err != nil { - return 0, errNotANumber - } - return n, nil -} - -// Go would take a hexadecimal float that Python rejects, so the digits are -// checked first. -func pyFloat(s string) (float64, error) { - if n, err := pyInt(s); err == nil { - return float64(n), nil - } - s = strings.TrimSpace(s) - lowered := strings.ToLower(s) - if strings.Contains(lowered, "x") || strings.Contains(lowered, "p") { - return 0, errNotANumber - } - f, err := strconv.ParseFloat(strings.ReplaceAll(s, "_", ""), 64) - if err != nil { - return 0, errNotANumber - } - return f, nil -} diff --git a/internal/listpages/params_test.go b/internal/listpages/params_test.go index c96f343e..a3d185d2 100644 --- a/internal/listpages/params_test.go +++ b/internal/listpages/params_test.go @@ -553,29 +553,3 @@ func TestParseWindowFallsBackOnJunk(t *testing.T) { t.Errorf("Page = %d, want 1", q.Page) } } - -func TestPyInt(t *testing.T) { - good := map[string]int{"5": 5, " 5 ": 5, "+5": 5, "-5": -5, "1_000": 1000, "0": 0} - for in, want := range good { - got, err := pyInt(in) - if err != nil || got != want { - t.Errorf("pyInt(%q) = %d, %v, want %d, nil", in, got, err, want) - } - } - for _, in := range []string{"", " ", "_5", "5_", "1__0", "5.0", "0x10", "５", "+"} { - if got, err := pyInt(in); err == nil { - t.Errorf("pyInt(%q) = %d, nil, want an error", in, got) - } - } -} - -func TestPyFloatRejectsWhatPythonRejects(t *testing.T) { - for _, in := range []string{"0x1p-2", "", "abc"} { - if got, err := pyFloat(in); err == nil { - t.Errorf("pyFloat(%q) = %v, nil, want an error", in, got) - } - } - if got, err := pyFloat("3.5"); err != nil || got != 3.5 { - t.Errorf("pyFloat(3.5) = %v, %v, want 3.5, nil", got, err) - } -} diff --git a/internal/pynum/pynum.go b/internal/pynum/pynum.go new file mode 100644 index 00000000..180fc9bd --- /dev/null +++ b/internal/pynum/pynum.go @@ -0,0 +1,52 @@ +// Package pynum is Python's int() and float() over the strings a wikitext +// author typed. +package pynum + +import ( + "errors" + "strconv" + "strings" +) + +var ErrNotANumber = errors.New("pynum: not a number") + +// Python's int() tolerates surrounding space, a sign and underscores between +// digits. Non-ASCII digits are the one thing it takes that this does not. +func Int(s string) (int, error) { + s = strings.TrimSpace(s) + body := strings.TrimPrefix(strings.TrimPrefix(s, "+"), "-") + if body == "" || strings.HasPrefix(body, "_") || strings.HasSuffix(body, "_") { + return 0, ErrNotANumber + } + if strings.Contains(body, "__") { + return 0, ErrNotANumber + } + for _, r := range body { + if r != '_' && (r < '0' || r > '9') { + return 0, ErrNotANumber + } + } + n, err := strconv.Atoi(strings.ReplaceAll(s, "_", "")) + if err != nil { + return 0, ErrNotANumber + } + return n, nil +} + +// Go would take a hexadecimal float that Python rejects, so the digits are +// checked first. +func Float(s string) (float64, error) { + if n, err := Int(s); err == nil { + return float64(n), nil + } + s = strings.TrimSpace(s) + lowered := strings.ToLower(s) + if strings.Contains(lowered, "x") || strings.Contains(lowered, "p") { + return 0, ErrNotANumber + } + f, err := strconv.ParseFloat(strings.ReplaceAll(s, "_", ""), 64) + if err != nil { + return 0, ErrNotANumber + } + return f, nil +} diff --git a/internal/pynum/pynum_test.go b/internal/pynum/pynum_test.go new file mode 100644 index 00000000..2c8143e5 --- /dev/null +++ b/internal/pynum/pynum_test.go @@ -0,0 +1,29 @@ +package pynum + +import "testing" + +func TestInt(t *testing.T) { + good := map[string]int{"5": 5, " 5 ": 5, "+5": 5, "-5": -5, "1_000": 1000, "0": 0} + for in, want := range good { + got, err := Int(in) + if err != nil || got != want { + t.Errorf("Int(%q) = %d, %v, want %d, nil", in, got, err, want) + } + } + for _, in := range []string{"", " ", "_5", "5_", "1__0", "5.0", "0x10", "５", "+"} { + if got, err := Int(in); err == nil { + t.Errorf("Int(%q) = %d, nil, want an error", in, got) + } + } +} + +func TestFloatRejectsWhatPythonRejects(t *testing.T) { + for _, in := range []string{"0x1p-2", "", "abc"} { + if got, err := Float(in); err == nil { + t.Errorf("Float(%q) = %v, nil, want an error", in, got) + } + } + if got, err := Float("3.5"); err != nil || got != 3.5 { + t.Errorf("Float(3.5) = %v, %v, want 3.5, nil", got, err) + } +} From f361bb7ff266ae96d9825dcf200828719d70ad18 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 15:13:47 +0900 Subject: [PATCH 077/428] carry the thread's category on the last post --- internal/db/forum.go | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/internal/db/forum.go b/internal/db/forum.go index 0a3082fd..e82ae0ce 100644 --- a/internal/db/forum.go +++ b/internal/db/forum.go @@ -28,12 +28,13 @@ type ForumCategory struct { // ForumLastPost carries ids rather than rows so the caller can reach for the // article and the author through the lookups it already has. type ForumLastPost struct { - ID int64 - CreatedAt time.Time - ThreadID int64 - ThreadName string - ThreadArticleID *int64 - AuthorID *int64 + ID int64 + CreatedAt time.Time + ThreadID int64 + ThreadName string + ThreadCategoryID *int64 + ThreadArticleID *int64 + AuthorID *int64 } type ForumCounts struct { @@ -137,7 +138,7 @@ func (d *DB) ForumCommentCounts(ctx context.Context) (ForumCounts, error) { return c, nil } -const forumLastPostColumns = `p.id, p.created_at, t.id, t.name, t.article_id, p.author_id` +const forumLastPostColumns = `p.id, p.created_at, t.id, t.name, t.category_id, t.article_id, p.author_id` // Ties are left to the database because Django orders on the timestamp alone. var qForumCategoryLastPost = register("ForumCategoryLastPost", ` @@ -167,7 +168,7 @@ func (d *DB) ForumCommentLastPost(ctx context.Context) (*ForumLastPost, error) { func (d *DB) scanLastPost(ctx context.Context, sql string, args ...any) (*ForumLastPost, error) { var p ForumLastPost err := d.pool.QueryRow(ctx, sql, args...).Scan( - &p.ID, &p.CreatedAt, &p.ThreadID, &p.ThreadName, &p.ThreadArticleID, &p.AuthorID) + &p.ID, &p.CreatedAt, &p.ThreadID, &p.ThreadName, &p.ThreadCategoryID, &p.ThreadArticleID, &p.AuthorID) if errors.Is(err, pgx.ErrNoRows) { return nil, ErrNotFound } From 7cdf1ade9baecaeefad96f497fbb2148061c5165 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 15:13:53 +0900 Subject: [PATCH 078/428] answer the forum listing --- internal/i18n/locales/zh-hans.json | 15 ++ internal/module/module.go | 20 ++ internal/module/render_test.go | 3 +- internal/modules/forum.go | 60 ++++++ internal/modules/forum_test.go | 46 +++++ internal/modules/forumstart.go | 283 +++++++++++++++++++++++++++++ internal/modules/listpages_test.go | 1 + internal/modules/rate.go | 2 +- internal/repo/modules.go | 54 ++++++ internal/repo/repo.go | 4 + 10 files changed, 486 insertions(+), 2 deletions(-) create mode 100644 internal/modules/forum.go create mode 100644 internal/modules/forum_test.go create mode 100644 internal/modules/forumstart.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 6e9ffd9a..fb8b0610 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -8,8 +8,23 @@ "include-create": "立刻创建", "include-loop": "插入的页面 \"{name}\" 导致了无限包含循环", "include-missing": "插入的页面 \"{name}\" 不存在", + "module-date-format": "{month}.{day}.{year} {hour}:{minute}", + "module-date-format-js": "%m.%d.%Y %H:%M", + "module-date-missing": "n/a", "module-disabled": "模块处理已禁用", "module-failed": "处理模块 '{name}' 时出错", + "module-forum-author": "作者：", + "module-forum-breadcrumb": "论坛", + "module-forum-view-post": "查看", + "module-forumstart-hide-hidden": "隐藏隐藏版块", + "module-forumstart-last-post": "最后回复", + "module-forumstart-no-section": "未找到版块 \"{name}\"", + "module-forumstart-posts": "帖子数", + "module-forumstart-section": "版块名称", + "module-forumstart-section-title": "论坛 — {name}", + "module-forumstart-show-hidden": "显示隐藏版块", + "module-forumstart-threads": "主题数", + "module-forumstart-title": "论坛版块", "module-listpages-pager-count": "第 {page} 页; 共 {total} 页", "module-listpages-pager-next": "下一页 »", "module-listpages-pager-prev": "« 上一页", diff --git a/internal/module/module.go b/internal/module/module.go index a91cff00..54974eed 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -8,6 +8,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/i18n" "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" ) // Error is the failure that reaches the reader as a block on the page rather @@ -31,9 +32,27 @@ type Data interface { HasVoted(articleID int64, userID *int64) (bool, error) ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) CountArticles(f db.ListFilter, offset int, limit *int) (int, error) + + ArticleByID(id int64) (*db.Article, error) + RenderUserByID(id *int64) (string, error) + + ForumSections() ([]db.ForumSection, error) + ForumSection(id int64) (*db.ForumSection, error) + ForumCategories() ([]db.ForumCategory, error) + ForumCategoryCounts(categoryID int64) (db.ForumCounts, error) + ForumCommentCounts() (db.ForumCounts, error) + ForumCategoryLastPost(categoryID int64) (*db.ForumLastPost, error) + ForumCommentLastPost() (*db.ForumLastPost, error) + + Subject(user *db.User) (perms.Subject, error) + ForumSectionObject(s *db.ForumSection) *perms.Object } type Env struct { + // Name is what the wikitext spelled, which is what an error block about + // this module has to quote back. + Name string + Page *page.Context Loc *i18n.Localizer Site *db.Site @@ -82,6 +101,7 @@ func Render(env Env, name string, params map[string]string, body string) (string info, ok := Lookup(name) if ok && !info.Removed { if render, ok := renderers[info.Name]; ok { + env.Name = name return render(env, params, body) } } diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 1aa63583..6cd8dda0 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -12,6 +12,7 @@ import ( ) type fakeData struct { + module.Data category db.TagCategory articles []db.Article hidden []string @@ -53,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} + ported := []string{"forumstart", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/forum.go b/internal/modules/forum.go new file mode 100644 index 00000000..44fa4557 --- /dev/null +++ b/internal/modules/forum.go @@ -0,0 +1,60 @@ +package modules + +import ( + "strconv" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" +) + +const ( + ind8 = " " + ind12 = " " + ind16 = " " + ind20 = " " + ind24 = " " + ind28 = " " + ind32 = " " + ind36 = " " + ind40 = " " +) + +func forumSectionURL(id int64, name string) string { + return "/forum/s-" + strconv.FormatInt(id, 10) + "/" + wikidot.Normalize(name) +} + +func forumCategoryURL(id int64, name string) string { + return "/forum/c-" + strconv.FormatInt(id, 10) + "/" + wikidot.Normalize(name) +} + +func forumPostURL(threadID int64, threadName string, postID int64) string { + return "/forum/t-" + strconv.FormatInt(threadID, 10) + "/" + wikidot.Normalize(threadName) + + "#post-" + strconv.FormatInt(postID, 10) +} + +func renderDate(env module.Env, at time.Time) string { + return `` + + escape.HTML(serverDate(env, at)) + `` +} + +// Python calls strftime on what the ORM handed back, which is UTC and not the +// site's zone. +func serverDate(env module.Env, at time.Time) string { + at = at.UTC() + pad := func(n int) string { + if n < 10 { + return "0" + strconv.Itoa(n) + } + return strconv.Itoa(n) + } + return env.Text("module-date-format", + "year", strconv.Itoa(at.Year()), + "month", pad(int(at.Month())), + "day", pad(at.Day()), + "hour", pad(at.Hour()), + "minute", pad(at.Minute())) +} diff --git a/internal/modules/forum_test.go b/internal/modules/forum_test.go new file mode 100644 index 00000000..8e27bfdb --- /dev/null +++ b/internal/modules/forum_test.go @@ -0,0 +1,46 @@ +package modules + +import ( + "testing" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/module" +) + +func forumEnv(t *testing.T) module.Env { + t.Helper() + bundle, err := i18n.Load("") + if err != nil { + t.Fatalf("i18n.Load() err = %v, want nil", err) + } + return module.Env{Loc: bundle.Localizer(i18n.DefaultLanguage)} +} + +func TestForumURLsNormalizeTheName(t *testing.T) { + if got, want := forumSectionURL(3, "Probe Open"), "/forum/s-3/probe-open"; got != want { + t.Errorf("forumSectionURL(3, %q) = %q, want %q", "Probe Open", got, want) + } + if got, want := forumCategoryURL(7, "Probe Chat"), "/forum/c-7/probe-chat"; got != want { + t.Errorf("forumCategoryURL(7, %q) = %q, want %q", "Probe Chat", got, want) + } + if got, want := forumPostURL(2, "Probe Thread", 9), "/forum/t-2/probe-thread#post-9"; got != want { + t.Errorf("forumPostURL(2, %q, 9) = %q, want %q", "Probe Thread", got, want) + } +} + +func TestRenderDateIsUTC(t *testing.T) { + at := time.Date(2023, 9, 10, 11, 12, 13, 0, time.FixedZone("east", 8*3600)) + want := `09.10.2023 03:12` + if got := renderDate(forumEnv(t), at); got != want { + t.Errorf("renderDate(%s) = %q, want %q", at, got, want) + } +} + +func TestServerDatePadsEveryField(t *testing.T) { + at := time.Date(2021, 3, 4, 5, 6, 7, 0, time.UTC) + if got, want := serverDate(forumEnv(t), at), "03.04.2021 05:06"; got != want { + t.Errorf("serverDate(%s) = %q, want %q", at, got, want) + } +} diff --git a/internal/modules/forumstart.go b/internal/modules/forumstart.go new file mode 100644 index 00000000..a19fb44a --- /dev/null +++ b/internal/modules/forumstart.go @@ -0,0 +1,283 @@ +package modules + +import ( + "errors" + "net/http" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/pynum" +) + +func init() { module.Register("forumstart", renderForumStart) } + +type forumStartCategory struct { + name string + description string + url string + threads int + posts int + lastPostURL string + lastPostBy string + lastPostAt string +} + +type forumStartSection struct { + name string + description string + url string + categories []forumStartCategory +} + +func renderForumStart(env module.Env, _ map[string]string, _ string) (string, error) { + if env.Data == nil { + return "", forumStartFailed(env) + } + setTitle(env, env.Text("module-forumstart-title")) + + var path page.PathParams + if env.Page != nil { + path = env.Page.PathParams + } + hidden := "hide" + if param, ok := path.Lookup("hidden"); ok { + hidden = param.Value + } + + rows, only, err := forumStartSections(env, path) + if err != nil { + return "", err + } + + hideURL, showURL := "/forum/start", "/forum/start/hidden/show" + if only != nil { + hideURL = forumSectionURL(only.ID, only.Name) + showURL = "/forum/s-" + strconv.FormatInt(only.ID, 10) + "/hidden/show" + } + + // Python's loop variable overwrites the section the URL named, so the + // breadcrumbs turn up on any listing that has a section in it at all. + var crumb *db.ForumSection + if len(rows) != 0 { + crumb = &rows[0] + } + + sections, err := forumStartItems(env, rows) + if err != nil { + return "", err + } + return forumStartHTML(env, sections, crumb, hidden, hideURL, showURL), nil +} + +// The hidden filter belongs to the listing alone, so a link to a hidden section +// still opens it. +func forumStartSections(env module.Env, path page.PathParams) ([]db.ForumSection, *db.ForumSection, error) { + param, ok := path.Lookup("s") + if !ok { + all, err := env.Data.ForumSections() + if err != nil { + return nil, nil, err + } + hidden := path.Get("hidden") == "show" + var rows []db.ForumSection + for _, section := range all { + if hidden || !section.IsHidden { + rows = append(rows, section) + } + } + return rows, nil, nil + } + + id, err := pynum.Int(param.Value) + if err != nil { + return nil, nil, forumStartFailed(env) + } + section, err := env.Data.ForumSection(int64(id)) + if errors.Is(err, db.ErrNotFound) { + if env.Page != nil { + env.Page.Status = http.StatusNotFound + } + return nil, nil, &module.Error{Message: env.Text("module-forumstart-no-section", "name", param.Value)} + } + if err != nil { + return nil, nil, err + } + setTitle(env, env.Text("module-forumstart-section-title", "name", section.Name)) + return []db.ForumSection{*section}, section, nil +} + +func forumStartItems(env module.Env, rows []db.ForumSection) ([]forumStartSection, error) { + categories, err := env.Data.ForumCategories() + if err != nil { + return nil, err + } + subject, err := env.Data.Subject(env.User) + if err != nil { + return nil, err + } + // Django asks this once per category, but a forum category carries no + // overrides of its own, so the answer cannot differ between them. + viewCategories := perms.Resolve(subject, nil).Has(perms.ViewForumCategories) + + var out []forumStartSection + for i := range rows { + object := env.Data.ForumSectionObject(&rows[i]) + if !perms.Resolve(subject, object).Has(perms.ViewForumSections) { + continue + } + item := forumStartSection{ + name: rows[i].Name, + description: rows[i].Description, + url: forumSectionURL(rows[i].ID, rows[i].Name), + } + if viewCategories { + for _, category := range categories { + if category.SectionID != rows[i].ID { + continue + } + row, err := forumStartRow(env, category) + if err != nil { + return nil, err + } + item.categories = append(item.categories, row) + } + } + if len(item.categories) != 0 { + out = append(out, item) + } + } + return out, nil +} + +func forumStartRow(env module.Env, category db.ForumCategory) (forumStartCategory, error) { + row := forumStartCategory{ + name: category.Name, + description: category.Description, + url: forumCategoryURL(category.ID, category.Name), + } + + counts, err := env.Data.ForumCategoryCounts(category.ID) + last, lastErr := env.Data.ForumCategoryLastPost(category.ID) + if category.IsForComments { + counts, err = env.Data.ForumCommentCounts() + last, lastErr = env.Data.ForumCommentLastPost() + } + if err != nil { + return row, err + } + row.threads, row.posts = counts.Threads, counts.Posts + + if errors.Is(lastErr, db.ErrNotFound) { + return row, nil + } + if lastErr != nil { + return row, lastErr + } + + name := last.ThreadName + // An imported thread can carry both a category and an article, and Django + // reads the category first. + if last.ThreadCategoryID == nil && last.ThreadArticleID != nil { + article, err := env.Data.ArticleByID(*last.ThreadArticleID) + if err != nil { + return row, err + } + name = article.DisplayName() + } + row.lastPostURL = forumPostURL(last.ThreadID, name, last.ID) + row.lastPostAt = renderDate(env, last.CreatedAt) + row.lastPostBy, err = env.Data.RenderUserByID(last.AuthorID) + if err != nil { + return row, err + } + return row, nil +} + +func forumStartHTML(env module.Env, sections []forumStartSection, crumb *db.ForumSection, hidden, hideURL, showURL string) string { + var b strings.Builder + b.WriteString(`
` + "\n" + ind12) + if crumb != nil { + b.WriteString("\n" + ind16 + `
` + + "\n" + ind20 + `` + env.Text("module-forum-breadcrumb") + `` + + "\n" + ind20 + `»` + + "\n" + ind20 + escape.HTML(crumb.Name) + + "\n" + ind16 + `
` + + "\n" + ind12) + } + b.WriteString("\n" + ind12) + + for _, section := range sections { + b.WriteString("\n" + ind16 + `
` + + "\n" + ind20 + `
` + + "\n" + ind24 + `
` + + escape.HTML(section.name) + `
` + + "\n" + ind24 + `
` + escape.HTML(section.description) + `
` + + "\n" + ind20 + `
` + + "\n" + ind20 + `
` + + "\n" + ind24 + `` + + "\n" + ind24 + `` + + "\n" + ind24 + `` + + "\n" + ind28 + `` + + "\n" + ind28 + `` + + "\n" + ind28 + `` + + "\n" + ind28 + `` + + "\n" + ind24 + `` + + "\n" + ind24) + for _, category := range section.categories { + b.WriteString("\n" + ind28 + `` + + "\n" + ind32 + `` + + "\n" + ind32 + `` + + "\n" + ind32 + `` + + "\n" + ind32 + `` + + "\n" + ind28 + `` + + "\n" + ind24) + } + b.WriteString("\n" + ind24 + `` + + "\n" + ind24 + `
` + env.Text("module-forumstart-section") + `` + env.Text("module-forumstart-threads") + `` + env.Text("module-forumstart-posts") + `` + env.Text("module-forumstart-last-post") + `
` + + "\n" + ind36 + `
` + + escape.HTML(category.name) + `
` + + "\n" + ind36 + `
` + escape.HTML(category.description) + `
` + + "\n" + ind32 + `		` + strconv.Itoa(category.threads) + `` + strconv.Itoa(category.posts) + `` + + "\n" + ind36) + if category.lastPostURL != "" { + b.WriteString("\n" + ind40 + env.Text("module-forum-author") + category.lastPostBy + + "\n" + ind40 + `
` + + "\n" + ind40 + category.lastPostAt + + "\n" + ind40 + `
` + + "\n" + ind40 + `` + + env.Text("module-forum-view-post") + `` + + "\n" + ind36) + } + b.WriteString("\n" + ind32 + `
` + + "\n" + ind20 + `
` + + "\n" + ind16 + `
` + + "\n" + ind12) + } + + b.WriteString("\n" + ind8 + `
` + + "\n" + ind8 + `

` + + "\n" + ind12) + url, label := showURL, "module-forumstart-show-hidden" + if hidden == "show" { + url, label = hideURL, "module-forumstart-hide-hidden" + } + b.WriteString("\n" + ind16 + `` + env.Text(label) + `` + + "\n" + ind12) + b.WriteString("\n" + ind8 + `

`) + return b.String() +} + +func forumStartFailed(env module.Env) error { + return &module.Error{Message: env.Text("module-failed", "name", env.Name)} +} + +func setTitle(env module.Env, title string) { + if env.Page != nil { + env.Page.Title = title + } +} diff --git a/internal/modules/listpages_test.go b/internal/modules/listpages_test.go index ba1f02e9..367367a6 100644 --- a/internal/modules/listpages_test.go +++ b/internal/modules/listpages_test.go @@ -11,6 +11,7 @@ import ( ) type listData struct { + module.Data listed []db.Article total int filter db.ListFilter diff --git a/internal/modules/rate.go b/internal/modules/rate.go index c29a2cb0..7c9bd0af 100644 --- a/internal/modules/rate.go +++ b/internal/modules/rate.go @@ -21,7 +21,7 @@ const ( func renderRate(env module.Env, _ map[string]string, _ string) (string, error) { if env.Data == nil { - return "", &module.Error{Message: env.Text("module-failed", "name", "rate")} + return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} } var article *db.Article if env.Page != nil { diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 761d36eb..fe26f94d 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -5,6 +5,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/printuser" ) type moduleData struct{ repo *Repository } @@ -89,3 +90,56 @@ func (m moduleData) ListArticles(f db.ListFilter, offset int, limit *int) ([]db. func (m moduleData) CountArticles(f db.ListFilter, offset int, limit *int) (int, error) { return m.repo.db.CountArticles(m.repo.ctx, f, offset, limit) } + +func (m moduleData) ArticleByID(id int64) (*db.Article, error) { + return m.repo.db.ArticleByID(m.repo.ctx, id) +} + +// A post with no author is one the site itself made, which is what the system +// chip stands for. +func (m moduleData) RenderUserByID(id *int64) (string, error) { + if id == nil { + return m.repo.users.System(printuser.Options{Hover: true}), nil + } + user, err := m.repo.db.UserByID(m.repo.ctx, *id) + if err != nil { + return "", err + } + return m.repo.renderUser(user, printuser.Options{Avatar: true, Hover: true}) +} + +func (m moduleData) ForumSections() ([]db.ForumSection, error) { + return m.repo.db.ForumSections(m.repo.ctx) +} + +func (m moduleData) ForumSection(id int64) (*db.ForumSection, error) { + return m.repo.db.ForumSection(m.repo.ctx, id) +} + +func (m moduleData) ForumCategories() ([]db.ForumCategory, error) { + return m.repo.db.ForumCategories(m.repo.ctx) +} + +func (m moduleData) ForumCategoryCounts(categoryID int64) (db.ForumCounts, error) { + return m.repo.db.ForumCategoryCounts(m.repo.ctx, categoryID) +} + +func (m moduleData) ForumCommentCounts() (db.ForumCounts, error) { + return m.repo.db.ForumCommentCounts(m.repo.ctx) +} + +func (m moduleData) ForumCategoryLastPost(categoryID int64) (*db.ForumLastPost, error) { + return m.repo.db.ForumCategoryLastPost(m.repo.ctx, categoryID) +} + +func (m moduleData) ForumCommentLastPost() (*db.ForumLastPost, error) { + return m.repo.db.ForumCommentLastPost(m.repo.ctx) +} + +func (m moduleData) Subject(user *db.User) (perms.Subject, error) { + return NewPerms(m.repo.ctx, m.repo.db).Subject(user, time.Now()) +} + +func (m moduleData) ForumSectionObject(s *db.ForumSection) *perms.Object { + return NewPerms(m.repo.ctx, m.repo.db).ForumSection(s) +} diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 941ab964..92eb11f4 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -132,6 +132,10 @@ func (r *Repository) RenderUser(username string, avatar bool) (string, error) { return "", err } + return r.renderUser(user, opts) +} + +func (r *Repository) renderUser(user *db.User, opts printuser.Options) (string, error) { roleList, err := r.db.RolesByUser(r.ctx, user.ID) if err != nil { return "", err From 4599dfcab6f5be5337ab7a890a132754658cdd52 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 15:13:58 +0900 Subject: [PATCH 079/428] check the forum listing against django --- internal/page/testdata/oracle_seed.py | 7 + internal/repo/forumstart_test.go | 150 +++ internal/repo/repo_test.go | 16 +- internal/repo/testdata/forumstart.golden | 1086 +++++++++++++++++ internal/repo/testdata/forumstart_corpus.json | 77 ++ internal/repo/testdata/oracle_forumstart.py | 59 + 6 files changed, 1393 insertions(+), 2 deletions(-) create mode 100644 internal/repo/forumstart_test.go create mode 100644 internal/repo/testdata/forumstart.golden create mode 100644 internal/repo/testdata/forumstart_corpus.json create mode 100644 internal/repo/testdata/oracle_forumstart.py diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index fd421cf8..90c430e2 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -142,6 +142,13 @@ def vote(article, user, rate): api_key='probe-key-wd', ) voter = make_user('probevoter', type=User.UserType.Normal, api_key='probe-key-voter') +make_user( + 'probe-staff', + display_name='Probe Staff', + type=User.UserType.Normal, + api_key='probe-key-staff', + is_superuser=True, +) crowd = [ make_user('probecrowd%d' % i, type=User.UserType.Normal, api_key='probe-key-crowd%d' % i) for i in range(8) diff --git a/internal/repo/forumstart_test.go b/internal/repo/forumstart_test.go new file mode 100644 index 00000000..0dfb354c --- /dev/null +++ b/internal/repo/forumstart_test.go @@ -0,0 +1,150 @@ +package repo + +import ( + "context" + "encoding/json" + "errors" + "flag" + "fmt" + "os" + "path/filepath" + "sort" + "strconv" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +var update = flag.Bool("update", false, "rewrite the golden file and the corpus the oracle reads") + +const ( + forumStartGolden = "testdata/forumstart.golden" + forumStartCorpus = "testdata/forumstart_corpus.json" +) + +type forumStartCase struct { + Name string `json:"name"` + Viewer string `json:"viewer"` + Section string `json:"section,omitempty"` + Path map[string]string `json:"path,omitempty"` +} + +func forumStartCases() []forumStartCase { + return []forumStartCase{ + {Name: "anonymous", Viewer: ""}, + {Name: "anonymous-hidden-shown", Viewer: "", Path: map[string]string{"hidden": "show"}}, + {Name: "anonymous-hidden-junk", Viewer: "", Path: map[string]string{"hidden": "maybe"}}, + {Name: "anonymous-open-section", Viewer: "", Section: "Probe Open"}, + {Name: "anonymous-hidden-section", Viewer: "", Section: "Probe Hidden"}, + {Name: "anonymous-staff-section", Viewer: "", Section: "Probe Staff"}, + {Name: "anonymous-section-and-hidden", Viewer: "", Section: "Probe Open", Path: map[string]string{"hidden": "show"}}, + {Name: "anonymous-missing-section", Viewer: "", Path: map[string]string{"s": "999999"}}, + {Name: "anonymous-unparsable-section", Viewer: "", Path: map[string]string{"s": "not-a-number"}}, + {Name: "registered", Viewer: "probe-author"}, + {Name: "superuser", Viewer: "probe-staff"}, + {Name: "superuser-hidden-shown", Viewer: "probe-staff", Path: map[string]string{"hidden": "show"}}, + {Name: "superuser-staff-section", Viewer: "probe-staff", Section: "Probe Staff"}, + } +} + +func TestForumStartMatchesGolden(t *testing.T) { + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := forumStartCases() + + article, err := d.ArticleByName(ctx, "forum:start") + if err != nil { + t.Fatalf("ArticleByName(forum:start) err = %v, want nil", err) + } + sections, err := d.ForumSections(ctx) + if err != nil { + t.Fatalf("ForumSections() err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + var viewer *db.User + if c.Viewer != "" { + viewer, err = d.UserByUsername(ctx, c.Viewer) + if err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + } + + path := forumStartPath(t, c, sections) + pc := page.NewContext(article, article, path, viewer) + r := New(ctx, d, users, Options{Loc: loc, User: viewer}) + + body, err := r.RenderModule(pc, "ForumStart", nil, "") + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\ntitle: %s\nstatus: %d\n%s\n", c.Name, pc.Title, pc.Status, body) + } + compareForumStartGolden(t, b.String(), cases) +} + +func forumStartPath(t *testing.T, c forumStartCase, sections []db.ForumSection) page.PathParams { + t.Helper() + var path page.PathParams + keys := make([]string, 0, len(c.Path)) + for key := range c.Path { + keys = append(keys, key) + } + sort.Strings(keys) + for _, key := range keys { + path = path.Put(page.PathParam{Key: key, Value: c.Path[key]}) + } + if c.Section == "" { + return path + } + for _, section := range sections { + if section.Name == c.Section { + return path.Put(page.PathParam{Key: "s", Value: strconv.FormatInt(section.ID, 10)}) + } + } + t.Fatalf("ForumSections() has no section named %q, want one seeded", c.Section) + return nil +} + +func compareForumStartGolden(t *testing.T, got string, corpus any) { + t.Helper() + if *update { + data, err := json.MarshalIndent(corpus, "", " ") + if err != nil { + t.Fatalf("Marshal(%s) err = %v, want nil", forumStartCorpus, err) + } + if err := os.WriteFile(filepath.FromSlash(forumStartCorpus), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", forumStartCorpus, err) + } + if err := os.WriteFile(filepath.FromSlash(forumStartGolden), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", forumStartGolden, err) + } + return + } + want, err := os.ReadFile(filepath.FromSlash(forumStartGolden)) + if err != nil { + t.Fatalf("ReadFile(%s) err = %v, want nil", forumStartGolden, err) + } + if got != string(want) { + gotAt, wantAt := firstForumStartDiff(got, string(want)) + t.Errorf("RenderModule(ForumStart) = %q, want %q", gotAt, wantAt) + } +} + +func firstForumStartDiff(got, want string) (string, string) { + at := 0 + for at < len(got) && at < len(want) && got[at] == want[at] { + at++ + } + cut := func(s string) string { return s[max(0, at-40):min(len(s), at+40)] } + return cut(got), cut(want) +} diff --git a/internal/repo/repo_test.go b/internal/repo/repo_test.go index 80db4965..bbf8d1ff 100644 --- a/internal/repo/repo_test.go +++ b/internal/repo/repo_test.go @@ -15,7 +15,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/renderer/sidecar" ) -func newTestRepo(t *testing.T) *Repository { +func testDB(t *testing.T) *db.DB { t.Helper() dsn := os.Getenv(db.EnvDSN) if dsn == "" { @@ -26,11 +26,23 @@ func newTestRepo(t *testing.T) *Repository { t.Fatalf("db.Open() err = %v, want nil", err) } t.Cleanup(d.Close) + return d +} + +func testUsers(t *testing.T) (*printuser.Renderer, *i18n.Localizer) { + t.Helper() bundle, err := i18n.Load("") if err != nil { t.Fatalf("i18n.Load() err = %v, want nil", err) } - users := printuser.New(bundle.Localizer(i18n.DefaultLanguage), nil) + loc := bundle.Localizer(i18n.DefaultLanguage) + return printuser.New(loc, nil), loc +} + +func newTestRepo(t *testing.T) *Repository { + t.Helper() + d := testDB(t) + users, _ := testUsers(t) return New(context.Background(), d, users, Options{}) } diff --git a/internal/repo/testdata/forumstart.golden b/internal/repo/testdata/forumstart.golden new file mode 100644 index 00000000..b04396a6 --- /dev/null +++ b/internal/repo/testdata/forumstart.golden @@ -0,0 +1,1086 @@ +=== anonymous +title: 论坛版块 +status: 200 +
+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		24 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		392 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 08.26.2026 13:01 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
+
+ +
+

+ + 显示隐藏版块 + +

+=== anonymous-hidden-shown +title: 论坛版块 +status: 200 +
+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		24 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		392 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 08.26.2026 13:01 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
+
+ +
+
+
Probe Hidden
+
hidden from the listing
+
+
+ + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Hidden Chat
+
inside the hidden section
+ 		00 + +
+
+
+ +
+

+ + 隐藏隐藏版块 + +

+=== anonymous-hidden-junk +title: 论坛版块 +status: 200 +
+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		24 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		392 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 08.26.2026 13:01 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
+
+ +
+

+ + 显示隐藏版块 + +

+=== anonymous-open-section +title: 论坛 — Probe Open +status: 200 +
+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		24 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		392 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 08.26.2026 13:01 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
+
+ +
+

+ + 显示隐藏版块 + +

+=== anonymous-hidden-section +title: 论坛 — Probe Hidden +status: 200 +
+ +
+ 论坛 + » + Probe Hidden +
+ + +
+
+
Probe Hidden
+
hidden from the listing
+
+
+ + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Hidden Chat
+
inside the hidden section
+ 		00 + +
+
+
+ +
+

+ + 显示隐藏版块 + +

+=== anonymous-staff-section +title: 论坛 — Probe Staff +status: 200 +
+ +
+ 论坛 + » + Probe Staff +
+ + +
+

+ + 显示隐藏版块 + +

+=== anonymous-section-and-hidden +title: 论坛 — Probe Open +status: 200 +
+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		24 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		392 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 08.26.2026 13:01 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
+
+ +
+

+ + 隐藏隐藏版块 + +

+=== anonymous-missing-section +title: 论坛版块 +status: 404 +!error: 未找到版块 "999999" +=== anonymous-unparsable-section +title: 论坛版块 +status: 200 +!error: 处理模块 'ForumStart' 时出错 +=== registered +title: 论坛版块 +status: 200 +
+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		24 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		392 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 08.26.2026 13:01 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
+
+ +
+

+ + 显示隐藏版块 + +

+=== superuser +title: 论坛版块 +status: 200 +
+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		24 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		392 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 08.26.2026 13:01 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
+
+ +
+
+
Probe Staff
+
only staff may browse
+
+
+ + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Staff Chat
+
inside the staff section
+ 		00 + +
+
+
+ +
+

+ + 显示隐藏版块 + +

+=== superuser-hidden-shown +title: 论坛版块 +status: 200 +
+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		24 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		392 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 08.26.2026 13:01 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
+
+ +
+
+
Probe Hidden
+
hidden from the listing
+
+
+ + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Hidden Chat
+
inside the hidden section
+ 		00 + +
+
+
+ +
+
+
Probe Staff
+
only staff may browse
+
+
+ + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Staff Chat
+
inside the staff section
+ 		00 + +
+
+
+ +
+

+ + 隐藏隐藏版块 + +

+=== superuser-staff-section +title: 论坛 — Probe Staff +status: 200 +
+ +
+ 论坛 + » + Probe Staff +
+ + +
+
+
Probe Staff
+
only staff may browse
+
+
+ + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Staff Chat
+
inside the staff section
+ 		00 + +
+
+
+ +
+

+ + 显示隐藏版块 + +

diff --git a/internal/repo/testdata/forumstart_corpus.json b/internal/repo/testdata/forumstart_corpus.json new file mode 100644 index 00000000..6c3b6faf --- /dev/null +++ b/internal/repo/testdata/forumstart_corpus.json @@ -0,0 +1,77 @@ +[ + { + "name": "anonymous", + "viewer": "" + }, + { + "name": "anonymous-hidden-shown", + "viewer": "", + "path": { + "hidden": "show" + } + }, + { + "name": "anonymous-hidden-junk", + "viewer": "", + "path": { + "hidden": "maybe" + } + }, + { + "name": "anonymous-open-section", + "viewer": "", + "section": "Probe Open" + }, + { + "name": "anonymous-hidden-section", + "viewer": "", + "section": "Probe Hidden" + }, + { + "name": "anonymous-staff-section", + "viewer": "", + "section": "Probe Staff" + }, + { + "name": "anonymous-section-and-hidden", + "viewer": "", + "section": "Probe Open", + "path": { + "hidden": "show" + } + }, + { + "name": "anonymous-missing-section", + "viewer": "", + "path": { + "s": "999999" + } + }, + { + "name": "anonymous-unparsable-section", + "viewer": "", + "path": { + "s": "not-a-number" + } + }, + { + "name": "registered", + "viewer": "probe-author" + }, + { + "name": "superuser", + "viewer": "probe-staff" + }, + { + "name": "superuser-hidden-shown", + "viewer": "probe-staff", + "path": { + "hidden": "show" + } + }, + { + "name": "superuser-staff-section", + "viewer": "probe-staff", + "section": "Probe Staff" + } +] diff --git a/internal/repo/testdata/oracle_forumstart.py b/internal/repo/testdata/oracle_forumstart.py new file mode 100644 index 00000000..427ff724 --- /dev/null +++ b/internal/repo/testdata/oracle_forumstart.py @@ -0,0 +1,59 @@ +"""Records what the ForumStart module renders for a reader browsing the forum. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e FORUMSTART_CORPUS="$(cat internal/repo/testdata/forumstart_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_forumstart.py + +Section ids are looked up by name so the corpus does not depend on what the +sequence handed out. Compare the output with internal/repo/testdata/forumstart.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.forum import ForumSection +from web.models.site import Site +from web.models.users import User + +CORPUS = json.loads(os.environ['FORUMSTART_CORPUS']) + + +def path_params(case): + params = dict(case.get('path') or {}) + if case.get('section'): + params['s'] = str(ForumSection.objects.get(name=case['section']).id) + return params + + +def main(): + article = articles.get_article('forum:start') + if article is None: + raise SystemExit('forum:start is missing; run manage.py seed first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + if case['viewer']: + viewer = User.objects.get(username=case['viewer']) + threadvars.put('current_user', viewer) + context = RenderContext(article, article, path_params(case), viewer) + try: + body = modules.render_module('ForumStart', context, {}) + except ModuleError as error: + body = '!error: %s' % error.message + out.append('=== %s\ntitle: %s\nstatus: %d\n%s\n' % ( + case['name'], context.title, context.status, body)) + sys.stdout.write(''.join(out)) + + +main() From 45c25e1523f0dc564b8db5a93243ec08eb79caaf Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 15:14:02 +0900 Subject: [PATCH 080/428] run the forum listing in the page corpus --- internal/difftest/corpus/articles.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 83a83934..2af26a84 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -51,7 +51,9 @@ OPTIONS /probe:full /probe:listbyvotes /probe:listed/p/2/tag/euclid -!/forum:start +/forum:start +/forum/start/hidden/show +/forum/start/s/999999 !/forum:recent-posts !/forum:category !/forum:thread From 3d8c3d6b1d1bff545b3f5434ae935f510afe9706 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 18:19:37 +0900 Subject: [PATCH 081/428] check csrf before the module api runs --- modules/__init__.py | 10 ++++++++++ web/views/api/module.py | 4 ++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/modules/__init__.py b/modules/__init__.py index 894dcef2..64b82188 100644 --- a/modules/__init__.py +++ b/modules/__init__.py @@ -71,6 +71,16 @@ def module_allows_api(name_or_module): return m.__dict__['allow_api']() +def module_api_is_csrf_safe(name_or_module, method): + m = get_module(name_or_module) + if m is None or not module_allows_api(m): + return False + api_method = m.__dict__.get('api_%s' % method, None) + if not callable(api_method): + return False + return getattr(api_method, 'is_csrf_safe', False) + + @transaction.atomic def render_module(name, context, params, content=None): if context and context.path_params.get('nomodule', 'false') == 'true': diff --git a/web/views/api/module.py b/web/views/api/module.py index e312eab5..23c06a5a 100644 --- a/web/views/api/module.py +++ b/web/views/api/module.py @@ -34,11 +34,11 @@ def post(self, request: HttpRequest, *args, **kwargs) -> HttpResponse: result = modules.render_module(module, context, params, content=content) return self.render_json(200, {'result': result}) else: - response, is_csrf_safe = modules.handle_api(module, method, context, params) - if not is_csrf_safe: + if not modules.module_api_is_csrf_safe(module, method): reason = CsrfViewMiddleware([]).process_view(request, None, (), {}) if reason: return reason + response, _ = modules.handle_api(module, method, context, params) return self.render_json(200, response) except modules.ModuleError as e: raise APIError(e.message) From f5370cc8bcff58d332df7ce5c99a95001f879ac5 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 18:19:43 +0900 Subject: [PATCH 082/428] let the forwarder drop the origin port --- cmd/pwikit/main.go | 2 + internal/forward/forward.go | 23 +++++++-- internal/forward/forward_test.go | 87 ++++++++++++++++++++++++++++++++ 3 files changed, 109 insertions(+), 3 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 0500d3e5..efbc0137 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -90,6 +90,7 @@ func serve(args []string) error { secret := fs.String("secret-key", os.Getenv(envSecretKey), "key the session cookie is signed with; without it every visitor is anonymous") sidecar := fs.String("sidecar", os.Getenv(envSidecar), "path to the ftml sidecar binary; without it the linked-in ftml is used") timezone := fs.String("timezone", envOr(envTimeZone, "UTC"), "time zone dates are shown in") + bareOrigin := fs.Bool("bare-origin", false, "drop the port from the Origin header before forwarding") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -116,6 +117,7 @@ func serve(args []string) error { if err != nil { return err } + proxy.BareOrigin = *bareOrigin assets, err := assetFS(*staticDir) if err != nil { return err diff --git a/internal/forward/forward.go b/internal/forward/forward.go index b729996e..e20e8ee3 100644 --- a/internal/forward/forward.go +++ b/internal/forward/forward.go @@ -13,9 +13,10 @@ import ( ) const ( - headerFor = "X-Forwarded-For" - headerHost = "X-Forwarded-Host" - headerProto = "X-Forwarded-Proto" + headerFor = "X-Forwarded-For" + headerHost = "X-Forwarded-Host" + headerProto = "X-Forwarded-Proto" + headerOrigin = "Origin" ) type Proxy struct { @@ -23,6 +24,8 @@ type Proxy struct { trust *proxyheader.Trust rp *httputil.ReverseProxy log *slog.Logger + + BareOrigin bool } var _ http.Handler = (*Proxy)(nil) @@ -72,10 +75,24 @@ func (p *Proxy) rewrite(pr *httputil.ProxyRequest) { pr.Out.Header.Set(headerHost, pr.In.Host) pr.Out.Header.Set(headerProto, scheme) + if p.BareOrigin { + if origin := bareOrigin(pr.In.Header.Get(headerOrigin)); origin != "" { + pr.Out.Header.Set(headerOrigin, origin) + } + } + pr.SetURL(p.target) pr.Out.Host = pr.In.Host } +func bareOrigin(origin string) string { + u, err := url.Parse(origin) + if err != nil || u.Scheme == "" || u.Hostname() == "" { + return "" + } + return u.Scheme + "://" + u.Hostname() +} + func (p *Proxy) handleError(w http.ResponseWriter, r *http.Request, err error) { if errors.Is(err, context.Canceled) { return diff --git a/internal/forward/forward_test.go b/internal/forward/forward_test.go index 8f2f3d57..8948ff97 100644 --- a/internal/forward/forward_test.go +++ b/internal/forward/forward_test.go @@ -225,3 +225,90 @@ func TestProxySetsForwardedHostToInboundHost(t *testing.T) { t.Errorf("upstream got X-Forwarded-Host = %q, want %q", got, "media.example") } } + +func TestProxyKeepsOriginByDefault(t *testing.T) { + var got string + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + got = r.Header.Get("Origin") + })) + defer up.Close() + + front := httptest.NewServer(newProxy(t, up)) + defer front.Close() + + req, _ := http.NewRequest(http.MethodPost, front.URL+"/api/modules", nil) + req.Header.Set("Origin", "http://localhost:8080") + resp, err := front.Client().Do(req) + if err != nil { + t.Fatalf("Do() err = %v, want nil", err) + } + resp.Body.Close() + + if got != "http://localhost:8080" { + t.Errorf("upstream got Origin = %q, want %q", got, "http://localhost:8080") + } +} + +func TestProxyDropsOriginPortWhenAsked(t *testing.T) { + var got string + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + got = r.Header.Get("Origin") + })) + defer up.Close() + + proxy := newProxy(t, up) + proxy.BareOrigin = true + front := httptest.NewServer(proxy) + defer front.Close() + + req, _ := http.NewRequest(http.MethodPost, front.URL+"/api/modules", nil) + req.Header.Set("Origin", "http://localhost:8080") + resp, err := front.Client().Do(req) + if err != nil { + t.Fatalf("Do() err = %v, want nil", err) + } + resp.Body.Close() + + if got != "http://localhost" { + t.Errorf("upstream got Origin = %q, want %q", got, "http://localhost") + } +} + +func TestProxyLeavesAMissingOriginAlone(t *testing.T) { + sent := true + up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, sent = r.Header["Origin"] + })) + defer up.Close() + + proxy := newProxy(t, up) + proxy.BareOrigin = true + front := httptest.NewServer(proxy) + defer front.Close() + + resp, err := front.Client().Post(front.URL+"/api/modules", "application/json", nil) + if err != nil { + t.Fatalf("Post() err = %v, want nil", err) + } + resp.Body.Close() + + if sent { + t.Error("upstream got an Origin header, want none") + } +} + +func TestBareOrigin(t *testing.T) { + cases := []struct{ in, want string }{ + {"http://localhost:8080", "http://localhost"}, + {"http://localhost", "http://localhost"}, + {"https://wiki.example:8443", "https://wiki.example"}, + {"null", ""}, + {"", ""}, + {"://broken", ""}, + } + for _, c := range cases { + if got := bareOrigin(c.in); got != c.want { + t.Errorf("bareOrigin(%q) = %q, want %q", c.in, got, c.want) + } + } +} From 8419ec0a99dc0c39ef10e9b2c72a17980623b7c6 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 18:19:48 +0900 Subject: [PATCH 083/428] add the queries a category page needs --- internal/db/forum.go | 139 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 139 insertions(+) diff --git a/internal/db/forum.go b/internal/db/forum.go index e82ae0ce..03b80b0d 100644 --- a/internal/db/forum.go +++ b/internal/db/forum.go @@ -177,3 +177,142 @@ func (d *DB) scanLastPost(ctx context.Context, sql string, args ...any) (*ForumL } return &p, nil } + +type ForumThread struct { + ID int64 + Name string + Description string + CategoryID *int64 + ArticleID *int64 + AuthorID *int64 + IsPinned bool + CreatedAt time.Time +} + +type ForumThreadSort int + +const ( + ForumThreadsByReply ForumThreadSort = iota + ForumThreadsByStart +) + +const forumThreadColumns = `id, name, description, category_id, article_id, author_id, is_pinned, created_at` + +var qForumThreadsByReply = register("ForumThreadsByReply", ` +SELECT `+forumThreadColumns+` +FROM web_forumthread +WHERE category_id = $1 +ORDER BY is_pinned DESC, updated_at DESC +OFFSET $2 LIMIT $3`) + +var qForumThreadsByStart = register("ForumThreadsByStart", ` +SELECT `+forumThreadColumns+` +FROM web_forumthread +WHERE category_id = $1 +ORDER BY is_pinned DESC, created_at DESC +OFFSET $2 LIMIT $3`) + +var qForumCommentThreadsByReply = register("ForumCommentThreadsByReply", ` +SELECT `+forumThreadColumns+` +FROM web_forumthread +WHERE article_id IS NOT NULL +ORDER BY is_pinned DESC, updated_at DESC +OFFSET $1 LIMIT $2`) + +var qForumCommentThreadsByStart = register("ForumCommentThreadsByStart", ` +SELECT `+forumThreadColumns+` +FROM web_forumthread +WHERE article_id IS NOT NULL +ORDER BY is_pinned DESC, created_at DESC +OFFSET $1 LIMIT $2`) + +func (d *DB) ForumThreads(ctx context.Context, categoryID int64, sort ForumThreadSort, offset, limit int) ([]ForumThread, error) { + sql, args := qForumThreadsByReply, []any{categoryID, offset, limit} + if sort == ForumThreadsByStart { + sql = qForumThreadsByStart + } + return d.scanThreads(ctx, sql, args...) +} + +func (d *DB) ForumCommentThreads(ctx context.Context, sort ForumThreadSort, offset, limit int) ([]ForumThread, error) { + sql := qForumCommentThreadsByReply + if sort == ForumThreadsByStart { + sql = qForumCommentThreadsByStart + } + return d.scanThreads(ctx, sql, offset, limit) +} + +func (d *DB) scanThreads(ctx context.Context, sql string, args ...any) ([]ForumThread, error) { + rows, err := d.pool.Query(ctx, sql, args...) + if err != nil { + return nil, fmt.Errorf("query forum threads: %w", err) + } + defer rows.Close() + + var out []ForumThread + for rows.Next() { + var t ForumThread + if err := rows.Scan(&t.ID, &t.Name, &t.Description, &t.CategoryID, &t.ArticleID, + &t.AuthorID, &t.IsPinned, &t.CreatedAt); err != nil { + return nil, fmt.Errorf("scan forum thread: %w", err) + } + out = append(out, t) + } + return out, rows.Err() +} + +var qForumThreadPostCount = register("ForumThreadPostCount", ` +SELECT count(*) FROM web_forumpost WHERE thread_id = $1`) + +func (d *DB) ForumThreadPostCount(ctx context.Context, threadID int64) (int, error) { + var n int + if err := d.pool.QueryRow(ctx, qForumThreadPostCount, threadID).Scan(&n); err != nil { + return 0, fmt.Errorf("count posts in thread %d: %w", threadID, err) + } + return n, nil +} + +// Django indexes to the end of an ascending list rather than taking the first +// of a descending one, which decides differently when two posts share a stamp. +var qForumThreadLastPost = register("ForumThreadLastPost", ` +SELECT id, created_at, author_id +FROM web_forumpost +WHERE thread_id = $1 +ORDER BY created_at +OFFSET $2 LIMIT 1`) + +type ForumPost struct { + ID int64 + CreatedAt time.Time + AuthorID *int64 +} + +func (d *DB) ForumThreadLastPost(ctx context.Context, threadID int64, count int) (*ForumPost, error) { + var p ForumPost + err := d.pool.QueryRow(ctx, qForumThreadLastPost, threadID, count-1).Scan(&p.ID, &p.CreatedAt, &p.AuthorID) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("query last post in thread %d: %w", threadID, err) + } + return &p, nil +} + +var qForumCategory = register("ForumCategory", ` +SELECT id, section_id, name, description, is_for_comments +FROM web_forumcategory +WHERE id = $1`) + +func (d *DB) ForumCategory(ctx context.Context, id int64) (*ForumCategory, error) { + var c ForumCategory + err := d.pool.QueryRow(ctx, qForumCategory, id).Scan( + &c.ID, &c.SectionID, &c.Name, &c.Description, &c.IsForComments) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("query forum category %d: %w", id, err) + } + return &c, nil +} From 4ff6f556b92d507c6b4758baa468fea21444cf8d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 18:19:54 +0900 Subject: [PATCH 084/428] give the seeded threads distinct stamps and enough of them to page --- internal/db/forum_test.go | 16 ++++++++-------- internal/page/testdata/oracle_seed.py | 14 ++++++++++++-- 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/internal/db/forum_test.go b/internal/db/forum_test.go index 4ed75d16..4ea73a62 100644 --- a/internal/db/forum_test.go +++ b/internal/db/forum_test.go @@ -84,7 +84,7 @@ func TestForumCategoriesComeBackInOrder(t *testing.T) { t.Fatalf("ForumCategories() err = %v, want nil", err) } - want := []string{"Probe Chat", "Probe Hidden Chat", "Probe Staff Chat", "Probe Comments", "Probe Quiet"} + want := []string{"Probe Chat", "Probe Hidden Chat", "Probe Staff Chat", "Probe Comments", "Probe Quiet", "Probe Busy"} if len(categories) != len(want) { t.Fatalf("len(ForumCategories()) = %d, want %d", len(categories), len(want)) } @@ -117,11 +117,11 @@ func TestForumCategoryCounts(t *testing.T) { if err != nil { t.Fatalf("ForumCategoryCounts(chat) err = %v, want nil", err) } - if got.Threads != 2 { - t.Errorf("ForumCategoryCounts(chat).Threads = %d, want %d", got.Threads, 2) + if got.Threads != 3 { + t.Errorf("ForumCategoryCounts(chat).Threads = %d, want %d", got.Threads, 3) } - if got.Posts != 4 { - t.Errorf("ForumCategoryCounts(chat).Posts = %d, want %d", got.Posts, 4) + if got.Posts != 6 { + t.Errorf("ForumCategoryCounts(chat).Posts = %d, want %d", got.Posts, 6) } } @@ -144,10 +144,10 @@ func TestForumCategoryLastPost(t *testing.T) { if err != nil { t.Fatalf("ForumCategoryLastPost(chat) err = %v, want nil", err) } - if got.ThreadName != "Probe Locked Thread" { - t.Errorf("ForumCategoryLastPost(chat).ThreadName = %q, want %q", got.ThreadName, "Probe Locked Thread") + if got.ThreadName != "Probe Pinned Thread" { + t.Errorf("ForumCategoryLastPost(chat).ThreadName = %q, want %q", got.ThreadName, "Probe Pinned Thread") } - want := time.Date(2023, 9, 10, 11, 15, 13, 0, time.UTC) + want := time.Date(2023, 9, 10, 11, 17, 13, 0, time.UTC) if !got.CreatedAt.Equal(want) { t.Errorf("ForumCategoryLastPost(chat).CreatedAt = %v, want %v", got.CreatedAt.UTC(), want) } diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index 90c430e2..977632a2 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -30,6 +30,7 @@ UPDATED_AT = datetime.datetime(2022, 7, 8, 9, 10, 11, tzinfo=datetime.timezone.utc) POSTED_AT = datetime.datetime(2023, 9, 10, 11, 12, 13, tzinfo=datetime.timezone.utc) POSTED_MINUTES = itertools.count() +THREAD_MINUTES = itertools.count() def make_user(username, **kwargs): @@ -95,7 +96,7 @@ def forum_category(section, name, order, **kwargs): return category -def forum_thread(category, name, user, posts): +def forum_thread(category, name, user, posts, pinned=False): thread, _ = ForumThread.objects.get_or_create( category=category, name=name, defaults=dict(author=user, description='%s description' % name)) made = [] @@ -105,7 +106,11 @@ def forum_thread(category, name, user, posts): if created: ForumPostVersion.objects.create(post=post, source='%s body %d' % (name, i), author=user) made.append(post) - ForumThread.objects.filter(pk=thread.pk).update(created_at=CREATED_AT, updated_at=UPDATED_AT) + minutes = next(THREAD_MINUTES) + ForumThread.objects.filter(pk=thread.pk).update( + created_at=CREATED_AT + datetime.timedelta(minutes=minutes), + updated_at=UPDATED_AT - datetime.timedelta(minutes=minutes), + is_pinned=pinned) for post in made: at = POSTED_AT + datetime.timedelta(minutes=next(POSTED_MINUTES)) ForumPost.objects.filter(pk=post.pk).update(created_at=at, updated_at=at) @@ -268,6 +273,11 @@ def vote(article, user, rate): forum_thread(chat, 'Probe Thread', author, 3) forum_thread(chat, 'Probe Locked Thread', voter, 1).is_locked = True ForumThread.objects.filter(category=chat, name='Probe Locked Thread').update(is_locked=True) +forum_thread(chat, 'Probe Pinned Thread', voter, 2, pinned=True) + +busy = forum_category(open_section, 'Probe Busy', 3, description='enough threads for a second page') +for index in range(21): + forum_thread(busy, 'Probe Busy %02d' % index, author, 1) thread = comment_thread(full, author, 2) subscribe(author, article=full) From 52d1ee9a22e9bdd5ce3b415f52c51c4cdd52fc58 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 18:20:01 +0900 Subject: [PATCH 085/428] answer the forum category page --- internal/i18n/locales/zh-hans.json | 19 +- internal/module/module.go | 5 + internal/module/render_test.go | 2 +- internal/modules/forum.go | 23 +- internal/modules/forumcategory.go | 333 +++++++++++++++++++++++++++++ internal/modules/forumstart.go | 28 +-- internal/repo/modules.go | 20 ++ 7 files changed, 402 insertions(+), 28 deletions(-) create mode 100644 internal/modules/forumcategory.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index fb8b0610..8032f4fb 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -14,14 +14,25 @@ "module-disabled": "模块处理已禁用", "module-failed": "处理模块 '{name}' 时出错", "module-forum-author": "作者：", - "module-forum-breadcrumb": "论坛", + "module-forum-last-post": "最后回复", + "module-forum-not-found": "未找到版块 \"{name}\"", + "module-forum-title": "论坛", + "module-forum-title-named": "论坛 — {name}", "module-forum-view-post": "查看", + "module-forumcategory-forbidden": "权限不足，无法查看该版块", + "module-forumcategory-new-thread": "创建主题", + "module-forumcategory-pinned": "置顶：", + "module-forumcategory-posts": "帖子数：", + "module-forumcategory-replies": "回复数", + "module-forumcategory-sort": "排序方式：", + "module-forumcategory-sort-reply": "按最后回复时间", + "module-forumcategory-sort-start": "按主题创建时间", + "module-forumcategory-started": "创建信息", + "module-forumcategory-thread": "主题标题", + "module-forumcategory-threads": "主题数：", "module-forumstart-hide-hidden": "隐藏隐藏版块", - "module-forumstart-last-post": "最后回复", - "module-forumstart-no-section": "未找到版块 \"{name}\"", "module-forumstart-posts": "帖子数", "module-forumstart-section": "版块名称", - "module-forumstart-section-title": "论坛 — {name}", "module-forumstart-show-hidden": "显示隐藏版块", "module-forumstart-threads": "主题数", "module-forumstart-title": "论坛版块", diff --git a/internal/module/module.go b/internal/module/module.go index 54974eed..3298235b 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -39,6 +39,11 @@ type Data interface { ForumSections() ([]db.ForumSection, error) ForumSection(id int64) (*db.ForumSection, error) ForumCategories() ([]db.ForumCategory, error) + ForumCategory(id int64) (*db.ForumCategory, error) + ForumThreads(categoryID int64, sort db.ForumThreadSort, offset, limit int) ([]db.ForumThread, error) + ForumCommentThreads(sort db.ForumThreadSort, offset, limit int) ([]db.ForumThread, error) + ForumThreadPostCount(threadID int64) (int, error) + ForumThreadLastPost(threadID int64, count int) (*db.ForumPost, error) ForumCategoryCounts(categoryID int64) (db.ForumCounts, error) ForumCommentCounts() (db.ForumCounts, error) ForumCategoryLastPost(categoryID int64) (*db.ForumLastPost, error) diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 6cd8dda0..a85baff6 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"forumstart", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} + ported := []string{"forumcategory", "forumstart", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/forum.go b/internal/modules/forum.go index 44fa4557..d3f08293 100644 --- a/internal/modules/forum.go +++ b/internal/modules/forum.go @@ -29,9 +29,12 @@ func forumCategoryURL(id int64, name string) string { return "/forum/c-" + strconv.FormatInt(id, 10) + "/" + wikidot.Normalize(name) } +func forumThreadURL(id int64, name string) string { + return "/forum/t-" + strconv.FormatInt(id, 10) + "/" + wikidot.Normalize(name) +} + func forumPostURL(threadID int64, threadName string, postID int64) string { - return "/forum/t-" + strconv.FormatInt(threadID, 10) + "/" + wikidot.Normalize(threadName) + - "#post-" + strconv.FormatInt(postID, 10) + return forumThreadURL(threadID, threadName) + "#post-" + strconv.FormatInt(postID, 10) } func renderDate(env module.Env, at time.Time) string { @@ -58,3 +61,19 @@ func serverDate(env module.Env, at time.Time) string { "hour", pad(at.Hour()), "minute", pad(at.Minute())) } + +func forumFailed(env module.Env) error { + return &module.Error{Message: env.Text("module-failed", "name", env.Name)} +} + +func setTitle(env module.Env, title string) { + if env.Page != nil { + env.Page.Title = title + } +} + +func setStatus(env module.Env, code int) { + if env.Page != nil { + env.Page.Status = code + } +} diff --git a/internal/modules/forumcategory.go b/internal/modules/forumcategory.go new file mode 100644 index 00000000..89377127 --- /dev/null +++ b/internal/modules/forumcategory.go @@ -0,0 +1,333 @@ +package modules + +import ( + "errors" + "net/http" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/pynum" +) + +func init() { module.Register("forumcategory", renderForumCategory) } + +const forumThreadsPerPage = 20 + +type forumCategoryThread struct { + name string + description string + url string + createdBy string + createdAt string + postCount int + isPinned bool + lastPostURL string + lastPostBy string + lastPostAt string +} + +type forumCategoryView struct { + category db.ForumCategory + sectionURL string + sectionName string + rows []forumCategoryThread + counts db.ForumCounts + byStart bool + canCreate bool + pagination string +} + +func renderForumCategory(env module.Env, _ map[string]string, _ string) (string, error) { + if env.Data == nil { + return "", forumFailed(env) + } + setTitle(env, env.Text("module-forum-title")) + + var path page.PathParams + if env.Page != nil { + path = env.Page.PathParams + } + + category, err := forumCategoryOf(env, path) + if err != nil { + return "", err + } + + subject, err := env.Data.Subject(env.User) + if err != nil { + return "", err + } + sitewide := perms.Resolve(subject, nil) + if !sitewide.Has(perms.ViewForumCategories) { + return "", &module.Error{Message: env.Text("module-forumcategory-forbidden")} + } + setTitle(env, env.Text("module-forum-title-named", "name", category.Name)) + + view := forumCategoryView{ + category: *category, + byStart: path.Get("sort") == "start", + canCreate: sitewide.Has(perms.CreateForumThreads), + } + if view.counts, err = env.Data.ForumCategoryCounts(category.ID); err != nil { + return "", err + } + section, err := env.Data.ForumSection(category.SectionID) + if err != nil { + return "", err + } + view.sectionName = section.Name + view.sectionURL = forumSectionURL(section.ID, section.Name) + + if err := forumCategoryThreads(env, &view, path); err != nil { + return "", err + } + return forumCategoryHTML(env, view), nil +} + +// Python rebinds c to the parsed number before the message reads it, so a +// well-formed id is echoed back normalized and a missing one prints as None. +func forumCategoryOf(env module.Env, path page.PathParams) (*db.ForumCategory, error) { + shown := "None" + if param, ok := path.Lookup("c"); ok { + shown = param.Value + } + notFound := func() error { + setStatus(env, http.StatusNotFound) + return &module.Error{Message: env.Text("module-forum-not-found", "name", shown)} + } + + id, err := pynum.Int(shown) + if err != nil { + return nil, notFound() + } + shown = strconv.Itoa(id) + + category, err := env.Data.ForumCategory(int64(id)) + if errors.Is(err, db.ErrNotFound) { + return nil, notFound() + } + if err != nil { + return nil, err + } + return category, nil +} + +func forumCategoryThreads(env module.Env, view *forumCategoryView, path page.PathParams) error { + sort := db.ForumThreadsByReply + if view.byStart { + sort = db.ForumThreadsByStart + } + + total := view.counts.Threads + if view.category.IsForComments { + comments, err := env.Data.ForumCommentCounts() + if err != nil { + return err + } + total = comments.Threads + } + + page := 1 + if n, err := pynum.Int(path.Get("p")); err == nil { + page = n + } + if page < 1 { + page = 1 + } + maxPage := (total + forumThreadsPerPage - 1) / forumThreadsPerPage + if maxPage < 1 { + maxPage = 1 + } + if page > maxPage { + page = maxPage + } + + offset := (page - 1) * forumThreadsPerPage + var ( + threads []db.ForumThread + err error + ) + if view.category.IsForComments { + threads, err = env.Data.ForumCommentThreads(sort, offset, forumThreadsPerPage) + } else { + threads, err = env.Data.ForumThreads(view.category.ID, sort, offset, forumThreadsPerPage) + } + if err != nil { + return err + } + + for _, thread := range threads { + row, err := forumCategoryRow(env, thread) + if err != nil { + return err + } + view.rows = append(view.rows, row) + } + view.pagination = listpages.Pagination(env.Loc, forumCategoryShortURL(view.category.ID), page, maxPage) + return nil +} + +func forumCategoryRow(env module.Env, thread db.ForumThread) (forumCategoryThread, error) { + name := thread.Name + if thread.CategoryID == nil && thread.ArticleID != nil { + article, err := env.Data.ArticleByID(*thread.ArticleID) + if err != nil { + return forumCategoryThread{}, err + } + name = article.DisplayName() + } + + url := forumThreadURL(thread.ID, name) + row := forumCategoryThread{ + name: name, + description: thread.Description, + url: url, + createdAt: renderDate(env, thread.CreatedAt), + isPinned: thread.IsPinned, + } + createdBy, err := env.Data.RenderUserByID(thread.AuthorID) + if err != nil { + return forumCategoryThread{}, err + } + row.createdBy = createdBy + + row.postCount, err = env.Data.ForumThreadPostCount(thread.ID) + if err != nil { + return forumCategoryThread{}, err + } + if row.postCount == 0 { + return row, nil + } + + last, err := env.Data.ForumThreadLastPost(thread.ID, row.postCount) + if err != nil { + return forumCategoryThread{}, err + } + row.lastPostURL = url + "#post-" + strconv.FormatInt(last.ID, 10) + row.lastPostAt = renderDate(env, last.CreatedAt) + row.lastPostBy, err = env.Data.RenderUserByID(last.AuthorID) + if err != nil { + return forumCategoryThread{}, err + } + return row, nil +} + +func forumCategoryHTML(env module.Env, view forumCategoryView) string { + category := view.category + canonical := forumCategoryURL(category.ID, category.Name) + short := forumCategoryShortURL(category.ID) + + var b strings.Builder + b.WriteString(`
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `` + env.Text("module-forum-title") + `` + + "\n" + ind16 + `»` + + "\n" + ind16 + `` + escape.HTML(view.sectionName) + `` + + "\n" + ind16 + `»` + + "\n" + ind16 + escape.HTML(category.Name) + + "\n" + ind12 + `
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `
` + + "\n" + ind20 + env.Text("module-forumcategory-threads") + strconv.Itoa(view.counts.Threads) + + "\n" + ind20 + `
` + + "\n" + ind20 + env.Text("module-forumcategory-posts") + strconv.Itoa(view.counts.Posts) + + "\n" + ind16 + `
` + + "\n" + ind16 + escape.HTML(category.Description) + + "\n" + ind12 + `
` + + "\n" + ind12 + `
` + + "\n" + ind16 + env.Text("module-forumcategory-sort") + + "\n" + ind16 + `
` + + "\n" + ind20) + b.WriteString("\n" + ind24 + + forumSortButton(env, canonical, "module-forumcategory-sort-reply", view.byStart) + + "\n" + ind20) + b.WriteString("\n" + ind20 + `
` + + "\n" + ind20) + b.WriteString("\n" + ind24 + + forumSortButton(env, short+"/sort/start", "module-forumcategory-sort-start", !view.byStart) + + "\n" + ind20) + b.WriteString("\n" + ind16 + `
` + + "\n" + ind12 + `
` + + "\n" + ind12) + + if !category.IsForComments && view.canCreate { + b.WriteString("\n" + ind16 + `
` + + "\n" + ind20 + `` + + env.Text("module-forumcategory-new-thread") + `` + + "\n" + ind16 + `
` + + "\n" + ind12) + } + + b.WriteString("\n" + ind12 + view.pagination + + "\n" + ind12 + `` + + "\n" + ind12 + `` + + "\n" + ind12 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind12 + `` + + "\n" + ind12) + + for _, row := range view.rows { + b.WriteString("\n" + ind16 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind16 + `` + + "\n" + ind12) + } + + b.WriteString("\n" + ind12 + `` + + "\n" + ind12 + `
` + env.Text("module-forumcategory-thread") + `` + env.Text("module-forumcategory-started") + `` + env.Text("module-forumcategory-replies") + `` + env.Text("module-forum-last-post") + `
` + + "\n" + ind24 + `
` + + "\n" + ind28) + if row.isPinned { + b.WriteString("\n" + ind28 + env.Text("module-forumcategory-pinned") + " " + + "\n" + ind28) + } + b.WriteString("\n" + ind28 + `` + escape.HTML(row.name) + `` + + "\n" + ind24 + `
` + + "\n" + ind24 + `
` + escape.HTML(row.description) + `
` + + "\n" + ind20 + `		` + + "\n" + ind24 + env.Text("module-forum-author") + row.createdBy + + "\n" + ind24 + `
` + + "\n" + ind24 + row.createdAt + + "\n" + ind20 + `		` + + "\n" + ind24 + strconv.Itoa(row.postCount) + + "\n" + ind20 + `` + + "\n" + ind24) + if row.lastPostURL != "" { + b.WriteString("\n" + ind24 + env.Text("module-forum-author") + row.lastPostBy + + "\n" + ind24 + `
` + + "\n" + ind24 + row.lastPostAt + + "\n" + ind24 + `
` + + "\n" + ind24 + `` + + env.Text("module-forum-view-post") + `` + + "\n" + ind24) + } + b.WriteString("\n" + ind20 + `
` + + "\n" + ind12 + view.pagination + + "\n" + ind8 + `
`) + return b.String() +} + +func forumSortButton(env module.Env, href, label string, active bool) string { + if active { + return `` + + env.Text(label) + `` + } + return `` + + env.Text(label) + `` +} + +func forumCategoryShortURL(id int64) string { + return "/forum/c-" + strconv.FormatInt(id, 10) +} diff --git a/internal/modules/forumstart.go b/internal/modules/forumstart.go index a19fb44a..c9a93d1a 100644 --- a/internal/modules/forumstart.go +++ b/internal/modules/forumstart.go @@ -36,7 +36,7 @@ type forumStartSection struct { func renderForumStart(env module.Env, _ map[string]string, _ string) (string, error) { if env.Data == nil { - return "", forumStartFailed(env) + return "", forumFailed(env) } setTitle(env, env.Text("module-forumstart-title")) @@ -95,19 +95,17 @@ func forumStartSections(env module.Env, path page.PathParams) ([]db.ForumSection id, err := pynum.Int(param.Value) if err != nil { - return nil, nil, forumStartFailed(env) + return nil, nil, forumFailed(env) } section, err := env.Data.ForumSection(int64(id)) if errors.Is(err, db.ErrNotFound) { - if env.Page != nil { - env.Page.Status = http.StatusNotFound - } - return nil, nil, &module.Error{Message: env.Text("module-forumstart-no-section", "name", param.Value)} + setStatus(env, http.StatusNotFound) + return nil, nil, &module.Error{Message: env.Text("module-forum-not-found", "name", param.Value)} } if err != nil { return nil, nil, err } - setTitle(env, env.Text("module-forumstart-section-title", "name", section.Name)) + setTitle(env, env.Text("module-forum-title-named", "name", section.Name)) return []db.ForumSection{*section}, section, nil } @@ -180,8 +178,6 @@ func forumStartRow(env module.Env, category db.ForumCategory) (forumStartCategor } name := last.ThreadName - // An imported thread can carry both a category and an article, and Django - // reads the category first. if last.ThreadCategoryID == nil && last.ThreadArticleID != nil { article, err := env.Data.ArticleByID(*last.ThreadArticleID) if err != nil { @@ -203,7 +199,7 @@ func forumStartHTML(env module.Env, sections []forumStartSection, crumb *db.Foru b.WriteString(`
` + "\n" + ind12) if crumb != nil { b.WriteString("\n" + ind16 + `
` + - "\n" + ind20 + `` + env.Text("module-forum-breadcrumb") + `` + + "\n" + ind20 + `` + env.Text("module-forum-title") + `` + "\n" + ind20 + `»` + "\n" + ind20 + escape.HTML(crumb.Name) + "\n" + ind16 + `
` + @@ -225,7 +221,7 @@ func forumStartHTML(env module.Env, sections []forumStartSection, crumb *db.Foru "\n" + ind28 + `` + env.Text("module-forumstart-section") + `` + "\n" + ind28 + `` + env.Text("module-forumstart-threads") + `` + "\n" + ind28 + `` + env.Text("module-forumstart-posts") + `` + - "\n" + ind28 + `` + env.Text("module-forumstart-last-post") + `` + + "\n" + ind28 + `` + env.Text("module-forum-last-post") + `` + "\n" + ind24 + `` + "\n" + ind24) for _, category := range section.categories { @@ -271,13 +267,3 @@ func forumStartHTML(env module.Env, sections []forumStartSection, crumb *db.Foru b.WriteString("\n" + ind8 + `

`) return b.String() } - -func forumStartFailed(env module.Env) error { - return &module.Error{Message: env.Text("module-failed", "name", env.Name)} -} - -func setTitle(env module.Env, title string) { - if env.Page != nil { - env.Page.Title = title - } -} diff --git a/internal/repo/modules.go b/internal/repo/modules.go index fe26f94d..f696db93 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -143,3 +143,23 @@ func (m moduleData) Subject(user *db.User) (perms.Subject, error) { func (m moduleData) ForumSectionObject(s *db.ForumSection) *perms.Object { return NewPerms(m.repo.ctx, m.repo.db).ForumSection(s) } + +func (m moduleData) ForumCategory(id int64) (*db.ForumCategory, error) { + return m.repo.db.ForumCategory(m.repo.ctx, id) +} + +func (m moduleData) ForumThreads(categoryID int64, sort db.ForumThreadSort, offset, limit int) ([]db.ForumThread, error) { + return m.repo.db.ForumThreads(m.repo.ctx, categoryID, sort, offset, limit) +} + +func (m moduleData) ForumCommentThreads(sort db.ForumThreadSort, offset, limit int) ([]db.ForumThread, error) { + return m.repo.db.ForumCommentThreads(m.repo.ctx, sort, offset, limit) +} + +func (m moduleData) ForumThreadPostCount(threadID int64) (int, error) { + return m.repo.db.ForumThreadPostCount(m.repo.ctx, threadID) +} + +func (m moduleData) ForumThreadLastPost(threadID int64, count int) (*db.ForumPost, error) { + return m.repo.db.ForumThreadLastPost(m.repo.ctx, threadID, count) +} From fca910a005e05f1b255425047b402830100de754 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 18:20:06 +0900 Subject: [PATCH 086/428] check the category page against django --- internal/repo/forumcategory_test.go | 103 + internal/repo/forumstart_test.go | 48 +- internal/repo/testdata/forumcategory.golden | 4554 +++++++++++++++++ .../repo/testdata/forumcategory_corpus.json | 105 + internal/repo/testdata/forumstart.golden | 280 +- .../repo/testdata/oracle_forumcategory.py | 59 + 6 files changed, 5096 insertions(+), 53 deletions(-) create mode 100644 internal/repo/forumcategory_test.go create mode 100644 internal/repo/testdata/forumcategory.golden create mode 100644 internal/repo/testdata/forumcategory_corpus.json create mode 100644 internal/repo/testdata/oracle_forumcategory.py diff --git a/internal/repo/forumcategory_test.go b/internal/repo/forumcategory_test.go new file mode 100644 index 00000000..e6b010a5 --- /dev/null +++ b/internal/repo/forumcategory_test.go @@ -0,0 +1,103 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +const ( + forumCategoryGolden = "testdata/forumcategory.golden" + forumCategoryCorpus = "testdata/forumcategory_corpus.json" +) + +type forumCategoryCase struct { + Name string `json:"name"` + Viewer string `json:"viewer"` + Category string `json:"category,omitempty"` + Path map[string]string `json:"path,omitempty"` +} + +func forumCategoryCases() []forumCategoryCase { + return []forumCategoryCase{ + {Name: "chat", Viewer: "", Category: "Probe Chat"}, + {Name: "chat-by-start", Viewer: "", Category: "Probe Chat", Path: map[string]string{"sort": "start"}}, + {Name: "chat-by-junk-sort", Viewer: "", Category: "Probe Chat", Path: map[string]string{"sort": "reply"}}, + {Name: "chat-signed-in", Viewer: "probe-author", Category: "Probe Chat"}, + {Name: "empty", Viewer: "", Category: "Probe Quiet"}, + {Name: "comments", Viewer: "", Category: "Probe Comments"}, + {Name: "busy-first-page", Viewer: "", Category: "Probe Busy"}, + {Name: "busy-second-page", Viewer: "", Category: "Probe Busy", Path: map[string]string{"p": "2"}}, + {Name: "busy-past-the-end", Viewer: "", Category: "Probe Busy", Path: map[string]string{"p": "99"}}, + {Name: "busy-below-one", Viewer: "", Category: "Probe Busy", Path: map[string]string{"p": "-3"}}, + {Name: "busy-junk-page", Viewer: "", Category: "Probe Busy", Path: map[string]string{"p": "later"}}, + {Name: "hidden-section-category", Viewer: "", Category: "Probe Hidden Chat"}, + {Name: "missing", Viewer: "", Path: map[string]string{"c": "999999"}}, + {Name: "unparsable", Viewer: "", Path: map[string]string{"c": "not-a-number"}}, + {Name: "padded-id", Viewer: "", Path: map[string]string{"c": "0999999"}}, + {Name: "no-parameter", Viewer: ""}, + } +} + +func TestForumCategoryMatchesGolden(t *testing.T) { + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := forumCategoryCases() + + article, err := d.ArticleByName(ctx, "forum:category") + if err != nil { + t.Fatalf("ArticleByName(forum:category) err = %v, want nil", err) + } + categories, err := d.ForumCategories(ctx) + if err != nil { + t.Fatalf("ForumCategories() err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + var viewer *db.User + if c.Viewer != "" { + viewer, err = d.UserByUsername(ctx, c.Viewer) + if err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + } + + path := forumCategoryPath(t, c, categories) + pc := page.NewContext(article, article, path, viewer) + r := New(ctx, d, users, Options{Loc: loc, User: viewer}) + + body, err := r.RenderModule(pc, "ForumCategory", nil, "") + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\ntitle: %s\nstatus: %d\n%s\n", c.Name, pc.Title, pc.Status, body) + } + compareGolden(t, b.String(), cases, forumCategoryGolden, forumCategoryCorpus) +} + +func forumCategoryPath(t *testing.T, c forumCategoryCase, categories []db.ForumCategory) page.PathParams { + t.Helper() + path := sortedPath(c.Path) + if c.Category == "" { + return path + } + for _, category := range categories { + if category.Name == c.Category { + return path.Put(page.PathParam{Key: "c", Value: fmt.Sprint(category.ID)}) + } + } + t.Fatalf("ForumCategories() has no category named %q, want one seeded", c.Category) + return nil +} diff --git a/internal/repo/forumstart_test.go b/internal/repo/forumstart_test.go index 0dfb354c..07bdc5da 100644 --- a/internal/repo/forumstart_test.go +++ b/internal/repo/forumstart_test.go @@ -89,20 +89,12 @@ func TestForumStartMatchesGolden(t *testing.T) { } fmt.Fprintf(&b, "=== %s\ntitle: %s\nstatus: %d\n%s\n", c.Name, pc.Title, pc.Status, body) } - compareForumStartGolden(t, b.String(), cases) + compareGolden(t, b.String(), cases, forumStartGolden, forumStartCorpus) } func forumStartPath(t *testing.T, c forumStartCase, sections []db.ForumSection) page.PathParams { t.Helper() - var path page.PathParams - keys := make([]string, 0, len(c.Path)) - for key := range c.Path { - keys = append(keys, key) - } - sort.Strings(keys) - for _, key := range keys { - path = path.Put(page.PathParam{Key: key, Value: c.Path[key]}) - } + path := sortedPath(c.Path) if c.Section == "" { return path } @@ -115,32 +107,46 @@ func forumStartPath(t *testing.T, c forumStartCase, sections []db.ForumSection) return nil } -func compareForumStartGolden(t *testing.T, got string, corpus any) { +func sortedPath(params map[string]string) page.PathParams { + keys := make([]string, 0, len(params)) + for key := range params { + keys = append(keys, key) + } + sort.Strings(keys) + + var path page.PathParams + for _, key := range keys { + path = path.Put(page.PathParam{Key: key, Value: params[key]}) + } + return path +} + +func compareGolden(t *testing.T, got string, corpus any, goldenPath, corpusPath string) { t.Helper() if *update { data, err := json.MarshalIndent(corpus, "", " ") if err != nil { - t.Fatalf("Marshal(%s) err = %v, want nil", forumStartCorpus, err) + t.Fatalf("Marshal(%s) err = %v, want nil", corpusPath, err) } - if err := os.WriteFile(filepath.FromSlash(forumStartCorpus), append(data, '\n'), 0o644); err != nil { - t.Fatalf("WriteFile(%s) err = %v, want nil", forumStartCorpus, err) + if err := os.WriteFile(filepath.FromSlash(corpusPath), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", corpusPath, err) } - if err := os.WriteFile(filepath.FromSlash(forumStartGolden), []byte(got), 0o644); err != nil { - t.Fatalf("WriteFile(%s) err = %v, want nil", forumStartGolden, err) + if err := os.WriteFile(filepath.FromSlash(goldenPath), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", goldenPath, err) } return } - want, err := os.ReadFile(filepath.FromSlash(forumStartGolden)) + want, err := os.ReadFile(filepath.FromSlash(goldenPath)) if err != nil { - t.Fatalf("ReadFile(%s) err = %v, want nil", forumStartGolden, err) + t.Fatalf("ReadFile(%s) err = %v, want nil", goldenPath, err) } if got != string(want) { - gotAt, wantAt := firstForumStartDiff(got, string(want)) - t.Errorf("RenderModule(ForumStart) = %q, want %q", gotAt, wantAt) + gotAt, wantAt := firstDiff(got, string(want)) + t.Errorf("%s = %q, want %q", goldenPath, gotAt, wantAt) } } -func firstForumStartDiff(got, want string) (string, string) { +func firstDiff(got, want string) (string, string) { at := 0 for at < len(got) && at < len(want) && got[at] == want[at] { at++ diff --git a/internal/repo/testdata/forumcategory.golden b/internal/repo/testdata/forumcategory.golden new file mode 100644 index 00000000..0a328c82 --- /dev/null +++ b/internal/repo/testdata/forumcategory.golden @@ -0,0 +1,4554 @@ +=== chat +title: 论坛 — Probe Chat +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Chat +
+
+
+ 主题数：3 +
+ 帖子数：6 +
+ ordinary threads +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + 置顶： + + Probe Pinned Thread +
+
Probe Pinned Thread description
+ 		+ 作者： + + probevoter + + probevoter + + + + + +
+ 03.04.2021 05:08 + 		+ 2 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:17 +
+ 查看 + +
+
+ + Probe Thread +
+
Probe Thread description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:06 + 		+ 3 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:14 +
+ 查看 + +
+
+ + Probe Locked Thread +
+
Probe Locked Thread description
+ 		+ 作者： + + probevoter + + probevoter + + + + + +
+ 03.04.2021 05:07 + 		+ 1 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+ +
+=== chat-by-start +title: 论坛 — Probe Chat +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Chat +
+
+
+ 主题数：3 +
+ 帖子数：6 +
+ ordinary threads +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + 置顶： + + Probe Pinned Thread +
+
Probe Pinned Thread description
+ 		+ 作者： + + probevoter + + probevoter + + + + + +
+ 03.04.2021 05:08 + 		+ 2 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:17 +
+ 查看 + +
+
+ + Probe Locked Thread +
+
Probe Locked Thread description
+ 		+ 作者： + + probevoter + + probevoter + + + + + +
+ 03.04.2021 05:07 + 		+ 1 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+
+ + Probe Thread +
+
Probe Thread description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:06 + 		+ 3 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:14 +
+ 查看 + +
+ +
+=== chat-by-junk-sort +title: 论坛 — Probe Chat +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Chat +
+
+
+ 主题数：3 +
+ 帖子数：6 +
+ ordinary threads +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + 置顶： + + Probe Pinned Thread +
+
Probe Pinned Thread description
+ 		+ 作者： + + probevoter + + probevoter + + + + + +
+ 03.04.2021 05:08 + 		+ 2 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:17 +
+ 查看 + +
+
+ + Probe Thread +
+
Probe Thread description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:06 + 		+ 3 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:14 +
+ 查看 + +
+
+ + Probe Locked Thread +
+
Probe Locked Thread description
+ 		+ 作者： + + probevoter + + probevoter + + + + + +
+ 03.04.2021 05:07 + 		+ 1 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+ +
+=== chat-signed-in +title: 论坛 — Probe Chat +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Chat +
+
+
+ 主题数：3 +
+ 帖子数：6 +
+ ordinary threads +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + 置顶： + + Probe Pinned Thread +
+
Probe Pinned Thread description
+ 		+ 作者： + + probevoter + + probevoter + + + + + +
+ 03.04.2021 05:08 + 		+ 2 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:17 +
+ 查看 + +
+
+ + Probe Thread +
+
Probe Thread description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:06 + 		+ 3 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:14 +
+ 查看 + +
+
+ + Probe Locked Thread +
+
Probe Locked Thread description
+ 		+ 作者： + + probevoter + + probevoter + + + + + +
+ 03.04.2021 05:07 + 		+ 1 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:15 +
+ 查看 + +
+ +
+=== empty +title: 论坛 — Probe Quiet +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Quiet +
+
+
+ 主题数：0 +
+ 帖子数：0 +
+ nobody has posted here +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+ +
+=== comments +title: 论坛 — Probe Comments +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Comments +
+
+
+ 主题数：0 +
+ 帖子数：0 +
+ article comments +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + Probe Third +
+
+ 		+ 作者：系统 +
+ 08.28.2026 13:17 + 		+ 0 + + +
+
+ + Probe List By Votes +
+
+ 		+ 作者：系统 +
+ 08.27.2026 10:52 + 		+ 0 + + +
+
+ + Probe List Url +
+
+ 		+ 作者：系统 +
+ 08.27.2026 10:52 + 		+ 0 + + +
+
+ + Probe List Empty +
+
+ 		+ 作者：系统 +
+ 08.27.2026 10:52 + 		+ 0 + + +
+
+ + Probe List Tags +
+
+ 		+ 作者：系统 +
+ 08.27.2026 10:52 + 		+ 0 + + +
+
+ + Probe List Sections +
+
+ 		+ 作者：系统 +
+ 08.27.2026 10:52 + 		+ 0 + + +
+
+ + Probe List No Wrapper +
+
+ 		+ 作者：系统 +
+ 08.27.2026 10:52 + 		+ 0 + + +
+
+ + Probe List Joined +
+
+ 		+ 作者：系统 +
+ 08.27.2026 10:52 + 		+ 0 + + +
+
+ + Probe Listed +
+
+ 		+ 作者：系统 +
+ 08.27.2026 10:51 + 		+ 0 + + +
+
+ + recent-posts +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:54 + 		+ 0 + + +
+
+ + new-thread +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:54 + 		+ 0 + + +
+
+ + category +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:54 + 		+ 0 + + +
+
+ + thread +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:54 + 		+ 0 + + +
+
+ + top-impl +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:54 + 		+ 0 + + +
+
+ + Probe By Display Name +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:49 + 		+ 0 + + +
+
+ + site +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:13 + 		+ 0 + + +
+
+ + wiki-syntax-guide +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:13 + 		+ 0 + + +
+
+ + start +
+
+ 		+ 作者：系统 +
+ 08.26.2026 16:12 + 		+ 0 + + +
+
+ + Probe Redirect +
+
+ 		+ 作者：系统 +
+ 08.26.2026 14:01 + 		+ 0 + + +
+
+ + Probe Unknown Module +
+
+ 		+ 作者：系统 +
+ 08.26.2026 14:01 + 		+ 0 + + +
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+=== busy-first-page +title: 论坛 — Probe Busy +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Busy +
+
+
+ 主题数：21 +
+ 帖子数：21 +
+ enough threads for a second page +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + Probe Busy 00 +
+
Probe Busy 00 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:09 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:18 +
+ 查看 + +
+
+ + Probe Busy 01 +
+
Probe Busy 01 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:10 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:19 +
+ 查看 + +
+
+ + Probe Busy 02 +
+
Probe Busy 02 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:11 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:20 +
+ 查看 + +
+
+ + Probe Busy 03 +
+
Probe Busy 03 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:12 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:21 +
+ 查看 + +
+
+ + Probe Busy 04 +
+
Probe Busy 04 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:13 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:22 +
+ 查看 + +
+
+ + Probe Busy 05 +
+
Probe Busy 05 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:14 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:23 +
+ 查看 + +
+
+ + Probe Busy 06 +
+
Probe Busy 06 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:15 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:24 +
+ 查看 + +
+
+ + Probe Busy 07 +
+
Probe Busy 07 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:16 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:25 +
+ 查看 + +
+
+ + Probe Busy 08 +
+
Probe Busy 08 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:17 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:26 +
+ 查看 + +
+
+ + Probe Busy 09 +
+
Probe Busy 09 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:18 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:27 +
+ 查看 + +
+
+ + Probe Busy 10 +
+
Probe Busy 10 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:19 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:28 +
+ 查看 + +
+
+ + Probe Busy 11 +
+
Probe Busy 11 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:20 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:29 +
+ 查看 + +
+
+ + Probe Busy 12 +
+
Probe Busy 12 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:21 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:30 +
+ 查看 + +
+
+ + Probe Busy 13 +
+
Probe Busy 13 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:22 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:31 +
+ 查看 + +
+
+ + Probe Busy 14 +
+
Probe Busy 14 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:23 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:32 +
+ 查看 + +
+
+ + Probe Busy 15 +
+
Probe Busy 15 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:24 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:33 +
+ 查看 + +
+
+ + Probe Busy 16 +
+
Probe Busy 16 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:25 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:34 +
+ 查看 + +
+
+ + Probe Busy 17 +
+
Probe Busy 17 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:26 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:35 +
+ 查看 + +
+
+ + Probe Busy 18 +
+
Probe Busy 18 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:27 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:36 +
+ 查看 + +
+
+ + Probe Busy 19 +
+
Probe Busy 19 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:28 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:37 +
+ 查看 + +
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+=== busy-second-page +title: 论坛 — Probe Busy +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Busy +
+
+
+ 主题数：21 +
+ 帖子数：21 +
+ enough threads for a second page +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ +
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+ + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + Probe Busy 20 +
+
Probe Busy 20 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:29 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + +
+
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+
+=== busy-past-the-end +title: 论坛 — Probe Busy +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Busy +
+
+
+ 主题数：21 +
+ 帖子数：21 +
+ enough threads for a second page +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ +
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+ + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + Probe Busy 20 +
+
Probe Busy 20 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:29 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + +
+
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+
+=== busy-below-one +title: 论坛 — Probe Busy +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Busy +
+
+
+ 主题数：21 +
+ 帖子数：21 +
+ enough threads for a second page +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + Probe Busy 00 +
+
Probe Busy 00 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:09 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:18 +
+ 查看 + +
+
+ + Probe Busy 01 +
+
Probe Busy 01 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:10 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:19 +
+ 查看 + +
+
+ + Probe Busy 02 +
+
Probe Busy 02 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:11 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:20 +
+ 查看 + +
+
+ + Probe Busy 03 +
+
Probe Busy 03 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:12 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:21 +
+ 查看 + +
+
+ + Probe Busy 04 +
+
Probe Busy 04 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:13 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:22 +
+ 查看 + +
+
+ + Probe Busy 05 +
+
Probe Busy 05 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:14 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:23 +
+ 查看 + +
+
+ + Probe Busy 06 +
+
Probe Busy 06 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:15 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:24 +
+ 查看 + +
+
+ + Probe Busy 07 +
+
Probe Busy 07 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:16 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:25 +
+ 查看 + +
+
+ + Probe Busy 08 +
+
Probe Busy 08 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:17 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:26 +
+ 查看 + +
+
+ + Probe Busy 09 +
+
Probe Busy 09 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:18 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:27 +
+ 查看 + +
+
+ + Probe Busy 10 +
+
Probe Busy 10 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:19 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:28 +
+ 查看 + +
+
+ + Probe Busy 11 +
+
Probe Busy 11 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:20 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:29 +
+ 查看 + +
+
+ + Probe Busy 12 +
+
Probe Busy 12 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:21 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:30 +
+ 查看 + +
+
+ + Probe Busy 13 +
+
Probe Busy 13 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:22 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:31 +
+ 查看 + +
+
+ + Probe Busy 14 +
+
Probe Busy 14 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:23 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:32 +
+ 查看 + +
+
+ + Probe Busy 15 +
+
Probe Busy 15 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:24 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:33 +
+ 查看 + +
+
+ + Probe Busy 16 +
+
Probe Busy 16 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:25 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:34 +
+ 查看 + +
+
+ + Probe Busy 17 +
+
Probe Busy 17 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:26 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:35 +
+ 查看 + +
+
+ + Probe Busy 18 +
+
Probe Busy 18 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:27 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:36 +
+ 查看 + +
+
+ + Probe Busy 19 +
+
Probe Busy 19 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:28 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:37 +
+ 查看 + +
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+=== busy-junk-page +title: 论坛 — Probe Busy +status: 200 +
+
+ 论坛 + » + Probe Open + » + Probe Busy +
+
+
+ 主题数：21 +
+ 帖子数：21 +
+ enough threads for a second page +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+
+ + Probe Busy 00 +
+
Probe Busy 00 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:09 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:18 +
+ 查看 + +
+
+ + Probe Busy 01 +
+
Probe Busy 01 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:10 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:19 +
+ 查看 + +
+
+ + Probe Busy 02 +
+
Probe Busy 02 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:11 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:20 +
+ 查看 + +
+
+ + Probe Busy 03 +
+
Probe Busy 03 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:12 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:21 +
+ 查看 + +
+
+ + Probe Busy 04 +
+
Probe Busy 04 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:13 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:22 +
+ 查看 + +
+
+ + Probe Busy 05 +
+
Probe Busy 05 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:14 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:23 +
+ 查看 + +
+
+ + Probe Busy 06 +
+
Probe Busy 06 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:15 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:24 +
+ 查看 + +
+
+ + Probe Busy 07 +
+
Probe Busy 07 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:16 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:25 +
+ 查看 + +
+
+ + Probe Busy 08 +
+
Probe Busy 08 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:17 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:26 +
+ 查看 + +
+
+ + Probe Busy 09 +
+
Probe Busy 09 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:18 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:27 +
+ 查看 + +
+
+ + Probe Busy 10 +
+
Probe Busy 10 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:19 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:28 +
+ 查看 + +
+
+ + Probe Busy 11 +
+
Probe Busy 11 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:20 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:29 +
+ 查看 + +
+
+ + Probe Busy 12 +
+
Probe Busy 12 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:21 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:30 +
+ 查看 + +
+
+ + Probe Busy 13 +
+
Probe Busy 13 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:22 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:31 +
+ 查看 + +
+
+ + Probe Busy 14 +
+
Probe Busy 14 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:23 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:32 +
+ 查看 + +
+
+ + Probe Busy 15 +
+
Probe Busy 15 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:24 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:33 +
+ 查看 + +
+
+ + Probe Busy 16 +
+
Probe Busy 16 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:25 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:34 +
+ 查看 + +
+
+ + Probe Busy 17 +
+
Probe Busy 17 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:26 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:35 +
+ 查看 + +
+
+ + Probe Busy 18 +
+
Probe Busy 18 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:27 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:36 +
+ 查看 + +
+
+ + Probe Busy 19 +
+
Probe Busy 19 description
+ 		+ 作者： + + Probe Author + + Probe Author + + + + + +
+ 03.04.2021 05:28 + 		+ 1 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:37 +
+ 查看 + +
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+=== hidden-section-category +title: 论坛 — Probe Hidden Chat +status: 200 +
+
+ 论坛 + » + Probe Hidden + » + Probe Hidden Chat +
+
+
+ 主题数：0 +
+ 帖子数：0 +
+ inside the hidden section +
+
+ 排序方式： +
+ + 按最后回复时间 + +
+ + 按主题创建时间 + +
+
+ + + + + + + + + + + + +
主题标题创建信息回复数最后回复
+ +
+=== missing +title: 论坛 +status: 404 +!error: 未找到版块 "999999" +=== unparsable +title: 论坛 +status: 404 +!error: 未找到版块 "not-a-number" +=== padded-id +title: 论坛 +status: 404 +!error: 未找到版块 "999999" +=== no-parameter +title: 论坛 +status: 404 +!error: 未找到版块 "None" diff --git a/internal/repo/testdata/forumcategory_corpus.json b/internal/repo/testdata/forumcategory_corpus.json new file mode 100644 index 00000000..5f95f76a --- /dev/null +++ b/internal/repo/testdata/forumcategory_corpus.json @@ -0,0 +1,105 @@ +[ + { + "name": "chat", + "viewer": "", + "category": "Probe Chat" + }, + { + "name": "chat-by-start", + "viewer": "", + "category": "Probe Chat", + "path": { + "sort": "start" + } + }, + { + "name": "chat-by-junk-sort", + "viewer": "", + "category": "Probe Chat", + "path": { + "sort": "reply" + } + }, + { + "name": "chat-signed-in", + "viewer": "probe-author", + "category": "Probe Chat" + }, + { + "name": "empty", + "viewer": "", + "category": "Probe Quiet" + }, + { + "name": "comments", + "viewer": "", + "category": "Probe Comments" + }, + { + "name": "busy-first-page", + "viewer": "", + "category": "Probe Busy" + }, + { + "name": "busy-second-page", + "viewer": "", + "category": "Probe Busy", + "path": { + "p": "2" + } + }, + { + "name": "busy-past-the-end", + "viewer": "", + "category": "Probe Busy", + "path": { + "p": "99" + } + }, + { + "name": "busy-below-one", + "viewer": "", + "category": "Probe Busy", + "path": { + "p": "-3" + } + }, + { + "name": "busy-junk-page", + "viewer": "", + "category": "Probe Busy", + "path": { + "p": "later" + } + }, + { + "name": "hidden-section-category", + "viewer": "", + "category": "Probe Hidden Chat" + }, + { + "name": "missing", + "viewer": "", + "path": { + "c": "999999" + } + }, + { + "name": "unparsable", + "viewer": "", + "path": { + "c": "not-a-number" + } + }, + { + "name": "padded-id", + "viewer": "", + "path": { + "c": "0999999" + } + }, + { + "name": "no-parameter", + "viewer": "" + } +] diff --git a/internal/repo/testdata/forumstart.golden b/internal/repo/testdata/forumstart.golden index b04396a6..b847aac0 100644 --- a/internal/repo/testdata/forumstart.golden +++ b/internal/repo/testdata/forumstart.golden @@ -30,8 +30,8 @@ status: 200
Probe Chat
ordinary threads
- 2 - 4 + 3 + 6 作者： @@ -45,9 +45,9 @@ status: 200
- 09.10.2023 11:15 + 09.10.2023 11:17
- 查看 + 查看 @@ -91,6 +91,33 @@ status: 200 + + +
Probe Busy
+
enough threads for a second page
+ + 21 + 21 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + + + +
@@ -134,8 +161,8 @@ status: 200
Probe Chat
ordinary threads
- 2 - 4 + 3 + 6 作者： @@ -149,9 +176,9 @@ status: 200
- 09.10.2023 11:15 + 09.10.2023 11:17
- 查看 + 查看 @@ -195,6 +222,33 @@ status: 200 + + +
Probe Busy
+
enough threads for a second page
+ + 21 + 21 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + + + +
@@ -270,8 +324,8 @@ status: 200
Probe Chat
ordinary threads
- 2 - 4 + 3 + 6 作者： @@ -285,9 +339,9 @@ status: 200
- 09.10.2023 11:15 + 09.10.2023 11:17
- 查看 + 查看 @@ -331,6 +385,33 @@ status: 200 + + +
Probe Busy
+
enough threads for a second page
+ + 21 + 21 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + + + +
@@ -374,8 +455,8 @@ status: 200
Probe Chat
ordinary threads
- 2 - 4 + 3 + 6 作者： @@ -389,9 +470,9 @@ status: 200
- 09.10.2023 11:15 + 09.10.2023 11:17
- 查看 + 查看 @@ -435,6 +516,33 @@ status: 200 + + +
Probe Busy
+
enough threads for a second page
+ + 21 + 21 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + + + + @@ -546,8 +654,8 @@ status: 200
Probe Chat
ordinary threads
- 2 - 4 + 3 + 6 作者： @@ -561,9 +669,9 @@ status: 200
- 09.10.2023 11:15 + 09.10.2023 11:17
- 查看 + 查看 @@ -607,6 +715,33 @@ status: 200 + + +
Probe Busy
+
enough threads for a second page
+ + 21 + 21 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + + + + @@ -658,8 +793,8 @@ status: 200
Probe Chat
ordinary threads
- 2 - 4 + 3 + 6 作者： @@ -673,9 +808,9 @@ status: 200
- 09.10.2023 11:15 + 09.10.2023 11:17
- 查看 + 查看 @@ -719,6 +854,33 @@ status: 200 + + +
Probe Busy
+
enough threads for a second page
+ + 21 + 21 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + + + + @@ -762,8 +924,8 @@ status: 200
Probe Chat
ordinary threads
- 2 - 4 + 3 + 6 作者： @@ -777,9 +939,9 @@ status: 200
- 09.10.2023 11:15 + 09.10.2023 11:17
- 查看 + 查看 @@ -823,6 +985,33 @@ status: 200 + + +
Probe Busy
+
enough threads for a second page
+ + 21 + 21 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + + + + @@ -898,8 +1087,8 @@ status: 200
Probe Chat
ordinary threads
- 2 - 4 + 3 + 6 作者： @@ -913,9 +1102,9 @@ status: 200
- 09.10.2023 11:15 + 09.10.2023 11:17
- 查看 + 查看 @@ -959,6 +1148,33 @@ status: 200 + + +
Probe Busy
+
enough threads for a second page
+ + 21 + 21 + + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + + + + diff --git a/internal/repo/testdata/oracle_forumcategory.py b/internal/repo/testdata/oracle_forumcategory.py new file mode 100644 index 00000000..961c864b --- /dev/null +++ b/internal/repo/testdata/oracle_forumcategory.py @@ -0,0 +1,59 @@ +"""Records what the ForumCategory module renders for a reader browsing a category. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e FORUMCATEGORY_CORPUS="$(cat internal/repo/testdata/forumcategory_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_forumcategory.py + +Category ids are looked up by name so the corpus does not depend on what the +sequence handed out. Compare the output with internal/repo/testdata/forumcategory.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.forum import ForumCategory +from web.models.site import Site +from web.models.users import User + +CORPUS = json.loads(os.environ['FORUMCATEGORY_CORPUS']) + + +def path_params(case): + params = dict(case.get('path') or {}) + if case.get('category'): + params['c'] = str(ForumCategory.objects.get(name=case['category']).id) + return params + + +def main(): + article = articles.get_article('forum:category') + if article is None: + raise SystemExit('forum:category is missing; run manage.py seed first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + if case['viewer']: + viewer = User.objects.get(username=case['viewer']) + threadvars.put('current_user', viewer) + context = RenderContext(article, article, path_params(case), viewer) + try: + body = modules.render_module('ForumCategory', context, {}) + except ModuleError as error: + body = '!error: %s' % error.message + out.append('=== %s\ntitle: %s\nstatus: %d\n%s\n' % ( + case['name'], context.title, context.status, body)) + sys.stdout.write(''.join(out)) + + +main() From 9a874fad66cb9d0c9d9b77e3e7cd6e01e7a26d98 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 18:20:12 +0900 Subject: [PATCH 087/428] run the category page in the page corpus --- internal/difftest/corpus/articles.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 2af26a84..c5d52482 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -55,7 +55,9 @@ OPTIONS /probe:full /forum/start/hidden/show /forum/start/s/999999 !/forum:recent-posts -!/forum:category +/forum:category +/forum/c-999999 +/forum/c-999999/sort/start !/forum:thread !/forum:new-thread /search:site From 2dfc91fe5b5ef614c0e940e85dfd7fa212dbbfa0 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 19:11:44 +0900 Subject: [PATCH 088/428] give the seeded threads replies and enough posts to page --- internal/db/forum_test.go | 6 +- internal/page/testdata/oracle_seed.py | 44 +++- internal/repo/testdata/forumstart.golden | 248 +++++++++++++++++++++-- 3 files changed, 275 insertions(+), 23 deletions(-) diff --git a/internal/db/forum_test.go b/internal/db/forum_test.go index 4ea73a62..d53fce0d 100644 --- a/internal/db/forum_test.go +++ b/internal/db/forum_test.go @@ -84,7 +84,7 @@ func TestForumCategoriesComeBackInOrder(t *testing.T) { t.Fatalf("ForumCategories() err = %v, want nil", err) } - want := []string{"Probe Chat", "Probe Hidden Chat", "Probe Staff Chat", "Probe Comments", "Probe Quiet", "Probe Busy"} + want := []string{"Probe Chat", "Probe Hidden Chat", "Probe Staff Chat", "Probe Comments", "Probe Quiet", "Probe Busy", "Probe Talk"} if len(categories) != len(want) { t.Fatalf("len(ForumCategories()) = %d, want %d", len(categories), len(want)) } @@ -185,8 +185,8 @@ func TestForumCommentCountsReachEveryArticle(t *testing.T) { if got.Threads < 1 { t.Errorf("ForumCommentCounts().Threads = %d, want at least 1", got.Threads) } - if got.Posts != 2 { - t.Errorf("ForumCommentCounts().Posts = %d, want %d", got.Posts, 2) + if got.Posts != 4 { + t.Errorf("ForumCommentCounts().Posts = %d, want %d", got.Posts, 4) } } diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index 977632a2..16612c62 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -69,15 +69,32 @@ def notify(user, kind, viewed): ) -def comment_thread(article, user, posts): +def comment_thread(article, authors): thread, _ = ForumThread.objects.get_or_create(article=article, defaults=dict(name=article.title)) - for i in range(posts): - ForumPost.objects.get_or_create( + for i, user in enumerate(authors): + post, _ = ForumPost.objects.get_or_create( thread=thread, name='probe post %d' % i, defaults=dict(author=user), ) + ForumPostVersion.objects.get_or_create( + post=post, defaults=dict(source='probe comment %d' % i, author=user)) + at = POSTED_AT + datetime.timedelta(minutes=next(POSTED_MINUTES)) + ForumPost.objects.filter(pk=post.pk).update(created_at=at, updated_at=at) return thread +def forum_reply(parent, name, user, source): + post, _ = ForumPost.objects.get_or_create( + thread=parent.thread, reply_to=parent, name=name, defaults=dict(author=user)) + ForumPostVersion.objects.get_or_create(post=post, defaults=dict(source=source, author=user)) + at = POSTED_AT + datetime.timedelta(minutes=next(POSTED_MINUTES)) + ForumPost.objects.filter(pk=post.pk).update(created_at=at, updated_at=at) + return post + + +def root_posts(thread): + return list(ForumPost.objects.filter(thread=thread, reply_to__isnull=True).order_by('created_at')) + + def forum_section(name, order, **kwargs): section, _ = ForumSection.objects.get_or_create(name=name) section.order = order @@ -279,9 +296,28 @@ def vote(article, user, rate): for index in range(21): forum_thread(busy, 'Probe Busy %02d' % index, author, 1) -thread = comment_thread(full, author, 2) +comment_thread(rated, [author, voter]) +thread = comment_thread(full, [author, author]) subscribe(author, article=full) subscribe(author, forum_thread=thread) + +talk = forum_category(open_section, 'Probe Talk', 4, description='threads that carry replies') + +deep = forum_thread(talk, 'Probe Deep Thread', author, 2) +deep_roots = root_posts(deep) +reply = forum_reply(deep_roots[0], 'Probe Deep reply 0', voter, + 'reply naming @probe-author and @nobody-at-all') +forum_reply(reply, 'Probe Deep reply 0 0', author, 'a reply to a reply') +forum_reply(deep_roots[0], 'Probe Deep reply 1', None, 'a reply the site itself made') + +edited = deep_roots[1] +ForumPost.objects.filter(pk=edited.pk).update( + updated_at=edited.created_at + datetime.timedelta(minutes=5)) +ForumPostVersion.objects.get_or_create( + post=edited, source='Probe Deep Thread body 1 edited', defaults=dict(author=voter)) + +forum_thread(talk, 'Probe Long Thread', voter, 12) + author.preferences['qol__advanced_source_editor_enabled'] = True notify(author, UserNotification.NotificationType.Welcome, False) diff --git a/internal/repo/testdata/forumstart.golden b/internal/repo/testdata/forumstart.golden index b847aac0..42361322 100644 --- a/internal/repo/testdata/forumstart.golden +++ b/internal/repo/testdata/forumstart.golden @@ -58,7 +58,7 @@ status: 200
article comments
39 - 2 + 4 作者： @@ -72,7 +72,7 @@ status: 200
- 08.26.2026 13:01 + 09.10.2023 11:42
查看 @@ -118,6 +118,33 @@ status: 200 + + +
Probe Talk
+
threads that carry replies
+ + 2 + 17 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:59 +
+ 查看 + + + + @@ -189,7 +216,7 @@ status: 200
article comments
39 - 2 + 4 作者： @@ -203,7 +230,7 @@ status: 200
- 08.26.2026 13:01 + 09.10.2023 11:42
查看 @@ -249,6 +276,33 @@ status: 200 + + +
Probe Talk
+
threads that carry replies
+ + 2 + 17 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:59 +
+ 查看 + + + + @@ -352,7 +406,7 @@ status: 200
article comments
39 - 2 + 4 作者： @@ -366,7 +420,7 @@ status: 200
- 08.26.2026 13:01 + 09.10.2023 11:42
查看 @@ -412,6 +466,33 @@ status: 200 + + +
Probe Talk
+
threads that carry replies
+ + 2 + 17 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:59 +
+ 查看 + + + + @@ -483,7 +564,7 @@ status: 200
article comments
39 - 2 + 4 作者： @@ -497,7 +578,7 @@ status: 200
- 08.26.2026 13:01 + 09.10.2023 11:42
查看 @@ -543,6 +624,33 @@ status: 200 + + +
Probe Talk
+
threads that carry replies
+ + 2 + 17 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:59 +
+ 查看 + + + + @@ -682,7 +790,7 @@ status: 200
article comments
39 - 2 + 4 作者： @@ -696,7 +804,7 @@ status: 200
- 08.26.2026 13:01 + 09.10.2023 11:42
查看 @@ -742,6 +850,33 @@ status: 200 + + +
Probe Talk
+
threads that carry replies
+ + 2 + 17 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:59 +
+ 查看 + + + + @@ -821,7 +956,7 @@ status: 200
article comments
39 - 2 + 4 作者： @@ -835,7 +970,7 @@ status: 200
- 08.26.2026 13:01 + 09.10.2023 11:42
查看 @@ -881,6 +1016,33 @@ status: 200 + + +
Probe Talk
+
threads that carry replies
+ + 2 + 17 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:59 +
+ 查看 + + + + @@ -952,7 +1114,7 @@ status: 200
article comments
39 - 2 + 4 作者： @@ -966,7 +1128,7 @@ status: 200
- 08.26.2026 13:01 + 09.10.2023 11:42
查看 @@ -1012,6 +1174,33 @@ status: 200 + + +
Probe Talk
+
threads that carry replies
+ + 2 + 17 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:59 +
+ 查看 + + + + @@ -1115,7 +1304,7 @@ status: 200
article comments
39 - 2 + 4 作者： @@ -1129,7 +1318,7 @@ status: 200
- 08.26.2026 13:01 + 09.10.2023 11:42
查看 @@ -1175,6 +1364,33 @@ status: 200 + + +
Probe Talk
+
threads that carry replies
+ + 2 + 17 + + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:59 +
+ 查看 + + + + From 24eb9b0f60f2f755f632afc568b5e10475ed23b9 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 19:11:51 +0900 Subject: [PATCH 089/428] add the queries a thread page needs --- internal/db/forum.go | 158 ++++++++++++++++++++++++++++++++++++++++- internal/db/rating.go | 21 ++++++ internal/db/user.go | 20 ++++++ internal/repo/perms.go | 29 ++++++++ 4 files changed, 226 insertions(+), 2 deletions(-) diff --git a/internal/db/forum.go b/internal/db/forum.go index 03b80b0d..6be10eb7 100644 --- a/internal/db/forum.go +++ b/internal/db/forum.go @@ -186,6 +186,7 @@ type ForumThread struct { ArticleID *int64 AuthorID *int64 IsPinned bool + IsLocked bool CreatedAt time.Time } @@ -196,7 +197,7 @@ const ( ForumThreadsByStart ) -const forumThreadColumns = `id, name, description, category_id, article_id, author_id, is_pinned, created_at` +const forumThreadColumns = `id, name, description, category_id, article_id, author_id, is_pinned, is_locked, created_at` var qForumThreadsByReply = register("ForumThreadsByReply", ` SELECT `+forumThreadColumns+` @@ -253,7 +254,7 @@ func (d *DB) scanThreads(ctx context.Context, sql string, args ...any) ([]ForumT for rows.Next() { var t ForumThread if err := rows.Scan(&t.ID, &t.Name, &t.Description, &t.CategoryID, &t.ArticleID, - &t.AuthorID, &t.IsPinned, &t.CreatedAt); err != nil { + &t.AuthorID, &t.IsPinned, &t.IsLocked, &t.CreatedAt); err != nil { return nil, fmt.Errorf("scan forum thread: %w", err) } out = append(out, t) @@ -316,3 +317,156 @@ func (d *DB) ForumCategory(ctx context.Context, id int64) (*ForumCategory, error } return &c, nil } + +var qForumThread = register("ForumThread", ` +SELECT `+forumThreadColumns+` +FROM web_forumthread +WHERE id = $1`) + +func (d *DB) ForumThread(ctx context.Context, id int64) (*ForumThread, error) { + var t ForumThread + err := d.pool.QueryRow(ctx, qForumThread, id).Scan(&t.ID, &t.Name, &t.Description, + &t.CategoryID, &t.ArticleID, &t.AuthorID, &t.IsPinned, &t.IsLocked, &t.CreatedAt) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("query forum thread %d: %w", id, err) + } + return &t, nil +} + +type ForumThreadPost struct { + ID int64 + ThreadID int64 + Name string + CreatedAt time.Time + UpdatedAt time.Time + AuthorID *int64 + ReplyToID *int64 +} + +const forumPostColumns = `id, thread_id, name, created_at, updated_at, author_id, reply_to_id` + +var qForumRootPostCount = register("ForumRootPostCount", ` +SELECT count(*) FROM web_forumpost WHERE thread_id = $1 AND reply_to_id IS NULL`) + +func (d *DB) ForumRootPostCount(ctx context.Context, threadID int64) (int, error) { + var n int + if err := d.pool.QueryRow(ctx, qForumRootPostCount, threadID).Scan(&n); err != nil { + return 0, fmt.Errorf("count root posts in thread %d: %w", threadID, err) + } + return n, nil +} + +var qForumRootPosts = register("ForumRootPosts", ` +SELECT `+forumPostColumns+` +FROM web_forumpost +WHERE thread_id = $1 AND reply_to_id IS NULL +ORDER BY created_at +OFFSET $2 LIMIT $3`) + +func (d *DB) ForumRootPosts(ctx context.Context, threadID int64, offset, limit int) ([]ForumThreadPost, error) { + return d.scanPosts(ctx, qForumRootPosts, threadID, offset, limit) +} + +var qForumRootPostIDs = register("ForumRootPostIDs", ` +SELECT id +FROM web_forumpost +WHERE thread_id = $1 AND reply_to_id IS NULL +ORDER BY created_at`) + +func (d *DB) ForumRootPostIDs(ctx context.Context, threadID int64) ([]int64, error) { + rows, err := d.pool.Query(ctx, qForumRootPostIDs, threadID) + if err != nil { + return nil, fmt.Errorf("query root post ids of thread %d: %w", threadID, err) + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + return nil, fmt.Errorf("scan root post id: %w", err) + } + out = append(out, id) + } + return out, rows.Err() +} + +var qForumPostReplies = register("ForumPostReplies", ` +SELECT `+forumPostColumns+` +FROM web_forumpost +WHERE reply_to_id = $1 +ORDER BY created_at`) + +func (d *DB) ForumPostReplies(ctx context.Context, postID int64) ([]ForumThreadPost, error) { + return d.scanPosts(ctx, qForumPostReplies, postID) +} + +var qForumPost = register("ForumPost", ` +SELECT `+forumPostColumns+` +FROM web_forumpost +WHERE id = $1`) + +func (d *DB) ForumPost(ctx context.Context, id int64) (*ForumThreadPost, error) { + var p ForumThreadPost + err := d.pool.QueryRow(ctx, qForumPost, id).Scan(&p.ID, &p.ThreadID, &p.Name, + &p.CreatedAt, &p.UpdatedAt, &p.AuthorID, &p.ReplyToID) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("query forum post %d: %w", id, err) + } + return &p, nil +} + +func (d *DB) scanPosts(ctx context.Context, sql string, args ...any) ([]ForumThreadPost, error) { + rows, err := d.pool.Query(ctx, sql, args...) + if err != nil { + return nil, fmt.Errorf("query forum posts: %w", err) + } + defer rows.Close() + + var out []ForumThreadPost + for rows.Next() { + var p ForumThreadPost + if err := rows.Scan(&p.ID, &p.ThreadID, &p.Name, &p.CreatedAt, &p.UpdatedAt, + &p.AuthorID, &p.ReplyToID); err != nil { + return nil, fmt.Errorf("scan forum post: %w", err) + } + out = append(out, p) + } + return out, rows.Err() +} + +type ForumPostContent struct { + Source string + AuthorID *int64 +} + +var qForumPostContents = register("ForumPostContents", ` +SELECT DISTINCT ON (post_id) post_id, source, author_id +FROM web_forumpostversion +WHERE post_id = ANY($1) +ORDER BY post_id, created_at DESC`) + +func (d *DB) ForumPostContents(ctx context.Context, postIDs []int64) (map[int64]ForumPostContent, error) { + rows, err := d.pool.Query(ctx, qForumPostContents, postIDs) + if err != nil { + return nil, fmt.Errorf("query forum post contents: %w", err) + } + defer rows.Close() + + out := make(map[int64]ForumPostContent, len(postIDs)) + for rows.Next() { + var id int64 + var content ForumPostContent + if err := rows.Scan(&id, &content.Source, &content.AuthorID); err != nil { + return nil, fmt.Errorf("scan forum post content: %w", err) + } + out[id] = content + } + return out, rows.Err() +} diff --git a/internal/db/rating.go b/internal/db/rating.go index d355784f..40fc3889 100644 --- a/internal/db/rating.go +++ b/internal/db/rating.go @@ -90,3 +90,24 @@ func (d *DB) HasVoted(ctx context.Context, articleID int64, userID *int64) (bool } return voted, nil } + +// Django reaches for the last row of an unordered set, which it spells as the +// first row of one ordered by descending key. +var qVoteByUser = register("VoteByUser", ` +SELECT rate +FROM web_vote +WHERE article_id = $1 AND user_id IS NOT DISTINCT FROM $2 +ORDER BY id DESC +LIMIT 1`) + +func (d *DB) VoteByUser(ctx context.Context, articleID int64, userID *int64) (float64, bool, error) { + var rate float64 + err := d.pool.QueryRow(ctx, qVoteByUser, articleID, userID).Scan(&rate) + if errors.Is(err, pgx.ErrNoRows) { + return 0, false, nil + } + if err != nil { + return 0, false, fmt.Errorf("query vote on article %d: %w", articleID, err) + } + return rate, true, nil +} diff --git a/internal/db/user.go b/internal/db/user.go index 7d212324..d0d7bc26 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -207,3 +207,23 @@ func (d *DB) UserForSession(ctx context.Context, id int64) (*User, string, error finish() return &u, password, nil } + +var qUsernamesLower = register("UsernamesLower", `SELECT lower(username) FROM web_user`) + +func (d *DB) UsernamesLower(ctx context.Context) (map[string]bool, error) { + rows, err := d.pool.Query(ctx, qUsernamesLower) + if err != nil { + return nil, fmt.Errorf("query usernames: %w", err) + } + defer rows.Close() + + out := make(map[string]bool) + for rows.Next() { + var name string + if err := rows.Scan(&name); err != nil { + return nil, fmt.Errorf("scan username: %w", err) + } + out[name] = true + } + return out, rows.Err() +} diff --git a/internal/repo/perms.go b/internal/repo/perms.go index 94ed1466..4c004372 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -97,3 +97,32 @@ func (p *Perms) Category(name string) (*perms.Object, error) { func (p *Perms) ForumSection(s *db.ForumSection) *perms.Object { return &perms.Object{Kind: perms.KindForumSection, HiddenForUsers: s.IsHiddenForUsers} } + +// A thread reads its role overrides through the article it comments on, so a +// thread of its own carries none. +func (p *Perms) ForumThread(t *db.ForumThread, u *db.User) (*perms.Object, error) { + object := &perms.Object{Kind: perms.KindForumThread, Locked: t.IsLocked} + if t.ArticleID != nil { + article, err := p.db.ArticleByID(p.ctx, *t.ArticleID) + if err != nil { + return nil, err + } + overrides, err := p.db.CategoryOverrides(p.ctx, article.Category) + if err != nil { + return nil, err + } + object.Overrides = overrides + } + if u != nil && t.AuthorID != nil { + object.Author = *t.AuthorID == u.ID + } + return object, nil +} + +func (p *Perms) ForumPost(post *db.ForumThreadPost, thread *perms.Object, u *db.User) *perms.Object { + object := &perms.Object{Kind: perms.KindForumPost, Thread: thread} + if u != nil && post.AuthorID != nil { + object.Author = *post.AuthorID == u.ID + } + return object +} From 911f1c0fba2ece5c5e14093977afbd2b0dc2bc9e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 19:12:14 +0900 Subject: [PATCH 090/428] answer the forum thread page --- internal/articlepage/render.go | 33 +- internal/i18n/locales/zh-hans.json | 12 +- internal/module/module.go | 21 +- internal/module/render_test.go | 2 +- internal/modules/forumthread.go | 690 +++++++++++++++++++++++++++++ internal/pageconfig/user.go | 6 +- internal/repo/modules.go | 57 +++ internal/repo/repo.go | 20 +- 8 files changed, 821 insertions(+), 20 deletions(-) create mode 100644 internal/modules/forumthread.go diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 950379fa..0aa1a20b 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -104,13 +104,19 @@ func (h *Handler) articleBody(req *request, canonical string) (body, error) { if err != nil { return body{}, err } + // Django hands every pass the one dict it built the request from, so a + // module that writes a path parameter is read back by the page options. + req.params = pc.PathParams + // The text pass gets a context of its own. Sharing one would let a module // that writes to it do so twice. + textPC := h.context(req, req.article) text, err := h.deps.Engine.RenderText(req.ctx, source, info, - h.callbacks(req, vars, h.context(req, req.article)), renderer.ModeArticle) + h.callbacks(req, vars, textPC), renderer.ModeArticle) if err != nil { return body{}, err } + req.params = textPC.PathParams rev, err := h.deps.DB.LatestRevNumber(req.ctx, req.article.ID) if err != nil { @@ -223,11 +229,12 @@ func (h *Handler) nav(req *request, name string) (string, string, error) { func (h *Handler) callbacks(req *request, vars *page.Vars, pc *page.Context) *callbacks.Callbacks { users := printuser.New(req.loc, h.deps.Icons) store := repo.New(req.ctx, h.deps.DB, users, repo.Options{ - Loc: req.loc, - Site: req.site, - User: req.user, - Render: func(source string, into *page.Context) (string, error) { return h.nested(req, source, into) }, - Vars: repo.NewVarSource(req.ctx, h.deps.DB, req.site.ID), + Loc: req.loc, + Site: req.site, + User: req.user, + Render: func(source string, into *page.Context) (string, error) { return h.nested(req, source, into) }, + RenderMessage: func(source string) (string, error) { return h.message(req, source) }, + Vars: repo.NewVarSource(req.ctx, h.deps.DB, req.site.ID), }) cb := callbacks.New(req.loc, store) cb.SetPageVars(vars) @@ -251,6 +258,20 @@ func (h *Handler) nested(req *request, source string, pc *page.Context) (string, return html.Body, nil } +func (h *Handler) message(req *request, source string) (string, error) { + pc := page.NewContext(nil, nil, nil, req.user) + info, err := h.pageInfo(req, nil) + if err != nil { + return "", err + } + html, err := h.deps.Engine.RenderHTML(req.ctx, page.ThisVars(source, nil), info, + h.callbacks(req, nil, pc), renderer.ModeMessage) + if err != nil { + return "", err + } + return html.Body, nil +} + func (h *Handler) vars(req *request, of *db.Article) *page.Vars { if of == nil { return nil diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 8032f4fb..a19a2871 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -36,6 +36,14 @@ "module-forumstart-show-hidden": "显示隐藏版块", "module-forumstart-threads": "主题数", "module-forumstart-title": "论坛版块", + "module-forumthread-article": "这是页面 {link} 的讨论", + "module-forumthread-comments-forbidden": "权限不足，无法查看讨论", + "module-forumthread-created-by": "创建者：", + "module-forumthread-date": "日期：", + "module-forumthread-description": "简短描述：", + "module-forumthread-forbidden": "权限不足，无法查看主题", + "module-forumthread-not-found": "未找到主题 \"{name}\"", + "module-forumthread-posts": "帖子数：", "module-listpages-pager-count": "第 {page} 页; 共 {total} 页", "module-listpages-pager-next": "下一页 »", "module-listpages-pager-prev": "« 上一页", @@ -67,5 +75,7 @@ "user-bot": "机器人", "user-bot-tooltip": "机器账户", "user-not-found": "用户 '{name}' 不存在", - "user-system": "系统" + "user-system": "系统", + "vote-tooltip": "讨论文章的评分", + "vote-unrated": "未评分" } diff --git a/internal/module/module.go b/internal/module/module.go index 3298235b..1699e170 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -9,6 +9,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/i18n" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/roles" ) // Error is the failure that reaches the reader as a block on the page rather @@ -49,8 +50,23 @@ type Data interface { ForumCategoryLastPost(categoryID int64) (*db.ForumLastPost, error) ForumCommentLastPost() (*db.ForumLastPost, error) + ForumThread(id int64) (*db.ForumThread, error) + ForumRootPostCount(threadID int64) (int, error) + ForumRootPosts(threadID int64, offset, limit int) ([]db.ForumThreadPost, error) + ForumRootPostIDs(threadID int64) ([]int64, error) + ForumPostReplies(postID int64) ([]db.ForumThreadPost, error) + ForumPost(id int64) (*db.ForumThreadPost, error) + ForumPostContents(postIDs []int64) (map[int64]db.ForumPostContent, error) + UsernamesLower() (map[string]bool, error) + VoteByUser(articleID int64, userID *int64) (float64, bool, error) + UserByID(id int64) (*db.User, error) + ArticleHasAuthor(articleID, userID int64) (bool, error) + RolesByUser(id int64) ([]roles.Role, error) + Subject(user *db.User) (perms.Subject, error) ForumSectionObject(s *db.ForumSection) *perms.Object + ForumThreadObject(t *db.ForumThread, u *db.User) (*perms.Object, error) + ForumPostObject(p *db.ForumThreadPost, thread *perms.Object, u *db.User) *perms.Object } type Env struct { @@ -67,7 +83,10 @@ type Env struct { // Render runs the wikitext a module produced through ftml. A module that // lists pages has to, since what it writes is source and not markup. Render func(source string, pc *page.Context) (string, error) - Vars page.VarSource + + RenderMessage func(source string) (string, error) + + Vars page.VarSource } func (e Env) Text(id string, args ...any) string { diff --git a/internal/module/render_test.go b/internal/module/render_test.go index a85baff6..1c41c231 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"forumcategory", "forumstart", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} + ported := []string{"forumcategory", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/forumthread.go b/internal/modules/forumthread.go new file mode 100644 index 00000000..cd9a4a1f --- /dev/null +++ b/internal/modules/forumthread.go @@ -0,0 +1,690 @@ +package modules + +import ( + "errors" + "net/http" + "regexp" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pageconfig" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/pynum" +) + +func init() { module.Register("forumthread", renderForumThread) } + +const ( + forumPostsPerPage = 10 + ind17 = ind16 + " " +) + +type forumThreadPost struct { + id int64 + name string + isOP bool + author string + authorRate string + createdAt string + content string + options string + replies []forumThreadPost +} + +type forumThreadView struct { + thread db.ForumThread + name string + article *db.Article + + category *db.ForumCategory + sectionName string + sectionURL string + categoryURL string + + createdBy string + createdAt string + total int + pagination string + posts []forumThreadPost + + canReply bool + contentOnly bool + + pathParams string + params string + threadOptions string + newPost string +} + +func renderForumThread(env module.Env, params map[string]string, _ string) (string, error) { + if env.Data == nil || env.RenderMessage == nil { + return "", forumFailed(env) + } + setTitle(env, env.Text("module-forum-title")) + + var path page.PathParams + if env.Page != nil { + path = env.Page.PathParams + } + + thread, err := forumThreadOf(env, path) + if err != nil { + return "", err + } + + subject, err := env.Data.Subject(env.User) + if err != nil { + return "", err + } + object, err := env.Data.ForumThreadObject(thread, env.User) + if err != nil { + return "", err + } + granted := perms.Resolve(subject, object) + + view := forumThreadView{thread: *thread, contentOnly: params["contentonly"] == "yes"} + if err := forumThreadCategory(env, &view, subject, granted); err != nil { + return "", err + } + if err := forumThreadName(env, &view); err != nil { + return "", err + } + setTitle(env, env.Text("module-forum-title-named", "name", view.name)) + + if view.createdBy, err = env.Data.RenderUserByID(thread.AuthorID); err != nil { + return "", err + } + view.createdAt = renderDate(env, thread.CreatedAt) + + if err := forumThreadPosts(env, &view, path, object); err != nil { + return "", err + } + if err := forumThreadConfigs(env, &view, params, subject, granted); err != nil { + return "", err + } + return forumThreadHTML(env, view), nil +} + +// Python rebinds t to the parsed number before the message reads it, so a +// well-formed id is echoed back normalized and a missing one prints as None. +func forumThreadOf(env module.Env, path page.PathParams) (*db.ForumThread, error) { + shown := "None" + if param, ok := path.Lookup("t"); ok { + shown = param.Value + } + notFound := func() error { + setStatus(env, http.StatusNotFound) + return &module.Error{Message: env.Text("module-forumthread-not-found", "name", shown)} + } + + id, err := pynum.Int(shown) + if err != nil { + return nil, notFound() + } + shown = strconv.Itoa(id) + + thread, err := env.Data.ForumThread(int64(id)) + if errors.Is(err, db.ErrNotFound) { + return nil, notFound() + } + if err != nil { + return nil, err + } + return thread, nil +} + +func forumThreadCategory(env module.Env, view *forumThreadView, subject perms.Subject, granted perms.Set) error { + if view.thread.CategoryID != nil { + if !granted.Has(perms.ViewForumThreads) { + return &module.Error{Message: env.Text("module-forumthread-forbidden")} + } + category, err := env.Data.ForumCategory(*view.thread.CategoryID) + if err != nil { + return err + } + view.category = category + } else { + if !granted.Has(perms.ViewArticleComments) { + return &module.Error{Message: env.Text("module-forumthread-comments-forbidden")} + } + if perms.Resolve(subject, nil).Has(perms.ViewForumCategories) { + categories, err := env.Data.ForumCategories() + if err != nil { + return err + } + for i := range categories { + if categories[i].IsForComments { + view.category = &categories[i] + break + } + } + } + } + + if view.category == nil { + return nil + } + section, err := env.Data.ForumSection(view.category.SectionID) + if err != nil { + return err + } + view.sectionName = section.Name + view.sectionURL = forumSectionURL(section.ID, section.Name) + view.categoryURL = forumCategoryURL(view.category.ID, view.category.Name) + return nil +} + +func forumThreadName(env module.Env, view *forumThreadView) error { + view.name = view.thread.Name + if view.thread.ArticleID == nil { + return nil + } + article, err := env.Data.ArticleByID(*view.thread.ArticleID) + if err != nil { + return err + } + view.article = article + if view.thread.CategoryID == nil { + view.name = article.DisplayName() + } + return nil +} + +func forumThreadPosts(env module.Env, view *forumThreadView, path page.PathParams, object *perms.Object) error { + total, err := env.Data.ForumRootPostCount(view.thread.ID) + if err != nil { + return err + } + view.total = total + + current := 1 + if n, err := pynum.Int(path.Get("p")); err == nil { + current = n + } else if n, err := forumThreadPageOfPost(env, view.thread.ID, path); err != nil { + return err + } else { + current = n + } + if current < 1 { + current = 1 + } + maxPage := (total + forumPostsPerPage - 1) / forumPostsPerPage + if maxPage < 1 { + maxPage = 1 + } + if current > maxPage { + current = maxPage + } + + usernames, err := env.Data.UsernamesLower() + if err != nil { + return err + } + posts, err := env.Data.ForumRootPosts(view.thread.ID, (current-1)*forumPostsPerPage, forumPostsPerPage) + if err != nil { + return err + } + if view.posts, err = forumThreadPostInfo(env, view, posts, usernames, object); err != nil { + return err + } + + if env.Page != nil { + env.Page.PathParams = env.Page.PathParams.Put(page.PathParam{Key: "p", Value: strconv.Itoa(current)}) + } + view.pagination = listpages.Pagination(env.Loc, forumThreadShortURL(view.thread.ID), current, maxPage) + return nil +} + +// Naming a post rather than a page means walking up to the root it hangs off, +// since only root posts are paged over. +func forumThreadPageOfPost(env module.Env, threadID int64, path page.PathParams) (int, error) { + param, ok := path.Lookup("post") + if !ok || param.Bare { + return 1, nil + } + id, err := pynum.Int(param.Value) + if err != nil { + return 0, forumFailed(env) + } + + wanted := int64(id) + post, err := env.Data.ForumPost(wanted) + if errors.Is(err, db.ErrNotFound) { + post = nil + } else if err != nil { + return 0, err + } + for post != nil { + if post.ThreadID != threadID { + return 1, nil + } + if post.ReplyToID == nil { + break + } + if post, err = env.Data.ForumPost(*post.ReplyToID); err != nil { + return 0, err + } + wanted = post.ID + } + + ids, err := env.Data.ForumRootPostIDs(threadID) + if err != nil { + return 0, err + } + for i, id := range ids { + if id == wanted { + return i/forumPostsPerPage + 1, nil + } + } + return 1, nil +} + +func forumThreadPostInfo(env module.Env, view *forumThreadView, posts []db.ForumThreadPost, + usernames map[string]bool, object *perms.Object) ([]forumThreadPost, error) { + + if len(posts) == 0 { + return nil, nil + } + ids := make([]int64, 0, len(posts)) + for _, post := range posts { + ids = append(ids, post.ID) + } + contents, err := env.Data.ForumPostContents(ids) + if err != nil { + return nil, err + } + + var mode string + if view.article != nil { + if mode, err = articleRatingMode(env, view.article.Category); err != nil { + return nil, err + } + } + + out := make([]forumThreadPost, 0, len(posts)) + for _, post := range posts { + one := forumThreadPost{ + id: post.ID, + name: post.Name, + isOP: samePerson(view.thread.AuthorID, post.AuthorID), + createdAt: renderDate(env, post.CreatedAt), + } + if one.author, err = env.Data.RenderUserByID(post.AuthorID); err != nil { + return nil, err + } + if view.article != nil { + rate, voted, err := env.Data.VoteByUser(view.article.ID, post.AuthorID) + if err != nil { + return nil, err + } + one.authorRate = forumVoteHTML(env, mode, rate, voted) + + if post.AuthorID != nil { + author, err := env.Data.ArticleHasAuthor(view.article.ID, *post.AuthorID) + if err != nil { + return nil, err + } + if author { + one.isOP = true + } + } + } + + html, err := env.RenderMessage(contents[post.ID].Source) + if err != nil { + return nil, err + } + one.content = highlightMentions(html, usernames) + + replies, err := env.Data.ForumPostReplies(post.ID) + if err != nil { + return nil, err + } + if one.replies, err = forumThreadPostInfo(env, view, replies, usernames, object); err != nil { + return nil, err + } + if one.options, err = forumPostOptions(env, view, post, contents[post.ID], object); err != nil { + return nil, err + } + out = append(out, one) + } + return out, nil +} + +// Django compares two model rows, and two absent authors compare equal, so a +// thread nobody owns marks every unowned post as its opener. +func samePerson(a, b *int64) bool { + if a == nil || b == nil { + return a == nil && b == nil + } + return *a == *b +} + +func forumPostOptions(env module.Env, view *forumThreadView, post db.ForumThreadPost, + content db.ForumPostContent, object *perms.Object) (string, error) { + + subject, err := env.Data.Subject(env.User) + if err != nil { + return "", err + } + granted := perms.Resolve(subject, env.Data.ForumPostObject(&post, object, env.User)) + threadGranted := perms.Resolve(subject, object) + + reviser, err := forumUserJSON(env, content.AuthorID) + if err != nil { + return "", err + } + viewer, err := forumViewerJSON(env) + if err != nil { + return "", err + } + + return pyjson.Marshal(pyjson.Object{ + {Key: "threadId", Value: view.thread.ID}, + {Key: "threadName", Value: view.name}, + {Key: "postId", Value: post.ID}, + {Key: "postName", Value: post.Name}, + {Key: "hasRevisions", Value: !post.CreatedAt.Equal(post.UpdatedAt)}, + {Key: "lastRevisionDate", Value: pyISOFormat(post.UpdatedAt)}, + {Key: "lastRevisionAuthor", Value: reviser}, + {Key: "user", Value: viewer}, + {Key: "canReply", Value: threadGranted.Has(forumReplyPerm(view))}, + {Key: "canEdit", Value: granted.Has(perms.EditForumPosts)}, + {Key: "canDelete", Value: granted.Has(perms.DeleteForumPosts)}, + }) +} + +func forumReplyPerm(view *forumThreadView) string { + if view.article != nil { + return perms.CommentArticles + } + return perms.CreateForumPosts +} + +func forumThreadConfigs(env module.Env, view *forumThreadView, params map[string]string, + subject perms.Subject, granted perms.Set) error { + + view.canReply = granted.Has(forumReplyPerm(view)) + + viewer, err := forumViewerJSON(env) + if err != nil { + return err + } + if view.newPost, err = pyjson.Marshal(pyjson.Object{ + {Key: "threadId", Value: view.thread.ID}, + {Key: "threadName", Value: view.name}, + {Key: "user", Value: viewer}, + }); err != nil { + return err + } + + moveTo, err := forumThreadMoveTo(env, subject, granted) + if err != nil { + return err + } + ownThread := view.thread.ArticleID == nil + var categoryID any + if view.thread.CategoryID != nil { + categoryID = *view.thread.CategoryID + } + if view.threadOptions, err = pyjson.Marshal(pyjson.Object{ + {Key: "threadId", Value: view.thread.ID}, + {Key: "threadName", Value: view.name}, + {Key: "threadDescription", Value: view.thread.Description}, + {Key: "canEdit", Value: ownThread && granted.Has(perms.EditForumThreads)}, + {Key: "canPin", Value: ownThread && granted.Has(perms.PinForumThreads)}, + {Key: "canLock", Value: granted.Has(perms.LockForumThreads)}, + {Key: "canMove", Value: ownThread && granted.Has(perms.MoveForumThreads)}, + {Key: "isLocked", Value: view.thread.IsLocked}, + {Key: "isPinned", Value: view.thread.IsPinned}, + {Key: "moveTo", Value: moveTo}, + {Key: "categoryId", Value: categoryID}, + }); err != nil { + return err + } + + var path page.PathParams + if env.Page != nil { + path = env.Page.PathParams + } + if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + return err + } + view.params, err = pyjson.Marshal(paramsObject(params, nil)) + return err +} + +// The section test asks about the thread rather than the section, which is what +// Python passes, so a section hidden from users never drops out here. +func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) (pyjson.Array, error) { + out := pyjson.Array{} + if !granted.Has(perms.ViewForumSections) { + return out, nil + } + if !perms.Resolve(subject, nil).Has(perms.ViewForumCategories) { + return out, nil + } + + sections, err := env.Data.ForumSections() + if err != nil { + return nil, err + } + categories, err := env.Data.ForumCategories() + if err != nil { + return nil, err + } + for _, section := range sections { + var under pyjson.Array + for _, category := range categories { + if category.SectionID != section.ID { + continue + } + under = append(under, pyjson.Object{ + {Key: "name", Value: "  " + category.Name}, + {Key: "canMove", Value: !category.IsForComments}, + {Key: "id", Value: category.ID}, + }) + } + if len(under) == 0 { + continue + } + out = append(out, pyjson.Object{ + {Key: "name", Value: section.Name}, + {Key: "canMove", Value: false}, + {Key: "id", Value: nil}, + }) + out = append(out, under...) + } + return out, nil +} + +func forumViewerJSON(env module.Env) (pyjson.Object, error) { + if env.User == nil { + return pageconfig.AnonymousUserJSON(env.Loc, true).Object(), nil + } + return forumUserJSON(env, &env.User.ID) +} + +func forumUserJSON(env module.Env, id *int64) (pyjson.Object, error) { + if id == nil { + return pageconfig.SystemUserJSON().Object(), nil + } + user, err := env.Data.UserByID(*id) + if err != nil { + return nil, err + } + userRoles, err := env.Data.RolesByUser(user.ID) + if err != nil { + return nil, err + } + subject, err := env.Data.Subject(user) + if err != nil { + return nil, err + } + editor := perms.Resolve(subject, nil).Has(perms.EditArticles) + return pageconfig.SignedInUserJSON(user, userRoles, true, editor).Object(), nil +} + +var mentionPattern = regexp.MustCompile(`@[\p{L}\p{N}_.-]+`) + +func highlightMentions(html string, usernames map[string]bool) string { + return mentionPattern.ReplaceAllStringFunc(html, func(match string) string { + if usernames[strings.ToLower(match[1:])] { + return `` + match + `` + } + return match + }) +} + +func forumVoteHTML(env module.Env, mode string, rate float64, voted bool) string { + if mode == page.RatingModeDisabled { + return "" + } + title := ` title="` + env.Text("vote-tooltip") + `"` + if !voted { + return `` + escape.HTML(env.Text("vote-unrated")) + `` + } + + var shown string + switch mode { + case page.RatingModeUpDown: + shown = pySignedInt(rate) + case page.RatingModeStars: + shown = strconv.FormatFloat(rate, 'f', 1, 64) + default: + shown = strconv.FormatInt(int64(rate), 10) + } + // Python opens two spans here and closes one. Closing the outer one would + // change the DOM of every post that carries a rating. + return `` + escape.HTML(shown) + `` +} + +func pySignedInt(f float64) string { + n := int64(f) + if n < 0 { + return strconv.FormatInt(n, 10) + } + return "+" + strconv.FormatInt(n, 10) +} + +// Python drops the fractional part when it is zero, so the two shapes are not +// interchangeable. +func pyISOFormat(t time.Time) string { + t = t.UTC() + if t.Nanosecond() == 0 { + return t.Format("2006-01-02T15:04:05-07:00") + } + return t.Format("2006-01-02T15:04:05.000000-07:00") +} + +func forumThreadShortURL(id int64) string { + return "/forum/t-" + strconv.FormatInt(id, 10) +} + +func forumThreadHTML(env module.Env, view forumThreadView) string { + var b strings.Builder + if !view.contentOnly { + b.WriteString("\n" + ind8 + `
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `` + env.Text("module-forum-title") + `` + + "\n" + ind16) + if view.category != nil { + b.WriteString("\n" + ind16 + `»` + + "\n" + ind16 + `` + escape.HTML(view.sectionName) + `` + + "\n" + ind16 + `»` + + "\n" + ind16 + `` + escape.HTML(view.category.Name) + `` + + "\n" + ind16) + } + b.WriteString("\n" + ind16 + `»` + + "\n" + ind16 + escape.HTML(view.name) + + "\n" + ind12 + `
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `
` + + "\n" + ind20 + env.Text("module-forumthread-created-by") + view.createdBy + + "\n" + ind20 + `
` + + "\n" + ind20 + env.Text("module-forumthread-date") + view.createdAt + + "\n" + ind20 + `
` + + "\n" + ind20 + env.Text("module-forumthread-posts") + strconv.Itoa(view.total) + + "\n" + ind16 + `
` + + "\n" + ind16) + switch { + case view.article != nil: + link := `` + + escape.HTML(view.article.DisplayName()) + `` + b.WriteString("\n" + ind20 + env.Text("module-forumthread-article", "link", link) + " " + + "\n" + ind16) + case view.thread.Description != "": + b.WriteString("\n" + ind20 + `
` + + "\n" + ind24 + env.Text("module-forumthread-description") + + "\n" + ind20 + `
` + + "\n" + ind20 + escape.HTML(view.thread.Description) + + "\n" + ind16) + } + b.WriteString("\n" + ind12 + `
` + + "\n" + ind12 + `
` + + "\n" + ind12) + } + + b.WriteString("\n" + ind12 + `
` + + "\n" + ind16 + `
` + + "\n" + ind20 + view.pagination + + "\n" + ind20 + forumPostsHTML(view.posts) + + "\n" + ind20 + view.pagination + + "\n" + ind16 + `
` + + "\n" + ind12 + `
` + + "\n" + ind12) + if view.canReply && !view.contentOnly { + b.WriteString("\n" + ind16 + `
` + + "\n" + ind12) + } + b.WriteString("\n" + ind8 + `
`) + return b.String() +} + +func forumPostsHTML(posts []forumThreadPost) string { + var b strings.Builder + for _, post := range posts { + head := `
` + if post.isOP { + head = `
` + } + b.WriteString("\n" + ind8 + `
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `
` + + "\n" + ind20 + head + + "\n" + ind24 + `
` + + "\n" + ind28 + escape.HTML(post.name) + + "\n" + ind24 + `
` + + "\n" + ind24 + `
` + + "\n" + ind28 + post.author + " " + post.createdAt + " " + post.authorRate + + "\n" + ind24 + `
` + + "\n" + ind20 + `
` + + "\n" + ind20 + `
` + + "\n" + ind24 + post.content + + "\n" + ind20 + `
` + + "\n" + ind20 + `
` + + "\n" + ind16 + `
` + + "\n" + ind12 + `
` + + "\n" + ind12) + if len(post.replies) > 0 { + b.WriteString("\n" + ind16 + forumPostsHTML(post.replies) + + "\n" + ind12) + } + b.WriteString("\n" + ind8 + `
` + + "\n" + ind8) + } + return b.String() +} diff --git a/internal/pageconfig/user.go b/internal/pageconfig/user.go index c11531c2..a1a06d66 100644 --- a/internal/pageconfig/user.go +++ b/internal/pageconfig/user.go @@ -27,7 +27,7 @@ type UserJSON struct { Roles any } -func (u UserJSON) object() pyjson.Object { +func (u UserJSON) Object() pyjson.Object { return pyjson.Object{ {Key: "type", Value: u.Type}, {Key: "id", Value: u.ID}, @@ -44,7 +44,7 @@ func (u UserJSON) object() pyjson.Object { } } -func (u UserJSON) JSON() (string, error) { return pyjson.Marshal(u.object()) } +func (u UserJSON) JSON() (string, error) { return pyjson.Marshal(u.Object()) } func SystemUserJSON() UserJSON { return UserJSON{Type: typeSystem, IsActive: true, Editor: false} @@ -115,7 +115,7 @@ func (l LoginStatus) JSON(loc *i18n.Localizer) (string, error) { user = SignedInUserJSON(l.User, l.Roles, true, l.CanEditArticles) } return pyjson.Marshal(pyjson.Object{ - {Key: "user", Value: user.object()}, + {Key: "user", Value: user.Object()}, {Key: "notificationCount", Value: l.NotificationCount}, }) } diff --git a/internal/repo/modules.go b/internal/repo/modules.go index f696db93..88eb58f9 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -6,6 +6,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/printuser" + "github.com/WikitTeam/ProjectWikit/internal/roles" ) type moduleData struct{ repo *Repository } @@ -163,3 +164,59 @@ func (m moduleData) ForumThreadPostCount(threadID int64) (int, error) { func (m moduleData) ForumThreadLastPost(threadID int64, count int) (*db.ForumPost, error) { return m.repo.db.ForumThreadLastPost(m.repo.ctx, threadID, count) } + +func (m moduleData) ForumThread(id int64) (*db.ForumThread, error) { + return m.repo.db.ForumThread(m.repo.ctx, id) +} + +func (m moduleData) ForumRootPostCount(threadID int64) (int, error) { + return m.repo.db.ForumRootPostCount(m.repo.ctx, threadID) +} + +func (m moduleData) ForumRootPosts(threadID int64, offset, limit int) ([]db.ForumThreadPost, error) { + return m.repo.db.ForumRootPosts(m.repo.ctx, threadID, offset, limit) +} + +func (m moduleData) ForumRootPostIDs(threadID int64) ([]int64, error) { + return m.repo.db.ForumRootPostIDs(m.repo.ctx, threadID) +} + +func (m moduleData) ForumPostReplies(postID int64) ([]db.ForumThreadPost, error) { + return m.repo.db.ForumPostReplies(m.repo.ctx, postID) +} + +func (m moduleData) ForumPost(id int64) (*db.ForumThreadPost, error) { + return m.repo.db.ForumPost(m.repo.ctx, id) +} + +func (m moduleData) ForumPostContents(postIDs []int64) (map[int64]db.ForumPostContent, error) { + return m.repo.db.ForumPostContents(m.repo.ctx, postIDs) +} + +func (m moduleData) UsernamesLower() (map[string]bool, error) { + return m.repo.db.UsernamesLower(m.repo.ctx) +} + +func (m moduleData) VoteByUser(articleID int64, userID *int64) (float64, bool, error) { + return m.repo.db.VoteByUser(m.repo.ctx, articleID, userID) +} + +func (m moduleData) UserByID(id int64) (*db.User, error) { + return m.repo.db.UserByID(m.repo.ctx, id) +} + +func (m moduleData) ArticleHasAuthor(articleID, userID int64) (bool, error) { + return m.repo.db.ArticleHasAuthor(m.repo.ctx, articleID, userID) +} + +func (m moduleData) RolesByUser(id int64) ([]roles.Role, error) { + return m.repo.db.RolesByUser(m.repo.ctx, id) +} + +func (m moduleData) ForumThreadObject(t *db.ForumThread, u *db.User) (*perms.Object, error) { + return NewPerms(m.repo.ctx, m.repo.db).ForumThread(t, u) +} + +func (m moduleData) ForumPostObject(p *db.ForumThreadPost, thread *perms.Object, u *db.User) *perms.Object { + return NewPerms(m.repo.ctx, m.repo.db).ForumPost(p, thread, u) +} diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 92eb11f4..d973b64a 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -37,7 +37,10 @@ type Options struct { // Render is how a module runs the wikitext it produced. The engine is not // reachable from here, so the caller that owns it supplies this. Render func(source string, pc *page.Context) (string, error) - Vars page.VarSource + + RenderMessage func(source string) (string, error) + + Vars page.VarSource } var _ callbacks.Repository = (*Repository)(nil) @@ -86,13 +89,14 @@ func (r *Repository) IncludeSources(refs []renderer.IncludeRef) ([]renderer.Fetc func (r *Repository) RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) { html, err := module.Render(module.Env{ - Page: pc, - Loc: r.opts.Loc, - Site: r.opts.Site, - User: r.opts.User, - Data: moduleData{repo: r}, - Render: r.opts.Render, - Vars: r.opts.Vars, + Page: pc, + Loc: r.opts.Loc, + Site: r.opts.Site, + User: r.opts.User, + Data: moduleData{repo: r}, + Render: r.opts.Render, + RenderMessage: r.opts.RenderMessage, + Vars: r.opts.Vars, }, name, params, body) var moduleErr *module.Error if errors.As(err, &moduleErr) { From 7cb34369989dd743463f37820b2a41a5ae525ccf Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 19:12:20 +0900 Subject: [PATCH 091/428] check the thread page against django --- internal/repo/forumthread_test.go | 210 + internal/repo/testdata/forumthread.golden | 3501 +++++++++++++++++ .../repo/testdata/forumthread_corpus.json | 137 + internal/repo/testdata/oracle_forumthread.py | 74 + 4 files changed, 3922 insertions(+) create mode 100644 internal/repo/forumthread_test.go create mode 100644 internal/repo/testdata/forumthread.golden create mode 100644 internal/repo/testdata/forumthread_corpus.json create mode 100644 internal/repo/testdata/oracle_forumthread.py diff --git a/internal/repo/forumthread_test.go b/internal/repo/forumthread_test.go new file mode 100644 index 00000000..7c05db97 --- /dev/null +++ b/internal/repo/forumthread_test.go @@ -0,0 +1,210 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "os" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/printuser" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/renderer/sidecar" +) + +const ( + forumThreadGolden = "testdata/forumthread.golden" + forumThreadCorpus = "testdata/forumthread_corpus.json" +) + +type forumThreadCase struct { + Name string `json:"name"` + Viewer string `json:"viewer"` + Thread string `json:"thread,omitempty"` + Article string `json:"article,omitempty"` + Post string `json:"post,omitempty"` + PostIn string `json:"postIn,omitempty"` + Params map[string]string `json:"params,omitempty"` + Path map[string]string `json:"path,omitempty"` +} + +func forumThreadCases() []forumThreadCase { + return []forumThreadCase{ + {Name: "deep", Viewer: "", Thread: "Probe Deep Thread"}, + {Name: "deep-signed-in", Viewer: "probe-author", Thread: "Probe Deep Thread"}, + {Name: "deep-content-only", Viewer: "", Thread: "Probe Deep Thread", Params: map[string]string{"contentonly": "yes"}}, + {Name: "locked", Viewer: "probevoter", Thread: "Probe Locked Thread"}, + {Name: "long-first-page", Viewer: "", Thread: "Probe Long Thread"}, + {Name: "long-second-page", Viewer: "", Thread: "Probe Long Thread", Path: map[string]string{"p": "2"}}, + {Name: "long-past-the-end", Viewer: "", Thread: "Probe Long Thread", Path: map[string]string{"p": "99"}}, + {Name: "long-below-one", Viewer: "", Thread: "Probe Long Thread", Path: map[string]string{"p": "-3"}}, + {Name: "long-junk-page", Viewer: "", Thread: "Probe Long Thread", Path: map[string]string{"p": "later"}}, + {Name: "by-post-on-second-page", Viewer: "", Thread: "Probe Long Thread", Post: "Probe Long Thread post 10"}, + {Name: "by-nested-reply", Viewer: "", Thread: "Probe Deep Thread", Post: "Probe Deep reply 0 0"}, + {Name: "by-post-in-another-thread", Viewer: "", Thread: "Probe Long Thread", Post: "Probe Thread post 0", PostIn: "Probe Thread"}, + {Name: "by-missing-post", Viewer: "", Thread: "Probe Long Thread", Path: map[string]string{"post": "999999"}}, + {Name: "by-junk-post", Viewer: "", Thread: "Probe Long Thread", Path: map[string]string{"post": "later"}}, + {Name: "comments", Viewer: "", Article: "probe:full"}, + {Name: "comments-signed-in", Viewer: "probevoter", Article: "probe:full"}, + {Name: "comments-stars", Viewer: "", Article: "probestars:rated"}, + {Name: "missing", Viewer: "", Path: map[string]string{"t": "999999"}}, + {Name: "unparsable", Viewer: "", Path: map[string]string{"t": "not-a-number"}}, + {Name: "padded-id", Viewer: "", Path: map[string]string{"t": "0999999"}}, + {Name: "no-parameter", Viewer: ""}, + } +} + +func TestForumThreadMatchesGolden(t *testing.T) { + bin := os.Getenv(sidecar.EnvBinary) + if bin == "" { + t.Skipf("%s not set, skipping the thread test", sidecar.EnvBinary) + } + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := forumThreadCases() + + rend, err := sidecar.New(bin) + if err != nil { + t.Fatalf("sidecar.New(%q) err = %v, want nil", bin, err) + } + t.Cleanup(func() { rend.Close() }) + + site, err := d.SiteByHosts(ctx, []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) + } + article, err := d.ArticleByName(ctx, "forum:thread") + if err != nil { + t.Fatalf("ArticleByName(forum:thread) err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + var viewer *db.User + if c.Viewer != "" { + viewer, err = d.UserByUsername(ctx, c.Viewer) + if err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + } + + path := forumThreadPath(t, ctx, d, c) + pc := page.NewContext(article, article, path, viewer) + r := newThreadRepo(ctx, d, users, loc, site, viewer, rend) + + body, err := r.RenderModule(pc, "ForumThread", c.Params, "") + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\ntitle: %s\nstatus: %d\n%s\n", c.Name, pc.Title, pc.Status, body) + } + compareGolden(t, b.String(), cases, forumThreadGolden, forumThreadCorpus) +} + +func newThreadRepo(ctx context.Context, d *db.DB, users *printuser.Renderer, loc *i18n.Localizer, + site *db.Site, viewer *db.User, rend renderer.Renderer) *Repository { + + var r *Repository + render := func(source string) (string, error) { + cb := callbacks.New(loc, r) + cb.SetContext(page.NewContext(nil, nil, nil, viewer)) + info := renderer.PageInfo{Site: site.Slug, Domain: site.Domain, MediaDomain: site.MediaDomain} + html, err := rend.RenderHTML(ctx, source, info, cb, renderer.ModeMessage) + if err != nil { + return "", err + } + return html.Body, nil + } + r = New(ctx, d, users, Options{Loc: loc, Site: site, User: viewer, RenderMessage: render}) + return r +} + +func forumThreadPath(t *testing.T, ctx context.Context, d *db.DB, c forumThreadCase) page.PathParams { + t.Helper() + path := sortedPath(c.Path) + + switch { + case c.Thread != "": + path = path.Put(page.PathParam{Key: "t", Value: fmt.Sprint(threadIDByName(t, ctx, d, c.Thread))}) + case c.Article != "": + found, err := d.ArticleByName(ctx, c.Article) + if err != nil { + t.Fatalf("ArticleByName(%q) err = %v, want nil", c.Article, err) + } + info, err := d.CommentInfo(ctx, found.ID) + if err != nil { + t.Fatalf("CommentInfo(%q) err = %v, want nil", c.Article, err) + } + path = path.Put(page.PathParam{Key: "t", Value: fmt.Sprint(info.ThreadID)}) + } + if c.Post != "" { + in := c.PostIn + if in == "" { + in = c.Thread + } + id := postIDByName(t, ctx, d, threadIDByName(t, ctx, d, in), c.Post) + path = path.Put(page.PathParam{Key: "post", Value: fmt.Sprint(id)}) + } + return path +} + +func threadIDByName(t *testing.T, ctx context.Context, d *db.DB, name string) int64 { + t.Helper() + categories, err := d.ForumCategories(ctx) + if err != nil { + t.Fatalf("ForumCategories() err = %v, want nil", err) + } + for _, category := range categories { + threads, err := d.ForumThreads(ctx, category.ID, db.ForumThreadsByStart, 0, 1000) + if err != nil { + t.Fatalf("ForumThreads(%d) err = %v, want nil", category.ID, err) + } + for _, thread := range threads { + if thread.Name == name { + return thread.ID + } + } + } + t.Fatalf("ForumThreads() has no thread named %q, want one seeded", name) + return 0 +} + +func postIDByName(t *testing.T, ctx context.Context, d *db.DB, threadID int64, name string) int64 { + t.Helper() + roots, err := d.ForumRootPosts(ctx, threadID, 0, 1000) + if err != nil { + t.Fatalf("ForumRootPosts(%d) err = %v, want nil", threadID, err) + } + if id, ok := findPost(t, ctx, d, roots, name); ok { + return id + } + t.Fatalf("ForumRootPosts(%d) has no post named %q, want one seeded", threadID, name) + return 0 +} + +func findPost(t *testing.T, ctx context.Context, d *db.DB, posts []db.ForumThreadPost, name string) (int64, bool) { + t.Helper() + for _, post := range posts { + if post.Name == name { + return post.ID, true + } + replies, err := d.ForumPostReplies(ctx, post.ID) + if err != nil { + t.Fatalf("ForumPostReplies(%d) err = %v, want nil", post.ID, err) + } + if id, ok := findPost(t, ctx, d, replies, name); ok { + return id, true + } + } + return 0, false +} diff --git a/internal/repo/testdata/forumthread.golden b/internal/repo/testdata/forumthread.golden new file mode 100644 index 00000000..d25f1c42 --- /dev/null +++ b/internal/repo/testdata/forumthread.golden @@ -0,0 +1,3501 @@ +=== deep +title: 论坛 — Probe Deep Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Deep Thread +
+
+
+ 创建者： + + Probe Author + + Probe Author + + + + + +
+ 日期：03.04.2021 05:30 +
+ 帖子数：2 +
+ +
+ 简短描述： +
+ Probe Deep Thread description + +
+
+ +
+
+ + +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+
+
+

Probe Deep Thread body 0

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+
+
+

a reply to a reply

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+
+
+

a reply the site itself made

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+ + +
+
+ +
+=== deep-signed-in +title: 论坛 — Probe Deep Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Deep Thread +
+
+
+ 创建者： + + Probe Author + + Probe Author + + + + + +
+ 日期：03.04.2021 05:30 +
+ 帖子数：2 +
+ +
+ 简短描述： +
+ Probe Deep Thread description + +
+
+ +
+
+ + +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+
+
+

Probe Deep Thread body 0

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+
+
+

a reply to a reply

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+
+
+

a reply the site itself made

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+ + +
+
+ +
+=== deep-content-only +title: 论坛 — Probe Deep Thread +status: 200 + +
+
+ + +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+
+
+

Probe Deep Thread body 0

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+
+
+

a reply to a reply

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+
+
+

a reply the site itself made

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+ + +
+
+ +
+=== locked +title: 论坛 — Probe Locked Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Chat + + » + Probe Locked Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:07 +
+ 帖子数：1 +
+ +
+ 简短描述： +
+ Probe Locked Thread description + +
+
+ +
+
+ + +
+
+
+
+
+ Probe Locked Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:15 +
+
+
+

Probe Locked Thread body 0

+
+
+
+
+ +
+ + +
+
+ +
+=== long-first-page +title: 论坛 — Probe Long Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Long Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:31 +
+ 帖子数：12 +
+ +
+ 简短描述： +
+ Probe Long Thread description + +
+
+ +
+
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+ +
+=== long-second-page +title: 论坛 — Probe Long Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Long Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:31 +
+ 帖子数：12 +
+ +
+ 简短描述： +
+ Probe Long Thread description + +
+
+ +
+
+
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+ +
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+
+
+ +
+=== long-past-the-end +title: 论坛 — Probe Long Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Long Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:31 +
+ 帖子数：12 +
+ +
+ 简短描述： +
+ Probe Long Thread description + +
+
+ +
+
+
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+ +
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+
+
+ +
+=== long-below-one +title: 论坛 — Probe Long Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Long Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:31 +
+ 帖子数：12 +
+ +
+ 简短描述： +
+ Probe Long Thread description + +
+
+ +
+
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+ +
+=== long-junk-page +title: 论坛 — Probe Long Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Long Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:31 +
+ 帖子数：12 +
+ +
+ 简短描述： +
+ Probe Long Thread description + +
+
+ +
+
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+ +
+=== by-post-on-second-page +title: 论坛 — Probe Long Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Long Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:31 +
+ 帖子数：12 +
+ +
+ 简短描述： +
+ Probe Long Thread description + +
+
+ +
+
+
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+ +
+ 第 2 页; 共 2 页 + + « 上一页 + + + + 1 + + + + + + + + 2 + + + +
+
+
+ +
+=== by-nested-reply +title: 论坛 — Probe Deep Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Deep Thread +
+
+
+ 创建者： + + Probe Author + + Probe Author + + + + + +
+ 日期：03.04.2021 05:30 +
+ 帖子数：2 +
+ +
+ 简短描述： +
+ Probe Deep Thread description + +
+
+ +
+
+ + +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+
+
+

Probe Deep Thread body 0

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+
+
+

a reply to a reply

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+
+
+

a reply the site itself made

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+ + +
+
+ +
+=== by-post-in-another-thread +title: 论坛 — Probe Long Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Long Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:31 +
+ 帖子数：12 +
+ +
+ 简短描述： +
+ Probe Long Thread description + +
+
+ +
+
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+ +
+=== by-missing-post +title: 论坛 — Probe Long Thread +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Long Thread +
+
+
+ 创建者： + + probevoter + + probevoter + + + + + +
+ 日期：03.04.2021 05:31 +
+ 帖子数：12 +
+ +
+ 简短描述： +
+ Probe Long Thread description + +
+
+ +
+
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+ +
+=== by-junk-post +title: 论坛 — Probe Long Thread +status: 200 +!error: 处理模块 'ForumThread' 时出错 +=== comments +title: 论坛 — Probe Full +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Comments + + » + Probe Full +
+
+
+ 创建者：系统 +
+ 日期：08.26.2026 13:01 +
+ 帖子数：2 +
+ + 这是页面 Probe Full 的讨论 + +
+
+ +
+
+ + +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+
+
+

probe comment 0

+
+
+
+
+ +
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+
+
+

probe comment 1

+
+
+
+
+ +
+ + +
+
+ +
+=== comments-signed-in +title: 论坛 — Probe Full +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Comments + + » + Probe Full +
+
+
+ 创建者：系统 +
+ 日期：08.26.2026 13:01 +
+ 帖子数：2 +
+ + 这是页面 Probe Full 的讨论 + +
+
+ +
+
+ + +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+
+
+

probe comment 0

+
+
+
+
+ +
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+
+
+

probe comment 1

+
+
+
+
+ +
+ + +
+
+ +
+=== comments-stars +title: 论坛 — Probe Rated +status: 200 + +
+
+ 论坛 + + » + Probe Open + » + Probe Comments + + » + Probe Rated +
+
+
+ 创建者：系统 +
+ 日期：08.26.2026 13:34 +
+ 帖子数：2 +
+ + 这是页面 Probe Rated 的讨论 + +
+
+ +
+
+ + +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:39 4.0 +
+
+
+

probe comment 0

+
+
+
+
+ +
+ +
+
+
+
+
+ probe post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:40 5.0 +
+
+
+

probe comment 1

+
+
+
+
+ +
+ + +
+
+ +
+=== missing +title: 论坛 +status: 404 +!error: 未找到主题 "999999" +=== unparsable +title: 论坛 +status: 404 +!error: 未找到主题 "not-a-number" +=== padded-id +title: 论坛 +status: 404 +!error: 未找到主题 "999999" +=== no-parameter +title: 论坛 +status: 404 +!error: 未找到主题 "None" diff --git a/internal/repo/testdata/forumthread_corpus.json b/internal/repo/testdata/forumthread_corpus.json new file mode 100644 index 00000000..6cbb150c --- /dev/null +++ b/internal/repo/testdata/forumthread_corpus.json @@ -0,0 +1,137 @@ +[ + { + "name": "deep", + "viewer": "", + "thread": "Probe Deep Thread" + }, + { + "name": "deep-signed-in", + "viewer": "probe-author", + "thread": "Probe Deep Thread" + }, + { + "name": "deep-content-only", + "viewer": "", + "thread": "Probe Deep Thread", + "params": { + "contentonly": "yes" + } + }, + { + "name": "locked", + "viewer": "probevoter", + "thread": "Probe Locked Thread" + }, + { + "name": "long-first-page", + "viewer": "", + "thread": "Probe Long Thread" + }, + { + "name": "long-second-page", + "viewer": "", + "thread": "Probe Long Thread", + "path": { + "p": "2" + } + }, + { + "name": "long-past-the-end", + "viewer": "", + "thread": "Probe Long Thread", + "path": { + "p": "99" + } + }, + { + "name": "long-below-one", + "viewer": "", + "thread": "Probe Long Thread", + "path": { + "p": "-3" + } + }, + { + "name": "long-junk-page", + "viewer": "", + "thread": "Probe Long Thread", + "path": { + "p": "later" + } + }, + { + "name": "by-post-on-second-page", + "viewer": "", + "thread": "Probe Long Thread", + "post": "Probe Long Thread post 10" + }, + { + "name": "by-nested-reply", + "viewer": "", + "thread": "Probe Deep Thread", + "post": "Probe Deep reply 0 0" + }, + { + "name": "by-post-in-another-thread", + "viewer": "", + "thread": "Probe Long Thread", + "post": "Probe Thread post 0", + "postIn": "Probe Thread" + }, + { + "name": "by-missing-post", + "viewer": "", + "thread": "Probe Long Thread", + "path": { + "post": "999999" + } + }, + { + "name": "by-junk-post", + "viewer": "", + "thread": "Probe Long Thread", + "path": { + "post": "later" + } + }, + { + "name": "comments", + "viewer": "", + "article": "probe:full" + }, + { + "name": "comments-signed-in", + "viewer": "probevoter", + "article": "probe:full" + }, + { + "name": "comments-stars", + "viewer": "", + "article": "probestars:rated" + }, + { + "name": "missing", + "viewer": "", + "path": { + "t": "999999" + } + }, + { + "name": "unparsable", + "viewer": "", + "path": { + "t": "not-a-number" + } + }, + { + "name": "padded-id", + "viewer": "", + "path": { + "t": "0999999" + } + }, + { + "name": "no-parameter", + "viewer": "" + } +] diff --git a/internal/repo/testdata/oracle_forumthread.py b/internal/repo/testdata/oracle_forumthread.py new file mode 100644 index 00000000..9094dcfa --- /dev/null +++ b/internal/repo/testdata/oracle_forumthread.py @@ -0,0 +1,74 @@ +"""Records what the ForumThread module renders for a reader browsing a thread. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e FORUMTHREAD_CORPUS="$(cat internal/repo/testdata/forumthread_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_forumthread.py + +Threads and posts are looked up by name so the corpus does not depend on what +the sequence handed out. Compare the output with +internal/repo/testdata/forumthread.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.forum import ForumPost, ForumThread +from web.models.site import Site +from web.models.users import User +from web.util.json import replace_json_dumps_default + +replace_json_dumps_default() + +CORPUS = json.loads(os.environ['FORUMTHREAD_CORPUS']) + + +def thread_id(case): + if case.get('thread'): + return ForumThread.objects.get(name=case['thread'], category__isnull=False).id + article = articles.get_article(case['article']) + if article is None: + raise SystemExit('%s is missing; run oracle_seed.py first' % case['article']) + return ForumThread.objects.get(article=article).id + + +def path_params(case): + params = dict(case.get('path') or {}) + if case.get('thread') or case.get('article'): + params['t'] = str(thread_id(case)) + if case.get('post'): + params['post'] = str(ForumPost.objects.get(name=case['post']).id) + return params + + +def main(): + article = articles.get_article('forum:thread') + if article is None: + raise SystemExit('forum:thread is missing; run manage.py seed first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + if case['viewer']: + viewer = User.objects.get(username=case['viewer']) + threadvars.put('current_user', viewer) + context = RenderContext(article, article, path_params(case), viewer) + try: + body = modules.render_module('ForumThread', context, case.get('params') or {}) + except ModuleError as error: + body = '!error: %s' % error.message + out.append('=== %s\ntitle: %s\nstatus: %d\n%s\n' % ( + case['name'], context.title, context.status, body)) + sys.stdout.write(''.join(out)) + + +main() From 22350bdca3ef121954cf94a94e8a6876cc9ed659 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 19:12:20 +0900 Subject: [PATCH 092/428] run the thread page in the page corpus --- internal/difftest/corpus/articles.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index c5d52482..6bd13445 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -58,7 +58,9 @@ OPTIONS /probe:full /forum:category /forum/c-999999 /forum/c-999999/sort/start -!/forum:thread +/forum:thread +/forum/t-999999 +/forum/t-999999/p/2 !/forum:new-thread /search:site /search:site/q/scp From 34b451778d5c99d2f5a6a6bc0cdb40bf11e99167 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 19:35:48 +0900 Subject: [PATCH 093/428] fix --- .gitattributes | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..6c929d48 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.golden -text From 317fef41e4b24937a6b852e82c35c51b4aad66e9 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 19:36:58 +0900 Subject: [PATCH 094/428] fix fix --- internal/articlepage/render.go | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 0aa1a20b..123c5552 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -104,12 +104,9 @@ func (h *Handler) articleBody(req *request, canonical string) (body, error) { if err != nil { return body{}, err } - // Django hands every pass the one dict it built the request from, so a - // module that writes a path parameter is read back by the page options. + req.params = pc.PathParams - // The text pass gets a context of its own. Sharing one would let a module - // that writes to it do so twice. textPC := h.context(req, req.article) text, err := h.deps.Engine.RenderText(req.ctx, source, info, h.callbacks(req, vars, textPC), renderer.ModeArticle) From 98f851531e511d4b18280feb9fdbae0d47f373b1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 19:48:21 +0900 Subject: [PATCH 095/428] pin go files to lf so gofmt and git agree --- .gitattributes | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitattributes b/.gitattributes index 6c929d48..4f2a678b 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,5 @@ +# Golden files are compared byte for byte, so line endings must survive checkout. *.golden -text + +# gofmt writes LF, so a checkout that hands back CRLF makes every file look unformatted. +*.go text eol=lf From 9fd3909b17c7e6229699a55b3515769f96a49f11 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 20:58:58 +0900 Subject: [PATCH 096/428] answer the forum new thread page --- internal/i18n/locales/zh-hans.json | 8 +-- internal/module/render_test.go | 2 +- internal/modules/forumcategory.go | 6 +-- internal/modules/forumnewthread.go | 85 ++++++++++++++++++++++++++++++ 4 files changed, 94 insertions(+), 7 deletions(-) create mode 100644 internal/modules/forumnewthread.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index a19a2871..c4200138 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -15,21 +15,23 @@ "module-failed": "处理模块 '{name}' 时出错", "module-forum-author": "作者：", "module-forum-last-post": "最后回复", + "module-forum-new-thread": "创建主题", "module-forum-not-found": "未找到版块 \"{name}\"", + "module-forum-posts": "帖子数：", + "module-forum-threads": "主题数：", "module-forum-title": "论坛", "module-forum-title-named": "论坛 — {name}", "module-forum-view-post": "查看", "module-forumcategory-forbidden": "权限不足，无法查看该版块", - "module-forumcategory-new-thread": "创建主题", "module-forumcategory-pinned": "置顶：", - "module-forumcategory-posts": "帖子数：", "module-forumcategory-replies": "回复数", "module-forumcategory-sort": "排序方式：", "module-forumcategory-sort-reply": "按最后回复时间", "module-forumcategory-sort-start": "按主题创建时间", "module-forumcategory-started": "创建信息", "module-forumcategory-thread": "主题标题", - "module-forumcategory-threads": "主题数：", + "module-forumnewthread-forbidden": "权限不足，无法创建主题", + "module-forumnewthread-style-note": "希望没人试图给论坛页面加样式", "module-forumstart-hide-hidden": "隐藏隐藏版块", "module-forumstart-posts": "帖子数", "module-forumstart-section": "版块名称", diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 1c41c231..d282e3f6 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"forumcategory", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} + ported := []string{"forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/forumcategory.go b/internal/modules/forumcategory.go index 89377127..e9b7ce39 100644 --- a/internal/modules/forumcategory.go +++ b/internal/modules/forumcategory.go @@ -234,9 +234,9 @@ func forumCategoryHTML(env module.Env, view forumCategoryView) string { "\n" + ind12 + `` + "\n" + ind12 + `
` + "\n" + ind16 + `
` + - "\n" + ind20 + env.Text("module-forumcategory-threads") + strconv.Itoa(view.counts.Threads) + + "\n" + ind20 + env.Text("module-forum-threads") + strconv.Itoa(view.counts.Threads) + "\n" + ind20 + `
` + - "\n" + ind20 + env.Text("module-forumcategory-posts") + strconv.Itoa(view.counts.Posts) + + "\n" + ind20 + env.Text("module-forum-posts") + strconv.Itoa(view.counts.Posts) + "\n" + ind16 + `
` + "\n" + ind16 + escape.HTML(category.Description) + "\n" + ind12 + `
` + @@ -259,7 +259,7 @@ func forumCategoryHTML(env module.Env, view forumCategoryView) string { if !category.IsForComments && view.canCreate { b.WriteString("\n" + ind16 + `
` + "\n" + ind20 + `` + - env.Text("module-forumcategory-new-thread") + `` + + env.Text("module-forum-new-thread") + `` + "\n" + ind16 + `
` + "\n" + ind12) } diff --git a/internal/modules/forumnewthread.go b/internal/modules/forumnewthread.go new file mode 100644 index 00000000..31cca5fe --- /dev/null +++ b/internal/modules/forumnewthread.go @@ -0,0 +1,85 @@ +package modules + +import ( + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" +) + +func init() { module.Register("forumnewthread", renderForumNewThread) } + +func renderForumNewThread(env module.Env, _ map[string]string, _ string) (string, error) { + if env.Data == nil { + return "", forumFailed(env) + } + setTitle(env, env.Text("module-forum-new-thread")) + + var path page.PathParams + if env.Page != nil { + path = env.Page.PathParams + } + + category, err := forumCategoryOf(env, path) + if err != nil { + return "", err + } + + subject, err := env.Data.Subject(env.User) + if err != nil { + return "", err + } + if !perms.Resolve(subject, nil).Has(perms.CreateForumThreads) { + return "", &module.Error{Message: env.Text("module-forumnewthread-forbidden")} + } + + counts, err := env.Data.ForumCategoryCounts(category.ID) + if err != nil { + return "", err + } + section, err := env.Data.ForumSection(category.SectionID) + if err != nil { + return "", err + } + viewer, err := forumViewerJSON(env) + if err != nil { + return "", err + } + + canonical := forumCategoryURL(category.ID, category.Name) + config, err := pyjson.Marshal(pyjson.Object{ + {Key: "categoryId", Value: category.ID}, + {Key: "user", Value: viewer}, + {Key: "cancelUrl", Value: canonical}, + }) + if err != nil { + return "", err + } + + var b strings.Builder + b.WriteString(`
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `` + env.Text("module-forum-title") + `` + + "\n" + ind16 + `»` + + "\n" + ind16 + `` + + escape.HTML(section.Name+" / "+category.Name) + `` + + "\n" + ind16 + `»` + + "\n" + ind16 + env.Text("module-forum-new-thread") + + "\n" + ind12 + `
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `
` + + "\n" + ind20 + env.Text("module-forum-threads") + strconv.Itoa(counts.Threads) + + "\n" + ind20 + `
` + + "\n" + ind20 + env.Text("module-forum-posts") + strconv.Itoa(counts.Posts) + + "\n" + ind16 + `
` + + "\n" + ind16 + escape.HTML(category.Description) + + "\n" + ind12 + `
` + + "\n" + ind8 + `
` + + "\n" + ind8 + `` + + "\n" + ind8 + `
`) + return b.String(), nil +} From ead6dfea928bcfd16d5137017ded276b2aa4c0d8 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 20:58:58 +0900 Subject: [PATCH 097/428] check the new thread page against django --- internal/repo/forumnewthread_test.go | 99 +++++++++++++++++ internal/repo/testdata/forumnewthread.golden | 102 ++++++++++++++++++ .../repo/testdata/forumnewthread_corpus.json | 67 ++++++++++++ .../repo/testdata/oracle_forumnewthread.py | 63 +++++++++++ 4 files changed, 331 insertions(+) create mode 100644 internal/repo/forumnewthread_test.go create mode 100644 internal/repo/testdata/forumnewthread.golden create mode 100644 internal/repo/testdata/forumnewthread_corpus.json create mode 100644 internal/repo/testdata/oracle_forumnewthread.py diff --git a/internal/repo/forumnewthread_test.go b/internal/repo/forumnewthread_test.go new file mode 100644 index 00000000..cea12f8a --- /dev/null +++ b/internal/repo/forumnewthread_test.go @@ -0,0 +1,99 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +const ( + forumNewThreadGolden = "testdata/forumnewthread.golden" + forumNewThreadCorpus = "testdata/forumnewthread_corpus.json" +) + +type forumNewThreadCase struct { + Name string `json:"name"` + Viewer string `json:"viewer"` + Category string `json:"category,omitempty"` + Path map[string]string `json:"path,omitempty"` +} + +func forumNewThreadCases() []forumNewThreadCase { + return []forumNewThreadCase{ + {Name: "chat", Viewer: "", Category: "Probe Chat"}, + {Name: "chat-signed-in", Viewer: "probe-author", Category: "Probe Chat"}, + {Name: "chat-superuser", Viewer: "probe-staff", Category: "Probe Chat"}, + {Name: "empty", Viewer: "", Category: "Probe Quiet"}, + {Name: "comments", Viewer: "", Category: "Probe Comments"}, + {Name: "hidden-section-category", Viewer: "", Category: "Probe Hidden Chat"}, + {Name: "hidden-section-superuser", Viewer: "probe-staff", Category: "Probe Hidden Chat"}, + {Name: "comments-superuser", Viewer: "probe-staff", Category: "Probe Comments"}, + {Name: "missing", Viewer: "", Path: map[string]string{"c": "999999"}}, + {Name: "unparsable", Viewer: "", Path: map[string]string{"c": "not-a-number"}}, + {Name: "padded-id", Viewer: "", Path: map[string]string{"c": "0999999"}}, + {Name: "no-parameter", Viewer: ""}, + } +} + +func TestForumNewThreadMatchesGolden(t *testing.T) { + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := forumNewThreadCases() + + article, err := d.ArticleByName(ctx, "forum:new-thread") + if err != nil { + t.Fatalf("ArticleByName(forum:new-thread) err = %v, want nil", err) + } + categories, err := d.ForumCategories(ctx) + if err != nil { + t.Fatalf("ForumCategories() err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + var viewer *db.User + if c.Viewer != "" { + viewer, err = d.UserByUsername(ctx, c.Viewer) + if err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + } + + path := forumNewThreadPath(t, c, categories) + pc := page.NewContext(article, article, path, viewer) + r := New(ctx, d, users, Options{Loc: loc, User: viewer}) + + body, err := r.RenderModule(pc, "ForumNewThread", nil, "") + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\ntitle: %s\nstatus: %d\n%s\n", c.Name, pc.Title, pc.Status, body) + } + compareGolden(t, b.String(), cases, forumNewThreadGolden, forumNewThreadCorpus) +} + +func forumNewThreadPath(t *testing.T, c forumNewThreadCase, categories []db.ForumCategory) page.PathParams { + t.Helper() + path := sortedPath(c.Path) + if c.Category == "" { + return path + } + for _, category := range categories { + if category.Name == c.Category { + return path.Put(page.PathParam{Key: "c", Value: fmt.Sprint(category.ID)}) + } + } + t.Fatalf("ForumCategories() has no category named %q, want one seeded", c.Category) + return nil +} diff --git a/internal/repo/testdata/forumnewthread.golden b/internal/repo/testdata/forumnewthread.golden new file mode 100644 index 00000000..60479713 --- /dev/null +++ b/internal/repo/testdata/forumnewthread.golden @@ -0,0 +1,102 @@ +=== chat +title: 创建主题 +status: 200 +!error: 权限不足，无法创建主题 +=== chat-signed-in +title: 创建主题 +status: 200 +!error: 权限不足，无法创建主题 +=== chat-superuser +title: 创建主题 +status: 200 +
+
+ 论坛 + » + Probe Open / Probe Chat + » + 创建主题 +
+
+
+ 主题数：3 +
+ 帖子数：6 +
+ ordinary threads +
+
+ +
+=== empty +title: 创建主题 +status: 200 +!error: 权限不足，无法创建主题 +=== comments +title: 创建主题 +status: 200 +!error: 权限不足，无法创建主题 +=== hidden-section-category +title: 创建主题 +status: 200 +!error: 权限不足，无法创建主题 +=== hidden-section-superuser +title: 创建主题 +status: 200 +
+
+ 论坛 + » + Probe Hidden / Probe Hidden Chat + » + 创建主题 +
+
+
+ 主题数：0 +
+ 帖子数：0 +
+ inside the hidden section +
+
+ +
+=== comments-superuser +title: 创建主题 +status: 200 +
+
+ 论坛 + » + Probe Open / Probe Comments + » + 创建主题 +
+
+
+ 主题数：0 +
+ 帖子数：0 +
+ article comments +
+
+ +
+=== missing +title: 创建主题 +status: 404 +!error: 未找到版块 "999999" +=== unparsable +title: 创建主题 +status: 404 +!error: 未找到版块 "not-a-number" +=== padded-id +title: 创建主题 +status: 404 +!error: 未找到版块 "999999" +=== no-parameter +title: 创建主题 +status: 404 +!error: 未找到版块 "None" diff --git a/internal/repo/testdata/forumnewthread_corpus.json b/internal/repo/testdata/forumnewthread_corpus.json new file mode 100644 index 00000000..c103dbd4 --- /dev/null +++ b/internal/repo/testdata/forumnewthread_corpus.json @@ -0,0 +1,67 @@ +[ + { + "name": "chat", + "viewer": "", + "category": "Probe Chat" + }, + { + "name": "chat-signed-in", + "viewer": "probe-author", + "category": "Probe Chat" + }, + { + "name": "chat-superuser", + "viewer": "probe-staff", + "category": "Probe Chat" + }, + { + "name": "empty", + "viewer": "", + "category": "Probe Quiet" + }, + { + "name": "comments", + "viewer": "", + "category": "Probe Comments" + }, + { + "name": "hidden-section-category", + "viewer": "", + "category": "Probe Hidden Chat" + }, + { + "name": "hidden-section-superuser", + "viewer": "probe-staff", + "category": "Probe Hidden Chat" + }, + { + "name": "comments-superuser", + "viewer": "probe-staff", + "category": "Probe Comments" + }, + { + "name": "missing", + "viewer": "", + "path": { + "c": "999999" + } + }, + { + "name": "unparsable", + "viewer": "", + "path": { + "c": "not-a-number" + } + }, + { + "name": "padded-id", + "viewer": "", + "path": { + "c": "0999999" + } + }, + { + "name": "no-parameter", + "viewer": "" + } +] diff --git a/internal/repo/testdata/oracle_forumnewthread.py b/internal/repo/testdata/oracle_forumnewthread.py new file mode 100644 index 00000000..ef5f3748 --- /dev/null +++ b/internal/repo/testdata/oracle_forumnewthread.py @@ -0,0 +1,63 @@ +"""Records what the ForumNewThread module renders for a reader starting a thread. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e FORUMNEWTHREAD_CORPUS="$(cat internal/repo/testdata/forumnewthread_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_forumnewthread.py + +Category ids are looked up by name so the corpus does not depend on what the +sequence handed out. Compare the output with +internal/repo/testdata/forumnewthread.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.forum import ForumCategory +from web.models.site import Site +from web.models.users import User +from web.util.json import replace_json_dumps_default + +replace_json_dumps_default() + +CORPUS = json.loads(os.environ['FORUMNEWTHREAD_CORPUS']) + + +def path_params(case): + params = dict(case.get('path') or {}) + if case.get('category'): + params['c'] = str(ForumCategory.objects.get(name=case['category']).id) + return params + + +def main(): + article = articles.get_article('forum:new-thread') + if article is None: + raise SystemExit('forum:new-thread is missing; run manage.py seed first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + if case['viewer']: + viewer = User.objects.get(username=case['viewer']) + threadvars.put('current_user', viewer) + context = RenderContext(article, article, path_params(case), viewer) + try: + body = modules.render_module('ForumNewThread', context, {}) + except ModuleError as error: + body = '!error: %s' % error.message + out.append('=== %s\ntitle: %s\nstatus: %d\n%s\n' % ( + case['name'], context.title, context.status, body)) + sys.stdout.write(''.join(out)) + + +main() From fac32db6af9892e89cbb9acd5cfc27797d0c72a4 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 20:58:58 +0900 Subject: [PATCH 098/428] run the new thread page in the page corpus --- internal/difftest/corpus/articles.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 6bd13445..077d081d 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -61,7 +61,8 @@ OPTIONS /probe:full /forum:thread /forum/t-999999 /forum/t-999999/p/2 -!/forum:new-thread +/forum:new-thread +/forum:new-thread/c/999999 /search:site /search:site/q/scp /search:site/q/%20spaced%20/author/probe-author From e645a96974de622ffc47a1e4d82d053858442761 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 20:59:31 +0900 Subject: [PATCH 099/428] give a seeded post a blank title --- internal/page/testdata/oracle_seed.py | 1 + internal/repo/testdata/forumstart.golden | 32 +- internal/repo/testdata/forumthread.golden | 340 +++++++++++++++------- 3 files changed, 245 insertions(+), 128 deletions(-) diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index 16612c62..f0be314f 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -309,6 +309,7 @@ def vote(article, user, rate): 'reply naming @probe-author and @nobody-at-all') forum_reply(reply, 'Probe Deep reply 0 0', author, 'a reply to a reply') forum_reply(deep_roots[0], 'Probe Deep reply 1', None, 'a reply the site itself made') +forum_reply(deep_roots[0], ' ', voter, 'a reply whose title is only spaces') edited = deep_roots[1] ForumPost.objects.filter(pk=edited.pk).update( diff --git a/internal/repo/testdata/forumstart.golden b/internal/repo/testdata/forumstart.golden index 42361322..de59fa52 100644 --- a/internal/repo/testdata/forumstart.golden +++ b/internal/repo/testdata/forumstart.golden @@ -124,7 +124,7 @@ status: 200
threads that carry replies
2 - 17 + 18 作者： @@ -138,7 +138,7 @@ status: 200
- 09.10.2023 11:59 + 09.10.2023 12:00
查看 @@ -282,7 +282,7 @@ status: 200
threads that carry replies
2 - 17 + 18 作者： @@ -296,7 +296,7 @@ status: 200
- 09.10.2023 11:59 + 09.10.2023 12:00
查看 @@ -472,7 +472,7 @@ status: 200
threads that carry replies
2 - 17 + 18 作者： @@ -486,7 +486,7 @@ status: 200
- 09.10.2023 11:59 + 09.10.2023 12:00
查看 @@ -630,7 +630,7 @@ status: 200
threads that carry replies
2 - 17 + 18 作者： @@ -644,7 +644,7 @@ status: 200
- 09.10.2023 11:59 + 09.10.2023 12:00
查看 @@ -856,7 +856,7 @@ status: 200
threads that carry replies
2 - 17 + 18 作者： @@ -870,7 +870,7 @@ status: 200
- 09.10.2023 11:59 + 09.10.2023 12:00
查看 @@ -1022,7 +1022,7 @@ status: 200
threads that carry replies
2 - 17 + 18 作者： @@ -1036,7 +1036,7 @@ status: 200
- 09.10.2023 11:59 + 09.10.2023 12:00
查看 @@ -1180,7 +1180,7 @@ status: 200
threads that carry replies
2 - 17 + 18 作者： @@ -1194,7 +1194,7 @@ status: 200
- 09.10.2023 11:59 + 09.10.2023 12:00
查看 @@ -1370,7 +1370,7 @@ status: 200
threads that carry replies
2 - 17 + 18 作者： @@ -1384,7 +1384,7 @@ status: 200
- 09.10.2023 11:59 + 09.10.2023 12:00
查看 diff --git a/internal/repo/testdata/forumthread.golden b/internal/repo/testdata/forumthread.golden index d25f1c42..23b19582 100644 --- a/internal/repo/testdata/forumthread.golden +++ b/internal/repo/testdata/forumthread.golden @@ -155,6 +155,35 @@ status: 200 +
+
+
+
+
+ +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+ @@ -349,6 +378,35 @@ status: 200 +
+
+
+
+
+ +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+ @@ -505,6 +563,35 @@ status: 200 +
+
+
+
+
+ +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+ @@ -710,13 +797,13 @@ status: 200 - 09.10.2023 11:48 + 09.10.2023 11:49

Probe Long Thread body 0

-
+
@@ -739,13 +826,13 @@ status: 200 - 09.10.2023 11:49 + 09.10.2023 11:50

Probe Long Thread body 1

-
+
@@ -768,13 +855,13 @@ status: 200 - 09.10.2023 11:50 + 09.10.2023 11:51

Probe Long Thread body 2

-
+
@@ -797,13 +884,13 @@ status: 200 - 09.10.2023 11:51 + 09.10.2023 11:52

Probe Long Thread body 3

-
+
@@ -826,13 +913,13 @@ status: 200 - 09.10.2023 11:52 + 09.10.2023 11:53

Probe Long Thread body 4

-
+
@@ -855,13 +942,13 @@ status: 200 - 09.10.2023 11:53 + 09.10.2023 11:54

Probe Long Thread body 5

-
+
@@ -884,13 +971,13 @@ status: 200 - 09.10.2023 11:54 + 09.10.2023 11:55

Probe Long Thread body 6

-
+
@@ -913,13 +1000,13 @@ status: 200 - 09.10.2023 11:55 + 09.10.2023 11:56

Probe Long Thread body 7

-
+
@@ -942,13 +1029,13 @@ status: 200 - 09.10.2023 11:56 + 09.10.2023 11:57

Probe Long Thread body 8

-
+
@@ -971,13 +1058,13 @@ status: 200 - 09.10.2023 11:57 + 09.10.2023 11:58

Probe Long Thread body 9

-
+
@@ -1092,13 +1179,13 @@ status: 200 - 09.10.2023 11:58 + 09.10.2023 11:59

Probe Long Thread body 10

-
+
@@ -1121,13 +1208,13 @@ status: 200 - 09.10.2023 11:59 + 09.10.2023 12:00

Probe Long Thread body 11

-
+
@@ -1242,13 +1329,13 @@ status: 200 - 09.10.2023 11:58 + 09.10.2023 11:59

Probe Long Thread body 10

-
+
@@ -1271,13 +1358,13 @@ status: 200 - 09.10.2023 11:59 + 09.10.2023 12:00

Probe Long Thread body 11

-
+
@@ -1392,13 +1479,13 @@ status: 200 - 09.10.2023 11:48 + 09.10.2023 11:49

Probe Long Thread body 0

-
+
@@ -1421,13 +1508,13 @@ status: 200 - 09.10.2023 11:49 + 09.10.2023 11:50

Probe Long Thread body 1

-
+
@@ -1450,13 +1537,13 @@ status: 200 - 09.10.2023 11:50 + 09.10.2023 11:51

Probe Long Thread body 2

-
+
@@ -1479,13 +1566,13 @@ status: 200 - 09.10.2023 11:51 + 09.10.2023 11:52

Probe Long Thread body 3

-
+
@@ -1508,13 +1595,13 @@ status: 200 - 09.10.2023 11:52 + 09.10.2023 11:53

Probe Long Thread body 4

-
+
@@ -1537,13 +1624,13 @@ status: 200 - 09.10.2023 11:53 + 09.10.2023 11:54

Probe Long Thread body 5

-
+
@@ -1566,13 +1653,13 @@ status: 200 - 09.10.2023 11:54 + 09.10.2023 11:55

Probe Long Thread body 6

-
+
@@ -1595,13 +1682,13 @@ status: 200 - 09.10.2023 11:55 + 09.10.2023 11:56

Probe Long Thread body 7

-
+
@@ -1624,13 +1711,13 @@ status: 200 - 09.10.2023 11:56 + 09.10.2023 11:57

Probe Long Thread body 8

-
+
@@ -1653,13 +1740,13 @@ status: 200 - 09.10.2023 11:57 + 09.10.2023 11:58

Probe Long Thread body 9

-
+
@@ -1774,13 +1861,13 @@ status: 200 - 09.10.2023 11:48 + 09.10.2023 11:49

Probe Long Thread body 0

-
+
@@ -1803,13 +1890,13 @@ status: 200 - 09.10.2023 11:49 + 09.10.2023 11:50

Probe Long Thread body 1

-
+
@@ -1832,13 +1919,13 @@ status: 200 - 09.10.2023 11:50 + 09.10.2023 11:51

Probe Long Thread body 2

-
+
@@ -1861,13 +1948,13 @@ status: 200 - 09.10.2023 11:51 + 09.10.2023 11:52

Probe Long Thread body 3

-
+
@@ -1890,13 +1977,13 @@ status: 200 - 09.10.2023 11:52 + 09.10.2023 11:53

Probe Long Thread body 4

-
+
@@ -1919,13 +2006,13 @@ status: 200 - 09.10.2023 11:53 + 09.10.2023 11:54

Probe Long Thread body 5

-
+
@@ -1948,13 +2035,13 @@ status: 200 - 09.10.2023 11:54 + 09.10.2023 11:55

Probe Long Thread body 6

-
+
@@ -1977,13 +2064,13 @@ status: 200 - 09.10.2023 11:55 + 09.10.2023 11:56

Probe Long Thread body 7

-
+
@@ -2006,13 +2093,13 @@ status: 200 - 09.10.2023 11:56 + 09.10.2023 11:57

Probe Long Thread body 8

-
+
@@ -2035,13 +2122,13 @@ status: 200 - 09.10.2023 11:57 + 09.10.2023 11:58

Probe Long Thread body 9

-
+
@@ -2156,13 +2243,13 @@ status: 200 - 09.10.2023 11:58 + 09.10.2023 11:59

Probe Long Thread body 10

-
+
@@ -2185,13 +2272,13 @@ status: 200 - 09.10.2023 11:59 + 09.10.2023 12:00

Probe Long Thread body 11

-
+
@@ -2378,6 +2465,35 @@ status: 200 +
+
+
+
+
+ +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+ @@ -2500,13 +2616,13 @@ status: 200 - 09.10.2023 11:48 + 09.10.2023 11:49

Probe Long Thread body 0

-
+
@@ -2529,13 +2645,13 @@ status: 200 - 09.10.2023 11:49 + 09.10.2023 11:50

Probe Long Thread body 1

-
+
@@ -2558,13 +2674,13 @@ status: 200 - 09.10.2023 11:50 + 09.10.2023 11:51

Probe Long Thread body 2

-
+
@@ -2587,13 +2703,13 @@ status: 200 - 09.10.2023 11:51 + 09.10.2023 11:52

Probe Long Thread body 3

-
+
@@ -2616,13 +2732,13 @@ status: 200 - 09.10.2023 11:52 + 09.10.2023 11:53

Probe Long Thread body 4

-
+
@@ -2645,13 +2761,13 @@ status: 200 - 09.10.2023 11:53 + 09.10.2023 11:54

Probe Long Thread body 5

-
+
@@ -2674,13 +2790,13 @@ status: 200 - 09.10.2023 11:54 + 09.10.2023 11:55

Probe Long Thread body 6

-
+
@@ -2703,13 +2819,13 @@ status: 200 - 09.10.2023 11:55 + 09.10.2023 11:56

Probe Long Thread body 7

-
+
@@ -2732,13 +2848,13 @@ status: 200 - 09.10.2023 11:56 + 09.10.2023 11:57

Probe Long Thread body 8

-
+
@@ -2761,13 +2877,13 @@ status: 200 - 09.10.2023 11:57 + 09.10.2023 11:58

Probe Long Thread body 9

-
+
@@ -2882,13 +2998,13 @@ status: 200 - 09.10.2023 11:48 + 09.10.2023 11:49

Probe Long Thread body 0

-
+
@@ -2911,13 +3027,13 @@ status: 200 - 09.10.2023 11:49 + 09.10.2023 11:50

Probe Long Thread body 1

-
+
@@ -2940,13 +3056,13 @@ status: 200 - 09.10.2023 11:50 + 09.10.2023 11:51

Probe Long Thread body 2

-
+
@@ -2969,13 +3085,13 @@ status: 200 - 09.10.2023 11:51 + 09.10.2023 11:52

Probe Long Thread body 3

-
+
@@ -2998,13 +3114,13 @@ status: 200 - 09.10.2023 11:52 + 09.10.2023 11:53

Probe Long Thread body 4

-
+
@@ -3027,13 +3143,13 @@ status: 200 - 09.10.2023 11:53 + 09.10.2023 11:54

Probe Long Thread body 5

-
+
@@ -3056,13 +3172,13 @@ status: 200 - 09.10.2023 11:54 + 09.10.2023 11:55

Probe Long Thread body 6

-
+
@@ -3085,13 +3201,13 @@ status: 200 - 09.10.2023 11:55 + 09.10.2023 11:56

Probe Long Thread body 7

-
+
@@ -3114,13 +3230,13 @@ status: 200 - 09.10.2023 11:56 + 09.10.2023 11:57

Probe Long Thread body 8

-
+
@@ -3143,13 +3259,13 @@ status: 200 - 09.10.2023 11:57 + 09.10.2023 11:58

Probe Long Thread body 9

-
+
From b73a5e1e21c8dd92da684793e436504e176f9e66 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 20:59:31 +0900 Subject: [PATCH 100/428] add the queries a recent posts list needs --- internal/db/forum.go | 56 +++++++++++++++++++++++++++++++++++++++ internal/module/module.go | 2 ++ internal/repo/modules.go | 8 ++++++ 3 files changed, 66 insertions(+) diff --git a/internal/db/forum.go b/internal/db/forum.go index 6be10eb7..5b0896fa 100644 --- a/internal/db/forum.go +++ b/internal/db/forum.go @@ -470,3 +470,59 @@ func (d *DB) ForumPostContents(ctx context.Context, postIDs []int64) (map[int64] } return out, rows.Err() } + +type RecentPost struct { + ID int64 + Name string + CreatedAt time.Time + AuthorID *int64 + + ThreadID int64 + ThreadName string + ThreadCategoryID *int64 + ThreadArticleID *int64 + ThreadAuthorID *int64 +} + +// An empty category list with comments switched off matches nothing, which is +// what a reader who may see no category is meant to get. +const recentPostFilter = ` +FROM web_forumpost p +JOIN web_forumthread t ON t.id = p.thread_id +WHERE t.category_id = ANY($1) OR ($2::boolean AND t.article_id IS NOT NULL)` + +var qRecentPostCount = register("RecentPostCount", `SELECT count(*)`+recentPostFilter) + +func (d *DB) RecentPostCount(ctx context.Context, categoryIDs []int64, comments bool) (int, error) { + var n int + if err := d.pool.QueryRow(ctx, qRecentPostCount, categoryIDs, comments).Scan(&n); err != nil { + return 0, fmt.Errorf("count recent posts: %w", err) + } + return n, nil +} + +var qRecentPosts = register("RecentPosts", ` +SELECT p.id, p.name, p.created_at, p.author_id, + t.id, t.name, t.category_id, t.article_id, t.author_id`+recentPostFilter+` +ORDER BY p.created_at DESC +OFFSET $3 LIMIT $4`) + +func (d *DB) RecentPosts(ctx context.Context, categoryIDs []int64, comments bool, offset, limit int) ([]RecentPost, error) { + rows, err := d.pool.Query(ctx, qRecentPosts, categoryIDs, comments, offset, limit) + if err != nil { + return nil, fmt.Errorf("query recent posts: %w", err) + } + defer rows.Close() + + var out []RecentPost + for rows.Next() { + var p RecentPost + if err := rows.Scan(&p.ID, &p.Name, &p.CreatedAt, &p.AuthorID, + &p.ThreadID, &p.ThreadName, &p.ThreadCategoryID, &p.ThreadArticleID, + &p.ThreadAuthorID); err != nil { + return nil, fmt.Errorf("scan recent post: %w", err) + } + out = append(out, p) + } + return out, rows.Err() +} diff --git a/internal/module/module.go b/internal/module/module.go index 1699e170..d4325270 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -57,6 +57,8 @@ type Data interface { ForumPostReplies(postID int64) ([]db.ForumThreadPost, error) ForumPost(id int64) (*db.ForumThreadPost, error) ForumPostContents(postIDs []int64) (map[int64]db.ForumPostContent, error) + RecentPostCount(categoryIDs []int64, comments bool) (int, error) + RecentPosts(categoryIDs []int64, comments bool, offset, limit int) ([]db.RecentPost, error) UsernamesLower() (map[string]bool, error) VoteByUser(articleID int64, userID *int64) (float64, bool, error) UserByID(id int64) (*db.User, error) diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 88eb58f9..522a2156 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -193,6 +193,14 @@ func (m moduleData) ForumPostContents(postIDs []int64) (map[int64]db.ForumPostCo return m.repo.db.ForumPostContents(m.repo.ctx, postIDs) } +func (m moduleData) RecentPostCount(categoryIDs []int64, comments bool) (int, error) { + return m.repo.db.RecentPostCount(m.repo.ctx, categoryIDs, comments) +} + +func (m moduleData) RecentPosts(categoryIDs []int64, comments bool, offset, limit int) ([]db.RecentPost, error) { + return m.repo.db.RecentPosts(m.repo.ctx, categoryIDs, comments, offset, limit) +} + func (m moduleData) UsernamesLower() (map[string]bool, error) { return m.repo.db.UsernamesLower(m.repo.ctx) } From b5eda1f29ad90de3a895530c9573f45ca78aca9d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 20:59:31 +0900 Subject: [PATCH 101/428] answer the forum recent posts list --- internal/i18n/locales/zh-hans.json | 6 + internal/module/render_test.go | 2 +- internal/modules/recentposts.go | 428 +++++++++++++++++++++++++++++ 3 files changed, 435 insertions(+), 1 deletion(-) create mode 100644 internal/modules/recentposts.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index c4200138..4f5e2eb3 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -58,6 +58,12 @@ "module-rate-popularity": "人气值（3.0分及以上评分占比）", "module-rate-up": "喜欢", "module-rate-votes": "评分数", + "module-recentposts-all": "所有版块", + "module-recentposts-from": "来自", + "module-recentposts-goto": "跳转到帖子", + "module-recentposts-refresh": "刷新", + "module-recentposts-select": "选择版块：", + "module-recentposts-title": "论坛最新帖子", "module-search-placeholder": "搜索文章标题或内容…", "module-unknown": "模块 '{name}' 不存在", "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", diff --git a/internal/module/render_test.go b/internal/module/render_test.go index d282e3f6..ced13779 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "redirect", "search"} + ported := []string{"forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/recentposts.go b/internal/modules/recentposts.go new file mode 100644 index 00000000..547ccd9f --- /dev/null +++ b/internal/modules/recentposts.go @@ -0,0 +1,428 @@ +package modules + +import ( + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/pynum" +) + +func init() { module.Register("recentposts", renderRecentPosts) } + +const recentPostsPerPage = 20 + +type recentPostRow struct { + id int64 + name string + url string + isOP bool + author string + authorRate string + createdAt string + content string + hasCategory bool + sectionName string + sectionURL string + categoryName string + categoryURL string + threadName string + threadURL string +} + +type recentPostsView struct { + rows []recentPostRow + options []recentPostsOption + selected string + pagination string + pathParams string + params string +} + +type recentPostsOption struct { + name string + id string + canSelect bool +} + +func renderRecentPosts(env module.Env, params map[string]string, _ string) (string, error) { + if env.Data == nil || env.RenderMessage == nil { + return "", forumFailed(env) + } + setTitle(env, env.Text("module-recentposts-title")) + + var path page.PathParams + if env.Page != nil { + path = env.Page.PathParams + } + + subject, err := env.Data.Subject(env.User) + if err != nil { + return "", err + } + visible, chosen, err := recentPostsCategories(env, path, subject) + if err != nil { + return "", err + } + + comments := false + for _, c := range visible { + if c.IsForComments { + comments = true + break + } + } + if chosen != nil { + comments = chosen.IsForComments + } + + view := recentPostsView{selected: "*"} + if chosen != nil { + view.selected = strconv.FormatInt(chosen.ID, 10) + } + + ids := make([]int64, 0, len(visible)) + for _, c := range visible { + ids = append(ids, c.ID) + } + if chosen != nil { + ids = []int64{chosen.ID} + if chosen.IsForComments { + ids, comments = nil, true + } else { + comments = false + } + } + + total, err := env.Data.RecentPostCount(ids, comments) + if err != nil { + return "", err + } + + current := 1 + if n, err := pynum.Int(path.Get("p")); err == nil { + current = n + } + if current < 1 { + current = 1 + } + maxPage := (total + recentPostsPerPage - 1) / recentPostsPerPage + if maxPage < 1 { + maxPage = 1 + } + if current > maxPage { + current = maxPage + } + + if err := recentPostsRows(env, &view, visible, chosen, ids, comments, current); err != nil { + return "", err + } + if err := recentPostsOptions(env, &view, visible, subject); err != nil { + return "", err + } + + view.pagination = listpages.Pagination(env.Loc, "", current, maxPage) + if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + return "", err + } + if view.params, err = pyjson.Marshal(paramsObject(params, nil)); err != nil { + return "", err + } + return recentPostsHTML(env, view), nil +} + +// A value that is not a number takes the whole category list down with it, so +// the reader gets an empty dropdown and no posts at all. +func recentPostsCategories(env module.Env, path page.PathParams, subject perms.Subject) ([]db.ForumCategory, *db.ForumCategory, error) { + all, err := env.Data.ForumCategories() + if err != nil { + return nil, nil, err + } + visible := all + if !perms.Resolve(subject, nil).Has(perms.ViewForumCategories) { + visible = nil + } + + asked := path.Get("c") + if !path.Has("c") { + asked = "*" + } + if asked == "*" { + return visible, nil, nil + } + + id, err := pynum.Int(asked) + if err != nil { + return nil, nil, nil + } + for i := range visible { + if visible[i].ID == int64(id) { + return visible, &visible[i], nil + } + } + return visible, nil, nil +} + +func recentPostsRows(env module.Env, view *recentPostsView, visible []db.ForumCategory, + chosen *db.ForumCategory, ids []int64, comments bool, current int) error { + + posts, err := env.Data.RecentPosts(ids, comments, (current-1)*recentPostsPerPage, recentPostsPerPage) + if err != nil { + return err + } + if len(posts) == 0 { + return nil + } + + usernames, err := env.Data.UsernamesLower() + if err != nil { + return err + } + postIDs := make([]int64, 0, len(posts)) + for _, post := range posts { + postIDs = append(postIDs, post.ID) + } + contents, err := env.Data.ForumPostContents(postIDs) + if err != nil { + return err + } + + sections, err := env.Data.ForumSections() + if err != nil { + return err + } + sectionByID := make(map[int64]db.ForumSection, len(sections)) + for _, s := range sections { + sectionByID[s.ID] = s + } + categoryByID := make(map[int64]db.ForumCategory, len(visible)) + for _, c := range visible { + categoryByID[c.ID] = c + } + + fallback := chosen + if fallback == nil || !fallback.IsForComments { + fallback = nil + for i := range visible { + if visible[i].IsForComments { + fallback = &visible[i] + break + } + } + } + + for _, post := range posts { + row, err := recentPostsRow(env, post, contents[post.ID], usernames, + categoryByID, sectionByID, fallback) + if err != nil { + return err + } + view.rows = append(view.rows, row) + } + return nil +} + +func recentPostsRow(env module.Env, post db.RecentPost, content db.ForumPostContent, + usernames map[string]bool, categories map[int64]db.ForumCategory, + sections map[int64]db.ForumSection, fallback *db.ForumCategory) (recentPostRow, error) { + + row := recentPostRow{ + id: post.ID, + name: env.Text("module-recentposts-goto"), + isOP: samePerson(post.ThreadAuthorID, post.AuthorID), + createdAt: renderDate(env, post.CreatedAt), + } + if trimmed := strings.TrimSpace(post.Name); trimmed != "" { + row.name = trimmed + } + + row.threadName = post.ThreadName + var article *db.Article + if post.ThreadArticleID != nil { + found, err := env.Data.ArticleByID(*post.ThreadArticleID) + if err != nil { + return recentPostRow{}, err + } + article = found + if post.ThreadCategoryID == nil { + row.threadName = article.DisplayName() + } + } + row.threadURL = forumThreadURL(post.ThreadID, row.threadName) + row.url = row.threadURL + "#post-" + strconv.FormatInt(post.ID, 10) + + var err error + if row.author, err = env.Data.RenderUserByID(post.AuthorID); err != nil { + return recentPostRow{}, err + } + if article != nil { + mode, err := articleRatingMode(env, article.Category) + if err != nil { + return recentPostRow{}, err + } + rate, voted, err := env.Data.VoteByUser(article.ID, post.AuthorID) + if err != nil { + return recentPostRow{}, err + } + row.authorRate = forumVoteHTML(env, mode, rate, voted) + + if post.AuthorID != nil { + author, err := env.Data.ArticleHasAuthor(article.ID, *post.AuthorID) + if err != nil { + return recentPostRow{}, err + } + if author { + row.isOP = true + } + } + } + + html, err := env.RenderMessage(content.Source) + if err != nil { + return recentPostRow{}, err + } + row.content = highlightMentions(html, usernames) + + shown := fallback + if post.ThreadCategoryID != nil { + if own, ok := categories[*post.ThreadCategoryID]; ok { + shown = &own + } + } + if shown == nil { + return row, nil + } + section := sections[shown.SectionID] + row.hasCategory = true + row.sectionName = section.Name + row.sectionURL = forumSectionURL(section.ID, section.Name) + row.categoryName = shown.Name + row.categoryURL = forumCategoryURL(shown.ID, shown.Name) + return row, nil +} + +func recentPostsOptions(env module.Env, view *recentPostsView, visible []db.ForumCategory, + subject perms.Subject) error { + + sections, err := env.Data.ForumSections() + if err != nil { + return err + } + for _, section := range sections { + object := env.Data.ForumSectionObject(§ion) + if !perms.Resolve(subject, object).Has(perms.ViewForumSections) { + continue + } + var under []recentPostsOption + for _, category := range visible { + if category.SectionID != section.ID { + continue + } + under = append(under, recentPostsOption{ + name: "  " + category.Name, + id: strconv.FormatInt(category.ID, 10), + canSelect: true, + }) + } + if len(under) == 0 { + continue + } + view.options = append(view.options, recentPostsOption{name: section.Name, id: "None"}) + view.options = append(view.options, under...) + } + return nil +} + +func recentPostsHTML(env module.Env, view recentPostsView) string { + var b strings.Builder + b.WriteString(`
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `
` + env.Text("module-recentposts-select") + `` + + "\n" + ind24 + `` + + "\n" + ind24 + `` + + "\n" + ind20 + `
` + + "\n" + ind12 + `
` + + "\n" + ind12 + `
` + + "\n" + ind16 + `
` + + "\n" + ind20 + view.pagination + + "\n" + ind20) + + for _, row := range view.rows { + head := `
` + if row.isOP { + head = `
` + } + b.WriteString("\n" + ind20 + `
` + + "\n" + ind24 + `
` + + "\n" + ind28 + `
` + + "\n" + ind32 + head + + "\n" + ind36 + `
` + + "\n" + ind40 + `` + escape.HTML(row.name) + `` + + "\n" + ind36 + `
` + + "\n" + ind36 + `
` + + "\n" + ind40 + row.author + " " + row.createdAt + " " + row.authorRate + + "\n" + ind36 + `
` + + "\n" + ind36 + `` + + "\n" + ind40 + env.Text("module-recentposts-from") + + "\n" + ind40) + if row.hasCategory { + b.WriteString("\n" + ind40 + `` + + escape.HTML(row.sectionName) + ` »` + + "\n" + ind40 + `` + + escape.HTML(row.categoryName) + ` »` + + "\n" + ind40) + } + b.WriteString("\n" + ind40 + `` + + escape.HTML(row.threadName) + `` + + "\n" + ind36 + `` + + "\n" + ind32 + `
` + + "\n" + ind32 + `
` + + "\n" + ind36 + row.content + + "\n" + ind32 + `
` + + "\n" + ind28 + `
` + + "\n" + ind24 + `
` + + "\n" + ind20 + `
` + + "\n" + ind20) + } + + b.WriteString("\n" + ind20 + view.pagination + + "\n" + ind16 + `
` + + "\n" + ind12 + `
` + + "\n" + ind8 + `
`) + return b.String() +} From 706ff93899e6c5701e987ba23741ee0c3f608300 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 20:59:31 +0900 Subject: [PATCH 102/428] check the recent posts list against django --- internal/repo/recentposts_test.go | 103 + internal/repo/testdata/oracle_recentposts.py | 63 + internal/repo/testdata/recentposts.golden | 7839 +++++++++++++++++ .../repo/testdata/recentposts_corpus.json | 86 + 4 files changed, 8091 insertions(+) create mode 100644 internal/repo/recentposts_test.go create mode 100644 internal/repo/testdata/oracle_recentposts.py create mode 100644 internal/repo/testdata/recentposts.golden create mode 100644 internal/repo/testdata/recentposts_corpus.json diff --git a/internal/repo/recentposts_test.go b/internal/repo/recentposts_test.go new file mode 100644 index 00000000..f143189d --- /dev/null +++ b/internal/repo/recentposts_test.go @@ -0,0 +1,103 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "os" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/renderer/sidecar" +) + +const ( + recentPostsGolden = "testdata/recentposts.golden" + recentPostsCorpus = "testdata/recentposts_corpus.json" +) + +type recentPostsCase struct { + Name string `json:"name"` + Viewer string `json:"viewer"` + Category string `json:"category,omitempty"` + Params map[string]string `json:"params,omitempty"` + Path map[string]string `json:"path,omitempty"` +} + +func recentPostsCases() []recentPostsCase { + return []recentPostsCase{ + {Name: "all", Viewer: ""}, + {Name: "all-signed-in", Viewer: "probe-author"}, + {Name: "second-page", Viewer: "", Path: map[string]string{"p": "2"}}, + {Name: "past-the-end", Viewer: "", Path: map[string]string{"p": "99"}}, + {Name: "below-one", Viewer: "", Path: map[string]string{"p": "-3"}}, + {Name: "junk-page", Viewer: "", Path: map[string]string{"p": "later"}}, + {Name: "one-category", Viewer: "", Category: "Probe Talk"}, + {Name: "empty-category", Viewer: "", Category: "Probe Quiet"}, + {Name: "comments-category", Viewer: "", Category: "Probe Comments"}, + {Name: "hidden-section-category", Viewer: "", Category: "Probe Hidden Chat"}, + {Name: "star", Viewer: "", Path: map[string]string{"c": "*"}}, + {Name: "missing-category", Viewer: "", Path: map[string]string{"c": "999999"}}, + {Name: "junk-category", Viewer: "", Path: map[string]string{"c": "not-a-number"}}, + {Name: "with-params", Viewer: "", Params: map[string]string{"limit": "5"}}, + } +} + +func TestRecentPostsMatchesGolden(t *testing.T) { + bin := os.Getenv(sidecar.EnvBinary) + if bin == "" { + t.Skipf("%s not set, skipping the recent posts test", sidecar.EnvBinary) + } + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := recentPostsCases() + + rend, err := sidecar.New(bin) + if err != nil { + t.Fatalf("sidecar.New(%q) err = %v, want nil", bin, err) + } + t.Cleanup(func() { rend.Close() }) + + site, err := d.SiteByHosts(ctx, []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) + } + article, err := d.ArticleByName(ctx, "forum:recent-posts") + if err != nil { + t.Fatalf("ArticleByName(forum:recent-posts) err = %v, want nil", err) + } + categories, err := d.ForumCategories(ctx) + if err != nil { + t.Fatalf("ForumCategories() err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + var viewer *db.User + if c.Viewer != "" { + viewer, err = d.UserByUsername(ctx, c.Viewer) + if err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + } + + path := forumNewThreadPath(t, forumNewThreadCase{Category: c.Category, Path: c.Path}, categories) + pc := page.NewContext(article, article, path, viewer) + r := newThreadRepo(ctx, d, users, loc, site, viewer, rend) + + body, err := r.RenderModule(pc, "RecentPosts", c.Params, "") + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\ntitle: %s\nstatus: %d\n%s\n", c.Name, pc.Title, pc.Status, body) + } + compareGolden(t, b.String(), cases, recentPostsGolden, recentPostsCorpus) +} diff --git a/internal/repo/testdata/oracle_recentposts.py b/internal/repo/testdata/oracle_recentposts.py new file mode 100644 index 00000000..2bbf77d7 --- /dev/null +++ b/internal/repo/testdata/oracle_recentposts.py @@ -0,0 +1,63 @@ +"""Records what the RecentPosts module renders for a reader browsing the forum. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e RECENTPOSTS_CORPUS="$(cat internal/repo/testdata/recentposts_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_recentposts.py + +Category ids are looked up by name so the corpus does not depend on what the +sequence handed out. Compare the output with +internal/repo/testdata/recentposts.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.forum import ForumCategory +from web.models.site import Site +from web.models.users import User +from web.util.json import replace_json_dumps_default + +replace_json_dumps_default() + +CORPUS = json.loads(os.environ['RECENTPOSTS_CORPUS']) + + +def path_params(case): + params = dict(case.get('path') or {}) + if case.get('category'): + params['c'] = str(ForumCategory.objects.get(name=case['category']).id) + return params + + +def main(): + article = articles.get_article('forum:recent-posts') + if article is None: + raise SystemExit('forum:recent-posts is missing; run manage.py seed first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + if case['viewer']: + viewer = User.objects.get(username=case['viewer']) + threadvars.put('current_user', viewer) + context = RenderContext(article, article, path_params(case), viewer) + try: + body = modules.render_module('RecentPosts', context, case.get('params') or {}) + except ModuleError as error: + body = '!error: %s' % error.message + out.append('=== %s\ntitle: %s\nstatus: %d\n%s\n' % ( + case['name'], context.title, context.status, body)) + sys.stdout.write(''.join(out)) + + +main() diff --git a/internal/repo/testdata/recentposts.golden b/internal/repo/testdata/recentposts.golden new file mode 100644 index 00000000..790dc928 --- /dev/null +++ b/internal/repo/testdata/recentposts.golden @@ -0,0 +1,7839 @@ +=== all +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+=== all-signed-in +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+=== second-page +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 2 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ probe post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:40 5.0 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Rated + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:39 4.0 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Rated + +
+
+

probe comment 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 20 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:38 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 20 + +
+
+

Probe Busy 20 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 19 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:37 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 19 + +
+
+

Probe Busy 19 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 18 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:36 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 18 + +
+
+

Probe Busy 18 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 17 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:35 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 17 + +
+
+

Probe Busy 17 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 16 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:34 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 16 + +
+
+

Probe Busy 16 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 15 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:33 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 15 + +
+
+

Probe Busy 15 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 14 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:32 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 14 + +
+
+

Probe Busy 14 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 13 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:31 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 13 + +
+
+

Probe Busy 13 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 12 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:30 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 12 + +
+
+

Probe Busy 12 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 11 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:29 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 11 + +
+
+

Probe Busy 11 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 10 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:28 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 10 + +
+
+

Probe Busy 10 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 09 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:27 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 09 + +
+
+

Probe Busy 09 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 08 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:26 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 08 + +
+
+

Probe Busy 08 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 07 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:25 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 07 + +
+
+

Probe Busy 07 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 06 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:24 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 06 + +
+
+

Probe Busy 06 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 05 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:23 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 05 + +
+
+

Probe Busy 05 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 04 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:22 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 04 + +
+
+

Probe Busy 04 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 03 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:21 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 03 + +
+
+

Probe Busy 03 body 0

+
+
+
+
+ +
+ 第 2 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+=== past-the-end +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 3 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + +
+ +
+
+
+
+
+ Probe Busy 02 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:20 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 02 + +
+
+

Probe Busy 02 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 01 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:19 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 01 + +
+
+

Probe Busy 01 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 00 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:18 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 00 + +
+
+

Probe Busy 00 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Pinned Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:17 +
+ + 来自 + + Probe Open » + Probe Chat » + + Probe Pinned Thread + +
+
+

Probe Pinned Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Pinned Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:16 +
+ + 来自 + + Probe Open » + Probe Chat » + + Probe Pinned Thread + +
+
+

Probe Pinned Thread body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Locked Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:15 +
+ + 来自 + + Probe Open » + Probe Chat » + + Probe Locked Thread + +
+
+

Probe Locked Thread body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Thread post 2 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:14 +
+ + 来自 + + Probe Open » + Probe Chat » + + Probe Thread + +
+
+

Probe Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:13 +
+ + 来自 + + Probe Open » + Probe Chat » + + Probe Thread + +
+
+

Probe Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:12 +
+ + 来自 + + Probe Open » + Probe Chat » + + Probe Thread + +
+
+

Probe Thread body 0

+
+
+
+
+ +
+ 第 3 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + +
+
+
+
+=== below-one +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+=== junk-page +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+=== one-category +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+ + +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ + +
+
+
+=== empty-category +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+ + + +
+
+
+=== comments-category +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+ + +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:40 5.0 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Rated + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:39 4.0 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Rated + +
+
+

probe comment 0

+
+
+
+
+ + +
+
+
+=== hidden-section-category +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+ + + +
+
+
+=== star +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+=== missing-category +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+=== junk-category +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+ + + +
+
+
+=== with-params +title: 论坛最新帖子 +status: 200 +
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +1 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
diff --git a/internal/repo/testdata/recentposts_corpus.json b/internal/repo/testdata/recentposts_corpus.json new file mode 100644 index 00000000..e333beaf --- /dev/null +++ b/internal/repo/testdata/recentposts_corpus.json @@ -0,0 +1,86 @@ +[ + { + "name": "all", + "viewer": "" + }, + { + "name": "all-signed-in", + "viewer": "probe-author" + }, + { + "name": "second-page", + "viewer": "", + "path": { + "p": "2" + } + }, + { + "name": "past-the-end", + "viewer": "", + "path": { + "p": "99" + } + }, + { + "name": "below-one", + "viewer": "", + "path": { + "p": "-3" + } + }, + { + "name": "junk-page", + "viewer": "", + "path": { + "p": "later" + } + }, + { + "name": "one-category", + "viewer": "", + "category": "Probe Talk" + }, + { + "name": "empty-category", + "viewer": "", + "category": "Probe Quiet" + }, + { + "name": "comments-category", + "viewer": "", + "category": "Probe Comments" + }, + { + "name": "hidden-section-category", + "viewer": "", + "category": "Probe Hidden Chat" + }, + { + "name": "star", + "viewer": "", + "path": { + "c": "*" + } + }, + { + "name": "missing-category", + "viewer": "", + "path": { + "c": "999999" + } + }, + { + "name": "junk-category", + "viewer": "", + "path": { + "c": "not-a-number" + } + }, + { + "name": "with-params", + "viewer": "", + "params": { + "limit": "5" + } + } +] From a9c6807505260ae98bd8c2e15438cfd3bf1e3741 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 20:59:31 +0900 Subject: [PATCH 103/428] run the recent posts list in the page corpus --- internal/difftest/corpus/articles.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 077d081d..40a5b517 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -54,7 +54,9 @@ OPTIONS /probe:full /forum:start /forum/start/hidden/show /forum/start/s/999999 -!/forum:recent-posts +/forum:recent-posts +/forum:recent-posts/p/2 +/forum:recent-posts/c/999999 /forum:category /forum/c-999999 /forum/c-999999/sort/start From 72a5e566a86a724dc14d9e86522865cdb6688fab Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 21:01:09 +0900 Subject: [PATCH 104/428] fix --- .gitattributes | 3 --- 1 file changed, 3 deletions(-) diff --git a/.gitattributes b/.gitattributes index 4f2a678b..027367a8 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,2 @@ -# Golden files are compared byte for byte, so line endings must survive checkout. *.golden -text - -# gofmt writes LF, so a checkout that hands back CRLF makes every file look unformatted. *.go text eol=lf From 63a7bee23f05e02f4e98995c11b189a536944cb1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 23:22:24 +0900 Subject: [PATCH 105/428] replace the loading spinner with a bar at the top of the block --- web/js/articles/article-authorship.tsx | 11 +--- web/js/articles/article-backlinks.tsx | 11 +--- web/js/articles/article-child.tsx | 11 +--- web/js/articles/article-delete.tsx | 11 +--- web/js/articles/article-diff.tsx | 11 +--- web/js/articles/article-editor.tsx | 11 +--- web/js/articles/article-files.tsx | 11 +--- web/js/articles/article-history.tsx | 11 +--- web/js/articles/article-lock.tsx | 11 +--- web/js/articles/article-parent.tsx | 11 +--- web/js/articles/article-rating.tsx | 11 +--- web/js/articles/article-rename.tsx | 11 +--- web/js/articles/article-source.tsx | 11 +--- web/js/articles/article-tags.tsx | 11 +--- web/js/articles/list-pages.tsx | 5 +- web/js/articles/site-changes.tsx | 5 +- web/js/articles/wanted-pages.tsx | 5 +- web/js/forum/forum-post-editor.tsx | 11 +--- web/js/forum/recent-posts-pagination.tsx | 5 +- web/js/forum/thread-pagination.tsx | 5 +- web/js/reactive/pages/search/Search.styles.ts | 7 ++- web/js/util/loader.tsx | 55 +++++++------------ 22 files changed, 48 insertions(+), 204 deletions(-) diff --git a/web/js/articles/article-authorship.tsx b/web/js/articles/article-authorship.tsx index 79f9fade..31dba399 100644 --- a/web/js/articles/article-authorship.tsx +++ b/web/js/articles/article-authorship.tsx @@ -21,20 +21,11 @@ interface Props { const Styles = styled.div` .text { &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-backlinks.tsx b/web/js/articles/article-backlinks.tsx index 97d9b23a..292e4b08 100644 --- a/web/js/articles/article-backlinks.tsx +++ b/web/js/articles/article-backlinks.tsx @@ -15,20 +15,11 @@ interface Props { const Styles = styled.div` .text { &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-child.tsx b/web/js/articles/article-child.tsx index 93fb12cb..192b6986 100644 --- a/web/js/articles/article-child.tsx +++ b/web/js/articles/article-child.tsx @@ -14,20 +14,11 @@ interface Props { const Styles = styled.div` .text { &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-delete.tsx b/web/js/articles/article-delete.tsx index 618382e4..b2d56cd9 100644 --- a/web/js/articles/article-delete.tsx +++ b/web/js/articles/article-delete.tsx @@ -17,20 +17,11 @@ interface Props { const Styles = styled.div` .text { &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-diff.tsx b/web/js/articles/article-diff.tsx index 4e71eac3..7eaf5a74 100644 --- a/web/js/articles/article-diff.tsx +++ b/web/js/articles/article-diff.tsx @@ -21,20 +21,11 @@ const Styles = styled.div<{ loading?: boolean }>` #source-code.loading { position: relative; min-height: calc(32px + 16px + 16px); - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-editor.tsx b/web/js/articles/article-editor.tsx index 9289dcec..7d568cd2 100644 --- a/web/js/articles/article-editor.tsx +++ b/web/js/articles/article-editor.tsx @@ -64,20 +64,11 @@ const Styles = styled.div` position: relative; &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-files.tsx b/web/js/articles/article-files.tsx index 09f188fe..18f0c9c2 100644 --- a/web/js/articles/article-files.tsx +++ b/web/js/articles/article-files.tsx @@ -40,20 +40,11 @@ const Styles = styled.div<{ loading?: boolean }>` .w-files-area.loading { position: relative; min-height: calc(32px + 16px + 16px); - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-history.tsx b/web/js/articles/article-history.tsx index 32a11349..e7bb93e8 100644 --- a/web/js/articles/article-history.tsx +++ b/web/js/articles/article-history.tsx @@ -25,20 +25,11 @@ const Styles = styled.div<{ loading?: boolean }>` #revision-list.loading { position: relative; min-height: calc(32px + 16px + 16px); - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-lock.tsx b/web/js/articles/article-lock.tsx index 732abd5f..7a55f8f5 100644 --- a/web/js/articles/article-lock.tsx +++ b/web/js/articles/article-lock.tsx @@ -16,20 +16,11 @@ interface Props { const Styles = styled.div` .text { &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-parent.tsx b/web/js/articles/article-parent.tsx index b7af28a8..d87802f3 100644 --- a/web/js/articles/article-parent.tsx +++ b/web/js/articles/article-parent.tsx @@ -15,20 +15,11 @@ interface Props { const Styles = styled.div` .text { &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-rating.tsx b/web/js/articles/article-rating.tsx index c7dc1557..b62ec055 100644 --- a/web/js/articles/article-rating.tsx +++ b/web/js/articles/article-rating.tsx @@ -23,20 +23,11 @@ const Styles = styled.div<{ loading?: boolean }>` #who-rated-page-area.loading { position: relative; min-height: calc(32px + 16px + 16px); - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-rename.tsx b/web/js/articles/article-rename.tsx index 4841f558..db5c6c42 100644 --- a/web/js/articles/article-rename.tsx +++ b/web/js/articles/article-rename.tsx @@ -17,20 +17,11 @@ interface Props { const Styles = styled.div` .text { &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-source.tsx b/web/js/articles/article-source.tsx index 2cba1421..0f19b862 100644 --- a/web/js/articles/article-source.tsx +++ b/web/js/articles/article-source.tsx @@ -17,20 +17,11 @@ const Styles = styled.div<{ loading?: boolean }>` #source-code.loading { position: relative; min-height: calc(32px + 16px + 16px); - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/article-tags.tsx b/web/js/articles/article-tags.tsx index 80d96331..acd8aaac 100644 --- a/web/js/articles/article-tags.tsx +++ b/web/js/articles/article-tags.tsx @@ -20,20 +20,11 @@ interface Props { const Styles = styled.div` .text { &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/articles/list-pages.tsx b/web/js/articles/list-pages.tsx index c8e19e9e..23807029 100644 --- a/web/js/articles/list-pages.tsx +++ b/web/js/articles/list-pages.tsx @@ -27,8 +27,7 @@ export function makeListPages(node: HTMLElement) { top: '0px', bottom: '-1px', display: 'none', - background: '#7777777f', - alignItems: 'center', + alignItems: 'flex-start', justifyContent: 'center', boxSizing: 'border-box', }) @@ -40,7 +39,7 @@ export function makeListPages(node: HTMLElement) { e.stopPropagation() loaderInto.style.display = 'flex' // because our loader is React, we should display it like this. - renderTo(loaderInto, ) + renderTo(loaderInto, ) // try { const { result: rendered } = await callModule({ diff --git a/web/js/articles/site-changes.tsx b/web/js/articles/site-changes.tsx index 08e5d977..6550b689 100644 --- a/web/js/articles/site-changes.tsx +++ b/web/js/articles/site-changes.tsx @@ -25,8 +25,7 @@ export function makeSiteChanges(node: HTMLElement) { top: '0px', bottom: '-1px', display: 'none', - background: '#7777777f', - alignItems: 'center', + alignItems: 'flex-start', justifyContent: 'center', boxSizing: 'border-box', }) @@ -40,7 +39,7 @@ export function makeSiteChanges(node: HTMLElement) { } loaderInto.style.display = 'flex' // because our loader is React, we should display it like this. - renderTo(loaderInto, ) + renderTo(loaderInto, ) // try { const { result: rendered } = await callModule({ diff --git a/web/js/articles/wanted-pages.tsx b/web/js/articles/wanted-pages.tsx index b4c6a1b8..bf72988f 100644 --- a/web/js/articles/wanted-pages.tsx +++ b/web/js/articles/wanted-pages.tsx @@ -26,8 +26,7 @@ export function makeWantedPages(node: HTMLElement) { top: '0px', bottom: '-1px', display: 'none', - background: '#7777777f', - alignItems: 'center', + alignItems: 'flex-start', justifyContent: 'center', boxSizing: 'border-box', }) @@ -39,7 +38,7 @@ export function makeWantedPages(node: HTMLElement) { e.stopPropagation() loaderInto.style.display = 'flex' // because our loader is React, we should display it like this. - renderTo(loaderInto, ) + renderTo(loaderInto, ) // try { const { result: rendered } = await callModule({ diff --git a/web/js/forum/forum-post-editor.tsx b/web/js/forum/forum-post-editor.tsx index 2cd872e9..bca98f0a 100644 --- a/web/js/forum/forum-post-editor.tsx +++ b/web/js/forum/forum-post-editor.tsx @@ -38,20 +38,11 @@ const Styles = styled.div` position: relative; &.loading { - &::after { - content: ' '; + .loader { position: absolute; - background: #0000003f; - z-index: 0; left: 0; right: 0; top: 0; - bottom: 0; - } - .loader { - position: absolute; - left: 16px; - top: 16px; z-index: 1; } } diff --git a/web/js/forum/recent-posts-pagination.tsx b/web/js/forum/recent-posts-pagination.tsx index bdc6622b..4b0f7767 100644 --- a/web/js/forum/recent-posts-pagination.tsx +++ b/web/js/forum/recent-posts-pagination.tsx @@ -25,8 +25,7 @@ export function makeRecentPosts(node: HTMLElement) { top: '0px', bottom: '-1px', display: 'none', - background: '#7777777f', - alignItems: 'center', + alignItems: 'flex-start', justifyContent: 'center', boxSizing: 'border-box', }) @@ -40,7 +39,7 @@ export function makeRecentPosts(node: HTMLElement) { } loaderInto.style.display = 'flex' // because our loader is React, we should display it like this. - renderTo(loaderInto, ) + renderTo(loaderInto, ) // try { const { result: rendered } = await callModule({ diff --git a/web/js/forum/thread-pagination.tsx b/web/js/forum/thread-pagination.tsx index 72d02a56..af991941 100644 --- a/web/js/forum/thread-pagination.tsx +++ b/web/js/forum/thread-pagination.tsx @@ -36,8 +36,7 @@ export function makeForumThread(node: HTMLElement) { top: '0px', bottom: '-1px', display: 'none', - background: '#7777777f', - alignItems: 'center', + alignItems: 'flex-start', justifyContent: 'center', boxSizing: 'border-box', }) @@ -62,7 +61,7 @@ export function makeForumThread(node: HTMLElement) { } loaderInto.style.display = 'flex' // because our loader is React, we should display it like this. - renderTo(loaderInto, ) + renderTo(loaderInto, ) // try { const pathParams = Object.assign({}, fBasePathParams) diff --git a/web/js/reactive/pages/search/Search.styles.ts b/web/js/reactive/pages/search/Search.styles.ts index 80359d16..39bd4997 100644 --- a/web/js/reactive/pages/search/Search.styles.ts +++ b/web/js/reactive/pages/search/Search.styles.ts @@ -81,10 +81,11 @@ export const LoaderContainer = styled.div` position: relative; ` -export const Loader = styled(BaseLoader).attrs({ size: 24 })` +export const Loader = styled(BaseLoader)` position: absolute; - left: calc(50% - 12px); - top: calc(50% - 12px); + left: 0; + right: 0; + top: 0; pointer-events: none; ` diff --git a/web/js/util/loader.tsx b/web/js/util/loader.tsx index 12a1ee1b..2d97b7a2 100644 --- a/web/js/util/loader.tsx +++ b/web/js/util/loader.tsx @@ -2,59 +2,42 @@ import * as React from 'react' import styled from 'styled-components' interface StyledProps { - size: number - borderSize: number color: string - className?: string } -type Props = Partial +type Props = Partial & { className?: string } const LoaderStyle = styled.div` - @keyframes ldio-rmqiozoxwgk { + @keyframes pwikit-loader { 0% { - transform: translate(-50%, -50%) rotate(0deg); + left: -35%; + right: 100%; } 100% { - transform: translate(-50%, -50%) rotate(360deg); + left: 100%; + right: -35%; } } - width: ${props => props.size}px; - height: ${props => props.size}px; - display: inline-block; + height: 2px; + width: 100%; + position: relative; overflow: hidden; - .ldio { - width: 100%; - height: 100%; - position: relative; - transform: translateZ(0) scale(1); - backface-visibility: hidden; - transform-origin: 0 0; /* see note above */ - div { - box-sizing: content-box; - animation: ldio-rmqiozoxwgk 1s linear infinite; - top: ${props => props.size / 2}px; - left: ${props => props.size / 2}px; - position: absolute; - width: ${props => props.size - props.borderSize * 2}px; - height: ${props => props.size - props.borderSize * 2}px; - border: ${props => props.borderSize}px solid ${props => props.color}; - border-top-color: transparent; - border-radius: 50%; - } + div { + position: absolute; + top: 0; + bottom: 0; + background: ${props => props.color}; + animation: pwikit-loader 1.1s ease-in-out infinite; + will-change: left, right; } ` -const Loader: React.FC = ({ className, size, borderSize, color }) => { - const defaultColor = '#e15b64' - +const Loader: React.FC = ({ className, color }) => { return ( - -
-
-
+ +
) } From 57531b5653a52ac2065f4b28dcbbe99f9cfe99c2 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 23:22:24 +0900 Subject: [PATCH 106/428] keep the page options in place when a panel opens --- web/js/entrypoints/page-options.tsx | 39 ----------------------------- 1 file changed, 39 deletions(-) diff --git a/web/js/entrypoints/page-options.tsx b/web/js/entrypoints/page-options.tsx index 7b6a3213..2e298521 100644 --- a/web/js/entrypoints/page-options.tsx +++ b/web/js/entrypoints/page-options.tsx @@ -114,27 +114,18 @@ const PageOptions: React.FC = ({ e.preventDefault() e.stopPropagation() setSubView('edit') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }, 1) }) const onRate = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('rating') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }, 1) }) const onTags = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('tags') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }, 1) }) const onCancelSubView = useConstCallback(() => { @@ -149,90 +140,60 @@ const PageOptions: React.FC = ({ e.preventDefault() e.stopPropagation() setSubView('history') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onFiles = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('files') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onSource = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('source') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onParent = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('parent') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onChild = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('child') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onLock = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('lock') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onRename = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('rename') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onDelete = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('delete') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onBacklinks = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('backlinks') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onAuthorship = useConstCallback(e => { e.preventDefault() e.stopPropagation() setSubView('authorship') - setTimeout(() => { - window.scrollTo(window.scrollX, document.body.scrollHeight) - }) }) const onWatch = useConstCallback(e => { From 53c9bef5fb69cf50d0482bcb790cf4ee2da7e556 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 23:22:32 +0900 Subject: [PATCH 107/428] drop the search attribution --- static/app.css | 16 ---------------- web/js/entrypoints/search.tsx | 8 -------- web/js/locales/zh-hans.json | 1 - 3 files changed, 25 deletions(-) diff --git a/static/app.css b/static/app.css index 68e0f119..1b0df933 100644 --- a/static/app.css +++ b/static/app.css @@ -387,22 +387,6 @@ content: '★ '; } -.w-search-footer { - margin-top: 14px; - text-align: right; - font-size: 11px; - color: var(--s-muted); -} - -.w-search-footer-icon { - height: 14px; - width: 14px; - vertical-align: -3px; - margin: 0 2px; - border-radius: 3px; - object-fit: cover; -} - .w-search .highlight { background: rgba(0, 0, 0, 0.12); color: inherit; diff --git a/web/js/entrypoints/search.tsx b/web/js/entrypoints/search.tsx index ce48d045..dfbb9997 100644 --- a/web/js/entrypoints/search.tsx +++ b/web/js/entrypoints/search.tsx @@ -1,6 +1,5 @@ import { t } from '~util/i18n' import * as React from 'react' -import Trans from '~util/trans' import { useEffect, useRef, useState } from 'react' import { searchModule, SearchResultItem } from '../api/search-module' import { highlightWords } from '../reactive/pages/search/Search.utils' @@ -194,13 +193,6 @@ const SearchModule: React.FC = ({ )} )} - -
- }} - /> -
) } diff --git a/web/js/locales/zh-hans.json b/web/js/locales/zh-hans.json index 610e60c3..57abca51 100644 --- a/web/js/locales/zh-hans.json +++ b/web/js/locales/zh-hans.json @@ -396,7 +396,6 @@ "search.page.title": "站内搜索", "search.page.updated-label": "最后修改:", "search.placeholder": "搜索…", - "search.powered-by": "由 {icon} Wikit Search 支持搜索服务", "search.tags-placeholder": "标签（空格分隔，- 排除）", "search.total": "共 {total} 条结果", "search.updated": "更新 {when}", From 97f56ca2349dcdfc43202e36c97d845b73e23927 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 23:22:32 +0900 Subject: [PATCH 108/428] let the site theme override the module styles --- internal/shell/templates/page.html | 2 +- internal/shell/testdata/shell.golden | 22 +++++++++++----------- web/templates/page.html | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/internal/shell/templates/page.html b/internal/shell/templates/page.html index 0cea8c9c..793537d7 100644 --- a/internal/shell/templates/page.html +++ b/internal/shell/templates/page.html @@ -31,10 +31,10 @@ + - {{if .ComputedStyle}} diff --git a/internal/shell/testdata/shell.golden b/internal/shell/testdata/shell.golden index 4381f04c..77b4cb79 100644 --- a/internal/shell/testdata/shell.golden +++ b/internal/shell/testdata/shell.golden @@ -27,10 +27,10 @@ + - @@ -144,10 +144,10 @@ + - @@ -306,10 +306,10 @@ + - @@ -446,10 +446,10 @@ + - @@ -562,10 +562,10 @@ + - @@ -688,10 +688,10 @@ + - @@ -804,10 +804,10 @@ + - @@ -933,10 +933,10 @@ + - @@ -1056,10 +1056,10 @@ + - @@ -1174,10 +1174,10 @@ + - @@ -1292,10 +1292,10 @@ + - diff --git a/web/templates/page.html b/web/templates/page.html index bd37301a..63d3986d 100644 --- a/web/templates/page.html +++ b/web/templates/page.html @@ -31,10 +31,10 @@ + - {% if computed_style %} From a18f5d0c134c6ae774fc22a4b5cfc5fe4fed9cca Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 23:22:40 +0900 Subject: [PATCH 109/428] answer the css module --- go.mod | 2 + go.sum | 6 ++ internal/module/render_test.go | 2 +- internal/modules/css.go | 43 +++++++++ internal/modules/css_test.go | 104 ++++++++++++++++++++++ internal/modules/testdata/css.golden | 52 +++++++++++ internal/modules/testdata/css_corpus.json | 66 ++++++++++++++ internal/modules/testdata/oracle_css.py | 47 ++++++++++ 8 files changed, 321 insertions(+), 1 deletion(-) create mode 100644 internal/modules/css.go create mode 100644 internal/modules/css_test.go create mode 100644 internal/modules/testdata/css.golden create mode 100644 internal/modules/testdata/css_corpus.json create mode 100644 internal/modules/testdata/oracle_css.py diff --git a/go.mod b/go.mod index a0400e85..544219ac 100644 --- a/go.mod +++ b/go.mod @@ -4,6 +4,7 @@ go 1.26 require ( github.com/jackc/pgx/v5 v5.10.0 + github.com/tdewolff/minify/v2 v2.24.17 golang.org/x/text v0.41.0 ) @@ -11,5 +12,6 @@ require ( github.com/jackc/pgpassfile v1.0.0 // indirect github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect github.com/jackc/puddle/v2 v2.2.2 // indirect + github.com/tdewolff/parse/v2 v2.8.16 // indirect golang.org/x/sync v0.22.0 // indirect ) diff --git a/go.sum b/go.sum index 31890d58..c0c8882f 100644 --- a/go.sum +++ b/go.sum @@ -16,6 +16,12 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +github.com/tdewolff/minify/v2 v2.24.17 h1:6AbitfVyq0M7aW6i+XL7+49DeTQZwloOMs9O574arBg= +github.com/tdewolff/minify/v2 v2.24.17/go.mod h1:kVqn9vxXUKtlHexSNrWbYePqioOT5mc4ou/KVSMpfCM= +github.com/tdewolff/parse/v2 v2.8.16 h1:bLk5svUOQRkW/Y2SJ+DeENSIkZBcTIkq+Atyv5D8feI= +github.com/tdewolff/parse/v2 v2.8.16/go.mod h1:XdsoSFThlVIRIajAuqz1evNY7bagZS8LBOPA3aVopwQ= +github.com/tdewolff/test v1.0.12 h1:7F21DqIajswxuche0geHdrUZRCWE4oko4b7bcmkkrxk= +github.com/tdewolff/test v1.0.12/go.mod h1:XPuWBzvdUzhCuxWO1ojpXsyzsA5bFoS3tO/Q3kFuTG8= golang.org/x/sync v0.22.0 h1:SZjpbeLmrCk4xhRSZFNZW5gFUeCeFgjekvI/+gfScek= golang.org/x/sync v0.22.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0= golang.org/x/text v0.41.0 h1:vz/seA0lnX87Othu2f/0L24RcgrXD9/YFTSuGjj3rH8= diff --git a/internal/module/render_test.go b/internal/module/render_test.go index ced13779..dd07785c 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search"} + ported := []string{"css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/css.go b/internal/modules/css.go new file mode 100644 index 00000000..78a45777 --- /dev/null +++ b/internal/modules/css.go @@ -0,0 +1,43 @@ +package modules + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/tdewolff/minify/v2" + "github.com/tdewolff/minify/v2/css" +) + +func init() { module.Register("css", renderCSS) } + +var cssMinifier = newCSSMinifier() + +func newCSSMinifier() *minify.M { + m := minify.New() + m.AddFunc("text/css", css.Minify) + return m +} + +func renderCSS(env module.Env, params map[string]string, body string) (string, error) { + head := module.BoolParam(pathUnder(env, params), "head", false) + + source := strings.ReplaceAll(body, nbsp, " ") + minified, err := cssMinifier.String("text/css", source) + if err != nil { + minified = source + } + minified = strings.ReplaceAll(minified, "<", lessThan) + + if env.Page != nil { + env.Page.AddCSS += source + "\n" + if head { + env.Page.ComputedStyle += minified + } + } + + if head { + return "\n" + ind8, nil + } + return "\n" + ind12 + `` + + "\n" + ind8 + "\n" + ind8, nil +} diff --git a/internal/modules/css_test.go b/internal/modules/css_test.go new file mode 100644 index 00000000..fc9f7a28 --- /dev/null +++ b/internal/modules/css_test.go @@ -0,0 +1,104 @@ +package modules + +import ( + "encoding/json" + "fmt" + "os" + "path/filepath" + "sort" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +const ( + cssGolden = "testdata/css.golden" + cssCorpus = "testdata/css_corpus.json" +) + +type cssCase struct { + Name string `json:"name"` + Body string `json:"body"` + Params map[string]string `json:"params,omitempty"` + Path map[string]string `json:"path,omitempty"` +} + +func cssCases() []cssCase { + return []cssCase{ + {Name: "plain", Body: "#page-content { color : red ; }"}, + {Name: "head", Body: "#page-content { color : red ; }", Params: map[string]string{"head": "true"}}, + {Name: "head-from-path", Body: "a { color : red }", Path: map[string]string{"head": "yes"}}, + {Name: "head-false", Body: "a { color : red }", Params: map[string]string{"head": "no"}}, + {Name: "head-junk", Body: "a { color : red }", Params: map[string]string{"head": "maybe"}}, + {Name: "empty", Body: ""}, + {Name: "comment-only", Body: "/* nothing but a comment */"}, + {Name: "nbsp", Body: "a { color:red }"}, + {Name: "angle-bracket", Body: "a > b { content: \"\" }"}, + {Name: "at-import", Body: "@import url(\"x.css\");\na { color: red }"}, + {Name: "media", Body: "@media (max-width: 767px) {\n #main { padding : 0 ; }\n}"}, + {Name: "two-rules", Body: ".a { color: #ff0000 }\n.b { margin: 0.50em }"}, + {Name: "malformed", Body: "a { color: red"}, + } +} + +func cssEnv(path page.PathParams) module.Env { + return module.Env{Page: page.NewContext(&db.Article{ID: 1, Name: "main", Category: "_default"}, nil, path, nil)} +} + +func TestRenderCSSMatchesGolden(t *testing.T) { + cases := cssCases() + + var b strings.Builder + for _, c := range cases { + env := cssEnv(sortedCSSPath(c.Path)) + got, err := renderCSS(env, c.Params, c.Body) + if err != nil { + t.Fatalf("renderCSS(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\nreturned: %q\ncomputed: %q\naddcss: %q\n", + c.Name, got, env.Page.ComputedStyle, env.Page.AddCSS) + } + compareCSSGolden(t, b.String(), cases) +} + +func sortedCSSPath(params map[string]string) page.PathParams { + keys := make([]string, 0, len(params)) + for key := range params { + keys = append(keys, key) + } + sort.Strings(keys) + + var path page.PathParams + for _, key := range keys { + path = path.Put(page.PathParam{Key: key, Value: params[key]}) + } + return path +} + +func compareCSSGolden(t *testing.T, got string, corpus any) { + t.Helper() + if *update { + data, err := json.MarshalIndent(corpus, "", " ") + if err != nil { + t.Fatalf("Marshal(%s) err = %v, want nil", cssCorpus, err) + } + if err := os.WriteFile(filepath.FromSlash(cssCorpus), append(data, '\n'), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", cssCorpus, err) + } + if err := os.WriteFile(filepath.FromSlash(cssGolden), []byte(got), 0o644); err != nil { + t.Fatalf("WriteFile(%s) err = %v, want nil", cssGolden, err) + } + return + } + want, err := os.ReadFile(filepath.FromSlash(cssGolden)) + if err != nil { + t.Fatalf("ReadFile(%s) err = %v, want nil", cssGolden, err) + } + if got != string(want) { + gotAt, wantAt := firstRateDiff(got, string(want)) + t.Errorf("renderCSS = %q, want %q", gotAt, wantAt) + } +} diff --git a/internal/modules/testdata/css.golden b/internal/modules/testdata/css.golden new file mode 100644 index 00000000..54aa4a58 --- /dev/null +++ b/internal/modules/testdata/css.golden @@ -0,0 +1,52 @@ +=== plain +returned: "\n \n \n " +computed: "" +addcss: "#page-content { color : red ; }\n" +=== head +returned: "\n " +computed: "#page-content{color:red}" +addcss: "#page-content { color : red ; }\n" +=== head-from-path +returned: "\n " +computed: "a{color:red}" +addcss: "a { color : red }\n" +=== head-false +returned: "\n \n \n " +computed: "" +addcss: "a { color : red }\n" +=== head-junk +returned: "\n \n \n " +computed: "" +addcss: "a { color : red }\n" +=== empty +returned: "\n \n \n " +computed: "" +addcss: "\n" +=== comment-only +returned: "\n \n \n " +computed: "" +addcss: "/* nothing but a comment */\n" +=== nbsp +returned: "\n \n \n " +computed: "" +addcss: "a { color:red }\n" +=== angle-bracket +returned: "\n \n \n " +computed: "" +addcss: "a > b { content: \"\" }\n" +=== at-import +returned: "\n \n \n " +computed: "" +addcss: "@import url(\"x.css\");\na { color: red }\n" +=== media +returned: "\n \n \n " +computed: "" +addcss: "@media (max-width: 767px) {\n #main { padding : 0 ; }\n}\n" +=== two-rules +returned: "\n \n \n " +computed: "" +addcss: ".a { color: #ff0000 }\n.b { margin: 0.50em }\n" +=== malformed +returned: "\n \n \n " +computed: "" +addcss: "a { color: red\n" diff --git a/internal/modules/testdata/css_corpus.json b/internal/modules/testdata/css_corpus.json new file mode 100644 index 00000000..589446c5 --- /dev/null +++ b/internal/modules/testdata/css_corpus.json @@ -0,0 +1,66 @@ +[ + { + "name": "plain", + "body": "#page-content { color : red ; }" + }, + { + "name": "head", + "body": "#page-content { color : red ; }", + "params": { + "head": "true" + } + }, + { + "name": "head-from-path", + "body": "a { color : red }", + "path": { + "head": "yes" + } + }, + { + "name": "head-false", + "body": "a { color : red }", + "params": { + "head": "no" + } + }, + { + "name": "head-junk", + "body": "a { color : red }", + "params": { + "head": "maybe" + } + }, + { + "name": "empty", + "body": "" + }, + { + "name": "comment-only", + "body": "/* nothing but a comment */" + }, + { + "name": "nbsp", + "body": "a { color:red }" + }, + { + "name": "angle-bracket", + "body": "a \u003e b { content: \"\u003c/style\u003e\" }" + }, + { + "name": "at-import", + "body": "@import url(\"x.css\");\na { color: red }" + }, + { + "name": "media", + "body": "@media (max-width: 767px) {\n #main { padding : 0 ; }\n}" + }, + { + "name": "two-rules", + "body": ".a { color: #ff0000 }\n.b { margin: 0.50em }" + }, + { + "name": "malformed", + "body": "a { color: red" + } +] diff --git a/internal/modules/testdata/oracle_css.py b/internal/modules/testdata/oracle_css.py new file mode 100644 index 00000000..950ca06d --- /dev/null +++ b/internal/modules/testdata/oracle_css.py @@ -0,0 +1,47 @@ +"""Records what the CSS module returns and what it leaves on the context. + +Run with the corpus the Go test exports under -update: + + docker compose exec -T -e CSS_CORPUS="$(cat internal/modules/testdata/css_corpus.json)" \ + web python manage.py shell < internal/modules/testdata/oracle_css.py + +The minified text will not match Go, which uses a different minifier; the point +of this oracle is everything around it. Compare with +internal/modules/testdata/css.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules.css +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.site import Site + +CORPUS = json.loads(os.environ['CSS_CORPUS']) + + +def main(): + article = articles.get_article('main') + if article is None: + raise SystemExit('main is missing; run manage.py seed first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + threadvars.put('current_user', AnonymousUser()) + context = RenderContext(article, None, dict(case.get('path') or {}), AnonymousUser()) + body = modules.css.render(context, case.get('params') or {}, case.get('body') or '') + out.append('=== %s\nreturned: %s\ncomputed: %s\naddcss: %s\n' % ( + case['name'], + json.dumps(str(body)), + json.dumps(context.computed_style), + json.dumps(context.add_css))) + sys.stdout.write(''.join(out)) + + +main() From 6c477894a0304573623f857953b19abb465b47dc Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 30 Aug 2026 23:22:41 +0900 Subject: [PATCH 110/428] seed a page that carries custom css --- internal/difftest/corpus/articles.txt | 2 + internal/page/testdata/oracle_seed.py | 15 +++- internal/repo/testdata/forumcategory.golden | 96 +++++++++++---------- internal/repo/testdata/forumstart.golden | 16 ++-- 4 files changed, 75 insertions(+), 54 deletions(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 40a5b517..6830e415 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -21,6 +21,8 @@ /probe:tagged /probe:taggedplain /probe:unknownmodule +!/probecss:styled +!/probecss:styledhead /probe:full/nomodule/true /probe:redirect diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index f0be314f..e5d8dd0c 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -198,6 +198,17 @@ def vote(article, user, rate): tagged = make_article('probe:tagged', 'Probe Tagged', '[[module PagesByTag tag="lang:en"]]', None) taggedplain = make_article('probe:taggedplain', 'Probe Tagged Plain', '[[module PagesByTag tag="zeta"]]', None) +styled = make_article('probecss:styled', 'Probe Styled', + NL.join(['[[module CSS]]', + '#page-content { color : red ; }', + '@media (max-width: 767px) { #main { padding : 0 ; } }', + '[[/module]]', + 'styled body']), None) +styledhead = make_article('probecss:styledhead', 'Probe Styled Head', + NL.join(['[[module CSS head="true"]]', + '.a { color: #ff0000 }', + '[[/module]]', + 'head styled body']), None) unknownmodule = make_article('probe:unknownmodule', 'Probe Unknown Module', '[[module NoSuchModule]]', None) # pwikit resolves a display name here and Django does not, so this page is the @@ -351,7 +362,7 @@ def vote(article, user, rate): for article in (parent, full, bare, rated, unrated, third, quarter, unratable, half, included, host, redirect, described, - imaged, tagged, taggedplain, unknownmodule, bydisplay, listed, listjoined, + imaged, tagged, taggedplain, unknownmodule, bydisplay, styled, styledhead, listed, listjoined, listnowrap, listsections, listtags, listempty, listurl, listbyvotes): freeze(article) @@ -360,6 +371,6 @@ def vote(article, user, rate): print('seeded', ', '.join(a.full_name for a in (parent, full, bare, rated, unrated, third, quarter, unratable, half, included, host, redirect, described, imaged, tagged, taggedplain, - unknownmodule, bydisplay, listed, listjoined, + unknownmodule, bydisplay, styled, styledhead, listed, listjoined, listnowrap, listsections, listtags, listempty, listurl, listbyvotes))) diff --git a/internal/repo/testdata/forumcategory.golden b/internal/repo/testdata/forumcategory.golden index 0a328c82..ca5bcbc6 100644 --- a/internal/repo/testdata/forumcategory.golden +++ b/internal/repo/testdata/forumcategory.golden @@ -809,19 +809,23 @@ status: 200
- 第 1 页; 共 2 页 + 第 1 页; 共 3 页 1 + + 2 + + - 2 + 3 @@ -841,14 +845,14 @@ status: 200
- Probe Third + Probe Styled
作者：系统
- 08.28.2026 13:17 + 08.30.2026 13:50 0 @@ -862,14 +866,14 @@ status: 200
- Probe List By Votes + Probe Styled Head
作者：系统
- 08.27.2026 10:52 + 08.30.2026 13:50 0 @@ -883,14 +887,14 @@ status: 200
- Probe List Url + Probe Third
作者：系统
- 08.27.2026 10:52 + 08.28.2026 13:17 0 @@ -904,14 +908,14 @@ status: 200
- Probe List Empty + Probe List By Votes
作者：系统
- 08.27.2026 10:52 + 08.27.2026 10:52 0 @@ -925,14 +929,14 @@ status: 200
- Probe List Tags + Probe List Url
作者：系统
- 08.27.2026 10:52 + 08.27.2026 10:52 0 @@ -946,14 +950,14 @@ status: 200
- Probe List Sections + Probe List Empty
作者：系统
- 08.27.2026 10:52 + 08.27.2026 10:52 0 @@ -967,14 +971,14 @@ status: 200
- Probe List No Wrapper + Probe List Tags
作者：系统
- 08.27.2026 10:52 + 08.27.2026 10:52 0 @@ -988,14 +992,14 @@ status: 200
- Probe List Joined + Probe List Sections
作者：系统
- 08.27.2026 10:52 + 08.27.2026 10:52 0 @@ -1009,14 +1013,14 @@ status: 200
- Probe Listed + Probe List No Wrapper
作者：系统
- 08.27.2026 10:51 + 08.27.2026 10:52 0 @@ -1030,14 +1034,14 @@ status: 200
- recent-posts + Probe List Joined
作者：系统
- 08.26.2026 16:54 + 08.27.2026 10:52 0 @@ -1051,14 +1055,14 @@ status: 200
- new-thread + Probe Listed
作者：系统
- 08.26.2026 16:54 + 08.27.2026 10:51 0 @@ -1072,14 +1076,14 @@ status: 200
- category + recent-posts
作者：系统
- 08.26.2026 16:54 + 08.26.2026 16:54 0 @@ -1093,14 +1097,14 @@ status: 200
- thread + new-thread
作者：系统
- 08.26.2026 16:54 + 08.26.2026 16:54 0 @@ -1114,14 +1118,14 @@ status: 200
- top-impl + category
作者：系统
- 08.26.2026 16:54 + 08.26.2026 16:54 0 @@ -1135,14 +1139,14 @@ status: 200
- Probe By Display Name + thread
作者：系统
- 08.26.2026 16:49 + 08.26.2026 16:54 0 @@ -1156,14 +1160,14 @@ status: 200
- site + top-impl
作者：系统
- 08.26.2026 16:13 + 08.26.2026 16:54 0 @@ -1177,14 +1181,14 @@ status: 200
- wiki-syntax-guide + Probe By Display Name
作者：系统
- 08.26.2026 16:13 + 08.26.2026 16:49 0 @@ -1198,14 +1202,14 @@ status: 200
- start + site
作者：系统
- 08.26.2026 16:12 + 08.26.2026 16:13 0 @@ -1219,14 +1223,14 @@ status: 200
- Probe Redirect + wiki-syntax-guide
作者：系统
- 08.26.2026 14:01 + 08.26.2026 16:13 0 @@ -1240,14 +1244,14 @@ status: 200
- Probe Unknown Module + start
作者：系统
- 08.26.2026 14:01 + 08.26.2026 16:12 0 @@ -1260,19 +1264,23 @@ status: 200
- 第 1 页; 共 2 页 + 第 1 页; 共 3 页 1 + + 2 + + - 2 + 3 diff --git a/internal/repo/testdata/forumstart.golden b/internal/repo/testdata/forumstart.golden index de59fa52..df8cd3dd 100644 --- a/internal/repo/testdata/forumstart.golden +++ b/internal/repo/testdata/forumstart.golden @@ -57,7 +57,7 @@ status: 200
Probe Comments
article comments
- 39 + 41 4 @@ -215,7 +215,7 @@ status: 200
Probe Comments
article comments
- 39 + 41 4 @@ -405,7 +405,7 @@ status: 200
Probe Comments
article comments
- 39 + 41 4 @@ -563,7 +563,7 @@ status: 200
Probe Comments
article comments
- 39 + 41 4 @@ -789,7 +789,7 @@ status: 200
Probe Comments
article comments
- 39 + 41 4 @@ -955,7 +955,7 @@ status: 200
Probe Comments
article comments
- 39 + 41 4 @@ -1113,7 +1113,7 @@ status: 200
Probe Comments
article comments
- 39 + 41 4 @@ -1303,7 +1303,7 @@ status: 200
Probe Comments
article comments
- 39 + 41 4 From 663b2c2a71152e688061ecfe39bc3f1725c4daac Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 14:05:08 +0900 Subject: [PATCH 111/428] seed a page with one log entry of every type --- internal/page/testdata/oracle_seed.py | 68 ++++++++++++++++++++++-- internal/repo/testdata/forumstart.golden | 16 +++--- 2 files changed, 73 insertions(+), 11 deletions(-) diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index e5d8dd0c..8faa4504 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -17,7 +17,7 @@ from django.utils import timezone from web.controllers import articles -from web.models.articles import Article, Category, Tag, TagsCategory, Vote +from web.models.articles import Article, ArticleLogEntry, Category, Tag, TagsCategory, Vote from web.models.forum import ForumCategory, ForumPost, ForumPostVersion, ForumSection, ForumThread from web.models.notifications import UserNotification, UserNotificationMapping, UserNotificationSubscription from web.models.settings import Settings @@ -29,6 +29,7 @@ CREATED_AT = datetime.datetime(2021, 3, 4, 5, 6, 7, tzinfo=datetime.timezone.utc) UPDATED_AT = datetime.datetime(2022, 7, 8, 9, 10, 11, tzinfo=datetime.timezone.utc) POSTED_AT = datetime.datetime(2023, 9, 10, 11, 12, 13, tzinfo=datetime.timezone.utc) +LOGGED_AT = datetime.datetime(2024, 11, 12, 13, 14, 15, tzinfo=datetime.timezone.utc) POSTED_MINUTES = itertools.count() THREAD_MINUTES = itertools.count() @@ -209,6 +210,8 @@ def vote(article, user, rate): '.a { color: #ff0000 }', '[[/module]]', 'head styled body']), None) +changes = make_article('probe:changes', 'Probe Changes', + '[[module SiteChanges]]', author) unknownmodule = make_article('probe:unknownmodule', 'Probe Unknown Module', '[[module NoSuchModule]]', None) # pwikit resolves a display name here and Django does not, so this page is the @@ -348,6 +351,59 @@ def vote(article, user, rate): for index, member in enumerate(crowd): vote(half, member, 1 if index == 0 else -1) +changes_comments, _ = ForumThread.objects.get_or_create(article=changes) +ForumThread.objects.filter(pk=changes_comments.pk).update( + created_at=CREATED_AT, updated_at=UPDATED_AT) + +LOG_TYPE = ArticleLogEntry.LogEntryType +LOG_REVS = itertools.count(1) + +ArticleLogEntry.objects.filter(article=changes).exclude(type=LOG_TYPE.New).delete() + + +def log_entry(kind, meta, user=author, comment=''): + ArticleLogEntry.objects.create( + article=changes, user=user, type=kind, meta=meta, + comment=comment, rev_number=next(LOG_REVS)) + + +log_entry(LOG_TYPE.Source, {'version_id': 0}, comment='a source edit') +log_entry(LOG_TYPE.Source, {'version_id': 0}, comment=' ') +log_entry(LOG_TYPE.Source, {'version_id': 0}, user=None) +log_entry(LOG_TYPE.Source, {'version_id': 0}, user=coauthor) +log_entry(LOG_TYPE.Source, {'version_id': 0}, user=voter) +log_entry(LOG_TYPE.Title, {'prev_title': 'Probe "Old" ', 'title': 'Probe Changes'}) +log_entry(LOG_TYPE.Name, {'prev_name': 'probe:was-here', 'name': 'probe:changes'}) +log_entry(LOG_TYPE.Tags, {'added_tags': [{'id': 1, 'name': 'alpha'}], 'removed_tags': []}) +log_entry(LOG_TYPE.Tags, {'added_tags': [], 'removed_tags': [{'id': 2, 'name': 'lang:en'}]}) +log_entry(LOG_TYPE.Tags, {'added_tags': [{'id': 1, 'name': 'alpha'}, {'id': 3, 'name': 'Zeta'}], + 'removed_tags': [{'id': 2, 'name': 'lang:en'}]}) +log_entry(LOG_TYPE.Tags, {}) +log_entry(LOG_TYPE.Parent, {'prev_parent': None, 'parent': 'probe:parent'}) +log_entry(LOG_TYPE.Parent, {'prev_parent': 'probe:parent', 'parent': None}) +log_entry(LOG_TYPE.Parent, {'prev_parent': 'probe:parent', 'parent': 'probe:full'}) +log_entry(LOG_TYPE.Parent, {'prev_parent': None, 'parent': None}) +log_entry(LOG_TYPE.FileAdded, {'name': 'cover.png', 'id': 1}) +log_entry(LOG_TYPE.FileDeleted, {'name': 'cover.png', 'id': 1}) +log_entry(LOG_TYPE.FileRenamed, {'prev_name': 'cover.png', 'name': 'banner.png'}) +log_entry(LOG_TYPE.VotesDeleted, + {'rating_mode': 'updown', 'rating': 3, 'votes_count': 5, 'popularity': 60}) +log_entry(LOG_TYPE.VotesDeleted, + {'rating_mode': 'updown', 'rating': -3.7, 'votes_count': 9, 'popularity': 11}) +log_entry(LOG_TYPE.VotesDeleted, + {'rating_mode': 'stars', 'rating': 4.25, 'votes_count': 4, 'popularity': 75}) +log_entry(LOG_TYPE.VotesDeleted, + {'rating_mode': 'disabled', 'rating': 0, 'votes_count': 0, 'popularity': 0}) +log_entry(LOG_TYPE.Authorship, {'added_authors': [author.id], 'removed_authors': []}) +log_entry(LOG_TYPE.Authorship, {'added_authors': [author.id, voter.id], 'removed_authors': []}) +log_entry(LOG_TYPE.Authorship, {'added_authors': [], 'removed_authors': [coauthor.id]}) +log_entry(LOG_TYPE.Authorship, {'added_authors': [voter.id], 'removed_authors': [coauthor.id]}) +log_entry(LOG_TYPE.Authorship, {}) +log_entry(LOG_TYPE.Wikidot, {}, comment='imported from wikidot') +log_entry(LOG_TYPE.Revert, {'rev_number': 2, 'subtypes': ['source', 'title']}) +log_entry(LOG_TYPE.Revert, {'rev_number': 0, 'subtypes': []}) +log_entry(LOG_TYPE.Revert, {'rev_number': 1}) + stars_category, _ = Category.objects.get_or_create(name='probestars') Settings.objects.update_or_create( category=stars_category, @@ -362,15 +418,21 @@ def vote(article, user, rate): for article in (parent, full, bare, rated, unrated, third, quarter, unratable, half, included, host, redirect, described, - imaged, tagged, taggedplain, unknownmodule, bydisplay, styled, styledhead, listed, listjoined, + imaged, tagged, taggedplain, unknownmodule, bydisplay, styled, styledhead, changes, listed, listjoined, listnowrap, listsections, listtags, listempty, listurl, listbyvotes): freeze(article) +for offset, entry_id in enumerate(ArticleLogEntry.objects.order_by('id').values_list('id', flat=True)): + ArticleLogEntry.objects.filter(pk=entry_id).update( + created_at=LOGGED_AT + datetime.timedelta(minutes=offset)) + print('site rating_mode =', site_settings.rating_mode) print('forum sections =', ForumSection.objects.count(), 'categories =', ForumCategory.objects.count()) +print('log entries =', ArticleLogEntry.objects.count()) print('seeded', ', '.join(a.full_name for a in (parent, full, bare, rated, unrated, third, quarter, unratable, half, included, host, redirect, described, imaged, tagged, taggedplain, - unknownmodule, bydisplay, styled, styledhead, listed, listjoined, + unknownmodule, bydisplay, styled, styledhead, changes, + listed, listjoined, listnowrap, listsections, listtags, listempty, listurl, listbyvotes))) diff --git a/internal/repo/testdata/forumstart.golden b/internal/repo/testdata/forumstart.golden index df8cd3dd..46e6691f 100644 --- a/internal/repo/testdata/forumstart.golden +++ b/internal/repo/testdata/forumstart.golden @@ -57,7 +57,7 @@ status: 200
Probe Comments
article comments
- 41 + 42 4 @@ -215,7 +215,7 @@ status: 200
Probe Comments
article comments
- 41 + 42 4 @@ -405,7 +405,7 @@ status: 200
Probe Comments
article comments
- 41 + 42 4 @@ -563,7 +563,7 @@ status: 200
Probe Comments
article comments
- 41 + 42 4 @@ -789,7 +789,7 @@ status: 200
Probe Comments
article comments
- 41 + 42 4 @@ -955,7 +955,7 @@ status: 200
Probe Comments
article comments
- 41 + 42 4 @@ -1113,7 +1113,7 @@ status: 200
Probe Comments
article comments
- 41 + 42 4 @@ -1303,7 +1303,7 @@ status: 200
Probe Comments
article comments
- 41 + 42 4 From 76b4f415250f57df58a8e049f971a6b59ec7da37 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 14:05:09 +0900 Subject: [PATCH 112/428] add the queries a site changes list needs --- internal/db/sitechanges.go | 219 ++++++++++++++++++++++++++++++++ internal/db/sitechanges_test.go | 61 +++++++++ 2 files changed, 280 insertions(+) create mode 100644 internal/db/sitechanges.go create mode 100644 internal/db/sitechanges_test.go diff --git a/internal/db/sitechanges.go b/internal/db/sitechanges.go new file mode 100644 index 00000000..3bd9081c --- /dev/null +++ b/internal/db/sitechanges.go @@ -0,0 +1,219 @@ +package db + +import ( + "context" + "fmt" + "strconv" + "strings" + "time" +) + +type SiteChangeFilter struct { + Hidden []string + + Types []string + + Category string + HasCategory bool + + HasUser bool + UserIDs []int64 + WithSystem bool +} + +type SiteChange struct { + RevNumber int + Type string + Meta []byte + Comment string + CreatedAt time.Time + UserID *int64 + + ArticleTitle string + ArticleCategory string + ArticleName string +} + +// A revert carries the types it undid in meta rather than in the type column, +// so asking for one type has to reach both places. +func (f SiteChangeFilter) build(b *listBuilder) string { + if len(f.Hidden) > 0 { + b.where = append(b.where, "NOT (a.category = ANY("+b.arg(f.Hidden)+"))") + } + if len(f.Types) > 0 { + ors := []string{"e.type = ANY(" + b.arg(f.Types) + ")"} + for _, t := range f.Types { + ors = append(ors, "(e.meta -> 'subtypes') @> "+b.arg(strconv.Quote(t))+"::jsonb") + } + b.where = append(b.where, "("+strings.Join(ors, " OR ")+")") + } + if f.HasCategory { + b.where = append(b.where, "a.category = "+b.arg(f.Category)) + } + if f.HasUser { + or := "e.user_id = ANY(" + b.arg(f.UserIDs) + ")" + if f.WithSystem { + or += " OR e.user_id IS NULL" + } + b.where = append(b.where, "("+or+")") + } + + sql := "FROM web_articlelogentry e\nJOIN web_article a ON a.id = e.article_id" + if len(b.where) > 0 { + sql += "\nWHERE " + strings.Join(b.where, "\n AND ") + } + return sql +} + +func (f SiteChangeFilter) selectSQL(b *listBuilder, offset, limit int) string { + sql := `SELECT e.rev_number, e.type, e.meta, e.comment, e.created_at, e.user_id, + a.title, a.category, a.name +` + f.build(b) + "\nORDER BY e.created_at DESC" + + "\nLIMIT " + b.arg(limit) + "\nOFFSET " + b.arg(offset) + return sql +} + +// Exposed so the schema-drift test can send a built statement to Postgres the +// way it sends the ones written out by hand. +func (f SiteChangeFilter) SelectSQL(offset, limit int) (string, []any) { + b := &listBuilder{} + return f.selectSQL(b, offset, limit), b.args +} + +func (d *DB) SiteChanges(ctx context.Context, f SiteChangeFilter, offset, limit int) ([]SiteChange, error) { + b := &listBuilder{} + sql := f.selectSQL(b, offset, limit) + + rows, err := d.pool.Query(ctx, sql, b.args...) + if err != nil { + return nil, fmt.Errorf("query site changes: %w", err) + } + defer rows.Close() + + var out []SiteChange + for rows.Next() { + var c SiteChange + if err := rows.Scan(&c.RevNumber, &c.Type, &c.Meta, &c.Comment, &c.CreatedAt, + &c.UserID, &c.ArticleTitle, &c.ArticleCategory, &c.ArticleName); err != nil { + return nil, fmt.Errorf("scan site change: %w", err) + } + out = append(out, c) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read site changes: %w", err) + } + return out, nil +} + +func (d *DB) SiteChangeCount(ctx context.Context, f SiteChangeFilter) (int, error) { + b := &listBuilder{} + sql := "SELECT COUNT(*)\n" + f.build(b) + + var n int + if err := d.pool.QueryRow(ctx, sql, b.args...).Scan(&n); err != nil { + return 0, fmt.Errorf("count site changes: %w", err) + } + return n, nil +} + +var qArticleCategories = register("ArticleCategories", ` +SELECT DISTINCT category +FROM web_article +WHERE NOT (category = ANY($1))`) + +func (d *DB) ArticleCategories(ctx context.Context, hidden []string) ([]string, error) { + if hidden == nil { + hidden = []string{} + } + rows, err := d.pool.Query(ctx, qArticleCategories, hidden) + if err != nil { + return nil, fmt.Errorf("query article categories: %w", err) + } + defer rows.Close() + + var out []string + for rows.Next() { + var name string + if err := rows.Scan(&name); err != nil { + return nil, fmt.Errorf("scan article category: %w", err) + } + out = append(out, name) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read article categories: %w", err) + } + return out, nil +} + +var qUserIDsByName = register("UserIDsByName", ` +SELECT id +FROM web_user +WHERE username = $1 OR wikidot_username = $1`) + +// Django uppercases both sides rather than leaning on citext, and a wiki that +// renamed the column to text would silently start matching case-sensitively. +var qUserIDsByNamePart = register("UserIDsByNamePart", ` +SELECT id +FROM web_user +WHERE UPPER(username::text) LIKE UPPER($1) OR UPPER(wikidot_username::text) LIKE UPPER($1)`) + +func (d *DB) UserIDsByName(ctx context.Context, name string, partial bool) ([]int64, error) { + sql, arg := qUserIDsByName, name + if partial { + sql, arg = qUserIDsByNamePart, likeContains(name) + } + rows, err := d.pool.Query(ctx, sql, arg) + if err != nil { + return nil, fmt.Errorf("query users named %q: %w", name, err) + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + return nil, fmt.Errorf("scan user named %q: %w", name, err) + } + out = append(out, id) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read users named %q: %w", name, err) + } + return out, nil +} + +var qUsersByIDs = register("UsersByIDs", ` +SELECT `+userColumns+` +FROM web_user +WHERE id = ANY($1)`) + +func (d *DB) UsersByIDs(ctx context.Context, ids []int64) ([]User, error) { + if len(ids) == 0 { + return nil, nil + } + rows, err := d.pool.Query(ctx, qUsersByIDs, ids) + if err != nil { + return nil, fmt.Errorf("query users by id: %w", err) + } + defer rows.Close() + + var out []User + for rows.Next() { + var u User + dest, finish := userDest(&u) + if err := rows.Scan(dest...); err != nil { + return nil, fmt.Errorf("scan user by id: %w", err) + } + finish() + out = append(out, u) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read users by id: %w", err) + } + return out, nil +} + +func likeContains(s string) string { + r := strings.NewReplacer(`\`, `\\`, `%`, `\%`, `_`, `\_`) + return "%" + r.Replace(s) + "%" +} diff --git a/internal/db/sitechanges_test.go b/internal/db/sitechanges_test.go new file mode 100644 index 00000000..f5a76fa9 --- /dev/null +++ b/internal/db/sitechanges_test.go @@ -0,0 +1,61 @@ +package db + +import ( + "context" + "strings" + "testing" +) + +func siteChangeFilterVariants() map[string]SiteChangeFilter { + return map[string]SiteChangeFilter{ + "empty": {}, + "hidden": {Hidden: []string{"admin"}}, + "one-type": {Types: []string{"source"}}, + "many-types": {Types: []string{"source", "title", "revert"}}, + "category": {Category: "probe", HasCategory: true}, + "users": {HasUser: true, UserIDs: int64s(1, 2)}, + "users-none": {HasUser: true}, + "system": {HasUser: true, UserIDs: int64s(1), WithSystem: true}, + "everything": {Hidden: []string{"admin"}, Types: []string{"tags"}, Category: "probe", HasCategory: true, HasUser: true, UserIDs: int64s(1), WithSystem: true}, + } +} + +func TestSiteChangeFilterSQLMatchesSchema(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + + for name, filter := range siteChangeFilterVariants() { + if _, err := d.SiteChanges(ctx, filter, 5, 20); err != nil { + t.Errorf("SiteChanges(%s) err = %v, want nil", name, err) + } + if _, err := d.SiteChangeCount(ctx, filter); err != nil { + t.Errorf("SiteChangeCount(%s) err = %v, want nil", name, err) + } + } +} + +func TestSiteChangeSelectSQLNamesEveryArgument(t *testing.T) { + for name, filter := range siteChangeFilterVariants() { + sql, args := filter.SelectSQL(3, 10) + for i := range args { + if !strings.Contains(sql, placeholder(i+1)) { + t.Errorf("SelectSQL(%s) leaves %s unused", name, placeholder(i+1)) + } + } + } +} + +func TestLikeContainsEscapesWildcards(t *testing.T) { + cases := map[string]string{ + "probe": "%probe%", + "a_b": `%a\_b%`, + "a%b": `%a\%b%`, + `a\b`: `%a\\b%`, + "": "%%", + } + for in, want := range cases { + if got := likeContains(in); got != want { + t.Errorf("likeContains(%q) = %q, want %q", in, got, want) + } + } +} From 7ce14c3ffb1530157c2adef7ef698e4434fb115f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 14:05:09 +0900 Subject: [PATCH 113/428] answer the site changes list --- internal/i18n/locales/zh-hans.json | 37 ++ internal/module/module.go | 6 + internal/module/render_test.go | 2 +- internal/modules/sitechanges.go | 802 +++++++++++++++++++++++++++++ internal/repo/modules.go | 20 + 5 files changed, 866 insertions(+), 1 deletion(-) create mode 100644 internal/modules/sitechanges.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 4f5e2eb3..ab8a895a 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -65,6 +65,43 @@ "module-recentposts-select": "选择版块：", "module-recentposts-title": "论坛最新帖子", "module-search-placeholder": "搜索文章标题或内容…", + "module-sitechanges-category": "选择分类：", + "module-sitechanges-category-all": "所有分类", + "module-sitechanges-comment-authors-added": "添加作者：{names}。", + "module-sitechanges-comment-authors-removed": "移除作者：{names}。", + "module-sitechanges-comment-file-added": "已上传文件：\"{name}\"", + "module-sitechanges-comment-file-deleted": "已删除文件：\"{name}\"", + "module-sitechanges-comment-file-renamed": "文件已从 \"{prev}\" 重命名为 \"{name}\"", + "module-sitechanges-comment-name": "页面已从 \"{prev}\" 重命名为 \"{name}\"", + "module-sitechanges-comment-new": "创建新页面", + "module-sitechanges-comment-parent-changed": "父页面已从 \"{prev}\" 更改为 \"{parent}\"", + "module-sitechanges-comment-parent-removed": "已移除父页面 \"{prev}\"", + "module-sitechanges-comment-parent-set": "已设置父页面 \"{parent}\"", + "module-sitechanges-comment-revert": "已回退页面至版本 #{rev}", + "module-sitechanges-comment-tags-added": "添加标签：{tags}。", + "module-sitechanges-comment-tags-removed": "移除标签：{tags}。", + "module-sitechanges-comment-title": "标题已从 \"{prev}\" 更改为 \"{title}\"", + "module-sitechanges-comment-votes": "已重置页面评分：{rating}（投票数：{votes}，人气：{popularity}%）", + "module-sitechanges-comment-votes-none": "无", + "module-sitechanges-perpage": "每页条目数：", + "module-sitechanges-refresh": "刷新列表", + "module-sitechanges-revision": "版本", + "module-sitechanges-type-authorship": "作者已更改", + "module-sitechanges-type-file-added": "文件已添加", + "module-sitechanges-type-file-deleted": "文件已删除", + "module-sitechanges-type-file-renamed": "文件已重命名", + "module-sitechanges-type-name": "页面已重命名/删除", + "module-sitechanges-type-new": "新页面已创建", + "module-sitechanges-type-parent": "父页面已更改", + "module-sitechanges-type-source": "文章内容已更改", + "module-sitechanges-type-tags": "标签已更改", + "module-sitechanges-type-title": "标题已更改", + "module-sitechanges-type-votes-deleted": "投票已更改", + "module-sitechanges-type-wikidot": "从Wikidot移植的编辑", + "module-sitechanges-types": "编辑类型：", + "module-sitechanges-types-all": "全部", + "module-sitechanges-username": "按用户名筛选：", + "module-sitechanges-username-hint": "使用前缀\"~\"进行部分
用户名匹配筛选", "module-unknown": "模块 '{name}' 不存在", "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", diff --git a/internal/module/module.go b/internal/module/module.go index d4325270..c6fae4af 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -37,6 +37,12 @@ type Data interface { ArticleByID(id int64) (*db.Article, error) RenderUserByID(id *int64) (string, error) + SiteChanges(f db.SiteChangeFilter, offset, limit int) ([]db.SiteChange, error) + SiteChangeCount(f db.SiteChangeFilter) (int, error) + ArticleCategories(hidden []string) ([]string, error) + UserIDsByName(name string, partial bool) ([]int64, error) + UsersByIDs(ids []int64) ([]db.User, error) + ForumSections() ([]db.ForumSection, error) ForumSection(id int64) (*db.ForumSection, error) ForumCategories() ([]db.ForumCategory, error) diff --git a/internal/module/render_test.go b/internal/module/render_test.go index dd07785c..f43f9596 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search"} + ported := []string{"css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/sitechanges.go b/internal/modules/sitechanges.go new file mode 100644 index 00000000..2ca3bf85 --- /dev/null +++ b/internal/modules/sitechanges.go @@ -0,0 +1,802 @@ +package modules + +import ( + "encoding/json" + "errors" + "fmt" + "slices" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/pynum" +) + +func init() { module.Register("sitechanges", renderSiteChanges) } + +// Every path parameter Python chokes on raises out of the module and reaches +// the reader as one block, so nothing here records which one it was. +var errSiteChange = errors.New("modules: site change is not renderable") + +// Sorting this list would reorder the type checkboxes on the page. +var siteChangeTypes = []string{ + "source", "title", "name", "tags", "new", "parent", + "file_added", "file_deleted", "file_renamed", "votes_deleted", + "authorship", "wikidot", "revert", +} + +var siteChangeFlags = map[string]string{ + "source": "S", "title": "T", "name": "R", "tags": "A", "new": "N", + "parent": "M", "file_added": "F", "file_deleted": "F", "file_renamed": "F", + "votes_deleted": "V", "authorship": "C", "wikidot": "W", +} + +type siteChangeFlag struct { + id string + desc string +} + +type siteChangeRow struct { + revNumber int + flags []siteChangeFlag + comment string + author string + date string + title string + category string + url string +} + +type siteChangesOption struct { + name string + id string + selected bool +} + +type siteChangesView struct { + rows []siteChangeRow + categories []string + types []siteChangesOption + typesEmpty bool + category string + userName string + perPage int + pagination string + pathParams string + params string +} + +func renderSiteChanges(env module.Env, params map[string]string, _ string) (string, error) { + if env.Data == nil { + return "", siteChangesFailed(env) + } + var path page.PathParams + if env.Page != nil { + path = env.Page.PathParams + } + + view, err := siteChangesBuild(env, path, params) + if errors.Is(err, errSiteChange) { + return "", siteChangesFailed(env) + } + if err != nil { + return "", err + } + return siteChangesHTML(env, view), nil +} + +func siteChangesFailed(env module.Env) error { + return &module.Error{Message: env.Text("module-failed", "name", env.Name)} +} + +func siteChangesBuild(env module.Env, path page.PathParams, params map[string]string) (siteChangesView, error) { + filterTypes, err := siteChangeFilterTypes(path) + if err != nil { + return siteChangesView{}, err + } + perPage, err := siteChangePerPage(path) + if err != nil { + return siteChangesView{}, err + } + category, err := siteChangeParam(path, "category", "*") + if err != nil { + return siteChangesView{}, err + } + category = strings.ToLower(category) + userName, err := siteChangeParam(path, "username", "") + if err != nil { + return siteChangesView{}, err + } + userName = strings.TrimSpace(strings.ToLower(userName)) + + hidden, err := env.Data.HiddenCategories(env.User) + if err != nil { + return siteChangesView{}, err + } + filter := db.SiteChangeFilter{Hidden: hidden, Types: filterTypes} + if category != "*" { + filter.Category, filter.HasCategory = category, true + } + if err := siteChangeUserFilter(env, &filter, userName); err != nil { + return siteChangesView{}, err + } + + total, err := env.Data.SiteChangeCount(filter) + if err != nil { + return siteChangesView{}, err + } + // Django divides by the page size and then slices with it, so zero and + // negative both raise before anything reaches the reader. + if perPage <= 0 { + return siteChangesView{}, errSiteChange + } + + current := 1 + if n, err := pynum.Int(path.Get("p")); err == nil { + current = n + } + if current < 1 { + current = 1 + } + maxPage := max(1, (total+perPage-1)/perPage) + if current > maxPage { + current = maxPage + } + + view := siteChangesView{ + typesEmpty: len(filterTypes) == 0, + category: category, + userName: userName, + perPage: perPage, + pagination: listpages.Pagination(env.Loc, "", current, maxPage), + } + changes, err := env.Data.SiteChanges(filter, (current-1)*perPage, perPage) + if err != nil { + return siteChangesView{}, err + } + for _, change := range changes { + row, err := siteChangeRowOf(env, change) + if err != nil { + return siteChangesView{}, err + } + view.rows = append(view.rows, row) + } + + if view.categories, err = env.Data.ArticleCategories(hidden); err != nil { + return siteChangesView{}, err + } + slices.Sort(view.categories) + + for _, t := range siteChangeTypes { + if t == "revert" { + continue + } + _, desc := siteChangeTypeName(env, t) + view.types = append(view.types, siteChangesOption{ + name: desc, id: t, selected: slices.Contains(filterTypes, t), + }) + } + + if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + return siteChangesView{}, err + } + if view.params, err = pyjson.Marshal(paramsObject(params, nil)); err != nil { + return siteChangesView{}, err + } + return view, nil +} + +func siteChangeParam(path page.PathParams, key, def string) (string, error) { + param, ok := path.Lookup(key) + if !ok { + return def, nil + } + if param.Bare { + return "", errSiteChange + } + return param.Value, nil +} + +func siteChangeFilterTypes(path page.PathParams) ([]string, error) { + var out []string + for _, param := range path { + if !slices.Contains(siteChangeTypes, param.Key) { + continue + } + if param.Bare { + return nil, errSiteChange + } + if strings.ToLower(param.Value) == "true" && !slices.Contains(out, param.Key) { + out = append(out, param.Key) + } + } + return out, nil +} + +func siteChangePerPage(path page.PathParams) (int, error) { + raw, err := siteChangeParam(path, "perpage", "20") + if err != nil { + return 0, err + } + n, err := pynum.Int(raw) + if err != nil { + return 0, errSiteChange + } + return n, nil +} + +// A search that is a piece of "system" also takes in the entries no account +// made, which is why the partial form asks for containment the other way up. +func siteChangeUserFilter(env module.Env, filter *db.SiteChangeFilter, userName string) error { + partial := strings.HasPrefix(userName, "~") + search := userName + if partial { + search = strings.TrimSpace(userName[len("~"):]) + } + if search == "" { + return nil + } + + ids, err := env.Data.UserIDsByName(search, partial) + if err != nil { + return err + } + filter.HasUser, filter.UserIDs = true, ids + if partial { + filter.WithSystem = strings.Contains("system", search) + } else { + filter.WithSystem = search == "system" + } + return nil +} + +func siteChangeTypeName(env module.Env, t string) (string, string) { + flag, ok := siteChangeFlags[t] + if !ok { + return "?", "?" + } + return flag, env.Text("module-sitechanges-type-" + strings.ReplaceAll(t, "_", "-")) +} + +func siteChangeRowOf(env module.Env, change db.SiteChange) (siteChangeRow, error) { + meta, err := siteChangeMetaOf(change.Meta) + if err != nil { + return siteChangeRow{}, err + } + + row := siteChangeRow{ + revNumber: change.RevNumber, + date: renderDate(env, change.CreatedAt), + title: change.ArticleTitle, + category: change.ArticleCategory, + url: "/" + change.ArticleName, + } + if change.ArticleCategory != "_default" { + row.url = "/" + change.ArticleCategory + ":" + change.ArticleName + } + + if raw, ok := meta["subtypes"]; ok { + var subtypes []string + if err := json.Unmarshal(raw, &subtypes); err != nil { + return siteChangeRow{}, errSiteChange + } + for _, subtype := range subtypes { + id, desc := siteChangeTypeName(env, subtype) + row.flags = append(row.flags, siteChangeFlag{id: id, desc: desc}) + } + } else { + id, desc := siteChangeTypeName(env, change.Type) + row.flags = append(row.flags, siteChangeFlag{id: id, desc: desc}) + } + + if row.comment, err = siteChangeComment(env, change, meta); err != nil { + return siteChangeRow{}, err + } + if row.author, err = env.Data.RenderUserByID(change.UserID); err != nil { + return siteChangeRow{}, err + } + return row, nil +} + +func siteChangeComment(env module.Env, change db.SiteChange, meta siteChangeMeta) (string, error) { + if strings.TrimSpace(change.Comment) != "" { + return change.Comment, nil + } + + switch change.Type { + case "new": + return env.Text("module-sitechanges-comment-new"), nil + case "title": + prev, title, err := meta.two("prev_title", "title") + if err != nil { + return "", err + } + return env.Text("module-sitechanges-comment-title", "prev", prev, "title", title), nil + case "name": + prev, name, err := meta.two("prev_name", "name") + if err != nil { + return "", err + } + return env.Text("module-sitechanges-comment-name", "prev", prev, "name", name), nil + case "tags": + return siteChangeTagComment(env, meta) + case "parent": + return siteChangeParentComment(env, meta) + case "file_added": + name, err := meta.str("name") + if err != nil { + return "", err + } + return env.Text("module-sitechanges-comment-file-added", "name", name), nil + case "file_deleted": + name, err := meta.str("name") + if err != nil { + return "", err + } + return env.Text("module-sitechanges-comment-file-deleted", "name", name), nil + case "file_renamed": + prev, name, err := meta.two("prev_name", "name") + if err != nil { + return "", err + } + return env.Text("module-sitechanges-comment-file-renamed", "prev", prev, "name", name), nil + case "votes_deleted": + return siteChangeVotesComment(env, meta) + case "authorship": + return siteChangeAuthorComment(env, meta) + case "revert": + rev, err := meta.str("rev_number") + if err != nil { + return "", err + } + return env.Text("module-sitechanges-comment-revert", "rev", rev), nil + } + return "", nil +} + +func siteChangeTagComment(env module.Env, meta siteChangeMeta) (string, error) { + added, err := meta.names("added_tags") + if err != nil { + return "", err + } + removed, err := meta.names("removed_tags") + if err != nil { + return "", err + } + + var parts []string + if len(added) > 0 { + parts = append(parts, env.Text("module-sitechanges-comment-tags-added", + "tags", strings.Join(added, ", "))) + } + if len(removed) > 0 { + parts = append(parts, env.Text("module-sitechanges-comment-tags-removed", + "tags", strings.Join(removed, ", "))) + } + return strings.Join(parts, " "), nil +} + +func siteChangeParentComment(env module.Env, meta siteChangeMeta) (string, error) { + prev, parent, err := meta.two("prev_parent", "parent") + if err != nil { + return "", err + } + switch { + case meta.truthy("prev_parent") && meta.truthy("parent"): + return env.Text("module-sitechanges-comment-parent-changed", "prev", prev, "parent", parent), nil + case meta.truthy("prev_parent"): + return env.Text("module-sitechanges-comment-parent-removed", "prev", prev), nil + case meta.truthy("parent"): + return env.Text("module-sitechanges-comment-parent-set", "parent", parent), nil + } + return "", nil +} + +func siteChangeVotesComment(env module.Env, meta siteChangeMeta) (string, error) { + mode, err := meta.str("rating_mode") + if err != nil { + return "", err + } + votes, err := meta.str("votes_count") + if err != nil { + return "", err + } + popularity, err := meta.str("popularity") + if err != nil { + return "", err + } + + rating := env.Text("module-sitechanges-comment-votes-none") + switch mode { + case "updown": + n, err := meta.integer("rating") + if err != nil { + return "", err + } + rating = fmt.Sprintf("%+d", n) + case "stars": + f, err := meta.float("rating") + if err != nil { + return "", err + } + rating = strconv.FormatFloat(f, 'f', 1, 64) + } + return env.Text("module-sitechanges-comment-votes", + "rating", rating, "votes", votes, "popularity", popularity), nil +} + +func siteChangeAuthorComment(env module.Env, meta siteChangeMeta) (string, error) { + label := func(key string) (string, error) { + ids, err := meta.ids(key) + if err != nil { + return "", err + } + users, err := env.Data.UsersByIDs(ids) + if err != nil { + return "", err + } + names := make([]string, 0, len(users)) + for i := range users { + names = append(names, users[i].DisplayLabel()) + } + return strings.Join(names, ", "), nil + } + + added, err := label("added_authors") + if err != nil { + return "", err + } + removed, err := label("removed_authors") + if err != nil { + return "", err + } + + var parts []string + if added != "" { + parts = append(parts, env.Text("module-sitechanges-comment-authors-added", "names", added)) + } + if removed != "" { + parts = append(parts, env.Text("module-sitechanges-comment-authors-removed", "names", removed)) + } + return strings.Join(parts, " "), nil +} + +type siteChangeMeta map[string]json.RawMessage + +func siteChangeMetaOf(raw []byte) (siteChangeMeta, error) { + if len(raw) == 0 { + return siteChangeMeta{}, nil + } + var meta siteChangeMeta + if err := json.Unmarshal(raw, &meta); err != nil { + return nil, errSiteChange + } + return meta, nil +} + +func (m siteChangeMeta) str(key string) (string, error) { + raw, ok := m[key] + if !ok { + return "", errSiteChange + } + return pyStr(raw), nil +} + +func (m siteChangeMeta) two(first, second string) (string, string, error) { + a, err := m.str(first) + if err != nil { + return "", "", err + } + b, err := m.str(second) + if err != nil { + return "", "", err + } + return a, b, nil +} + +func (m siteChangeMeta) truthy(key string) bool { + switch text := strings.TrimSpace(string(m[key])); text { + case "", "null", "false", "0", "0.0", `""`, "[]", "{}": + return false + } + return true +} + +func (m siteChangeMeta) names(key string) ([]string, error) { + raw, ok := m[key] + if !ok { + return nil, nil + } + var items []map[string]json.RawMessage + if err := json.Unmarshal(raw, &items); err != nil { + return nil, errSiteChange + } + out := make([]string, 0, len(items)) + for _, item := range items { + name, ok := item["name"] + if !ok { + return nil, errSiteChange + } + out = append(out, pyStr(name)) + } + return out, nil +} + +func (m siteChangeMeta) ids(key string) ([]int64, error) { + raw, ok := m[key] + if !ok { + return nil, nil + } + var ids []int64 + if err := json.Unmarshal(raw, &ids); err != nil { + return nil, errSiteChange + } + return ids, nil +} + +func (m siteChangeMeta) integer(key string) (int, error) { + raw, ok := m[key] + if !ok { + return 0, errSiteChange + } + if quoted, ok := unquoteJSON(raw); ok { + n, err := pynum.Int(quoted) + if err != nil { + return 0, errSiteChange + } + return n, nil + } + f, err := strconv.ParseFloat(strings.TrimSpace(string(raw)), 64) + if err != nil { + return 0, errSiteChange + } + return int(f), nil +} + +func (m siteChangeMeta) float(key string) (float64, error) { + raw, ok := m[key] + if !ok { + return 0, errSiteChange + } + if quoted, ok := unquoteJSON(raw); ok { + f, err := pynum.Float(quoted) + if err != nil { + return 0, errSiteChange + } + return f, nil + } + f, err := strconv.ParseFloat(strings.TrimSpace(string(raw)), 64) + if err != nil { + return 0, errSiteChange + } + return f, nil +} + +func unquoteJSON(raw json.RawMessage) (string, bool) { + if !strings.HasPrefix(strings.TrimSpace(string(raw)), `"`) { + return "", false + } + var out string + if err := json.Unmarshal(raw, &out); err != nil { + return "", false + } + return out, true +} + +// The comment lines are f-strings over whatever the log entry stored, so a +// value that is not a string still has to come out the way Python prints it. +func pyStr(raw json.RawMessage) string { + text := strings.TrimSpace(string(raw)) + switch text { + case "null": + return "None" + case "true": + return "True" + case "false": + return "False" + } + if unquoted, ok := unquoteJSON(raw); ok { + return unquoted + } + return text +} + +func siteChangesHTML(env module.Env, v siteChangesView) string { + var b strings.Builder + b.WriteString(`
` + + "\n" + ind12 + `` + + "\n" + ind12 + `
` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `` + + "\n" + ind16 + `
` + env.Text("module-sitechanges-types") + `` + + "\n" + ind24 + `` + + "\n" + ind24 + `
` + + "\n" + ind24) + for _, option := range v.types { + b.WriteString("\n" + ind28 + `` + + "\n" + ind28 + `
` + + "\n" + ind24) + } + b.WriteString("\n" + ind20 + `
` + env.Text("module-sitechanges-category") + `` + + "\n" + ind24 + `` + + "\n" + ind20 + `
` + env.Text("module-sitechanges-username") + + `
` + env.Text("module-sitechanges-username-hint") + + `		` + + "\n" + ind24 + ` ` + + "\n" + ind20 + `
` + env.Text("module-sitechanges-perpage") + `` + + "\n" + ind24 + `` + + "\n" + ind20 + `
` + + "\n" + ind16 + `
` + + "\n" + ind20 + `` + + "\n" + ind16 + `
` + + "\n" + ind12 + `
` + + "\n" + ind12 + `
` + + "\n" + ind16 + v.pagination + + "\n" + ind16) + + for _, row := range v.rows { + b.WriteString("\n" + ind16 + `
` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind24 + `` + + "\n" + ind24 + `` + + "\n" + ind24 + `` + + "\n" + ind24 + `` + + "\n" + ind24 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `` + + "\n" + ind20 + `
` + + "\n" + ind28 + `` + + "\n" + ind32) + if row.category != "_default" { + b.WriteString("\n" + ind36 + escape.HTML(row.category) + `:` + + "\n" + ind32) + } + b.WriteString("\n" + ind32 + escape.HTML(row.title) + + "\n" + ind28 + `` + + "\n" + ind24 + `` + + "\n" + ind28) + for _, flag := range row.flags { + b.WriteString(`` + + escape.HTML(flag.id) + ``) + } + b.WriteString("\n" + ind24 + `` + + "\n" + ind28 + row.date + + "\n" + ind24 + `` + + "\n" + ind28 + `(` + env.Text("module-sitechanges-revision") + ` ` + + strconv.Itoa(row.revNumber) + `) ` + + "\n" + ind24 + `` + + "\n" + ind28 + row.author + + "\n" + ind24 + `
` + + "\n" + ind20) + if row.comment != "" { + b.WriteString("\n" + ind24 + `
` + + "\n" + ind28 + escape.HTML(row.comment) + + "\n" + ind24 + `
` + + "\n" + ind20) + } + b.WriteString("\n" + ind16 + `
` + + "\n" + ind16) + } + + b.WriteString("\n" + ind16 + v.pagination + + "\n" + ind12 + `
` + + "\n" + ind8 + `
`) + return b.String() +} + +const siteChangesStyle = ` + .changes-list{} + + .changes-list .pager{ + margin: 1em 0; + text-align: center; + } + + .changes-list-item{ + /* overflow: hidden; */ + padding: 2px; + } + + .changes-list-item:hover{ + background-color: #F2F2F2; + } + + .changes-list-item table{ + width: 98%; + + } + + .changes-list-item .title{ + + } + + .changes-list-item .mod-date{ + text-align: right; + width: 13em; + + } + .changes-list-item .revision-no{ + text-align: center; + width: 7em; + } + .changes-list-item .flags{ + text-align: left; + width: 3em; + } + .changes-list-item .mod-by{ + width: 15em; + text-align: left; + } + + .changes-list-item .comments{ + font-size: 95%; + color: #666; + margin: 2px 0; + }` diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 522a2156..b73b0791 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -228,3 +228,23 @@ func (m moduleData) ForumThreadObject(t *db.ForumThread, u *db.User) (*perms.Obj func (m moduleData) ForumPostObject(p *db.ForumThreadPost, thread *perms.Object, u *db.User) *perms.Object { return NewPerms(m.repo.ctx, m.repo.db).ForumPost(p, thread, u) } + +func (m moduleData) SiteChanges(f db.SiteChangeFilter, offset, limit int) ([]db.SiteChange, error) { + return m.repo.db.SiteChanges(m.repo.ctx, f, offset, limit) +} + +func (m moduleData) SiteChangeCount(f db.SiteChangeFilter) (int, error) { + return m.repo.db.SiteChangeCount(m.repo.ctx, f) +} + +func (m moduleData) ArticleCategories(hidden []string) ([]string, error) { + return m.repo.db.ArticleCategories(m.repo.ctx, hidden) +} + +func (m moduleData) UserIDsByName(name string, partial bool) ([]int64, error) { + return m.repo.db.UserIDsByName(m.repo.ctx, name, partial) +} + +func (m moduleData) UsersByIDs(ids []int64) ([]db.User, error) { + return m.repo.db.UsersByIDs(m.repo.ctx, ids) +} From 55a3f82e61fd16c4cfd9175e3981bbdaad78f28b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 14:05:09 +0900 Subject: [PATCH 114/428] check the site changes list against django --- internal/repo/sitechanges_test.go | 118 + internal/repo/testdata/oracle_sitechanges.py | 61 + internal/repo/testdata/sitechanges.golden | 17200 ++++++++++++++++ .../repo/testdata/sitechanges_corpus.json | 322 + 4 files changed, 17701 insertions(+) create mode 100644 internal/repo/sitechanges_test.go create mode 100644 internal/repo/testdata/oracle_sitechanges.py create mode 100644 internal/repo/testdata/sitechanges.golden create mode 100644 internal/repo/testdata/sitechanges_corpus.json diff --git a/internal/repo/sitechanges_test.go b/internal/repo/sitechanges_test.go new file mode 100644 index 00000000..31550743 --- /dev/null +++ b/internal/repo/sitechanges_test.go @@ -0,0 +1,118 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +const ( + siteChangesGolden = "testdata/sitechanges.golden" + siteChangesCorpus = "testdata/sitechanges_corpus.json" +) + +type siteChangesCase struct { + Name string `json:"name"` + Viewer string `json:"viewer"` + Params map[string]string `json:"params,omitempty"` + Path map[string]string `json:"path,omitempty"` + Bare []string `json:"bare,omitempty"` +} + +func siteChangesCases() []siteChangesCase { + return []siteChangesCase{ + {Name: "all", Viewer: ""}, + {Name: "signed-in", Viewer: "probe-author", Path: map[string]string{"perpage": "5"}}, + {Name: "second-page", Path: map[string]string{"p": "2"}}, + {Name: "last-page", Path: map[string]string{"p": "4"}}, + {Name: "past-the-end", Path: map[string]string{"p": "99", "perpage": "5"}}, + {Name: "below-one", Path: map[string]string{"p": "-3", "perpage": "5"}}, + {Name: "junk-page", Path: map[string]string{"p": "later", "perpage": "5"}}, + {Name: "perpage-10", Path: map[string]string{"p": "3", "perpage": "10"}}, + {Name: "perpage-200", Path: map[string]string{"category": "nav", "perpage": "200"}}, + {Name: "last-partial-page", Path: map[string]string{"p": "12", "perpage": "7"}}, + {Name: "perpage-junk", Path: map[string]string{"perpage": "many"}}, + {Name: "perpage-zero", Path: map[string]string{"perpage": "0"}}, + {Name: "perpage-negative", Path: map[string]string{"perpage": "-5"}}, + {Name: "perpage-bare", Bare: []string{"perpage"}}, + {Name: "category-probe", Path: map[string]string{"perpage": "5", "category": "probe"}}, + {Name: "category-uppercase", Path: map[string]string{"perpage": "5", "category": "PROBE"}}, + {Name: "category-default", Path: map[string]string{"perpage": "5", "category": "_default"}}, + {Name: "category-star", Path: map[string]string{"perpage": "5", "category": "*"}}, + {Name: "category-missing", Path: map[string]string{"perpage": "5", "category": "nosuchcategory"}}, + {Name: "category-bare", Bare: []string{"category"}}, + {Name: "user-exact", Path: map[string]string{"perpage": "5", "username": "probe-author"}}, + {Name: "user-uppercase", Path: map[string]string{"perpage": "5", "username": "PROBE-AUTHOR"}}, + {Name: "user-padded", Path: map[string]string{"perpage": "5", "username": " probe-author "}}, + {Name: "user-wikidot", Path: map[string]string{"perpage": "5", "username": "probe-wd-original"}}, + {Name: "user-system", Path: map[string]string{"perpage": "5", "username": "system"}}, + {Name: "user-unknown", Path: map[string]string{"perpage": "5", "username": "nobody-at-all"}}, + {Name: "user-partial", Path: map[string]string{"perpage": "5", "username": "~probe"}}, + {Name: "user-partial-system", Path: map[string]string{"perpage": "5", "username": "~sys"}}, + {Name: "user-partial-empty", Path: map[string]string{"perpage": "5", "username": "~"}}, + {Name: "user-partial-wildcard", Path: map[string]string{"perpage": "5", "username": "~%"}}, + {Name: "types-source", Path: map[string]string{"perpage": "5", "source": "true"}}, + {Name: "types-tags", Path: map[string]string{"perpage": "5", "tags": "true"}}, + {Name: "types-revert", Path: map[string]string{"perpage": "5", "revert": "true"}}, + {Name: "types-title", Path: map[string]string{"perpage": "5", "title": "true"}}, + {Name: "types-two", Path: map[string]string{"perpage": "5", "source": "true", "title": "true"}}, + {Name: "types-not-true", Path: map[string]string{"perpage": "5", "source": "false"}}, + {Name: "types-mixed-case", Path: map[string]string{"perpage": "5", "source": "TRUE"}}, + {Name: "types-unknown", Path: map[string]string{"perpage": "5", "nosuchtype": "true"}}, + {Name: "types-bare", Bare: []string{"source"}}, + {Name: "with-params", Params: map[string]string{"limit": "5"}, Path: map[string]string{"perpage": "5"}}, + {Name: "everything-at-once", Viewer: "probe-author", + Path: map[string]string{"perpage": "5", "category": "probe", "username": "~probe", "source": "true"}}, + } +} + +func TestSiteChangesMatchesGolden(t *testing.T) { + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := siteChangesCases() + + site, err := d.SiteByHosts(ctx, []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) + } + article, err := d.ArticleByName(ctx, "probe:changes") + if err != nil { + t.Fatalf("ArticleByName(probe:changes) err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + var viewer *db.User + if c.Viewer != "" { + viewer, err = d.UserByUsername(ctx, c.Viewer) + if err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + } + + path := sortedPath(c.Path) + for _, key := range c.Bare { + path = path.Put(page.PathParam{Key: key, Bare: true}) + } + pc := page.NewContext(article, article, path, viewer) + r := New(ctx, d, users, Options{Loc: loc, Site: site, User: viewer}) + + body, err := r.RenderModule(pc, "SiteChanges", c.Params, "") + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\ntitle: %s\nstatus: %d\n%s\n", c.Name, pc.Title, pc.Status, body) + } + compareGolden(t, b.String(), cases, siteChangesGolden, siteChangesCorpus) +} diff --git a/internal/repo/testdata/oracle_sitechanges.py b/internal/repo/testdata/oracle_sitechanges.py new file mode 100644 index 00000000..78ca2e3b --- /dev/null +++ b/internal/repo/testdata/oracle_sitechanges.py @@ -0,0 +1,61 @@ +"""Records what the SiteChanges module renders for a reader browsing the log. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e SITECHANGES_CORPUS="$(cat internal/repo/testdata/sitechanges_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_sitechanges.py + +Compare the output with internal/repo/testdata/sitechanges.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.site import Site +from web.models.users import User +from web.util.json import replace_json_dumps_default + +replace_json_dumps_default() + +CORPUS = json.loads(os.environ['SITECHANGES_CORPUS']) + + +def path_params(case): + params = dict(sorted((case.get('path') or {}).items())) + for key in case.get('bare') or []: + params[key] = None + return params + + +def main(): + article = articles.get_article('probe:changes') + if article is None: + raise SystemExit('probe:changes is missing; run oracle_seed.py first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + if case['viewer']: + viewer = User.objects.get(username=case['viewer']) + threadvars.put('current_user', viewer) + context = RenderContext(article, article, path_params(case), viewer) + params = dict(sorted((case.get('params') or {}).items())) + try: + body = modules.render_module('SiteChanges', context, params) + except ModuleError as error: + body = '!error: %s' % error.message + out.append('=== %s\ntitle: %s\nstatus: %d\n%s\n' % ( + case['name'], context.title, context.status, body)) + sys.stdout.write(''.join(out)) + + +main() diff --git a/internal/repo/testdata/sitechanges.golden b/internal/repo/testdata/sitechanges.golden new file mode 100644 index 00000000..a7b55403 --- /dev/null +++ b/internal/repo/testdata/sitechanges.golden @@ -0,0 +1,17200 @@ +=== all +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 5 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:30 + + (版本 26) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：probevoter。 移除作者：wd:Probe WD。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:29 + + (版本 25) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 移除作者：wd:Probe WD。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:28 + + (版本 24) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：Probe Author, probevoter。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:27 + + (版本 23) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：Probe Author。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:26 + + (版本 22) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：无（投票数：0，人气：0%） +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:25 + + (版本 21) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：4.2（投票数：4，人气：75%） +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:24 + + (版本 20) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：-3（投票数：9，人气：11%） +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:23 + + (版本 19) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：+3（投票数：5，人气：60%） +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + F + + 11.12.2024 14:22 + + (版本 18) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 文件已从 "cover.png" 重命名为 "banner.png" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + F + + 11.12.2024 14:21 + + (版本 17) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已删除文件："cover.png" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + F + + 11.12.2024 14:20 + + (版本 16) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已上传文件："cover.png" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + M + + 11.12.2024 14:19 + + (版本 15) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + M + + 11.12.2024 14:18 + + (版本 14) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 父页面已从 "probe:parent" 更改为 "probe:full" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + M + + 11.12.2024 14:17 + + (版本 13) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已移除父页面 "probe:parent" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + M + + 11.12.2024 14:16 + + (版本 12) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已设置父页面 "probe:parent" +
+ +
+ +
+ 第 1 页; 共 5 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+
+
+=== signed-in +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+
+
+=== second-page +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 2 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:15 + + (版本 11) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:14 + + (版本 10) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加标签：alpha, Zeta。 移除标签：lang:en。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:13 + + (版本 9) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 移除标签：lang:en。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:12 + + (版本 8) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加标签：alpha。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + R + + 11.12.2024 14:11 + + (版本 7) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 页面已从 "probe:was-here" 重命名为 "probe:changes" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + T + + 11.12.2024 14:10 + + (版本 6) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 标题已从 "Probe "Old" <b>" 更改为 "Probe Changes" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:09 + + (版本 5) + + + + probevoter + + probevoter + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:07 + + (版本 3) + + 系统 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:06 + + (版本 2) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:05 + + (版本 1) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ a source edit +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + N + + 11.12.2024 14:04 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probecss: + + Probe Styled Head + + + N + + 11.12.2024 14:03 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probecss: + + Probe Styled + + + N + + 11.12.2024 14:02 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probestars: + + Probe Third + + + N + + 11.12.2024 14:01 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probeoff: + + Probe Unratable + + + N + + 11.12.2024 14:00 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probestars: + + Probe Quarter + + + N + + 11.12.2024 13:59 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probestars: + + Probe Unrated + + + N + + 11.12.2024 13:58 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe List By Votes + + + N + + 11.12.2024 13:57 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe List Url + + + N + + 11.12.2024 13:56 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ 第 2 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+
+
+=== last-page +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 4 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Tagged + + + N + + 11.12.2024 13:35 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Imaged + + + N + + 11.12.2024 13:34 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Described + + + N + + 11.12.2024 13:33 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Redirect + + + N + + 11.12.2024 13:32 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Host + + + N + + 11.12.2024 13:31 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Included Page + + + N + + 11.12.2024 13:30 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Half + + + N + + 11.12.2024 13:29 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probestars: + + Probe Rated + + + N + + 11.12.2024 13:28 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Bare + + + N + + 11.12.2024 13:27 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Full + + + N + + 11.12.2024 13:26 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Parent + + + N + + 11.12.2024 13:25 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + Page B + + + N + + 11.12.2024 13:24 + + (版本 1) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + Page B + + + T + + 11.12.2024 13:23 + + (版本 0) + + 系统 +
+ +
+ 标题已从 "probe-b" 更改为 "Page B" +
+ +
+ +
+ + + + + + + + + + +
+ + + Page A + + + N + + 11.12.2024 13:22 + + (版本 1) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + Page A + + + T + + 11.12.2024 13:21 + + (版本 0) + + 系统 +
+ +
+ 标题已从 "probe-a" 更改为 "Page A" +
+ +
+ +
+ + + + + + + + + + +
+ + + component: + + Shared Component + + + N + + 11.12.2024 13:20 + + (版本 1) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + component: + + Shared Component + + + T + + 11.12.2024 13:19 + + (版本 0) + + 系统 +
+ +
+ 标题已从 "probe-var" 更改为 "Shared Component" +
+ +
+ +
+ + + + + + + + + + +
+ + + scp-173 + + + N + + 11.12.2024 13:18 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ + + + + + + + + + +
+ + + main + + + N + + 11.12.2024 13:17 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ + + + + + + + + + +
+ + + component: + + box + + + N + + 11.12.2024 13:16 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ 第 4 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+
+
+=== past-the-end +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 17 页; 共 17 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 14 + + + + 15 + + + + 16 + + + + 17 + + + +
+ +
+ + + + + + + + + + +
+ + + nav: + + side + + + N + + 11.12.2024 13:15 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ + + + + + + + + + +
+ + + nav: + + top + + + N + + 11.12.2024 13:14 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ 第 17 页; 共 17 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 14 + + + + 15 + + + + 16 + + + + 17 + + + +
+
+
+=== below-one +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+
+
+=== junk-page +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+
+
+=== perpage-10 +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 3 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + ... + + + + 8 + + + + 9 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:15 + + (版本 11) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:14 + + (版本 10) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加标签：alpha, Zeta。 移除标签：lang:en。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:13 + + (版本 9) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 移除标签：lang:en。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:12 + + (版本 8) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加标签：alpha。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + R + + 11.12.2024 14:11 + + (版本 7) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 页面已从 "probe:was-here" 重命名为 "probe:changes" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + T + + 11.12.2024 14:10 + + (版本 6) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 标题已从 "Probe "Old" <b>" 更改为 "Probe Changes" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:09 + + (版本 5) + + + + probevoter + + probevoter + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:07 + + (版本 3) + + 系统 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:06 + + (版本 2) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 3 页; 共 9 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + 5 + + + + ... + + + + 8 + + + + 9 + + + + 下一页 » + +
+
+
+=== perpage-200 +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + +
+ + + + + + + + + + +
+ + + nav: + + side + + + S + + 11.12.2024 13:48 + + (版本 1) + + 系统 +
+ +
+ Seeding +
+ +
+ +
+ + + + + + + + + + +
+ + + nav: + + top + + + S + + 11.12.2024 13:47 + + (版本 1) + + 系统 +
+ +
+ Seeding +
+ +
+ +
+ + + + + + + + + + +
+ + + nav: + + top-impl + + + N + + 11.12.2024 13:46 + + (版本 0) + + 系统 +
+ +
+ Seeding +
+ +
+ +
+ + + + + + + + + + +
+ + + nav: + + side + + + N + + 11.12.2024 13:15 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ + + + + + + + + + +
+ + + nav: + + top + + + N + + 11.12.2024 13:14 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ + +
+
+=== last-partial-page +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 12 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 9 + + + + 10 + + + + 11 + + + + 12 + + + +
+ +
+ + + + + + + + + + +
+ + + scp-173 + + + N + + 11.12.2024 13:18 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ + + + + + + + + + +
+ + + main + + + N + + 11.12.2024 13:17 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ + + + + + + + + + +
+ + + component: + + box + + + N + + 11.12.2024 13:16 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ + + + + + + + + + +
+ + + nav: + + side + + + N + + 11.12.2024 13:15 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ + + + + + + + + + +
+ + + nav: + + top + + + N + + 11.12.2024 13:14 + + (版本 0) + + + + seeduser + + seeduser + + + + + +
+ +
+ seed +
+ +
+ +
+ 第 12 页; 共 12 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 9 + + + + 10 + + + + 11 + + + + 12 + + + +
+
+
+=== perpage-junk +title: Probe Changes +status: 200 +!error: 处理模块 'SiteChanges' 时出错 +=== perpage-zero +title: Probe Changes +status: 200 +!error: 处理模块 'SiteChanges' 时出错 +=== perpage-negative +title: Probe Changes +status: 200 +!error: 处理模块 'SiteChanges' 时出错 +=== perpage-bare +title: Probe Changes +status: 200 +!error: 处理模块 'SiteChanges' 时出错 +=== category-probe +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 11 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 10 + + + + 11 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 11 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 10 + + + + 11 + + + + 下一页 » + +
+
+
+=== category-uppercase +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 11 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 10 + + + + 11 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 11 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 10 + + + + 11 + + + + 下一页 » + +
+
+
+=== category-default +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + wiki-syntax-guide + + + N + + 11.12.2024 13:39 + + (版本 0) + + 系统 +
+ +
+ Seeding +
+ +
+ +
+ + + + + + + + + + +
+ + + main + + + S + + 11.12.2024 13:38 + + (版本 1) + + 系统 +
+ +
+ Seeding +
+ +
+ +
+ + + + + + + + + + +
+ + + Page B + + + N + + 11.12.2024 13:24 + + (版本 1) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + Page B + + + T + + 11.12.2024 13:23 + + (版本 0) + + 系统 +
+ +
+ 标题已从 "probe-b" 更改为 "Page B" +
+ +
+ +
+ + + + + + + + + + +
+ + + Page A + + + N + + 11.12.2024 13:22 + + (版本 1) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+=== category-star +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+
+
+=== category-missing +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + + +
+
+=== category-bare +title: Probe Changes +status: 200 +!error: 处理模块 'SiteChanges' 时出错 +=== user-exact +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+=== user-uppercase +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+=== user-padded +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+=== user-wikidot +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ + +
+
+=== user-system +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:07 + + (版本 3) + + 系统 +
+ +
+ +
+ + + + + + + + + + +
+ + + probecss: + + Probe Styled Head + + + N + + 11.12.2024 14:03 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probecss: + + Probe Styled + + + N + + 11.12.2024 14:02 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe List By Votes + + + N + + 11.12.2024 13:57 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe List Url + + + N + + 11.12.2024 13:56 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+=== user-unknown +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + + +
+
+=== user-partial +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+=== user-partial-system +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:07 + + (版本 3) + + 系统 +
+ +
+ +
+ + + + + + + + + + +
+ + + probecss: + + Probe Styled Head + + + N + + 11.12.2024 14:03 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probecss: + + Probe Styled + + + N + + 11.12.2024 14:02 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe List By Votes + + + N + + 11.12.2024 13:57 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe List Url + + + N + + 11.12.2024 13:56 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+=== user-partial-empty +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+
+
+=== user-partial-wildcard +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + + +
+
+=== types-source +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:09 + + (版本 5) + + + + probevoter + + probevoter + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:07 + + (版本 3) + + 系统 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:06 + + (版本 2) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+=== types-tags +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:15 + + (版本 11) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:14 + + (版本 10) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加标签：alpha, Zeta。 移除标签：lang:en。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:13 + + (版本 9) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 移除标签：lang:en。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:12 + + (版本 8) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加标签：alpha。 +
+ +
+ + +
+
+=== types-revert +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ + +
+
+=== types-title +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + T + + 11.12.2024 14:10 + + (版本 6) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 标题已从 "Probe "Old" <b>" 更改为 "Probe Changes" +
+ +
+ +
+ + + + + + + + + + +
+ + + Page B + + + T + + 11.12.2024 13:23 + + (版本 0) + + 系统 +
+ +
+ 标题已从 "probe-b" 更改为 "Page B" +
+ +
+ +
+ + + + + + + + + + +
+ + + Page A + + + T + + 11.12.2024 13:21 + + (版本 0) + + 系统 +
+ +
+ 标题已从 "probe-a" 更改为 "Page A" +
+ +
+ +
+ + + + + + + + + + +
+ + + component: + + Shared Component + + + T + + 11.12.2024 13:19 + + (版本 0) + + 系统 +
+ +
+ 标题已从 "probe-var" 更改为 "Shared Component" +
+ +
+ + +
+
+=== types-two +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + T + + 11.12.2024 14:10 + + (版本 6) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 标题已从 "Probe "Old" <b>" 更改为 "Probe Changes" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:09 + + (版本 5) + + + + probevoter + + probevoter + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:07 + + (版本 3) + + 系统 +
+ +
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+=== types-not-true +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+
+
+=== types-mixed-case +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:09 + + (版本 5) + + + + probevoter + + probevoter + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:07 + + (版本 3) + + 系统 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:06 + + (版本 2) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+=== types-unknown +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+
+
+=== types-bare +title: Probe Changes +status: 200 +!error: 处理模块 'SiteChanges' 时出错 +=== with-params +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ 第 1 页; 共 17 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 16 + + + + 17 + + + + 下一页 » + +
+
+
+=== everything-at-once +title: Probe Changes +status: 200 +
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:09 + + (版本 5) + + + + probevoter + + probevoter + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:06 + + (版本 2) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:05 + + (版本 1) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ a source edit +
+ +
+ + +
+
diff --git a/internal/repo/testdata/sitechanges_corpus.json b/internal/repo/testdata/sitechanges_corpus.json new file mode 100644 index 00000000..b69cc99f --- /dev/null +++ b/internal/repo/testdata/sitechanges_corpus.json @@ -0,0 +1,322 @@ +[ + { + "name": "all", + "viewer": "" + }, + { + "name": "signed-in", + "viewer": "probe-author", + "path": { + "perpage": "5" + } + }, + { + "name": "second-page", + "viewer": "", + "path": { + "p": "2" + } + }, + { + "name": "last-page", + "viewer": "", + "path": { + "p": "4" + } + }, + { + "name": "past-the-end", + "viewer": "", + "path": { + "p": "99", + "perpage": "5" + } + }, + { + "name": "below-one", + "viewer": "", + "path": { + "p": "-3", + "perpage": "5" + } + }, + { + "name": "junk-page", + "viewer": "", + "path": { + "p": "later", + "perpage": "5" + } + }, + { + "name": "perpage-10", + "viewer": "", + "path": { + "p": "3", + "perpage": "10" + } + }, + { + "name": "perpage-200", + "viewer": "", + "path": { + "category": "nav", + "perpage": "200" + } + }, + { + "name": "last-partial-page", + "viewer": "", + "path": { + "p": "12", + "perpage": "7" + } + }, + { + "name": "perpage-junk", + "viewer": "", + "path": { + "perpage": "many" + } + }, + { + "name": "perpage-zero", + "viewer": "", + "path": { + "perpage": "0" + } + }, + { + "name": "perpage-negative", + "viewer": "", + "path": { + "perpage": "-5" + } + }, + { + "name": "perpage-bare", + "viewer": "", + "bare": [ + "perpage" + ] + }, + { + "name": "category-probe", + "viewer": "", + "path": { + "category": "probe", + "perpage": "5" + } + }, + { + "name": "category-uppercase", + "viewer": "", + "path": { + "category": "PROBE", + "perpage": "5" + } + }, + { + "name": "category-default", + "viewer": "", + "path": { + "category": "_default", + "perpage": "5" + } + }, + { + "name": "category-star", + "viewer": "", + "path": { + "category": "*", + "perpage": "5" + } + }, + { + "name": "category-missing", + "viewer": "", + "path": { + "category": "nosuchcategory", + "perpage": "5" + } + }, + { + "name": "category-bare", + "viewer": "", + "bare": [ + "category" + ] + }, + { + "name": "user-exact", + "viewer": "", + "path": { + "perpage": "5", + "username": "probe-author" + } + }, + { + "name": "user-uppercase", + "viewer": "", + "path": { + "perpage": "5", + "username": "PROBE-AUTHOR" + } + }, + { + "name": "user-padded", + "viewer": "", + "path": { + "perpage": "5", + "username": " probe-author " + } + }, + { + "name": "user-wikidot", + "viewer": "", + "path": { + "perpage": "5", + "username": "probe-wd-original" + } + }, + { + "name": "user-system", + "viewer": "", + "path": { + "perpage": "5", + "username": "system" + } + }, + { + "name": "user-unknown", + "viewer": "", + "path": { + "perpage": "5", + "username": "nobody-at-all" + } + }, + { + "name": "user-partial", + "viewer": "", + "path": { + "perpage": "5", + "username": "~probe" + } + }, + { + "name": "user-partial-system", + "viewer": "", + "path": { + "perpage": "5", + "username": "~sys" + } + }, + { + "name": "user-partial-empty", + "viewer": "", + "path": { + "perpage": "5", + "username": "~" + } + }, + { + "name": "user-partial-wildcard", + "viewer": "", + "path": { + "perpage": "5", + "username": "~%" + } + }, + { + "name": "types-source", + "viewer": "", + "path": { + "perpage": "5", + "source": "true" + } + }, + { + "name": "types-tags", + "viewer": "", + "path": { + "perpage": "5", + "tags": "true" + } + }, + { + "name": "types-revert", + "viewer": "", + "path": { + "perpage": "5", + "revert": "true" + } + }, + { + "name": "types-title", + "viewer": "", + "path": { + "perpage": "5", + "title": "true" + } + }, + { + "name": "types-two", + "viewer": "", + "path": { + "perpage": "5", + "source": "true", + "title": "true" + } + }, + { + "name": "types-not-true", + "viewer": "", + "path": { + "perpage": "5", + "source": "false" + } + }, + { + "name": "types-mixed-case", + "viewer": "", + "path": { + "perpage": "5", + "source": "TRUE" + } + }, + { + "name": "types-unknown", + "viewer": "", + "path": { + "nosuchtype": "true", + "perpage": "5" + } + }, + { + "name": "types-bare", + "viewer": "", + "bare": [ + "source" + ] + }, + { + "name": "with-params", + "viewer": "", + "params": { + "limit": "5" + }, + "path": { + "perpage": "5" + } + }, + { + "name": "everything-at-once", + "viewer": "probe-author", + "path": { + "category": "probe", + "perpage": "5", + "source": "true", + "username": "~probe" + } + } +] From 26f8d628f0b3064e87c7355ce27e1a91d5f3da2d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 14:05:09 +0900 Subject: [PATCH 115/428] run the site changes list in the page corpus --- internal/difftest/corpus/articles.txt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 6830e415..7b73d004 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -71,6 +71,9 @@ OPTIONS /probe:full /search:site/q/scp /search:site/q/%20spaced%20/author/probe-author /search:site/datefrom/2021-01-01/dateto/2021-12-31 -# the pages the wiki ships with. each is one unported module, so pwikit draws the -# error block where django draws the module. the three that django 404s do it from -# inside the module, which pwikit cannot reach yet. drop each ! as its module lands. +# the pages the wiki ships with, one module each. + +/probe:changes +/probe:changes/p/2 +/probe:changes/perpage/10/category/probe +/probe:changes/username/~probe/source/true From bdbd0cb7900fb13d95ea978d4374d2ce48d3eec8 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 14:23:08 +0900 Subject: [PATCH 116/428] adjust --- cmd/pwikit/main.go | 2 - internal/article/path.go | 7 +-- internal/article/unquote.go | 9 ++- internal/article/vars.go | 9 ++- internal/articlepage/build.go | 6 +- internal/articlepage/render.go | 12 ++-- internal/auth/auth.go | 4 +- internal/callbacks/callbacks.go | 3 +- internal/compress/compress.go | 9 ++- internal/db/article.go | 6 +- internal/db/article_meta.go | 4 +- internal/db/chrome.go | 6 +- internal/db/forum.go | 3 - internal/db/listpages.go | 4 +- internal/db/options.go | 4 +- internal/db/perms.go | 9 ++- internal/db/rating.go | 4 -- internal/db/role.go | 5 +- internal/db/sitechanges.go | 4 +- internal/db/user.go | 7 +-- internal/difftest/listpages.go | 8 +-- internal/escape/escape.go | 8 +-- internal/escape/js.go | 4 +- internal/listpages/params.go | 26 ++++----- internal/listpages/query.go | 4 +- internal/listpages/render.go | 2 - internal/listpages/render_test.go | 4 +- internal/media/media.go | 21 +++---- internal/media/mime.go | 3 +- internal/modules/forum.go | 4 +- internal/modules/forumcategory.go | 8 +-- internal/modules/forumnewthread.go | 4 +- internal/modules/forumstart.go | 10 ++-- internal/modules/forumthread.go | 56 +++++++++---------- internal/modules/listpages.go | 24 ++++---- internal/modules/rate.go | 4 +- internal/modules/recentposts.go | 12 ++-- internal/modules/search.go | 6 +- internal/modules/sitechanges.go | 32 +++++------ internal/page/rating.go | 6 +- internal/page/template.go | 3 +- internal/page/vars.go | 14 ++--- internal/page/vars_test.go | 4 +- internal/pageconfig/options.go | 22 ++++---- internal/pageconfig/user.go | 10 ++-- internal/perms/perms.go | 4 +- internal/printuser/printuser.go | 8 +-- internal/repo/perms.go | 4 +- internal/repo/repo.go | 5 +- internal/roles/roles.go | 5 +- internal/routing/routing.go | 30 +++++----- internal/routing/routing_test.go | 34 +++++------ internal/session/signing.go | 2 - internal/shell/shell.go | 3 +- internal/site/host.go | 13 ++--- internal/wikidot/username.go | 9 +-- .../testdata/oracle_wikijson.py} | 14 ++--- .../testdata/wikijson.golden} | 0 .../testdata/wikijson_corpus.json} | 0 .../pyjson.go => wikijson/wikijson.go} | 20 +++---- .../wikijson_test.go} | 6 +- .../{pynum/pynum.go => wikinum/wikinum.go} | 12 ++-- .../pynum_test.go => wikinum/wikinum_test.go} | 2 +- 63 files changed, 262 insertions(+), 325 deletions(-) rename internal/{pyjson/testdata/oracle_pyjson.py => wikijson/testdata/oracle_wikijson.py} (52%) rename internal/{pyjson/testdata/pyjson.golden => wikijson/testdata/wikijson.golden} (100%) rename internal/{pyjson/testdata/pyjson_corpus.json => wikijson/testdata/wikijson_corpus.json} (100%) rename internal/{pyjson/pyjson.go => wikijson/wikijson.go} (80%) rename internal/{pyjson/pyjson_test.go => wikijson/wikijson_test.go} (97%) rename internal/{pynum/pynum.go => wikinum/wikinum.go} (71%) rename internal/{pynum/pynum_test.go => wikinum/wikinum_test.go} (98%) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index efbc0137..f7af6800 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -171,8 +171,6 @@ func serve(args []string) error { return srv.ListenAndServe() } -// listenPort feeds the host lookup its second candidate, the way Django reads -// SERVER_PORT. func listenPort(addr string) string { _, port, err := net.SplitHostPort(addr) if err != nil { diff --git a/internal/article/path.go b/internal/article/path.go index 02ab523b..48f84c87 100644 --- a/internal/article/path.go +++ b/internal/article/path.go @@ -73,8 +73,6 @@ func rewriteForum(path string) string { return path } -// put keeps the position of the first occurrence, the way assigning to a -// Python dict does. // Encode writes the parameters back as a path, sorted by key. Only the values // are escaped, and only the first bare key survives. func Encode(p Params) string { @@ -115,9 +113,8 @@ func RedirectTarget(name string, params Params) (target string, ok bool) { return iriToURI("/" + normalized + Encode(params)), true } -// iriSafe is what Django leaves alone when it writes a Location, on top of the -// unreserved characters every escaper keeps. It spares the percent sign, so -// text escaped once does not grow a second time. +// iriSafe spares the percent sign on top of the unreserved characters, so text +// escaped once does not grow a second time. const iriSafe = "/#%[]=:;$&()+,!*?@'" func iriToURI(s string) string { diff --git a/internal/article/unquote.go b/internal/article/unquote.go index 2e791c6a..d938e4ab 100644 --- a/internal/article/unquote.go +++ b/internal/article/unquote.go @@ -5,8 +5,8 @@ import ( "unicode/utf8" ) -// unquote decodes %XX the way Python's urllib does. An escape it cannot read -// stays in the text, and bytes that are not UTF-8 turn into U+FFFD. +// An escape unquote cannot read stays in the text, and bytes that are not UTF-8 +// turn into U+FFFD. func unquote(s string) string { if !strings.Contains(s, "%") { return s @@ -67,9 +67,8 @@ func replaceInvalid(b []byte) string { return out.String() } -// subpartLen answers how many bytes one U+FFFD stands for. Python spends one -// per maximal subpart, so a truncated sequence costs one rather than one per -// byte. +// One U+FFFD stands for a whole maximal subpart, so a truncated sequence costs +// one replacement rather than one per byte. func subpartLen(b []byte) int { var want int var lo, hi byte diff --git a/internal/article/vars.go b/internal/article/vars.go index 6e29c53e..646c241a 100644 --- a/internal/article/vars.go +++ b/internal/article/vars.go @@ -4,7 +4,7 @@ import ( "strings" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) const ( @@ -24,19 +24,18 @@ func ThisPage(params Params, canonicalURL string) func(string) (string, bool) { param, ok := params.Lookup(lookupKey(name, prefixExpr)) switch { case !ok: - return pyjson.String(literal(name)), true + return wikijson.String(literal(name)), true case param.Bare: return "null", true } - return pyjson.String(param.Value), true + return wikijson.String(param.Value), true case strings.HasPrefix(name, prefixURL): param, ok := params.Lookup(lookupKey(name, prefixURL)) if !ok { return page.QuoteAll(literal(name)), true } - // A bare key crashes Django here, and the empty string is what the - // rest of this family answers for one. + // The empty string is what the rest of this family answers for a bare key. return page.QuoteAll(param.Value), true case strings.HasPrefix(name, prefixPath): diff --git a/internal/articlepage/build.go b/internal/articlepage/build.go index ae7eef01..fac58f15 100644 --- a/internal/articlepage/build.go +++ b/internal/articlepage/build.go @@ -102,8 +102,6 @@ func (h *Handler) load(req *request) error { return nil } -// permsObject reports checked=false when neither the page nor a row for its -// category exists, where Django asks nothing and lets the response be a 404. func (h *Handler) permsObject(req *request, perm *repo.Perms) (*perms.Object, bool, error) { if req.article != nil { object, err := perm.Article(req.article, req.user) @@ -121,8 +119,8 @@ func (h *Handler) permsObject(req *request, perm *repo.Perms) (*perms.Object, bo return object, true, err } -// Django creates the thread on the way past. This only reads, so a page nobody -// has commented on stays where it is. +// This only reads, so a page nobody has commented on gets no thread written for +// it. func (h *Handler) commentsRedirect(req *request) (string, error) { info, err := h.deps.DB.CommentInfo(req.ctx, req.article.ID) if err != nil { diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 123c5552..eaa656d9 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -15,12 +15,12 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/pageconfig" "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/printuser" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/shell" "github.com/WikitTeam/ProjectWikit/internal/site" "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) const ( @@ -164,7 +164,7 @@ func (h *Handler) source(req *request) (string, error) { } func (h *Handler) missingBody(req *request) (body, error) { - options, err := pyjson.Marshal(pyjson.Object{ + options, err := wikijson.Marshal(wikijson.Object{ {Key: "page_id", Value: req.name}, {Key: "pathParams", Value: pathParams(req.params)}, }) @@ -316,14 +316,14 @@ func excerpt(text string) string { return joined } -func pathParams(params article.Params) pyjson.Object { - out := make(pyjson.Object, 0, len(params)) +func pathParams(params article.Params) wikijson.Object { + out := make(wikijson.Object, 0, len(params)) for _, param := range params { var value any if !param.Bare { value = param.Value } - out = append(out, pyjson.Field{Key: param.Key, Value: value}) + out = append(out, wikijson.Field{Key: param.Key, Value: value}) } return out } @@ -534,7 +534,7 @@ func (h *Handler) rating(req *request) (page.Rating, error) { } // watching asks about the page and about the thread the path names. A t that is -// not a number leaves the second question unasked, where Django raises. +// not a number leaves the second question unasked. func (h *Handler) watching(req *request, threadID int64) (bool, error) { if req.user == nil { return false, nil diff --git a/internal/auth/auth.go b/internal/auth/auth.go index f86c9273..c253ccd1 100644 --- a/internal/auth/auth.go +++ b/internal/auth/auth.go @@ -91,8 +91,8 @@ func (r *Resolver) resolve(req *http.Request) *db.User { hash, _ := decoded[session.AuthUserHash].(string) if !r.store.AuthHashMatches(password, hash) { - // The password changed under this session. Django drops the row here, - // so leaving it would let the same cookie keep costing a query. + // The password changed under this session. Leaving the row would let the same + // dead cookie keep costing a query. if err := r.sessions.DeleteSession(ctx, cookie.Value); err != nil { r.log.Error("drop stale session", "err", err) } diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go index 0acfc488..87b9da15 100644 --- a/internal/callbacks/callbacks.go +++ b/internal/callbacks/callbacks.go @@ -48,8 +48,7 @@ type Callbacks struct { var _ renderer.Callbacks = (*Callbacks)(nil) // SetPageVars names the page whose %%this|x%% an included page reaches. Without -// it every such name is left standing, which is what a render with no article -// of its own gets in Django too. +// it every such name is left standing. func (c *Callbacks) SetPageVars(vars *page.Vars) { c.vars = vars } // SetContext hands the modules the page they are rendering into, which is what diff --git a/internal/compress/compress.go b/internal/compress/compress.go index 38f4d4c2..29faae39 100644 --- a/internal/compress/compress.go +++ b/internal/compress/compress.go @@ -1,4 +1,5 @@ -// Package compress gzips a response the way Django's GZipMiddleware does. +// Package compress gzips a response with a deterministic header, so the same +// body twice produces the same bytes. package compress import ( @@ -12,8 +13,8 @@ import ( "strings" ) -// Below this size Django returns the response untouched, Vary included, so the -// header is not a reliable sign that compression was considered. +// Below this size the response goes out untouched, Vary included, so that +// header is not a sign compression was considered. const minSize = 200 const ( @@ -78,8 +79,6 @@ func patchVary(h http.Header) { h.Set("Vary", current+", "+name) } -// pack writes the gzip stream Django writes, down to the zero timestamp and -// the padding it hides in the filename field. func pack(body []byte) ([]byte, error) { var out bytes.Buffer zw, err := gzip.NewWriterLevel(&out, level) diff --git a/internal/db/article.go b/internal/db/article.go index 7c22cb55..ec6736f9 100644 --- a/internal/db/article.go +++ b/internal/db/article.go @@ -6,9 +6,9 @@ import ( "strings" ) -// dumbName mirrors _page_name_to_dumb in renderer/__init__.py. complete_full_name -// is a generated column that always carries an explicit category, so a bare page -// name has to grow the implicit _default: prefix before it can match anything. +// complete_full_name is a generated column that always carries an explicit +// category, so a bare page name grows the implicit _default one before it can +// match anything. func dumbName(ref string) string { if strings.Contains(ref, ":") { return strings.ToLower(ref) diff --git a/internal/db/article_meta.go b/internal/db/article_meta.go index 784b381f..621f5439 100644 --- a/internal/db/article_meta.go +++ b/internal/db/article_meta.go @@ -46,8 +46,8 @@ func (d *DB) LatestSource(ctx context.Context, articleID int64) (string, error) return source, nil } -// The join table carries no ordering in Django, so the author order a page -// shows is whatever Postgres returns; ordering by the link row freezes it. +// The join table carries no ordering of its own, so ordering by the link row is +// what freezes the author order a page shows. var qArticleAuthors = register("ArticleAuthors", ` SELECT `+prefixed("u", userColumns)+` FROM web_article_authors link diff --git a/internal/db/chrome.go b/internal/db/chrome.go index ebff64f6..dd7c5e0c 100644 --- a/internal/db/chrome.go +++ b/internal/db/chrome.go @@ -62,8 +62,6 @@ type TagCategory struct { Tags []Tag } -// The tie-break is the category id because the order Django gets there falls out -// of iterating a set of model objects, which for small ids is ascending. var qArticleTagCategories = register("ArticleTagCategories", ` SELECT c.id, c.name, c.priority, t.name, CASE WHEN c.slug = '_default' THEN t.name ELSE c.slug || ':' || t.name END @@ -73,8 +71,8 @@ JOIN web_tagscategory c ON c.id = t.category_id WHERE link.article_id = $1 AND t.name NOT LIKE '\_%' ORDER BY c.id, link.id`) -// ArticleTagCategories returns the tag block in display order. A category with no -// priority sorts under the page's tag count, the number Django compares it with. +// A category with no priority sorts under the page's tag count, which is the +// number it is compared with. func (d *DB) ArticleTagCategories(ctx context.Context, articleID int64) ([]TagCategory, error) { rows, err := d.pool.Query(ctx, qArticleTagCategories, articleID) if err != nil { diff --git a/internal/db/forum.go b/internal/db/forum.go index 5b0896fa..ad6f0d26 100644 --- a/internal/db/forum.go +++ b/internal/db/forum.go @@ -140,7 +140,6 @@ func (d *DB) ForumCommentCounts(ctx context.Context) (ForumCounts, error) { const forumLastPostColumns = `p.id, p.created_at, t.id, t.name, t.category_id, t.article_id, p.author_id` -// Ties are left to the database because Django orders on the timestamp alone. var qForumCategoryLastPost = register("ForumCategoryLastPost", ` SELECT `+forumLastPostColumns+` FROM web_forumpost p @@ -273,8 +272,6 @@ func (d *DB) ForumThreadPostCount(ctx context.Context, threadID int64) (int, err return n, nil } -// Django indexes to the end of an ascending list rather than taking the first -// of a descending one, which decides differently when two posts share a stamp. var qForumThreadLastPost = register("ForumThreadLastPost", ` SELECT id, created_at, author_id FROM web_forumpost diff --git a/internal/db/listpages.go b/internal/db/listpages.go index d96ef678..dba29b12 100644 --- a/internal/db/listpages.go +++ b/internal/db/listpages.go @@ -108,8 +108,8 @@ func (b *listBuilder) arg(v any) string { return "$" + strconv.Itoa(len(b.args)) } -// A site that rates nothing still has to sort by something, and Django picks -// the id. +// A site that rates nothing still has to sort by something, so the id stands +// in. func ratingExpr(mode string) string { switch mode { case "updown": diff --git a/internal/db/options.go b/internal/db/options.go index 01d12196..61c8f22d 100644 --- a/internal/db/options.go +++ b/internal/db/options.go @@ -43,8 +43,8 @@ SELECT t.id, (SELECT count(*) FROM web_forumpost p WHERE p.thread_id = t.id) FROM web_forumthread t WHERE t.article_id = $1`) -// CommentInfo reports the zero value for a page whose thread has never been -// created. Django creates one here instead, which is a write on a read. +// A page whose thread has never been created reports the zero value rather than +// having one written for it on a read. func (d *DB) CommentInfo(ctx context.Context, articleID int64) (CommentInfo, error) { var info CommentInfo err := d.pool.QueryRow(ctx, qCommentInfo, articleID).Scan(&info.ThreadID, &info.Count) diff --git a/internal/db/perms.go b/internal/db/perms.go index b431a508..0a7b12dc 100644 --- a/internal/db/perms.go +++ b/internal/db/perms.go @@ -12,8 +12,8 @@ SELECT slug, id FROM web_role WHERE slug = ANY($1)`) -// The roles Django reads here are ordered by index. Nothing downstream depends -// on that: each role's permissions are settled on their own and then merged. +// Nothing downstream depends on the order. Each role's permissions are settled +// on their own and then merged. var qRoleIDsForUser = register("RoleIDsForUser", ` SELECT ur.role_id FROM web_user_roles ur @@ -56,9 +56,8 @@ SELECT EXISTS ( SELECT 1 FROM web_article_authors WHERE article_id = $1 AND user_id = $2 )`) -// RoleIDsBySlug resolves the two roles every visitor carries. A slug with no -// row is left out rather than created, which is where this parts ways with -// Django's get_or_create on a read path. +// A slug with no row is left out rather than created, because a read path must +// not write. func (d *DB) RoleIDsBySlug(ctx context.Context, slugs []string) (map[string]int64, error) { rows, err := d.pool.Query(ctx, qRoleIDsBySlug, slugs) if err != nil { diff --git a/internal/db/rating.go b/internal/db/rating.go index 40fc3889..b591d96e 100644 --- a/internal/db/rating.go +++ b/internal/db/rating.go @@ -76,8 +76,6 @@ func (d *DB) VoteStats(ctx context.Context, articleID int64) (VoteStats, error) return s, nil } -// A null user matches the votes cast without one, because Django filters on -// user=None the same way. var qHasVoted = register("HasVoted", ` SELECT EXISTS( SELECT 1 FROM web_vote @@ -91,8 +89,6 @@ func (d *DB) HasVoted(ctx context.Context, articleID int64, userID *int64) (bool return voted, nil } -// Django reaches for the last row of an unordered set, which it spells as the -// first row of one ordered by descending key. var qVoteByUser = register("VoteByUser", ` SELECT rate FROM web_vote diff --git a/internal/db/role.go b/internal/db/role.go index 89e1ef84..10fd2f84 100644 --- a/internal/db/role.go +++ b/internal/db/role.go @@ -16,9 +16,8 @@ JOIN web_user_roles ur ON ur.role_id = r.id WHERE ur.user_id = $1 ORDER BY r.index, r.id`) -// RolesByUser returns every role of one user, ordered the way the name tail -// and showcase queries both consume it. The tie-break on id has no counterpart -// in Django, where index is rewritten to be unique on every role save. +// Ordered the way the name tail and showcase queries both consume it. The tie- +// break on id covers the rows whose index is not unique. func (d *DB) RolesByUser(ctx context.Context, userID int64) ([]roles.Role, error) { rows, err := d.pool.Query(ctx, qRolesByUser, userID) if err != nil { diff --git a/internal/db/sitechanges.go b/internal/db/sitechanges.go index 3bd9081c..5bf83b76 100644 --- a/internal/db/sitechanges.go +++ b/internal/db/sitechanges.go @@ -150,8 +150,8 @@ SELECT id FROM web_user WHERE username = $1 OR wikidot_username = $1`) -// Django uppercases both sides rather than leaning on citext, and a wiki that -// renamed the column to text would silently start matching case-sensitively. +// Uppercasing both sides rather than leaning on citext, so a column changed to +// text would not silently start matching case-sensitively. var qUserIDsByNamePart = register("UserIDsByNamePart", ` SELECT id FROM web_user diff --git a/internal/db/user.go b/internal/db/user.go index d0d7bc26..5502c017 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -31,9 +31,8 @@ type User struct { ForumInactiveUntil *time.Time } -// ActiveAt reproduces User.__init__, where a deadline in the future overrides -// the stored flag in both directions: is_active is ignored whenever -// inactive_until is set. +// A deadline in the future overrides the stored flag in both directions, so +// is_active is ignored whenever inactive_until is set. func (u *User) ActiveAt(now time.Time) bool { if u.InactiveUntil == nil { return u.IsActive @@ -73,8 +72,6 @@ func firstNonEmpty(values ...string) string { const userColumns = `id, type, username, wikidot_username, display_name, avatar, is_active, inactive_until, is_superuser, is_forum_active, forum_inactive_until` -// Django's QuerySet.first() falls back to ordering by primary key when the -// queryset carries no ordering of its own, so these two are not stray sorts. var qUserByName = register("UserByName", ` SELECT `+userColumns+` FROM web_user diff --git a/internal/difftest/listpages.go b/internal/difftest/listpages.go index 6dd6a4a4..5c0459b8 100644 --- a/internal/difftest/listpages.go +++ b/internal/difftest/listpages.go @@ -6,7 +6,7 @@ import ( "strings" "github.com/WikitTeam/ProjectWikit/internal/escape" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) var attrUnescape = strings.NewReplacer( @@ -35,11 +35,11 @@ func sortListPagesParams(match []byte) []byte { } sort.Strings(keys) - out := make(pyjson.Object, 0, len(keys)) + out := make(wikijson.Object, 0, len(keys)) for _, key := range keys { - out = append(out, pyjson.Field{Key: key, Value: decoded[key]}) + out = append(out, wikijson.Field{Key: key, Value: decoded[key]}) } - sorted, err := pyjson.Marshal(out) + sorted, err := wikijson.Marshal(out) if err != nil { return match } diff --git a/internal/escape/escape.go b/internal/escape/escape.go index 771e47ed..5d91a01b 100644 --- a/internal/escape/escape.go +++ b/internal/escape/escape.go @@ -1,11 +1,11 @@ -// Package escape reproduces the escaping Django and Python apply on their way -// into a response. +// Package escape holds the HTML and URL escapes these pages use, which the +// standard library spells differently. package escape import "strings" -// Django writes ' as ' where html.EscapeString writes ', and the -// acceptance test for the whole renderer is byte-identical output. +// These pages spell ' as ' where html.EscapeString writes ', and the +// whole renderer is checked on byte-identical output. var replacer = strings.NewReplacer( "&", "&", "<", "<", diff --git a/internal/escape/js.go b/internal/escape/js.go index b77dbe33..9f640c5c 100644 --- a/internal/escape/js.go +++ b/internal/escape/js.go @@ -11,8 +11,8 @@ const ( paragraphSep = '\u2029' ) -// JS is Django's escapejs. Go's template.JSEscapeString covers a different set -// of characters and spells them differently, so it cannot stand in here. +// Go's template.JSEscapeString covers a different set of characters and spells +// them differently, so it cannot stand in here. func JS(s string) string { var b strings.Builder for _, r := range s { diff --git a/internal/listpages/params.go b/internal/listpages/params.go index 049c7dec..4f329ae0 100644 --- a/internal/listpages/params.go +++ b/internal/listpages/params.go @@ -8,7 +8,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) type Source interface { @@ -384,7 +384,7 @@ func timeOp(op string) string { // day of 2020-12. func parseDateBounds(text string) (first, last time.Time, ok bool) { parts := strings.Split(text, "-") - year, err := pynum.Int(parts[0]) + year, err := wikinum.Int(parts[0]) if err != nil || year < 1 || year > 9999 { return time.Time{}, time.Time{}, false } @@ -392,7 +392,7 @@ func parseDateBounds(text string) (first, last time.Time, ok bool) { lastMonth, lastDay := 12, 31 if len(parts) >= 2 { - m, err := pynum.Int(parts[1]) + m, err := wikinum.Int(parts[1]) if err != nil { return time.Time{}, time.Time{}, false } @@ -401,7 +401,7 @@ func parseDateBounds(text string) (first, last time.Time, ok bool) { lastDay = daysIn(year, month) } if len(parts) >= 3 { - d, err := pynum.Int(parts[2]) + d, err := wikinum.Int(parts[2]) if err != nil { return time.Time{}, time.Time{}, false } @@ -441,7 +441,7 @@ func (p *parser) parseRating() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pynum.Float(strings.TrimSpace(rest)) + value, err := wikinum.Float(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -463,7 +463,7 @@ func (p *parser) parseVotes() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pynum.Int(strings.TrimSpace(rest)) + value, err := wikinum.Int(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -485,7 +485,7 @@ func (p *parser) parsePopularity() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pynum.Int(strings.TrimSpace(rest)) + value, err := wikinum.Int(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -524,8 +524,8 @@ func ratingValue(r page.Rating) float64 { return 0 } -// Python splits on a single space and strips each piece, which keeps a tab -// inside a tag name rather than breaking on it. +// Splitting on a single space and stripping each piece keeps a tab inside a tag +// name rather than breaking on it. func splitFields(s string) []string { var out []string for _, part := range strings.Split(s, " ") { @@ -567,19 +567,19 @@ func (p *parser) parseSort() { } func (p *parser) parseWindow() { - if offset, err := pynum.Int(p.getOr("offset", "0")); err == nil { + if offset, err := wikinum.Int(p.getOr("offset", "0")); err == nil { p.out.Offset = offset } if raw, ok := p.params["limit"]; ok { - if limit, err := pynum.Int(raw); err == nil { + if limit, err := wikinum.Int(raw); err == nil { p.out.Limit = &limit } } - perPage, err := pynum.Int(p.getOr("perpage", "20")) + perPage, err := wikinum.Int(p.getOr("perpage", "20")) if err != nil { perPage = defaultPerPage } - pageNum, err := pynum.Int(p.pathOr("p", "1")) + pageNum, err := wikinum.Int(p.pathOr("p", "1")) if err != nil || pageNum < 1 { pageNum = 1 } diff --git a/internal/listpages/query.go b/internal/listpages/query.go index 4daed886..c554e4a5 100644 --- a/internal/listpages/query.go +++ b/internal/listpages/query.go @@ -104,8 +104,8 @@ func window(q Query) (offset int, limit *int, skip bool) { return offset, &bounded, false } -// A per-page of zero would divide by zero in Django, so this reports no pages -// at all rather than failing the request. +// A per-page of zero reports no pages at all rather than dividing by zero and +// failing the request. func totalPages(total, perPage int) int { if perPage <= 0 { return 0 diff --git a/internal/listpages/render.go b/internal/listpages/render.go index 29b6267f..32ca4ba6 100644 --- a/internal/listpages/render.go +++ b/internal/listpages/render.go @@ -77,8 +77,6 @@ func BasePath(fullName string, path page.PathParams) string { return out } -// A key that arrived without a value is spelled the way Python spells the -// None it stores for one. func pathValue(param page.PathParam) string { if param.Bare { return "None" diff --git a/internal/listpages/render_test.go b/internal/listpages/render_test.go index b3759b97..6af9cb5c 100644 --- a/internal/listpages/render_test.go +++ b/internal/listpages/render_test.go @@ -11,7 +11,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/i18n" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) var update = flag.Bool("update", false, "rewrite the golden files and the corpora the oracles read") @@ -100,7 +100,7 @@ func TestSplitMatchesGolden(t *testing.T) { for _, c := range cases { s := Split(c.Content) fmt.Fprintf(&b, "=== %s\nhead=%s\nbody=%s\nfoot=%s\n", c.Name, - pyjson.String(s.Head), pyjson.String(s.Body), pyjson.String(s.Foot)) + wikijson.String(s.Head), wikijson.String(s.Body), wikijson.String(s.Foot)) } compareGolden(t, sectionsGolden, b.String(), sectionsCorpus, cases) } diff --git a/internal/media/media.go b/internal/media/media.go index a525add8..c42aef0a 100644 --- a/internal/media/media.go +++ b/internal/media/media.go @@ -19,10 +19,9 @@ import ( ) const ( - Prefix = "/local--files/" - notFoundBody = "Not found" - defaultMime = "application/octet-stream" - // What Django gives a response built without an explicit type. + Prefix = "/local--files/" + notFoundBody = "Not found" + defaultMime = "application/octet-stream" defaultHTMLMime = "text/html; charset=utf-8" ) @@ -74,8 +73,6 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } - // Django never writes the guessed type back onto the response, so anything - // the database did not name goes out labelled text/html. responseMime := mimeType if mimeType == "" { responseMime = defaultHTMLMime @@ -87,8 +84,6 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { chunk := chunkSizeFor(mimeType) if chunk == 0 { - // Django's FileResponse sets its own headers and ignores - // If-Modified-Since. w.Header().Set("Content-Type", mimeType) w.Header().Set("Content-Disposition", disposition(filepath.Base(full))) w.Header().Set("Content-Length", strconv.FormatInt(info.Size(), 10)) @@ -121,8 +116,8 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { w.Header().Set("Accept-Ranges", "bytes") if begin >= end || end == 0 { - // Django keeps the full Content-Length here and sends no body, which - // breaks the framing. + // The length has to be zero here, since no body follows and a full one would + // break the framing. w.Header().Set("Content-Range", fmt.Sprintf("bytes */%d", size)) w.Header().Set("Content-Length", "0") w.WriteHeader(http.StatusRequestedRangeNotSatisfiable) @@ -130,7 +125,7 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { } // end is exclusive here and inclusive in the header, so this is a byte - // short of what the client asked for. Django does the same. + // short of what the client asked for. w.Header().Set("Content-Range", fmt.Sprintf("bytes %d-%d/%d", begin, end-1, size)) w.Header().Set("Content-Length", strconv.FormatInt(end-begin, 10)) w.WriteHeader(http.StatusPartialContent) @@ -180,8 +175,8 @@ func exists(name string) bool { return err == nil } -// rangeBounds returns a half-open [begin, end). A false third value is a 416; -// Django raises on the malformed cases instead. +// rangeBounds returns a half-open [begin, end), and a false third value is a +// 416 rather than a raised error. func rangeBounds(header string, chunk, size int64) (begin, end int64, ok bool) { if header == "" { return 0, min(chunk, size), true diff --git a/internal/media/mime.go b/internal/media/mime.go index 3c325337..83e95663 100644 --- a/internal/media/mime.go +++ b/internal/media/mime.go @@ -2,8 +2,7 @@ package media import "strings" -// guessType mirrors Python's mimetypes.guess_type. An empty type means -// unknown; the caller supplies the fallback. +// An empty type means unknown, and the caller supplies the fallback. func guessType(name string) (mimeType, encoding string) { base, ext := splitExt(name) for { diff --git a/internal/modules/forum.go b/internal/modules/forum.go index d3f08293..f9e080af 100644 --- a/internal/modules/forum.go +++ b/internal/modules/forum.go @@ -44,8 +44,8 @@ func renderDate(env module.Env, at time.Time) string { escape.HTML(serverDate(env, at)) + `` } -// Python calls strftime on what the ORM handed back, which is UTC and not the -// site's zone. +// The stamp is formatted in UTC and not the site's zone, which is what the +// stored value carries. func serverDate(env module.Env, at time.Time) string { at = at.UTC() pad := func(n int) string { diff --git a/internal/modules/forumcategory.go b/internal/modules/forumcategory.go index e9b7ce39..2a0d851f 100644 --- a/internal/modules/forumcategory.go +++ b/internal/modules/forumcategory.go @@ -12,7 +12,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("forumcategory", renderForumCategory) } @@ -90,8 +90,6 @@ func renderForumCategory(env module.Env, _ map[string]string, _ string) (string, return forumCategoryHTML(env, view), nil } -// Python rebinds c to the parsed number before the message reads it, so a -// well-formed id is echoed back normalized and a missing one prints as None. func forumCategoryOf(env module.Env, path page.PathParams) (*db.ForumCategory, error) { shown := "None" if param, ok := path.Lookup("c"); ok { @@ -102,7 +100,7 @@ func forumCategoryOf(env module.Env, path page.PathParams) (*db.ForumCategory, e return &module.Error{Message: env.Text("module-forum-not-found", "name", shown)} } - id, err := pynum.Int(shown) + id, err := wikinum.Int(shown) if err != nil { return nil, notFound() } @@ -134,7 +132,7 @@ func forumCategoryThreads(env module.Env, view *forumCategoryView, path page.Pat } page := 1 - if n, err := pynum.Int(path.Get("p")); err == nil { + if n, err := wikinum.Int(path.Get("p")); err == nil { page = n } if page < 1 { diff --git a/internal/modules/forumnewthread.go b/internal/modules/forumnewthread.go index 31cca5fe..1b50dd06 100644 --- a/internal/modules/forumnewthread.go +++ b/internal/modules/forumnewthread.go @@ -8,7 +8,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) func init() { module.Register("forumnewthread", renderForumNewThread) } @@ -51,7 +51,7 @@ func renderForumNewThread(env module.Env, _ map[string]string, _ string) (string } canonical := forumCategoryURL(category.ID, category.Name) - config, err := pyjson.Marshal(pyjson.Object{ + config, err := wikijson.Marshal(wikijson.Object{ {Key: "categoryId", Value: category.ID}, {Key: "user", Value: viewer}, {Key: "cancelUrl", Value: canonical}, diff --git a/internal/modules/forumstart.go b/internal/modules/forumstart.go index c9a93d1a..e43da47d 100644 --- a/internal/modules/forumstart.go +++ b/internal/modules/forumstart.go @@ -11,7 +11,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("forumstart", renderForumStart) } @@ -60,8 +60,6 @@ func renderForumStart(env module.Env, _ map[string]string, _ string) (string, er showURL = "/forum/s-" + strconv.FormatInt(only.ID, 10) + "/hidden/show" } - // Python's loop variable overwrites the section the URL named, so the - // breadcrumbs turn up on any listing that has a section in it at all. var crumb *db.ForumSection if len(rows) != 0 { crumb = &rows[0] @@ -93,7 +91,7 @@ func forumStartSections(env module.Env, path page.PathParams) ([]db.ForumSection return rows, nil, nil } - id, err := pynum.Int(param.Value) + id, err := wikinum.Int(param.Value) if err != nil { return nil, nil, forumFailed(env) } @@ -118,8 +116,8 @@ func forumStartItems(env module.Env, rows []db.ForumSection) ([]forumStartSectio if err != nil { return nil, err } - // Django asks this once per category, but a forum category carries no - // overrides of its own, so the answer cannot differ between them. + // A forum category carries no overrides of its own, so the answer cannot + // differ between them. viewCategories := perms.Resolve(subject, nil).Has(perms.ViewForumCategories) var out []forumStartSection diff --git a/internal/modules/forumthread.go b/internal/modules/forumthread.go index cd9a4a1f..e20dc3e4 100644 --- a/internal/modules/forumthread.go +++ b/internal/modules/forumthread.go @@ -15,8 +15,8 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/pageconfig" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("forumthread", renderForumThread) } @@ -112,8 +112,6 @@ func renderForumThread(env module.Env, params map[string]string, _ string) (stri return forumThreadHTML(env, view), nil } -// Python rebinds t to the parsed number before the message reads it, so a -// well-formed id is echoed back normalized and a missing one prints as None. func forumThreadOf(env module.Env, path page.PathParams) (*db.ForumThread, error) { shown := "None" if param, ok := path.Lookup("t"); ok { @@ -124,7 +122,7 @@ func forumThreadOf(env module.Env, path page.PathParams) (*db.ForumThread, error return &module.Error{Message: env.Text("module-forumthread-not-found", "name", shown)} } - id, err := pynum.Int(shown) + id, err := wikinum.Int(shown) if err != nil { return nil, notFound() } @@ -205,7 +203,7 @@ func forumThreadPosts(env module.Env, view *forumThreadView, path page.PathParam view.total = total current := 1 - if n, err := pynum.Int(path.Get("p")); err == nil { + if n, err := wikinum.Int(path.Get("p")); err == nil { current = n } else if n, err := forumThreadPageOfPost(env, view.thread.ID, path); err != nil { return err @@ -249,7 +247,7 @@ func forumThreadPageOfPost(env module.Env, threadID int64, path page.PathParams) if !ok || param.Bare { return 1, nil } - id, err := pynum.Int(param.Value) + id, err := wikinum.Int(param.Value) if err != nil { return 0, forumFailed(env) } @@ -358,8 +356,6 @@ func forumThreadPostInfo(env module.Env, view *forumThreadView, posts []db.Forum return out, nil } -// Django compares two model rows, and two absent authors compare equal, so a -// thread nobody owns marks every unowned post as its opener. func samePerson(a, b *int64) bool { if a == nil || b == nil { return a == nil && b == nil @@ -386,13 +382,13 @@ func forumPostOptions(env module.Env, view *forumThreadView, post db.ForumThread return "", err } - return pyjson.Marshal(pyjson.Object{ + return wikijson.Marshal(wikijson.Object{ {Key: "threadId", Value: view.thread.ID}, {Key: "threadName", Value: view.name}, {Key: "postId", Value: post.ID}, {Key: "postName", Value: post.Name}, {Key: "hasRevisions", Value: !post.CreatedAt.Equal(post.UpdatedAt)}, - {Key: "lastRevisionDate", Value: pyISOFormat(post.UpdatedAt)}, + {Key: "lastRevisionDate", Value: isoTimestamp(post.UpdatedAt)}, {Key: "lastRevisionAuthor", Value: reviser}, {Key: "user", Value: viewer}, {Key: "canReply", Value: threadGranted.Has(forumReplyPerm(view))}, @@ -417,7 +413,7 @@ func forumThreadConfigs(env module.Env, view *forumThreadView, params map[string if err != nil { return err } - if view.newPost, err = pyjson.Marshal(pyjson.Object{ + if view.newPost, err = wikijson.Marshal(wikijson.Object{ {Key: "threadId", Value: view.thread.ID}, {Key: "threadName", Value: view.name}, {Key: "user", Value: viewer}, @@ -434,7 +430,7 @@ func forumThreadConfigs(env module.Env, view *forumThreadView, params map[string if view.thread.CategoryID != nil { categoryID = *view.thread.CategoryID } - if view.threadOptions, err = pyjson.Marshal(pyjson.Object{ + if view.threadOptions, err = wikijson.Marshal(wikijson.Object{ {Key: "threadId", Value: view.thread.ID}, {Key: "threadName", Value: view.name}, {Key: "threadDescription", Value: view.thread.Description}, @@ -454,17 +450,17 @@ func forumThreadConfigs(env module.Env, view *forumThreadView, params map[string if env.Page != nil { path = env.Page.PathParams } - if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + if view.pathParams, err = wikijson.Marshal(pathParamsObject(path)); err != nil { return err } - view.params, err = pyjson.Marshal(paramsObject(params, nil)) + view.params, err = wikijson.Marshal(paramsObject(params, nil)) return err } -// The section test asks about the thread rather than the section, which is what -// Python passes, so a section hidden from users never drops out here. -func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) (pyjson.Array, error) { - out := pyjson.Array{} +// The section test asks about the thread rather than the section, so a section +// hidden from users never drops out here. +func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) (wikijson.Array, error) { + out := wikijson.Array{} if !granted.Has(perms.ViewForumSections) { return out, nil } @@ -481,12 +477,12 @@ func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) return nil, err } for _, section := range sections { - var under pyjson.Array + var under wikijson.Array for _, category := range categories { if category.SectionID != section.ID { continue } - under = append(under, pyjson.Object{ + under = append(under, wikijson.Object{ {Key: "name", Value: "  " + category.Name}, {Key: "canMove", Value: !category.IsForComments}, {Key: "id", Value: category.ID}, @@ -495,7 +491,7 @@ func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) if len(under) == 0 { continue } - out = append(out, pyjson.Object{ + out = append(out, wikijson.Object{ {Key: "name", Value: section.Name}, {Key: "canMove", Value: false}, {Key: "id", Value: nil}, @@ -505,14 +501,14 @@ func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) return out, nil } -func forumViewerJSON(env module.Env) (pyjson.Object, error) { +func forumViewerJSON(env module.Env) (wikijson.Object, error) { if env.User == nil { return pageconfig.AnonymousUserJSON(env.Loc, true).Object(), nil } return forumUserJSON(env, &env.User.ID) } -func forumUserJSON(env module.Env, id *int64) (pyjson.Object, error) { +func forumUserJSON(env module.Env, id *int64) (wikijson.Object, error) { if id == nil { return pageconfig.SystemUserJSON().Object(), nil } @@ -555,18 +551,18 @@ func forumVoteHTML(env module.Env, mode string, rate float64, voted bool) string var shown string switch mode { case page.RatingModeUpDown: - shown = pySignedInt(rate) + shown = signedInt(rate) case page.RatingModeStars: shown = strconv.FormatFloat(rate, 'f', 1, 64) default: shown = strconv.FormatInt(int64(rate), 10) } - // Python opens two spans here and closes one. Closing the outer one would - // change the DOM of every post that carries a rating. + // Two spans open here and one closes. Closing the outer one would change + // the DOM of every post that carries a rating. return `` + escape.HTML(shown) + `` } -func pySignedInt(f float64) string { +func signedInt(f float64) string { n := int64(f) if n < 0 { return strconv.FormatInt(n, 10) @@ -574,9 +570,9 @@ func pySignedInt(f float64) string { return "+" + strconv.FormatInt(n, 10) } -// Python drops the fractional part when it is zero, so the two shapes are not +// The fractional part is dropped when it is zero, so the two shapes are not // interchangeable. -func pyISOFormat(t time.Time) string { +func isoTimestamp(t time.Time) string { t = t.UTC() if t.Nanosecond() == 0 { return t.Format("2006-01-02T15:04:05-07:00") diff --git a/internal/modules/listpages.go b/internal/modules/listpages.go index 2057a547..3b5187f1 100644 --- a/internal/modules/listpages.go +++ b/internal/modules/listpages.go @@ -8,7 +8,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/listpages" "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) func init() { module.Register("listpages", renderListPages) } @@ -16,8 +16,8 @@ func init() { module.Register("listpages", renderListPages) } // The two interfaces are kept apart, and this is what stops them drifting. var _ listpages.Source = (module.Data)(nil) -// Python runs out of stack and loses one request, while Go would lose the -// whole process. +// Without a depth cap a page that includes itself would take the whole process +// down rather than the one request. const maxNesting = 10 func renderListPages(env module.Env, params map[string]string, body string) (string, error) { @@ -148,47 +148,47 @@ func wrap(env module.Env, pc *page.Context, out string, result listpages.Result, basePath = listpages.BasePath(pageID, pc.PathParams) } - pathJSON, err := pyjson.Marshal(pathParamsObject(pc.PathParams)) + pathJSON, err := wikijson.Marshal(pathParamsObject(pc.PathParams)) if err != nil { return "", err } - paramsJSON, err := pyjson.Marshal(paramsObject(params, nullParams)) + paramsJSON, err := wikijson.Marshal(paramsObject(params, nullParams)) if err != nil { return "", err } pagination := listpages.Pagination(env.Loc, basePath, result.Page, result.TotalPages) - return listpages.Wrap(out, pagination, pathJSON, paramsJSON, pyjson.String(body), pageID), nil + return listpages.Wrap(out, pagination, pathJSON, paramsJSON, wikijson.String(body), pageID), nil } -func pathParamsObject(params page.PathParams) pyjson.Object { - out := make(pyjson.Object, 0, len(params)) +func pathParamsObject(params page.PathParams) wikijson.Object { + out := make(wikijson.Object, 0, len(params)) for _, param := range params { var value any if !param.Bare { value = param.Value } - out = append(out, pyjson.Field{Key: param.Key, Value: value}) + out = append(out, wikijson.Field{Key: param.Key, Value: value}) } return out } // The keys are sorted because the order ftml hands them over in is not stable, // and an attribute that changes between two renders cannot be compared. -func paramsObject(params map[string]string, null map[string]bool) pyjson.Object { +func paramsObject(params map[string]string, null map[string]bool) wikijson.Object { keys := make([]string, 0, len(params)) for key := range params { keys = append(keys, key) } slices.Sort(keys) - out := make(pyjson.Object, 0, len(keys)) + out := make(wikijson.Object, 0, len(keys)) for _, key := range keys { var value any if !null[key] { value = params[key] } - out = append(out, pyjson.Field{Key: key, Value: value}) + out = append(out, wikijson.Field{Key: key, Value: value}) } return out } diff --git a/internal/modules/rate.go b/internal/modules/rate.go index 7c9bd0af..b093f380 100644 --- a/internal/modules/rate.go +++ b/internal/modules/rate.go @@ -48,8 +48,8 @@ func renderRate(env module.Env, _ map[string]string, _ string) (string, error) { return upDownWidget(env, article.FullName(), rating), nil } - // Django only reaches the vote lookup for a signed-in reader, so the - // anonymous votes a null user id would match are never asked about. + // The vote lookup is only reached for a signed-in reader, so the anonymous + // votes a null user id would match are never asked about. voted := false if env.User != nil { voted, err = env.Data.HasVoted(article.ID, &env.User.ID) diff --git a/internal/modules/recentposts.go b/internal/modules/recentposts.go index 547ccd9f..db01a173 100644 --- a/internal/modules/recentposts.go +++ b/internal/modules/recentposts.go @@ -10,8 +10,8 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("recentposts", renderRecentPosts) } @@ -106,7 +106,7 @@ func renderRecentPosts(env module.Env, params map[string]string, _ string) (stri } current := 1 - if n, err := pynum.Int(path.Get("p")); err == nil { + if n, err := wikinum.Int(path.Get("p")); err == nil { current = n } if current < 1 { @@ -128,10 +128,10 @@ func renderRecentPosts(env module.Env, params map[string]string, _ string) (stri } view.pagination = listpages.Pagination(env.Loc, "", current, maxPage) - if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + if view.pathParams, err = wikijson.Marshal(pathParamsObject(path)); err != nil { return "", err } - if view.params, err = pyjson.Marshal(paramsObject(params, nil)); err != nil { + if view.params, err = wikijson.Marshal(paramsObject(params, nil)); err != nil { return "", err } return recentPostsHTML(env, view), nil @@ -157,7 +157,7 @@ func recentPostsCategories(env module.Env, path page.PathParams, subject perms.S return visible, nil, nil } - id, err := pynum.Int(asked) + id, err := wikinum.Int(asked) if err != nil { return nil, nil, nil } diff --git a/internal/modules/search.go b/internal/modules/search.go index ddf38c23..6947a40a 100644 --- a/internal/modules/search.go +++ b/internal/modules/search.go @@ -6,7 +6,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/escape" "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) func init() { module.Register("search", renderSearch) } @@ -18,7 +18,7 @@ func renderSearch(env module.Env, params map[string]string, _ string) (string, e } fromPath := func(key string) string { return strings.TrimSpace(path.Get(key)) } - config := pyjson.Object{ + config := wikijson.Object{ {Key: "placeholder", Value: firstNonBlank(params["placeholder"], env.Text("module-search-placeholder"))}, {Key: "tags", Value: params["tags"]}, {Key: "category", Value: params["category"]}, @@ -27,7 +27,7 @@ func renderSearch(env module.Env, params map[string]string, _ string) (string, e {Key: "datefrom", Value: fromPath("datefrom")}, {Key: "dateto", Value: fromPath("dateto")}, } - encoded, err := pyjson.Marshal(config) + encoded, err := wikijson.Marshal(config) if err != nil { return "", err } diff --git a/internal/modules/sitechanges.go b/internal/modules/sitechanges.go index 2ca3bf85..56e18887 100644 --- a/internal/modules/sitechanges.go +++ b/internal/modules/sitechanges.go @@ -13,14 +13,14 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/listpages" "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("sitechanges", renderSiteChanges) } -// Every path parameter Python chokes on raises out of the module and reaches -// the reader as one block, so nothing here records which one it was. +// Every path parameter this rejects reaches the reader as the same block, so +// nothing here records which one it was. var errSiteChange = errors.New("modules: site change is not renderable") // Sorting this list would reorder the type checkboxes on the page. @@ -130,14 +130,12 @@ func siteChangesBuild(env module.Env, path page.PathParams, params map[string]st if err != nil { return siteChangesView{}, err } - // Django divides by the page size and then slices with it, so zero and - // negative both raise before anything reaches the reader. if perPage <= 0 { return siteChangesView{}, errSiteChange } current := 1 - if n, err := pynum.Int(path.Get("p")); err == nil { + if n, err := wikinum.Int(path.Get("p")); err == nil { current = n } if current < 1 { @@ -182,10 +180,10 @@ func siteChangesBuild(env module.Env, path page.PathParams, params map[string]st }) } - if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + if view.pathParams, err = wikijson.Marshal(pathParamsObject(path)); err != nil { return siteChangesView{}, err } - if view.params, err = pyjson.Marshal(paramsObject(params, nil)); err != nil { + if view.params, err = wikijson.Marshal(paramsObject(params, nil)); err != nil { return siteChangesView{}, err } return view, nil @@ -223,7 +221,7 @@ func siteChangePerPage(path page.PathParams) (int, error) { if err != nil { return 0, err } - n, err := pynum.Int(raw) + n, err := wikinum.Int(raw) if err != nil { return 0, errSiteChange } @@ -484,7 +482,7 @@ func (m siteChangeMeta) str(key string) (string, error) { if !ok { return "", errSiteChange } - return pyStr(raw), nil + return metaText(raw), nil } func (m siteChangeMeta) two(first, second string) (string, string, error) { @@ -522,7 +520,7 @@ func (m siteChangeMeta) names(key string) ([]string, error) { if !ok { return nil, errSiteChange } - out = append(out, pyStr(name)) + out = append(out, metaText(name)) } return out, nil } @@ -545,7 +543,7 @@ func (m siteChangeMeta) integer(key string) (int, error) { return 0, errSiteChange } if quoted, ok := unquoteJSON(raw); ok { - n, err := pynum.Int(quoted) + n, err := wikinum.Int(quoted) if err != nil { return 0, errSiteChange } @@ -564,7 +562,7 @@ func (m siteChangeMeta) float(key string) (float64, error) { return 0, errSiteChange } if quoted, ok := unquoteJSON(raw); ok { - f, err := pynum.Float(quoted) + f, err := wikinum.Float(quoted) if err != nil { return 0, errSiteChange } @@ -588,9 +586,9 @@ func unquoteJSON(raw json.RawMessage) (string, bool) { return out, true } -// The comment lines are f-strings over whatever the log entry stored, so a -// value that is not a string still has to come out the way Python prints it. -func pyStr(raw json.RawMessage) string { +// The comment lines interpolate whatever the log entry stored, so a value that +// is not a string still has to come out as text. +func metaText(raw json.RawMessage) string { text := strings.TrimSpace(string(raw)) switch text { case "null": diff --git a/internal/page/rating.go b/internal/page/rating.go index 097fb3cc..335e0dad 100644 --- a/internal/page/rating.go +++ b/internal/page/rating.go @@ -32,13 +32,13 @@ func RatingOf(mode string, stats db.VoteStats) Rating { return Rating{ Value: value, Votes: stats.Count, - Popularity: pyRound(float64(good) / float64(count) * 100), + Popularity: roundHalfEven(float64(good) / float64(count) * 100), Mode: mode, } } -// round1 is Python's round(x, 1). Both languages round the exact binary value -// to nearest with ties going to the even digit, so the text round trip agrees. +// The exact binary value rounds to nearest with ties going to the even digit, +// so a number written as text and read back agrees. func round1(x float64) float64 { rounded, err := strconv.ParseFloat(strconv.FormatFloat(x, 'f', 1, 64), 64) if err != nil { diff --git a/internal/page/template.go b/internal/page/template.go index 2e72f262..a4644262 100644 --- a/internal/page/template.go +++ b/internal/page/template.go @@ -7,8 +7,7 @@ import ( "strconv" ) -// Go's dot excludes newlines by default, the same as Python's without DOTALL, -// so a %% pair may not span lines. +// Go's dot excludes newlines by default, so a %% pair may not span lines. var variablePattern = regexp.MustCompile(`%%(.*?)%%`) // ApplyTemplate replaces every %%name%% the resolver knows. An unresolved name diff --git a/internal/page/vars.go b/internal/page/vars.go index 4727fa0c..521ce82c 100644 --- a/internal/page/vars.go +++ b/internal/page/vars.go @@ -237,8 +237,8 @@ func (v *Vars) compute(name string) (string, bool) { return "", false } -// notFoundOrFail keeps a missing row out of Err. A page with no revision yet -// leaves %%content%% standing, which is what Django renders too. +// A missing row is kept out of Err, so a page with no revision yet leaves +// %%content%% standing. func (v *Vars) notFoundOrFail(err error) bool { if errors.Is(err, db.ErrNotFound) { return false @@ -391,12 +391,12 @@ func (v *Vars) popularity() (string, bool) { if count == 0 { count = 1 } - return strconv.Itoa(pyRound(float64(good) / float64(count) * 100)), true + return strconv.Itoa(roundHalfEven(float64(good) / float64(count) * 100)), true } -// pyRound is Python's round, where a halfway value goes to the even neighbour, -// so a popularity of exactly 12.5 is 12 and not 13. -func pyRound(x float64) int { +// A halfway value goes to the even neighbour, so a popularity of exactly 12.5 +// is 12 and not 13. +func roundHalfEven(x float64) int { return int(math.RoundToEven(x)) } @@ -446,8 +446,6 @@ func (v *Vars) userText(u *db.User) string { return u.Username } -// QuoteAll matches Python's quote(safe=”), which escapes the slash too and -// spells a space %20 rather than a plus. func QuoteAll(s string) string { return strings.ReplaceAll(url.QueryEscape(s), "+", "%20") } diff --git a/internal/page/vars_test.go b/internal/page/vars_test.go index 786920b7..93ebb25f 100644 --- a/internal/page/vars_test.go +++ b/internal/page/vars_test.go @@ -587,8 +587,8 @@ func TestPyRound(t *testing.T) { {12.6, 13}, } for _, tt := range tests { - if got := pyRound(tt.in); got != tt.want { - t.Errorf("pyRound(%v) = %d, want %d", tt.in, got, tt.want) + if got := roundHalfEven(tt.in); got != tt.want { + t.Errorf("roundHalfEven(%v) = %d, want %d", tt.in, got, tt.want) } } } diff --git a/internal/pageconfig/options.go b/internal/pageconfig/options.go index 592a2f5b..0000eb90 100644 --- a/internal/pageconfig/options.go +++ b/internal/pageconfig/options.go @@ -4,7 +4,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/article" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) type Options struct { @@ -23,8 +23,8 @@ type Options struct { Preferences Preferences } -// Preferences is every preference the registry carries, which today is one. -// The frontend reads them under the section__name key Django writes. +// Preferences is every preference the registry carries, which today is one. The +// frontend reads them under the section__name key. type Preferences struct { AdvancedSourceEditor bool } @@ -35,12 +35,10 @@ const ( preferenceKey = PreferenceSection + "__" + PreferenceAdvancedSourceEditor ) -// PreferenceEnabled reads the value Django stores, which is the Python repr of -// the boolean rather than a JSON one. func PreferenceEnabled(raw string) bool { return raw == "True" } func (o Options) JSON() (string, error) { - return pyjson.Marshal(pyjson.Object{ + return wikijson.Marshal(wikijson.Object{ {Key: "optionsEnabled", Value: o.HasArticle}, {Key: "editable", Value: o.Perms.Has(perms.EditArticles)}, {Key: "lockable", Value: o.Perms.Has(perms.LockArticles)}, @@ -76,21 +74,21 @@ func (o Options) commentThread() any { return "/" + o.NormalizedName + "/comments/show" } -func (o Options) preferences() pyjson.Object { +func (o Options) preferences() wikijson.Object { if o.Anonymous { - return pyjson.Object{} + return wikijson.Object{} } - return pyjson.Object{{Key: preferenceKey, Value: o.Preferences.AdvancedSourceEditor}} + return wikijson.Object{{Key: preferenceKey, Value: o.Preferences.AdvancedSourceEditor}} } -func pathParams(params article.Params) pyjson.Object { - out := make(pyjson.Object, 0, len(params)) +func pathParams(params article.Params) wikijson.Object { + out := make(wikijson.Object, 0, len(params)) for _, param := range params { var value any if !param.Bare { value = param.Value } - out = append(out, pyjson.Field{Key: param.Key, Value: value}) + out = append(out, wikijson.Field{Key: param.Key, Value: value}) } return out } diff --git a/internal/pageconfig/user.go b/internal/pageconfig/user.go index a1a06d66..a0489a9d 100644 --- a/internal/pageconfig/user.go +++ b/internal/pageconfig/user.go @@ -3,8 +3,8 @@ package pageconfig import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/i18n" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) const ( @@ -27,8 +27,8 @@ type UserJSON struct { Roles any } -func (u UserJSON) Object() pyjson.Object { - return pyjson.Object{ +func (u UserJSON) Object() wikijson.Object { + return wikijson.Object{ {Key: "type", Value: u.Type}, {Key: "id", Value: u.ID}, {Key: "name", Value: u.Name}, @@ -44,7 +44,7 @@ func (u UserJSON) Object() pyjson.Object { } } -func (u UserJSON) JSON() (string, error) { return pyjson.Marshal(u.Object()) } +func (u UserJSON) JSON() (string, error) { return wikijson.Marshal(u.Object()) } func SystemUserJSON() UserJSON { return UserJSON{Type: typeSystem, IsActive: true, Editor: false} @@ -114,7 +114,7 @@ func (l LoginStatus) JSON(loc *i18n.Localizer) (string, error) { if l.User != nil { user = SignedInUserJSON(l.User, l.Roles, true, l.CanEditArticles) } - return pyjson.Marshal(pyjson.Object{ + return wikijson.Marshal(wikijson.Object{ {Key: "user", Value: user.Object()}, {Key: "notificationCount", Value: l.NotificationCount}, }) diff --git a/internal/perms/perms.go b/internal/perms/perms.go index 85275d55..cfeba089 100644 --- a/internal/perms/perms.go +++ b/internal/perms/perms.go @@ -41,7 +41,7 @@ var lockable = []string{EditArticles, ManageArticleAuthors, ManageArticleFiles, var silenced = []string{CommentArticles, CreateForumPosts, EditForumPosts, DeleteForumPosts, EditForumThreads, PinForumThreads, MoveForumThreads} // Set answers one question at a time. A superuser gets a set that says yes to -// every name, which is the shortcut Django takes before any backend runs. +// every name before any rule runs. type Set struct { all bool named map[string]bool @@ -105,8 +105,6 @@ type Object struct { HiddenForUsers bool - // Django reaches this through the post's override pipeline, so a thread's - // rules run after the post's own. Thread *Object } diff --git a/internal/printuser/printuser.go b/internal/printuser/printuser.go index 8b7c7b37..5ddd32de 100644 --- a/internal/printuser/printuser.go +++ b/internal/printuser/printuser.go @@ -71,8 +71,8 @@ func (r *Renderer) Anonymous(opts Options) string { return b.String() } -// External is the wd: user that was never imported: the name is normalized as -// a page name, not as a user name, and the displayed form keeps the original. +// External is the wd: user nobody imported. The name is normalized as a page +// name rather than a user name, and the displayed form keeps the original. func (r *Renderer) External(username string, opts Options) string { display := escape.HTML(username) name := escape.HTML(wikidot.Normalize(username)) @@ -173,8 +173,8 @@ func classAdd(opts Options) string { return "" } -// The tooltip is dropped rather than emitted empty, which leaves the two -// spaces Django's {% if %} leaves behind. +// The tooltip is dropped rather than emitted empty, which leaves two spaces +// behind. func title(tooltip string) string { if tooltip == "" { return "" diff --git a/internal/repo/perms.go b/internal/repo/perms.go index 4c004372..41d1e32b 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -64,8 +64,8 @@ func (p *Perms) Subject(u *db.User, now time.Time) (perms.Subject, error) { return subject, nil } -// Article is the object side for a page that exists. The overrides come from -// its category, which is the only step Django takes before the page's own. +// Article is the object side for a page that exists. Its category is the only +// step taken before the page's own overrides. func (p *Perms) Article(a *db.Article, u *db.User) (*perms.Object, error) { overrides, err := p.db.CategoryOverrides(p.ctx, a.Category) if err != nil { diff --git a/internal/repo/repo.go b/internal/repo/repo.go index d973b64a..6327f422 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -105,9 +105,8 @@ func (r *Repository) RenderModule(pc *page.Context, name string, params map[stri return html, err } -// RenderUser mirrors the prefix handling in renderer/__init__.py: external: -// never touches the database, wd: may only ever match an imported account, and -// a bare name is matched against both name columns. +// The external: prefix never touches the database, wd: may only ever match an +// imported account, and a bare name is matched against both name columns. func (r *Repository) RenderUser(username string, avatar bool) (string, error) { opts := printuser.Options{Avatar: avatar, Hover: true} diff --git a/internal/roles/roles.go b/internal/roles/roles.go index e88303a1..364c63f8 100644 --- a/internal/roles/roles.go +++ b/internal/roles/roles.go @@ -73,9 +73,8 @@ type Tails struct { // relative to the media root. type IconLoader func(path string) (string, error) -// NameTails builds the decorations shown next to a user name. Roles must -// arrive ordered by index; the first role of a given (mode, category) pair -// wins, which is what Django's DISTINCT ON over that pair resolves to. +// Roles must arrive ordered by index, since the first role of a given mode and +// category pair is the one that wins. func NameTails(rs []Role, load IconLoader) (Tails, error) { type key struct { mode InlineVisualMode diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 974f620b..e892ed3b 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -10,8 +10,8 @@ import ( type Owner string const ( - OwnerGo Owner = "go" - OwnerDjango Owner = "django" + OwnerGo Owner = "go" + OwnerUpstream Owner = "upstream" ) type Route struct { @@ -24,13 +24,13 @@ const root = "/" var Table = []Route{ {Prefix: "/", Owner: OwnerGo, Label: "articles"}, - {Prefix: "/-/", Owner: OwnerDjango, Label: "system pages"}, + {Prefix: "/-/", Owner: OwnerUpstream, Label: "system pages"}, {Prefix: "/-/static/", Owner: OwnerGo, Label: "static assets"}, - {Prefix: "/api/", Owner: OwnerDjango, Label: "API"}, + {Prefix: "/api/", Owner: OwnerUpstream, Label: "API"}, {Prefix: "/local--files/", Owner: OwnerGo, Label: "site files"}, - {Prefix: "/local--code/", Owner: OwnerDjango, Label: "code blocks"}, - {Prefix: "/local--html/", Owner: OwnerDjango, Label: "embedded HTML"}, - {Prefix: "/local--theme/", Owner: OwnerDjango, Label: "page theme"}, + {Prefix: "/local--code/", Owner: OwnerUpstream, Label: "code blocks"}, + {Prefix: "/local--html/", Owner: OwnerUpstream, Label: "embedded HTML"}, + {Prefix: "/local--theme/", Owner: OwnerUpstream, Label: "page theme"}, } func Validate(table []Route) error { @@ -47,8 +47,8 @@ func Validate(table []Route) error { return fmt.Errorf("duplicate route prefix %q", r.Prefix) } seen[r.Prefix] = true - if r.Owner != OwnerGo && r.Owner != OwnerDjango { - return fmt.Errorf("route %q owner = %q, want go or django", r.Prefix, r.Owner) + if r.Owner != OwnerGo && r.Owner != OwnerUpstream { + return fmt.Errorf("route %q owner = %q, want go or upstream", r.Prefix, r.Owner) } if r.Prefix == root { hasRoot = true @@ -68,23 +68,23 @@ type Mux struct { var _ http.Handler = (*Mux)(nil) -func New(table []Route, django http.Handler, goHandlers map[string]http.Handler) (*Mux, error) { +func New(table []Route, upstream http.Handler, goHandlers map[string]http.Handler) (*Mux, error) { if err := Validate(table); err != nil { return nil, err } - if django == nil { - return nil, fmt.Errorf("django handler is nil") + if upstream == nil { + return nil, fmt.Errorf("upstream handler is nil") } handlers := make(map[string]http.Handler, len(table)) var fallback Route for _, r := range table { switch r.Owner { - case OwnerDjango: + case OwnerUpstream: if _, ok := goHandlers[r.Prefix]; ok { - return nil, fmt.Errorf("route %q is owned by django but a Go handler is registered", r.Prefix) + return nil, fmt.Errorf("route %q is owned by upstream but a Go handler is registered", r.Prefix) } - handlers[r.Prefix] = django + handlers[r.Prefix] = upstream case OwnerGo: h, ok := goHandlers[r.Prefix] if !ok { diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go index 63da597f..7925e80e 100644 --- a/internal/routing/routing_test.go +++ b/internal/routing/routing_test.go @@ -23,11 +23,11 @@ func TestValidateRejectsBadTable(t *testing.T) { name string table []Route }{ - {"prefix does not start with slash", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "api/", Owner: OwnerDjango}}}, - {"prefix does not end with slash", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api", Owner: OwnerDjango}}}, - {"duplicate prefix", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerGo}}}, + {"prefix does not start with slash", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "api/", Owner: OwnerUpstream}}}, + {"prefix does not end with slash", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api", Owner: OwnerUpstream}}}, + {"duplicate prefix", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerGo}}}, {"invalid owner", []Route{{Prefix: "/", Owner: "rust"}}}, - {"missing fallback prefix", []Route{{Prefix: "/api/", Owner: OwnerDjango}}}, + {"missing fallback prefix", []Route{{Prefix: "/api/", Owner: OwnerUpstream}}}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -51,7 +51,7 @@ func goHandlers() map[string]http.Handler { } func TestMuxRouteLongestPrefixWins(t *testing.T) { - m, err := New(Table, stub("django"), goHandlers()) + m, err := New(Table, stub("upstream"), goHandlers()) if err != nil { t.Fatalf("New() err = %v, want nil", err) } @@ -80,41 +80,41 @@ func TestMuxRouteLongestPrefixWins(t *testing.T) { } } -func TestNewRejectsNilDjango(t *testing.T) { +func TestNewRejectsNilUpstream(t *testing.T) { if _, err := New(Table, nil, nil); err == nil { - t.Error("New(django=nil) err = nil, want non-nil") + t.Error("New(upstream=nil) err = nil, want non-nil") } } func TestNewRejectsGoRouteWithoutHandler(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerGo}} - if _, err := New(table, stub("django"), nil); err == nil { + table := []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerGo}} + if _, err := New(table, stub("upstream"), nil); err == nil { t.Error("New() err = nil, want non-nil") } } -func TestNewRejectsDjangoRouteWithHandler(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerDjango}} +func TestNewRejectsUpstreamRouteWithHandler(t *testing.T) { + table := []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerUpstream}} handlers := map[string]http.Handler{"/api/": stub("go")} - if _, err := New(table, stub("django"), handlers); err == nil { + if _, err := New(table, stub("upstream"), handlers); err == nil { t.Error("New() err = nil, want non-nil") } } func TestNewRejectsHandlerOutsideTable(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerDjango}} + table := []Route{{Prefix: "/", Owner: OwnerUpstream}} handlers := map[string]http.Handler{"/forum/": stub("go")} - if _, err := New(table, stub("django"), handlers); err == nil { + if _, err := New(table, stub("upstream"), handlers); err == nil { t.Error("New() err = nil, want non-nil") } } func TestMuxServeHTTPDispatches(t *testing.T) { table := []Route{ - {Prefix: "/", Owner: OwnerDjango}, + {Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerGo}, } - m, err := New(table, stub("django"), map[string]http.Handler{"/api/": stub("go")}) + m, err := New(table, stub("upstream"), map[string]http.Handler{"/api/": stub("go")}) if err != nil { t.Fatalf("New() err = %v, want nil", err) } @@ -124,7 +124,7 @@ func TestMuxServeHTTPDispatches(t *testing.T) { want string }{ {"/api/articles", "go"}, - {"/scp-173", "django"}, + {"/scp-173", "upstream"}, } for _, tt := range tests { t.Run(tt.path, func(t *testing.T) { diff --git a/internal/session/signing.go b/internal/session/signing.go index ae371211..23dec162 100644 --- a/internal/session/signing.go +++ b/internal/session/signing.go @@ -29,8 +29,6 @@ func (s Signer) signature(value, key string) string { return b64Encode(saltedHMAC(s.Salt+"signer", key, value)) } -// keys puts the current secret first, the order Django tries them in while a -// key rotation is in flight. func (s Signer) keys() []string { return append([]string{s.Key}, s.Fallbacks...) } diff --git a/internal/shell/shell.go b/internal/shell/shell.go index 73961ba6..76116f97 100644 --- a/internal/shell/shell.go +++ b/internal/shell/shell.go @@ -24,7 +24,8 @@ const ( var files embed.FS // text/template rather than html/template because Go's escaper picks and spells -// different characters than Django's, and this output is compared byte for byte. +// different characters than these pages do, and the output is compared byte for +// byte. var tmpl = template.Must(template.New("shell").Funcs(template.FuncMap{ "esc": escape.HTML, "escjs": escape.JS, diff --git a/internal/site/host.go b/internal/site/host.go index 52c82b11..e2cbbd18 100644 --- a/internal/site/host.go +++ b/internal/site/host.go @@ -16,14 +16,12 @@ type Lookup interface { } // HostRules is the redirect between the two domains plus the header pair that -// follows from which one the request arrived on. The asset bundle must stay -// outside it: whitenoise answers those before Django applies any of this. +// follows from which one the request arrived on. The asset bundle stays outside +// it, since it is answered before any of this runs. type HostRules struct { sites Lookup serverPort string next http.Handler - // unresolved takes over when the Host matches no site; that response is - // still Django's to render. unresolved http.Handler } @@ -46,10 +44,9 @@ func (h *HostRules) ServeHTTP(w http.ResponseWriter, r *http.Request) { decision := Decide(Site{Domain: found.Domain, MediaDomain: found.MediaDomain}, r.Host, r.URL) if decision.Action == Redirect { - // Not http.Redirect: it writes an HTML body for GET, and Django sends - // none. + // Not http.Redirect, which writes an HTML body for GET where this + // response has none. w.Header().Set("Location", decision.Location) - // The type of the body Django would have sent, kept so the two agree. w.Header().Set("Content-Type", redirectContentType) // Written out because net/http leaves it off a HEAD it did not size. w.Header().Set("Content-Length", "0") @@ -57,8 +54,6 @@ func (h *HostRules) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } - // Django sets these after the handler runs, overwriting it. Setting them - // first lets the handler win; nothing writes these names today. for name, value := range decision.Headers { w.Header().Set(name, value) } diff --git a/internal/wikidot/username.go b/internal/wikidot/username.go index dbcab8ec..350b7581 100644 --- a/internal/wikidot/username.go +++ b/internal/wikidot/username.go @@ -7,12 +7,9 @@ import ( "golang.org/x/text/unicode/norm" ) -// CanonicalizeUsername mirrors canonicalize_username in web/models/users.py. -// Unlike Normalize it keeps non-Latin letters, so a Chinese name canonicalizes -// to itself rather than to an empty string. -// -// Python's [\W_]+ is every run that is neither a letter nor a number, because -// \W excludes the underscore that the class then adds back. +// Unlike Normalize this keeps non-Latin letters, so a Chinese name +// canonicalizes to itself rather than to an empty string. Every run that is +// neither a letter nor a number collapses, the underscore included. func CanonicalizeUsername(name string) string { var b strings.Builder pending := false diff --git a/internal/pyjson/testdata/oracle_pyjson.py b/internal/wikijson/testdata/oracle_wikijson.py similarity index 52% rename from internal/pyjson/testdata/oracle_pyjson.py rename to internal/wikijson/testdata/oracle_wikijson.py index 3b16292f..6d73260c 100644 --- a/internal/pyjson/testdata/oracle_pyjson.py +++ b/internal/wikijson/testdata/oracle_wikijson.py @@ -1,15 +1,15 @@ """Dump the same corpus with Python's own json.dumps. - PYJSON_CORPUS="$(cat internal/pyjson/testdata/pyjson_corpus.json)" \ - python internal/pyjson/testdata/oracle_pyjson.py > pyjson.python.golden + WIKIJSON_CORPUS="$(cat internal/wikijson/testdata/wikijson_corpus.json)" \ + python internal/wikijson/testdata/oracle_wikijson.py > wikijson.python.golden It needs no Django, so a host Python does. To check the version the server runs: - PYJSON_CORPUS="$(cat internal/pyjson/testdata/pyjson_corpus.json)" \ - docker compose exec -T -e PYJSON_CORPUS web python \ - < internal/pyjson/testdata/oracle_pyjson.py + WIKIJSON_CORPUS="$(cat internal/wikijson/testdata/wikijson_corpus.json)" \ + docker compose exec -T -e WIKIJSON_CORPUS web python \ + < internal/wikijson/testdata/oracle_wikijson.py -Then compare with internal/pyjson/testdata/pyjson.golden. Each corpus entry is a +Then compare with internal/wikijson/testdata/wikijson.golden. Each corpus entry is a JSON document; json.loads keeps the key order and tells an int from a float, which is what the comparison is about. """ @@ -19,7 +19,7 @@ import os import sys -corpus = os.environ.get('PYJSON_CORPUS') +corpus = os.environ.get('WIKIJSON_CORPUS') if not corpus: raise SystemExit(__doc__) diff --git a/internal/pyjson/testdata/pyjson.golden b/internal/wikijson/testdata/wikijson.golden similarity index 100% rename from internal/pyjson/testdata/pyjson.golden rename to internal/wikijson/testdata/wikijson.golden diff --git a/internal/pyjson/testdata/pyjson_corpus.json b/internal/wikijson/testdata/wikijson_corpus.json similarity index 100% rename from internal/pyjson/testdata/pyjson_corpus.json rename to internal/wikijson/testdata/wikijson_corpus.json diff --git a/internal/pyjson/pyjson.go b/internal/wikijson/wikijson.go similarity index 80% rename from internal/pyjson/pyjson.go rename to internal/wikijson/wikijson.go index fd3020cc..9bf6937b 100644 --- a/internal/pyjson/pyjson.go +++ b/internal/wikijson/wikijson.go @@ -1,5 +1,7 @@ -// Package pyjson spells values the way Python's json.dumps does. -package pyjson +// Package wikijson writes the JSON dialect the wiki's stored data and frontend +// both expect, which separates with a space and keeps the fraction of a whole +// number. +package wikijson import ( "fmt" @@ -8,8 +10,8 @@ import ( "strings" ) -// Field is one key of an object. Objects are slices rather than maps because -// Python writes a dict in insertion order and these are compared byte for byte. +// Objects are slices rather than maps because the output keeps insertion order +// and is compared byte for byte. type Field struct { Key string Value any @@ -19,8 +21,6 @@ type Object []Field type Array []any -// Marshal writes v with Python's separators, which carry a space that -// encoding/json never writes. func Marshal(v any) (string, error) { var b strings.Builder if err := write(&b, v); err != nil { @@ -62,7 +62,7 @@ func write(b *strings.Builder, v any) error { } return writeArray(b, items) default: - return fmt.Errorf("pyjson: cannot write %T", v) + return fmt.Errorf("wikijson: cannot write %T", v) } return nil } @@ -97,11 +97,11 @@ func writeArray(b *strings.Builder, a Array) error { return nil } -// Float writes what Python's repr gives. Go drops the fraction of a whole -// number and Python keeps it, so 4.0 must not come out as 4. +// Go drops the fraction of a whole number where this dialect keeps it, so 4.0 +// must not come out as 4. func Float(f float64) (string, error) { if math.IsInf(f, 0) || math.IsNaN(f) { - return "", fmt.Errorf("pyjson: cannot write %v", f) + return "", fmt.Errorf("wikijson: cannot write %v", f) } s := strconv.FormatFloat(f, 'g', -1, 64) if !strings.ContainsAny(s, ".e") { diff --git a/internal/pyjson/pyjson_test.go b/internal/wikijson/wikijson_test.go similarity index 97% rename from internal/pyjson/pyjson_test.go rename to internal/wikijson/wikijson_test.go index f7185603..20fbecb9 100644 --- a/internal/pyjson/pyjson_test.go +++ b/internal/wikijson/wikijson_test.go @@ -1,4 +1,4 @@ -package pyjson +package wikijson import ( "encoding/json" @@ -14,8 +14,8 @@ import ( var update = flag.Bool("update", false, "rewrite the golden file and the corpus the oracle reads") const ( - goldenPath = "testdata/pyjson.golden" - corpusPath = "testdata/pyjson_corpus.json" + goldenPath = "testdata/wikijson.golden" + corpusPath = "testdata/wikijson_corpus.json" ) func escaped(r rune) string { return fmt.Sprintf(`\u%04x`, r) } diff --git a/internal/pynum/pynum.go b/internal/wikinum/wikinum.go similarity index 71% rename from internal/pynum/pynum.go rename to internal/wikinum/wikinum.go index 180fc9bd..5b3c6d4a 100644 --- a/internal/pynum/pynum.go +++ b/internal/wikinum/wikinum.go @@ -1,6 +1,6 @@ -// Package pynum is Python's int() and float() over the strings a wikitext -// author typed. -package pynum +// Package wikinum parses the numbers a wikitext author typed, which tolerate +// surrounding space, a sign and underscores between digits. +package wikinum import ( "errors" @@ -8,10 +8,8 @@ import ( "strings" ) -var ErrNotANumber = errors.New("pynum: not a number") +var ErrNotANumber = errors.New("wikinum: not a number") -// Python's int() tolerates surrounding space, a sign and underscores between -// digits. Non-ASCII digits are the one thing it takes that this does not. func Int(s string) (int, error) { s = strings.TrimSpace(s) body := strings.TrimPrefix(strings.TrimPrefix(s, "+"), "-") @@ -33,7 +31,7 @@ func Int(s string) (int, error) { return n, nil } -// Go would take a hexadecimal float that Python rejects, so the digits are +// Go would take a hexadecimal float that this must not, so the digits are // checked first. func Float(s string) (float64, error) { if n, err := Int(s); err == nil { diff --git a/internal/pynum/pynum_test.go b/internal/wikinum/wikinum_test.go similarity index 98% rename from internal/pynum/pynum_test.go rename to internal/wikinum/wikinum_test.go index 2c8143e5..bb6068ec 100644 --- a/internal/pynum/pynum_test.go +++ b/internal/wikinum/wikinum_test.go @@ -1,4 +1,4 @@ -package pynum +package wikinum import "testing" From cc8cc4e479d502fd6b8ef039e6882b121c84be88 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 14:23:08 +0900 Subject: [PATCH 117/428] adjust --- cmd/pwikit/main.go | 2 - internal/article/path.go | 7 +-- internal/article/unquote.go | 9 ++- internal/article/vars.go | 9 ++- internal/articlepage/build.go | 6 +- internal/articlepage/render.go | 12 ++-- internal/auth/auth.go | 4 +- internal/callbacks/callbacks.go | 3 +- internal/compress/compress.go | 9 ++- internal/db/article.go | 6 +- internal/db/article_meta.go | 4 +- internal/db/chrome.go | 6 +- internal/db/forum.go | 3 - internal/db/listpages.go | 4 +- internal/db/options.go | 4 +- internal/db/perms.go | 9 ++- internal/db/rating.go | 4 -- internal/db/role.go | 5 +- internal/db/sitechanges.go | 4 +- internal/db/user.go | 7 +-- internal/difftest/listpages.go | 8 +-- internal/escape/escape.go | 8 +-- internal/escape/js.go | 4 +- internal/expr/builtin.go | 2 +- internal/expr/expr_test.go | 8 +-- internal/expr/value.go | 2 +- internal/listpages/params.go | 26 ++++----- internal/listpages/query.go | 4 +- internal/listpages/render.go | 2 - internal/listpages/render_test.go | 4 +- internal/media/media.go | 21 +++---- internal/media/mime.go | 3 +- internal/modules/forum.go | 4 +- internal/modules/forumcategory.go | 8 +-- internal/modules/forumnewthread.go | 4 +- internal/modules/forumstart.go | 10 ++-- internal/modules/forumthread.go | 56 +++++++++---------- internal/modules/listpages.go | 24 ++++---- internal/modules/rate.go | 4 +- internal/modules/recentposts.go | 12 ++-- internal/modules/search.go | 6 +- internal/modules/sitechanges.go | 32 +++++------ internal/page/rating.go | 6 +- internal/page/template.go | 3 +- internal/page/vars.go | 14 ++--- internal/page/vars_test.go | 4 +- internal/pageconfig/options.go | 22 ++++---- internal/pageconfig/user.go | 10 ++-- internal/perms/perms.go | 4 +- internal/printuser/printuser.go | 8 +-- internal/repo/perms.go | 4 +- internal/repo/repo.go | 5 +- internal/roles/roles.go | 5 +- internal/routing/routing.go | 30 +++++----- internal/routing/routing_test.go | 34 +++++------ internal/session/signing.go | 2 - internal/shell/shell.go | 3 +- internal/shell/templates/page.html | 2 +- internal/site/host.go | 13 ++--- internal/wikidot/username.go | 9 +-- .../testdata/oracle_wikijson.py} | 14 ++--- .../testdata/wikijson.golden} | 0 .../testdata/wikijson_corpus.json} | 0 .../pyjson.go => wikijson/wikijson.go} | 20 +++---- .../wikijson_test.go} | 6 +- .../{pynum/pynum.go => wikinum/wikinum.go} | 12 ++-- .../pynum_test.go => wikinum/wikinum_test.go} | 2 +- 67 files changed, 269 insertions(+), 332 deletions(-) rename internal/{pyjson/testdata/oracle_pyjson.py => wikijson/testdata/oracle_wikijson.py} (52%) rename internal/{pyjson/testdata/pyjson.golden => wikijson/testdata/wikijson.golden} (100%) rename internal/{pyjson/testdata/pyjson_corpus.json => wikijson/testdata/wikijson_corpus.json} (100%) rename internal/{pyjson/pyjson.go => wikijson/wikijson.go} (80%) rename internal/{pyjson/pyjson_test.go => wikijson/wikijson_test.go} (97%) rename internal/{pynum/pynum.go => wikinum/wikinum.go} (71%) rename internal/{pynum/pynum_test.go => wikinum/wikinum_test.go} (98%) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index efbc0137..f7af6800 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -171,8 +171,6 @@ func serve(args []string) error { return srv.ListenAndServe() } -// listenPort feeds the host lookup its second candidate, the way Django reads -// SERVER_PORT. func listenPort(addr string) string { _, port, err := net.SplitHostPort(addr) if err != nil { diff --git a/internal/article/path.go b/internal/article/path.go index 02ab523b..48f84c87 100644 --- a/internal/article/path.go +++ b/internal/article/path.go @@ -73,8 +73,6 @@ func rewriteForum(path string) string { return path } -// put keeps the position of the first occurrence, the way assigning to a -// Python dict does. // Encode writes the parameters back as a path, sorted by key. Only the values // are escaped, and only the first bare key survives. func Encode(p Params) string { @@ -115,9 +113,8 @@ func RedirectTarget(name string, params Params) (target string, ok bool) { return iriToURI("/" + normalized + Encode(params)), true } -// iriSafe is what Django leaves alone when it writes a Location, on top of the -// unreserved characters every escaper keeps. It spares the percent sign, so -// text escaped once does not grow a second time. +// iriSafe spares the percent sign on top of the unreserved characters, so text +// escaped once does not grow a second time. const iriSafe = "/#%[]=:;$&()+,!*?@'" func iriToURI(s string) string { diff --git a/internal/article/unquote.go b/internal/article/unquote.go index 2e791c6a..d938e4ab 100644 --- a/internal/article/unquote.go +++ b/internal/article/unquote.go @@ -5,8 +5,8 @@ import ( "unicode/utf8" ) -// unquote decodes %XX the way Python's urllib does. An escape it cannot read -// stays in the text, and bytes that are not UTF-8 turn into U+FFFD. +// An escape unquote cannot read stays in the text, and bytes that are not UTF-8 +// turn into U+FFFD. func unquote(s string) string { if !strings.Contains(s, "%") { return s @@ -67,9 +67,8 @@ func replaceInvalid(b []byte) string { return out.String() } -// subpartLen answers how many bytes one U+FFFD stands for. Python spends one -// per maximal subpart, so a truncated sequence costs one rather than one per -// byte. +// One U+FFFD stands for a whole maximal subpart, so a truncated sequence costs +// one replacement rather than one per byte. func subpartLen(b []byte) int { var want int var lo, hi byte diff --git a/internal/article/vars.go b/internal/article/vars.go index 6e29c53e..646c241a 100644 --- a/internal/article/vars.go +++ b/internal/article/vars.go @@ -4,7 +4,7 @@ import ( "strings" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) const ( @@ -24,19 +24,18 @@ func ThisPage(params Params, canonicalURL string) func(string) (string, bool) { param, ok := params.Lookup(lookupKey(name, prefixExpr)) switch { case !ok: - return pyjson.String(literal(name)), true + return wikijson.String(literal(name)), true case param.Bare: return "null", true } - return pyjson.String(param.Value), true + return wikijson.String(param.Value), true case strings.HasPrefix(name, prefixURL): param, ok := params.Lookup(lookupKey(name, prefixURL)) if !ok { return page.QuoteAll(literal(name)), true } - // A bare key crashes Django here, and the empty string is what the - // rest of this family answers for one. + // The empty string is what the rest of this family answers for a bare key. return page.QuoteAll(param.Value), true case strings.HasPrefix(name, prefixPath): diff --git a/internal/articlepage/build.go b/internal/articlepage/build.go index ae7eef01..fac58f15 100644 --- a/internal/articlepage/build.go +++ b/internal/articlepage/build.go @@ -102,8 +102,6 @@ func (h *Handler) load(req *request) error { return nil } -// permsObject reports checked=false when neither the page nor a row for its -// category exists, where Django asks nothing and lets the response be a 404. func (h *Handler) permsObject(req *request, perm *repo.Perms) (*perms.Object, bool, error) { if req.article != nil { object, err := perm.Article(req.article, req.user) @@ -121,8 +119,8 @@ func (h *Handler) permsObject(req *request, perm *repo.Perms) (*perms.Object, bo return object, true, err } -// Django creates the thread on the way past. This only reads, so a page nobody -// has commented on stays where it is. +// This only reads, so a page nobody has commented on gets no thread written for +// it. func (h *Handler) commentsRedirect(req *request) (string, error) { info, err := h.deps.DB.CommentInfo(req.ctx, req.article.ID) if err != nil { diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 123c5552..eaa656d9 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -15,12 +15,12 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/pageconfig" "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/printuser" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/shell" "github.com/WikitTeam/ProjectWikit/internal/site" "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) const ( @@ -164,7 +164,7 @@ func (h *Handler) source(req *request) (string, error) { } func (h *Handler) missingBody(req *request) (body, error) { - options, err := pyjson.Marshal(pyjson.Object{ + options, err := wikijson.Marshal(wikijson.Object{ {Key: "page_id", Value: req.name}, {Key: "pathParams", Value: pathParams(req.params)}, }) @@ -316,14 +316,14 @@ func excerpt(text string) string { return joined } -func pathParams(params article.Params) pyjson.Object { - out := make(pyjson.Object, 0, len(params)) +func pathParams(params article.Params) wikijson.Object { + out := make(wikijson.Object, 0, len(params)) for _, param := range params { var value any if !param.Bare { value = param.Value } - out = append(out, pyjson.Field{Key: param.Key, Value: value}) + out = append(out, wikijson.Field{Key: param.Key, Value: value}) } return out } @@ -534,7 +534,7 @@ func (h *Handler) rating(req *request) (page.Rating, error) { } // watching asks about the page and about the thread the path names. A t that is -// not a number leaves the second question unasked, where Django raises. +// not a number leaves the second question unasked. func (h *Handler) watching(req *request, threadID int64) (bool, error) { if req.user == nil { return false, nil diff --git a/internal/auth/auth.go b/internal/auth/auth.go index f86c9273..c253ccd1 100644 --- a/internal/auth/auth.go +++ b/internal/auth/auth.go @@ -91,8 +91,8 @@ func (r *Resolver) resolve(req *http.Request) *db.User { hash, _ := decoded[session.AuthUserHash].(string) if !r.store.AuthHashMatches(password, hash) { - // The password changed under this session. Django drops the row here, - // so leaving it would let the same cookie keep costing a query. + // The password changed under this session. Leaving the row would let the same + // dead cookie keep costing a query. if err := r.sessions.DeleteSession(ctx, cookie.Value); err != nil { r.log.Error("drop stale session", "err", err) } diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go index 0acfc488..87b9da15 100644 --- a/internal/callbacks/callbacks.go +++ b/internal/callbacks/callbacks.go @@ -48,8 +48,7 @@ type Callbacks struct { var _ renderer.Callbacks = (*Callbacks)(nil) // SetPageVars names the page whose %%this|x%% an included page reaches. Without -// it every such name is left standing, which is what a render with no article -// of its own gets in Django too. +// it every such name is left standing. func (c *Callbacks) SetPageVars(vars *page.Vars) { c.vars = vars } // SetContext hands the modules the page they are rendering into, which is what diff --git a/internal/compress/compress.go b/internal/compress/compress.go index 38f4d4c2..29faae39 100644 --- a/internal/compress/compress.go +++ b/internal/compress/compress.go @@ -1,4 +1,5 @@ -// Package compress gzips a response the way Django's GZipMiddleware does. +// Package compress gzips a response with a deterministic header, so the same +// body twice produces the same bytes. package compress import ( @@ -12,8 +13,8 @@ import ( "strings" ) -// Below this size Django returns the response untouched, Vary included, so the -// header is not a reliable sign that compression was considered. +// Below this size the response goes out untouched, Vary included, so that +// header is not a sign compression was considered. const minSize = 200 const ( @@ -78,8 +79,6 @@ func patchVary(h http.Header) { h.Set("Vary", current+", "+name) } -// pack writes the gzip stream Django writes, down to the zero timestamp and -// the padding it hides in the filename field. func pack(body []byte) ([]byte, error) { var out bytes.Buffer zw, err := gzip.NewWriterLevel(&out, level) diff --git a/internal/db/article.go b/internal/db/article.go index 7c22cb55..ec6736f9 100644 --- a/internal/db/article.go +++ b/internal/db/article.go @@ -6,9 +6,9 @@ import ( "strings" ) -// dumbName mirrors _page_name_to_dumb in renderer/__init__.py. complete_full_name -// is a generated column that always carries an explicit category, so a bare page -// name has to grow the implicit _default: prefix before it can match anything. +// complete_full_name is a generated column that always carries an explicit +// category, so a bare page name grows the implicit _default one before it can +// match anything. func dumbName(ref string) string { if strings.Contains(ref, ":") { return strings.ToLower(ref) diff --git a/internal/db/article_meta.go b/internal/db/article_meta.go index 784b381f..621f5439 100644 --- a/internal/db/article_meta.go +++ b/internal/db/article_meta.go @@ -46,8 +46,8 @@ func (d *DB) LatestSource(ctx context.Context, articleID int64) (string, error) return source, nil } -// The join table carries no ordering in Django, so the author order a page -// shows is whatever Postgres returns; ordering by the link row freezes it. +// The join table carries no ordering of its own, so ordering by the link row is +// what freezes the author order a page shows. var qArticleAuthors = register("ArticleAuthors", ` SELECT `+prefixed("u", userColumns)+` FROM web_article_authors link diff --git a/internal/db/chrome.go b/internal/db/chrome.go index ebff64f6..dd7c5e0c 100644 --- a/internal/db/chrome.go +++ b/internal/db/chrome.go @@ -62,8 +62,6 @@ type TagCategory struct { Tags []Tag } -// The tie-break is the category id because the order Django gets there falls out -// of iterating a set of model objects, which for small ids is ascending. var qArticleTagCategories = register("ArticleTagCategories", ` SELECT c.id, c.name, c.priority, t.name, CASE WHEN c.slug = '_default' THEN t.name ELSE c.slug || ':' || t.name END @@ -73,8 +71,8 @@ JOIN web_tagscategory c ON c.id = t.category_id WHERE link.article_id = $1 AND t.name NOT LIKE '\_%' ORDER BY c.id, link.id`) -// ArticleTagCategories returns the tag block in display order. A category with no -// priority sorts under the page's tag count, the number Django compares it with. +// A category with no priority sorts under the page's tag count, which is the +// number it is compared with. func (d *DB) ArticleTagCategories(ctx context.Context, articleID int64) ([]TagCategory, error) { rows, err := d.pool.Query(ctx, qArticleTagCategories, articleID) if err != nil { diff --git a/internal/db/forum.go b/internal/db/forum.go index 5b0896fa..ad6f0d26 100644 --- a/internal/db/forum.go +++ b/internal/db/forum.go @@ -140,7 +140,6 @@ func (d *DB) ForumCommentCounts(ctx context.Context) (ForumCounts, error) { const forumLastPostColumns = `p.id, p.created_at, t.id, t.name, t.category_id, t.article_id, p.author_id` -// Ties are left to the database because Django orders on the timestamp alone. var qForumCategoryLastPost = register("ForumCategoryLastPost", ` SELECT `+forumLastPostColumns+` FROM web_forumpost p @@ -273,8 +272,6 @@ func (d *DB) ForumThreadPostCount(ctx context.Context, threadID int64) (int, err return n, nil } -// Django indexes to the end of an ascending list rather than taking the first -// of a descending one, which decides differently when two posts share a stamp. var qForumThreadLastPost = register("ForumThreadLastPost", ` SELECT id, created_at, author_id FROM web_forumpost diff --git a/internal/db/listpages.go b/internal/db/listpages.go index d96ef678..dba29b12 100644 --- a/internal/db/listpages.go +++ b/internal/db/listpages.go @@ -108,8 +108,8 @@ func (b *listBuilder) arg(v any) string { return "$" + strconv.Itoa(len(b.args)) } -// A site that rates nothing still has to sort by something, and Django picks -// the id. +// A site that rates nothing still has to sort by something, so the id stands +// in. func ratingExpr(mode string) string { switch mode { case "updown": diff --git a/internal/db/options.go b/internal/db/options.go index 01d12196..61c8f22d 100644 --- a/internal/db/options.go +++ b/internal/db/options.go @@ -43,8 +43,8 @@ SELECT t.id, (SELECT count(*) FROM web_forumpost p WHERE p.thread_id = t.id) FROM web_forumthread t WHERE t.article_id = $1`) -// CommentInfo reports the zero value for a page whose thread has never been -// created. Django creates one here instead, which is a write on a read. +// A page whose thread has never been created reports the zero value rather than +// having one written for it on a read. func (d *DB) CommentInfo(ctx context.Context, articleID int64) (CommentInfo, error) { var info CommentInfo err := d.pool.QueryRow(ctx, qCommentInfo, articleID).Scan(&info.ThreadID, &info.Count) diff --git a/internal/db/perms.go b/internal/db/perms.go index b431a508..0a7b12dc 100644 --- a/internal/db/perms.go +++ b/internal/db/perms.go @@ -12,8 +12,8 @@ SELECT slug, id FROM web_role WHERE slug = ANY($1)`) -// The roles Django reads here are ordered by index. Nothing downstream depends -// on that: each role's permissions are settled on their own and then merged. +// Nothing downstream depends on the order. Each role's permissions are settled +// on their own and then merged. var qRoleIDsForUser = register("RoleIDsForUser", ` SELECT ur.role_id FROM web_user_roles ur @@ -56,9 +56,8 @@ SELECT EXISTS ( SELECT 1 FROM web_article_authors WHERE article_id = $1 AND user_id = $2 )`) -// RoleIDsBySlug resolves the two roles every visitor carries. A slug with no -// row is left out rather than created, which is where this parts ways with -// Django's get_or_create on a read path. +// A slug with no row is left out rather than created, because a read path must +// not write. func (d *DB) RoleIDsBySlug(ctx context.Context, slugs []string) (map[string]int64, error) { rows, err := d.pool.Query(ctx, qRoleIDsBySlug, slugs) if err != nil { diff --git a/internal/db/rating.go b/internal/db/rating.go index 40fc3889..b591d96e 100644 --- a/internal/db/rating.go +++ b/internal/db/rating.go @@ -76,8 +76,6 @@ func (d *DB) VoteStats(ctx context.Context, articleID int64) (VoteStats, error) return s, nil } -// A null user matches the votes cast without one, because Django filters on -// user=None the same way. var qHasVoted = register("HasVoted", ` SELECT EXISTS( SELECT 1 FROM web_vote @@ -91,8 +89,6 @@ func (d *DB) HasVoted(ctx context.Context, articleID int64, userID *int64) (bool return voted, nil } -// Django reaches for the last row of an unordered set, which it spells as the -// first row of one ordered by descending key. var qVoteByUser = register("VoteByUser", ` SELECT rate FROM web_vote diff --git a/internal/db/role.go b/internal/db/role.go index 89e1ef84..10fd2f84 100644 --- a/internal/db/role.go +++ b/internal/db/role.go @@ -16,9 +16,8 @@ JOIN web_user_roles ur ON ur.role_id = r.id WHERE ur.user_id = $1 ORDER BY r.index, r.id`) -// RolesByUser returns every role of one user, ordered the way the name tail -// and showcase queries both consume it. The tie-break on id has no counterpart -// in Django, where index is rewritten to be unique on every role save. +// Ordered the way the name tail and showcase queries both consume it. The tie- +// break on id covers the rows whose index is not unique. func (d *DB) RolesByUser(ctx context.Context, userID int64) ([]roles.Role, error) { rows, err := d.pool.Query(ctx, qRolesByUser, userID) if err != nil { diff --git a/internal/db/sitechanges.go b/internal/db/sitechanges.go index 3bd9081c..5bf83b76 100644 --- a/internal/db/sitechanges.go +++ b/internal/db/sitechanges.go @@ -150,8 +150,8 @@ SELECT id FROM web_user WHERE username = $1 OR wikidot_username = $1`) -// Django uppercases both sides rather than leaning on citext, and a wiki that -// renamed the column to text would silently start matching case-sensitively. +// Uppercasing both sides rather than leaning on citext, so a column changed to +// text would not silently start matching case-sensitively. var qUserIDsByNamePart = register("UserIDsByNamePart", ` SELECT id FROM web_user diff --git a/internal/db/user.go b/internal/db/user.go index d0d7bc26..5502c017 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -31,9 +31,8 @@ type User struct { ForumInactiveUntil *time.Time } -// ActiveAt reproduces User.__init__, where a deadline in the future overrides -// the stored flag in both directions: is_active is ignored whenever -// inactive_until is set. +// A deadline in the future overrides the stored flag in both directions, so +// is_active is ignored whenever inactive_until is set. func (u *User) ActiveAt(now time.Time) bool { if u.InactiveUntil == nil { return u.IsActive @@ -73,8 +72,6 @@ func firstNonEmpty(values ...string) string { const userColumns = `id, type, username, wikidot_username, display_name, avatar, is_active, inactive_until, is_superuser, is_forum_active, forum_inactive_until` -// Django's QuerySet.first() falls back to ordering by primary key when the -// queryset carries no ordering of its own, so these two are not stray sorts. var qUserByName = register("UserByName", ` SELECT `+userColumns+` FROM web_user diff --git a/internal/difftest/listpages.go b/internal/difftest/listpages.go index 6dd6a4a4..5c0459b8 100644 --- a/internal/difftest/listpages.go +++ b/internal/difftest/listpages.go @@ -6,7 +6,7 @@ import ( "strings" "github.com/WikitTeam/ProjectWikit/internal/escape" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) var attrUnescape = strings.NewReplacer( @@ -35,11 +35,11 @@ func sortListPagesParams(match []byte) []byte { } sort.Strings(keys) - out := make(pyjson.Object, 0, len(keys)) + out := make(wikijson.Object, 0, len(keys)) for _, key := range keys { - out = append(out, pyjson.Field{Key: key, Value: decoded[key]}) + out = append(out, wikijson.Field{Key: key, Value: decoded[key]}) } - sorted, err := pyjson.Marshal(out) + sorted, err := wikijson.Marshal(out) if err != nil { return match } diff --git a/internal/escape/escape.go b/internal/escape/escape.go index 771e47ed..5d91a01b 100644 --- a/internal/escape/escape.go +++ b/internal/escape/escape.go @@ -1,11 +1,11 @@ -// Package escape reproduces the escaping Django and Python apply on their way -// into a response. +// Package escape holds the HTML and URL escapes these pages use, which the +// standard library spells differently. package escape import "strings" -// Django writes ' as ' where html.EscapeString writes ', and the -// acceptance test for the whole renderer is byte-identical output. +// These pages spell ' as ' where html.EscapeString writes ', and the +// whole renderer is checked on byte-identical output. var replacer = strings.NewReplacer( "&", "&", "<", "<", diff --git a/internal/escape/js.go b/internal/escape/js.go index b77dbe33..9f640c5c 100644 --- a/internal/escape/js.go +++ b/internal/escape/js.go @@ -11,8 +11,8 @@ const ( paragraphSep = '\u2029' ) -// JS is Django's escapejs. Go's template.JSEscapeString covers a different set -// of characters and spells them differently, so it cannot stand in here. +// Go's template.JSEscapeString covers a different set of characters and spells +// them differently, so it cannot stand in here. func JS(s string) string { var b strings.Builder for _, r := range s { diff --git a/internal/expr/builtin.go b/internal/expr/builtin.go index 18e247ba..91e1c0f5 100644 --- a/internal/expr/builtin.go +++ b/internal/expr/builtin.go @@ -205,7 +205,7 @@ func unsetOf(args []Value) (Value, error) { if err := arity(args, 1); err != nil { return None(), err } - s := args[0].PyStr() + s := args[0].Text() return BoolOf(strings.HasPrefix(s, "%%") && strings.HasSuffix(s, "%%")), nil } diff --git a/internal/expr/expr_test.go b/internal/expr/expr_test.go index 62f16751..4b49c677 100644 --- a/internal/expr/expr_test.go +++ b/internal/expr/expr_test.go @@ -266,7 +266,7 @@ func TestEvaluateRandomStaysInRange(t *testing.T) { check(t, "random(3, 1)", None()) } -func TestPyStr(t *testing.T) { +func TestText(t *testing.T) { tests := []struct { in Value want string @@ -281,8 +281,8 @@ func TestPyStr(t *testing.T) { } for _, tt := range tests { t.Run(tt.want, func(t *testing.T) { - if got := tt.in.PyStr(); got != tt.want { - t.Errorf("PyStr(%+v) = %q, want %q", tt.in, got, tt.want) + if got := tt.in.Text(); got != tt.want { + t.Errorf("Text(%+v) = %q, want %q", tt.in, got, tt.want) } }) } @@ -302,7 +302,7 @@ func TestTruthy(t *testing.T) { {StrOf("0"), true}, } for _, tt := range tests { - t.Run(tt.in.PyStr(), func(t *testing.T) { + t.Run(tt.in.Text(), func(t *testing.T) { if got := tt.in.Truthy(); got != tt.want { t.Errorf("Truthy(%+v) = %v, want %v", tt.in, got, tt.want) } diff --git a/internal/expr/value.go b/internal/expr/value.go index 47c94a0f..153d93c2 100644 --- a/internal/expr/value.go +++ b/internal/expr/value.go @@ -74,7 +74,7 @@ func (v Value) Truthy() bool { return false } -func (v Value) PyStr() string { +func (v Value) Text() string { switch v.Kind { case KindBool: if v.Bool { diff --git a/internal/listpages/params.go b/internal/listpages/params.go index 049c7dec..4f329ae0 100644 --- a/internal/listpages/params.go +++ b/internal/listpages/params.go @@ -8,7 +8,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) type Source interface { @@ -384,7 +384,7 @@ func timeOp(op string) string { // day of 2020-12. func parseDateBounds(text string) (first, last time.Time, ok bool) { parts := strings.Split(text, "-") - year, err := pynum.Int(parts[0]) + year, err := wikinum.Int(parts[0]) if err != nil || year < 1 || year > 9999 { return time.Time{}, time.Time{}, false } @@ -392,7 +392,7 @@ func parseDateBounds(text string) (first, last time.Time, ok bool) { lastMonth, lastDay := 12, 31 if len(parts) >= 2 { - m, err := pynum.Int(parts[1]) + m, err := wikinum.Int(parts[1]) if err != nil { return time.Time{}, time.Time{}, false } @@ -401,7 +401,7 @@ func parseDateBounds(text string) (first, last time.Time, ok bool) { lastDay = daysIn(year, month) } if len(parts) >= 3 { - d, err := pynum.Int(parts[2]) + d, err := wikinum.Int(parts[2]) if err != nil { return time.Time{}, time.Time{}, false } @@ -441,7 +441,7 @@ func (p *parser) parseRating() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pynum.Float(strings.TrimSpace(rest)) + value, err := wikinum.Float(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -463,7 +463,7 @@ func (p *parser) parseVotes() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pynum.Int(strings.TrimSpace(rest)) + value, err := wikinum.Int(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -485,7 +485,7 @@ func (p *parser) parsePopularity() { return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - value, err := pynum.Int(strings.TrimSpace(rest)) + value, err := wikinum.Int(strings.TrimSpace(rest)) if err != nil { p.invalid() return @@ -524,8 +524,8 @@ func ratingValue(r page.Rating) float64 { return 0 } -// Python splits on a single space and strips each piece, which keeps a tab -// inside a tag name rather than breaking on it. +// Splitting on a single space and stripping each piece keeps a tab inside a tag +// name rather than breaking on it. func splitFields(s string) []string { var out []string for _, part := range strings.Split(s, " ") { @@ -567,19 +567,19 @@ func (p *parser) parseSort() { } func (p *parser) parseWindow() { - if offset, err := pynum.Int(p.getOr("offset", "0")); err == nil { + if offset, err := wikinum.Int(p.getOr("offset", "0")); err == nil { p.out.Offset = offset } if raw, ok := p.params["limit"]; ok { - if limit, err := pynum.Int(raw); err == nil { + if limit, err := wikinum.Int(raw); err == nil { p.out.Limit = &limit } } - perPage, err := pynum.Int(p.getOr("perpage", "20")) + perPage, err := wikinum.Int(p.getOr("perpage", "20")) if err != nil { perPage = defaultPerPage } - pageNum, err := pynum.Int(p.pathOr("p", "1")) + pageNum, err := wikinum.Int(p.pathOr("p", "1")) if err != nil || pageNum < 1 { pageNum = 1 } diff --git a/internal/listpages/query.go b/internal/listpages/query.go index 4daed886..c554e4a5 100644 --- a/internal/listpages/query.go +++ b/internal/listpages/query.go @@ -104,8 +104,8 @@ func window(q Query) (offset int, limit *int, skip bool) { return offset, &bounded, false } -// A per-page of zero would divide by zero in Django, so this reports no pages -// at all rather than failing the request. +// A per-page of zero reports no pages at all rather than dividing by zero and +// failing the request. func totalPages(total, perPage int) int { if perPage <= 0 { return 0 diff --git a/internal/listpages/render.go b/internal/listpages/render.go index 29b6267f..32ca4ba6 100644 --- a/internal/listpages/render.go +++ b/internal/listpages/render.go @@ -77,8 +77,6 @@ func BasePath(fullName string, path page.PathParams) string { return out } -// A key that arrived without a value is spelled the way Python spells the -// None it stores for one. func pathValue(param page.PathParam) string { if param.Bare { return "None" diff --git a/internal/listpages/render_test.go b/internal/listpages/render_test.go index b3759b97..6af9cb5c 100644 --- a/internal/listpages/render_test.go +++ b/internal/listpages/render_test.go @@ -11,7 +11,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/i18n" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) var update = flag.Bool("update", false, "rewrite the golden files and the corpora the oracles read") @@ -100,7 +100,7 @@ func TestSplitMatchesGolden(t *testing.T) { for _, c := range cases { s := Split(c.Content) fmt.Fprintf(&b, "=== %s\nhead=%s\nbody=%s\nfoot=%s\n", c.Name, - pyjson.String(s.Head), pyjson.String(s.Body), pyjson.String(s.Foot)) + wikijson.String(s.Head), wikijson.String(s.Body), wikijson.String(s.Foot)) } compareGolden(t, sectionsGolden, b.String(), sectionsCorpus, cases) } diff --git a/internal/media/media.go b/internal/media/media.go index a525add8..c42aef0a 100644 --- a/internal/media/media.go +++ b/internal/media/media.go @@ -19,10 +19,9 @@ import ( ) const ( - Prefix = "/local--files/" - notFoundBody = "Not found" - defaultMime = "application/octet-stream" - // What Django gives a response built without an explicit type. + Prefix = "/local--files/" + notFoundBody = "Not found" + defaultMime = "application/octet-stream" defaultHTMLMime = "text/html; charset=utf-8" ) @@ -74,8 +73,6 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } - // Django never writes the guessed type back onto the response, so anything - // the database did not name goes out labelled text/html. responseMime := mimeType if mimeType == "" { responseMime = defaultHTMLMime @@ -87,8 +84,6 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { chunk := chunkSizeFor(mimeType) if chunk == 0 { - // Django's FileResponse sets its own headers and ignores - // If-Modified-Since. w.Header().Set("Content-Type", mimeType) w.Header().Set("Content-Disposition", disposition(filepath.Base(full))) w.Header().Set("Content-Length", strconv.FormatInt(info.Size(), 10)) @@ -121,8 +116,8 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { w.Header().Set("Accept-Ranges", "bytes") if begin >= end || end == 0 { - // Django keeps the full Content-Length here and sends no body, which - // breaks the framing. + // The length has to be zero here, since no body follows and a full one would + // break the framing. w.Header().Set("Content-Range", fmt.Sprintf("bytes */%d", size)) w.Header().Set("Content-Length", "0") w.WriteHeader(http.StatusRequestedRangeNotSatisfiable) @@ -130,7 +125,7 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { } // end is exclusive here and inclusive in the header, so this is a byte - // short of what the client asked for. Django does the same. + // short of what the client asked for. w.Header().Set("Content-Range", fmt.Sprintf("bytes %d-%d/%d", begin, end-1, size)) w.Header().Set("Content-Length", strconv.FormatInt(end-begin, 10)) w.WriteHeader(http.StatusPartialContent) @@ -180,8 +175,8 @@ func exists(name string) bool { return err == nil } -// rangeBounds returns a half-open [begin, end). A false third value is a 416; -// Django raises on the malformed cases instead. +// rangeBounds returns a half-open [begin, end), and a false third value is a +// 416 rather than a raised error. func rangeBounds(header string, chunk, size int64) (begin, end int64, ok bool) { if header == "" { return 0, min(chunk, size), true diff --git a/internal/media/mime.go b/internal/media/mime.go index 3c325337..83e95663 100644 --- a/internal/media/mime.go +++ b/internal/media/mime.go @@ -2,8 +2,7 @@ package media import "strings" -// guessType mirrors Python's mimetypes.guess_type. An empty type means -// unknown; the caller supplies the fallback. +// An empty type means unknown, and the caller supplies the fallback. func guessType(name string) (mimeType, encoding string) { base, ext := splitExt(name) for { diff --git a/internal/modules/forum.go b/internal/modules/forum.go index d3f08293..f9e080af 100644 --- a/internal/modules/forum.go +++ b/internal/modules/forum.go @@ -44,8 +44,8 @@ func renderDate(env module.Env, at time.Time) string { escape.HTML(serverDate(env, at)) + `` } -// Python calls strftime on what the ORM handed back, which is UTC and not the -// site's zone. +// The stamp is formatted in UTC and not the site's zone, which is what the +// stored value carries. func serverDate(env module.Env, at time.Time) string { at = at.UTC() pad := func(n int) string { diff --git a/internal/modules/forumcategory.go b/internal/modules/forumcategory.go index e9b7ce39..2a0d851f 100644 --- a/internal/modules/forumcategory.go +++ b/internal/modules/forumcategory.go @@ -12,7 +12,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("forumcategory", renderForumCategory) } @@ -90,8 +90,6 @@ func renderForumCategory(env module.Env, _ map[string]string, _ string) (string, return forumCategoryHTML(env, view), nil } -// Python rebinds c to the parsed number before the message reads it, so a -// well-formed id is echoed back normalized and a missing one prints as None. func forumCategoryOf(env module.Env, path page.PathParams) (*db.ForumCategory, error) { shown := "None" if param, ok := path.Lookup("c"); ok { @@ -102,7 +100,7 @@ func forumCategoryOf(env module.Env, path page.PathParams) (*db.ForumCategory, e return &module.Error{Message: env.Text("module-forum-not-found", "name", shown)} } - id, err := pynum.Int(shown) + id, err := wikinum.Int(shown) if err != nil { return nil, notFound() } @@ -134,7 +132,7 @@ func forumCategoryThreads(env module.Env, view *forumCategoryView, path page.Pat } page := 1 - if n, err := pynum.Int(path.Get("p")); err == nil { + if n, err := wikinum.Int(path.Get("p")); err == nil { page = n } if page < 1 { diff --git a/internal/modules/forumnewthread.go b/internal/modules/forumnewthread.go index 31cca5fe..1b50dd06 100644 --- a/internal/modules/forumnewthread.go +++ b/internal/modules/forumnewthread.go @@ -8,7 +8,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) func init() { module.Register("forumnewthread", renderForumNewThread) } @@ -51,7 +51,7 @@ func renderForumNewThread(env module.Env, _ map[string]string, _ string) (string } canonical := forumCategoryURL(category.ID, category.Name) - config, err := pyjson.Marshal(pyjson.Object{ + config, err := wikijson.Marshal(wikijson.Object{ {Key: "categoryId", Value: category.ID}, {Key: "user", Value: viewer}, {Key: "cancelUrl", Value: canonical}, diff --git a/internal/modules/forumstart.go b/internal/modules/forumstart.go index c9a93d1a..e43da47d 100644 --- a/internal/modules/forumstart.go +++ b/internal/modules/forumstart.go @@ -11,7 +11,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("forumstart", renderForumStart) } @@ -60,8 +60,6 @@ func renderForumStart(env module.Env, _ map[string]string, _ string) (string, er showURL = "/forum/s-" + strconv.FormatInt(only.ID, 10) + "/hidden/show" } - // Python's loop variable overwrites the section the URL named, so the - // breadcrumbs turn up on any listing that has a section in it at all. var crumb *db.ForumSection if len(rows) != 0 { crumb = &rows[0] @@ -93,7 +91,7 @@ func forumStartSections(env module.Env, path page.PathParams) ([]db.ForumSection return rows, nil, nil } - id, err := pynum.Int(param.Value) + id, err := wikinum.Int(param.Value) if err != nil { return nil, nil, forumFailed(env) } @@ -118,8 +116,8 @@ func forumStartItems(env module.Env, rows []db.ForumSection) ([]forumStartSectio if err != nil { return nil, err } - // Django asks this once per category, but a forum category carries no - // overrides of its own, so the answer cannot differ between them. + // A forum category carries no overrides of its own, so the answer cannot + // differ between them. viewCategories := perms.Resolve(subject, nil).Has(perms.ViewForumCategories) var out []forumStartSection diff --git a/internal/modules/forumthread.go b/internal/modules/forumthread.go index cd9a4a1f..e20dc3e4 100644 --- a/internal/modules/forumthread.go +++ b/internal/modules/forumthread.go @@ -15,8 +15,8 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/pageconfig" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("forumthread", renderForumThread) } @@ -112,8 +112,6 @@ func renderForumThread(env module.Env, params map[string]string, _ string) (stri return forumThreadHTML(env, view), nil } -// Python rebinds t to the parsed number before the message reads it, so a -// well-formed id is echoed back normalized and a missing one prints as None. func forumThreadOf(env module.Env, path page.PathParams) (*db.ForumThread, error) { shown := "None" if param, ok := path.Lookup("t"); ok { @@ -124,7 +122,7 @@ func forumThreadOf(env module.Env, path page.PathParams) (*db.ForumThread, error return &module.Error{Message: env.Text("module-forumthread-not-found", "name", shown)} } - id, err := pynum.Int(shown) + id, err := wikinum.Int(shown) if err != nil { return nil, notFound() } @@ -205,7 +203,7 @@ func forumThreadPosts(env module.Env, view *forumThreadView, path page.PathParam view.total = total current := 1 - if n, err := pynum.Int(path.Get("p")); err == nil { + if n, err := wikinum.Int(path.Get("p")); err == nil { current = n } else if n, err := forumThreadPageOfPost(env, view.thread.ID, path); err != nil { return err @@ -249,7 +247,7 @@ func forumThreadPageOfPost(env module.Env, threadID int64, path page.PathParams) if !ok || param.Bare { return 1, nil } - id, err := pynum.Int(param.Value) + id, err := wikinum.Int(param.Value) if err != nil { return 0, forumFailed(env) } @@ -358,8 +356,6 @@ func forumThreadPostInfo(env module.Env, view *forumThreadView, posts []db.Forum return out, nil } -// Django compares two model rows, and two absent authors compare equal, so a -// thread nobody owns marks every unowned post as its opener. func samePerson(a, b *int64) bool { if a == nil || b == nil { return a == nil && b == nil @@ -386,13 +382,13 @@ func forumPostOptions(env module.Env, view *forumThreadView, post db.ForumThread return "", err } - return pyjson.Marshal(pyjson.Object{ + return wikijson.Marshal(wikijson.Object{ {Key: "threadId", Value: view.thread.ID}, {Key: "threadName", Value: view.name}, {Key: "postId", Value: post.ID}, {Key: "postName", Value: post.Name}, {Key: "hasRevisions", Value: !post.CreatedAt.Equal(post.UpdatedAt)}, - {Key: "lastRevisionDate", Value: pyISOFormat(post.UpdatedAt)}, + {Key: "lastRevisionDate", Value: isoTimestamp(post.UpdatedAt)}, {Key: "lastRevisionAuthor", Value: reviser}, {Key: "user", Value: viewer}, {Key: "canReply", Value: threadGranted.Has(forumReplyPerm(view))}, @@ -417,7 +413,7 @@ func forumThreadConfigs(env module.Env, view *forumThreadView, params map[string if err != nil { return err } - if view.newPost, err = pyjson.Marshal(pyjson.Object{ + if view.newPost, err = wikijson.Marshal(wikijson.Object{ {Key: "threadId", Value: view.thread.ID}, {Key: "threadName", Value: view.name}, {Key: "user", Value: viewer}, @@ -434,7 +430,7 @@ func forumThreadConfigs(env module.Env, view *forumThreadView, params map[string if view.thread.CategoryID != nil { categoryID = *view.thread.CategoryID } - if view.threadOptions, err = pyjson.Marshal(pyjson.Object{ + if view.threadOptions, err = wikijson.Marshal(wikijson.Object{ {Key: "threadId", Value: view.thread.ID}, {Key: "threadName", Value: view.name}, {Key: "threadDescription", Value: view.thread.Description}, @@ -454,17 +450,17 @@ func forumThreadConfigs(env module.Env, view *forumThreadView, params map[string if env.Page != nil { path = env.Page.PathParams } - if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + if view.pathParams, err = wikijson.Marshal(pathParamsObject(path)); err != nil { return err } - view.params, err = pyjson.Marshal(paramsObject(params, nil)) + view.params, err = wikijson.Marshal(paramsObject(params, nil)) return err } -// The section test asks about the thread rather than the section, which is what -// Python passes, so a section hidden from users never drops out here. -func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) (pyjson.Array, error) { - out := pyjson.Array{} +// The section test asks about the thread rather than the section, so a section +// hidden from users never drops out here. +func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) (wikijson.Array, error) { + out := wikijson.Array{} if !granted.Has(perms.ViewForumSections) { return out, nil } @@ -481,12 +477,12 @@ func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) return nil, err } for _, section := range sections { - var under pyjson.Array + var under wikijson.Array for _, category := range categories { if category.SectionID != section.ID { continue } - under = append(under, pyjson.Object{ + under = append(under, wikijson.Object{ {Key: "name", Value: "  " + category.Name}, {Key: "canMove", Value: !category.IsForComments}, {Key: "id", Value: category.ID}, @@ -495,7 +491,7 @@ func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) if len(under) == 0 { continue } - out = append(out, pyjson.Object{ + out = append(out, wikijson.Object{ {Key: "name", Value: section.Name}, {Key: "canMove", Value: false}, {Key: "id", Value: nil}, @@ -505,14 +501,14 @@ func forumThreadMoveTo(env module.Env, subject perms.Subject, granted perms.Set) return out, nil } -func forumViewerJSON(env module.Env) (pyjson.Object, error) { +func forumViewerJSON(env module.Env) (wikijson.Object, error) { if env.User == nil { return pageconfig.AnonymousUserJSON(env.Loc, true).Object(), nil } return forumUserJSON(env, &env.User.ID) } -func forumUserJSON(env module.Env, id *int64) (pyjson.Object, error) { +func forumUserJSON(env module.Env, id *int64) (wikijson.Object, error) { if id == nil { return pageconfig.SystemUserJSON().Object(), nil } @@ -555,18 +551,18 @@ func forumVoteHTML(env module.Env, mode string, rate float64, voted bool) string var shown string switch mode { case page.RatingModeUpDown: - shown = pySignedInt(rate) + shown = signedInt(rate) case page.RatingModeStars: shown = strconv.FormatFloat(rate, 'f', 1, 64) default: shown = strconv.FormatInt(int64(rate), 10) } - // Python opens two spans here and closes one. Closing the outer one would - // change the DOM of every post that carries a rating. + // Two spans open here and one closes. Closing the outer one would change + // the DOM of every post that carries a rating. return `` + escape.HTML(shown) + `` } -func pySignedInt(f float64) string { +func signedInt(f float64) string { n := int64(f) if n < 0 { return strconv.FormatInt(n, 10) @@ -574,9 +570,9 @@ func pySignedInt(f float64) string { return "+" + strconv.FormatInt(n, 10) } -// Python drops the fractional part when it is zero, so the two shapes are not +// The fractional part is dropped when it is zero, so the two shapes are not // interchangeable. -func pyISOFormat(t time.Time) string { +func isoTimestamp(t time.Time) string { t = t.UTC() if t.Nanosecond() == 0 { return t.Format("2006-01-02T15:04:05-07:00") diff --git a/internal/modules/listpages.go b/internal/modules/listpages.go index 2057a547..3b5187f1 100644 --- a/internal/modules/listpages.go +++ b/internal/modules/listpages.go @@ -8,7 +8,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/listpages" "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) func init() { module.Register("listpages", renderListPages) } @@ -16,8 +16,8 @@ func init() { module.Register("listpages", renderListPages) } // The two interfaces are kept apart, and this is what stops them drifting. var _ listpages.Source = (module.Data)(nil) -// Python runs out of stack and loses one request, while Go would lose the -// whole process. +// Without a depth cap a page that includes itself would take the whole process +// down rather than the one request. const maxNesting = 10 func renderListPages(env module.Env, params map[string]string, body string) (string, error) { @@ -148,47 +148,47 @@ func wrap(env module.Env, pc *page.Context, out string, result listpages.Result, basePath = listpages.BasePath(pageID, pc.PathParams) } - pathJSON, err := pyjson.Marshal(pathParamsObject(pc.PathParams)) + pathJSON, err := wikijson.Marshal(pathParamsObject(pc.PathParams)) if err != nil { return "", err } - paramsJSON, err := pyjson.Marshal(paramsObject(params, nullParams)) + paramsJSON, err := wikijson.Marshal(paramsObject(params, nullParams)) if err != nil { return "", err } pagination := listpages.Pagination(env.Loc, basePath, result.Page, result.TotalPages) - return listpages.Wrap(out, pagination, pathJSON, paramsJSON, pyjson.String(body), pageID), nil + return listpages.Wrap(out, pagination, pathJSON, paramsJSON, wikijson.String(body), pageID), nil } -func pathParamsObject(params page.PathParams) pyjson.Object { - out := make(pyjson.Object, 0, len(params)) +func pathParamsObject(params page.PathParams) wikijson.Object { + out := make(wikijson.Object, 0, len(params)) for _, param := range params { var value any if !param.Bare { value = param.Value } - out = append(out, pyjson.Field{Key: param.Key, Value: value}) + out = append(out, wikijson.Field{Key: param.Key, Value: value}) } return out } // The keys are sorted because the order ftml hands them over in is not stable, // and an attribute that changes between two renders cannot be compared. -func paramsObject(params map[string]string, null map[string]bool) pyjson.Object { +func paramsObject(params map[string]string, null map[string]bool) wikijson.Object { keys := make([]string, 0, len(params)) for key := range params { keys = append(keys, key) } slices.Sort(keys) - out := make(pyjson.Object, 0, len(keys)) + out := make(wikijson.Object, 0, len(keys)) for _, key := range keys { var value any if !null[key] { value = params[key] } - out = append(out, pyjson.Field{Key: key, Value: value}) + out = append(out, wikijson.Field{Key: key, Value: value}) } return out } diff --git a/internal/modules/rate.go b/internal/modules/rate.go index 7c9bd0af..b093f380 100644 --- a/internal/modules/rate.go +++ b/internal/modules/rate.go @@ -48,8 +48,8 @@ func renderRate(env module.Env, _ map[string]string, _ string) (string, error) { return upDownWidget(env, article.FullName(), rating), nil } - // Django only reaches the vote lookup for a signed-in reader, so the - // anonymous votes a null user id would match are never asked about. + // The vote lookup is only reached for a signed-in reader, so the anonymous + // votes a null user id would match are never asked about. voted := false if env.User != nil { voted, err = env.Data.HasVoted(article.ID, &env.User.ID) diff --git a/internal/modules/recentposts.go b/internal/modules/recentposts.go index 547ccd9f..db01a173 100644 --- a/internal/modules/recentposts.go +++ b/internal/modules/recentposts.go @@ -10,8 +10,8 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("recentposts", renderRecentPosts) } @@ -106,7 +106,7 @@ func renderRecentPosts(env module.Env, params map[string]string, _ string) (stri } current := 1 - if n, err := pynum.Int(path.Get("p")); err == nil { + if n, err := wikinum.Int(path.Get("p")); err == nil { current = n } if current < 1 { @@ -128,10 +128,10 @@ func renderRecentPosts(env module.Env, params map[string]string, _ string) (stri } view.pagination = listpages.Pagination(env.Loc, "", current, maxPage) - if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + if view.pathParams, err = wikijson.Marshal(pathParamsObject(path)); err != nil { return "", err } - if view.params, err = pyjson.Marshal(paramsObject(params, nil)); err != nil { + if view.params, err = wikijson.Marshal(paramsObject(params, nil)); err != nil { return "", err } return recentPostsHTML(env, view), nil @@ -157,7 +157,7 @@ func recentPostsCategories(env module.Env, path page.PathParams, subject perms.S return visible, nil, nil } - id, err := pynum.Int(asked) + id, err := wikinum.Int(asked) if err != nil { return nil, nil, nil } diff --git a/internal/modules/search.go b/internal/modules/search.go index ddf38c23..6947a40a 100644 --- a/internal/modules/search.go +++ b/internal/modules/search.go @@ -6,7 +6,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/escape" "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) func init() { module.Register("search", renderSearch) } @@ -18,7 +18,7 @@ func renderSearch(env module.Env, params map[string]string, _ string) (string, e } fromPath := func(key string) string { return strings.TrimSpace(path.Get(key)) } - config := pyjson.Object{ + config := wikijson.Object{ {Key: "placeholder", Value: firstNonBlank(params["placeholder"], env.Text("module-search-placeholder"))}, {Key: "tags", Value: params["tags"]}, {Key: "category", Value: params["category"]}, @@ -27,7 +27,7 @@ func renderSearch(env module.Env, params map[string]string, _ string) (string, e {Key: "datefrom", Value: fromPath("datefrom")}, {Key: "dateto", Value: fromPath("dateto")}, } - encoded, err := pyjson.Marshal(config) + encoded, err := wikijson.Marshal(config) if err != nil { return "", err } diff --git a/internal/modules/sitechanges.go b/internal/modules/sitechanges.go index 2ca3bf85..56e18887 100644 --- a/internal/modules/sitechanges.go +++ b/internal/modules/sitechanges.go @@ -13,14 +13,14 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/listpages" "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" - "github.com/WikitTeam/ProjectWikit/internal/pynum" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" ) func init() { module.Register("sitechanges", renderSiteChanges) } -// Every path parameter Python chokes on raises out of the module and reaches -// the reader as one block, so nothing here records which one it was. +// Every path parameter this rejects reaches the reader as the same block, so +// nothing here records which one it was. var errSiteChange = errors.New("modules: site change is not renderable") // Sorting this list would reorder the type checkboxes on the page. @@ -130,14 +130,12 @@ func siteChangesBuild(env module.Env, path page.PathParams, params map[string]st if err != nil { return siteChangesView{}, err } - // Django divides by the page size and then slices with it, so zero and - // negative both raise before anything reaches the reader. if perPage <= 0 { return siteChangesView{}, errSiteChange } current := 1 - if n, err := pynum.Int(path.Get("p")); err == nil { + if n, err := wikinum.Int(path.Get("p")); err == nil { current = n } if current < 1 { @@ -182,10 +180,10 @@ func siteChangesBuild(env module.Env, path page.PathParams, params map[string]st }) } - if view.pathParams, err = pyjson.Marshal(pathParamsObject(path)); err != nil { + if view.pathParams, err = wikijson.Marshal(pathParamsObject(path)); err != nil { return siteChangesView{}, err } - if view.params, err = pyjson.Marshal(paramsObject(params, nil)); err != nil { + if view.params, err = wikijson.Marshal(paramsObject(params, nil)); err != nil { return siteChangesView{}, err } return view, nil @@ -223,7 +221,7 @@ func siteChangePerPage(path page.PathParams) (int, error) { if err != nil { return 0, err } - n, err := pynum.Int(raw) + n, err := wikinum.Int(raw) if err != nil { return 0, errSiteChange } @@ -484,7 +482,7 @@ func (m siteChangeMeta) str(key string) (string, error) { if !ok { return "", errSiteChange } - return pyStr(raw), nil + return metaText(raw), nil } func (m siteChangeMeta) two(first, second string) (string, string, error) { @@ -522,7 +520,7 @@ func (m siteChangeMeta) names(key string) ([]string, error) { if !ok { return nil, errSiteChange } - out = append(out, pyStr(name)) + out = append(out, metaText(name)) } return out, nil } @@ -545,7 +543,7 @@ func (m siteChangeMeta) integer(key string) (int, error) { return 0, errSiteChange } if quoted, ok := unquoteJSON(raw); ok { - n, err := pynum.Int(quoted) + n, err := wikinum.Int(quoted) if err != nil { return 0, errSiteChange } @@ -564,7 +562,7 @@ func (m siteChangeMeta) float(key string) (float64, error) { return 0, errSiteChange } if quoted, ok := unquoteJSON(raw); ok { - f, err := pynum.Float(quoted) + f, err := wikinum.Float(quoted) if err != nil { return 0, errSiteChange } @@ -588,9 +586,9 @@ func unquoteJSON(raw json.RawMessage) (string, bool) { return out, true } -// The comment lines are f-strings over whatever the log entry stored, so a -// value that is not a string still has to come out the way Python prints it. -func pyStr(raw json.RawMessage) string { +// The comment lines interpolate whatever the log entry stored, so a value that +// is not a string still has to come out as text. +func metaText(raw json.RawMessage) string { text := strings.TrimSpace(string(raw)) switch text { case "null": diff --git a/internal/page/rating.go b/internal/page/rating.go index 097fb3cc..335e0dad 100644 --- a/internal/page/rating.go +++ b/internal/page/rating.go @@ -32,13 +32,13 @@ func RatingOf(mode string, stats db.VoteStats) Rating { return Rating{ Value: value, Votes: stats.Count, - Popularity: pyRound(float64(good) / float64(count) * 100), + Popularity: roundHalfEven(float64(good) / float64(count) * 100), Mode: mode, } } -// round1 is Python's round(x, 1). Both languages round the exact binary value -// to nearest with ties going to the even digit, so the text round trip agrees. +// The exact binary value rounds to nearest with ties going to the even digit, +// so a number written as text and read back agrees. func round1(x float64) float64 { rounded, err := strconv.ParseFloat(strconv.FormatFloat(x, 'f', 1, 64), 64) if err != nil { diff --git a/internal/page/template.go b/internal/page/template.go index 2e72f262..a4644262 100644 --- a/internal/page/template.go +++ b/internal/page/template.go @@ -7,8 +7,7 @@ import ( "strconv" ) -// Go's dot excludes newlines by default, the same as Python's without DOTALL, -// so a %% pair may not span lines. +// Go's dot excludes newlines by default, so a %% pair may not span lines. var variablePattern = regexp.MustCompile(`%%(.*?)%%`) // ApplyTemplate replaces every %%name%% the resolver knows. An unresolved name diff --git a/internal/page/vars.go b/internal/page/vars.go index 4727fa0c..521ce82c 100644 --- a/internal/page/vars.go +++ b/internal/page/vars.go @@ -237,8 +237,8 @@ func (v *Vars) compute(name string) (string, bool) { return "", false } -// notFoundOrFail keeps a missing row out of Err. A page with no revision yet -// leaves %%content%% standing, which is what Django renders too. +// A missing row is kept out of Err, so a page with no revision yet leaves +// %%content%% standing. func (v *Vars) notFoundOrFail(err error) bool { if errors.Is(err, db.ErrNotFound) { return false @@ -391,12 +391,12 @@ func (v *Vars) popularity() (string, bool) { if count == 0 { count = 1 } - return strconv.Itoa(pyRound(float64(good) / float64(count) * 100)), true + return strconv.Itoa(roundHalfEven(float64(good) / float64(count) * 100)), true } -// pyRound is Python's round, where a halfway value goes to the even neighbour, -// so a popularity of exactly 12.5 is 12 and not 13. -func pyRound(x float64) int { +// A halfway value goes to the even neighbour, so a popularity of exactly 12.5 +// is 12 and not 13. +func roundHalfEven(x float64) int { return int(math.RoundToEven(x)) } @@ -446,8 +446,6 @@ func (v *Vars) userText(u *db.User) string { return u.Username } -// QuoteAll matches Python's quote(safe=”), which escapes the slash too and -// spells a space %20 rather than a plus. func QuoteAll(s string) string { return strings.ReplaceAll(url.QueryEscape(s), "+", "%20") } diff --git a/internal/page/vars_test.go b/internal/page/vars_test.go index 786920b7..93ebb25f 100644 --- a/internal/page/vars_test.go +++ b/internal/page/vars_test.go @@ -587,8 +587,8 @@ func TestPyRound(t *testing.T) { {12.6, 13}, } for _, tt := range tests { - if got := pyRound(tt.in); got != tt.want { - t.Errorf("pyRound(%v) = %d, want %d", tt.in, got, tt.want) + if got := roundHalfEven(tt.in); got != tt.want { + t.Errorf("roundHalfEven(%v) = %d, want %d", tt.in, got, tt.want) } } } diff --git a/internal/pageconfig/options.go b/internal/pageconfig/options.go index 592a2f5b..0000eb90 100644 --- a/internal/pageconfig/options.go +++ b/internal/pageconfig/options.go @@ -4,7 +4,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/article" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) type Options struct { @@ -23,8 +23,8 @@ type Options struct { Preferences Preferences } -// Preferences is every preference the registry carries, which today is one. -// The frontend reads them under the section__name key Django writes. +// Preferences is every preference the registry carries, which today is one. The +// frontend reads them under the section__name key. type Preferences struct { AdvancedSourceEditor bool } @@ -35,12 +35,10 @@ const ( preferenceKey = PreferenceSection + "__" + PreferenceAdvancedSourceEditor ) -// PreferenceEnabled reads the value Django stores, which is the Python repr of -// the boolean rather than a JSON one. func PreferenceEnabled(raw string) bool { return raw == "True" } func (o Options) JSON() (string, error) { - return pyjson.Marshal(pyjson.Object{ + return wikijson.Marshal(wikijson.Object{ {Key: "optionsEnabled", Value: o.HasArticle}, {Key: "editable", Value: o.Perms.Has(perms.EditArticles)}, {Key: "lockable", Value: o.Perms.Has(perms.LockArticles)}, @@ -76,21 +74,21 @@ func (o Options) commentThread() any { return "/" + o.NormalizedName + "/comments/show" } -func (o Options) preferences() pyjson.Object { +func (o Options) preferences() wikijson.Object { if o.Anonymous { - return pyjson.Object{} + return wikijson.Object{} } - return pyjson.Object{{Key: preferenceKey, Value: o.Preferences.AdvancedSourceEditor}} + return wikijson.Object{{Key: preferenceKey, Value: o.Preferences.AdvancedSourceEditor}} } -func pathParams(params article.Params) pyjson.Object { - out := make(pyjson.Object, 0, len(params)) +func pathParams(params article.Params) wikijson.Object { + out := make(wikijson.Object, 0, len(params)) for _, param := range params { var value any if !param.Bare { value = param.Value } - out = append(out, pyjson.Field{Key: param.Key, Value: value}) + out = append(out, wikijson.Field{Key: param.Key, Value: value}) } return out } diff --git a/internal/pageconfig/user.go b/internal/pageconfig/user.go index a1a06d66..a0489a9d 100644 --- a/internal/pageconfig/user.go +++ b/internal/pageconfig/user.go @@ -3,8 +3,8 @@ package pageconfig import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/i18n" - "github.com/WikitTeam/ProjectWikit/internal/pyjson" "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) const ( @@ -27,8 +27,8 @@ type UserJSON struct { Roles any } -func (u UserJSON) Object() pyjson.Object { - return pyjson.Object{ +func (u UserJSON) Object() wikijson.Object { + return wikijson.Object{ {Key: "type", Value: u.Type}, {Key: "id", Value: u.ID}, {Key: "name", Value: u.Name}, @@ -44,7 +44,7 @@ func (u UserJSON) Object() pyjson.Object { } } -func (u UserJSON) JSON() (string, error) { return pyjson.Marshal(u.Object()) } +func (u UserJSON) JSON() (string, error) { return wikijson.Marshal(u.Object()) } func SystemUserJSON() UserJSON { return UserJSON{Type: typeSystem, IsActive: true, Editor: false} @@ -114,7 +114,7 @@ func (l LoginStatus) JSON(loc *i18n.Localizer) (string, error) { if l.User != nil { user = SignedInUserJSON(l.User, l.Roles, true, l.CanEditArticles) } - return pyjson.Marshal(pyjson.Object{ + return wikijson.Marshal(wikijson.Object{ {Key: "user", Value: user.Object()}, {Key: "notificationCount", Value: l.NotificationCount}, }) diff --git a/internal/perms/perms.go b/internal/perms/perms.go index 85275d55..cfeba089 100644 --- a/internal/perms/perms.go +++ b/internal/perms/perms.go @@ -41,7 +41,7 @@ var lockable = []string{EditArticles, ManageArticleAuthors, ManageArticleFiles, var silenced = []string{CommentArticles, CreateForumPosts, EditForumPosts, DeleteForumPosts, EditForumThreads, PinForumThreads, MoveForumThreads} // Set answers one question at a time. A superuser gets a set that says yes to -// every name, which is the shortcut Django takes before any backend runs. +// every name before any rule runs. type Set struct { all bool named map[string]bool @@ -105,8 +105,6 @@ type Object struct { HiddenForUsers bool - // Django reaches this through the post's override pipeline, so a thread's - // rules run after the post's own. Thread *Object } diff --git a/internal/printuser/printuser.go b/internal/printuser/printuser.go index 8b7c7b37..5ddd32de 100644 --- a/internal/printuser/printuser.go +++ b/internal/printuser/printuser.go @@ -71,8 +71,8 @@ func (r *Renderer) Anonymous(opts Options) string { return b.String() } -// External is the wd: user that was never imported: the name is normalized as -// a page name, not as a user name, and the displayed form keeps the original. +// External is the wd: user nobody imported. The name is normalized as a page +// name rather than a user name, and the displayed form keeps the original. func (r *Renderer) External(username string, opts Options) string { display := escape.HTML(username) name := escape.HTML(wikidot.Normalize(username)) @@ -173,8 +173,8 @@ func classAdd(opts Options) string { return "" } -// The tooltip is dropped rather than emitted empty, which leaves the two -// spaces Django's {% if %} leaves behind. +// The tooltip is dropped rather than emitted empty, which leaves two spaces +// behind. func title(tooltip string) string { if tooltip == "" { return "" diff --git a/internal/repo/perms.go b/internal/repo/perms.go index 4c004372..41d1e32b 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -64,8 +64,8 @@ func (p *Perms) Subject(u *db.User, now time.Time) (perms.Subject, error) { return subject, nil } -// Article is the object side for a page that exists. The overrides come from -// its category, which is the only step Django takes before the page's own. +// Article is the object side for a page that exists. Its category is the only +// step taken before the page's own overrides. func (p *Perms) Article(a *db.Article, u *db.User) (*perms.Object, error) { overrides, err := p.db.CategoryOverrides(p.ctx, a.Category) if err != nil { diff --git a/internal/repo/repo.go b/internal/repo/repo.go index d973b64a..6327f422 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -105,9 +105,8 @@ func (r *Repository) RenderModule(pc *page.Context, name string, params map[stri return html, err } -// RenderUser mirrors the prefix handling in renderer/__init__.py: external: -// never touches the database, wd: may only ever match an imported account, and -// a bare name is matched against both name columns. +// The external: prefix never touches the database, wd: may only ever match an +// imported account, and a bare name is matched against both name columns. func (r *Repository) RenderUser(username string, avatar bool) (string, error) { opts := printuser.Options{Avatar: avatar, Hover: true} diff --git a/internal/roles/roles.go b/internal/roles/roles.go index e88303a1..364c63f8 100644 --- a/internal/roles/roles.go +++ b/internal/roles/roles.go @@ -73,9 +73,8 @@ type Tails struct { // relative to the media root. type IconLoader func(path string) (string, error) -// NameTails builds the decorations shown next to a user name. Roles must -// arrive ordered by index; the first role of a given (mode, category) pair -// wins, which is what Django's DISTINCT ON over that pair resolves to. +// Roles must arrive ordered by index, since the first role of a given mode and +// category pair is the one that wins. func NameTails(rs []Role, load IconLoader) (Tails, error) { type key struct { mode InlineVisualMode diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 974f620b..e892ed3b 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -10,8 +10,8 @@ import ( type Owner string const ( - OwnerGo Owner = "go" - OwnerDjango Owner = "django" + OwnerGo Owner = "go" + OwnerUpstream Owner = "upstream" ) type Route struct { @@ -24,13 +24,13 @@ const root = "/" var Table = []Route{ {Prefix: "/", Owner: OwnerGo, Label: "articles"}, - {Prefix: "/-/", Owner: OwnerDjango, Label: "system pages"}, + {Prefix: "/-/", Owner: OwnerUpstream, Label: "system pages"}, {Prefix: "/-/static/", Owner: OwnerGo, Label: "static assets"}, - {Prefix: "/api/", Owner: OwnerDjango, Label: "API"}, + {Prefix: "/api/", Owner: OwnerUpstream, Label: "API"}, {Prefix: "/local--files/", Owner: OwnerGo, Label: "site files"}, - {Prefix: "/local--code/", Owner: OwnerDjango, Label: "code blocks"}, - {Prefix: "/local--html/", Owner: OwnerDjango, Label: "embedded HTML"}, - {Prefix: "/local--theme/", Owner: OwnerDjango, Label: "page theme"}, + {Prefix: "/local--code/", Owner: OwnerUpstream, Label: "code blocks"}, + {Prefix: "/local--html/", Owner: OwnerUpstream, Label: "embedded HTML"}, + {Prefix: "/local--theme/", Owner: OwnerUpstream, Label: "page theme"}, } func Validate(table []Route) error { @@ -47,8 +47,8 @@ func Validate(table []Route) error { return fmt.Errorf("duplicate route prefix %q", r.Prefix) } seen[r.Prefix] = true - if r.Owner != OwnerGo && r.Owner != OwnerDjango { - return fmt.Errorf("route %q owner = %q, want go or django", r.Prefix, r.Owner) + if r.Owner != OwnerGo && r.Owner != OwnerUpstream { + return fmt.Errorf("route %q owner = %q, want go or upstream", r.Prefix, r.Owner) } if r.Prefix == root { hasRoot = true @@ -68,23 +68,23 @@ type Mux struct { var _ http.Handler = (*Mux)(nil) -func New(table []Route, django http.Handler, goHandlers map[string]http.Handler) (*Mux, error) { +func New(table []Route, upstream http.Handler, goHandlers map[string]http.Handler) (*Mux, error) { if err := Validate(table); err != nil { return nil, err } - if django == nil { - return nil, fmt.Errorf("django handler is nil") + if upstream == nil { + return nil, fmt.Errorf("upstream handler is nil") } handlers := make(map[string]http.Handler, len(table)) var fallback Route for _, r := range table { switch r.Owner { - case OwnerDjango: + case OwnerUpstream: if _, ok := goHandlers[r.Prefix]; ok { - return nil, fmt.Errorf("route %q is owned by django but a Go handler is registered", r.Prefix) + return nil, fmt.Errorf("route %q is owned by upstream but a Go handler is registered", r.Prefix) } - handlers[r.Prefix] = django + handlers[r.Prefix] = upstream case OwnerGo: h, ok := goHandlers[r.Prefix] if !ok { diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go index 63da597f..7925e80e 100644 --- a/internal/routing/routing_test.go +++ b/internal/routing/routing_test.go @@ -23,11 +23,11 @@ func TestValidateRejectsBadTable(t *testing.T) { name string table []Route }{ - {"prefix does not start with slash", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "api/", Owner: OwnerDjango}}}, - {"prefix does not end with slash", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api", Owner: OwnerDjango}}}, - {"duplicate prefix", []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerGo}}}, + {"prefix does not start with slash", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "api/", Owner: OwnerUpstream}}}, + {"prefix does not end with slash", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api", Owner: OwnerUpstream}}}, + {"duplicate prefix", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerGo}}}, {"invalid owner", []Route{{Prefix: "/", Owner: "rust"}}}, - {"missing fallback prefix", []Route{{Prefix: "/api/", Owner: OwnerDjango}}}, + {"missing fallback prefix", []Route{{Prefix: "/api/", Owner: OwnerUpstream}}}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -51,7 +51,7 @@ func goHandlers() map[string]http.Handler { } func TestMuxRouteLongestPrefixWins(t *testing.T) { - m, err := New(Table, stub("django"), goHandlers()) + m, err := New(Table, stub("upstream"), goHandlers()) if err != nil { t.Fatalf("New() err = %v, want nil", err) } @@ -80,41 +80,41 @@ func TestMuxRouteLongestPrefixWins(t *testing.T) { } } -func TestNewRejectsNilDjango(t *testing.T) { +func TestNewRejectsNilUpstream(t *testing.T) { if _, err := New(Table, nil, nil); err == nil { - t.Error("New(django=nil) err = nil, want non-nil") + t.Error("New(upstream=nil) err = nil, want non-nil") } } func TestNewRejectsGoRouteWithoutHandler(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerGo}} - if _, err := New(table, stub("django"), nil); err == nil { + table := []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerGo}} + if _, err := New(table, stub("upstream"), nil); err == nil { t.Error("New() err = nil, want non-nil") } } -func TestNewRejectsDjangoRouteWithHandler(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerDjango}, {Prefix: "/api/", Owner: OwnerDjango}} +func TestNewRejectsUpstreamRouteWithHandler(t *testing.T) { + table := []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerUpstream}} handlers := map[string]http.Handler{"/api/": stub("go")} - if _, err := New(table, stub("django"), handlers); err == nil { + if _, err := New(table, stub("upstream"), handlers); err == nil { t.Error("New() err = nil, want non-nil") } } func TestNewRejectsHandlerOutsideTable(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerDjango}} + table := []Route{{Prefix: "/", Owner: OwnerUpstream}} handlers := map[string]http.Handler{"/forum/": stub("go")} - if _, err := New(table, stub("django"), handlers); err == nil { + if _, err := New(table, stub("upstream"), handlers); err == nil { t.Error("New() err = nil, want non-nil") } } func TestMuxServeHTTPDispatches(t *testing.T) { table := []Route{ - {Prefix: "/", Owner: OwnerDjango}, + {Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api/", Owner: OwnerGo}, } - m, err := New(table, stub("django"), map[string]http.Handler{"/api/": stub("go")}) + m, err := New(table, stub("upstream"), map[string]http.Handler{"/api/": stub("go")}) if err != nil { t.Fatalf("New() err = %v, want nil", err) } @@ -124,7 +124,7 @@ func TestMuxServeHTTPDispatches(t *testing.T) { want string }{ {"/api/articles", "go"}, - {"/scp-173", "django"}, + {"/scp-173", "upstream"}, } for _, tt := range tests { t.Run(tt.path, func(t *testing.T) { diff --git a/internal/session/signing.go b/internal/session/signing.go index ae371211..23dec162 100644 --- a/internal/session/signing.go +++ b/internal/session/signing.go @@ -29,8 +29,6 @@ func (s Signer) signature(value, key string) string { return b64Encode(saltedHMAC(s.Salt+"signer", key, value)) } -// keys puts the current secret first, the order Django tries them in while a -// key rotation is in flight. func (s Signer) keys() []string { return append([]string{s.Key}, s.Fallbacks...) } diff --git a/internal/shell/shell.go b/internal/shell/shell.go index 73961ba6..76116f97 100644 --- a/internal/shell/shell.go +++ b/internal/shell/shell.go @@ -24,7 +24,8 @@ const ( var files embed.FS // text/template rather than html/template because Go's escaper picks and spells -// different characters than Django's, and this output is compared byte for byte. +// different characters than these pages do, and the output is compared byte for +// byte. var tmpl = template.Must(template.New("shell").Funcs(template.FuncMap{ "esc": escape.HTML, "escjs": escape.JS, diff --git a/internal/shell/templates/page.html b/internal/shell/templates/page.html index 793537d7..75288ce1 100644 --- a/internal/shell/templates/page.html +++ b/internal/shell/templates/page.html @@ -1,4 +1,4 @@ -{{/* Django's two load tags print nothing and leave these two newlines behind. */}} +{{/* The two newlines below are part of the byte-compared output. */}} diff --git a/internal/site/host.go b/internal/site/host.go index 52c82b11..e2cbbd18 100644 --- a/internal/site/host.go +++ b/internal/site/host.go @@ -16,14 +16,12 @@ type Lookup interface { } // HostRules is the redirect between the two domains plus the header pair that -// follows from which one the request arrived on. The asset bundle must stay -// outside it: whitenoise answers those before Django applies any of this. +// follows from which one the request arrived on. The asset bundle stays outside +// it, since it is answered before any of this runs. type HostRules struct { sites Lookup serverPort string next http.Handler - // unresolved takes over when the Host matches no site; that response is - // still Django's to render. unresolved http.Handler } @@ -46,10 +44,9 @@ func (h *HostRules) ServeHTTP(w http.ResponseWriter, r *http.Request) { decision := Decide(Site{Domain: found.Domain, MediaDomain: found.MediaDomain}, r.Host, r.URL) if decision.Action == Redirect { - // Not http.Redirect: it writes an HTML body for GET, and Django sends - // none. + // Not http.Redirect, which writes an HTML body for GET where this + // response has none. w.Header().Set("Location", decision.Location) - // The type of the body Django would have sent, kept so the two agree. w.Header().Set("Content-Type", redirectContentType) // Written out because net/http leaves it off a HEAD it did not size. w.Header().Set("Content-Length", "0") @@ -57,8 +54,6 @@ func (h *HostRules) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } - // Django sets these after the handler runs, overwriting it. Setting them - // first lets the handler win; nothing writes these names today. for name, value := range decision.Headers { w.Header().Set(name, value) } diff --git a/internal/wikidot/username.go b/internal/wikidot/username.go index dbcab8ec..350b7581 100644 --- a/internal/wikidot/username.go +++ b/internal/wikidot/username.go @@ -7,12 +7,9 @@ import ( "golang.org/x/text/unicode/norm" ) -// CanonicalizeUsername mirrors canonicalize_username in web/models/users.py. -// Unlike Normalize it keeps non-Latin letters, so a Chinese name canonicalizes -// to itself rather than to an empty string. -// -// Python's [\W_]+ is every run that is neither a letter nor a number, because -// \W excludes the underscore that the class then adds back. +// Unlike Normalize this keeps non-Latin letters, so a Chinese name +// canonicalizes to itself rather than to an empty string. Every run that is +// neither a letter nor a number collapses, the underscore included. func CanonicalizeUsername(name string) string { var b strings.Builder pending := false diff --git a/internal/pyjson/testdata/oracle_pyjson.py b/internal/wikijson/testdata/oracle_wikijson.py similarity index 52% rename from internal/pyjson/testdata/oracle_pyjson.py rename to internal/wikijson/testdata/oracle_wikijson.py index 3b16292f..6d73260c 100644 --- a/internal/pyjson/testdata/oracle_pyjson.py +++ b/internal/wikijson/testdata/oracle_wikijson.py @@ -1,15 +1,15 @@ """Dump the same corpus with Python's own json.dumps. - PYJSON_CORPUS="$(cat internal/pyjson/testdata/pyjson_corpus.json)" \ - python internal/pyjson/testdata/oracle_pyjson.py > pyjson.python.golden + WIKIJSON_CORPUS="$(cat internal/wikijson/testdata/wikijson_corpus.json)" \ + python internal/wikijson/testdata/oracle_wikijson.py > wikijson.python.golden It needs no Django, so a host Python does. To check the version the server runs: - PYJSON_CORPUS="$(cat internal/pyjson/testdata/pyjson_corpus.json)" \ - docker compose exec -T -e PYJSON_CORPUS web python \ - < internal/pyjson/testdata/oracle_pyjson.py + WIKIJSON_CORPUS="$(cat internal/wikijson/testdata/wikijson_corpus.json)" \ + docker compose exec -T -e WIKIJSON_CORPUS web python \ + < internal/wikijson/testdata/oracle_wikijson.py -Then compare with internal/pyjson/testdata/pyjson.golden. Each corpus entry is a +Then compare with internal/wikijson/testdata/wikijson.golden. Each corpus entry is a JSON document; json.loads keeps the key order and tells an int from a float, which is what the comparison is about. """ @@ -19,7 +19,7 @@ import os import sys -corpus = os.environ.get('PYJSON_CORPUS') +corpus = os.environ.get('WIKIJSON_CORPUS') if not corpus: raise SystemExit(__doc__) diff --git a/internal/pyjson/testdata/pyjson.golden b/internal/wikijson/testdata/wikijson.golden similarity index 100% rename from internal/pyjson/testdata/pyjson.golden rename to internal/wikijson/testdata/wikijson.golden diff --git a/internal/pyjson/testdata/pyjson_corpus.json b/internal/wikijson/testdata/wikijson_corpus.json similarity index 100% rename from internal/pyjson/testdata/pyjson_corpus.json rename to internal/wikijson/testdata/wikijson_corpus.json diff --git a/internal/pyjson/pyjson.go b/internal/wikijson/wikijson.go similarity index 80% rename from internal/pyjson/pyjson.go rename to internal/wikijson/wikijson.go index fd3020cc..9bf6937b 100644 --- a/internal/pyjson/pyjson.go +++ b/internal/wikijson/wikijson.go @@ -1,5 +1,7 @@ -// Package pyjson spells values the way Python's json.dumps does. -package pyjson +// Package wikijson writes the JSON dialect the wiki's stored data and frontend +// both expect, which separates with a space and keeps the fraction of a whole +// number. +package wikijson import ( "fmt" @@ -8,8 +10,8 @@ import ( "strings" ) -// Field is one key of an object. Objects are slices rather than maps because -// Python writes a dict in insertion order and these are compared byte for byte. +// Objects are slices rather than maps because the output keeps insertion order +// and is compared byte for byte. type Field struct { Key string Value any @@ -19,8 +21,6 @@ type Object []Field type Array []any -// Marshal writes v with Python's separators, which carry a space that -// encoding/json never writes. func Marshal(v any) (string, error) { var b strings.Builder if err := write(&b, v); err != nil { @@ -62,7 +62,7 @@ func write(b *strings.Builder, v any) error { } return writeArray(b, items) default: - return fmt.Errorf("pyjson: cannot write %T", v) + return fmt.Errorf("wikijson: cannot write %T", v) } return nil } @@ -97,11 +97,11 @@ func writeArray(b *strings.Builder, a Array) error { return nil } -// Float writes what Python's repr gives. Go drops the fraction of a whole -// number and Python keeps it, so 4.0 must not come out as 4. +// Go drops the fraction of a whole number where this dialect keeps it, so 4.0 +// must not come out as 4. func Float(f float64) (string, error) { if math.IsInf(f, 0) || math.IsNaN(f) { - return "", fmt.Errorf("pyjson: cannot write %v", f) + return "", fmt.Errorf("wikijson: cannot write %v", f) } s := strconv.FormatFloat(f, 'g', -1, 64) if !strings.ContainsAny(s, ".e") { diff --git a/internal/pyjson/pyjson_test.go b/internal/wikijson/wikijson_test.go similarity index 97% rename from internal/pyjson/pyjson_test.go rename to internal/wikijson/wikijson_test.go index f7185603..20fbecb9 100644 --- a/internal/pyjson/pyjson_test.go +++ b/internal/wikijson/wikijson_test.go @@ -1,4 +1,4 @@ -package pyjson +package wikijson import ( "encoding/json" @@ -14,8 +14,8 @@ import ( var update = flag.Bool("update", false, "rewrite the golden file and the corpus the oracle reads") const ( - goldenPath = "testdata/pyjson.golden" - corpusPath = "testdata/pyjson_corpus.json" + goldenPath = "testdata/wikijson.golden" + corpusPath = "testdata/wikijson_corpus.json" ) func escaped(r rune) string { return fmt.Sprintf(`\u%04x`, r) } diff --git a/internal/pynum/pynum.go b/internal/wikinum/wikinum.go similarity index 71% rename from internal/pynum/pynum.go rename to internal/wikinum/wikinum.go index 180fc9bd..5b3c6d4a 100644 --- a/internal/pynum/pynum.go +++ b/internal/wikinum/wikinum.go @@ -1,6 +1,6 @@ -// Package pynum is Python's int() and float() over the strings a wikitext -// author typed. -package pynum +// Package wikinum parses the numbers a wikitext author typed, which tolerate +// surrounding space, a sign and underscores between digits. +package wikinum import ( "errors" @@ -8,10 +8,8 @@ import ( "strings" ) -var ErrNotANumber = errors.New("pynum: not a number") +var ErrNotANumber = errors.New("wikinum: not a number") -// Python's int() tolerates surrounding space, a sign and underscores between -// digits. Non-ASCII digits are the one thing it takes that this does not. func Int(s string) (int, error) { s = strings.TrimSpace(s) body := strings.TrimPrefix(strings.TrimPrefix(s, "+"), "-") @@ -33,7 +31,7 @@ func Int(s string) (int, error) { return n, nil } -// Go would take a hexadecimal float that Python rejects, so the digits are +// Go would take a hexadecimal float that this must not, so the digits are // checked first. func Float(s string) (float64, error) { if n, err := Int(s); err == nil { diff --git a/internal/pynum/pynum_test.go b/internal/wikinum/wikinum_test.go similarity index 98% rename from internal/pynum/pynum_test.go rename to internal/wikinum/wikinum_test.go index 2c8143e5..bb6068ec 100644 --- a/internal/pynum/pynum_test.go +++ b/internal/wikinum/wikinum_test.go @@ -1,4 +1,4 @@ -package pynum +package wikinum import "testing" From 8d33246be77fcbf45f2c0b568aabb2bfc9eca70d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 15:43:48 +0900 Subject: [PATCH 118/428] answer the new page form --- internal/i18n/locales/zh-hans.json | 1 + internal/module/render_test.go | 2 +- internal/modules/newpage.go | 32 +++++++ internal/modules/newpage_test.go | 85 +++++++++++++++++++ internal/modules/testdata/newpage.golden | 84 ++++++++++++++++++ internal/modules/testdata/newpage_corpus.json | 73 ++++++++++++++++ internal/modules/testdata/oracle_newpage.py | 44 ++++++++++ static/app.css | 20 ----- 8 files changed, 320 insertions(+), 21 deletions(-) create mode 100644 internal/modules/newpage.go create mode 100644 internal/modules/newpage_test.go create mode 100644 internal/modules/testdata/newpage.golden create mode 100644 internal/modules/testdata/newpage_corpus.json create mode 100644 internal/modules/testdata/oracle_newpage.py diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index ab8a895a..c880b279 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -49,6 +49,7 @@ "module-listpages-pager-count": "第 {page} 页; 共 {total} 页", "module-listpages-pager-next": "下一页 »", "module-listpages-pager-prev": "« 上一页", + "module-newpage-submit": "创建页面", "module-pagesbytag-category": " 来自分类 {category}", "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", "module-rate-cancel": "取消", diff --git a/internal/module/render_test.go b/internal/module/render_test.go index f43f9596..9f1ed3d2 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges"} + ported := []string{"css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/newpage.go b/internal/modules/newpage.go new file mode 100644 index 00000000..f6af024a --- /dev/null +++ b/internal/modules/newpage.go @@ -0,0 +1,32 @@ +package modules + +import ( + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +func init() { module.Register("newpage", renderNewPage) } + +func renderNewPage(env module.Env, params map[string]string, _ string) (string, error) { + // An empty submit= is the caller asking for a blank button, so a missing + // key and a present one are not the same thing here. + submit, ok := params["submit"] + if !ok { + submit = env.Text("module-newpage-submit") + } + config, err := wikijson.Marshal(wikijson.Object{{Key: "category", Value: params["category"]}}) + if err != nil { + return "", err + } + + // new-page-box appears nowhere else in the tree because the base stylesheet + // reserves it for exactly this form. + return `
+
+ + +
+
`, nil +} diff --git a/internal/modules/newpage_test.go b/internal/modules/newpage_test.go new file mode 100644 index 00000000..d03eca3c --- /dev/null +++ b/internal/modules/newpage_test.go @@ -0,0 +1,85 @@ +package modules + +import ( + "encoding/json" + "fmt" + "os" + "path/filepath" + "strings" + "testing" +) + +const ( + newPageGolden = "testdata/newpage.golden" + newPageCorpus = "testdata/newpage_corpus.json" +) + +type newPageCase struct { + Name string `json:"name"` + Params map[string]string `json:"params,omitempty"` +} + +func newPageCases() []newPageCase { + return []newPageCase{ + {Name: "bare"}, + {Name: "example", Params: map[string]string{"example": "scp-1000"}}, + {Name: "example-empty", Params: map[string]string{"example": ""}}, + {Name: "category", Params: map[string]string{"category": "scp"}}, + {Name: "category-empty", Params: map[string]string{"category": ""}}, + {Name: "submit", Params: map[string]string{"submit": "开始写"}}, + {Name: "submit-empty", Params: map[string]string{"submit": ""}}, + {Name: "all", Params: map[string]string{"example": "scp-1000", "category": "scp", "submit": "开始写"}}, + {Name: "quoted-example", Params: map[string]string{"example": `a"b'c`) { + t.Errorf("renderNewPage(submit=\"\") = %q, want an empty submit value", got) + } +} diff --git a/internal/modules/testdata/newpage.golden b/internal/modules/testdata/newpage.golden new file mode 100644 index 00000000..e4aed453 --- /dev/null +++ b/internal/modules/testdata/newpage.golden @@ -0,0 +1,84 @@ +=== bare +
+
+ + +
+
+=== example +
+
+ + +
+
+=== example-empty +
+
+ + +
+
+=== category +
+
+ + +
+
+=== category-empty +
+
+ + +
+
+=== submit +
+
+ + +
+
+=== submit-empty +
+
+ + +
+
+=== all +
+
+ + +
+
+=== quoted-example +
+
+ + +
+
+=== quoted-category +
+
+ + +
+
+=== quoted-submit +
+
+ + +
+
+=== unknown-param +
+
+ + +
+
diff --git a/internal/modules/testdata/newpage_corpus.json b/internal/modules/testdata/newpage_corpus.json new file mode 100644 index 00000000..c1043935 --- /dev/null +++ b/internal/modules/testdata/newpage_corpus.json @@ -0,0 +1,73 @@ +[ + { + "name": "bare" + }, + { + "name": "example", + "params": { + "example": "scp-1000" + } + }, + { + "name": "example-empty", + "params": { + "example": "" + } + }, + { + "name": "category", + "params": { + "category": "scp" + } + }, + { + "name": "category-empty", + "params": { + "category": "" + } + }, + { + "name": "submit", + "params": { + "submit": "开始写" + } + }, + { + "name": "submit-empty", + "params": { + "submit": "" + } + }, + { + "name": "all", + "params": { + "category": "scp", + "example": "scp-1000", + "submit": "开始写" + } + }, + { + "name": "quoted-example", + "params": { + "example": "a\"b'c\u003cd\u0026e" + } + }, + { + "name": "quoted-category", + "params": { + "category": "a\"b'c\u003cd\u0026e" + } + }, + { + "name": "quoted-submit", + "params": { + "submit": "a\"b'c\u003cd\u0026e" + } + }, + { + "name": "unknown-param", + "params": { + "unknown": "x" + } + } +] diff --git a/internal/modules/testdata/oracle_newpage.py b/internal/modules/testdata/oracle_newpage.py new file mode 100644 index 00000000..ea06a1eb --- /dev/null +++ b/internal/modules/testdata/oracle_newpage.py @@ -0,0 +1,44 @@ +"""Records what the NewPage module returns for each set of parameters. + +Run with the corpus the Go test exports under -update: + + docker compose exec -T -e NEWPAGE_CORPUS="$(cat internal/modules/testdata/newpage_corpus.json)" \ + web python manage.py shell < internal/modules/testdata/oracle_newpage.py + +Two things here are deliberately not what Go emits -- the wrapper markup, and +the placeholder, which Go fills with the bare example= and leaves empty when +there is none. What has to keep matching is data-config and the submit value, +against internal/modules/testdata/newpage.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules.newpage +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.site import Site + +CORPUS = json.loads(os.environ['NEWPAGE_CORPUS']) + + +def main(): + article = articles.get_article('main') + if article is None: + raise SystemExit('main is missing; run manage.py seed first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + threadvars.put('current_user', AnonymousUser()) + context = RenderContext(article, None, {}, AnonymousUser()) + body = modules.newpage.render(context, case.get('params') or {}) + out.append('=== %s\n%s\n' % (case['name'], str(body))) + sys.stdout.write(''.join(out)) + + +main() diff --git a/static/app.css b/static/app.css index 1b0df933..ecdd0c6d 100644 --- a/static/app.css +++ b/static/app.css @@ -206,26 +206,6 @@ border-radius: 3px; } -.new-page-form { - border: 1px solid #ccc; - background: #eee; - padding: 8px; - text-align: center; -} - -.new-page-form form { - display: flex; - flex-direction: column; -} - -.new-page-form p { - margin: 4px 0; -} - -.new-page-form p div { - margin: 4px 0; -} - .w-search { --s-bg: var(--wk-surface, #ffffff); --s-alt: var(--wk-surface-alt, #f6f8fc); From 6d691329312c27172503850797254330c30546dc Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 15:44:04 +0900 Subject: [PATCH 119/428] count the pages a filter leaves --- internal/module/render_test.go | 2 +- internal/modules/countpages.go | 44 ++++++ internal/repo/countpages_test.go | 135 ++++++++++++++++++ internal/repo/testdata/countpages.golden | 36 +++++ internal/repo/testdata/countpages_corpus.json | 127 ++++++++++++++++ internal/repo/testdata/oracle_countpages.py | 45 ++++++ 6 files changed, 388 insertions(+), 1 deletion(-) create mode 100644 internal/modules/countpages.go create mode 100644 internal/repo/countpages_test.go create mode 100644 internal/repo/testdata/countpages.golden create mode 100644 internal/repo/testdata/countpages_corpus.json create mode 100644 internal/repo/testdata/oracle_countpages.py diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 9f1ed3d2..17d7006a 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges"} + ported := []string{"countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/countpages.go b/internal/modules/countpages.go new file mode 100644 index 00000000..a288e1c6 --- /dev/null +++ b/internal/modules/countpages.go @@ -0,0 +1,44 @@ +package modules + +import ( + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +func init() { module.Register("countpages", renderCountPages) } + +func renderCountPages(env module.Env, params map[string]string, body string) (string, error) { + if env.Render == nil || env.Data == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", "countpages")} + } + pc := env.Page + if pc == nil { + pc = page.NewContext(nil, nil, nil, env.User) + } + + params, _ = listpages.URLParams(params, pc.PathParams) + query, err := listpages.Parse(env.Data, pc.Article, env.User, params, pc.PathParams) + if err != nil { + return "", err + } + // The count is the rows the filter leaves, so the query runs unpaginated + // and the reader's per-page never reaches it. + result, err := listpages.Run(env.Data, query, env.User, false) + if err != nil { + return "", err + } + + total := strconv.Itoa(len(result.Pages)) + source := page.ApplyTemplate(strings.TrimSpace(body), func(name string) (string, bool) { + switch strings.ToLower(name) { + case "total", "count": + return total, true + } + return "", false + }) + return env.Render(source, pc) +} diff --git a/internal/repo/countpages_test.go b/internal/repo/countpages_test.go new file mode 100644 index 00000000..a6e23ecd --- /dev/null +++ b/internal/repo/countpages_test.go @@ -0,0 +1,135 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "os" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/printuser" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/renderer/sidecar" +) + +const ( + countPagesGolden = "testdata/countpages.golden" + countPagesCorpus = "testdata/countpages_corpus.json" +) + +type countPagesCase struct { + Name string `json:"name"` + Body string `json:"body"` + Params map[string]string `json:"params,omitempty"` + Path map[string]string `json:"path,omitempty"` + Article string `json:"article,omitempty"` +} + +func countPagesCases() []countPagesCase { + return []countPagesCase{ + {Name: "category", Body: "%%total%%", Params: map[string]string{"category": "probe"}}, + {Name: "count-alias", Body: "%%count%%", Params: map[string]string{"category": "probe"}}, + {Name: "uppercase-name", Body: "%%TOTAL%%", Params: map[string]string{"category": "probe"}}, + {Name: "unknown-name", Body: "%%nope%%", Params: map[string]string{"category": "probe"}}, + {Name: "wikitext-around-it", Body: "**%%total%%** pages", Params: map[string]string{"category": "probe"}}, + {Name: "every-category", Body: "%%total%%", Params: map[string]string{"category": "*"}}, + {Name: "no-parameters", Body: "%%total%%"}, + {Name: "per-page-does-not-cut-it", Body: "%%total%%", Params: map[string]string{"category": "probe", "perPage": "2"}}, + {Name: "limit", Body: "%%total%%", Params: map[string]string{"category": "probe", "limit": "3"}}, + {Name: "offset", Body: "%%total%%", Params: map[string]string{"category": "probe", "offset": "2"}}, + {Name: "tags", Body: "%%total%%", Params: map[string]string{"category": "*", "tags": "lang:en"}}, + {Name: "full-name", Body: "%%total%%", Params: map[string]string{"fullname": "probe:full"}}, + {Name: "full-name-missing", Body: "%%total%%", Params: map[string]string{"fullname": "probe:no-such-page"}}, + {Name: "unparsable-parameter", Body: "%%total%%", Params: map[string]string{"category": "probe", "rating": "junk"}}, + {Name: "url-parameter-default", Body: "%%total%%", Params: map[string]string{"category": "@url|probe"}}, + {Name: "url-parameter-from-path", Body: "%%total%%", Params: map[string]string{"category": "@url|probe"}, + Path: map[string]string{"category": "probestars"}}, + {Name: "empty-body"}, + {Name: "body-without-a-variable", Body: "no variable here"}, + } +} + +func TestCountPagesMatchesGolden(t *testing.T) { + bin := os.Getenv(sidecar.EnvBinary) + if bin == "" { + t.Skipf("%s not set, skipping the count test", sidecar.EnvBinary) + } + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := countPagesCases() + + rend, err := sidecar.New(bin) + if err != nil { + t.Fatalf("sidecar.New(%q) err = %v, want nil", bin, err) + } + t.Cleanup(func() { rend.Close() }) + + site, err := d.SiteByHosts(ctx, []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + name := c.Article + if name == "" { + name = "main" + } + article, err := d.ArticleByName(ctx, name) + if err != nil { + t.Fatalf("ArticleByName(%q) err = %v, want nil", name, err) + } + pc := page.NewContext(article, article, sortedPath(c.Path), nil) + r := newRenderRepo(ctx, d, users, loc, site, nil, rend) + + body, err := r.RenderModule(pc, "CountPages", copyParams(c.Params), c.Body) + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\n%s\n", c.Name, body) + } + compareGolden(t, b.String(), cases, countPagesGolden, countPagesCorpus) +} + +func newRenderRepo(ctx context.Context, d *db.DB, users *printuser.Renderer, loc *i18n.Localizer, + site *db.Site, viewer *db.User, rend renderer.Renderer) *Repository { + + var r *Repository + source := NewVarSource(ctx, d, site.ID) + render := func(text string, pc *page.Context) (string, error) { + cb := callbacks.New(loc, r) + cb.SetContext(pc) + info := renderer.PageInfo{Site: site.Slug, Domain: site.Domain, MediaDomain: site.MediaDomain} + if pc.Article != nil { + info.Page = pc.Article.Name + info.Category = pc.Article.Category + info.Title = pc.Article.Title + } + vars := page.NewVars(pc.Article, viewer, source, loc) + html, err := rend.RenderHTML(ctx, page.ThisVars(text, vars), info, cb, renderer.ModeArticle) + if err != nil { + return "", err + } + return html.Body, nil + } + r = New(ctx, d, users, Options{Loc: loc, Site: site, User: viewer, Render: render, Vars: source}) + return r +} + +func copyParams(params map[string]string) map[string]string { + out := make(map[string]string, len(params)) + for key, value := range params { + out[key] = value + } + return out +} diff --git a/internal/repo/testdata/countpages.golden b/internal/repo/testdata/countpages.golden new file mode 100644 index 00000000..08bb2232 --- /dev/null +++ b/internal/repo/testdata/countpages.golden @@ -0,0 +1,36 @@ +=== category +

22

+=== count-alias +

22

+=== uppercase-name +

22

+=== unknown-name +

%%nope%%

+=== wikitext-around-it +

22 pages

+=== every-category +

45

+=== no-parameters +

5

+=== per-page-does-not-cut-it +

22

+=== limit +

3

+=== offset +

20

+=== tags +

1

+=== full-name +

1

+=== full-name-missing +

0

+=== unparsable-parameter +

0

+=== url-parameter-default +

22

+=== url-parameter-from-path +

4

+=== empty-body + +=== body-without-a-variable +

no variable here

diff --git a/internal/repo/testdata/countpages_corpus.json b/internal/repo/testdata/countpages_corpus.json new file mode 100644 index 00000000..8cbd89f9 --- /dev/null +++ b/internal/repo/testdata/countpages_corpus.json @@ -0,0 +1,127 @@ +[ + { + "name": "category", + "body": "%%total%%", + "params": { + "category": "probe" + } + }, + { + "name": "count-alias", + "body": "%%count%%", + "params": { + "category": "probe" + } + }, + { + "name": "uppercase-name", + "body": "%%TOTAL%%", + "params": { + "category": "probe" + } + }, + { + "name": "unknown-name", + "body": "%%nope%%", + "params": { + "category": "probe" + } + }, + { + "name": "wikitext-around-it", + "body": "**%%total%%** pages", + "params": { + "category": "probe" + } + }, + { + "name": "every-category", + "body": "%%total%%", + "params": { + "category": "*" + } + }, + { + "name": "no-parameters", + "body": "%%total%%" + }, + { + "name": "per-page-does-not-cut-it", + "body": "%%total%%", + "params": { + "category": "probe", + "perPage": "2" + } + }, + { + "name": "limit", + "body": "%%total%%", + "params": { + "category": "probe", + "limit": "3" + } + }, + { + "name": "offset", + "body": "%%total%%", + "params": { + "category": "probe", + "offset": "2" + } + }, + { + "name": "tags", + "body": "%%total%%", + "params": { + "category": "*", + "tags": "lang:en" + } + }, + { + "name": "full-name", + "body": "%%total%%", + "params": { + "fullname": "probe:full" + } + }, + { + "name": "full-name-missing", + "body": "%%total%%", + "params": { + "fullname": "probe:no-such-page" + } + }, + { + "name": "unparsable-parameter", + "body": "%%total%%", + "params": { + "category": "probe", + "rating": "junk" + } + }, + { + "name": "url-parameter-default", + "body": "%%total%%", + "params": { + "category": "@url|probe" + } + }, + { + "name": "url-parameter-from-path", + "body": "%%total%%", + "params": { + "category": "@url|probe" + }, + "path": { + "category": "probestars" + } + }, + { + "name": "empty-body", + "body": "" + }, + { + "name": "body-without-a-variable", + "body": "no variable here" + } +] diff --git a/internal/repo/testdata/oracle_countpages.py b/internal/repo/testdata/oracle_countpages.py new file mode 100644 index 00000000..d49c2708 --- /dev/null +++ b/internal/repo/testdata/oracle_countpages.py @@ -0,0 +1,45 @@ +"""Records what the CountPages module renders for each set of parameters. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e COUNTPAGES_CORPUS="$(cat internal/repo/testdata/countpages_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_countpages.py + +Compare the output with internal/repo/testdata/countpages.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.site import Site + +CORPUS = json.loads(os.environ['COUNTPAGES_CORPUS']) + + +def main(): + out = [] + for case in CORPUS: + article = articles.get_article(case.get('article') or 'main') + if article is None: + raise SystemExit('%s is missing; run oracle_seed.py first' % (case.get('article') or 'main')) + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + threadvars.put('current_user', viewer) + context = RenderContext(article, article, dict(case.get('path') or {}), viewer) + try: + body = modules.render_module('CountPages', context, dict(case.get('params') or {}), case.get('body') or '') + except ModuleError as error: + body = '!error: %s' % error.message + out.append('=== %s\n%s\n' % (case['name'], body)) + sys.stdout.write(''.join(out)) + + +main() From 478e9293dde8547bde32ac2eb61aec0ec687bfaa Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 15:44:18 +0900 Subject: [PATCH 120/428] answer the user list --- internal/i18n/locales/zh-hans.json | 1 + internal/module/module.go | 2 + internal/module/render_test.go | 2 +- internal/modules/listusers.go | 137 +++++++++++++++++++ internal/modules/listusers_test.go | 85 ++++++++++++ internal/repo/listusers_test.go | 108 +++++++++++++++ internal/repo/modules.go | 8 ++ internal/repo/testdata/listusers.golden | 72 ++++++++++ internal/repo/testdata/listusers_corpus.json | 133 ++++++++++++++++++ internal/repo/testdata/oracle_listusers.py | 52 +++++++ 10 files changed, 599 insertions(+), 1 deletion(-) create mode 100644 internal/modules/listusers.go create mode 100644 internal/modules/listusers_test.go create mode 100644 internal/repo/listusers_test.go create mode 100644 internal/repo/testdata/listusers.golden create mode 100644 internal/repo/testdata/listusers_corpus.json create mode 100644 internal/repo/testdata/oracle_listusers.py diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index c880b279..1f5624ff 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -49,6 +49,7 @@ "module-listpages-pager-count": "第 {page} 页; 共 {total} 页", "module-listpages-pager-next": "下一页 »", "module-listpages-pager-prev": "« 上一页", + "module-listusers-anonymous": "@@[匿名]@@", "module-newpage-submit": "创建页面", "module-pagesbytag-category": " 来自分类 {category}", "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", diff --git a/internal/module/module.go b/internal/module/module.go index c6fae4af..16937351 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -35,7 +35,9 @@ type Data interface { CountArticles(f db.ListFilter, offset int, limit *int) (int, error) ArticleByID(id int64) (*db.Article, error) + ArticleAuthors(articleID int64) ([]db.User, error) RenderUserByID(id *int64) (string, error) + RenderUser(u db.User) (string, error) SiteChanges(f db.SiteChangeFilter, offset, limit int) ([]db.SiteChange, error) SiteChangeCount(f db.SiteChangeFilter) (int, error) diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 17d7006a..40d94ba0 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges"} + ported := []string{"countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/listusers.go b/internal/modules/listusers.go new file mode 100644 index 00000000..6d078d94 --- /dev/null +++ b/internal/modules/listusers.go @@ -0,0 +1,137 @@ +package modules + +import ( + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/printuser" +) + +func init() { module.Register("listusers", renderListUsers) } + +func renderListUsers(env module.Env, params map[string]string, body string) (string, error) { + if env.Render == nil || env.Data == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", "listusers")} + } + pc := env.Page + if pc == nil { + pc = page.NewContext(nil, nil, nil, env.User) + } + + body = strings.TrimSpace(body) + var filled []string + chips := map[string]string{} + if module.BoolParam(params, "authors", false) { + var err error + if filled, err = authorTemplates(env, pc, body, chips); err != nil { + return "", err + } + } else { + if env.User == nil && !module.BoolParam(params, "always", false) { + return "", nil + } + filled = append(filled, page.ApplyTemplate(body, viewerVars(env, params))) + } + + html, err := env.Render(strings.Join(filled, " "), pc) + if err != nil { + return "", err + } + return putChipsBack(html, chips), nil +} + +// A user chip is markup, and wikitext escapes markup, so the body goes through +// the renderer carrying a plain token where each chip belongs. +func putChipsBack(html string, chips map[string]string) string { + if len(chips) == 0 { + return html + } + pairs := make([]string, 0, 2*len(chips)) + for token, chip := range chips { + pairs = append(pairs, token, chip) + } + return strings.NewReplacer(pairs...).Replace(html) +} + +// The index sits inside the token rather than at its end, so one token is never +// the beginning of another once there are ten authors. +func chipToken(i int) string { return "pwikitauthor" + strconv.Itoa(i) + "chip" } + +func authorTemplates(env module.Env, pc *page.Context, body string, chips map[string]string) ([]string, error) { + if pc.Article == nil { + return nil, nil + } + authors, err := env.Data.ArticleAuthors(pc.Article.ID) + if err != nil { + return nil, err + } + + out := make([]string, 0, len(authors)) + for i := range authors { + author := authors[i] + // The chip is only rendered when the body asks for it, since building + // one costs a roles lookup per author. + var chipErr error + out = append(out, page.ApplyTemplate(body, func(name string) (string, bool) { + switch strings.ToLower(name) { + case "author": + return author.DisplayLabel(), true + case "author_linked": + token := chipToken(i) + if _, done := chips[token]; !done { + chip, err := env.Data.RenderUser(author) + if err != nil { + chipErr = err + return "", true + } + chips[token] = chip + } + return token, true + } + return "", false + })) + if chipErr != nil { + return nil, chipErr + } + } + return out, nil +} + +func viewerVars(env module.Env, params map[string]string) func(name string) (string, bool) { + user := env.User + number := "-1" + name := params["anonname"] + if _, ok := params["anonname"]; !ok { + name = env.Text("module-listusers-anonymous") + } + title := name + avatar := printuser.DefaultAvatar + if user != nil { + number = strconv.FormatInt(user.ID, 10) + name = user.Username + // The display name rather than the account name, which is what every + // other place a reader sees a person shows. + title = firstNonBlank(user.DisplayName, user.Username) + if user.Avatar != "" { + avatar = "/local--files/" + user.Avatar + } + } + + return func(key string) (string, bool) { + switch strings.ToLower(key) { + case "number": + return number, true + case "title": + return title, true + case "name": + return name, true + case "avatar": + return avatar, true + case "is_authenticated": + return strconv.FormatBool(user != nil), true + } + return "", false + } +} diff --git a/internal/modules/listusers_test.go b/internal/modules/listusers_test.go new file mode 100644 index 00000000..447371f3 --- /dev/null +++ b/internal/modules/listusers_test.go @@ -0,0 +1,85 @@ +package modules + +import ( + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +type stubData struct{ module.Data } + +func listUsersEnv(t *testing.T, user *db.User) module.Env { + t.Helper() + env := forumEnv(t) + env.User = user + env.Data = stubData{} + env.Render = func(source string, _ *page.Context) (string, error) { return source, nil } + return env +} + +func TestListUsersAvatarOfAViewerWhoUploadedOne(t *testing.T) { + env := listUsersEnv(t, &db.User{ID: 7, Username: "probe", Avatar: "avatars/7.png"}) + + got, err := renderListUsers(env, nil, "%%avatar%%") + if err != nil { + t.Fatalf("renderListUsers() err = %v, want nil", err) + } + if want := "/local--files/avatars/7.png"; got != want { + t.Errorf("renderListUsers(%%%%avatar%%%%) = %q, want %q", got, want) + } +} + +func TestListUsersAvatarOfAViewerWithoutOne(t *testing.T) { + env := listUsersEnv(t, &db.User{ID: 7, Username: "probe"}) + + got, err := renderListUsers(env, nil, "%%avatar%%") + if err != nil { + t.Fatalf("renderListUsers() err = %v, want nil", err) + } + if want := "/-/static/images/default_avatar.png"; got != want { + t.Errorf("renderListUsers(%%%%avatar%%%%) = %q, want %q", got, want) + } +} + +func TestListUsersSkipsAnAnonymousReader(t *testing.T) { + env := listUsersEnv(t, nil) + + got, err := renderListUsers(env, nil, "%%name%%") + if err != nil { + t.Fatalf("renderListUsers() err = %v, want nil", err) + } + if got != "" { + t.Errorf("renderListUsers(%%%%name%%%%) = %q, want %q", got, "") + } +} + +func TestListUsersLeavesAnUnknownVariableAlone(t *testing.T) { + env := listUsersEnv(t, &db.User{ID: 7, Username: "probe"}) + + got, err := renderListUsers(env, nil, "%%nope%%") + if err != nil { + t.Fatalf("renderListUsers() err = %v, want nil", err) + } + if !strings.Contains(got, "%%nope%%") { + t.Errorf("renderListUsers(%%%%nope%%%%) = %q, want it kept", got) + } +} + +func TestListUsersChipTokensDoNotOverlap(t *testing.T) { + chips := map[string]string{chipToken(1): "one", chipToken(10): "ten"} + + got := putChipsBack(chipToken(1)+" "+chipToken(10), chips) + if want := "one ten"; got != want { + t.Errorf("putChipsBack() = %q, want %q", got, want) + } +} + +func TestListUsersLeavesTheBodyAloneWithoutChips(t *testing.T) { + got := putChipsBack("

nothing to put back

", nil) + if want := "

nothing to put back

"; got != want { + t.Errorf("putChipsBack() = %q, want %q", got, want) + } +} diff --git a/internal/repo/listusers_test.go b/internal/repo/listusers_test.go new file mode 100644 index 00000000..fc8a3fbe --- /dev/null +++ b/internal/repo/listusers_test.go @@ -0,0 +1,108 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "os" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/renderer/sidecar" +) + +const ( + listUsersGolden = "testdata/listusers.golden" + listUsersCorpus = "testdata/listusers_corpus.json" +) + +const listUsersBody = "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%" + +type listUsersCase struct { + Name string `json:"name"` + Viewer string `json:"viewer"` + Body string `json:"body"` + Params map[string]string `json:"params,omitempty"` + Article string `json:"article,omitempty"` +} + +func listUsersCases() []listUsersCase { + return []listUsersCase{ + {Name: "anonymous-without-always", Body: listUsersBody}, + {Name: "anonymous-always", Body: listUsersBody, Params: map[string]string{"always": "yes"}}, + {Name: "anonymous-named", Body: listUsersBody, Params: map[string]string{"always": "yes", "anonname": "Guest"}}, + {Name: "anonymous-named-empty", Body: listUsersBody, Params: map[string]string{"always": "yes", "anonname": ""}}, + {Name: "viewer-with-display-name", Viewer: "probe-author", Body: listUsersBody}, + {Name: "viewer-without-display-name", Viewer: "probevoter", Body: listUsersBody}, + {Name: "viewer-from-wikidot", Viewer: "576c0df3-8a28-4468-9770-ede851d88c67", Body: listUsersBody}, + {Name: "viewer-with-always-off", Viewer: "probe-author", Body: listUsersBody, Params: map[string]string{"always": "no"}}, + {Name: "uppercase-name", Viewer: "probe-author", Body: "%%TITLE%%"}, + {Name: "unknown-name", Viewer: "probe-author", Body: "%%nope%%"}, + {Name: "empty-body", Viewer: "probe-author"}, + {Name: "authors", Body: "%%author%%", Params: map[string]string{"authors": "yes"}, Article: "probe:full"}, + {Name: "authors-linked", Body: "%%author_linked%%", Params: map[string]string{"authors": "yes"}, Article: "probe:full"}, + {Name: "authors-both", Body: "%%author%% is %%author_linked%%", Params: map[string]string{"authors": "yes"}, Article: "probe:full"}, + {Name: "authors-wikitext", Body: "**%%author%%**", Params: map[string]string{"authors": "yes"}, Article: "probe:full"}, + {Name: "authors-none", Body: "%%author%%", Params: map[string]string{"authors": "yes"}, Article: "probe:bare"}, + {Name: "authors-while-signed-in", Viewer: "probevoter", Body: "%%author%%", + Params: map[string]string{"authors": "yes"}, Article: "probe:full"}, + {Name: "authors-off", Viewer: "probe-author", Body: listUsersBody, Params: map[string]string{"authors": "no"}}, + } +} + +func TestListUsersMatchesGolden(t *testing.T) { + bin := os.Getenv(sidecar.EnvBinary) + if bin == "" { + t.Skipf("%s not set, skipping the user list test", sidecar.EnvBinary) + } + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := listUsersCases() + + rend, err := sidecar.New(bin) + if err != nil { + t.Fatalf("sidecar.New(%q) err = %v, want nil", bin, err) + } + t.Cleanup(func() { rend.Close() }) + + site, err := d.SiteByHosts(ctx, []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + name := c.Article + if name == "" { + name = "main" + } + article, err := d.ArticleByName(ctx, name) + if err != nil { + t.Fatalf("ArticleByName(%q) err = %v, want nil", name, err) + } + var viewer *db.User + if c.Viewer != "" { + if viewer, err = d.UserByUsername(ctx, c.Viewer); err != nil { + t.Fatalf("UserByUsername(%q) err = %v, want nil", c.Viewer, err) + } + } + + pc := page.NewContext(article, article, nil, viewer) + r := newRenderRepo(ctx, d, users, loc, site, viewer, rend) + + body, err := r.RenderModule(pc, "ListUsers", copyParams(c.Params), c.Body) + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\n%s\n", c.Name, body) + } + compareGolden(t, b.String(), cases, listUsersGolden, listUsersCorpus) +} diff --git a/internal/repo/modules.go b/internal/repo/modules.go index b73b0791..cbe028fd 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -96,6 +96,14 @@ func (m moduleData) ArticleByID(id int64) (*db.Article, error) { return m.repo.db.ArticleByID(m.repo.ctx, id) } +func (m moduleData) ArticleAuthors(articleID int64) ([]db.User, error) { + return m.repo.db.ArticleAuthors(m.repo.ctx, articleID) +} + +func (m moduleData) RenderUser(u db.User) (string, error) { + return m.repo.renderUser(&u, printuser.Options{Avatar: true, Hover: true}) +} + // A post with no author is one the site itself made, which is what the system // chip stands for. func (m moduleData) RenderUserByID(id *int64) (string, error) { diff --git a/internal/repo/testdata/listusers.golden b/internal/repo/testdata/listusers.golden new file mode 100644 index 00000000..0508a3bf --- /dev/null +++ b/internal/repo/testdata/listusers.golden @@ -0,0 +1,72 @@ +=== anonymous-without-always + +=== anonymous-always +

-1 [匿名] [匿名] /-/static/images/default_avatar.png false

+=== anonymous-named +

-1 Guest Guest /-/static/images/default_avatar.png false

+=== anonymous-named-empty +

-1 /-/static/images/default_avatar.png false

+=== viewer-with-display-name +

30 Probe Author probe-author /-/static/images/default_avatar.png true

+=== viewer-without-display-name +

32 probevoter probevoter /-/static/images/default_avatar.png true

+=== viewer-from-wikidot +

31 Probe WD 576c0df3-8a28-4468-9770-ede851d88c67 /-/static/images/default_avatar.png true

+=== viewer-with-always-off +

30 Probe Author probe-author /-/static/images/default_avatar.png true

+=== uppercase-name +

Probe Author

+=== unknown-name +

%%nope%%

+=== empty-body + +=== authors +

Probe Author wd:Probe WD

+=== authors-linked +

+ + Probe Author + + Probe Author + + + + + + + wd:Probe WD + + wd:Probe WD + + + + +

+=== authors-both +

Probe Author is + + Probe Author + + Probe Author + + + + + wd:Probe WD is + + wd:Probe WD + + wd:Probe WD + + + + +

+=== authors-wikitext +

Probe Author wd:Probe WD

+=== authors-none + +=== authors-while-signed-in +

Probe Author wd:Probe WD

+=== authors-off +

30 Probe Author probe-author /-/static/images/default_avatar.png true

diff --git a/internal/repo/testdata/listusers_corpus.json b/internal/repo/testdata/listusers_corpus.json new file mode 100644 index 00000000..6a1686fa --- /dev/null +++ b/internal/repo/testdata/listusers_corpus.json @@ -0,0 +1,133 @@ +[ + { + "name": "anonymous-without-always", + "viewer": "", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%" + }, + { + "name": "anonymous-always", + "viewer": "", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%", + "params": { + "always": "yes" + } + }, + { + "name": "anonymous-named", + "viewer": "", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%", + "params": { + "always": "yes", + "anonname": "Guest" + } + }, + { + "name": "anonymous-named-empty", + "viewer": "", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%", + "params": { + "always": "yes", + "anonname": "" + } + }, + { + "name": "viewer-with-display-name", + "viewer": "probe-author", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%" + }, + { + "name": "viewer-without-display-name", + "viewer": "probevoter", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%" + }, + { + "name": "viewer-from-wikidot", + "viewer": "576c0df3-8a28-4468-9770-ede851d88c67", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%" + }, + { + "name": "viewer-with-always-off", + "viewer": "probe-author", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%", + "params": { + "always": "no" + } + }, + { + "name": "uppercase-name", + "viewer": "probe-author", + "body": "%%TITLE%%" + }, + { + "name": "unknown-name", + "viewer": "probe-author", + "body": "%%nope%%" + }, + { + "name": "empty-body", + "viewer": "probe-author", + "body": "" + }, + { + "name": "authors", + "viewer": "", + "body": "%%author%%", + "params": { + "authors": "yes" + }, + "article": "probe:full" + }, + { + "name": "authors-linked", + "viewer": "", + "body": "%%author_linked%%", + "params": { + "authors": "yes" + }, + "article": "probe:full" + }, + { + "name": "authors-both", + "viewer": "", + "body": "%%author%% is %%author_linked%%", + "params": { + "authors": "yes" + }, + "article": "probe:full" + }, + { + "name": "authors-wikitext", + "viewer": "", + "body": "**%%author%%**", + "params": { + "authors": "yes" + }, + "article": "probe:full" + }, + { + "name": "authors-none", + "viewer": "", + "body": "%%author%%", + "params": { + "authors": "yes" + }, + "article": "probe:bare" + }, + { + "name": "authors-while-signed-in", + "viewer": "probevoter", + "body": "%%author%%", + "params": { + "authors": "yes" + }, + "article": "probe:full" + }, + { + "name": "authors-off", + "viewer": "probe-author", + "body": "%%number%% %%title%% %%name%% %%avatar%% %%is_authenticated%%", + "params": { + "authors": "no" + } + } +] diff --git a/internal/repo/testdata/oracle_listusers.py b/internal/repo/testdata/oracle_listusers.py new file mode 100644 index 00000000..7e533e56 --- /dev/null +++ b/internal/repo/testdata/oracle_listusers.py @@ -0,0 +1,52 @@ +"""Records what the ListUsers module renders for a reader and for page authors. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e LISTUSERS_CORPUS="$(cat internal/repo/testdata/listusers_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_listusers.py + +Two variables deliberately differ from what Go answers. %%title%% is the display +name there and the account name here, and %%author_linked%% is a working user +chip there where the renderer escapes it into text here. Every other case has to +match internal/repo/testdata/listusers.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.site import Site +from web.models.users import ExtendedAnonymousUser, User + +CORPUS = json.loads(os.environ['LISTUSERS_CORPUS']) + + +def main(): + out = [] + for case in CORPUS: + name = case.get('article') or 'main' + article = articles.get_article(name) + if article is None: + raise SystemExit('%s is missing; run oracle_seed.py first' % name) + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = ExtendedAnonymousUser() + if case['viewer']: + viewer = User.objects.get(username=case['viewer']) + threadvars.put('current_user', viewer) + context = RenderContext(article, article, {}, viewer) + try: + body = modules.render_module('ListUsers', context, dict(case.get('params') or {}), case.get('body') or '') + except ModuleError as error: + body = '!error: %s' % error.message + out.append('=== %s\n%s\n' % (case['name'], body)) + sys.stdout.write(''.join(out)) + + +main() From a70028b19830e6c40671239cbf190e053cb8dbef Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 16:41:52 +0900 Subject: [PATCH 121/428] answer the tag cloud --- internal/db/tag.go | 53 +++ internal/db/tag_test.go | 56 +++ internal/i18n/locales/zh-hans.json | 3 + internal/module/module.go | 1 + internal/module/render_test.go | 8 +- internal/modules/tagcloud.go | 291 +++++++++++++++ internal/page/testdata/oracle_seed.py | 48 ++- internal/page/testdata/vars.golden | 4 +- internal/repo/modules.go | 4 + internal/repo/tagcloud_test.go | 89 +++++ internal/repo/testdata/oracle_tagcloud.py | 48 +++ internal/repo/testdata/tagcloud.golden | 393 ++++++++++++++++++++ internal/repo/testdata/tagcloud_corpus.json | 197 ++++++++++ 13 files changed, 1188 insertions(+), 7 deletions(-) create mode 100644 internal/db/tag_test.go create mode 100644 internal/modules/tagcloud.go create mode 100644 internal/repo/tagcloud_test.go create mode 100644 internal/repo/testdata/oracle_tagcloud.py create mode 100644 internal/repo/testdata/tagcloud.golden create mode 100644 internal/repo/testdata/tagcloud_corpus.json diff --git a/internal/db/tag.go b/internal/db/tag.go index 29100f24..8ac440e9 100644 --- a/internal/db/tag.go +++ b/internal/db/tag.go @@ -69,3 +69,56 @@ func (d *DB) ArticleTagIDs(ctx context.Context, articleID int64) ([]int64, error } return out, nil } + +type CloudTag struct { + Name string + FullName string + Articles int + CategoryID int64 + CategoryName string + CategorySlug string + CategoryText string + Priority *int +} + +var qTagCloud = register("TagCloud", ` +SELECT t.name, + CASE WHEN c.slug = '_default' THEN t.name ELSE c.slug || ':' || t.name END, + count(link.article_id), + c.id, c.name, c.slug, c.description, c.priority +FROM web_tag t +JOIN web_tagscategory c ON c.id = t.category_id +LEFT JOIN web_article_tags link ON link.tag_id = t.id +WHERE t.name NOT LIKE '\_%' +GROUP BY t.id, t.name, c.id, c.name, c.slug, c.description, c.priority +ORDER BY count(link.article_id) DESC`) + +// The limit lands after the busiest tags come first, so it decides which tags +// are in the cloud and not just how many. +func (d *DB) TagCloud(ctx context.Context, limit *int) ([]CloudTag, error) { + sql := qTagCloud + args := []any{} + if limit != nil { + sql += "\nLIMIT $1" + args = append(args, *limit) + } + rows, err := d.pool.Query(ctx, sql, args...) + if err != nil { + return nil, fmt.Errorf("query tag cloud: %w", err) + } + defer rows.Close() + + var out []CloudTag + for rows.Next() { + var t CloudTag + if err := rows.Scan(&t.Name, &t.FullName, &t.Articles, + &t.CategoryID, &t.CategoryName, &t.CategorySlug, &t.CategoryText, &t.Priority); err != nil { + return nil, fmt.Errorf("scan tag cloud: %w", err) + } + out = append(out, t) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read tag cloud: %w", err) + } + return out, nil +} diff --git a/internal/db/tag_test.go b/internal/db/tag_test.go new file mode 100644 index 00000000..388c2ee2 --- /dev/null +++ b/internal/db/tag_test.go @@ -0,0 +1,56 @@ +package db + +import ( + "context" + "testing" +) + +func TestTagCloudSQLMatchesSchema(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + limit := 2 + + all, err := d.TagCloud(ctx, nil) + if err != nil { + t.Fatalf("TagCloud(nil) err = %v, want nil", err) + } + limited, err := d.TagCloud(ctx, &limit) + if err != nil { + t.Fatalf("TagCloud(2) err = %v, want nil", err) + } + if len(limited) != limit { + t.Errorf("len(TagCloud(2)) = %d, want %d", len(limited), limit) + } + if len(all) <= len(limited) { + t.Errorf("len(TagCloud(nil)) = %d, want more than %d", len(all), len(limited)) + } +} + +func TestTagCloudSkipsUnderscoreNames(t *testing.T) { + d := newTestDB(t) + + tags, err := d.TagCloud(context.Background(), nil) + if err != nil { + t.Fatalf("TagCloud(nil) err = %v, want nil", err) + } + for _, tag := range tags { + if len(tag.Name) > 0 && tag.Name[0] == '_' { + t.Errorf("TagCloud() has %q, want no name starting with _", tag.Name) + } + } +} + +func TestTagCloudOrdersByArticleCount(t *testing.T) { + d := newTestDB(t) + + tags, err := d.TagCloud(context.Background(), nil) + if err != nil { + t.Fatalf("TagCloud(nil) err = %v, want nil", err) + } + for i := 1; i < len(tags); i++ { + if tags[i-1].Articles < tags[i].Articles { + t.Errorf("TagCloud()[%d].Articles = %d, want at least %d", + i-1, tags[i-1].Articles, tags[i].Articles) + } + } +} diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 1f5624ff..162f889c 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -104,6 +104,9 @@ "module-sitechanges-types-all": "全部", "module-sitechanges-username": "按用户名筛选：", "module-sitechanges-username-hint": "使用前缀\"~\"进行部分
用户名匹配筛选", + "module-tagcloud-color": "无效的颜色：{color}", + "module-tagcloud-font-size": "无效的字体大小：{size}", + "module-tagcloud-units": "最大和最小字体大小的单位不同：{min} 和 {max}", "module-unknown": "模块 '{name}' 不存在", "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", diff --git a/internal/module/module.go b/internal/module/module.go index 16937351..b8f3fe7f 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -23,6 +23,7 @@ type Data interface { TagCategory(slug string) (db.TagCategory, error) HiddenCategories(user *db.User) ([]string, error) TagIDsByName(categorySlug, name string) ([]int64, error) + TagCloud(limit *int) ([]db.CloudTag, error) ArticleTagIDs(articleID int64) ([]int64, error) ArticleByRef(ref string) (*db.Article, error) UserByUsername(name string) (*db.User, error) diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 40d94ba0..5ecabf7d 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges"} + ported := []string{"countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) @@ -102,11 +102,11 @@ func TestRenderOfARemovedModule(t *testing.T) { func TestRenderOfAModuleNobodyWroteYet(t *testing.T) { var moduleErr *module.Error - if _, err := module.Render(module.Env{}, "tagcloud", nil, ""); !errors.As(err, &moduleErr) { - t.Fatalf("Render(tagcloud) err = %v, want a module error", err) + if _, err := module.Render(module.Env{}, "forumpost", nil, ""); !errors.As(err, &moduleErr) { + t.Fatalf("Render(forumpost) err = %v, want a module error", err) } if moduleErr.Message != "module-unknown" { - t.Errorf("Render(tagcloud) message = %q, want %q", moduleErr.Message, "module-unknown") + t.Errorf("Render(forumpost) message = %q, want %q", moduleErr.Message, "module-unknown") } } diff --git a/internal/modules/tagcloud.go b/internal/modules/tagcloud.go new file mode 100644 index 00000000..b7d77425 --- /dev/null +++ b/internal/modules/tagcloud.go @@ -0,0 +1,291 @@ +package modules + +import ( + "fmt" + "regexp" + "sort" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" +) + +func init() { module.Register("tagcloud", renderTagCloud) } + +const ( + defaultMinSize = "100%" + defaultMaxSize = "300%" + defaultMinColor = "128,128,192" + defaultMaxColor = "64,64,128" + defaultTagTarget = "system:page-tags" +) + +func renderTagCloud(env module.Env, params map[string]string, _ string) (string, error) { + if env.Data == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} + } + + // Both bounds have to be named together, since interpolating between a + // default and a chosen one is not what the caller asked for. + minSize, maxSize := defaultMinSize, defaultMaxSize + _, hasMin := params["minfontsize"] + _, hasMax := params["maxfontsize"] + if hasMin && hasMax { + minSize, maxSize = params["minfontsize"], params["maxfontsize"] + } + minColor, maxColor := defaultMinColor, defaultMaxColor + _, hasMinColor := params["mincolor"] + _, hasMaxColor := params["maxcolor"] + if hasMinColor && hasMaxColor { + minColor, maxColor = params["mincolor"], params["maxcolor"] + } + + // A limit that does not parse, and a negative one, both blow up before the + // module can say anything about it, so the reader gets the generic block. + var limit *int + if raw, ok := params["limit"]; ok { + value, err := wikinum.Int(raw) + if err != nil || value < 0 { + return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} + } + limit = &value + } + + target, ok := params["target"] + if !ok { + target = defaultTagTarget + } + + tags, err := env.Data.TagCloud(limit) + if err != nil { + return "", err + } + scale, err := newTagScale(env, tags, minSize, maxSize, minColor, maxColor) + if err != nil { + return "", err + } + + // The query orders by count so the limit cuts the quiet tags, and the + // display order is the bare name even where the link carries a category. + shown := make([]db.CloudTag, len(tags)) + copy(shown, tags) + sort.SliceStable(shown, func(i, j int) bool { return shown[i].Name < shown[j].Name }) + + if params["categories"] == "yes" { + return tagCloudByCategory(shown, scale, target), nil + } + return tagCloudFlat(shown, scale, target), nil +} + +func tagCloudFlat(tags []db.CloudTag, scale tagScale, target string) string { + var b strings.Builder + b.WriteString(`
` + "\n ") + for i := range tags { + b.WriteString("\n " + + tagAnchor(tags[i], tags[i].FullName, scale, target) + "\n ") + } + b.WriteString("\n
") + return b.String() +} + +func tagCloudByCategory(tags []db.CloudTag, scale tagScale, target string) string { + order := make([]int64, 0, len(tags)) + byCategory := map[int64][]db.CloudTag{} + for _, tag := range tags { + if _, seen := byCategory[tag.CategoryID]; !seen { + order = append(order, tag.CategoryID) + } + byCategory[tag.CategoryID] = append(byCategory[tag.CategoryID], tag) + } + sort.SliceStable(order, func(i, j int) bool { + return lessPriority(byCategory[order[i]][0].Priority, byCategory[order[j]][0].Priority) + }) + + var b strings.Builder + b.WriteString(`
` + "\n ") + for _, id := range order { + group := byCategory[id] + head := group[0] + + b.WriteString("\n " + `
` + + "\n " + `" + + "\n " + `
` + + "\n " + `
` + + "\n " + `

- ` + + tagCategoryLabel(head) + `

` + + "\n
" + + "\n " + `
` + + "\n ") + if head.CategoryText != "" { + b.WriteString("

" + escape.HTML(head.CategoryText) + "

") + } + b.WriteString("\n " + `
` + + "\n ") + for i := range group { + b.WriteString("\n " + + tagAnchor(group[i], group[i].Name, scale, target) + + "\n ") + } + b.WriteString("\n
" + + "\n
" + + "\n
" + + "\n
" + + "\n ") + } + b.WriteString("\n
") + return b.String() +} + +func tagCategoryLabel(tag db.CloudTag) string { + label := escape.HTML(tag.CategoryName) + if tag.CategorySlug == "_default" || tag.CategoryName == tag.CategorySlug { + return label + } + return label + ` 
[` +
+		escape.HTML(tag.CategorySlug) + `]
` +} + +func tagAnchor(tag db.CloudTag, shown string, scale tagScale, target string) string { + value := scale.value(tag.Articles) + link := "/" + target + "/tag/" + page.QuoteAll(tag.FullName) + return `` + + escape.HTML(shown) + "" +} + +// A category with no priority sorts after every category that has one. +func lessPriority(a, b *int) bool { + if a == nil || b == nil { + return b == nil && a != nil + } + return *a < *b +} + +type tagScale struct { + min, span int + minSize, maxSize float64 + unit string + minRGB, maxRGB [3]int +} + +func newTagScale(env module.Env, tags []db.CloudTag, minSize, maxSize, minColor, maxColor string) (tagScale, error) { + var s tagScale + if len(tags) > 0 { + low, high := tags[0].Articles, tags[0].Articles + for _, tag := range tags { + low = min(low, tag.Articles) + high = max(high, tag.Articles) + } + s.min, s.span = low, high-low + } + + var minUnit, maxUnit string + var err error + if s.minSize, minUnit, err = parseFontSize(env, minSize); err != nil { + return s, err + } + if s.maxSize, maxUnit, err = parseFontSize(env, maxSize); err != nil { + return s, err + } + if minUnit != maxUnit { + return s, &module.Error{Message: env.Text("module-tagcloud-units", "min", minSize, "max", maxSize)} + } + s.unit = minUnit + if s.minRGB, err = parseTagColor(env, minColor); err != nil { + return s, err + } + if s.maxRGB, err = parseTagColor(env, maxColor); err != nil { + return s, err + } + return s, nil +} + +func (s tagScale) value(articles int) float64 { + if s.span == 0 { + return 0 + } + return float64(articles-s.min) / float64(s.span) +} + +func (s tagScale) size(value float64) string { + return fmt.Sprintf("%.4f%s", s.minSize+(s.maxSize-s.minSize)*value, s.unit) +} + +func (s tagScale) color(value float64) string { + channel := func(i int) int { + v := int(float64(s.minRGB[i]) + float64(s.maxRGB[i]-s.minRGB[i])*value) + return max(0, min(v, 255)) + } + return fmt.Sprintf("#%02x%02x%02x", channel(0), channel(1), channel(2)) +} + +// The digits are taken greedily and whatever follows is the unit, so 1.5em +// reads as a size of one carrying the unit ".5em". +var fontSizePattern = regexp.MustCompile(`^(\d+)([\s\S]*)$`) + +func parseFontSize(env module.Env, size string) (float64, string, error) { + match := fontSizePattern.FindStringSubmatch(size) + if match == nil { + return 0, "", &module.Error{Message: env.Text("module-tagcloud-font-size", "size", size)} + } + value, err := strconv.ParseFloat(match[1], 64) + if err != nil { + return 0, "", &module.Error{Message: env.Text("module-tagcloud-font-size", "size", size)} + } + return value, strings.ToLower(strings.TrimSpace(match[2])), nil +} + +var rgbPattern = regexp.MustCompile(`^rgb\s*\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*\)$`) +var bareRGBPattern = regexp.MustCompile(`^(\d+)\s*,\s*(\d+)\s*,\s*(\d+)$`) + +func parseTagColor(env module.Env, color string) ([3]int, error) { + bad := &module.Error{Message: env.Text("module-tagcloud-color", "color", color)} + if strings.HasPrefix(color, "#") { + return parseHexColor(color[1:], bad) + } + if strings.HasPrefix(strings.TrimLeft(color, " \t\n\v\f\r"), "rgb") { + return matchRGB(rgbPattern, strings.TrimSpace(color), bad) + } + return matchRGB(bareRGBPattern, strings.TrimSpace(color), bad) +} + +func parseHexColor(digits string, bad error) ([3]int, error) { + if len(digits) == 3 { + digits = string([]byte{digits[0], digits[0], digits[1], digits[1], digits[2], digits[2]}) + } + if len(digits) != 6 { + return [3]int{}, bad + } + var out [3]int + for i := range out { + value, err := strconv.ParseUint(digits[2*i:2*i+2], 16, 16) + if err != nil { + return [3]int{}, bad + } + out[i] = int(value) + } + return out, nil +} + +func matchRGB(pattern *regexp.Regexp, color string, bad error) ([3]int, error) { + match := pattern.FindStringSubmatch(color) + if match == nil { + return [3]int{}, bad + } + var out [3]int + for i := range out { + value, err := strconv.Atoi(match[i+1]) + if err != nil { + return [3]int{}, bad + } + out[i] = value + } + return out, nil +} diff --git a/internal/page/testdata/oracle_seed.py b/internal/page/testdata/oracle_seed.py index 8faa4504..b4371ab2 100644 --- a/internal/page/testdata/oracle_seed.py +++ b/internal/page/testdata/oracle_seed.py @@ -14,10 +14,13 @@ import datetime import itertools +from django.contrib.auth.models import AnonymousUser from django.utils import timezone +from web import threadvars from web.controllers import articles -from web.models.articles import Article, ArticleLogEntry, Category, Tag, TagsCategory, Vote +from web.models.articles import (Article, ArticleLogEntry, ArticleVersion, Category, ExternalLink, + Tag, TagsCategory, Vote) from web.models.forum import ForumCategory, ForumPost, ForumPostVersion, ForumSection, ForumThread from web.models.notifications import UserNotification, UserNotificationMapping, UserNotificationSubscription from web.models.settings import Settings @@ -291,6 +294,19 @@ def vote(article, user, rate): TagsCategory.objects.filter(slug='lang').update(priority=1) bare.tags.clear() +# The tag cloud sizes every tag against the busiest one, so the counts here have +# to differ. A tag whose name starts with _ never reaches the cloud, and the +# topic category is the one whose name is not its slug. +rated.tags.set([make_tag('_default', 'alpha'), make_tag('topic', 'scp')]) +unrated.tags.set([make_tag('_default', 'alpha'), make_tag('_default', '_staff')]) +quarter.tags.set([make_tag('_default', 'alpha'), make_tag('topic', 'scp')]) +third.tags.set([make_tag('_default', 'Zeta'), make_tag('_default', '_staff')]) +# aaa sorts before alpha by bare name and after it by full name, which is what +# tells apart the two orders the cloud could be using. +unratable.tags.set([make_tag('topic', 'scp'), make_tag('lang', 'aaa')]) +TagsCategory.objects.filter(slug='topic').update( + priority=2, name='Probe Topic', description='what a page is about') + open_section = forum_section('Probe Open', 0, description='an open section') hidden_section = forum_section('Probe Hidden', 1, description='hidden from the listing', is_hidden=True) staff_section = forum_section('Probe Staff', 2, description='only staff may browse', is_hidden_for_users=True) @@ -426,6 +442,36 @@ def log_entry(kind, meta, user=author, comment=''): ArticleLogEntry.objects.filter(pk=entry_id).update( created_at=LOGGED_AT + datetime.timedelta(minutes=offset)) +def relink(article, source): + version = articles.get_latest_version(article) + ArticleVersion.objects.filter(pk=version.pk).update(source=source) + + +# The wanted-pages list reads the link table, and nothing rebuilds that table on +# save, so the seed points a few pages at names that do not exist and then +# rebuilds it by hand. +relink(unrated, NL.join([ + 'unrated source', + '[[[probe:no-such-one|first]]] [[[probe:no-such-two]]] [[[wanted:alpha|alpha]]]', +])) +relink(quarter, NL.join([ + 'quarter source', + '[[[wanted:beta]]] [[[probe:no-such-one]]]', +])) +relink(unratable, NL.join([ + 'unratable source', + '[[[wanted:gamma]]] [[[probe:full|a page that exists]]]', +])) + +with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + threadvars.put('current_user', AnonymousUser()) + for one in Article.objects.all(): + latest = articles.get_latest_version(one) + if latest: + articles.refresh_article_links(latest) + +print('external links =', ExternalLink.objects.count()) print('site rating_mode =', site_settings.rating_mode) print('forum sections =', ForumSection.objects.count(), 'categories =', ForumCategory.objects.count()) print('log entries =', ArticleLogEntry.objects.count()) diff --git a/internal/page/testdata/vars.golden b/internal/page/testdata/vars.golden index 6a199164..7f3b6018 100644 --- a/internal/page/testdata/vars.golden +++ b/internal/page/testdata/vars.golden @@ -345,9 +345,9 @@ Probe Author === probestars:rated authors_count 1 === probestars:rated tags - +alpha, topic:scp === probestars:rated tags_linked - +[/system:page-tags/tag/alpha alpha], [/system:page-tags/tag/topic%3Ascp topic:scp] === probestars:rated created_at [[date 1614834367]] === probestars:rated updated_at diff --git a/internal/repo/modules.go b/internal/repo/modules.go index cbe028fd..0a2ac8a1 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -100,6 +100,10 @@ func (m moduleData) ArticleAuthors(articleID int64) ([]db.User, error) { return m.repo.db.ArticleAuthors(m.repo.ctx, articleID) } +func (m moduleData) TagCloud(limit *int) ([]db.CloudTag, error) { + return m.repo.db.TagCloud(m.repo.ctx, limit) +} + func (m moduleData) RenderUser(u db.User) (string, error) { return m.repo.renderUser(&u, printuser.Options{Avatar: true, Hover: true}) } diff --git a/internal/repo/tagcloud_test.go b/internal/repo/tagcloud_test.go new file mode 100644 index 00000000..426bcec9 --- /dev/null +++ b/internal/repo/tagcloud_test.go @@ -0,0 +1,89 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +const ( + tagCloudGolden = "testdata/tagcloud.golden" + tagCloudCorpus = "testdata/tagcloud_corpus.json" +) + +type tagCloudCase struct { + Name string `json:"name"` + Params map[string]string `json:"params,omitempty"` +} + +func tagCloudCases() []tagCloudCase { + return []tagCloudCase{ + {Name: "bare"}, + {Name: "categories", Params: map[string]string{"categories": "yes"}}, + {Name: "categories-no", Params: map[string]string{"categories": "no"}}, + {Name: "categories-junk", Params: map[string]string{"categories": "true"}}, + {Name: "limit", Params: map[string]string{"limit": "2"}}, + {Name: "limit-one", Params: map[string]string{"limit": "1"}}, + {Name: "limit-zero", Params: map[string]string{"limit": "0"}}, + {Name: "limit-past-the-end", Params: map[string]string{"limit": "99"}}, + {Name: "limit-junk", Params: map[string]string{"limit": "many"}}, + {Name: "limit-negative", Params: map[string]string{"limit": "-1"}}, + {Name: "limit-underscore", Params: map[string]string{"limit": "1_0"}}, + {Name: "limit-padded", Params: map[string]string{"limit": " 2 "}}, + {Name: "limit-signed", Params: map[string]string{"limit": "+2"}}, + {Name: "target", Params: map[string]string{"target": "probe:tagged"}}, + {Name: "target-empty", Params: map[string]string{"target": ""}}, + {Name: "font-sizes", Params: map[string]string{"minfontsize": "80%", "maxfontsize": "160%"}}, + {Name: "font-sizes-px", Params: map[string]string{"minfontsize": "10px", "maxfontsize": "40px"}}, + {Name: "font-size-min-only", Params: map[string]string{"minfontsize": "80%"}}, + {Name: "font-size-fraction", Params: map[string]string{"minfontsize": "1.5em", "maxfontsize": "3.5em"}}, + {Name: "font-size-mixed-units", Params: map[string]string{"minfontsize": "10px", "maxfontsize": "200%"}}, + {Name: "font-size-junk", Params: map[string]string{"minfontsize": "big", "maxfontsize": "bigger"}}, + {Name: "colors-hex", Params: map[string]string{"mincolor": "#ff0000", "maxcolor": "#0000ff"}}, + {Name: "colors-short-hex", Params: map[string]string{"mincolor": "#f00", "maxcolor": "#00f"}}, + {Name: "colors-rgb", Params: map[string]string{"mincolor": "rgb(255, 0, 0)", "maxcolor": "rgb(0,0,255)"}}, + {Name: "colors-bare", Params: map[string]string{"mincolor": "255,0,0", "maxcolor": "0, 0, 255"}}, + {Name: "colors-out-of-range", Params: map[string]string{"mincolor": "300,0,0", "maxcolor": "999,0,0"}}, + {Name: "colors-min-only", Params: map[string]string{"mincolor": "#ff0000"}}, + {Name: "colors-junk", Params: map[string]string{"mincolor": "red", "maxcolor": "blue"}}, + {Name: "colors-bad-hex", Params: map[string]string{"mincolor": "#ff00", "maxcolor": "#0000ff"}}, + {Name: "everything", Params: map[string]string{ + "categories": "yes", "limit": "3", "target": "probe:tagged", + "minfontsize": "90%", "maxfontsize": "250%", + "mincolor": "#102030", "maxcolor": "rgb(200, 100, 50)"}}, + } +} + +func TestTagCloudMatchesGolden(t *testing.T) { + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := tagCloudCases() + + article, err := d.ArticleByName(ctx, "main") + if err != nil { + t.Fatalf("ArticleByName(main) err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + pc := page.NewContext(article, article, nil, nil) + r := New(ctx, d, users, Options{Loc: loc}) + + body, err := r.RenderModule(pc, "TagCloud", copyParams(c.Params), "") + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\n%s\n", c.Name, body) + } + compareGolden(t, b.String(), cases, tagCloudGolden, tagCloudCorpus) +} diff --git a/internal/repo/testdata/oracle_tagcloud.py b/internal/repo/testdata/oracle_tagcloud.py new file mode 100644 index 00000000..cebb21dc --- /dev/null +++ b/internal/repo/testdata/oracle_tagcloud.py @@ -0,0 +1,48 @@ +"""Records what the TagCloud module renders for each set of parameters. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e TAGCLOUD_CORPUS="$(cat internal/repo/testdata/tagcloud_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_tagcloud.py + +Compare the output with internal/repo/testdata/tagcloud.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.site import Site + +CORPUS = json.loads(os.environ['TAGCLOUD_CORPUS']) + + +def main(): + article = articles.get_article('main') + if article is None: + raise SystemExit('main is missing; run oracle_seed.py first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + threadvars.put('current_user', viewer) + context = RenderContext(article, article, {}, viewer) + try: + body = modules.render_module('TagCloud', context, dict(case.get('params') or {})) + except ModuleError as error: + body = '!error: %s' % error.message + except Exception as error: + body = '!crash: %s: %s' % (type(error).__name__, error) + out.append('=== %s\n%s\n' % (case['name'], body)) + sys.stdout.write(''.join(out)) + + +main() diff --git a/internal/repo/testdata/tagcloud.golden b/internal/repo/testdata/tagcloud.golden new file mode 100644 index 00000000..d6d42f17 --- /dev/null +++ b/internal/repo/testdata/tagcloud.golden @@ -0,0 +1,393 @@ +=== bare +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== categories +
+ +
+ +
+
+

- lang

+
+
+ +
+ + aaa + + en + +
+
+
+
+ +
+ +
+
+

- Probe Topic 
[topic]

+
+
+

what a page is about

+
+ + scp + +
+
+
+
+ +
+ +
+
+

- 默认

+
+
+ +
+ + alpha + + zeta + +
+
+
+
+ +
+=== categories-no +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== categories-junk +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== limit +
+ + alpha + + topic:scp + +
+=== limit-one +
+ + alpha + +
+=== limit-zero +
+ +
+=== limit-past-the-end +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== limit-junk +!error: 处理模块 'TagCloud' 时出错 +=== limit-negative +!error: 处理模块 'TagCloud' 时出错 +=== limit-underscore +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== limit-padded +
+ + alpha + + topic:scp + +
+=== limit-signed +
+ + alpha + + topic:scp + +
+=== target +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== target-empty +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== font-sizes +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== font-sizes-px +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== font-size-min-only +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== font-size-fraction +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== font-size-mixed-units +!error: 最大和最小字体大小的单位不同：10px 和 200% +=== font-size-junk +!error: 无效的字体大小：big +=== colors-hex +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== colors-short-hex +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== colors-rgb +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== colors-bare +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== colors-out-of-range +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== colors-min-only +
+ + lang:aaa + + alpha + + lang:en + + topic:scp + + zeta + +
+=== colors-junk +!error: 无效的颜色：red +=== colors-bad-hex +!error: 无效的颜色：#ff00 +=== everything +
+ +
+ +
+
+

- Probe Topic 
[topic]

+
+
+

what a page is about

+
+ + scp + +
+
+
+
+ +
+ +
+
+

- 默认

+
+
+ +
+ + alpha + + zeta + +
+
+
+
+ +
diff --git a/internal/repo/testdata/tagcloud_corpus.json b/internal/repo/testdata/tagcloud_corpus.json new file mode 100644 index 00000000..8073aaa2 --- /dev/null +++ b/internal/repo/testdata/tagcloud_corpus.json @@ -0,0 +1,197 @@ +[ + { + "name": "bare" + }, + { + "name": "categories", + "params": { + "categories": "yes" + } + }, + { + "name": "categories-no", + "params": { + "categories": "no" + } + }, + { + "name": "categories-junk", + "params": { + "categories": "true" + } + }, + { + "name": "limit", + "params": { + "limit": "2" + } + }, + { + "name": "limit-one", + "params": { + "limit": "1" + } + }, + { + "name": "limit-zero", + "params": { + "limit": "0" + } + }, + { + "name": "limit-past-the-end", + "params": { + "limit": "99" + } + }, + { + "name": "limit-junk", + "params": { + "limit": "many" + } + }, + { + "name": "limit-negative", + "params": { + "limit": "-1" + } + }, + { + "name": "limit-underscore", + "params": { + "limit": "1_0" + } + }, + { + "name": "limit-padded", + "params": { + "limit": " 2 " + } + }, + { + "name": "limit-signed", + "params": { + "limit": "+2" + } + }, + { + "name": "target", + "params": { + "target": "probe:tagged" + } + }, + { + "name": "target-empty", + "params": { + "target": "" + } + }, + { + "name": "font-sizes", + "params": { + "maxfontsize": "160%", + "minfontsize": "80%" + } + }, + { + "name": "font-sizes-px", + "params": { + "maxfontsize": "40px", + "minfontsize": "10px" + } + }, + { + "name": "font-size-min-only", + "params": { + "minfontsize": "80%" + } + }, + { + "name": "font-size-fraction", + "params": { + "maxfontsize": "3.5em", + "minfontsize": "1.5em" + } + }, + { + "name": "font-size-mixed-units", + "params": { + "maxfontsize": "200%", + "minfontsize": "10px" + } + }, + { + "name": "font-size-junk", + "params": { + "maxfontsize": "bigger", + "minfontsize": "big" + } + }, + { + "name": "colors-hex", + "params": { + "maxcolor": "#0000ff", + "mincolor": "#ff0000" + } + }, + { + "name": "colors-short-hex", + "params": { + "maxcolor": "#00f", + "mincolor": "#f00" + } + }, + { + "name": "colors-rgb", + "params": { + "maxcolor": "rgb(0,0,255)", + "mincolor": "rgb(255, 0, 0)" + } + }, + { + "name": "colors-bare", + "params": { + "maxcolor": "0, 0, 255", + "mincolor": "255,0,0" + } + }, + { + "name": "colors-out-of-range", + "params": { + "maxcolor": "999,0,0", + "mincolor": "300,0,0" + } + }, + { + "name": "colors-min-only", + "params": { + "mincolor": "#ff0000" + } + }, + { + "name": "colors-junk", + "params": { + "maxcolor": "blue", + "mincolor": "red" + } + }, + { + "name": "colors-bad-hex", + "params": { + "maxcolor": "#0000ff", + "mincolor": "#ff00" + } + }, + { + "name": "everything", + "params": { + "categories": "yes", + "limit": "3", + "maxcolor": "rgb(200, 100, 50)", + "maxfontsize": "250%", + "mincolor": "#102030", + "minfontsize": "90%", + "target": "probe:tagged" + } + } +] From cc6917a4275e5caef7425da7d82cfbc3d8cb56b6 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 16:42:04 +0900 Subject: [PATCH 122/428] answer the wanted pages list --- internal/db/wantedpages.go | 95 ++ internal/db/wantedpages_test.go | 59 + internal/i18n/locales/zh-hans.json | 2 + internal/module/module.go | 2 + internal/module/render_test.go | 2 +- internal/modules/wantedpages.go | 154 +++ internal/repo/modules.go | 8 + internal/repo/testdata/oracle_wantedpages.py | 61 + internal/repo/testdata/wantedpages.golden | 1104 +++++++++++++++++ .../repo/testdata/wantedpages_corpus.json | 139 +++ internal/repo/wantedpages_test.go | 79 ++ 11 files changed, 1704 insertions(+), 1 deletion(-) create mode 100644 internal/db/wantedpages.go create mode 100644 internal/db/wantedpages_test.go create mode 100644 internal/modules/wantedpages.go create mode 100644 internal/repo/testdata/oracle_wantedpages.py create mode 100644 internal/repo/testdata/wantedpages.golden create mode 100644 internal/repo/testdata/wantedpages_corpus.json create mode 100644 internal/repo/wantedpages_test.go diff --git a/internal/db/wantedpages.go b/internal/db/wantedpages.go new file mode 100644 index 00000000..f1b68768 --- /dev/null +++ b/internal/db/wantedpages.go @@ -0,0 +1,95 @@ +package db + +import ( + "context" + "fmt" + "strconv" + "strings" +) + +type WantedLink struct { + From string + To string + Title string +} + +type WantedFilter struct { + From []string + Categories []string + NotCategories []string +} + +// A link recorded without a category belongs to the default one, on both ends, +// and the stored text carries no hint of that. +const ( + completeFrom = `(CASE WHEN position(':' in l.link_from) > 0 THEN l.link_from::text ELSE '_default:' || l.link_from::text END)` + completeTo = `(CASE WHEN position(':' in l.link_to) > 0 THEN l.link_to::text ELSE '_default:' || l.link_to::text END)` + categoryOfTo = `(CASE WHEN position(':' in l.link_to) > 0 THEN substring(l.link_to::text from 1 for position(':' in l.link_to) - 1) ELSE '_default' END)` +) + +func (f WantedFilter) where(args *[]any) string { + *args = append(*args, lowerAll(f.From)) + var b strings.Builder + b.WriteString("WHERE l.link_type = 'link'\n AND lower(" + completeFrom + ") = ANY($1)" + + "\n AND NOT EXISTS (SELECT 1 FROM web_article a WHERE a.complete_full_name = " + completeTo + ")") + if len(f.Categories) > 0 { + *args = append(*args, lowerAll(f.Categories)) + b.WriteString("\n AND lower(" + categoryOfTo + ") = ANY($" + strconv.Itoa(len(*args)) + ")") + } + if len(f.NotCategories) > 0 { + *args = append(*args, lowerAll(f.NotCategories)) + b.WriteString("\n AND NOT (lower(" + categoryOfTo + ") = ANY($" + strconv.Itoa(len(*args)) + "))") + } + return b.String() +} + +// The link table has no order of its own, so the row id is what keeps a page of +// results from reshuffling between requests. +func (d *DB) WantedLinks(ctx context.Context, f WantedFilter, offset, limit int) ([]WantedLink, error) { + args := []any{} + where := f.where(&args) + args = append(args, limit, offset) + sql := `SELECT l.link_from, l.link_to, coalesce(src.title, '') +FROM web_externallink l +LEFT JOIN web_article src ON src.complete_full_name = ` + completeFrom + "\n" + where + + "\nORDER BY l.id" + + "\nLIMIT $" + strconv.Itoa(len(args)-1) + " OFFSET $" + strconv.Itoa(len(args)) + + rows, err := d.pool.Query(ctx, sql, args...) + if err != nil { + return nil, fmt.Errorf("query wanted links: %w", err) + } + defer rows.Close() + + var out []WantedLink + for rows.Next() { + var link WantedLink + if err := rows.Scan(&link.From, &link.To, &link.Title); err != nil { + return nil, fmt.Errorf("scan wanted link: %w", err) + } + out = append(out, link) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read wanted links: %w", err) + } + return out, nil +} + +func (d *DB) WantedLinkCount(ctx context.Context, f WantedFilter) (int, error) { + args := []any{} + sql := "SELECT count(*)\nFROM web_externallink l\n" + f.where(&args) + + var total int + if err := d.pool.QueryRow(ctx, sql, args...).Scan(&total); err != nil { + return 0, fmt.Errorf("count wanted links: %w", err) + } + return total, nil +} + +func lowerAll(values []string) []string { + out := make([]string, len(values)) + for i, value := range values { + out[i] = strings.ToLower(value) + } + return out +} diff --git a/internal/db/wantedpages_test.go b/internal/db/wantedpages_test.go new file mode 100644 index 00000000..51655ef0 --- /dev/null +++ b/internal/db/wantedpages_test.go @@ -0,0 +1,59 @@ +package db + +import ( + "context" + "testing" +) + +func TestWantedLinkSQLMatchesSchema(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + + for name, filter := range map[string]WantedFilter{ + "empty": {}, + "from": {From: []string{"probestars:unrated"}}, + "categories": {From: []string{"probestars:unrated"}, Categories: []string{"wanted"}}, + "not-categories": {From: []string{"probestars:unrated"}, NotCategories: []string{"wanted"}}, + "both": {From: []string{"probestars:unrated"}, Categories: []string{"wanted"}, NotCategories: []string{"probe"}}, + } { + if _, err := d.WantedLinks(ctx, filter, 0, 20); err != nil { + t.Errorf("WantedLinks(%s) err = %v, want nil", name, err) + } + if _, err := d.WantedLinkCount(ctx, filter); err != nil { + t.Errorf("WantedLinkCount(%s) err = %v, want nil", name, err) + } + } +} + +func TestWantedLinkCountAgreesWithTheRows(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + filter := WantedFilter{From: []string{"probestars:unrated", "probestars:quarter", "probeoff:unratable"}} + + rows, err := d.WantedLinks(ctx, filter, 0, 100) + if err != nil { + t.Fatalf("WantedLinks() err = %v, want nil", err) + } + total, err := d.WantedLinkCount(ctx, filter) + if err != nil { + t.Fatalf("WantedLinkCount() err = %v, want nil", err) + } + if total != len(rows) { + t.Errorf("WantedLinkCount() = %d, want %d", total, len(rows)) + } +} + +func TestWantedLinksSkipPagesThatExist(t *testing.T) { + d := newTestDB(t) + filter := WantedFilter{From: []string{"probeoff:unratable"}} + + rows, err := d.WantedLinks(context.Background(), filter, 0, 100) + if err != nil { + t.Fatalf("WantedLinks() err = %v, want nil", err) + } + for _, row := range rows { + if row.To == "probe:full" { + t.Errorf("WantedLinks() has %q, want only names with no page", row.To) + } + } +} diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 162f889c..e7787be6 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -107,6 +107,8 @@ "module-tagcloud-color": "无效的颜色：{color}", "module-tagcloud-font-size": "无效的字体大小：{size}", "module-tagcloud-units": "最大和最小字体大小的单位不同：{min} 和 {max}", + "module-wantedpages-missing": "缺失的链接", + "module-wantedpages-source": "源页面", "module-unknown": "模块 '{name}' 不存在", "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", diff --git a/internal/module/module.go b/internal/module/module.go index b8f3fe7f..df9f75be 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -24,6 +24,8 @@ type Data interface { HiddenCategories(user *db.User) ([]string, error) TagIDsByName(categorySlug, name string) ([]int64, error) TagCloud(limit *int) ([]db.CloudTag, error) + WantedLinks(f db.WantedFilter, offset, limit int) ([]db.WantedLink, error) + WantedLinkCount(f db.WantedFilter) (int, error) ArticleTagIDs(articleID int64) ([]int64, error) ArticleByRef(ref string) (*db.Article, error) UserByUsername(name string) (*db.User, error) diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 5ecabf7d..790d0ade 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud"} + ported := []string{"countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "wantedpages"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/wantedpages.go b/internal/modules/wantedpages.go new file mode 100644 index 00000000..1d61c080 --- /dev/null +++ b/internal/modules/wantedpages.go @@ -0,0 +1,154 @@ +package modules + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +func init() { module.Register("wantedpages", renderWantedPages) } + +const wantedPerPageCap = 250 + +func renderWantedPages(env module.Env, params map[string]string, _ string) (string, error) { + if env.Data == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} + } + pc := env.Page + if pc == nil { + pc = page.NewContext(nil, nil, nil, env.User) + } + + // The source side reuses the page filter whole, so category_from is copied + // over the name that filter knows and its own window is dropped. + if from, ok := params["category_from"]; ok { + params["category"] = from + } + dropped := map[string]bool{} + for _, key := range []string{"limit", "offset"} { + if _, ok := params[key]; ok { + dropped[key] = true + delete(params, key) + } + } + + categoryTo := "*" + if to, ok := params["category_to"]; ok { + categoryTo = to + } + var path page.PathParams + if value, ok := pc.PathParams.Lookup("p"); ok { + path = path.Put(value) + } + window, err := listpages.Parse(env.Data, pc.Article, env.User, + map[string]string{"category": categoryTo, "perpage": params["perpage"]}, path) + if err != nil { + return "", err + } + + sources, err := wantedSourceNames(env, pc, params) + if err != nil { + return "", err + } + + filter := db.WantedFilter{ + From: sources, + Categories: window.Filter.Categories, + NotCategories: window.Filter.NotCategories, + } + total, err := env.Data.WantedLinkCount(filter) + if err != nil { + return "", err + } + + perPage := min(window.PerPage, wantedPerPageCap) + links, err := env.Data.WantedLinks(filter, (window.Page-1)*perPage, perPage) + if err != nil { + return "", err + } + + pathJSON, err := wikijson.Marshal(pathParamsObject(pc.PathParams)) + if err != nil { + return "", err + } + // Dropping the two keys outright would tell the frontend they were never + // given, so they go back with no value instead. + shownParams := map[string]string{} + for key, value := range params { + shownParams[key] = value + } + for key := range dropped { + shownParams[key] = "" + } + paramsJSON, err := wikijson.Marshal(paramsObject(shownParams, dropped)) + if err != nil { + return "", err + } + + pageID := "" + if pc.Article != nil { + pageID = pc.Article.FullName() + } + pagination := listpages.Pagination(env.Loc, "", window.Page, wantedPageCount(total, perPage)) + return wantedPagesHTML(env, links, pagination, pathJSON, paramsJSON, pageID), nil +} + +func wantedSourceNames(env module.Env, pc *page.Context, params map[string]string) ([]string, error) { + query, err := listpages.Parse(env.Data, pc.Article, env.User, params, nil) + if err != nil { + return nil, err + } + result, err := listpages.Run(env.Data, query, env.User, false) + if err != nil { + return nil, err + } + // The link table stores whatever the wikitext spelled, so the comparison + // happens on the form that always carries a category. + out := make([]string, 0, len(result.Pages)) + for i := range result.Pages { + out = append(out, result.Pages[i].Category+":"+result.Pages[i].Name) + } + return out, nil +} + +func wantedPageCount(total, perPage int) int { + if perPage <= 0 { + return 1 + } + return max(1, (total+perPage-1)/perPage) +} + +func wantedPagesHTML(env module.Env, links []db.WantedLink, pagination, pathJSON, paramsJSON, pageID string) string { + const ind16 = "\n " + const ind20 = "\n " + const ind24 = "\n " + const ind28 = "\n " + + var b strings.Builder + b.WriteString(`
` + + ind16 + pagination + + ind16 + `` + + ind20 + "" + + ind24 + "" + + ind24) + for _, link := range links { + b.WriteString(ind24 + "" + + ind28 + `" + + ind28 + `" + + ind24 + "\n" + ind24) + } + b.WriteString(ind20 + "" + + ind16 + "
" + env.Text("module-wantedpages-source") + + "" + env.Text("module-wantedpages-missing") + "
` + escape.HTML(link.Title) + "` + escape.HTML(link.To) + "
" + + ind16 + pagination + + ind16 + "
") + return b.String() +} diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 0a2ac8a1..32136e4e 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -104,6 +104,14 @@ func (m moduleData) TagCloud(limit *int) ([]db.CloudTag, error) { return m.repo.db.TagCloud(m.repo.ctx, limit) } +func (m moduleData) WantedLinks(f db.WantedFilter, offset, limit int) ([]db.WantedLink, error) { + return m.repo.db.WantedLinks(m.repo.ctx, f, offset, limit) +} + +func (m moduleData) WantedLinkCount(f db.WantedFilter) (int, error) { + return m.repo.db.WantedLinkCount(m.repo.ctx, f) +} + func (m moduleData) RenderUser(u db.User) (string, error) { return m.repo.renderUser(&u, printuser.Options{Avatar: true, Hover: true}) } diff --git a/internal/repo/testdata/oracle_wantedpages.py b/internal/repo/testdata/oracle_wantedpages.py new file mode 100644 index 00000000..f799d508 --- /dev/null +++ b/internal/repo/testdata/oracle_wantedpages.py @@ -0,0 +1,61 @@ +"""Records what the WantedPages module renders for each set of parameters. + +Run oracle_seed.py first, then, with the corpus the Go test exports under -update: + + docker compose exec -T -e WANTEDPAGES_CORPUS="$(cat internal/repo/testdata/wantedpages_corpus.json)" \ + web python manage.py shell < internal/repo/testdata/oracle_wantedpages.py + +The parameters are handed over already sorted, and category is pre-set when +category_from is given, so the JSON this writes into the widget comes out in key +order. The module would otherwise print them in the order it received them, +which is the order ftml handed them over in, and that is not stable between two +renders of the same page. + +Compare the output with internal/repo/testdata/wantedpages.golden. +""" +import json +import os +import sys + +from django.contrib.auth.models import AnonymousUser + +import modules +from modules import ModuleError +from renderer.parser import RenderContext +from web import threadvars +from web.controllers import articles +from web.models.site import Site + +CORPUS = json.loads(os.environ['WANTEDPAGES_CORPUS']) + + +def sorted_params(case): + params = dict(case.get('params') or {}) + if 'category_from' in params and 'category' not in params: + params['category'] = params['category_from'] + return dict(sorted(params.items())) + + +def main(): + article = articles.get_article('main') + if article is None: + raise SystemExit('main is missing; run oracle_seed.py first') + + out = [] + for case in CORPUS: + with threadvars.context(): + threadvars.put('current_site', Site.objects.first()) + viewer = AnonymousUser() + threadvars.put('current_user', viewer) + context = RenderContext(article, article, dict(case.get('path') or {}), viewer) + try: + body = modules.render_module('WantedPages', context, sorted_params(case)) + except ModuleError as error: + body = '!error: %s' % error.message + except Exception as error: + body = '!crash: %s: %s' % (type(error).__name__, error) + out.append('=== %s\n%s\n' % (case['name'], body)) + sys.stdout.write(''.join(out)) + + +main() diff --git a/internal/repo/testdata/wantedpages.golden b/internal/repo/testdata/wantedpages.golden new file mode 100644 index 00000000..2a854d64 --- /dev/null +++ b/internal/repo/testdata/wantedpages.golden @@ -0,0 +1,1104 @@ +=== bare +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
scp-173another-missing
wiki-syntax-guidecomponent:_template
wiki-syntax-guide_template
wiki-syntax-guidesystem:page-tags
wiki-syntax-guidesystem:recent-changes
+ +
+=== every-category +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
scp-173another-missing
Probe Unratablewanted:gamma
wiki-syntax-guidecomponent:_template
wiki-syntax-guide_template
wiki-syntax-guidesystem:page-tags
wiki-syntax-guidesystem:recent-changes
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
Probe Unratedwanted:alpha
+ +
+=== category-from +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
Probe Unratedwanted:alpha
+ +
+=== category-from-two +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
Probe Unratablewanted:gamma
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
Probe Unratedwanted:alpha
+ +
+=== category-from-default +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
scp-173another-missing
wiki-syntax-guidecomponent:_template
wiki-syntax-guide_template
wiki-syntax-guidesystem:page-tags
wiki-syntax-guidesystem:recent-changes
+ +
+=== category-from-empty +
+ + + + + + +
源页面缺失的链接
+ +
+=== category-to +
+ + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Unratablewanted:gamma
Probe Unratedwanted:alpha
+ +
+=== category-to-default +
+ + + + + + + + + + + + + + + + + + +
源页面缺失的链接
scp-173another-missing
wiki-syntax-guide_template
+ +
+=== category-to-not +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterprobe:no-such-one
scp-173another-missing
wiki-syntax-guidecomponent:_template
wiki-syntax-guide_template
wiki-syntax-guidesystem:page-tags
wiki-syntax-guidesystem:recent-changes
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
+ +
+=== category-to-two +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
Probe Unratablewanted:gamma
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
Probe Unratedwanted:alpha
+ +
+=== category-both +
+ + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Unratedwanted:alpha
+ +
+=== per-page +
+
+ 第 1 页; 共 4 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+ + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
scp-173another-missing
+
+ 第 1 页; 共 4 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+
+=== per-page-second +
+
+ 第 2 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+ + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Unratablewanted:gamma
wiki-syntax-guidecomponent:_template
wiki-syntax-guide_template
+
+ 第 2 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+
+=== per-page-past-the-end +
+
+ 第 99 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 3 + + + + 4 + + + +
+ + + + + +
源页面缺失的链接
+
+ 第 99 页; 共 4 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 3 + + + + 4 + + + +
+
+=== per-page-one +
+
+ 第 1 页; 共 11 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 10 + + + + 11 + + + + 下一页 » + +
+ + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
+
+ 第 1 页; 共 11 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 10 + + + + 11 + + + + 下一页 » + +
+
+=== per-page-junk +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
scp-173another-missing
Probe Unratablewanted:gamma
wiki-syntax-guidecomponent:_template
wiki-syntax-guide_template
wiki-syntax-guidesystem:page-tags
wiki-syntax-guidesystem:recent-changes
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
Probe Unratedwanted:alpha
+ +
+=== limit-is-dropped +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
scp-173another-missing
Probe Unratablewanted:gamma
wiki-syntax-guidecomponent:_template
wiki-syntax-guide_template
wiki-syntax-guidesystem:page-tags
wiki-syntax-guidesystem:recent-changes
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
Probe Unratedwanted:alpha
+ +
+=== offset-is-dropped +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
scp-173another-missing
Probe Unratablewanted:gamma
wiki-syntax-guidecomponent:_template
wiki-syntax-guide_template
wiki-syntax-guidesystem:page-tags
wiki-syntax-guidesystem:recent-changes
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
Probe Unratedwanted:alpha
+ +
+=== tags-on-the-source +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
源页面缺失的链接
Probe Quarterwanted:beta
Probe Quarterprobe:no-such-one
Probe Unratedprobe:no-such-one
Probe Unratedprobe:no-such-two
Probe Unratedwanted:alpha
+ +
+=== unparsable-source-filter +
+ + + + + + +
源页面缺失的链接
+ +
diff --git a/internal/repo/testdata/wantedpages_corpus.json b/internal/repo/testdata/wantedpages_corpus.json new file mode 100644 index 00000000..19d28de6 --- /dev/null +++ b/internal/repo/testdata/wantedpages_corpus.json @@ -0,0 +1,139 @@ +[ + { + "name": "bare" + }, + { + "name": "every-category", + "params": { + "category": "*" + } + }, + { + "name": "category-from", + "params": { + "category_from": "probestars" + } + }, + { + "name": "category-from-two", + "params": { + "category_from": "probestars, probeoff" + } + }, + { + "name": "category-from-default", + "params": { + "category_from": "_default" + } + }, + { + "name": "category-from-empty", + "params": { + "category_from": "nosuchcategory" + } + }, + { + "name": "category-to", + "params": { + "category": "*", + "category_to": "wanted" + } + }, + { + "name": "category-to-default", + "params": { + "category": "*", + "category_to": "_default" + } + }, + { + "name": "category-to-not", + "params": { + "category": "*", + "category_to": "-wanted" + } + }, + { + "name": "category-to-two", + "params": { + "category": "*", + "category_to": "wanted, probe" + } + }, + { + "name": "category-both", + "params": { + "category_from": "probestars", + "category_to": "wanted" + } + }, + { + "name": "per-page", + "params": { + "category": "*", + "perpage": "3" + } + }, + { + "name": "per-page-second", + "params": { + "category": "*", + "perpage": "3" + }, + "path": { + "p": "2" + } + }, + { + "name": "per-page-past-the-end", + "params": { + "category": "*", + "perpage": "3" + }, + "path": { + "p": "99" + } + }, + { + "name": "per-page-one", + "params": { + "category": "*", + "perpage": "1" + } + }, + { + "name": "per-page-junk", + "params": { + "category": "*", + "perpage": "many" + } + }, + { + "name": "limit-is-dropped", + "params": { + "category": "*", + "limit": "1" + } + }, + { + "name": "offset-is-dropped", + "params": { + "category": "*", + "offset": "5" + } + }, + { + "name": "tags-on-the-source", + "params": { + "category": "*", + "tags": "alpha" + } + }, + { + "name": "unparsable-source-filter", + "params": { + "category": "*", + "rating": "junk" + } + } +] diff --git a/internal/repo/wantedpages_test.go b/internal/repo/wantedpages_test.go new file mode 100644 index 00000000..8512b6b7 --- /dev/null +++ b/internal/repo/wantedpages_test.go @@ -0,0 +1,79 @@ +package repo + +import ( + "context" + "errors" + "fmt" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/callbacks" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +const ( + wantedPagesGolden = "testdata/wantedpages.golden" + wantedPagesCorpus = "testdata/wantedpages_corpus.json" +) + +type wantedPagesCase struct { + Name string `json:"name"` + Params map[string]string `json:"params,omitempty"` + Path map[string]string `json:"path,omitempty"` +} + +func wantedPagesCases() []wantedPagesCase { + return []wantedPagesCase{ + {Name: "bare"}, + {Name: "every-category", Params: map[string]string{"category": "*"}}, + {Name: "category-from", Params: map[string]string{"category_from": "probestars"}}, + {Name: "category-from-two", Params: map[string]string{"category_from": "probestars, probeoff"}}, + {Name: "category-from-default", Params: map[string]string{"category_from": "_default"}}, + {Name: "category-from-empty", Params: map[string]string{"category_from": "nosuchcategory"}}, + {Name: "category-to", Params: map[string]string{"category": "*", "category_to": "wanted"}}, + {Name: "category-to-default", Params: map[string]string{"category": "*", "category_to": "_default"}}, + {Name: "category-to-not", Params: map[string]string{"category": "*", "category_to": "-wanted"}}, + {Name: "category-to-two", Params: map[string]string{"category": "*", "category_to": "wanted, probe"}}, + {Name: "category-both", Params: map[string]string{"category_from": "probestars", "category_to": "wanted"}}, + {Name: "per-page", Params: map[string]string{"category": "*", "perpage": "3"}}, + {Name: "per-page-second", Params: map[string]string{"category": "*", "perpage": "3"}, + Path: map[string]string{"p": "2"}}, + {Name: "per-page-past-the-end", Params: map[string]string{"category": "*", "perpage": "3"}, + Path: map[string]string{"p": "99"}}, + {Name: "per-page-one", Params: map[string]string{"category": "*", "perpage": "1"}}, + {Name: "per-page-junk", Params: map[string]string{"category": "*", "perpage": "many"}}, + {Name: "limit-is-dropped", Params: map[string]string{"category": "*", "limit": "1"}}, + {Name: "offset-is-dropped", Params: map[string]string{"category": "*", "offset": "5"}}, + {Name: "tags-on-the-source", Params: map[string]string{"category": "*", "tags": "alpha"}}, + {Name: "unparsable-source-filter", Params: map[string]string{"category": "*", "rating": "junk"}}, + } +} + +func TestWantedPagesMatchesGolden(t *testing.T) { + ctx := context.Background() + d := testDB(t) + users, loc := testUsers(t) + cases := wantedPagesCases() + + article, err := d.ArticleByName(ctx, "main") + if err != nil { + t.Fatalf("ArticleByName(main) err = %v, want nil", err) + } + + var b strings.Builder + for _, c := range cases { + pc := page.NewContext(article, article, sortedPath(c.Path), nil) + r := New(ctx, d, users, Options{Loc: loc}) + + body, err := r.RenderModule(pc, "WantedPages", copyParams(c.Params), "") + var moduleErr *callbacks.ModuleError + switch { + case errors.As(err, &moduleErr): + body = "!error: " + moduleErr.Message + case err != nil: + t.Fatalf("RenderModule(%s) err = %v, want nil", c.Name, err) + } + fmt.Fprintf(&b, "=== %s\n%s\n", c.Name, body) + } + compareGolden(t, b.String(), cases, wantedPagesGolden, wantedPagesCorpus) +} From f43ca0a933690033c36311098980c07489f29800 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 16:42:25 +0900 Subject: [PATCH 123/428] answer a missing page with the site's own 404 template --- internal/articlepage/articlepage_test.go | 27 +++++++ internal/articlepage/render.go | 85 ++++++++++++++++++++-- internal/callbacks/callbacks.go | 2 +- internal/i18n/locales/zh-hans.json | 2 + internal/module/registry.go | 1 + internal/module/render_test.go | 2 +- internal/modules/button.go | 29 ++++++++ internal/modules/button_test.go | 91 ++++++++++++++++++++++++ internal/page/button.go | 13 ++++ internal/page/button_test.go | 40 +++++++++++ internal/page/template.go | 6 ++ 11 files changed, 292 insertions(+), 6 deletions(-) create mode 100644 internal/modules/button.go create mode 100644 internal/modules/button_test.go create mode 100644 internal/page/button.go create mode 100644 internal/page/button_test.go diff --git a/internal/articlepage/articlepage_test.go b/internal/articlepage/articlepage_test.go index 2eea55d0..b7095b70 100644 --- a/internal/articlepage/articlepage_test.go +++ b/internal/articlepage/articlepage_test.go @@ -101,3 +101,30 @@ func TestRequestWithoutASiteFails(t *testing.T) { t.Errorf("GET /main without a site = %d, want %d", rec.Code, http.StatusInternalServerError) } } + +func TestNotFoundNamesAskTheCategoryFirst(t *testing.T) { + got := notFoundNames("scp:9999") + want := []string{"scp:_404", "_404"} + if len(got) != len(want) { + t.Fatalf("notFoundNames(%q) = %v, want %v", "scp:9999", got, want) + } + for i := range want { + if got[i] != want[i] { + t.Errorf("notFoundNames(%q)[%d] = %q, want %q", "scp:9999", i, got[i], want[i]) + } + } +} + +func TestNotFoundNamesOfTheDefaultCategory(t *testing.T) { + got := notFoundNames("no-such-page") + if len(got) != 1 || got[0] != "_404" { + t.Errorf("notFoundNames(%q) = %v, want [_404]", "no-such-page", got) + } +} + +func TestNotFoundNamesOfAnExplicitDefaultCategory(t *testing.T) { + got := notFoundNames("_default:no-such-page") + if len(got) != 1 || got[0] != "_404" { + t.Errorf("notFoundNames(%q) = %v, want [_404]", "_default:no-such-page", got) + } +} diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index eaa656d9..575bc09c 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -25,6 +25,7 @@ import ( const ( templateName = "_template" + notFoundName = "_404" excerptLimit = 384 ) @@ -92,7 +93,7 @@ func (h *Handler) articleBody(req *request, canonical string) (body, error) { vars := h.vars(req, req.article) source = page.PageVars(source, vars, 1, 1) source = page.ApplyTemplate(source, article.ThisPage(req.params, canonical)) - source = page.ThisVars(source, vars) + source = page.PreRender(source, vars) info, err := h.pageInfo(req, req.article) if err != nil { @@ -182,6 +183,14 @@ func (h *Handler) missingBody(req *request) (body, error) { } allow := wikidot.NameAllowed(req.name) && perms.Resolve(subject, object).Has(perms.CreateArticles) + written, err := h.notFoundPage(req) + if err != nil { + return body{}, err + } + if written != nil { + return *written, nil + } + // The name is left out because the view never puts it in this template's // context, so the message it renders has an empty slot where it goes. html, err := h.shell(req.loc).NotFound(shell.NotFound{ @@ -191,6 +200,74 @@ func (h *Handler) missingBody(req *request) (body, error) { return body{html: html, status: http.StatusNotFound}, err } +func (h *Handler) notFoundPage(req *request) (*body, error) { + for _, name := range notFoundNames(req.name) { + found, err := h.deps.DB.ArticleByName(req.ctx, name) + if errors.Is(err, db.ErrNotFound) { + continue + } + if err != nil { + return nil, err + } + source, err := h.deps.DB.LatestSource(req.ctx, found.ID) + if errors.Is(err, db.ErrNotFound) { + continue + } + if err != nil { + return nil, err + } + out, err := h.renderNotFound(req, found, source) + return &out, err + } + return nil, nil +} + +// The category's own page comes first so a category can answer differently. A +// page in the default category would ask for the same row twice. +func notFoundNames(fullName string) []string { + category, _ := wikidot.Split(fullName) + if category == wikidot.DefaultCategory { + return []string{notFoundName} + } + return []string{category + ":" + notFoundName, notFoundName} +} + +// The page the reader asked for has no row, so it is stood up from the name +// alone. What the template names has to be that page, not the template. +func (h *Handler) renderNotFound(req *request, template *db.Article, source string) (body, error) { + category, name := wikidot.Split(req.name) + asked := &db.Article{Category: category, Name: name} + + // The variables answer for the page that was asked for rather than for the + // template, so a template can name what is missing. + vars := h.vars(req, asked) + source = page.PageVars(source, vars, 1, 1) + source = page.PreRender(source, vars) + info, err := h.pageInfo(req, template) + if err != nil { + return body{}, err + } + + pc := page.NewContext(asked, template, req.params, req.user) + html, err := h.deps.Engine.RenderHTML(req.ctx, source, info, + h.callbacks(req, vars, pc), renderer.ModeArticle) + if err != nil { + return body{}, err + } + req.params = pc.PathParams + + status := http.StatusNotFound + if pc.Status != 0 && pc.Status != http.StatusOK { + status = pc.Status + } + return body{ + html: html.Body, + status: status, + title: pc.Title, + style: pc.ComputedStyle, + }, nil +} + // nav renders one of the two navigation pages. It gets its own callbacks and // its own PageInfo, since the page it decorates is a different row. func (h *Handler) nav(req *request, name string) (string, string, error) { @@ -215,7 +292,7 @@ func (h *Handler) nav(req *request, name string) (string, string, error) { return "", "", err } pc := h.context(req, found) - html, err := h.deps.Engine.RenderHTML(req.ctx, page.ThisVars(source, vars), info, + html, err := h.deps.Engine.RenderHTML(req.ctx, page.PreRender(source, vars), info, h.callbacks(req, vars, pc), renderer.ModeArticle) if err != nil { return "", "", err @@ -247,7 +324,7 @@ func (h *Handler) nested(req *request, source string, pc *page.Context) (string, if err != nil { return "", err } - html, err := h.deps.Engine.RenderHTML(req.ctx, page.ThisVars(source, vars), info, + html, err := h.deps.Engine.RenderHTML(req.ctx, page.PreRender(source, vars), info, h.callbacks(req, vars, pc), renderer.ModeArticle) if err != nil { return "", err @@ -261,7 +338,7 @@ func (h *Handler) message(req *request, source string) (string, error) { if err != nil { return "", err } - html, err := h.deps.Engine.RenderHTML(req.ctx, page.ThisVars(source, nil), info, + html, err := h.deps.Engine.RenderHTML(req.ctx, page.PreRender(source, nil), info, h.callbacks(req, nil, pc), renderer.ModeMessage) if err != nil { return "", err diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go index 87b9da15..538d398b 100644 --- a/internal/callbacks/callbacks.go +++ b/internal/callbacks/callbacks.go @@ -159,7 +159,7 @@ func (c *Callbacks) IncludePages(refs []renderer.IncludeRef) ([]renderer.Fetched if fetched[i].Content == nil { continue } - substituted := page.ThisVars(*fetched[i].Content, c.vars) + substituted := page.PreRender(*fetched[i].Content, c.vars) fetched[i].Content = &substituted } return fetched, nil diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index e7787be6..5b970ac2 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -8,6 +8,8 @@ "include-create": "立刻创建", "include-loop": "插入的页面 \"{name}\" 导致了无限包含循环", "include-missing": "插入的页面 \"{name}\" 不存在", + "module-button-edit": "编辑", + "module-button-unknown": "不支持的按钮类型：{type}", "module-date-format": "{month}.{day}.{year} {hour}:{minute}", "module-date-format-js": "%m.%d.%Y %H:%M", "module-date-missing": "n/a", diff --git a/internal/module/registry.go b/internal/module/registry.go index 4cf6365e..3bc1f87c 100644 --- a/internal/module/registry.go +++ b/internal/module/registry.go @@ -12,6 +12,7 @@ type Info struct { } var registry = map[string]Info{ + "button": {Name: "button"}, "countpages": {Name: "countpages", HasContent: true}, "css": {Name: "css", HasContent: true}, "forumcategory": {Name: "forumcategory"}, diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 790d0ade..30789819 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "wantedpages"} + ported := []string{"button", "countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "wantedpages"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/button.go b/internal/modules/button.go new file mode 100644 index 00000000..320583bb --- /dev/null +++ b/internal/modules/button.go @@ -0,0 +1,29 @@ +package modules + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" +) + +func init() { module.Register("button", renderButton) } + +func renderButton(env module.Env, params map[string]string, _ string) (string, error) { + kind := strings.ToLower(strings.TrimSpace(params["type"])) + if kind != "edit" { + return "", &module.Error{Message: env.Text("module-button-unknown", "type", params["type"])} + } + if env.Page == nil || env.Page.Article == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} + } + + label, ok := params["text"] + if !ok { + label = env.Text("module-button-edit") + } + // The path parameter is what opens the editor on arrival, and it is the + // same one the missing-page view already answers to. + href := "/" + env.Page.Article.FullName() + "/edit/true" + return `` + escape.HTML(label) + "", nil +} diff --git a/internal/modules/button_test.go b/internal/modules/button_test.go new file mode 100644 index 00000000..f6c3211f --- /dev/null +++ b/internal/modules/button_test.go @@ -0,0 +1,91 @@ +package modules + +import ( + "errors" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +func buttonEnv(t *testing.T, article *db.Article) module.Env { + t.Helper() + env := forumEnv(t) + env.Name = "Button" + env.Page = page.NewContext(article, article, nil, nil) + return env +} + +func TestRenderButtonEdit(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "scp", Name: "missing"}) + + got, err := renderButton(env, map[string]string{"type": "edit"}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + want := `编辑` + if got != want { + t.Errorf("renderButton(edit) = %q, want %q", got, want) + } +} + +func TestRenderButtonWithItsOwnText(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) + + got, err := renderButton(env, map[string]string{"type": "edit", "text": "创建此页"}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + want := `创建此页` + if got != want { + t.Errorf("renderButton(text) = %q, want %q", got, want) + } +} + +func TestRenderButtonWithEmptyText(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) + + got, err := renderButton(env, map[string]string{"type": "edit", "text": ""}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + want := `` + if got != want { + t.Errorf("renderButton(text=\"\") = %q, want %q", got, want) + } +} + +func TestRenderButtonEscapes(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "a b&c"}) + + got, err := renderButton(env, map[string]string{"type": "edit", "text": `"x"`}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + want := `<b>"x"</b>` + if got != want { + t.Errorf("renderButton(escapes) = %q, want %q", got, want) + } +} + +func TestRenderButtonOfAnUnknownType(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) + + _, err := renderButton(env, map[string]string{"type": "print"}, "") + var moduleErr *module.Error + if !errors.As(err, &moduleErr) { + t.Fatalf("renderButton(print) err = %v, want a module error", err) + } +} + +func TestRenderButtonWithoutAPage(t *testing.T) { + env := forumEnv(t) + env.Name = "Button" + + _, err := renderButton(env, map[string]string{"type": "edit"}, "") + var moduleErr *module.Error + if !errors.As(err, &moduleErr) { + t.Fatalf("renderButton() err = %v, want a module error", err) + } +} diff --git a/internal/page/button.go b/internal/page/button.go new file mode 100644 index 00000000..8a38ab42 --- /dev/null +++ b/internal/page/button.go @@ -0,0 +1,13 @@ +package page + +import "regexp" + +// A bare-word kind keeps a stray [[button in prose as prose, and arguments stop +// at the first ] because past it a block head cannot be told from the text. +var buttonPattern = regexp.MustCompile(`(?i)\[\[button\s+([A-Za-z][A-Za-z0-9_-]*)([^\]]*)\]\]`) + +// This runs on the source rather than the tree, because the renderer knows +// modules and does not know buttons. +func Buttons(source string) string { + return buttonPattern.ReplaceAllString(source, `[[module Button type="$1"$2]]`) +} diff --git a/internal/page/button_test.go b/internal/page/button_test.go new file mode 100644 index 00000000..3286bc51 --- /dev/null +++ b/internal/page/button_test.go @@ -0,0 +1,40 @@ +package page + +import "testing" + +func TestButtons(t *testing.T) { + cases := []struct{ in, want string }{ + {"", ""}, + {"[[button edit]]", `[[module Button type="edit"]]`}, + {`[[button edit text="创建此页"]]`, `[[module Button type="edit" text="创建此页"]]`}, + {"[[button EDIT]]", `[[module Button type="EDIT"]]`}, + {"[[BUTTON edit]]", `[[module Button type="edit"]]`}, + {"before [[button edit]] after", `before [[module Button type="edit"]] after`}, + {"[[button edit]][[button edit]]", `[[module Button type="edit"]][[module Button type="edit"]]`}, + {"[[button]]", "[[button]]"}, + {"[[button ]]", "[[button ]]"}, + {"[[button 1edit]]", "[[button 1edit]]"}, + {"[[buttons edit]]", "[[buttons edit]]"}, + {"[[module Button type=\"edit\"]]", "[[module Button type=\"edit\"]]"}, + } + for _, c := range cases { + if got := Buttons(c.in); got != c.want { + t.Errorf("Buttons(%q) = %q, want %q", c.in, got, c.want) + } + } +} + +func TestButtonsKeepsTheRestOfTheHead(t *testing.T) { + in := `[[button edit text="a" class="b"]]` + want := `[[module Button type="edit" text="a" class="b"]]` + if got := Buttons(in); got != want { + t.Errorf("Buttons(%q) = %q, want %q", in, got, want) + } +} + +func TestButtonsLeavesAHeadCarryingABracket(t *testing.T) { + in := `[[button edit text="a]b"]]` + if got := Buttons(in); got != in { + t.Errorf("Buttons(%q) = %q, want it left alone", in, got) + } +} diff --git a/internal/page/template.go b/internal/page/template.go index a4644262..44d5f725 100644 --- a/internal/page/template.go +++ b/internal/page/template.go @@ -30,6 +30,12 @@ func ThisVars(source string, vars *Vars) string { return ApplyTemplate(source, vars.This) } +// PreRender is everything the source goes through on its way to the renderer. +// Both passes are blind to code blocks, the way a %% pair in prose already is. +func PreRender(source string, vars *Vars) string { + return Buttons(ThisVars(source, vars)) +} + // PageVars is the pass the category template goes through, where a variable // carries no prefix. index and total exist nowhere else. func PageVars(template string, vars *Vars, index, total int) string { From 240039d459325132b09850b4ca3e871b1406dbf6 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 16:49:57 +0900 Subject: [PATCH 124/428] check the 404 template against the reader before showing it --- internal/articlepage/render.go | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 575bc09c..05ba9ab8 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -201,6 +201,12 @@ func (h *Handler) missingBody(req *request) (body, error) { } func (h *Handler) notFoundPage(req *request) (*body, error) { + perm := repo.NewPerms(req.ctx, h.deps.DB) + subject, err := h.subject(req) + if err != nil { + return nil, err + } + for _, name := range notFoundNames(req.name) { found, err := h.deps.DB.ArticleByName(req.ctx, name) if errors.Is(err, db.ErrNotFound) { @@ -209,6 +215,15 @@ func (h *Handler) notFoundPage(req *request) (*body, error) { if err != nil { return nil, err } + // A template the reader may not read is not a template for them, and + // showing it anyway would hand out a page they were refused. + object, err := perm.Article(found, req.user) + if err != nil { + return nil, err + } + if !perms.Resolve(subject, object).Has(perms.ViewArticles) { + continue + } source, err := h.deps.DB.LatestSource(req.ctx, found.ID) if errors.Is(err, db.ErrNotFound) { continue @@ -261,10 +276,11 @@ func (h *Handler) renderNotFound(req *request, template *db.Article, source stri status = pc.Status } return body{ - html: html.Body, - status: status, - title: pc.Title, - style: pc.ComputedStyle, + html: html.Body, + status: status, + title: pc.Title, + style: pc.ComputedStyle, + redirect: pc.RedirectTo, }, nil } From 48b4ea65bfe8b0e4745dab586fb41e2cb448f940 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 18:14:02 +0900 Subject: [PATCH 125/428] stop the avatar from growing under the pointer --- static/app.css | 9 --------- 1 file changed, 9 deletions(-) diff --git a/static/app.css b/static/app.css index ecdd0c6d..a1b5226b 100644 --- a/static/app.css +++ b/static/app.css @@ -20,15 +20,6 @@ .printuser.avatarhover img.small { padding: 0; border: 1px solid #777; - transition: all 0.25s ease; - pointer-events: none; -} - -.printuser.avatarhover a:hover img.small, -.printuser span:hover img.small { - transform: scale(4); - z-index: 100; - position: relative; } .printuser { From 14413b33d901f5818a7e0e93811910946eca3b24 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 18:14:02 +0900 Subject: [PATCH 126/428] log what made a page render fail --- internal/articlepage/articlepage.go | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/internal/articlepage/articlepage.go b/internal/articlepage/articlepage.go index 7f417fa2..09928d01 100644 --- a/internal/articlepage/articlepage.go +++ b/internal/articlepage/articlepage.go @@ -4,6 +4,7 @@ package articlepage import ( "errors" + "log/slog" "net/http" "time" @@ -23,6 +24,7 @@ type Deps struct { Assets *static.Assets TimeZone *time.Location GoogleTagID string + Log *slog.Logger // Now exists so a test can pin the moment an inactive account comes back. Now func() time.Time @@ -37,6 +39,13 @@ const allowedMethods = "GET, HEAD, OPTIONS" var _ http.Handler = (*Handler)(nil) +func (h *Handler) log() *slog.Logger { + if h.deps.Log == nil { + return slog.Default() + } + return h.deps.Log +} + func New(d Deps) *Handler { if d.Now == nil { d.Now = time.Now @@ -70,6 +79,7 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { out, err := h.build(r) if err != nil { + h.log().Error("render article", "path", r.URL.Path, "err", err) http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) return } From 1a09b9888323ca2afebdf5ebd4fc6898c9cd4e34 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 18:14:03 +0900 Subject: [PATCH 127/428] render a user whose role icon has gone missing --- internal/printuser/printuser_test.go | 18 ++++++++++++------ internal/roles/roles.go | 4 ++-- internal/roles/roles_test.go | 13 ++++++++----- 3 files changed, 22 insertions(+), 13 deletions(-) diff --git a/internal/printuser/printuser_test.go b/internal/printuser/printuser_test.go index 741280a4..d40d3bee 100644 --- a/internal/printuser/printuser_test.go +++ b/internal/printuser/printuser_test.go @@ -195,13 +195,19 @@ func TestTailsPrefersBannedOverBot(t *testing.T) { } } -func TestUserReportsIconLoadFailure(t *testing.T) { - want := errors.New("no such icon") - r := New(nil, func(string) (string, error) { return "", want }) +func TestUserRendersWithoutAnIconThatWillNotLoad(t *testing.T) { + r := New(nil, func(string) (string, error) { return "", errors.New("no such icon") }) role := roles.Role{Slug: "icon", InlineVisualMode: roles.InlineIcon, Icon: "-/roles/gone.svg"} - _, err := r.User(User{ID: 1, Type: TypeNormal, Username: "u", IsActive: true}, []roles.Role{role}, Options{Avatar: true}) - if !errors.Is(err, want) { - t.Errorf("User() err = %v, want %v", err, want) + + got, err := r.User(User{ID: 1, Type: TypeNormal, Username: "u", IsActive: true}, []roles.Role{role}, Options{Avatar: true}) + if err != nil { + t.Fatalf("User() err = %v, want nil", err) + } + if !strings.Contains(got, `data-user-name="u"`) { + t.Errorf("User() = %q, want the chip anyway", got) + } + if strings.Contains(got, "role-icon") { + t.Errorf("User() = %q, want no icon in it", got) } } diff --git a/internal/roles/roles.go b/internal/roles/roles.go index 364c63f8..34d6f143 100644 --- a/internal/roles/roles.go +++ b/internal/roles/roles.go @@ -129,11 +129,11 @@ func (r Role) NameTail(load IconLoader) (*Badge, *Icon, error) { } svg, err := load(r.Icon) if err != nil { - return nil, nil, err + return nil, nil, nil } colored, err := ColorizeIcon(svg, r.Color) if err != nil { - return nil, nil, err + return nil, nil, nil } return nil, &Icon{Icon: colored, Color: r.Color, Tooltip: r.Name}, nil } diff --git a/internal/roles/roles_test.go b/internal/roles/roles_test.go index fb025365..43a12a7b 100644 --- a/internal/roles/roles_test.go +++ b/internal/roles/roles_test.go @@ -95,12 +95,15 @@ func TestNameTailsSkipsIconRoleWithoutFile(t *testing.T) { } } -func TestNameTailsReportsLoaderFailure(t *testing.T) { - want := errors.New("gone") +func TestNameTailsDropsAnIconThatWillNotLoad(t *testing.T) { rs := []Role{{Slug: "icon", InlineVisualMode: InlineIcon, Icon: "i.svg"}} - _, err := NameTails(rs, func(string) (string, error) { return "", want }) - if !errors.Is(err, want) { - t.Errorf("NameTails() err = %v, want %v", err, want) + + got, err := NameTails(rs, func(string) (string, error) { return "", errors.New("gone") }) + if err != nil { + t.Fatalf("NameTails() err = %v, want nil", err) + } + if len(got.Icons) != 0 { + t.Errorf("len(NameTails().Icons) = %d, want 0", len(got.Icons)) } } From d92d8db758f28e19b3f62e26fce2f0dc05724179 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 21:45:22 +0900 Subject: [PATCH 128/428] add the tables the tickets and the invite links need --- ...ser_tickets_and_site_membership_options.py | 140 ++++++++++++++++++ .../0081_assign_ticket_permissions.py | 72 +++++++++ web/migrations/0082_invite_links.py | 59 ++++++++ web/models/__init__.py | 2 + web/models/invites.py | 72 +++++++++ web/models/site.py | 26 ++++ web/models/tickets.py | 91 ++++++++++++ web/permissions/__init__.py | 1 + web/permissions/admin.py | 12 +- web/permissions/tickets.py | 22 +++ 10 files changed, 495 insertions(+), 2 deletions(-) create mode 100644 web/migrations/0080_user_tickets_and_site_membership_options.py create mode 100644 web/migrations/0081_assign_ticket_permissions.py create mode 100644 web/migrations/0082_invite_links.py create mode 100644 web/models/invites.py create mode 100644 web/models/tickets.py create mode 100644 web/permissions/tickets.py diff --git a/web/migrations/0080_user_tickets_and_site_membership_options.py b/web/migrations/0080_user_tickets_and_site_membership_options.py new file mode 100644 index 00000000..0dc1b8cb --- /dev/null +++ b/web/migrations/0080_user_tickets_and_site_membership_options.py @@ -0,0 +1,140 @@ +import auto_prefetch +import django.db.models.deletion +import django.db.models.manager +from django.conf import settings +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('web', '0079_theme_slug'), + ] + + operations = [ + migrations.CreateModel( + name='UserTicket', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('kind', models.TextField(choices=[('ticket', '工单'), ('membershipapply', '入组申请')], default='ticket', verbose_name='类型')), + ('subject', models.TextField(blank=True, verbose_name='标题')), + ('body', models.TextField(verbose_name='正文')), + ('source_page', models.TextField(blank=True, verbose_name='提交页面')), + ('status', models.TextField(choices=[('pending', '待处理'), ('approved', '已通过'), ('rejected', '已驳回'), ('closed', '已关闭')], default='pending', verbose_name='状态')), + ('admin_notes', models.TextField(blank=True, verbose_name='处理备注')), + ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='提交时间')), + ('reviewed_at', models.DateTimeField(blank=True, null=True, verbose_name='处理时间')), + ], + options={ + 'verbose_name': '用户提交', + 'verbose_name_plural': '用户提交', + 'abstract': False, + 'base_manager_name': 'prefetch_manager', + }, + managers=[ + ('objects', django.db.models.manager.Manager()), + ('prefetch_manager', django.db.models.manager.Manager()), + ], + ), + migrations.AddField( + model_name='site', + name='auth_icon', + field=models.ImageField(blank=True, null=True, upload_to='-/sites', verbose_name='登录/注册页图标'), + ), + migrations.AddField( + model_name='site', + name='default_role', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.role', verbose_name='普通注册获得的角色'), + ), + migrations.AddField( + model_name='site', + name='footer_license', + field=models.TextField(blank=True, help_text='留空使用内置文案。支持 wikitext，并且只允许 [[module time]] 这一个模块。', verbose_name='页脚授权说明'), + ), + migrations.AddField( + model_name='site', + name='membership_password', + field=models.TextField(blank=True, verbose_name='入组密码'), + ), + migrations.AddField( + model_name='site', + name='membership_password_enabled', + field=models.BooleanField(default=False, verbose_name='启用密码入组'), + ), + migrations.AddField( + model_name='site', + name='membership_password_role', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.role', verbose_name='密码入组获得的角色'), + ), + migrations.AddField( + model_name='site', + name='signup_notice', + field=models.TextField(blank=True, help_text='留空使用内置文案。显示在注册按钮下方。', verbose_name='注册页提示'), + ), + migrations.AddField( + model_name='site', + name='verified_role', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.role', verbose_name='认证账号获得的角色'), + ), + migrations.AddField( + model_name='userticket', + name='author', + field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='tickets_submitted', to=settings.AUTH_USER_MODEL, verbose_name='提交人'), + ), + migrations.AddField( + model_name='userticket', + name='granted_role', + field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.role', verbose_name='授予的角色'), + ), + migrations.AddField( + model_name='userticket', + name='reviewed_by', + field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='tickets_reviewed', to=settings.AUTH_USER_MODEL, verbose_name='处理人'), + ), + migrations.CreateModel( + name='MembershipApplication', + fields=[ + ], + options={ + 'verbose_name': '申请书', + 'verbose_name_plural': '申请书', + 'abstract': False, + 'proxy': True, + 'base_manager_name': 'prefetch_manager', + 'indexes': [], + 'constraints': [], + }, + bases=('web.userticket',), + managers=[ + ('objects', django.db.models.manager.Manager()), + ('prefetch_manager', django.db.models.manager.Manager()), + ], + ), + migrations.CreateModel( + name='SupportTicket', + fields=[ + ], + options={ + 'verbose_name': '用户工单', + 'verbose_name_plural': '用户工单', + 'abstract': False, + 'proxy': True, + 'base_manager_name': 'prefetch_manager', + 'indexes': [], + 'constraints': [], + }, + bases=('web.userticket',), + managers=[ + ('objects', django.db.models.manager.Manager()), + ('prefetch_manager', django.db.models.manager.Manager()), + ], + ), + migrations.AddIndex( + model_name='userticket', + index=models.Index(fields=['kind', 'status', 'created_at'], name='web_usertic_kind_b5423e_idx'), + ), + migrations.AddIndex( + model_name='userticket', + index=models.Index(fields=['author', 'kind'], name='web_usertic_author__6ccbb3_idx'), + ), + ] diff --git a/web/migrations/0081_assign_ticket_permissions.py b/web/migrations/0081_assign_ticket_permissions.py new file mode 100644 index 00000000..ba273206 --- /dev/null +++ b/web/migrations/0081_assign_ticket_permissions.py @@ -0,0 +1,72 @@ +from django.apps.registry import Apps +from django.db import migrations + + +NEW_PERMISSIONS = { + 'view_user_tickets': '查看用户工单', + 'review_membership_applications': '审核入组申请', + 'manage_permissions': '访问权限表', +} + + +def assign_ticket_permissions(apps: Apps, schema_editor): + ContentType = apps.get_model('contenttypes', 'ContentType') + Permission = apps.get_model('auth', 'Permission') + Role = apps.get_model('web', 'Role') + + content_type, _ = ContentType.objects.get_or_create( + app_label='web', + model='roles', + ) + + created = {} + for codename, name in NEW_PERMISSIONS.items(): + created[codename], _ = Permission.objects.get_or_create( + codename=codename, + content_type=content_type, + defaults={'name': name}, + ) + + view_reports = Permission.objects.filter( + codename='view_user_reports', content_type=content_type, + ).first() + if view_reports: + for role in Role.objects.filter(permissions=view_reports): + role.permissions.add(created['view_user_tickets']) + role.permissions.add(created['review_membership_applications']) + + # 在这条迁移之前，改权限的门是「管理角色」；不给这些角色补上「访问权限表」， + # 升级之后他们会突然失去一项本来就有的能力。 + manage_roles = Permission.objects.filter( + codename='manage_roles', content_type=content_type, + ).first() + if manage_roles: + for role in Role.objects.filter(permissions=manage_roles): + role.permissions.add(created['manage_permissions']) + + +def remove_permissions(apps: Apps, schema_editor): + ContentType = apps.get_model('contenttypes', 'ContentType') + Permission = apps.get_model('auth', 'Permission') + + content_type = ContentType.objects.filter( + app_label='web', model='roles', + ).first() + if not content_type: + return + + Permission.objects.filter( + codename__in=list(NEW_PERMISSIONS), + content_type=content_type, + ).delete() + + +class Migration(migrations.Migration): + + dependencies = [ + ('web', '0080_user_tickets_and_site_membership_options'), + ] + + operations = [ + migrations.RunPython(assign_ticket_permissions, remove_permissions, atomic=True), + ] diff --git a/web/migrations/0082_invite_links.py b/web/migrations/0082_invite_links.py new file mode 100644 index 00000000..dc06bbc3 --- /dev/null +++ b/web/migrations/0082_invite_links.py @@ -0,0 +1,59 @@ +import auto_prefetch +import django.db.models.deletion +import django.db.models.manager +from django.conf import settings +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('web', '0081_assign_ticket_permissions'), + ] + + operations = [ + migrations.CreateModel( + name='InviteLink', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('kind', models.TextField(choices=[('register', '邀请注册'), ('claim', '认领')], default='register', verbose_name='类型')), + ('delivery', models.TextField(choices=[('link', '手动发链接'), ('email', '邮件发送')], default='link', verbose_name='发放方式')), + ('email', models.TextField(blank=True, verbose_name='邮箱')), + ('wikidot_username', models.TextField(blank=True, verbose_name='Wikidot 用户名')), + ('token', models.TextField(verbose_name='令牌')), + ('uidb64', models.TextField(verbose_name='账号编码')), + ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='创建时间')), + ('activated_at', models.DateTimeField(blank=True, null=True, verbose_name='激活时间')), + ('activated_username', models.TextField(blank=True, verbose_name='激活后用户名')), + ], + options={ + 'verbose_name': '邀请链接', + 'verbose_name_plural': '邀请链接', + 'ordering': ['-created_at'], + 'abstract': False, + 'base_manager_name': 'prefetch_manager', + }, + managers=[ + ('objects', django.db.models.manager.Manager()), + ('prefetch_manager', django.db.models.manager.Manager()), + ], + ), + migrations.AddField( + model_name='invitelink', + name='created_by', + field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='invite_links_created', to=settings.AUTH_USER_MODEL, verbose_name='创建人'), + ), + migrations.AddField( + model_name='invitelink', + name='target', + field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='invite_links', to=settings.AUTH_USER_MODEL, verbose_name='目标账号'), + ), + migrations.AddIndex( + model_name='invitelink', + index=models.Index(fields=['kind', 'activated_at'], name='web_invitel_kind_bfa536_idx'), + ), + migrations.AddIndex( + model_name='invitelink', + index=models.Index(fields=['token'], name='web_invitel_token_4bbe08_idx'), + ), + ] diff --git a/web/models/__init__.py b/web/models/__init__.py index 7981d6f6..4bc6b2c6 100644 --- a/web/models/__init__.py +++ b/web/models/__init__.py @@ -2,11 +2,13 @@ from .articles import * from .files import * from .forum import * +from .invites import * from .logs import * from .messages import * from .reports import * from .settings import * from .site import * +from .tickets import * from .users import * from .search import * from .roles import * diff --git a/web/models/invites.py b/web/models/invites.py new file mode 100644 index 00000000..e6368854 --- /dev/null +++ b/web/models/invites.py @@ -0,0 +1,72 @@ +__all__ = [ + 'InviteLink', +] + +import auto_prefetch + +from django.contrib.auth import get_user_model +from django.db import models + + +User = get_user_model() + + +class InviteLink(auto_prefetch.Model): + class Meta(auto_prefetch.Model.Meta): + verbose_name = '邀请链接' + verbose_name_plural = '邀请链接' + ordering = ['-created_at'] + indexes = [ + models.Index(fields=['kind', 'activated_at']), + models.Index(fields=['token']), + ] + + class Kind(models.TextChoices): + Register = ('register', '邀请注册') + Claim = ('claim', '认领') + + class Delivery(models.TextChoices): + Link = ('link', '手动发链接') + Email = ('email', '邮件发送') + + kind = models.TextField('类型', choices=Kind.choices, default=Kind.Register, null=False, blank=False) + delivery = models.TextField('发放方式', choices=Delivery.choices, default=Delivery.Link, null=False, blank=False) + + target = auto_prefetch.ForeignKey( + User, on_delete=models.SET_NULL, null=True, blank=True, + verbose_name='目标账号', related_name='invite_links', + ) + # 目标账号可能被删掉，而这一行还要说得清它当初是发给谁的。 + email = models.TextField('邮箱', blank=True) + wikidot_username = models.TextField('Wikidot 用户名', blank=True) + + token = models.TextField('令牌', null=False, blank=False) + uidb64 = models.TextField('账号编码', null=False, blank=False) + + created_at = models.DateTimeField('创建时间', auto_now_add=True, null=False, blank=False) + created_by = auto_prefetch.ForeignKey( + User, on_delete=models.SET_NULL, null=True, blank=True, + verbose_name='创建人', related_name='invite_links_created', + ) + + activated_at = models.DateTimeField('激活时间', null=True, blank=True) + activated_username = models.TextField('激活后用户名', blank=True) + + @property + def path(self): + return '/-/accept/%s/%s' % (self.uidb64, self.token) + + @property + def is_activated(self): + return self.activated_at is not None + + # 记的是身份用户名而不是 __str__ 的显示名，因为这一列的用处是回头去找那个账号。 + @classmethod + def mark_activated(cls, token, user, when): + cls.objects.filter(token=token, activated_at__isnull=True).update( + activated_at=when, + activated_username=user.username, + ) + + def __str__(self): + return '#%s %s → %s' % (self.pk, self.get_kind_display(), self.email or self.wikidot_username or self.target) diff --git a/web/models/site.py b/web/models/site.py index cb178923..218c80a5 100644 --- a/web/models/site.py +++ b/web/models/site.py @@ -102,6 +102,32 @@ class Meta(SingletonModel.Meta): on_delete=models.SET_NULL, related_name='+', ) + auth_icon = models.ImageField('登录/注册页图标', null=True, blank=True, upload_to='-/sites') + footer_license = models.TextField( + '页脚授权说明', blank=True, + help_text='留空使用内置文案。支持 wikitext，并且只允许 [[module time]] 这一个模块。', + ) + signup_notice = models.TextField( + '注册页提示', blank=True, + help_text='留空使用内置文案。显示在注册按钮下方。', + ) + + default_role = models.ForeignKey( + 'Role', verbose_name='普通注册获得的角色', null=True, blank=True, + on_delete=models.SET_NULL, related_name='+', + ) + verified_role = models.ForeignKey( + 'Role', verbose_name='认证账号获得的角色', null=True, blank=True, + on_delete=models.SET_NULL, related_name='+', + ) + + membership_password_enabled = models.BooleanField('启用密码入组', default=False, null=False) + membership_password = models.TextField('入组密码', blank=True) + membership_password_role = models.ForeignKey( + 'Role', verbose_name='密码入组获得的角色', null=True, blank=True, + on_delete=models.SET_NULL, related_name='+', + ) + @cached_property def settings(self): return Settings.objects.filter(site=self).first() or Settings.get_default_settings() diff --git a/web/models/tickets.py b/web/models/tickets.py new file mode 100644 index 00000000..2d61005d --- /dev/null +++ b/web/models/tickets.py @@ -0,0 +1,91 @@ +__all__ = [ + 'UserTicket', + 'SupportTicket', + 'MembershipApplication', +] + +import auto_prefetch + +from django.contrib.auth import get_user_model +from django.db import models + +from .roles import Role + + +User = get_user_model() + + +class UserTicket(auto_prefetch.Model): + class Meta(auto_prefetch.Model.Meta): + verbose_name = '用户提交' + verbose_name_plural = '用户提交' + indexes = [ + models.Index(fields=['kind', 'status', 'created_at']), + models.Index(fields=['author', 'kind']), + ] + + class Kind(models.TextChoices): + Ticket = ('ticket', '工单') + MembershipApply = ('membershipapply', '入组申请') + + class Status(models.TextChoices): + Pending = ('pending', '待处理') + Approved = ('approved', '已通过') + Rejected = ('rejected', '已驳回') + Closed = ('closed', '已关闭') + + kind = models.TextField('类型', choices=Kind.choices, default=Kind.Ticket, null=False, blank=False) + author = auto_prefetch.ForeignKey( + User, on_delete=models.SET_NULL, null=True, blank=True, + verbose_name='提交人', related_name='tickets_submitted', + ) + subject = models.TextField('标题', blank=True) + body = models.TextField('正文', blank=False, null=False) + source_page = models.TextField('提交页面', blank=True) + + status = models.TextField( + '状态', choices=Status.choices, default=Status.Pending, null=False, blank=False, + ) + granted_role = auto_prefetch.ForeignKey( + Role, on_delete=models.SET_NULL, null=True, blank=True, + verbose_name='授予的角色', related_name='+', + ) + admin_notes = models.TextField('处理备注', blank=True) + + created_at = models.DateTimeField('提交时间', auto_now_add=True, null=False, blank=False) + reviewed_at = models.DateTimeField('处理时间', null=True, blank=True) + reviewed_by = auto_prefetch.ForeignKey( + User, on_delete=models.SET_NULL, null=True, blank=True, + verbose_name='处理人', related_name='tickets_reviewed', + ) + + def __str__(self): + return f'#{self.pk} {self.author or "(已删除)"} {self.subject or self.get_kind_display()}' + + +class SupportTicketManager(auto_prefetch.Manager): + def get_queryset(self): + return super().get_queryset().filter(kind=UserTicket.Kind.Ticket) + + +class SupportTicket(UserTicket): + class Meta(auto_prefetch.Model.Meta): + proxy = True + verbose_name = '用户工单' + verbose_name_plural = '用户工单' + + objects = SupportTicketManager() + + +class MembershipApplicationManager(auto_prefetch.Manager): + def get_queryset(self): + return super().get_queryset().filter(kind=UserTicket.Kind.MembershipApply) + + +class MembershipApplication(UserTicket): + class Meta(auto_prefetch.Model.Meta): + proxy = True + verbose_name = '申请书' + verbose_name_plural = '申请书' + + objects = MembershipApplicationManager() diff --git a/web/permissions/__init__.py b/web/permissions/__init__.py index b86e4a44..7692976d 100644 --- a/web/permissions/__init__.py +++ b/web/permissions/__init__.py @@ -79,6 +79,7 @@ def register_role_permissions(): import web.permissions.articles import web.permissions.messages import web.permissions.reports + import web.permissions.tickets # Temporary disabled because paws # _preload_role_permissions() diff --git a/web/permissions/admin.py b/web/permissions/admin.py index 190ac164..4b8a3185 100644 --- a/web/permissions/admin.py +++ b/web/permissions/admin.py @@ -9,7 +9,7 @@ class ManageUsersPermission(BaseRolePermission): name = '管理用户' codename = 'manage_users' description = '允许创建和编辑用户' - represent_django_perms = ['web.view_user', 'web.add_user', 'web.change_user'] + represent_django_perms = ['web.view_user', 'web.add_user', 'web.change_user', 'web.view_invitelink', 'web.delete_invitelink'] group = '管理后台' admin_only = True @@ -89,4 +89,12 @@ class ManageUpdatesPermission(BaseRolePermission): codename = 'manage_updates' description = '允许查看 GitHub 版本更新并从后台执行更新' group = '管理后台' - admin_only = True \ No newline at end of file + admin_only = True + + +class ManagePermissionsPermission(BaseRolePermission): + name = '访问权限表' + codename = 'manage_permissions' + description = '允许修改角色的权限勾选，以及给用户分配角色。没有这一项的人即使能编辑用户，也改不了权限' + group = '管理后台' + admin_only = True diff --git a/web/permissions/tickets.py b/web/permissions/tickets.py new file mode 100644 index 00000000..696ae32d --- /dev/null +++ b/web/permissions/tickets.py @@ -0,0 +1,22 @@ +from web.permissions import BaseRolePermission + + +def is_perms_collection(): + return True + + +class ViewUserTicketsPermission(BaseRolePermission): + name = '查看用户工单' + codename = 'view_user_tickets' + description = '允许查看用户通过表单提交的工单' + represent_django_perms = ['web.view_userticket', 'web.change_userticket'] + group = '工单管理' + admin_only = True + + +class ReviewMembershipApplicationsPermission(BaseRolePermission): + name = '审核入组申请' + codename = 'review_membership_applications' + description = '允许审核入组申请，并决定授予申请人哪个角色' + group = '工单管理' + admin_only = True From 73e34ade8c5542257835a487116c136304f3f40f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 21:45:28 +0900 Subject: [PATCH 129/428] answer tickets, applications and invite links in the admin --- web/admin.py | 221 +++++++++++++++++- web/forms.py | 19 ++ web/templates/admin/web/user/change_list.html | 2 + web/templatetags/admin_side_menu.py | 3 + web/views/invite.py | 151 ++++++++---- 5 files changed, 345 insertions(+), 51 deletions(-) diff --git a/web/admin.py b/web/admin.py index 5fe630cc..32dbe42c 100644 --- a/web/admin.py +++ b/web/admin.py @@ -8,7 +8,7 @@ from django.contrib.auth.admin import UserAdmin from django.contrib.auth.forms import UserChangeForm from django.contrib import admin -from django.urls import path +from django.urls import path, resolve from django.utils import timezone from django.utils.html import format_html, format_html_join from django import forms @@ -19,7 +19,9 @@ from .models import * from .fields import CITextField from .views.invite import InviteView +from .views.invite import GenerateClaimLinkView from .views.invite import GenerateInviteLinkView +from .views.invite import invite_url from .views.bot import CreateBotView from .views.reset_votes import ResetUserVotesView from .controllers import logging @@ -202,7 +204,28 @@ class Meta: class SiteAdmin(SingletonModelAdmin): form = SiteForm inlines = [SettingsAdmin] - fields = ['slug', 'title', 'headline', 'domain', 'media_domain', 'home_page', 'active_theme'] + fieldsets = ( + (None, { + 'fields': ('slug', 'title', 'headline', 'domain', 'media_domain', 'home_page', 'active_theme') + }), + ('外观', { + 'fields': ('icon', 'auth_icon', 'footer_license') + }), + ('注册与入组', { + 'fields': ('signup_notice', 'default_role', 'verified_role', + 'membership_password_enabled', 'membership_password', 'membership_password_role') + }), + ) + + def get_readonly_fields(self, request, obj=None): + readonly_fields = super().get_readonly_fields(request, obj) + # 这几项决定谁能自动拿到哪个角色，等同于发权限，所以跟着权限表那道门走。 + if not request.user.has_perm('roles.manage_permissions'): + readonly_fields = list(readonly_fields) + [ + 'default_role', 'verified_role', + 'membership_password_enabled', 'membership_password', 'membership_password_role', + ] + return readonly_fields def save_model(self, request, obj, form, change): super().save_model(request, obj, form, change) @@ -304,6 +327,7 @@ def get_urls(self): new_urls = [ path('invite/', InviteView.as_view()), path('generate-link/', GenerateInviteLinkView.as_view()), + path('claim-link/', GenerateClaimLinkView.as_view()), path('newbot/', CreateBotView.as_view()), path('/activate/', InviteView.as_view()), path('/reset_votes/', ResetUserVotesView.as_view()), @@ -338,9 +362,25 @@ def get_queryset(self, request): ).order_by('username_or_wd') def formfield_for_manytomany(self, db_field, request, **kwargs): - if db_field.name == 'roles' and not request.user.has_perm('roles.manage_roles'): + if db_field.name == 'roles' and not self._may_set_roles(request, self._editing(request)): kwargs['disabled'] = True return super().formfield_for_manytomany(db_field, request, **kwargs) + + # 发角色就是发权限，所以这道门是「访问权限表」而不是「管理用户」—— + # 否则一个只被勾了「管理用户」的人可以给自己加任意角色。 + def _may_set_roles(self, request, obj=None): + if request.user.is_superuser: + return True + if obj is not None and obj.is_superuser: + return False + return request.user.has_perm('roles.manage_permissions') + + # formfield_for_manytomany 拿不到正在编辑的对象，只能从 URL 里认。 + def _editing(self, request): + object_id = resolve(request.path_info).kwargs.get('object_id') + if not object_id: + return None + return self.get_object(request, object_id) def has_change_permission(self, request, obj=None): if obj and not request.user.is_superuser and obj.operation_index <= request.user.operation_index: @@ -353,7 +393,7 @@ def save_model(self, request, obj, form, change): if change: if not request.user.is_superuser: obj.is_superuser = target.is_superuser - if not request.user.has_perm('roles.manage_roles'): + if not self._may_set_roles(request, target): obj.roles.set(target.roles.all()) super().save_model(request, obj, form, change) @@ -516,9 +556,12 @@ def has_change_permission(self, request, obj=None): return super().has_change_permission(request, obj) def get_readonly_fields(self, request, obj=None): - if obj and obj.slug in ['everyone', 'registered']: - return self.readonly_fields + ("slug",) - return self.readonly_fields + readonly_fields = self.readonly_fields + if obj and obj.slug in ['everyone', 'registered']: + readonly_fields = readonly_fields + ("slug",) + if not request.user.is_superuser and not request.user.has_perm('roles.manage_permissions'): + readonly_fields = readonly_fields + ("_perms_",) + return readonly_fields class UserReportForm(forms.ModelForm): @@ -611,3 +654,167 @@ def save_model(self, request, obj, form, change): obj.reviewed_at = timezone.now() obj.reviewed_by = request.user super().save_model(request, obj, form, change) + + +class UserTicketAdmin(admin.ModelAdmin): + kind = None + review_permission = None + + list_display = ['id', 'author_display', 'subject_display', 'status', 'source_page', 'created_at'] + list_filter = ['status', 'created_at'] + search_fields = ['subject', 'body', 'author__username', 'admin_notes'] + readonly_fields = ['author_display', 'subject_display', 'body_preview', 'source_page', 'created_at', 'reviewed_at', 'reviewed_by'] + + @admin.display(description='提交人') + def author_display(self, obj): + if obj.author is None: + return '(已删除)' + return obj.author + + # 表单可以关掉标题栏，所以列表要有个不空的东西可显示。 + @admin.display(description='标题', ordering='subject') + def subject_display(self, obj): + if obj.subject: + return obj.subject + body = (obj.body or '').strip().splitlines() + first = body[0] if body else '' + return (first[:40] + '…') if len(first) > 40 else (first or '(无标题)') + + @admin.display(description='正文') + def body_preview(self, obj): + return format_html( + '
{}
', + obj.body, + ) + + def get_queryset(self, request): + return super().get_queryset(request).filter(kind=self.kind) + + def has_add_permission(self, request): + return False + + def has_delete_permission(self, request, obj=None): + return False + + def has_view_permission(self, request, obj=None): + if request.user.is_superuser: + return True + return request.user.has_perm('roles.view_user_tickets') + + def has_change_permission(self, request, obj=None): + if request.user.is_superuser: + return True + return request.user.has_perm(self.review_permission) + + def save_model(self, request, obj, form, change): + if change and 'status' in form.changed_data: + obj.reviewed_at = timezone.now() + obj.reviewed_by = request.user + super().save_model(request, obj, form, change) + + +class SupportTicketForm(forms.ModelForm): + class Meta: + model = SupportTicket + fields = ['status', 'admin_notes'] + + +@admin.register(SupportTicket) +class SupportTicketAdmin(UserTicketAdmin): + form = SupportTicketForm + kind = UserTicket.Kind.Ticket + review_permission = 'roles.view_user_tickets' + fieldsets = ( + ('工单内容', { + 'fields': ('author_display', 'subject_display', 'created_at', 'source_page', 'body_preview'), + }), + ('管理员操作', { + 'fields': ('status', 'admin_notes', 'reviewed_at', 'reviewed_by'), + }), + ) + + +class MembershipApplicationForm(forms.ModelForm): + class Meta: + model = MembershipApplication + fields = ['status', 'granted_role', 'admin_notes'] + + +@admin.register(MembershipApplication) +class MembershipApplicationAdmin(UserTicketAdmin): + form = MembershipApplicationForm + kind = UserTicket.Kind.MembershipApply + review_permission = 'roles.review_membership_applications' + list_display = ['id', 'author_display', 'subject_display', 'status', 'granted_role', 'created_at'] + list_filter = ['status', 'granted_role', 'created_at'] + fieldsets = ( + ('申请内容', { + 'fields': ('author_display', 'subject_display', 'created_at', 'source_page', 'body_preview'), + }), + ('管理员操作', { + 'fields': ('status', 'granted_role', 'admin_notes', 'reviewed_at', 'reviewed_by'), + }), + ) + + def save_model(self, request, obj, form, change): + super().save_model(request, obj, form, change) + # 通过就当场把角色发下去，否则管理员还得再去用户页点一次，两处状态就会对不上。 + if obj.status == UserTicket.Status.Approved and obj.granted_role and obj.author: + obj.author.roles.add(obj.granted_role) + + +@admin.register(InviteLink) +class InviteLinkAdmin(admin.ModelAdmin): + list_display = ['id', 'kind', 'delivery', 'recipient', 'state', 'activated_username', 'created_by', 'created_at', 'activated_at'] + list_filter = ['kind', 'delivery', 'created_at'] + search_fields = ['email', 'wikidot_username', 'activated_username', 'token'] + readonly_fields = [ + 'kind', 'delivery', 'recipient', 'state', 'link', 'target', + 'created_by', 'created_at', 'activated_username', 'activated_at', + ] + fieldsets = ( + ('链接', { + 'fields': ('kind', 'delivery', 'recipient', 'link'), + }), + ('状态', { + 'fields': ('state', 'activated_username', 'activated_at'), + }), + ('来源', { + 'fields': ('target', 'created_by', 'created_at'), + }), + ) + + @admin.display(description='发给谁') + def recipient(self, obj): + return obj.email or obj.wikidot_username or obj.target or '(已删除)' + + @admin.display(description='是否激活', boolean=True, ordering='activated_at') + def state(self, obj): + return obj.is_activated + + # 链接只有完整可复制才有用，所以这里给出带域名的那一份而不是路径。 + @admin.display(description='链接') + def link(self, obj): + url = invite_url(self.request, obj) if getattr(self, 'request', None) else obj.path + return format_html('', url) + + def get_queryset(self, request): + self.request = request + return super().get_queryset(request) + + def has_add_permission(self, request): + return False + + def has_view_permission(self, request, obj=None): + if request.user.is_superuser: + return True + return request.user.has_perm('roles.manage_users') + + def has_change_permission(self, request, obj=None): + return False + + def has_delete_permission(self, request, obj=None): + if request.user.is_superuser: + return True + return request.user.has_perm('roles.manage_users') diff --git a/web/forms.py b/web/forms.py index 68c2abf1..fb771009 100644 --- a/web/forms.py +++ b/web/forms.py @@ -38,6 +38,25 @@ class InviteForm(forms.Form): roles = forms.ModelMultipleChoiceField(label='用户组权限', queryset=Role.objects.exclude(slug__in=['everyone', 'registered']), required=False) +class ClaimLinkForm(forms.Form): + user = forms.ModelChoiceField( + label='待认领的 Wikidot 账号', + queryset=User.objects.none(), + required=True, + ) + roles = forms.ModelMultipleChoiceField( + label='认领后获得的用户组', + queryset=Role.objects.exclude(slug__in=['everyone', 'registered']), + required=False, + ) + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.fields['user'].queryset = User.objects.filter( + type=User.UserType.Wikidot, is_active=False, + ).order_by('wikidot_username') + + class CreateAccountForm(forms.Form): username = forms.CharField(label='用户名', required=True, validators=[RegexValidator(r'^[A-Za-z0-9_-]+$', '用户名格式无效')]) password = forms.CharField(label='密码', widget=forms.PasswordInput(), required=True) diff --git a/web/templates/admin/web/user/change_list.html b/web/templates/admin/web/user/change_list.html index 47affebd..54f7d5ef 100644 --- a/web/templates/admin/web/user/change_list.html +++ b/web/templates/admin/web/user/change_list.html @@ -1,6 +1,8 @@ {% extends "admin/change_list.html" %} {% block object-tools-items %} {{ block.super }} + 邀请链接记录 + 创建认领链接 创建邀请链接 创建机器人 邀请用户 diff --git a/web/templatetags/admin_side_menu.py b/web/templatetags/admin_side_menu.py index 1235fd3d..202aa06b 100644 --- a/web/templatetags/admin_side_menu.py +++ b/web/templatetags/admin_side_menu.py @@ -24,6 +24,7 @@ def get_side_menu(context: Context, using: str = "available_apps") -> list[dict] {'model': models.roles.RoleCategory}, {'model': models.roles.Role}, {'model': models.users.User}, + {'model': models.invites.InviteLink}, )), ('活动记录', ( {'model': models.logs.ActionLogEntry}, @@ -46,6 +47,8 @@ def get_side_menu(context: Context, using: str = "available_apps") -> list[dict] )), ('工单管理', ( {'model': models.reports.UserReport}, + {'model': models.tickets.SupportTicket}, + {'model': models.tickets.MembershipApplication}, )), ) diff --git a/web/views/invite.py b/web/views/invite.py index 332f9281..5d7569e2 100644 --- a/web/views/invite.py +++ b/web/views/invite.py @@ -12,7 +12,8 @@ from django.contrib.admin import site from django.contrib import messages -from web.forms import InviteForm +from web.forms import ClaimLinkForm, InviteForm +from web.models.invites import InviteLink from web.models.site import get_current_site @@ -89,6 +90,12 @@ def form_valid(self, form): content = render_to_string(self.email_template_name, c) try: send_mail(subject, content, None, [user.email], fail_silently=False) + record_invite_link( + self.request, user, + kind=InviteLink.Kind.Claim if user.type == User.UserType.Wikidot else InviteLink.Kind.Register, + delivery=InviteLink.Delivery.Email, + token=c['token'], uidb64=c['uid'], + ) messages.success(self.request, "邀请已成功发送") except BadHeaderError: messages.error(self.request, "邮件头格式错误") @@ -96,47 +103,103 @@ def form_valid(self, form): messages.error(self.request, "此邮箱已被站点成员使用") return redirect(self.get_success_url()) -@method_decorator(staff_member_required, name='dispatch') -class GenerateInviteLinkView(FormView): - form_class = InviteForm - template_name = "admin/web/user/user_action.html" - - def get_context_data(self, **kwargs): - context = super().get_context_data(**kwargs) - context["title"] = "生成邀请链接" - context["submit_btn"] = "生成链接" - context.update(site.each_context(self.request)) - return context - - def get_success_url(self): - return resolve_url("admin:index") - - def form_valid(self, form): - email = form.cleaned_data['email'] - roles = form.cleaned_data['roles'] - - try: - user, created = User.objects.get_or_create(email=email) - if not created: - messages.error(self.request, "该邮箱已被站点成员使用") - return redirect(self.get_success_url()) - - # 设置用户 - user.roles.set(roles) - user.is_active = False - user.username = f'user-{user.id}' - user.email = email - user.save() - - # 生成令牌和链接 - token = account_activation_token.make_token(user) - uid = urlsafe_base64_encode(force_bytes(user.pk)) - site = get_current_site() - invitation_url = f"{self.request.scheme}://{site.domain}/-/accept/{uid}/{token}" - - messages.success(self.request, f"邀请链接已生成: {invitation_url}") - - except IntegrityError: - messages.error(self.request, "创建用户失败") - + + +def record_invite_link(request, user, kind, delivery, token, uidb64): + return InviteLink.objects.create( + kind=kind, + delivery=delivery, + target=user, + email=user.email or '', + wikidot_username=user.wikidot_username or '', + token=token, + uidb64=uidb64, + created_by=request.user if request.user.is_authenticated else None, + ) + + +def invite_url(request, link): + site = get_current_site() + host = site.domain if site else request.get_host() + return '%s://%s%s' % (request.scheme, host, link.path) + + +@method_decorator(staff_member_required, name='dispatch') +class GenerateInviteLinkView(FormView): + form_class = InviteForm + template_name = "admin/web/user/user_action.html" + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context["title"] = "创建邀请链接" + context["submit_btn"] = "生成链接" + context.update(site.each_context(self.request)) + return context + + # 链接以前只活在一条一刷新就没的提示里，现在落进表，所以生成完直接送到那张表上。 + def get_success_url(self): + return resolve_url("admin:web_invitelink_changelist") + + def form_valid(self, form): + email = form.cleaned_data['email'] + roles = form.cleaned_data['roles'] + + try: + user, created = User.objects.get_or_create(email=email) + if not created: + messages.error(self.request, "该邮箱已被站点成员使用") + return redirect(resolve_url("admin:index")) + + user.roles.set(roles) + user.is_active = False + user.username = f'user-{user.id}' + user.email = email + user.save() + + link = record_invite_link( + self.request, user, + kind=InviteLink.Kind.Register, + delivery=InviteLink.Delivery.Link, + token=account_activation_token.make_token(user), + uidb64=urlsafe_base64_encode(force_bytes(user.pk)), + ) + messages.success(self.request, "邀请链接已生成：%s" % invite_url(self.request, link)) + + except IntegrityError: + messages.error(self.request, "创建用户失败") + return redirect(resolve_url("admin:index")) + + return redirect(self.get_success_url()) + + +@method_decorator(staff_member_required, name='dispatch') +class GenerateClaimLinkView(FormView): + form_class = ClaimLinkForm + template_name = "admin/web/user/user_action.html" + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + context["title"] = "创建认领链接" + context["submit_btn"] = "生成链接" + context["after_text"] = "只列出尚未被认领的 Wikidot 账号。认领后账号会转为普通账号，用户名沿用原 Wikidot 用户名。" + context.update(site.each_context(self.request)) + return context + + def get_success_url(self): + return resolve_url("admin:web_invitelink_changelist") + + def form_valid(self, form): + user = form.cleaned_data['user'] + roles = form.cleaned_data['roles'] + if roles: + user.roles.set(roles) + + link = record_invite_link( + self.request, user, + kind=InviteLink.Kind.Claim, + delivery=InviteLink.Delivery.Link, + token=account_activation_token.make_token(user), + uidb64=urlsafe_base64_encode(force_bytes(user.pk)), + ) + messages.success(self.request, "认领链接已生成：%s" % invite_url(self.request, link)) return redirect(self.get_success_url()) From 34222b813ea7ae9ddd6d84bfc6ffe0d0ceea5653 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 21:45:34 +0900 Subject: [PATCH 130/428] let the site set its own icons, notice and signup roles --- web/context_processors.py | 12 ++++++++++++ web/templates/login/login.html | 2 +- web/templates/profile/user.html | 2 +- web/templates/signup/register.html | 4 ++-- web/views/signup.py | 22 ++++++++++++++++++++-- wikitgo/settings.py | 1 + 6 files changed, 37 insertions(+), 6 deletions(-) create mode 100644 web/context_processors.py diff --git a/web/context_processors.py b/web/context_processors.py new file mode 100644 index 00000000..9abc39ce --- /dev/null +++ b/web/context_processors.py @@ -0,0 +1,12 @@ +from web.models.site import get_current_site + + +def site_branding(request): + site = get_current_site() + if site is None: + return {} + return { + 'site_auth_icon': '/local--files/%s' % site.auth_icon if site.auth_icon else '', + 'site_icon': '/local--files/%s' % site.icon if site.icon else '', + 'site_signup_notice': site.signup_notice, + } diff --git a/web/templates/login/login.html b/web/templates/login/login.html index 5d10fd6b..e16d19c4 100644 --- a/web/templates/login/login.html +++ b/web/templates/login/login.html @@ -13,7 +13,7 @@ {% csrf_token %}
- ProjectWikit + {% if site_auth_icon %}{{ site_title|default:{% else %}ProjectWikit{% endif %}
diff --git a/web/templates/profile/user.html b/web/templates/profile/user.html index 2e7a5208..47b999c0 100644 --- a/web/templates/profile/user.html +++ b/web/templates/profile/user.html @@ -12,7 +12,7 @@
- ProjectWikit + {% if site_auth_icon %}{{ site_title|default:{% else %}ProjectWikit{% endif %} ProjectWikit diff --git a/web/templates/signup/register.html b/web/templates/signup/register.html index ebafeac9..bcec876b 100644 --- a/web/templates/signup/register.html +++ b/web/templates/signup/register.html @@ -13,7 +13,7 @@ {% csrf_token %}
- ProjectWikit + {% if site_auth_icon %}{{ site_title|default:{% else %}ProjectWikit{% endif %}
@@ -60,7 +60,7 @@

创建账号

- 普通注册默认分配「读者」权限 + {{ site_signup_notice|default:"普通注册默认分配「读者」权限" }} 已有账号 → 登录
diff --git a/web/views/signup.py b/web/views/signup.py index f9aa9a2b..f287c75d 100644 --- a/web/views/signup.py +++ b/web/views/signup.py @@ -3,6 +3,7 @@ from django.contrib.auth.models import AbstractUser as _UserType from django.utils.http import urlsafe_base64_decode from django.utils.encoding import force_str +from django.utils import timezone from django.contrib.auth import get_user_model from django.http import HttpRequest, HttpResponseRedirect, JsonResponse from django.contrib.auth import login @@ -28,7 +29,9 @@ from .invite import account_activation_token from web.events import EventBase from django.shortcuts import redirect +from web.models.invites import InviteLink from web.models.roles import Role +from web.models.site import get_current_site User = get_user_model() @@ -126,6 +129,7 @@ def post(self, request, *args, **kwargs): user.is_active = True user.save() UsedToken.mark_used(self.kwargs['token'], is_case_sensitive=True) + InviteLink.mark_activated(self.kwargs['token'], user, timezone.now()) login(request, user, backend='django.contrib.auth.backends.ModelBackend') OnUserSignUp(request, user).emit() return HttpResponseRedirect(redirect_to=settings.LOGIN_REDIRECT_URL) @@ -277,6 +281,10 @@ def post(self, request, *args, **kwargs): request.session.pop(WD_VERIFY_NAME_KEY, None) request.session.pop(WD_VERIFY_FOR_KEY, None) + verified_role = _signup_role('verified_role') + if verified_role: + wikidot_user.roles.add(verified_role) + login(request, wikidot_user, backend='django.contrib.auth.backends.ModelBackend') OnUserSignUp(request, wikidot_user).emit() return redirect('/') @@ -298,8 +306,9 @@ def post(self, request, *args, **kwargs): user.username = allocate_fallback_username(user.pk) if display: user.display_name = display - reader_role = Role.objects.get(slug='reader') - user.roles.add(reader_role) + default_role = _signup_role('default_role') + if default_role: + user.roles.add(default_role) user.set_password(password) user.is_active = True user.save() @@ -307,3 +316,12 @@ def post(self, request, *args, **kwargs): login(request, user, backend='django.contrib.auth.backends.ModelBackend') OnUserSignUp(request, user).emit() return redirect('/') + + +# 站点没配就回落到 reader，而 reader 也可能不存在（全新站点），所以两层都不能硬取。 +def _signup_role(field): + site = get_current_site() + role = getattr(site, field, None) if site else None + if role is not None: + return role + return Role.objects.filter(slug='reader').first() diff --git a/wikitgo/settings.py b/wikitgo/settings.py index 83644369..6f07315b 100644 --- a/wikitgo/settings.py +++ b/wikitgo/settings.py @@ -86,6 +86,7 @@ 'django.template.context_processors.request', 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', + 'web.context_processors.site_branding', ], }, }, From 4a02357f8ae05b9144abcfe59e922c718359a117 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 21:53:23 +0900 Subject: [PATCH 131/428] add the queries and the render state the new modules need --- internal/db/member.go | 90 ++++++++++++++++++++++++++++ internal/db/member_test.go | 117 +++++++++++++++++++++++++++++++++++++ internal/db/site.go | 16 ++++- internal/module/module.go | 32 ++++++++-- internal/page/context.go | 9 +++ internal/repo/modules.go | 12 ++++ 6 files changed, 269 insertions(+), 7 deletions(-) create mode 100644 internal/db/member.go create mode 100644 internal/db/member_test.go diff --git a/internal/db/member.go b/internal/db/member.go new file mode 100644 index 00000000..5a034232 --- /dev/null +++ b/internal/db/member.go @@ -0,0 +1,90 @@ +package db + +import ( + "context" + "errors" + "fmt" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/jackc/pgx/v5" +) + +type Member struct { + User + JoinedAt time.Time +} + +// A null role means every account, so one statement covers both the filtered +// and the unfiltered listing rather than two that can drift apart. +const memberFilter = ` +WHERE $1::bigint IS NULL + OR EXISTS (SELECT 1 FROM web_user_roles ur WHERE ur.user_id = u.id AND ur.role_id = $1)` + +var qMembers = register("Members", ` +SELECT `+prefixed("u", userColumns)+`, u.date_joined +FROM web_user u`+memberFilter+` +ORDER BY u.id +OFFSET $2 +LIMIT $3`) + +var qMemberCount = register("MemberCount", ` +SELECT count(*) +FROM web_user u`+memberFilter) + +func (d *DB) Members(ctx context.Context, roleID *int64, offset, limit int) ([]Member, error) { + rows, err := d.pool.Query(ctx, qMembers, roleID, offset, limit) + if err != nil { + return nil, fmt.Errorf("list members: %w", err) + } + defer rows.Close() + + var out []Member + for rows.Next() { + var m Member + dest, finish := userDest(&m.User) + if err := rows.Scan(append(dest, &m.JoinedAt)...); err != nil { + return nil, fmt.Errorf("scan member: %w", err) + } + finish() + out = append(out, m) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("list members: %w", err) + } + return out, nil +} + +func (d *DB) MemberCount(ctx context.Context, roleID *int64) (int, error) { + var total int + if err := d.pool.QueryRow(ctx, qMemberCount, roleID).Scan(&total); err != nil { + return 0, fmt.Errorf("count members: %w", err) + } + return total, nil +} + +var qRoleByRef = register("RoleByRef", ` +SELECT r.id, r.slug, r.name, r.short_name, r.category_id, r.index, + r.is_staff, r.group_votes, r.inline_visual_mode, r.profile_visual_mode, + r.color, r.icon, r.badge_text, r.badge_bg, r.badge_text_color, r.badge_show_border +FROM web_role r +WHERE lower(r.slug) = lower($1) OR r.id::text = $1 +ORDER BY r.index, r.id +LIMIT 1`) + +func (d *DB) RoleByRef(ctx context.Context, ref string) (*roles.Role, error) { + var role roles.Role + err := d.pool.QueryRow(ctx, qRoleByRef, ref).Scan( + &role.ID, &role.Slug, &role.Name, &role.ShortName, &role.CategoryID, &role.Index, + &role.IsStaff, &role.GroupVotes, &role.InlineVisualMode, &role.ProfileVisualMode, + &role.Color, &role.Icon, &role.BadgeText, &role.BadgeBg, &role.BadgeTextColor, + &role.BadgeShowBorder, + ) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("lookup role %q: %w", ref, err) + } + return &role, nil +} diff --git a/internal/db/member_test.go b/internal/db/member_test.go new file mode 100644 index 00000000..f0694da6 --- /dev/null +++ b/internal/db/member_test.go @@ -0,0 +1,117 @@ +package db + +import ( + "context" + "errors" + "strconv" + "testing" +) + +func TestMembersAreOrderedByID(t *testing.T) { + d := newTestDB(t) + + got, err := d.Members(context.Background(), nil, 0, 100) + if err != nil { + t.Fatalf("Members() err = %v, want nil", err) + } + if len(got) == 0 { + t.Fatal("Members() = 0 rows, want at least one") + } + for i := 1; i < len(got); i++ { + if got[i-1].ID >= got[i].ID { + t.Errorf("Members()[%d].ID = %d, want it after %d", i, got[i].ID, got[i-1].ID) + } + } + if got[0].JoinedAt.IsZero() { + t.Errorf("Members()[0].JoinedAt = %v, want a real time", got[0].JoinedAt) + } +} + +func TestMemberCountMatchesTheUnfilteredListing(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + + total, err := d.MemberCount(ctx, nil) + if err != nil { + t.Fatalf("MemberCount() err = %v, want nil", err) + } + listed, err := d.Members(ctx, nil, 0, total+1) + if err != nil { + t.Fatalf("Members() err = %v, want nil", err) + } + if len(listed) != total { + t.Errorf("MemberCount() = %d, want %d", total, len(listed)) + } +} + +func TestMembersOffsetSkipsRows(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + + all, err := d.Members(ctx, nil, 0, 3) + if err != nil { + t.Fatalf("Members() err = %v, want nil", err) + } + if len(all) < 2 { + t.Skip("the database holds fewer than two users") + } + got, err := d.Members(ctx, nil, 1, 1) + if err != nil { + t.Fatalf("Members() err = %v, want nil", err) + } + if len(got) != 1 { + t.Fatalf("Members(offset 1, limit 1) = %d rows, want 1", len(got)) + } + if got[0].ID != all[1].ID { + t.Errorf("Members(offset 1).ID = %d, want %d", got[0].ID, all[1].ID) + } +} + +func TestMembersFilteredByRole(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + + role, err := d.RoleByRef(ctx, "everyone") + if err != nil { + t.Fatalf("RoleByRef(\"everyone\") err = %v, want nil", err) + } + filtered, err := d.MemberCount(ctx, &role.ID) + if err != nil { + t.Fatalf("MemberCount() err = %v, want nil", err) + } + total, err := d.MemberCount(ctx, nil) + if err != nil { + t.Fatalf("MemberCount() err = %v, want nil", err) + } + if filtered > total { + t.Errorf("MemberCount(role) = %d, want at most %d", filtered, total) + } +} + +func TestRoleByRefMatchesTheNumber(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + + bySlug, err := d.RoleByRef(ctx, "everyone") + if err != nil { + t.Fatalf("RoleByRef(\"everyone\") err = %v, want nil", err) + } + byID, err := d.RoleByRef(ctx, itoa(bySlug.ID)) + if err != nil { + t.Fatalf("RoleByRef(%q) err = %v, want nil", itoa(bySlug.ID), err) + } + if byID.Slug != bySlug.Slug { + t.Errorf("RoleByRef(%q).Slug = %q, want %q", itoa(bySlug.ID), byID.Slug, bySlug.Slug) + } +} + +func TestRoleByRefUnknown(t *testing.T) { + d := newTestDB(t) + + _, err := d.RoleByRef(context.Background(), "no-such-role") + if !errors.Is(err, ErrNotFound) { + t.Errorf("RoleByRef(\"no-such-role\") err = %v, want ErrNotFound", err) + } +} + +func itoa(n int64) string { return strconv.FormatInt(n, 10) } diff --git a/internal/db/site.go b/internal/db/site.go index 1270a301..2ac48c8c 100644 --- a/internal/db/site.go +++ b/internal/db/site.go @@ -18,10 +18,20 @@ type Site struct { HomePage string Icon string ThemeID *int64 + + AuthIcon string + FooterLicense string + SignupNotice string + + MembershipPasswordEnabled bool + MembershipPassword string + MembershipPasswordRoleID *int64 } var qSiteByHost = register("SiteByHost", ` -SELECT id, slug, title, headline, domain, media_domain, home_page, COALESCE(icon, ''), active_theme_id +SELECT id, slug, title, headline, domain, media_domain, home_page, COALESCE(icon, ''), active_theme_id, + COALESCE(auth_icon, ''), footer_license, signup_notice, + membership_password_enabled, membership_password, membership_password_role_id FROM web_site WHERE domain = $1 OR media_domain = $1 ORDER BY id @@ -35,7 +45,9 @@ func (d *DB) SiteByHosts(ctx context.Context, hosts []string) (*Site, error) { var s Site err := d.pool.QueryRow(ctx, qSiteByHost, host).Scan( &s.ID, &s.Slug, &s.Title, &s.Headline, &s.Domain, &s.MediaDomain, &s.HomePage, - &s.Icon, &s.ThemeID) + &s.Icon, &s.ThemeID, + &s.AuthIcon, &s.FooterLicense, &s.SignupNotice, + &s.MembershipPasswordEnabled, &s.MembershipPassword, &s.MembershipPasswordRoleID) if errors.Is(err, pgx.ErrNoRows) { continue } diff --git a/internal/module/module.go b/internal/module/module.go index df9f75be..e70c894b 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -3,6 +3,7 @@ package module import ( + "slices" "strings" "github.com/WikitTeam/ProjectWikit/internal/db" @@ -73,6 +74,9 @@ type Data interface { UsernamesLower() (map[string]bool, error) VoteByUser(articleID int64, userID *int64) (float64, bool, error) UserByID(id int64) (*db.User, error) + Members(roleID *int64, offset, limit int) ([]db.Member, error) + MemberCount(roleID *int64) (int, error) + RoleByRef(ref string) (*roles.Role, error) ArticleHasAuthor(articleID, userID int64) (bool, error) RolesByUser(id int64) ([]roles.Role, error) @@ -136,7 +140,7 @@ func Render(env Env, name string, params map[string]string, body string) (string return "", &Error{Message: env.Text("module-disabled")} } info, ok := Lookup(name) - if ok && !info.Removed { + if ok && !info.Removed && allowed(env.Page, info.Name) { if render, ok := renderers[info.Name]; ok { env.Name = name return render(env, params, body) @@ -145,6 +149,15 @@ func Render(env Env, name string, params map[string]string, body string) (string return "", &Error{Message: env.Text("module-unknown", "name", name)} } +// A render that narrowed the list answers for the rest the way it answers for +// a name nobody knows, so a page cannot tell a blocked module from a typo. +func allowed(pc *page.Context, name string) bool { + if pc == nil || len(pc.OnlyModules) == 0 { + return true + } + return slices.Contains(pc.OnlyModules, name) +} + // BoolParam is get_boolean_param, where anything the list does not name reads // as the default rather than as false. func BoolParam(params map[string]string, key string, def bool) bool { @@ -152,11 +165,20 @@ func BoolParam(params map[string]string, key string, def bool) bool { if !ok { return def } - switch strings.ToLower(value) { + if parsed, ok := ParseBool(value); ok { + return parsed + } + return def +} + +// Callers have to tell a switch from a string, since one parameter can carry +// either. +func ParseBool(value string) (parsed, ok bool) { + switch strings.ToLower(strings.TrimSpace(value)) { case "true", "t", "1", "yes": - return true + return true, true case "false", "f", "0", "no": - return false + return false, true } - return def + return false, false } diff --git a/internal/page/context.go b/internal/page/context.go index f21063ae..41a274dc 100644 --- a/internal/page/context.go +++ b/internal/page/context.go @@ -15,6 +15,13 @@ type Context struct { PathParams PathParams User *db.User + // The handler owns this because it is the only layer that can also plant + // the cookie a form needs. + CSRF string + + // An empty list means every module, which is what an article gets. + OnlyModules []string + Title string Status int RedirectTo string @@ -50,6 +57,8 @@ func (c *Context) CloneWith(article, sourceArticle *db.Article, pathParams PathP clone.Status = c.Status clone.RedirectTo = c.RedirectTo clone.Title = c.Title + clone.CSRF = c.CSRF + clone.OnlyModules = c.OnlyModules return clone } diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 32136e4e..74a1f508 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -268,3 +268,15 @@ func (m moduleData) UserIDsByName(name string, partial bool) ([]int64, error) { func (m moduleData) UsersByIDs(ids []int64) ([]db.User, error) { return m.repo.db.UsersByIDs(m.repo.ctx, ids) } + +func (m moduleData) Members(roleID *int64, offset, limit int) ([]db.Member, error) { + return m.repo.db.Members(m.repo.ctx, roleID, offset, limit) +} + +func (m moduleData) MemberCount(roleID *int64) (int, error) { + return m.repo.db.MemberCount(m.repo.ctx, roleID) +} + +func (m moduleData) RoleByRef(ref string) (*roles.Role, error) { + return m.repo.db.RoleByRef(m.repo.ctx, ref) +} From 90ee9b5ce033552dcf715680c3fd5302b5e9f71d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 21:54:13 +0900 Subject: [PATCH 132/428] add the members and time modules --- internal/i18n/locales/zh-hans.json | 1 + internal/module/registry.go | 2 + internal/module/render_test.go | 2 +- internal/modules/members.go | 140 ++++++++++++++++++++ internal/modules/members_test.go | 206 +++++++++++++++++++++++++++++ internal/modules/time.go | 95 +++++++++++++ internal/modules/time_test.go | 151 +++++++++++++++++++++ 7 files changed, 596 insertions(+), 1 deletion(-) create mode 100644 internal/modules/members.go create mode 100644 internal/modules/members_test.go create mode 100644 internal/modules/time.go create mode 100644 internal/modules/time_test.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 5b970ac2..61bde011 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -52,6 +52,7 @@ "module-listpages-pager-next": "下一页 »", "module-listpages-pager-prev": "« 上一页", "module-listusers-anonymous": "@@[匿名]@@", + "module-members-no-role": "身分组 \"{name}\" 不存在", "module-newpage-submit": "创建页面", "module-pagesbytag-category": " 来自分类 {category}", "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", diff --git a/internal/module/registry.go b/internal/module/registry.go index 3bc1f87c..269f23c2 100644 --- a/internal/module/registry.go +++ b/internal/module/registry.go @@ -24,6 +24,7 @@ var registry = map[string]Info{ "interwiki": {Name: "interwiki", HasContent: true, Removed: true}, "listpages": {Name: "listpages", HasContent: true}, "listusers": {Name: "listusers", HasContent: true}, + "members": {Name: "members", HasContent: true}, "newpage": {Name: "newpage"}, "pagedescription": {Name: "pagedescription", HasContent: true}, "pageimage": {Name: "pageimage"}, @@ -35,6 +36,7 @@ var registry = map[string]Info{ "search": {Name: "search"}, "sitechanges": {Name: "sitechanges"}, "tagcloud": {Name: "tagcloud"}, + "time": {Name: "time", HasContent: true}, "wantedpages": {Name: "wantedpages"}, } diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 30789819..ad0dce6f 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"button", "countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "wantedpages"} + ported := []string{"button", "countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "members", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "time", "wantedpages"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/members.go b/internal/modules/members.go new file mode 100644 index 00000000..843b9d9b --- /dev/null +++ b/internal/modules/members.go @@ -0,0 +1,140 @@ +package modules + +import ( + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" +) + +func init() { module.Register("members", renderMembers) } + +const ( + defaultMembersPerPage = 100 + maxMembersPerPage = 500 +) + +func renderMembers(env module.Env, params map[string]string, body string) (string, error) { + if env.Render == nil || env.Data == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", "members")} + } + pc := env.Page + if pc == nil { + pc = page.NewContext(nil, nil, nil, env.User) + } + + var roleID *int64 + if ref := strings.TrimSpace(params["role"]); ref != "" { + role, err := env.Data.RoleByRef(ref) + if err != nil { + return "", &module.Error{Message: env.Text("module-members-no-role", "name", ref)} + } + roleID = &role.ID + } + + perPage := membersPerPage(params) + total, err := env.Data.MemberCount(roleID) + if err != nil { + return "", err + } + totalPages := (total + perPage - 1) / perPage + current := membersPage(pc.PathParams, totalPages) + + members, err := env.Data.Members(roleID, (current-1)*perPage, perPage) + if err != nil { + return "", err + } + + chips := map[string]string{} + rows := make([]string, 0, len(members)) + for i := range members { + filled, err := memberRow(env, body, members[i], (current-1)*perPage+i+1, total, chips) + if err != nil { + return "", err + } + rows = append(rows, filled) + } + + html, err := env.Render(strings.Join(rows, "\n"), pc) + if err != nil { + return "", err + } + html = putChipsBack(html, chips) + + basePath := "#" + if pc.Article != nil { + basePath = listpages.BasePath(pc.Article.FullName(), pc.PathParams) + } + pager := listpages.Pagination(env.Loc, basePath, current, totalPages) + if pager == "" { + return `
` + "\n" + html + "\n
", nil + } + return `
` + "\n" + html + "\n" + pager + "\n
", nil +} + +func memberRow(env module.Env, body string, m db.Member, index, total int, chips map[string]string) (string, error) { + var chipErr error + filled := page.ApplyTemplate(strings.TrimSpace(body), func(name string) (string, bool) { + switch strings.ToLower(strings.TrimSpace(name)) { + case "members", "member": + // A user chip is markup, and the row still has to go through the + // renderer, so a plain token stands in until the markup is back. + token := chipToken(index) + if _, done := chips[token]; !done { + chip, err := env.Data.RenderUser(m.User) + if err != nil { + chipErr = err + return "", true + } + chips[token] = chip + } + return token, true + case "time": + return memberJoined(m.JoinedAt), true + case "number": + return strconv.FormatInt(m.ID, 10), true + case "name": + return m.Username, true + case "title": + return firstNonBlank(m.DisplayName, m.Username), true + case "index": + return strconv.Itoa(index), true + case "total": + return strconv.Itoa(total), true + } + return "", false + }) + return filled, chipErr +} + +func memberJoined(at time.Time) string { + return "[[date " + strconv.FormatInt(at.Unix(), 10) + "]]" +} + +func membersPerPage(params map[string]string) int { + raw, ok := params["perpage"] + if !ok { + raw = params["limit"] + } + n, err := wikinum.Int(strings.TrimSpace(raw)) + if err != nil || n <= 0 { + return defaultMembersPerPage + } + return min(n, maxMembersPerPage) +} + +func membersPage(path page.PathParams, totalPages int) int { + n, err := wikinum.Int(path.Get("p")) + if err != nil || n < 1 { + return 1 + } + if totalPages > 0 && n > totalPages { + return totalPages + } + return n +} diff --git a/internal/modules/members_test.go b/internal/modules/members_test.go new file mode 100644 index 00000000..c177f4ef --- /dev/null +++ b/internal/modules/members_test.go @@ -0,0 +1,206 @@ +package modules + +import ( + "strconv" + "strings" + "testing" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/roles" +) + +type memberData struct { + module.Data + all []db.Member + role *roles.Role + roleErr error + lastRole *int64 + offset int + limit int +} + +func (d *memberData) Members(roleID *int64, offset, limit int) ([]db.Member, error) { + d.lastRole, d.offset, d.limit = roleID, offset, limit + if offset >= len(d.all) { + return nil, nil + } + return d.all[offset:min(offset+limit, len(d.all))], nil +} + +func (d *memberData) MemberCount(roleID *int64) (int, error) { + d.lastRole = roleID + return len(d.all), nil +} + +func (d *memberData) RoleByRef(string) (*roles.Role, error) { return d.role, d.roleErr } + +func (d *memberData) RenderUser(u db.User) (string, error) { + return `` + u.Username + ``, nil +} + +func membersEnv(t *testing.T, data *memberData) module.Env { + t.Helper() + env := forumEnv(t) + env.Data = data + env.Render = func(source string, _ *page.Context) (string, error) { return source, nil } + return env +} + +func someMembers(n int) []db.Member { + out := make([]db.Member, n) + for i := range out { + out[i] = db.Member{ + User: db.User{ID: int64(i + 1), Username: "user" + strconv.Itoa(i+1)}, + JoinedAt: time.Unix(int64(1700000000+i), 0), + } + } + return out +} + +func TestMembersNumbersRowsAcrossPages(t *testing.T) { + data := &memberData{all: someMembers(250)} + env := membersEnv(t, data) + env.Page = page.NewContext(nil, nil, page.PathParams{{Key: "p", Value: "2"}}, nil) + + got, err := renderMembers(env, nil, "%%index%%") + if err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if !strings.Contains(got, "\n101\n") { + t.Errorf("renderMembers(%%%%index%%%%) page 2 = %q, want it to start at 101", got) + } + if data.offset != 100 { + t.Errorf("Members() offset = %d, want %d", data.offset, 100) + } +} + +func TestMembersDefaultsToOneHundredPerPage(t *testing.T) { + data := &memberData{all: someMembers(150)} + env := membersEnv(t, data) + + if _, err := renderMembers(env, nil, "%%number%%"); err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if data.limit != 100 { + t.Errorf("Members() limit = %d, want %d", data.limit, 100) + } +} + +func TestMembersPerPageParam(t *testing.T) { + data := &memberData{all: someMembers(150)} + env := membersEnv(t, data) + + if _, err := renderMembers(env, map[string]string{"perpage": "25"}, "%%number%%"); err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if data.limit != 25 { + t.Errorf("Members() limit = %d, want %d", data.limit, 25) + } +} + +func TestMembersPerPageIsCapped(t *testing.T) { + data := &memberData{all: someMembers(10)} + env := membersEnv(t, data) + + if _, err := renderMembers(env, map[string]string{"perpage": "9000"}, "%%number%%"); err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if data.limit != maxMembersPerPage { + t.Errorf("Members() limit = %d, want %d", data.limit, maxMembersPerPage) + } +} + +func TestMembersFiltersByRole(t *testing.T) { + data := &memberData{all: someMembers(3), role: &roles.Role{ID: 42, Slug: "staff"}} + env := membersEnv(t, data) + + if _, err := renderMembers(env, map[string]string{"role": "staff"}, "%%number%%"); err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if data.lastRole == nil || *data.lastRole != 42 { + t.Errorf("Members() roleID = %v, want 42", data.lastRole) + } +} + +func TestMembersReportsAnUnknownRole(t *testing.T) { + data := &memberData{all: someMembers(3), roleErr: db.ErrNotFound} + env := membersEnv(t, data) + + _, err := renderMembers(env, map[string]string{"role": "nope"}, "%%number%%") + var moduleErr *module.Error + if !asModuleError(err, &moduleErr) { + t.Fatalf("renderMembers() err = %v, want a module error", err) + } + if !strings.Contains(moduleErr.Message, "nope") { + t.Errorf("renderMembers() message = %q, want it to name %q", moduleErr.Message, "nope") + } +} + +func TestMembersRendersTheUserChip(t *testing.T) { + data := &memberData{all: someMembers(1)} + env := membersEnv(t, data) + + got, err := renderMembers(env, nil, "%%members%%") + if err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if want := `user1`; !strings.Contains(got, want) { + t.Errorf("renderMembers(%%%%members%%%%) = %q, want it to contain %q", got, want) + } +} + +func TestMembersTimeIsTheJoinDate(t *testing.T) { + data := &memberData{all: someMembers(1)} + env := membersEnv(t, data) + + got, err := renderMembers(env, nil, "%%time%%") + if err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if want := "[[date 1700000000]]"; !strings.Contains(got, want) { + t.Errorf("renderMembers(%%%%time%%%%) = %q, want it to contain %q", got, want) + } +} + +func TestMembersOrdersByUserNumber(t *testing.T) { + data := &memberData{all: someMembers(3)} + env := membersEnv(t, data) + + got, err := renderMembers(env, nil, "%%number%%") + if err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if want := "1\n2\n3"; !strings.Contains(got, want) { + t.Errorf("renderMembers(%%%%number%%%%) = %q, want it to contain %q", got, want) + } +} + +func TestMembersHasNoPagerOnASinglePage(t *testing.T) { + data := &memberData{all: someMembers(3)} + env := membersEnv(t, data) + + got, err := renderMembers(env, nil, "%%number%%") + if err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if strings.Contains(got, `class="pager"`) { + t.Errorf("renderMembers() = %q, want no pager", got) + } +} + +func TestMembersPagerLinksToTheHostPage(t *testing.T) { + data := &memberData{all: someMembers(250)} + env := membersEnv(t, data) + env.Page = page.NewContext(&db.Article{Category: "_default", Name: "roster"}, nil, nil, nil) + + got, err := renderMembers(env, nil, "%%number%%") + if err != nil { + t.Fatalf("renderMembers() err = %v, want nil", err) + } + if want := `href="/roster/p/2"`; !strings.Contains(got, want) { + t.Errorf("renderMembers() = %q, want it to contain %q", got, want) + } +} diff --git a/internal/modules/time.go b/internal/modules/time.go new file mode 100644 index 00000000..59970bf5 --- /dev/null +++ b/internal/modules/time.go @@ -0,0 +1,95 @@ +package modules + +import ( + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +func init() { module.Register("time", renderTime) } + +// Each field becomes its own date element so the reader's browser resolves it +// in their own zone, which the server cannot know. +var timeFields = map[string]string{ + "currentyear": "%Y", + "currentmonth": "%m", + "currentday": "%d", + "currenthour": "%H", + "currentminute": "%M", + "currentsecond": "%S", +} + +func renderTime(env module.Env, _ map[string]string, body string) (string, error) { + if env.Render == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", "time")} + } + pc := env.Page + if pc == nil { + pc = page.NewContext(nil, nil, nil, env.User) + } + + now := time.Now() + stamps := map[string]string{} + source := page.ApplyTemplate(strings.TrimSpace(body), func(name string) (string, bool) { + format, ok := timeFields[normalizeTimeField(name)] + if !ok { + return "", false + } + token := timeToken(format) + stamps[token] = dateSpan(now, format) + return token, true + }) + + html, err := env.Render(source, pc) + if err != nil { + return "", err + } + return putChipsBack(html, stamps), nil +} + +func timeToken(format string) string { return "pwikittime" + format[1:] + "stamp" } + +func dateSpan(at time.Time, format string) string { + return `` + escape.HTML(timeField(at, format)) + `` +} + +func timeField(at time.Time, format string) string { + switch format { + case "%Y": + return strconv.Itoa(at.Year()) + case "%m": + return pad2(int(at.Month())) + case "%d": + return pad2(at.Day()) + case "%H": + return pad2(at.Hour()) + case "%M": + return pad2(at.Minute()) + case "%S": + return pad2(at.Second()) + } + return "" +} + +func pad2(n int) string { + if n < 10 { + return "0" + strconv.Itoa(n) + } + return strconv.Itoa(n) +} + +// The spelling without the second r reaches the same field, so a page using it +// does not silently render the variable name instead. +func normalizeTimeField(name string) string { + lowered := strings.ToLower(strings.TrimSpace(name)) + if rest, ok := strings.CutPrefix(lowered, "curent"); ok { + return "current" + rest + } + return lowered +} diff --git a/internal/modules/time_test.go b/internal/modules/time_test.go new file mode 100644 index 00000000..65aba442 --- /dev/null +++ b/internal/modules/time_test.go @@ -0,0 +1,151 @@ +package modules + +import ( + "regexp" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +func timeEnv(t *testing.T) module.Env { + t.Helper() + env := forumEnv(t) + env.Render = func(source string, _ *page.Context) (string, error) { return source, nil } + return env +} + +var dateSpanPattern = regexp.MustCompile(`([^<]*)`) + +func TestTimeSubstitutesEveryField(t *testing.T) { + env := timeEnv(t) + cases := []struct{ in, want string }{ + {"%%currentyear%%", "%Y"}, + {"%%currentmonth%%", "%m"}, + {"%%currentday%%", "%d"}, + {"%%currenthour%%", "%H"}, + {"%%currentminute%%", "%M"}, + {"%%currentsecond%%", "%S"}, + } + for _, c := range cases { + got, err := renderTime(env, nil, c.in) + if err != nil { + t.Fatalf("renderTime(%q) err = %v, want nil", c.in, err) + } + m := dateSpanPattern.FindStringSubmatch(got) + if m == nil { + t.Errorf("renderTime(%q) = %q, want a date span", c.in, got) + continue + } + if m[2] != c.want { + t.Errorf("renderTime(%q) format = %q, want %q", c.in, m[2], c.want) + } + if m[3] == "" { + t.Errorf("renderTime(%q) text = %q, want the field spelled out", c.in, m[3]) + } + } +} + +func TestTimeYearTextIsFourDigits(t *testing.T) { + env := timeEnv(t) + + got, err := renderTime(env, nil, "%%currentyear%%") + if err != nil { + t.Fatalf("renderTime() err = %v, want nil", err) + } + m := dateSpanPattern.FindStringSubmatch(got) + if m == nil { + t.Fatalf("renderTime(%%%%currentyear%%%%) = %q, want a date span", got) + } + if len(m[3]) != 4 { + t.Errorf("renderTime(%%%%currentyear%%%%) text = %q, want four digits", m[3]) + } +} + +func TestTimeMonthTextIsPaddedToTwo(t *testing.T) { + env := timeEnv(t) + + got, err := renderTime(env, nil, "%%currentmonth%%") + if err != nil { + t.Fatalf("renderTime() err = %v, want nil", err) + } + m := dateSpanPattern.FindStringSubmatch(got) + if m == nil { + t.Fatalf("renderTime(%%%%currentmonth%%%%) = %q, want a date span", got) + } + if len(m[3]) != 2 { + t.Errorf("renderTime(%%%%currentmonth%%%%) text = %q, want two digits", m[3]) + } +} + +func TestTimeAcceptsTheCurentSpelling(t *testing.T) { + env := timeEnv(t) + + got, err := renderTime(env, nil, "%%curentyear%%") + if err != nil { + t.Fatalf("renderTime() err = %v, want nil", err) + } + m := dateSpanPattern.FindStringSubmatch(got) + if m == nil { + t.Fatalf("renderTime(%%%%curentyear%%%%) = %q, want a date span", got) + } + if m[2] != "%Y" { + t.Errorf("renderTime(%%%%curentyear%%%%) format = %q, want %q", m[2], "%Y") + } +} + +func TestTimeKeepsTheTextAroundTheFields(t *testing.T) { + env := timeEnv(t) + + got, err := renderTime(env, nil, "%%currentyear%%.%%currentmonth%%") + if err != nil { + t.Fatalf("renderTime() err = %v, want nil", err) + } + if n := len(dateSpanPattern.FindAllString(got, -1)); n != 2 { + t.Errorf("renderTime(%q) has %d date spans, want 2", "%%currentyear%%.%%currentmonth%%", n) + } + if !strings.Contains(got, ". Date: Mon, 31 Aug 2026 21:56:15 +0900 Subject: [PATCH 133/428] carry the token a form needs through the render --- internal/articlepage/articlepage.go | 12 ++++++ internal/articlepage/build.go | 7 ++++ internal/articlepage/render.go | 12 +++++- internal/page/csrf.go | 43 +++++++++++++++++++++ internal/page/csrf_test.go | 58 +++++++++++++++++++++++++++++ 5 files changed, 130 insertions(+), 2 deletions(-) create mode 100644 internal/page/csrf.go create mode 100644 internal/page/csrf_test.go diff --git a/internal/articlepage/articlepage.go b/internal/articlepage/articlepage.go index 09928d01..a952d503 100644 --- a/internal/articlepage/articlepage.go +++ b/internal/articlepage/articlepage.go @@ -10,6 +10,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/roles" "github.com/WikitTeam/ProjectWikit/internal/shell" @@ -35,6 +36,8 @@ type Handler struct { shell func(loc *i18n.Localizer) *shell.Renderer } +const csrfCookieMaxAge = 60 * 60 * 24 * 365 + const allowedMethods = "GET, HEAD, OPTIONS" var _ http.Handler = (*Handler)(nil) @@ -91,6 +94,15 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } + if out.SetCSRF != "" { + http.SetCookie(w, &http.Cookie{ + Name: page.CSRFCookie, + Value: out.SetCSRF, + Path: "/", + MaxAge: csrfCookieMaxAge, + SameSite: http.SameSiteLaxMode, + }) + } w.Header().Set("Content-Type", "text/html; charset=utf-8") w.WriteHeader(out.Status) if r.Method == http.MethodHead { diff --git a/internal/articlepage/build.go b/internal/articlepage/build.go index fac58f15..0ea7f39e 100644 --- a/internal/articlepage/build.go +++ b/internal/articlepage/build.go @@ -11,6 +11,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/auth" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/site" @@ -21,6 +22,8 @@ type result struct { Status int Location string Body string + + SetCSRF string } type request struct { @@ -36,6 +39,9 @@ type request struct { article *db.Article forbidden bool perms perms.Set + + csrf string + csrfNew bool } func (h *Handler) build(r *http.Request) (*result, error) { @@ -51,6 +57,7 @@ func (h *Handler) build(r *http.Request) (*result, error) { site: found, user: auth.FromContext(ctx), } + req.csrf, req.csrfNew = page.CSRFToken(r) req.name, req.params = article.ParsePath(strings.TrimPrefix(r.URL.EscapedPath(), "/"), found.HomePage) req.encoded = article.Encode(req.params) diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 05ba9ab8..17a30839 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -70,7 +70,14 @@ func (h *Handler) render(req *request) (*result, error) { if err := h.shell(req.loc).Page(&page, data); err != nil { return nil, err } - return &result{Status: out.status, Body: page.String()}, nil + body := page.String() + res := &result{Status: out.status, Body: body} + // Only a page that actually put the token in a form gets the cookie, so a + // plain reader is never handed one they have no use for. + if req.csrfNew && strings.Contains(body, req.csrf) { + res.SetCSRF = req.csrf + } + return res, nil } func (h *Handler) body(req *request, canonical string) (body, error) { @@ -138,7 +145,8 @@ func (h *Handler) articleBody(req *request, canonical string) (body, error) { } func (h *Handler) context(req *request, source *db.Article) *page.Context { - return page.NewContext(req.article, source, req.params, req.user) + pc := page.NewContext(req.article, source, req.params, req.user) + return pc } // A page named _template is its own content, which is what keeps the template diff --git a/internal/page/csrf.go b/internal/page/csrf.go new file mode 100644 index 00000000..aa172a6b --- /dev/null +++ b/internal/page/csrf.go @@ -0,0 +1,43 @@ +package page + +import ( + "crypto/rand" + "net/http" +) + +// CSRFCookie is the name the frontend already reads the token back from, so +// the two have to stay spelled the same. +const CSRFCookie = "pwikit_csrftoken" + +const csrfAlphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" + +const csrfTokenLength = 32 + +func CSRFToken(r *http.Request) (token string, isNew bool) { + if cookie, err := r.Cookie(CSRFCookie); err == nil && validCSRFToken(cookie.Value) { + return cookie.Value, false + } + return newCSRFToken(), true +} + +func validCSRFToken(token string) bool { + if len(token) != csrfTokenLength && len(token) != 2*csrfTokenLength { + return false + } + for i := 0; i < len(token); i++ { + c := token[i] + if !(c >= 'a' && c <= 'z' || c >= 'A' && c <= 'Z' || c >= '0' && c <= '9') { + return false + } + } + return true +} + +func newCSRFToken() string { + buf := make([]byte, csrfTokenLength) + rand.Read(buf) + for i, b := range buf { + buf[i] = csrfAlphabet[int(b)%len(csrfAlphabet)] + } + return string(buf) +} diff --git a/internal/page/csrf_test.go b/internal/page/csrf_test.go new file mode 100644 index 00000000..74260a8d --- /dev/null +++ b/internal/page/csrf_test.go @@ -0,0 +1,58 @@ +package page + +import ( + "net/http" + "testing" +) + +func requestWithToken(value string) *http.Request { + r, _ := http.NewRequest(http.MethodGet, "/", nil) + if value != "" { + r.AddCookie(&http.Cookie{Name: CSRFCookie, Value: value}) + } + return r +} + +func TestCSRFTokenKeepsTheCookie(t *testing.T) { + want := "abcdefghijklmnopqrstuvwxyz012345" + + got, isNew := CSRFToken(requestWithToken(want)) + if got != want { + t.Errorf("CSRFToken() = %q, want %q", got, want) + } + if isNew { + t.Error("CSRFToken() isNew = true, want false") + } +} + +func TestCSRFTokenMintsOneWhenTheCookieIsMissing(t *testing.T) { + got, isNew := CSRFToken(requestWithToken("")) + if !isNew { + t.Error("CSRFToken() isNew = false, want true") + } + if !validCSRFToken(got) { + t.Errorf("CSRFToken() = %q, want a valid token", got) + } +} + +func TestCSRFTokenReplacesAMalformedCookie(t *testing.T) { + for _, bad := range []string{"short", "has-a-dash-in-it-and-is-32-chars", ""} { + got, isNew := CSRFToken(requestWithToken(bad)) + if !isNew { + t.Errorf("CSRFToken(%q) isNew = false, want true", bad) + } + if !validCSRFToken(got) { + t.Errorf("CSRFToken(%q) = %q, want a valid token", bad, got) + } + } +} + +func TestValidCSRFTokenAcceptsBothLengths(t *testing.T) { + short := "abcdefghijklmnopqrstuvwxyz012345" + if !validCSRFToken(short) { + t.Errorf("validCSRFToken(%q) = false, want true", short) + } + if long := short + short; !validCSRFToken(long) { + t.Errorf("validCSRFToken(%q) = false, want true", long) + } +} From f3480a6f54a9e81d5116af7c9d2433407587faa2 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 21:57:04 +0900 Subject: [PATCH 134/428] answer with the site's own footer text --- internal/articlepage/render.go | 34 +++++++++++++++++++++++++++++ internal/articlepage/render_test.go | 17 +++++++++++++++ internal/shell/shell.go | 8 ++++++- internal/shell/templates/page.html | 2 +- 4 files changed, 59 insertions(+), 2 deletions(-) create mode 100644 internal/articlepage/render_test.go diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 17a30839..2c9ed324 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -356,6 +356,34 @@ func (h *Handler) nested(req *request, source string, pc *page.Context) (string, return html.Body, nil } +func (h *Handler) license(req *request) (string, error) { + source := strings.TrimSpace(req.site.FooterLicense) + if source == "" { + return "", nil + } + pc := page.NewContext(nil, nil, nil, req.user) + // This text is site configuration rather than an article, so it does not get + // to reach the whole module set. + pc.OnlyModules = []string{"time"} + info, err := h.pageInfo(req, nil) + if err != nil { + return "", err + } + html, err := h.deps.Engine.RenderHTML(req.ctx, source, info, + h.callbacks(req, nil, pc), renderer.ModeSystemWithModules) + if err != nil { + return "", err + } + // The licence area holds a single line, so the paragraphs come back off. + return unwrapParagraphs(html.Body), nil +} + +func unwrapParagraphs(html string) string { + out := strings.ReplaceAll(html, "

", "") + out = strings.ReplaceAll(out, "

", "") + return strings.TrimSpace(out) +} + func (h *Handler) message(req *request, source string) (string, error) { pc := page.NewContext(nil, nil, nil, req.user) info, err := h.pageInfo(req, nil) @@ -464,12 +492,18 @@ func (h *Handler) shellData(req *request, out body, canonical, navTop, navSide s return shell.Data{}, err } + license, err := h.license(req) + if err != nil { + return shell.Data{}, err + } + title := firstNonEmpty(out.title, req.site.Title) return shell.Data{ SiteName: req.site.Title, SiteHeadline: req.site.Headline, SiteTitle: title, SiteIcon: req.site.Icon, + License: license, OGTitle: title, OGDescription: out.excerpt, OGImage: out.image, diff --git a/internal/articlepage/render_test.go b/internal/articlepage/render_test.go new file mode 100644 index 00000000..bbc9df3b --- /dev/null +++ b/internal/articlepage/render_test.go @@ -0,0 +1,17 @@ +package articlepage + +import "testing" + +func TestUnwrapParagraphs(t *testing.T) { + cases := []struct{ in, want string }{ + {"

one line

", "one line"}, + {"

a

\nb\n

c

", "a\nb\nc"}, + {"", ""}, + {"no markup", "no markup"}, + } + for _, c := range cases { + if got := unwrapParagraphs(c.in); got != c.want { + t.Errorf("unwrapParagraphs(%q) = %q, want %q", c.in, got, c.want) + } + } +} diff --git a/internal/shell/shell.go b/internal/shell/shell.go index 76116f97..7be500c3 100644 --- a/internal/shell/shell.go +++ b/internal/shell/shell.go @@ -58,6 +58,9 @@ type Data struct { SiteTitle string SiteIcon string + // An empty one falls back to the built-in line. + License string + OGTitle string OGDescription string OGImage string @@ -143,7 +146,10 @@ func (v view) T(id string, args ...any) string { return v.r.loc.T(id, args...) } func (v view) Asset(name string) string { return v.r.assets.URL(name) } -func (v view) License() string { +func (v view) LicenseHTML() string { + if v.Data.License != "" { + return v.Data.License + } return v.T("page.license", "link", ``+licenseName+``) } diff --git a/internal/shell/templates/page.html b/internal/shell/templates/page.html index 75288ce1..8646b66a 100644 --- a/internal/shell/templates/page.html +++ b/internal/shell/templates/page.html @@ -126,7 +126,7 @@

{{esc .SiteHeadline}}

- {{.License}} + {{.LicenseHTML}}
From 05bd327eb96a49c639010c75abbea15cc4284a01 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 31 Aug 2026 21:57:47 +0900 Subject: [PATCH 135/428] take the application and membership forms --- internal/i18n/locales/zh-hans.json | 11 ++ internal/module/registry.go | 54 +++--- internal/module/registry_test.go | 34 ++++ internal/module/render_test.go | 27 ++- internal/modules/applicationform.go | 107 +++++++++++ internal/modules/applicationform_test.go | 226 +++++++++++++++++++++++ internal/modules/membershipbypassword.go | 55 ++++++ web/urls.py | 5 +- web/views/tickets.py | 60 ++++++ 9 files changed, 551 insertions(+), 28 deletions(-) create mode 100644 internal/modules/applicationform.go create mode 100644 internal/modules/applicationform_test.go create mode 100644 internal/modules/membershipbypassword.go create mode 100644 web/views/tickets.py diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 61bde011..4d2701d1 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -8,6 +8,12 @@ "include-create": "立刻创建", "include-loop": "插入的页面 \"{name}\" 导致了无限包含循环", "include-missing": "插入的页面 \"{name}\" 不存在", + "module-applicationform-body": "正文", + "module-applicationform-login": "请先登录后再提交。", + "module-applicationform-subject": "标题", + "module-applicationform-submit": "提交", + "module-applied-failed": "提交失败，请检查填写的内容。", + "module-applied-ok": "已提交，等待管理员处理。", "module-button-edit": "编辑", "module-button-unknown": "不支持的按钮类型：{type}", "module-date-format": "{month}.{day}.{year} {hour}:{minute}", @@ -53,6 +59,11 @@ "module-listpages-pager-prev": "« 上一页", "module-listusers-anonymous": "@@[匿名]@@", "module-members-no-role": "身分组 \"{name}\" 不存在", + "module-membership-failed": "密码不正确。", + "module-membership-ok": "密码正确，身分组已发放。", + "module-membershipbypassword-login": "请先登录后再输入密码。", + "module-membershipbypassword-password": "输入密码", + "module-membershipbypassword-submit": "提交", "module-newpage-submit": "创建页面", "module-pagesbytag-category": " 来自分类 {category}", "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", diff --git a/internal/module/registry.go b/internal/module/registry.go index 269f23c2..1b9b5334 100644 --- a/internal/module/registry.go +++ b/internal/module/registry.go @@ -12,32 +12,34 @@ type Info struct { } var registry = map[string]Info{ - "button": {Name: "button"}, - "countpages": {Name: "countpages", HasContent: true}, - "css": {Name: "css", HasContent: true}, - "forumcategory": {Name: "forumcategory"}, - "forumnewpost": {Name: "forumnewpost"}, - "forumnewthread": {Name: "forumnewthread"}, - "forumpost": {Name: "forumpost"}, - "forumstart": {Name: "forumstart"}, - "forumthread": {Name: "forumthread"}, - "interwiki": {Name: "interwiki", HasContent: true, Removed: true}, - "listpages": {Name: "listpages", HasContent: true}, - "listusers": {Name: "listusers", HasContent: true}, - "members": {Name: "members", HasContent: true}, - "newpage": {Name: "newpage"}, - "pagedescription": {Name: "pagedescription", HasContent: true}, - "pageimage": {Name: "pageimage"}, - "pagesbytag": {Name: "pagesbytag"}, - "rat": {Name: "rat", Removed: true}, - "rate": {Name: "rate"}, - "recentposts": {Name: "recentposts"}, - "redirect": {Name: "redirect"}, - "search": {Name: "search"}, - "sitechanges": {Name: "sitechanges"}, - "tagcloud": {Name: "tagcloud"}, - "time": {Name: "time", HasContent: true}, - "wantedpages": {Name: "wantedpages"}, + "applicationform": {Name: "applicationform"}, + "button": {Name: "button"}, + "countpages": {Name: "countpages", HasContent: true}, + "css": {Name: "css", HasContent: true}, + "forumcategory": {Name: "forumcategory"}, + "forumnewpost": {Name: "forumnewpost"}, + "forumnewthread": {Name: "forumnewthread"}, + "forumpost": {Name: "forumpost"}, + "forumstart": {Name: "forumstart"}, + "forumthread": {Name: "forumthread"}, + "interwiki": {Name: "interwiki", HasContent: true, Removed: true}, + "listpages": {Name: "listpages", HasContent: true}, + "listusers": {Name: "listusers", HasContent: true}, + "members": {Name: "members", HasContent: true}, + "membershipbypassword": {Name: "membershipbypassword"}, + "newpage": {Name: "newpage"}, + "pagedescription": {Name: "pagedescription", HasContent: true}, + "pageimage": {Name: "pageimage"}, + "pagesbytag": {Name: "pagesbytag"}, + "rat": {Name: "rat", Removed: true}, + "rate": {Name: "rate"}, + "recentposts": {Name: "recentposts"}, + "redirect": {Name: "redirect"}, + "search": {Name: "search"}, + "sitechanges": {Name: "sitechanges"}, + "tagcloud": {Name: "tagcloud"}, + "time": {Name: "time", HasContent: true}, + "wantedpages": {Name: "wantedpages"}, } func Lookup(name string) (Info, bool) { diff --git a/internal/module/registry_test.go b/internal/module/registry_test.go index 40a86e3c..2bd3aa53 100644 --- a/internal/module/registry_test.go +++ b/internal/module/registry_test.go @@ -75,3 +75,37 @@ func TestRegisterRejectsAnUnknownName(t *testing.T) { }() Register("no-such-module", func(Env, map[string]string, string) (string, error) { return "", nil }) } + +func TestParseBool(t *testing.T) { + cases := []struct { + in string + want, isOk bool + }{ + {"yes", true, true}, + {"TRUE", true, true}, + {" 1 ", true, true}, + {"no", false, true}, + {"f", false, true}, + {"0", false, true}, + {"入组申请", false, false}, + {"", false, false}, + } + for _, c := range cases { + got, ok := ParseBool(c.in) + if ok != c.isOk { + t.Errorf("ParseBool(%q) ok = %v, want %v", c.in, ok, c.isOk) + continue + } + if ok && got != c.want { + t.Errorf("ParseBool(%q) = %v, want %v", c.in, got, c.want) + } + } +} + +func TestFormModulesTakeNoBody(t *testing.T) { + for _, name := range []string{"applicationform", "membershipbypassword"} { + if HasContent(name) { + t.Errorf("HasContent(%q) = true, want false", name) + } + } +} diff --git a/internal/module/render_test.go b/internal/module/render_test.go index ad0dce6f..94f876bb 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"button", "countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "members", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "time", "wantedpages"} + ported := []string{"applicationform", "button", "countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "members", "membershipbypassword", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "time", "wantedpages"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) @@ -258,3 +258,28 @@ func TestPagesByTagOfTheDefaultCategory(t *testing.T) { t.Errorf("Render(pagesbytag) = %q, want no category clause", got) } } + +func TestRenderRefusesAModuleOutsideTheAllowlist(t *testing.T) { + ctx := page.NewContext(nil, nil, nil, nil) + ctx.OnlyModules = []string{"time"} + + _, err := module.Render(module.Env{Page: ctx}, "listpages", nil, "") + var moduleErr *module.Error + if !errors.As(err, &moduleErr) { + t.Fatalf("Render(listpages) err = %v, want a module error", err) + } + if moduleErr.Message != "module-unknown" { + t.Errorf("Render(listpages) message = %q, want %q", moduleErr.Message, "module-unknown") + } +} + +func TestRenderAllowsAModuleOnTheAllowlist(t *testing.T) { + ctx := page.NewContext(nil, nil, nil, nil) + ctx.OnlyModules = []string{"time"} + + _, err := module.Render(module.Env{Page: ctx}, "time", nil, "") + var moduleErr *module.Error + if errors.As(err, &moduleErr) && moduleErr.Message == "module-unknown" { + t.Error("Render(time) = module-unknown, want the module to run") + } +} diff --git a/internal/modules/applicationform.go b/internal/modules/applicationform.go new file mode 100644 index 00000000..886b2362 --- /dev/null +++ b/internal/modules/applicationform.go @@ -0,0 +1,107 @@ +package modules + +import ( + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +func init() { module.Register("applicationform", renderApplicationForm) } + +const ( + kindTicket = "ticket" + kindMembershipApply = "membershipapply" + + ticketSubmitPath = "/-/tickets/submit" + ticketMaxSubject = 200 +) + +func renderApplicationForm(env module.Env, params map[string]string, _ string) (string, error) { + pc := env.Page + if pc == nil { + pc = page.NewContext(nil, nil, nil, env.User) + } + + kind := kindTicket + if strings.EqualFold(strings.TrimSpace(firstNonBlank(params["type"], params["kind"])), kindMembershipApply) { + kind = kindMembershipApply + } + + var b strings.Builder + if notice := submittedNotice(env, pc, "applied"); notice != "" { + b.WriteString(notice) + } + if env.User == nil { + b.WriteString(noticeBlock(env.Text("module-applicationform-login"))) + return b.String(), nil + } + + source := "" + if pc.Article != nil { + source = pc.Article.FullName() + } + + b.WriteString(`
` + "\n") + b.WriteString(hiddenField("csrfmiddlewaretoken", pc.CSRF)) + b.WriteString(hiddenField("kind", kind)) + b.WriteString(hiddenField("page", source)) + b.WriteString(`` + "\n") + b.WriteString(subjectRow(env, params)) + b.WriteString(`` + + `` + "\n") + b.WriteString("
` + escape.HTML(env.Text("module-applicationform-body")) + `
\n") + b.WriteString(`
` + "\n") + b.WriteString("
") + return b.String(), nil +} + +// One parameter carries both readings. A word a switch is spelled with turns +// the field on or off, and anything else is the subject itself. +func subjectRow(env module.Env, params map[string]string) string { + value, given := params["title"] + if !given { + value, given = params["subject"] + } + if !given { + return subjectInput(env) + } + if wanted, isSwitch := module.ParseBool(value); isSwitch { + if wanted { + return subjectInput(env) + } + return "" + } + return hiddenField("subject", strings.TrimSpace(value)) +} + +func subjectInput(env module.Env) string { + return `` + escape.HTML(env.Text("module-applicationform-subject")) + `` + + `` + "\n" +} + +func hiddenField(name, value string) string { + return `` + "\n" +} + +func noticeBlock(text string) string { + return `

` + escape.HTML(text) + `

` + "\n" +} + +// The outcome comes back as a path parameter rather than a query string +// because that is the only part of the URL a page render can see. +func submittedNotice(env module.Env, pc *page.Context, key string) string { + switch pc.PathParams.Get(key) { + case "ok": + return `

` + + escape.HTML(env.Text("module-"+key+"-ok")) + `

` + "\n" + case "": + return "" + default: + return noticeBlock(env.Text("module-" + key + "-failed")) + } +} diff --git a/internal/modules/applicationform_test.go b/internal/modules/applicationform_test.go new file mode 100644 index 00000000..42ebd135 --- /dev/null +++ b/internal/modules/applicationform_test.go @@ -0,0 +1,226 @@ +package modules + +import ( + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" +) + +func formEnv(t *testing.T, user *db.User) module.Env { + t.Helper() + env := forumEnv(t) + env.User = user + env.Render = func(source string, _ *page.Context) (string, error) { return source, nil } + env.Page = page.NewContext(&db.Article{Category: "_default", Name: "join"}, nil, nil, user) + env.Page.CSRF = "abcdefghijklmnopqrstuvwxyz012345" + return env +} + +func TestApplicationFormNeedsALogin(t *testing.T) { + env := formEnv(t, nil) + + got, err := renderApplicationForm(env, nil, "") + if err != nil { + t.Fatalf("renderApplicationForm() err = %v, want nil", err) + } + if strings.Contains(got, "` + "\n") + b.WriteString(hiddenField("csrfmiddlewaretoken", pc.CSRF)) + b.WriteString(hiddenField("page", source)) + b.WriteString(`` + "\n") + b.WriteString(`` + + `` + "\n") + b.WriteString("
` + escape.HTML(label) + `
\n") + b.WriteString(`
` + "\n") + b.WriteString("") + return b.String(), nil +} diff --git a/web/urls.py b/web/urls.py index 033aa28b..9de2ec06 100644 --- a/web/urls.py +++ b/web/urls.py @@ -22,7 +22,7 @@ from django.contrib.auth.views import PasswordResetDoneView, PasswordResetConfirmView, PasswordResetCompleteView, PasswordResetView from django.contrib import admin -from .views import profile, signup, login, updates as updates_views +from .views import profile, signup, login, tickets, updates as updates_views from .views.theme import SiteThemeFileView from web.views.api import articles, preview, module, files, notifications, users, search, messages as api_messages, reports as api_reports @@ -116,6 +116,9 @@ def make_reactive(routes: list[str]): path("theme/.css", SiteThemeFileView.as_view(), name='site_theme_file'), + path("tickets/submit", tickets.SubmitTicketView.as_view(), name='ticket_submit'), + path("membership/password", tickets.MembershipByPasswordView.as_view(), name='membership_by_password'), + path("admin/update/status", updates_views.UpdatesStatusView.as_view(), name='wu_update_status'), path("admin/update/trigger", updates_views.UpdatesTriggerView.as_view(), name='wu_update_trigger'), path("admin/update", updates_views.UpdatesAdminView.as_view(), name='wu_update'), diff --git a/web/views/tickets.py b/web/views/tickets.py new file mode 100644 index 00000000..95de305b --- /dev/null +++ b/web/views/tickets.py @@ -0,0 +1,60 @@ +from django.http import HttpRequest, HttpResponse, HttpResponseRedirect +from django.utils.http import urlencode +from django.views import View + +from web.models.roles import Role +from web.models.site import get_current_site +from web.models.tickets import UserTicket + + +MAX_SUBJECT_LENGTH = 200 +MAX_BODY_LENGTH = 20000 + + +def _back(request: HttpRequest, key: str, outcome: str) -> HttpResponse: + # 文章渲染只看得见路径参数，查询串到不了模块手里。 + page = (request.POST.get('page') or '').strip().strip('/') + if not page: + return HttpResponseRedirect('/') + return HttpResponseRedirect('/%s/%s/%s' % (page, key, outcome)) + + +class SubmitTicketView(View): + def post(self, request: HttpRequest): + if not request.user.is_authenticated: + return _back(request, 'applied', 'failed') + + body = (request.POST.get('body') or '').strip() + if not body or len(body) > MAX_BODY_LENGTH: + return _back(request, 'applied', 'failed') + + kind = request.POST.get('kind') + if kind not in UserTicket.Kind.values: + kind = UserTicket.Kind.Ticket + + UserTicket.objects.create( + kind=kind, + author=request.user, + subject=(request.POST.get('subject') or '').strip()[:MAX_SUBJECT_LENGTH], + body=body, + source_page=(request.POST.get('page') or '').strip(), + ) + return _back(request, 'applied', 'ok') + + +class MembershipByPasswordView(View): + def post(self, request: HttpRequest): + if not request.user.is_authenticated: + return _back(request, 'membership', 'failed') + + site = get_current_site() + if not site or not site.membership_password_enabled or not site.membership_password: + return _back(request, 'membership', 'failed') + if (request.POST.get('password') or '') != site.membership_password: + return _back(request, 'membership', 'failed') + + role = site.membership_password_role + if role is None: + return _back(request, 'membership', 'failed') + request.user.roles.add(role) + return _back(request, 'membership', 'ok') From ec9bda6658071341657346738df531b077ee4dee Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 15:25:08 +0900 Subject: [PATCH 136/428] join page tags and authors the way wikidot does --- internal/page/testdata/vars.golden | 16 ++++++++-------- internal/page/vars.go | 4 ++-- internal/page/vars_test.go | 4 ++-- modules/listpages/__init__.py | 4 ++-- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/internal/page/testdata/vars.golden b/internal/page/testdata/vars.golden index 7f3b6018..3d02afbf 100644 --- a/internal/page/testdata/vars.golden +++ b/internal/page/testdata/vars.golden @@ -26,7 +26,7 @@ True === probe:full revisions 1 === probe:full created_by -[[span]]Probe Author[[/span]] [[span]]wd:Probe WD[[/span]] +Probe Author wd:Probe WD === probe:full created_by_linked [[*user probe-author]] [[*user 576c0df3-8a28-4468-9770-ede851d88c67]] === probe:full created_by_linked_plain @@ -40,7 +40,7 @@ Probe Author === probe:full authors_count 2 === probe:full tags -alpha, lang:en, zeta +alpha lang:en zeta === probe:full tags_linked [/system:page-tags/tag/alpha alpha], [/system:page-tags/tag/lang%3Aen lang:en], [/system:page-tags/tag/zeta zeta] === probe:full created_at @@ -103,7 +103,7 @@ False === probe:full revisions 1 === probe:full created_by -[[span]]Probe Author[[/span]] [[span]]wd:Probe WD[[/span]] +Probe Author wd:Probe WD === probe:full created_by_linked [[*user probe-author]] [[*user 576c0df3-8a28-4468-9770-ede851d88c67]] === probe:full created_by_linked_plain @@ -117,7 +117,7 @@ Probe Author === probe:full authors_count 2 === probe:full tags -alpha, lang:en, zeta +alpha lang:en zeta === probe:full tags_linked [/system:page-tags/tag/alpha alpha], [/system:page-tags/tag/lang%3Aen lang:en], [/system:page-tags/tag/zeta zeta] === probe:full created_at @@ -255,7 +255,7 @@ False === probe:parent revisions 1 === probe:parent created_by -[[span]]Probe Author[[/span]] +Probe Author === probe:parent created_by_linked [[*user probe-author]] === probe:parent created_by_linked_plain @@ -331,7 +331,7 @@ True === probestars:rated revisions 1 === probestars:rated created_by -[[span]]Probe Author[[/span]] +Probe Author === probestars:rated created_by_linked [[*user probe-author]] === probestars:rated created_by_linked_plain @@ -345,7 +345,7 @@ Probe Author === probestars:rated authors_count 1 === probestars:rated tags -alpha, topic:scp +alpha topic:scp === probestars:rated tags_linked [/system:page-tags/tag/alpha alpha], [/system:page-tags/tag/topic%3Ascp topic:scp] === probestars:rated created_at @@ -407,7 +407,7 @@ False === probe:half revisions 1 === probe:half created_by -[[span]]Probe Author[[/span]] +Probe Author === probe:half created_by_linked [[*user probe-author]] === probe:half created_by_linked_plain diff --git a/internal/page/vars.go b/internal/page/vars.go index 521ce82c..c3108629 100644 --- a/internal/page/vars.go +++ b/internal/page/vars.go @@ -187,7 +187,7 @@ func (v *Vars) compute(name string) (string, bool) { } parts := make([]string, len(authors)) for i := range authors { - parts[i] = "[[span]]" + v.userText(&authors[i]) + "[[/span]]" + parts[i] = v.userText(&authors[i]) } return strings.Join(parts, " "), true case "created_by_linked": @@ -215,7 +215,7 @@ func (v *Vars) compute(name string) (string, bool) { if !ok { return "", false } - return strings.Join(tags, ", "), true + return strings.Join(tags, " "), true case "tags_linked": tags, ok := v.getTags() if !ok { diff --git a/internal/page/vars_test.go b/internal/page/vars_test.go index 93ebb25f..cdb09996 100644 --- a/internal/page/vars_test.go +++ b/internal/page/vars_test.go @@ -286,7 +286,7 @@ func TestLookupUsers(t *testing.T) { v := NewVars(testArticle(), nil, src, nil) tests := []struct{ name, want string }{ - {"created_by", "[[span]]Alice[[/span]] [[span]]bob[[/span]] [[span]]wd:Carol WD[[/span]]"}, + {"created_by", "Alice bob wd:Carol WD"}, {"created_by_linked", "[[*user alice]] [[*user bob]] [[*user carol]]"}, {"created_by_linked_plain", "[[user alice]] [[user bob]] [[user carol]]"}, {"authors_count", "3"}, @@ -343,7 +343,7 @@ func TestLookupTags(t *testing.T) { v := NewVars(testArticle(), nil, src, nil) got, _ := v.Lookup("tags") - if want := "alpha, lang:en, zeta"; got != want { + if want := "alpha lang:en zeta"; got != want { t.Errorf("Lookup(\"tags\") = %q, want %q", got, want) } } diff --git a/modules/listpages/__init__.py b/modules/listpages/__init__.py index c7b48b86..bfdc366e 100644 --- a/modules/listpages/__init__.py +++ b/modules/listpages/__init__.py @@ -110,7 +110,7 @@ def get_authors(): 'current_user_voted': lambda: 'True' if page.votes.filter(user=current_user).exists() else 'False', 'popularity': lambda: str(get_rating('popularity')), 'revisions': lambda: str(len(ArticleLogEntry.objects.filter(article=page))), - 'created_by': lambda: ' '.join([f'[[span]]{render_user_to_text(author)}[[/span]]' for author in get_authors()]), + 'created_by': lambda: ' '.join([render_user_to_text(author) for author in get_authors()]), 'created_by_linked': get_created_by_linked(False), 'created_by_linked_plain': get_created_by_linked(True), 'updated_by': lambda: render_user_to_text(get_updated_by()), @@ -120,7 +120,7 @@ def get_authors(): # content{n} = content sections are not supported yet # preview and preview(n) = first characters of the page are not supported yet # summary = wtf is this? - 'tags': lambda: ', '.join(articles.get_tags(page)), + 'tags': lambda: ' '.join(articles.get_tags(page)), 'tags_linked': lambda: ', '.join(('[/system:page-tags/tag/%s %s]' % (urllib.parse.quote(tag, safe=''), tag)) for tag in articles.get_tags(page)), # _tags, _tags_linked, _tags_linked|link_prefix = not yet # form_data{name}, form_raw{name}, form_label{name}, form_hint{name} = never ever From 7daf365ff7c2f6a902a1b3052cf5ddff349deccb Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 15:25:08 +0900 Subject: [PATCH 137/428] skip the body of a conditional block that will not render --- .../parsing/rule/impls/block/blocks/iftags.rs | 38 +++++++-------- ftml/src/parsing/rule/impls/block/parser.rs | 48 +++++++++++++++++++ 2 files changed, 64 insertions(+), 22 deletions(-) diff --git a/ftml/src/parsing/rule/impls/block/blocks/iftags.rs b/ftml/src/parsing/rule/impls/block/blocks/iftags.rs index 9359d136..79a3be43 100644 --- a/ftml/src/parsing/rule/impls/block/blocks/iftags.rs +++ b/ftml/src/parsing/rule/impls/block/blocks/iftags.rs @@ -55,37 +55,31 @@ fn parse_fn<'r, 't>( None => Err(parser.make_warn(ParseWarningKind::BlockMissingArguments)), })?; + if !no_conditionals && !check_iftags(parser_tx.page_info(), &conditions) { + debug!("Conditions failed, skipping body"); + + parser_tx.skip_body(&BLOCK_IFTAGS, name)?; + + // Cancel all state modifications (forget TOC and footnotes). + parser_tx.rollback(); + + return ok!(true; Elements::None, Vec::new()); + } + // Get body content, never with paragraphs - let (elements, mut exceptions, paragraph_safe) = + let (elements, exceptions, paragraph_safe) = parser_tx.get_body_elements(&BLOCK_IFTAGS, name, false)?.into(); debug!( - "IfTags conditions parsed (conditions length {}, elements length {})", + "IfTags conditions passed (conditions length {}, elements length {})", conditions.len(), elements.len(), ); - // Return elements based on condition - let elements = if no_conditionals || check_iftags(parser_tx.page_info(), &conditions) { - debug!("Conditions passed, including elements"); - - // Confirm parser state modification caused by iftags content. - parser_tx.commit(); - - Elements::Multiple(elements) - } else { - debug!("Conditions failed, excluding elements"); - - // Filter out non-warning exceptions - exceptions.retain(|ex| matches!(ex, ParseException::Warning(_))); - - // Cancel all state modifications (forget TOC and footnotes). - parser_tx.rollback(); - - Elements::None - }; + // Confirm parser state modification caused by iftags content. + parser_tx.commit(); - ok!(paragraph_safe; elements, exceptions) + ok!(paragraph_safe; Elements::Multiple(elements), exceptions) } pub fn check_iftags(info: &PageInfo, conditions: &[ElementCondition]) -> bool { diff --git a/ftml/src/parsing/rule/impls/block/parser.rs b/ftml/src/parsing/rule/impls/block/parser.rs index 309ec1cf..eb90d402 100644 --- a/ftml/src/parsing/rule/impls/block/parser.rs +++ b/ftml/src/parsing/rule/impls/block/parser.rs @@ -137,6 +137,54 @@ where }) } + fn verify_start_block(&mut self, block_name: &str) -> Option<&'r ExtractedToken<'t>> { + self.save_evaluate_fn(|parser| { + parser.get_token(Token::LeftBlock, ParseWarningKind::BlockMissingName)?; + parser.get_optional_space()?; + + let (name, _) = parser.get_block_name_internal(ParseWarningKind::BlockMissingName)?; + Ok(name.eq_ignore_ascii_case(block_name)) + }) + } + + /// Walks past a body without building elements from it. + /// + /// A conditional block whose condition failed discards its body, so the body + /// never has to be well formed. Stepping over the tokens instead of parsing + /// them lets a body that opens a block in one include and closes it in + /// another survive, which is how theme warning banners are written. + pub fn skip_body( + &mut self, + block_rule: &BlockRule, + block_name: &str, + ) -> Result<(), ParseWarning> { + let mut first = true; + let mut depth = 0usize; + + loop { + if self + .verify_end_block(first, block_rule, block_name) + .is_some() + { + if depth == 0 { + return Ok(()); + } + depth -= 1; + first = false; + continue; + } + + if self.verify_start_block(block_name).is_some() { + depth += 1; + first = false; + continue; + } + + first = false; + self.step()?; + } + } + // Body parsing /// Generic helper function that performs the primary block collection. From 62a630508c2994f5ec1fb4154c6fb72bc26cf60f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 15:25:08 +0900 Subject: [PATCH 138/428] accept the block spellings wikidot accepts --- .../parsing/rule/impls/block/blocks/html.rs | 2 +- ftml/src/parsing/rule/impls/block/end.rs | 44 +++++++++++++++++++ ftml/src/parsing/rule/impls/block/mod.rs | 2 + ftml/src/parsing/rule/impls/mod.rs | 1 + ftml/src/parsing/rule/mapping.rs | 2 +- 5 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 ftml/src/parsing/rule/impls/block/end.rs diff --git a/ftml/src/parsing/rule/impls/block/blocks/html.rs b/ftml/src/parsing/rule/impls/block/blocks/html.rs index 1243d50c..a8f11438 100644 --- a/ftml/src/parsing/rule/impls/block/blocks/html.rs +++ b/ftml/src/parsing/rule/impls/block/blocks/html.rs @@ -24,7 +24,7 @@ use super::prelude::*; pub const BLOCK_HTML: BlockRule = BlockRule { name: "block-html", - accepts_names: &["html"], + accepts_names: &["html", "embed"], accepts_star: false, accepts_score: false, accepts_newlines: true, diff --git a/ftml/src/parsing/rule/impls/block/end.rs b/ftml/src/parsing/rule/impls/block/end.rs new file mode 100644 index 00000000..844a624e --- /dev/null +++ b/ftml/src/parsing/rule/impls/block/end.rs @@ -0,0 +1,44 @@ +/* + * parsing/rule/impls/block/end.rs + * + * ftml - Library to parse Wikidot text + * Copyright (C) 2019-2022 Wikijump Team + * + * 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 . + */ + +//! Rule for an end block that closes nothing. +//! +//! A block that is open consumes its own end block while gathering its body, +//! so anything reaching this rule was never opened. Wikidot drops such a tag, +//! and pages carrying one have been written against that for years. + +use super::super::prelude::*; + +pub const RULE_BLOCK_END: Rule = Rule { + name: "block-end", + position: LineRequirement::Any, + try_consume_fn, +}; + +fn try_consume_fn<'p, 'r, 't>( + parser: &'p mut Parser<'r, 't>, +) -> ParseResult<'r, 't, Elements<'t>> { + info!("Consuming an end block that closes nothing"); + + // A malformed tag is left to the fallback so it still shows up as text. + parser.get_end_block()?; + + ok!(Elements::None) +} diff --git a/ftml/src/parsing/rule/impls/block/mod.rs b/ftml/src/parsing/rule/impls/block/mod.rs index 0acf3723..c2fc8b36 100644 --- a/ftml/src/parsing/rule/impls/block/mod.rs +++ b/ftml/src/parsing/rule/impls/block/mod.rs @@ -31,6 +31,7 @@ use crate::tree::{Elements, AcceptsPartial}; use std::fmt::{self, Debug}; mod arguments; +mod end; mod mapping; mod parser; mod rule; @@ -38,6 +39,7 @@ mod rule; pub mod blocks; pub use self::arguments::Arguments; +pub use self::end::RULE_BLOCK_END; pub use self::rule::RULE_BLOCK; /// Define a rule for how to parse a block. diff --git a/ftml/src/parsing/rule/impls/mod.rs b/ftml/src/parsing/rule/impls/mod.rs index 682e04d1..ce29f186 100644 --- a/ftml/src/parsing/rule/impls/mod.rs +++ b/ftml/src/parsing/rule/impls/mod.rs @@ -70,6 +70,7 @@ mod ws_variable; pub use self::anchor::RULE_ANCHOR; pub use self::block::RULE_BLOCK; +pub use self::block::RULE_BLOCK_END; pub use self::blockquote::RULE_BLOCKQUOTE; pub use self::bold::RULE_BOLD; pub use self::center::RULE_CENTER; diff --git a/ftml/src/parsing/rule/mapping.rs b/ftml/src/parsing/rule/mapping.rs index d9386c71..29529d9a 100644 --- a/ftml/src/parsing/rule/mapping.rs +++ b/ftml/src/parsing/rule/mapping.rs @@ -37,7 +37,7 @@ lazy_static! { Token::LeftBracket => vec![RULE_LINK_SINGLE, RULE_TEXT], Token::RightBracket => vec![RULE_TEXT], Token::LeftBlock => vec![RULE_BLOCK, RULE_ANCHOR], - Token::LeftBlockEnd => vec![], + Token::LeftBlockEnd => vec![RULE_BLOCK_END], Token::RightBlock => vec![], Token::LeftMath => vec![RULE_MATH], Token::RightMath => vec![], From 5602ebbc6918f40c45ed207529dd7175b0987a35 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 15:25:19 +0900 Subject: [PATCH 139/428] show a hovertip where wikidot shows one --- web/js/articles/date.ts | 18 +++++- web/js/articles/footnote.ts | 18 ++---- web/js/entrypoints/page-options.tsx | 28 +++++++++ web/js/locales/zh-hans.json | 15 +++++ web/js/util/date-format.ts | 2 +- web/js/util/hovertip.ts | 89 +++++++++++++++++++++++++++++ 6 files changed, 153 insertions(+), 17 deletions(-) create mode 100644 web/js/util/hovertip.ts diff --git a/web/js/articles/date.ts b/web/js/articles/date.ts index 153207d0..d78e3875 100644 --- a/web/js/articles/date.ts +++ b/web/js/articles/date.ts @@ -1,4 +1,5 @@ -import formatDate from '../util/date-format' +import formatDate, { formatTimeAgo } from '../util/date-format' +import { attachHovertip } from '~util/hovertip' export function makeDate(node: HTMLElement) { // hack: mark node as already processed because it was @@ -12,7 +13,12 @@ export function makeDate(node: HTMLElement) { const defaultFormatHere = '%m.%d.%Y %H:%M' const timestamp = Number.parseInt(node.dataset.timestamp ?? '') - const format = node.dataset.format || defaultFormatHere + + // Everything after a pipe is a modifier, not part of the format. Feeding it + // to the formatter would leave it in the page, since anything without a + // percent passes through untouched. + const [rawFormat, ...modifiers] = (node.dataset.format || defaultFormatHere).split('|') + const format = rawFormat || defaultFormatHere const date = new Date(timestamp) @@ -23,6 +29,14 @@ export function makeDate(node: HTMLElement) { formatted = formatDate(date, defaultFormatHere) } + if (modifiers.includes('ago')) { + const absolute = formatted + attachHovertip(node, absolute) + formatted = formatTimeAgo(new Date().getTime() - date.getTime()) + } else if (modifiers.includes('agohover')) { + attachHovertip(node, () => formatTimeAgo(new Date().getTime() - date.getTime())) + } + node.textContent = formatted } catch (e) { /* ... */ diff --git a/web/js/articles/footnote.ts b/web/js/articles/footnote.ts index b80c30cf..2d3fb3dc 100644 --- a/web/js/articles/footnote.ts +++ b/web/js/articles/footnote.ts @@ -1,4 +1,5 @@ import { t } from '~util/i18n' +import { hovertipContainer, show, hide } from '~util/hovertip' export function makeFootnote(node: HTMLElement) { // hack: mark node as already processed because it was if ((node as any)._footnote) { @@ -13,18 +14,7 @@ export function makeFootnote(node: HTMLElement) { return } - let footnoteContainer = document.getElementById('odialog-hovertips') - if (!footnoteContainer) { - footnoteContainer = document.createElement('div') - footnoteContainer.setAttribute('id', 'odialog-hovertips') - Object.assign(footnoteContainer.style, { - position: 'absolute', - zIndex: '100', - top: '0', - width: '100%', - }) - document.body.appendChild(footnoteContainer) - } + const footnoteContainer = hovertipContainer() let footnoteHovertip: HTMLElement | null = footnoteContainer.querySelector('.hovertip.w-footnote-hovertip') if (!footnoteHovertip) { @@ -60,7 +50,7 @@ export function makeFootnote(node: HTMLElement) { } const enableAndPosition = (x: number, y: number) => { - footnoteHovertip.style.display = 'block' + show(footnoteHovertip) footnoteHeading.textContent = shouldBeHeading footnoteContent.innerHTML = shouldBeContent.innerHTML position(x, y) @@ -92,7 +82,7 @@ export function makeFootnote(node: HTMLElement) { } const disable = () => { - footnoteHovertip.style.display = 'none' + hide(footnoteHovertip) footnoteHeading.textContent = '' footnoteContent.innerHTML = '' } diff --git a/web/js/entrypoints/page-options.tsx b/web/js/entrypoints/page-options.tsx index 2e298521..6e5e85af 100644 --- a/web/js/entrypoints/page-options.tsx +++ b/web/js/entrypoints/page-options.tsx @@ -1,4 +1,5 @@ import { t } from '~util/i18n' +import { attachHovertip } from '~util/hovertip' import React, { useEffect, useState } from 'react' import ReactDOM from 'react-dom' import { sprintf } from 'sprintf-js' @@ -63,6 +64,24 @@ type SubViewType = | 'authorship' | null +const BUTTON_HINTS: [string, string][] = [ + ['edit-button', 'page-options.hint.edit'], + ['pagerate-button', 'page-options.hint.rate'], + ['tags-button', 'page-options.hint.tags'], + ['discuss-button', 'page-options.hint.discuss'], + ['history-button', 'page-options.hint.history'], + ['files-button', 'page-options.hint.files'], + ['more-options-button', 'page-options.hint.more'], + ['backlinks-button', 'page-options.hint.backlinks'], + ['view-source-button', 'page-options.hint.source'], + ['view-authorship-button', 'page-options.hint.authorship'], + ['parent-page-button', 'page-options.hint.parent'], + ['child-page-button', 'page-options.hint.new-child'], + ['page-block-button', 'page-options.hint.lock'], + ['rename-move-button', 'page-options.hint.rename'], + ['delete-button', 'page-options.hint.delete'], +] + const PageOptions: React.FC = ({ pageId, optionsEnabled, @@ -110,6 +129,15 @@ const PageOptions: React.FC = ({ if (pathParams?.['edit']) (window as any)._openNewEditor() }, []) + // Runs on every render because the second row of buttons only exists once the + // reader expands it. + useEffect(() => { + for (const [id, key] of BUTTON_HINTS) { + const button = document.getElementById(id) + if (button) attachHovertip(button, t(key)) + } + }) + const onEdit = useConstCallback(e => { e.preventDefault() e.stopPropagation() diff --git a/web/js/locales/zh-hans.json b/web/js/locales/zh-hans.json index 57abca51..92dcc066 100644 --- a/web/js/locales/zh-hans.json +++ b/web/js/locales/zh-hans.json @@ -352,6 +352,21 @@ "page-options.error-dismiss": "关闭", "page-options.error-label": "错误:", "page-options.files": "附件", + "page-options.hint.authorship": "检视并调整本页记录的作者。", + "page-options.hint.backlinks": "检视链接至本页或引用本页的页面。", + "page-options.hint.delete": "删除本页，或将其移入归档分类。", + "page-options.hint.discuss": "若您想要讨论本页内容，这是最简单的方法。", + "page-options.hint.edit": "点击编辑本页内容。", + "page-options.hint.files": "检视并管理本页附件。", + "page-options.hint.history": "查看本页过去是如何沿革的。", + "page-options.hint.lock": "锁定本页，使其只能由管理员编辑。", + "page-options.hint.more": "展开其余的页面工具。", + "page-options.hint.new-child": "以本页为父页面新建一个页面。", + "page-options.hint.parent": "检视 / 设定父页面（用以建立浏览足迹与结构化配置）。", + "page-options.hint.rate": "为本页评分，并查看已投出的票。", + "page-options.hint.rename": "变更页面名称（及 URL 地址，或许会影响分类）。", + "page-options.hint.source": "在不编辑的情形下检视维基源代码。", + "page-options.hint.tags": "检视并修改本页的标签。", "page-options.history": "历史记录", "page-options.lock": "锁定页面", "page-options.more": "选项", diff --git a/web/js/util/date-format.ts b/web/js/util/date-format.ts index 4133c6db..613a4bc3 100644 --- a/web/js/util/date-format.ts +++ b/web/js/util/date-format.ts @@ -7,7 +7,7 @@ function padString(paddingValue: string, str: string) { return String(paddingValue + str).slice(-paddingValue.length) } -function formatTimeAgo(diffMs: number) { +export function formatTimeAgo(diffMs: number) { const minutes = Math.floor(diffMs / 1000 / 60) if (minutes < 1) { return t('util.date-format.just-now') diff --git a/web/js/util/hovertip.ts b/web/js/util/hovertip.ts new file mode 100644 index 00000000..c6375183 --- /dev/null +++ b/web/js/util/hovertip.ts @@ -0,0 +1,89 @@ +// Wikidot themes style `.hovertip` and its `.content` child, so the markup has +// to keep that shape even though nothing in this file reads those rules. + +export function hovertipContainer(): HTMLElement { + let container = document.getElementById('odialog-hovertips') + if (!container) { + container = document.createElement('div') + container.setAttribute('id', 'odialog-hovertips') + Object.assign(container.style, { + position: 'absolute', + zIndex: '100', + top: '0', + width: '100%', + }) + document.body.appendChild(container) + } + return container +} + +// Site themes reach for .hovertip to restyle it, and one of them wins over a +// plain inline display. The tip is ours, so it declares its own visibility the +// only way nothing else can override. +export function show(tip: HTMLElement) { + tip.style.setProperty('display', 'block', 'important') +} + +export function hide(tip: HTMLElement) { + tip.style.setProperty('display', 'none', 'important') +} + +function position(tip: HTMLElement, x: number, y: number) { + tip.style.left = '0' + tip.style.top = '0' + const r = tip.getBoundingClientRect() + + const centeredX = x - r.width / 2 + 4 + if (centeredX + r.width > window.innerWidth) { + x = Math.max(0, window.innerWidth - r.width) + } else if (centeredX < 0) { + x = 0 + } else { + x = centeredX + } + + if (y + r.height + 8 > window.innerHeight && y - 8 > r.height) { + y = Math.max(0, y - r.height - 8) + } else { + y += 8 + } + + tip.style.left = `${x}px` + tip.style.top = `${y}px` +} + +export function attachHovertip(node: HTMLElement, text: string | (() => string)) { + if ((node as any)._hovertip) { + return + } + ;(node as any)._hovertip = true + + const container = hovertipContainer() + + let tip: HTMLElement | null = container.querySelector('.hovertip.w-plain-hovertip') + if (!tip) { + tip = document.createElement('div') + tip.setAttribute('class', 'hovertip w-plain-hovertip') + Object.assign(tip.style, { position: 'fixed', display: 'none' }) + tip.innerHTML = '
' + container.appendChild(tip) + } + const content: HTMLElement = tip.querySelector('.content')! + + node.style.cursor = 'help' + + node.addEventListener('mouseover', e => { + content.textContent = typeof text === 'function' ? text() : text + show(tip) + position(tip, e.clientX, e.clientY) + }) + + node.addEventListener('mousemove', e => { + position(tip, e.clientX, e.clientY) + }) + + node.addEventListener('mouseout', () => { + hide(tip) + content.textContent = '' + }) +} From e83b071fd8c568ae1e666655d05225888a8984f7 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 15:25:19 +0900 Subject: [PATCH 140/428] wrap a bare menu label the way wikidot does --- web/js/articles/top-bar.ts | 17 +++++++++++++++++ web/js/index.tsx | 2 ++ 2 files changed, 19 insertions(+) create mode 100644 web/js/articles/top-bar.ts diff --git a/web/js/articles/top-bar.ts b/web/js/articles/top-bar.ts new file mode 100644 index 00000000..233b920e --- /dev/null +++ b/web/js/articles/top-bar.ts @@ -0,0 +1,17 @@ +// A menu entry that only opens its submenu is written without a link, so its +// label arrives as a bare text node that the theme's `li > a` rules cannot +// reach. Wrapping it produces the same element the linked form would have. +export function makeTopBar() { + for (const li of document.querySelectorAll('#top-bar li')) { + const first = li.firstChild + if (!first || first.nodeType !== Node.TEXT_NODE) continue + + const label = (first.textContent ?? '').trim() + if (!label) continue + + const link = document.createElement('a') + link.setAttribute('href', 'javascript:;') + link.textContent = label + li.replaceChild(link, first) + } +} diff --git a/web/js/index.tsx b/web/js/index.tsx index 845a8cb2..6039ab99 100644 --- a/web/js/index.tsx +++ b/web/js/index.tsx @@ -28,6 +28,7 @@ import { makeRecentPosts } from './forum/recent-posts-pagination' import { makeForumThread } from './forum/thread-pagination' import ReactivePage from './reactive/router' import { makePasswordToggle } from './util/password' +import { makeTopBar } from './articles/top-bar' import AdminSusUsers from './entrypoints/admin-sus-users' import { renderTo } from '~util/react-render-into' @@ -49,6 +50,7 @@ window.addEventListener('DOMContentLoaded', () => { makePasswordToggle() attachUserActions() + makeTopBar() // add new things here! const processNode = (node: HTMLElement) => { From 3beeab1f58efd104ed2d42dcc2a5cd729bd4d2ba Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 15:25:19 +0900 Subject: [PATCH 141/428] load no stylesheet of our own when the site brings its own --- internal/articlepage/render.go | 4 ++-- internal/shell/templates/page.html | 2 +- internal/site/theme.go | 14 ++++---------- internal/site/theme_test.go | 8 ++++---- 4 files changed, 11 insertions(+), 17 deletions(-) diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 2c9ed324..96935350 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -527,11 +527,11 @@ func (h *Handler) shellData(req *request, out body, canonical, navTop, navSide s func (h *Handler) themeURL(req *request) (string, error) { if req.site.ThemeID == nil { - return site.DefaultThemeURL, nil + return "", nil } theme, err := h.deps.DB.ThemeByID(req.ctx, *req.site.ThemeID) if errors.Is(err, db.ErrNotFound) { - return site.DefaultThemeURL, nil + return "", nil } if err != nil { return "", err diff --git a/internal/shell/templates/page.html b/internal/shell/templates/page.html index 8646b66a..e01b2ff5 100644 --- a/internal/shell/templates/page.html +++ b/internal/shell/templates/page.html @@ -32,7 +32,7 @@ - + {{if .ThemeURL}}{{end}} diff --git a/internal/site/theme.go b/internal/site/theme.go index ed6c9ac3..05882e9b 100644 --- a/internal/site/theme.go +++ b/internal/site/theme.go @@ -5,22 +5,16 @@ import ( "strings" "github.com/WikitTeam/ProjectWikit/internal/db" - "github.com/WikitTeam/ProjectWikit/internal/static" ) -const DefaultThemeURL = static.Prefix + "theme.css" - -// ThemeURL is the stylesheet a page loads after the base one. A theme that is -// gone or points at nothing falls back rather than leaving the page unstyled. +// A site with no usable theme loads nothing, so the base stylesheet stays the +// only thing under the site's own CSS, which is what a wikidot theme expects. func ThemeURL(t *db.Theme) string { if t == nil { - return DefaultThemeURL + return "" } if t.Mode == db.ThemeExternal { - if url := strings.TrimSpace(t.ExternalURL); url != "" { - return url - } - return DefaultThemeURL + return strings.TrimSpace(t.ExternalURL) } return "/-/theme/" + t.Slug + ".css?v=" + strconv.FormatInt(t.UpdatedAt.Unix(), 10) } diff --git a/internal/site/theme_test.go b/internal/site/theme_test.go index 8d076951..6ab5b16b 100644 --- a/internal/site/theme_test.go +++ b/internal/site/theme_test.go @@ -8,8 +8,8 @@ import ( ) func TestThemeURLWithoutTheme(t *testing.T) { - if got := ThemeURL(nil); got != DefaultThemeURL { - t.Errorf("ThemeURL(nil) = %q, want %q", got, DefaultThemeURL) + if got := ThemeURL(nil); got != "" { + t.Errorf("ThemeURL(nil) = %q, want %q", got, "") } } @@ -31,7 +31,7 @@ func TestThemeURLOfExternalTheme(t *testing.T) { func TestThemeURLOfExternalThemeWithoutURL(t *testing.T) { theme := &db.Theme{Slug: "dark", Mode: db.ThemeExternal, ExternalURL: " "} - if got := ThemeURL(theme); got != DefaultThemeURL { - t.Errorf("ThemeURL(external without url) = %q, want %q", got, DefaultThemeURL) + if got := ThemeURL(theme); got != "" { + t.Errorf("ThemeURL(external without url) = %q, want %q", got, "") } } From 60fd83bde67bbc01896ed9755261d6fa7959934f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 15:25:19 +0900 Subject: [PATCH 142/428] put every css module block in the head --- internal/modules/css.go | 14 ++----- internal/modules/css_test.go | 8 ++-- internal/modules/testdata/css.golden | 48 +++++++++++------------ internal/modules/testdata/css_corpus.json | 8 ++-- 4 files changed, 36 insertions(+), 42 deletions(-) diff --git a/internal/modules/css.go b/internal/modules/css.go index 78a45777..d20df443 100644 --- a/internal/modules/css.go +++ b/internal/modules/css.go @@ -18,9 +18,9 @@ func newCSSMinifier() *minify.M { return m } +// Every block goes to the head, so a rule cannot lose to one that merely sits +// higher up the page. The head argument is accepted and ignored. func renderCSS(env module.Env, params map[string]string, body string) (string, error) { - head := module.BoolParam(pathUnder(env, params), "head", false) - source := strings.ReplaceAll(body, nbsp, " ") minified, err := cssMinifier.String("text/css", source) if err != nil { @@ -30,14 +30,8 @@ func renderCSS(env module.Env, params map[string]string, body string) (string, e if env.Page != nil { env.Page.AddCSS += source + "\n" - if head { - env.Page.ComputedStyle += minified - } + env.Page.ComputedStyle += minified } - if head { - return "\n" + ind8, nil - } - return "\n" + ind12 + `` + - "\n" + ind8 + "\n" + ind8, nil + return "\n" + ind8, nil } diff --git a/internal/modules/css_test.go b/internal/modules/css_test.go index fc9f7a28..243551b6 100644 --- a/internal/modules/css_test.go +++ b/internal/modules/css_test.go @@ -29,10 +29,10 @@ type cssCase struct { func cssCases() []cssCase { return []cssCase{ {Name: "plain", Body: "#page-content { color : red ; }"}, - {Name: "head", Body: "#page-content { color : red ; }", Params: map[string]string{"head": "true"}}, - {Name: "head-from-path", Body: "a { color : red }", Path: map[string]string{"head": "yes"}}, - {Name: "head-false", Body: "a { color : red }", Params: map[string]string{"head": "no"}}, - {Name: "head-junk", Body: "a { color : red }", Params: map[string]string{"head": "maybe"}}, + {Name: "ignores-head", Body: "#page-content { color : red ; }", Params: map[string]string{"head": "true"}}, + {Name: "ignores-head-from-path", Body: "a { color : red }", Path: map[string]string{"head": "yes"}}, + {Name: "ignores-head-false", Body: "a { color : red }", Params: map[string]string{"head": "no"}}, + {Name: "ignores-head-junk", Body: "a { color : red }", Params: map[string]string{"head": "maybe"}}, {Name: "empty", Body: ""}, {Name: "comment-only", Body: "/* nothing but a comment */"}, {Name: "nbsp", Body: "a { color:red }"}, diff --git a/internal/modules/testdata/css.golden b/internal/modules/testdata/css.golden index 54aa4a58..94673d59 100644 --- a/internal/modules/testdata/css.golden +++ b/internal/modules/testdata/css.golden @@ -1,52 +1,52 @@ === plain -returned: "\n \n \n " -computed: "" +returned: "\n " +computed: "#page-content{color:red}" addcss: "#page-content { color : red ; }\n" -=== head +=== ignores-head returned: "\n " computed: "#page-content{color:red}" addcss: "#page-content { color : red ; }\n" -=== head-from-path +=== ignores-head-from-path returned: "\n " computed: "a{color:red}" addcss: "a { color : red }\n" -=== head-false -returned: "\n \n \n " -computed: "" +=== ignores-head-false +returned: "\n " +computed: "a{color:red}" addcss: "a { color : red }\n" -=== head-junk -returned: "\n \n \n " -computed: "" +=== ignores-head-junk +returned: "\n " +computed: "a{color:red}" addcss: "a { color : red }\n" === empty -returned: "\n \n \n " +returned: "\n " computed: "" addcss: "\n" === comment-only -returned: "\n \n \n " +returned: "\n " computed: "" addcss: "/* nothing but a comment */\n" === nbsp -returned: "\n \n \n " -computed: "" +returned: "\n " +computed: "a{color:red}" addcss: "a { color:red }\n" === angle-bracket -returned: "\n \n \n " -computed: "" +returned: "\n " +computed: "a>b{content:\"\\u003c/style>\"}" addcss: "a > b { content: \"\" }\n" === at-import -returned: "\n \n \n " -computed: "" +returned: "\n " +computed: "@import \"x.css\";a{color:red}" addcss: "@import url(\"x.css\");\na { color: red }\n" === media -returned: "\n \n \n " -computed: "" +returned: "\n " +computed: "@media(max-width:767px){#main{padding:0}}" addcss: "@media (max-width: 767px) {\n #main { padding : 0 ; }\n}\n" === two-rules -returned: "\n \n \n " -computed: "" +returned: "\n " +computed: ".a{color:red}.b{margin:.5em}" addcss: ".a { color: #ff0000 }\n.b { margin: 0.50em }\n" === malformed -returned: "\n \n \n " -computed: "" +returned: "\n " +computed: "a{color:red}" addcss: "a { color: red\n" diff --git a/internal/modules/testdata/css_corpus.json b/internal/modules/testdata/css_corpus.json index 589446c5..f981caa6 100644 --- a/internal/modules/testdata/css_corpus.json +++ b/internal/modules/testdata/css_corpus.json @@ -4,28 +4,28 @@ "body": "#page-content { color : red ; }" }, { - "name": "head", + "name": "ignores-head", "body": "#page-content { color : red ; }", "params": { "head": "true" } }, { - "name": "head-from-path", + "name": "ignores-head-from-path", "body": "a { color : red }", "path": { "head": "yes" } }, { - "name": "head-false", + "name": "ignores-head-false", "body": "a { color : red }", "params": { "head": "no" } }, { - "name": "head-junk", + "name": "ignores-head-junk", "body": "a { color : red }", "params": { "head": "maybe" From fd42d14f89af338560d19a8fba6a43375e5a0ab5 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 16:31:51 +0900 Subject: [PATCH 143/428] look up an imported user by the name that was stored --- internal/db/user.go | 8 ++++---- internal/repo/repo.go | 2 +- renderer/__init__.py | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/internal/db/user.go b/internal/db/user.go index 5502c017..30752700 100644 --- a/internal/db/user.go +++ b/internal/db/user.go @@ -137,10 +137,10 @@ func (d *DB) UserByDisplayName(ctx context.Context, name string) (*User, error) return d.scanUser(ctx, qUserByDisplayName, name) } -// UserByWikidotName resolves the wd: prefix, which may only ever match an -// imported Wikidot account. -func (d *DB) UserByWikidotName(ctx context.Context, canonical string) (*User, error) { - return d.scanUser(ctx, qUserByWikidotName, canonical) +// The stored name is whatever the other site displayed, so canonicalizing +// first would compare a spaced name against a hyphenated one and never match. +func (d *DB) UserByWikidotName(ctx context.Context, name string) (*User, error) { + return d.scanUser(ctx, qUserByWikidotName, name) } func (d *DB) scanUser(ctx context.Context, sql, canonical string) (*User, error) { diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 6327f422..086582fc 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -119,7 +119,7 @@ func (r *Repository) RenderUser(username string, avatar bool) (string, error) { err error ) if wd, ok := cutPrefixFold(username, "wd:"); ok { - user, err = r.db.UserByWikidotName(r.ctx, wikidot.CanonicalizeUsername(wd)) + user, err = r.db.UserByWikidotName(r.ctx, wd) } else { user, err = r.db.UserByName(r.ctx, wikidot.CanonicalizeUsername(username)) // An imported account keeps the name it had on the other site, which diff --git a/renderer/__init__.py b/renderer/__init__.py index 4dbea2b6..a72d6972 100644 --- a/renderer/__init__.py +++ b/renderer/__init__.py @@ -46,7 +46,7 @@ def render_user(self, username: str, avatar: bool) -> str: user = username[len('external:'):] return render_external_user_to_html(user, avatar=avatar) if username.lower().startswith('wd:'): - user = User.objects.get(type=User.UserType.Wikidot, wikidot_username=canonicalize_username(username[3:])) + user = User.objects.get(type=User.UserType.Wikidot, wikidot_username=username[3:]) else: canon = canonicalize_username(username) user = User.objects.filter(Q(username=canon) | Q(wikidot_username=canon)).first() From 2d7aabd9c94f2f40f72f4ccd667c9182aaa02f8d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 20:59:39 +0900 Subject: [PATCH 144/428] let the host say where a block ends and a module fits --- cmd/pwikit/trace.go | 5 +++ ftml-capi/src/lib.rs | 10 +++++ ftml-sidecar/src/main.rs | 6 +++ ftml/src/data/page_callbacks.rs | 7 ++++ ftml/src/includes/parse.rs | 9 ++-- .../parsing/rule/impls/block/blocks/iftags.rs | 5 ++- .../rule/impls/block/blocks/module/rule.rs | 4 +- ftml/src/tree/element/object.rs | 4 +- internal/callbacks/callbacks.go | 4 ++ internal/callbacks/callbacks_test.go | 25 +++++++++++ .../callbacks/testdata/callback_trace.golden | 3 ++ internal/callbacks/trace_test.go | 5 +++ internal/module/registry.go | 13 +++++- internal/module/registry_test.go | 6 +++ internal/renderer/cgo/bridge.go | 9 ++++ internal/renderer/cgo/ftml.h | 1 + internal/renderer/cgo/trampolines.c | 1 + internal/renderer/fake.go | 3 +- internal/renderer/renderer.go | 1 + internal/renderer/sidecar/dispatch.go | 13 ++++++ internal/renderer/sidecar/integration_test.go | 42 +++++++++++++++++++ 21 files changed, 165 insertions(+), 11 deletions(-) diff --git a/cmd/pwikit/trace.go b/cmd/pwikit/trace.go index 0e2c73f4..3545f6e1 100644 --- a/cmd/pwikit/trace.go +++ b/cmd/pwikit/trace.go @@ -24,6 +24,11 @@ func (t *tracer) ModuleHasBody(name string) (bool, error) { return t.inner.ModuleHasBody(name) } +func (t *tracer) ModuleIsInline(name string) (bool, error) { + t.log("module_is_inline(%s)", name) + return t.inner.ModuleIsInline(name) +} + func (t *tracer) RenderModule(name string, params map[string]string, body string) (string, error) { t.log("render_module(%s, {%s}, body=%q)", name, joinPairs(params), body) return t.inner.RenderModule(name, params, body) diff --git a/ftml-capi/src/lib.rs b/ftml-capi/src/lib.rs index c415872e..019fdeb0 100644 --- a/ftml-capi/src/lib.rs +++ b/ftml-capi/src/lib.rs @@ -150,6 +150,7 @@ pub unsafe extern "C" fn ftml_sink_fetched_page( #[repr(C)] pub struct FtmlCallbacks { pub module_has_body: Option c_int>, + pub module_is_inline: Option c_int>, pub render_module: Option< extern "C" fn(usize, FtmlStr, *const FtmlKeyValue, usize, FtmlStr, *mut FtmlStringSink), >, @@ -254,6 +255,15 @@ impl PageCallbacks for HostBridge { } } + fn module_is_inline(&self, module_name: Cow) -> bool { + unsafe { + match self.vtable().module_is_inline { + Some(f) => f(self.host, FtmlStr::borrow(&module_name)) != 0, + None => false, + } + } + } + fn render_module( &self, module_name: Cow, diff --git a/ftml-sidecar/src/main.rs b/ftml-sidecar/src/main.rs index 6628f7be..d6735a68 100644 --- a/ftml-sidecar/src/main.rs +++ b/ftml-sidecar/src/main.rs @@ -94,6 +94,12 @@ impl PageCallbacks for Bridge { .unwrap_or(false) } + fn module_is_inline(&self, module_name: Cow) -> bool { + self.call("module_is_inline", json!({ "name": module_name })) + .as_bool() + .unwrap_or(false) + } + fn render_module( &self, module_name: Cow, diff --git a/ftml/src/data/page_callbacks.rs b/ftml/src/data/page_callbacks.rs index 2910a84f..8363875f 100644 --- a/ftml/src/data/page_callbacks.rs +++ b/ftml/src/data/page_callbacks.rs @@ -29,6 +29,13 @@ impl<'t> ToString for ExpressionResult<'t> { pub trait PageCallbacks: Debug { fn module_has_body(&self, module_name: Cow) -> bool; + + /// A module that stays inline does not break the paragraph around it. + /// Defaulting to false leaves a host that does not answer unchanged. + fn module_is_inline(&self, _module_name: Cow) -> bool { + false + } + fn render_module<'a>(&self, module_name: Cow, params: HashMap, Cow>, body: Cow) -> Cow<'static, str>; fn render_user<'a>(&self, user: Cow, avatar: bool) -> Cow<'static, str>; fn get_i18n_message<'a>(&self, message_id: Cow) -> Cow<'static, str>; diff --git a/ftml/src/includes/parse.rs b/ftml/src/includes/parse.rs index 6344bfe3..c8b67b06 100644 --- a/ftml/src/includes/parse.rs +++ b/ftml/src/includes/parse.rs @@ -86,7 +86,7 @@ fn process_pairs(mut pairs: Pairs) -> Result) -> Result( return ok!(true; Elements::None, Vec::new()); } - // Get body content, never with paragraphs + // Wikidot ends the paragraph at a conditional block, so the body has to make + // its own rather than run together with whatever follows. let (elements, exceptions, paragraph_safe) = - parser_tx.get_body_elements(&BLOCK_IFTAGS, name, false)?.into(); + parser_tx.get_body_elements(&BLOCK_IFTAGS, name, true)?.into(); debug!( "IfTags conditions passed (conditions length {}, elements length {})", diff --git a/ftml/src/parsing/rule/impls/block/blocks/module/rule.rs b/ftml/src/parsing/rule/impls/block/blocks/module/rule.rs index 12612c51..f2281988 100644 --- a/ftml/src/parsing/rule/impls/block/blocks/module/rule.rs +++ b/ftml/src/parsing/rule/impls/block/blocks/module/rule.rs @@ -59,5 +59,7 @@ fn parse_fn<'r, 't>( parser.replace_variables(body.to_mut()); - return ok!(false; Elements::Single(Element::Module(Module::new(Cow::from(subname), arguments.to_hash_map(), body))), vec![]); + let inline = parser.page_callbacks().module_is_inline(Cow::from(subname)); + + return ok!(inline; Elements::Single(Element::Module(Module::new(Cow::from(subname), arguments.to_hash_map(), body))), vec![]); } diff --git a/ftml/src/tree/element/object.rs b/ftml/src/tree/element/object.rs index ba026b60..71c7902d 100644 --- a/ftml/src/tree/element/object.rs +++ b/ftml/src/tree/element/object.rs @@ -373,7 +373,9 @@ impl Element<'_> { Element::Anchor { .. } | Element::AnchorName(_) | Element::Link { .. } => { true } - Element::Image { .. } => true, + // Wikidot gives an image its own block. Left in a paragraph it picks + // up that paragraph's margins and pulls away from its frame. + Element::Image { .. } => false, Element::List { .. } => false, Element::DefinitionList(_) => false, Element::Collapsible { .. } => false, diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go index 538d398b..073823a9 100644 --- a/internal/callbacks/callbacks.go +++ b/internal/callbacks/callbacks.go @@ -68,6 +68,10 @@ func (c *Callbacks) ModuleHasBody(name string) (bool, error) { return module.HasContent(name), nil } +func (c *Callbacks) ModuleIsInline(name string) (bool, error) { + return module.IsInline(name), nil +} + func (c *Callbacks) RenderModule(name string, params map[string]string, body string) (string, error) { if c.repo == nil { return "", ErrNoRepository diff --git a/internal/callbacks/callbacks_test.go b/internal/callbacks/callbacks_test.go index 064370fb..0c886ab7 100644 --- a/internal/callbacks/callbacks_test.go +++ b/internal/callbacks/callbacks_test.go @@ -92,6 +92,31 @@ func TestModuleHasBody(t *testing.T) { } } +func TestModuleIsInline(t *testing.T) { + c := newCallbacks(t, nil) + tests := []struct { + name string + want bool + }{ + {"button", true}, + {"BUTTON", true}, + {"css", false}, + {"listpages", false}, + {"nosuchmodule", false}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := c.ModuleIsInline(tt.name) + if err != nil { + t.Fatalf("ModuleIsInline(%q) err = %v, want nil", tt.name, err) + } + if got != tt.want { + t.Errorf("ModuleIsInline(%q) = %v, want %v", tt.name, got, tt.want) + } + }) + } +} + func TestRenderModuleLowercasesParamKeys(t *testing.T) { repo := &fakeRepo{} c := newCallbacks(t, repo) diff --git a/internal/callbacks/testdata/callback_trace.golden b/internal/callbacks/testdata/callback_trace.golden index ef31a96c..d8207088 100644 --- a/internal/callbacks/testdata/callback_trace.golden +++ b/internal/callbacks/testdata/callback_trace.golden @@ -14,6 +14,7 @@ get_page_info([exists missing]) next_include_level() include_pages([]) module_has_body(Rate) +module_is_inline(Rate) get_page_info([]) render_module(Rate, {}, body="") @@ -21,6 +22,7 @@ render_module(Rate, {}, body="") next_include_level() include_pages([]) module_has_body(Rate) +module_is_inline(Rate) get_page_info([]) render_module(Rate, {limit="5", showVotes="true"}, body="") @@ -34,6 +36,7 @@ get_page_info([]) next_include_level() include_pages([]) module_has_body(ListPages) +module_is_inline(ListPages) get_page_info([]) render_module(ListPages, {}, body="%%title%%") diff --git a/internal/callbacks/trace_test.go b/internal/callbacks/trace_test.go index 1aee89c4..922cd6bc 100644 --- a/internal/callbacks/trace_test.go +++ b/internal/callbacks/trace_test.go @@ -32,6 +32,11 @@ func (t *tracer) ModuleHasBody(name string) (bool, error) { return t.inner.ModuleHasBody(name) } +func (t *tracer) ModuleIsInline(name string) (bool, error) { + t.log("module_is_inline(%s)", name) + return t.inner.ModuleIsInline(name) +} + func (t *tracer) RenderModule(name string, params map[string]string, body string) (string, error) { keys := make([]string, 0, len(params)) for k := range params { diff --git a/internal/module/registry.go b/internal/module/registry.go index 1b9b5334..b56eff36 100644 --- a/internal/module/registry.go +++ b/internal/module/registry.go @@ -8,20 +8,24 @@ import ( type Info struct { Name string HasContent bool + Inline bool Removed bool } var registry = map[string]Info{ "applicationform": {Name: "applicationform"}, - "button": {Name: "button"}, + "button": {Name: "button", Inline: true}, + "comments": {Name: "comments"}, "countpages": {Name: "countpages", HasContent: true}, "css": {Name: "css", HasContent: true}, + "files": {Name: "files"}, "forumcategory": {Name: "forumcategory"}, "forumnewpost": {Name: "forumnewpost"}, "forumnewthread": {Name: "forumnewthread"}, "forumpost": {Name: "forumpost"}, "forumstart": {Name: "forumstart"}, "forumthread": {Name: "forumthread"}, + "gallery": {Name: "gallery"}, "interwiki": {Name: "interwiki", HasContent: true, Removed: true}, "listpages": {Name: "listpages", HasContent: true}, "listusers": {Name: "listusers", HasContent: true}, @@ -52,6 +56,13 @@ func HasContent(name string) bool { return ok && !info.Removed && info.HasContent } +// A module that renders a block cannot sit in a paragraph without closing +// it, so only the ones that render a span of their own answer true. +func IsInline(name string) bool { + info, ok := Lookup(name) + return ok && !info.Removed && info.Inline +} + // Ported is derived from the renderers that registered themselves, so the list // cannot drift from the code that answers. func Ported(name string) bool { diff --git a/internal/module/registry_test.go b/internal/module/registry_test.go index 2bd3aa53..6b0f36c4 100644 --- a/internal/module/registry_test.go +++ b/internal/module/registry_test.go @@ -16,6 +16,12 @@ func TestLookupOfAnUnknownName(t *testing.T) { } } +func TestIsInlineOfARemovedModule(t *testing.T) { + if IsInline("interwiki") { + t.Error("IsInline(\"interwiki\") = true, want false") + } +} + func TestHasContentOfARemovedModule(t *testing.T) { info, ok := Lookup("interwiki") if !ok || !info.HasContent { diff --git a/internal/renderer/cgo/bridge.go b/internal/renderer/cgo/bridge.go index 3bbec0be..a70930cb 100644 --- a/internal/renderer/cgo/bridge.go +++ b/internal/renderer/cgo/bridge.go @@ -65,6 +65,15 @@ func pwikitModuleHasBody(h C.uintptr_t, name C.FtmlStr) C.int { return 1 } +//export pwikitModuleIsInline +func pwikitModuleIsInline(h C.uintptr_t, name C.FtmlStr) C.int { + ok, err := host(h).ModuleIsInline(goString(name)) + if err != nil || !ok { + return 0 + } + return 1 +} + //export pwikitRenderModule func pwikitRenderModule(h C.uintptr_t, name C.FtmlStr, params *C.FtmlKeyValue, count C.size_t, body C.FtmlStr, sink *C.FtmlStringSink) { values := make(map[string]string, int(count)) diff --git a/internal/renderer/cgo/ftml.h b/internal/renderer/cgo/ftml.h index 4f708694..f853a4a2 100644 --- a/internal/renderer/cgo/ftml.h +++ b/internal/renderer/cgo/ftml.h @@ -47,6 +47,7 @@ void ftml_sink_fetched_page(FtmlFetchedPageSink *sink, FtmlStr full_name, FtmlSt Declaring it uintptr_t keeps Go's garbage collector from scanning it as one. */ typedef struct { int (*module_has_body)(uintptr_t, FtmlStr); + int (*module_is_inline)(uintptr_t, FtmlStr); void (*render_module)(uintptr_t, FtmlStr, FtmlKeyValue *, size_t, FtmlStr, FtmlStringSink *); void (*render_user)(uintptr_t, FtmlStr, int, FtmlStringSink *); void (*get_i18n_message)(uintptr_t, FtmlStr, FtmlStringSink *); diff --git a/internal/renderer/cgo/trampolines.c b/internal/renderer/cgo/trampolines.c index 6d227c2d..9b98158c 100644 --- a/internal/renderer/cgo/trampolines.c +++ b/internal/renderer/cgo/trampolines.c @@ -5,6 +5,7 @@ void pwikit_fill_callbacks(FtmlCallbacks *out) { out->module_has_body = pwikitModuleHasBody; + out->module_is_inline = pwikitModuleIsInline; out->render_module = pwikitRenderModule; out->render_user = pwikitRenderUser; out->get_i18n_message = pwikitGetI18nMessage; diff --git a/internal/renderer/fake.go b/internal/renderer/fake.go index 6db7fb2e..32c8510f 100644 --- a/internal/renderer/fake.go +++ b/internal/renderer/fake.go @@ -58,7 +58,8 @@ type NopCallbacks struct{} var _ Callbacks = NopCallbacks{} -func (NopCallbacks) ModuleHasBody(string) (bool, error) { return false, nil } +func (NopCallbacks) ModuleHasBody(string) (bool, error) { return false, nil } +func (NopCallbacks) ModuleIsInline(string) (bool, error) { return false, nil } func (NopCallbacks) RenderModule(string, map[string]string, string) (string, error) { return "", nil diff --git a/internal/renderer/renderer.go b/internal/renderer/renderer.go index d43a2389..651d34a8 100644 --- a/internal/renderer/renderer.go +++ b/internal/renderer/renderer.go @@ -91,6 +91,7 @@ func IntExpr(v int64) ExpressionResult { return ExpressionResult{Kind: ExprI type PageCallbacks interface { ModuleHasBody(name string) (bool, error) + ModuleIsInline(name string) (bool, error) RenderModule(name string, params map[string]string, body string) (string, error) RenderUser(user string, avatar bool) (string, error) GetI18nMessage(id string) (string, error) diff --git a/internal/renderer/sidecar/dispatch.go b/internal/renderer/sidecar/dispatch.go index 9cb33190..251561c3 100644 --- a/internal/renderer/sidecar/dispatch.go +++ b/internal/renderer/sidecar/dispatch.go @@ -32,6 +32,19 @@ func dispatch(cb renderer.Callbacks, method string, raw json.RawMessage) (any, e } return v, nil + case "module_is_inline": + var a struct { + Name string `json:"name"` + } + if err := decode(&a); err != nil { + return nil, err + } + v, err := cb.ModuleIsInline(a.Name) + if err != nil { + return fail(err) + } + return v, nil + case "render_module": var a struct { Name string `json:"name"` diff --git a/internal/renderer/sidecar/integration_test.go b/internal/renderer/sidecar/integration_test.go index fd1f83ab..af5c9f83 100644 --- a/internal/renderer/sidecar/integration_test.go +++ b/internal/renderer/sidecar/integration_test.go @@ -12,6 +12,7 @@ import ( type stubHost struct { renderer.NopCallbacks existing map[string]bool + included string } func (h stubHost) RenderModule(name string, _ map[string]string, _ string) (string, error) { @@ -37,6 +38,19 @@ func (h stubHost) NoSuchInclude(fullName string) (string, error) { return "[[include " + fullName + " missing]]", nil } +func (h stubHost) IncludePages(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) { + out := make([]renderer.FetchedPage, 0, len(refs)) + for _, ref := range refs { + page := renderer.FetchedPage{FullName: ref.FullName} + if h.existing[ref.FullName] { + body := h.included + page.Content = &body + } + out = append(out, page) + } + return out, nil +} + func newReal(t *testing.T) *Renderer { t.Helper() bin := os.Getenv(EnvBinary) @@ -51,6 +65,34 @@ func newReal(t *testing.T) *Renderer { return r } +func TestRealSidecarTakesAFallbackArgument(t *testing.T) { + r := newReal(t) + host := stubHost{existing: map[string]bool{"probe": true}, included: "[{$a}]"} + info := renderer.PageInfo{Page: "173", Category: "scp", Domain: "example.org"} + + tests := []struct { + name string + source string + want string + }{ + {"no space", "[[include probe |a={$a}|a=fallback]]", "[fallback]"}, + {"space before the pipe", "[[include probe |a={$a} |a=fallback]]", "[fallback]"}, + {"caller wins", "[[include probe |a=given |a=fallback]]", "[given]"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := r.RenderHTML(context.Background(), tt.source, info, host, renderer.ModeArticle) + if err != nil { + t.Fatalf("RenderHTML(%q) err = %v, want nil", tt.source, err) + } + if !strings.Contains(got.Body, tt.want) { + t.Errorf("RenderHTML(%q) = %q, want substring %q", tt.source, got.Body, tt.want) + } + }) + } +} + func TestRealSidecarRendersHTML(t *testing.T) { r := newReal(t) host := stubHost{existing: map[string]bool{"exists": true}} From 340680115cc593ddfa71b5a1014f090d4633801e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 20:59:47 +0900 Subject: [PATCH 145/428] render buttons the way wikidot renders them --- internal/i18n/locales/zh-hans.json | 10 +++- internal/modules/button.go | 28 +++++++--- internal/modules/button_test.go | 77 +++++++++++++++++++++++--- internal/page/button.go | 61 ++++++++++++++++++++- internal/page/button_test.go | 32 +++++++++++ web/js/articles/buttons.ts | 86 ++++++++++++++++++++++++++++++ web/js/articles/lightbox.ts | 48 +++++++++++++++++ web/js/index.tsx | 4 ++ 8 files changed, 330 insertions(+), 16 deletions(-) create mode 100644 web/js/articles/buttons.ts create mode 100644 web/js/articles/lightbox.ts diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 4d2701d1..74286764 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -14,13 +14,18 @@ "module-applicationform-submit": "提交", "module-applied-failed": "提交失败，请检查填写的内容。", "module-applied-ok": "已提交，等待管理员处理。", - "module-button-edit": "编辑", "module-button-unknown": "不支持的按钮类型：{type}", + "module-comments-hide": "隐藏评论", + "module-comments-show": "显示评论", "module-date-format": "{month}.{day}.{year} {hour}:{minute}", "module-date-format-js": "%m.%d.%Y %H:%M", "module-date-missing": "n/a", "module-disabled": "模块处理已禁用", "module-failed": "处理模块 '{name}' 时出错", + "module-files-manage": "管理附件", + "module-files-name": "文件名称", + "module-files-size": "大小", + "module-files-type": "文件类型", "module-forum-author": "作者：", "module-forum-last-post": "最后回复", "module-forum-new-thread": "创建主题", @@ -54,6 +59,7 @@ "module-forumthread-forbidden": "权限不足，无法查看主题", "module-forumthread-not-found": "未找到主题 \"{name}\"", "module-forumthread-posts": "帖子数：", + "module-gallery-size": "不支持的图库尺寸：{size}", "module-listpages-pager-count": "第 {page} 页; 共 {total} 页", "module-listpages-pager-next": "下一页 »", "module-listpages-pager-prev": "« 上一页", @@ -121,9 +127,9 @@ "module-tagcloud-color": "无效的颜色：{color}", "module-tagcloud-font-size": "无效的字体大小：{size}", "module-tagcloud-units": "最大和最小字体大小的单位不同：{min} 和 {max}", + "module-unknown": "模块 '{name}' 不存在", "module-wantedpages-missing": "缺失的链接", "module-wantedpages-source": "源页面", - "module-unknown": "模块 '{name}' 不存在", "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", "page.forbidden": "您没有查看此页面的权限 {page}.", diff --git a/internal/modules/button.go b/internal/modules/button.go index 320583bb..efe4a158 100644 --- a/internal/modules/button.go +++ b/internal/modules/button.go @@ -9,21 +9,37 @@ import ( func init() { module.Register("button", renderButton) } +// Escaping for JavaScript first lets the HTML escape that follows keep a quote +// inside the string rather than ending the attribute. +var jsString = strings.NewReplacer(`\`, `\\`, `'`, `\'`) + func renderButton(env module.Env, params map[string]string, _ string) (string, error) { kind := strings.ToLower(strings.TrimSpace(params["type"])) - if kind != "edit" { + + var call string + switch kind { + case "edit": + call = "pwikit.edit(event)" + case "set-tags": + call = "pwikit.setTags(event, '" + jsString.Replace(params["tags"]) + "')" + default: return "", &module.Error{Message: env.Text("module-button-unknown", "type", params["type"])} } if env.Page == nil || env.Page.Article == nil { return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} } + // Wikidot trims the label, and a kept trailing space would sit inside the + // button's own box and swallow the gap to the next one. label, ok := params["text"] if !ok { - label = env.Text("module-button-edit") + label = params["type"] } - // The path parameter is what opens the editor on arrival, and it is the - // same one the missing-page view already answers to. - href := "/" + env.Page.Article.FullName() + "/edit/true" - return `` + escape.HTML(label) + "", nil + label = strings.TrimSpace(label) + + // Wikidot gives every kind the same class, so data-button-type is the only + // thing a stylesheet has to tell one button from another. + return `` + + escape.HTML(label) + ``, nil } diff --git a/internal/modules/button_test.go b/internal/modules/button_test.go index f6c3211f..d7180fdf 100644 --- a/internal/modules/button_test.go +++ b/internal/modules/button_test.go @@ -2,6 +2,7 @@ package modules import ( "errors" + "strings" "testing" "github.com/WikitTeam/ProjectWikit/internal/db" @@ -24,12 +25,51 @@ func TestRenderButtonEdit(t *testing.T) { if err != nil { t.Fatalf("renderButton() err = %v, want nil", err) } - want := `编辑` + want := `edit` if got != want { t.Errorf("renderButton(edit) = %q, want %q", got, want) } } +func TestRenderButtonSetTags(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) + + got, err := renderButton(env, map[string]string{"type": "set-tags", "tags": "-发现 +丢失", "text": "丢失"}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + want := `丢失` + if got != want { + t.Errorf("renderButton(set-tags) = %q, want %q", got, want) + } +} + +func TestRenderButtonSetTagsWithoutTags(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) + + got, err := renderButton(env, map[string]string{"type": "set-tags"}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + want := `set-tags` + if got != want { + t.Errorf("renderButton(set-tags without tags) = %q, want %q", got, want) + } +} + +func TestRenderButtonSetTagsEscapesTheOperations(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) + + got, err := renderButton(env, map[string]string{"type": "set-tags", "tags": `+it's`, "text": "x"}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + want := `x` + if got != want { + t.Errorf("renderButton(quote in tags) = %q, want %q", got, want) + } +} + func TestRenderButtonWithItsOwnText(t *testing.T) { env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) @@ -37,12 +77,24 @@ func TestRenderButtonWithItsOwnText(t *testing.T) { if err != nil { t.Fatalf("renderButton() err = %v, want nil", err) } - want := `创建此页` + want := `创建此页` if got != want { t.Errorf("renderButton(text) = %q, want %q", got, want) } } +func TestRenderButtonTrimsTheLabel(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) + + got, err := renderButton(env, map[string]string{"type": "set-tags", "tags": "+a", "text": "丢失 "}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + if !strings.HasSuffix(got, ">丢失") { + t.Errorf("renderButton(text=%q) = %q, want the label without its trailing space", "丢失 ", got) + } +} + func TestRenderButtonWithEmptyText(t *testing.T) { env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) @@ -50,20 +102,33 @@ func TestRenderButtonWithEmptyText(t *testing.T) { if err != nil { t.Fatalf("renderButton() err = %v, want nil", err) } - want := `` + want := `` if got != want { t.Errorf("renderButton(text=\"\") = %q, want %q", got, want) } } -func TestRenderButtonEscapes(t *testing.T) { - env := buttonEnv(t, &db.Article{Category: "_default", Name: "a b&c"}) +func TestRenderButtonLabelsWithTheTypeAsWritten(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) + + got, err := renderButton(env, map[string]string{"type": "Set-Tags"}, "") + if err != nil { + t.Fatalf("renderButton() err = %v, want nil", err) + } + want := `Set-Tags` + if got != want { + t.Errorf("renderButton(Set-Tags) = %q, want %q", got, want) + } +} + +func TestRenderButtonEscapesTheLabel(t *testing.T) { + env := buttonEnv(t, &db.Article{Category: "_default", Name: "missing"}) got, err := renderButton(env, map[string]string{"type": "edit", "text": `"x"`}, "") if err != nil { t.Fatalf("renderButton() err = %v, want nil", err) } - want := `<b>"x"</b>` + want := `<b>"x"</b>` if got != want { t.Errorf("renderButton(escapes) = %q, want %q", got, want) } diff --git a/internal/page/button.go b/internal/page/button.go index 8a38ab42..96d81eaf 100644 --- a/internal/page/button.go +++ b/internal/page/button.go @@ -1,13 +1,70 @@ package page -import "regexp" +import ( + "regexp" + "strings" +) // A bare-word kind keeps a stray [[button in prose as prose, and arguments stop // at the first ] because past it a block head cannot be told from the text. var buttonPattern = regexp.MustCompile(`(?i)\[\[button\s+([A-Za-z][A-Za-z0-9_-]*)([^\]]*)\]\]`) +var argumentName = regexp.MustCompile(`^[A-Za-z_][A-Za-z0-9_-]*=`) + // This runs on the source rather than the tree, because the renderer knows // modules and does not know buttons. func Buttons(source string) string { - return buttonPattern.ReplaceAllString(source, `[[module Button type="$1"$2]]`) + return buttonPattern.ReplaceAllStringFunc(source, func(match string) string { + parts := buttonPattern.FindStringSubmatch(match) + tags, rest := splitButtonArguments(parts[2]) + head := `[[module Button type="` + parts[1] + `"` + if tags != "" { + head += ` tags="` + tags + `"` + } + return head + rest + `]]` + }) +} + +// The renderer throws away head words that are not key=value, so tag operations +// reach a module only once they are gathered into one argument. +func splitButtonArguments(tail string) (string, string) { + var tags, rest strings.Builder + for i := 0; i < len(tail); { + if headSpace(tail[i]) { + i++ + continue + } + start := i + if loc := argumentName.FindStringIndex(tail[i:]); loc != nil { + i += loc[1] + if i < len(tail) && tail[i] == '"' { + i++ + for i < len(tail) && tail[i] != '"' { + i++ + } + if i < len(tail) { + i++ + } + } else { + for i < len(tail) && !headSpace(tail[i]) { + i++ + } + } + rest.WriteByte(' ') + rest.WriteString(tail[start:i]) + continue + } + for i < len(tail) && !headSpace(tail[i]) { + i++ + } + if tags.Len() > 0 { + tags.WriteByte(' ') + } + // A quote here would end the gathered argument early and turn whatever + // follows into arguments of its own. + tags.WriteString(strings.ReplaceAll(tail[start:i], `"`, "")) + } + return tags.String(), rest.String() } + +func headSpace(c byte) bool { return c == ' ' || c == '\t' || c == '\r' || c == '\n' } diff --git a/internal/page/button_test.go b/internal/page/button_test.go index 3286bc51..beef4572 100644 --- a/internal/page/button_test.go +++ b/internal/page/button_test.go @@ -24,6 +24,38 @@ func TestButtons(t *testing.T) { } } +func TestButtonsGathersBareArguments(t *testing.T) { + cases := []struct{ in, want string }{ + {"[[button set-tags -a +b]]", `[[module Button type="set-tags" tags="-a +b"]]`}, + {"[[button set-tags -发现 +丢失]]", `[[module Button type="set-tags" tags="-发现 +丢失"]]`}, + {`[[button set-tags -a +b text="x"]]`, `[[module Button type="set-tags" tags="-a +b" text="x"]]`}, + {`[[button set-tags text="x" -a +b]]`, `[[module Button type="set-tags" tags="-a +b" text="x"]]`}, + {`[[button set-tags -a text="丢失 "]]`, `[[module Button type="set-tags" tags="-a" text="丢失 "]]`}, + {`[[button set-tags -a +b]]`, `[[module Button type="set-tags" tags="-a +b"]]`}, + } + for _, c := range cases { + if got := Buttons(c.in); got != c.want { + t.Errorf("Buttons(%q) = %q, want %q", c.in, got, c.want) + } + } +} + +func TestButtonsDropsAQuoteFromABareArgument(t *testing.T) { + in := `[[button set-tags +a"b]]` + want := `[[module Button type="set-tags" tags="+ab"]]` + if got := Buttons(in); got != want { + t.Errorf("Buttons(%q) = %q, want %q", in, got, want) + } +} + +func TestButtonsKeepsAnArgumentWithoutQuotes(t *testing.T) { + in := `[[button set-tags -a text=x]]` + want := `[[module Button type="set-tags" tags="-a" text=x]]` + if got := Buttons(in); got != want { + t.Errorf("Buttons(%q) = %q, want %q", in, got, want) + } +} + func TestButtonsKeepsTheRestOfTheHead(t *testing.T) { in := `[[button edit text="a" class="b"]]` want := `[[module Button type="edit" text="a" class="b"]]` diff --git a/web/js/articles/buttons.ts b/web/js/articles/buttons.ts new file mode 100644 index 00000000..64b99cc7 --- /dev/null +++ b/web/js/articles/buttons.ts @@ -0,0 +1,86 @@ +import { t } from '~util/i18n' +import { fetchArticle, updateArticle } from '../api/articles' +import { callModule, ModuleRenderResponse } from '../api/modules' +import { showErrorModal } from '../util/wikidot-modal' + +function currentPageId(): string | null { + const node = document.getElementById('page-options-container') as HTMLElement | null + if (!node || !node.dataset.config) return null + try { + return JSON.parse(node.dataset.config).pageId ?? null + } catch { + return null + } +} + +function applyOperations(tags: Array, operations: string): Array { + const next = new Set(tags) + for (const operation of operations.split(/\s+/).filter(Boolean)) { + if (operation.startsWith('-')) { + next.delete(operation.slice(1)) + } else { + next.add(operation.replace(/^\+/, '')) + } + } + return Array.from(next) +} + +async function setTags(event: Event, operations: string) { + event.preventDefault() + const pageId = currentPageId() + if (!pageId) return + + try { + // The tags come back from the server rather than off the page, so a tag + // block that did not render cannot turn one click into a wipe. + const article = await fetchArticle(pageId) + await updateArticle(pageId, { pageId, tags: applyOperations(article.tags ?? [], operations) }) + } catch (e) { + showErrorModal(e.error || t('common.server-unreachable')) + return + } + window.location.reload() +} + +function edit(event: Event) { + event.preventDefault() + document.getElementById('edit-button')?.click() +} + +function files(event: Event) { + event.preventDefault() + document.getElementById('files-button')?.click() +} + +async function comments(event: Event) { + event.preventDefault() + const container = document.getElementById('thread-container') + const options = document.getElementById('comments-options-hidden') + if (!container) return + + const thread = Number(container.dataset.thread || '0') + if (!thread) { + document.getElementById('discuss-button')?.click() + return + } + + try { + const response = await callModule({ + module: 'forumthread', + pageId: currentPageId() ?? undefined, + method: 'render', + params: { t: thread }, + }) + container.innerHTML = response.result + } catch (e) { + showErrorModal(e.error || t('common.server-unreachable')) + return + } + if (options) options.remove() +} + +// The markup calls these by name from an inline onclick, because themes reach +// their buttons through [onclick*="..."] and a listener would leave no match. +export function makeButtons() { + ;(window as any).pwikit = { ...((window as any).pwikit || {}), setTags, edit, files, comments } +} diff --git a/web/js/articles/lightbox.ts b/web/js/articles/lightbox.ts new file mode 100644 index 00000000..e88d703d --- /dev/null +++ b/web/js/articles/lightbox.ts @@ -0,0 +1,48 @@ +const containerId = 'pwikit-lightbox' + +function close() { + document.getElementById(containerId)?.remove() + document.removeEventListener('keydown', onKey) +} + +function onKey(e: KeyboardEvent) { + if (e.key === 'Escape') close() +} + +function open(url: string) { + close() + + const overlay = document.createElement('div') + overlay.id = containerId + Object.assign(overlay.style, { + position: 'fixed', + inset: '0', + zIndex: '10000', + background: 'rgba(0, 0, 0, 0.8)', + display: 'flex', + alignItems: 'center', + justifyContent: 'center', + cursor: 'zoom-out', + }) + + const image = document.createElement('img') + image.src = url + image.alt = '' + Object.assign(image.style, { maxWidth: '92vw', maxHeight: '92vh', boxShadow: '0 0 24px rgba(0, 0, 0, 0.6)' }) + + overlay.appendChild(image) + overlay.addEventListener('click', close) + document.body.appendChild(overlay) + document.addEventListener('keydown', onKey) +} + +// One listener on the document rather than one per image, because a gallery can +// arrive with a module that rendered after the page did. +export function makeLightbox() { + document.addEventListener('click', e => { + const link = (e.target as HTMLElement)?.closest?.('.gallery-box a') as HTMLAnchorElement | null + if (!link || !link.href) return + e.preventDefault() + open(link.href) + }) +} diff --git a/web/js/index.tsx b/web/js/index.tsx index 6039ab99..275fdf4b 100644 --- a/web/js/index.tsx +++ b/web/js/index.tsx @@ -1,10 +1,12 @@ import React from 'react' import './articles/auto-resize-iframe' +import { makeButtons } from './articles/buttons' import { makeCodeBlock } from './articles/codeblock' import { makeCollapsible } from './articles/collapsible' import { makeDate } from './articles/date' import { makeFootnote } from './articles/footnote' import { makeInterwiki } from './articles/interwiki' +import { makeLightbox } from './articles/lightbox' import { makeListPages } from './articles/list-pages' import { makeStarsRateModule } from './articles/rate-stars' import { makeUpDownRateModule } from './articles/rate-updown' @@ -33,6 +35,8 @@ import AdminSusUsers from './entrypoints/admin-sus-users' import { renderTo } from '~util/react-render-into' attachApiMessageListener() +makeButtons() +makeLightbox() window.addEventListener('DOMContentLoaded', () => { document.querySelectorAll('#create-new-page').forEach((node: HTMLElement) => renderTo(node, )) From f3194fe280504e2e03353b14549b4867982fecdb Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 20:59:47 +0900 Subject: [PATCH 146/428] render from the command line the way the server does --- cmd/pwikit/render.go | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/cmd/pwikit/render.go b/cmd/pwikit/render.go index e2c79740..a06666fd 100644 --- a/cmd/pwikit/render.go +++ b/cmd/pwikit/render.go @@ -35,6 +35,7 @@ func render(args []string) error { pageName := fs.String("page", "page", "page name reported to ftml") category := fs.String("category", "_default", "page category reported to ftml") domain := fs.String("domain", "example.org", "site domain reported to ftml") + modules := fs.String("modules", "real", "how to answer modules: real, stub") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -45,6 +46,9 @@ func render(args []string) error { if !renderer.Mode(*mode).Valid() { return fmt.Errorf("unknown mode %q", *mode) } + if *modules != "real" && *modules != "stub" { + return fmt.Errorf("unknown modules %q", *modules) + } source, err := readSource(*file) if err != nil { @@ -63,8 +67,11 @@ func render(args []string) error { return err } - store := cliRepository{} - var vars *page.Vars + store := cliRepository{stub: *modules == "stub"} + var ( + vars *page.Vars + article *db.Article + ) if *dsn != "" { conn, err := db.Open(ctx, *dsn) if err != nil { @@ -77,7 +84,7 @@ func render(args []string) error { } users := printuser.New(bundle.Localizer(i18n.DefaultLanguage), roles.FileIcons(p.Files())) store.data = repo.New(ctx, conn, users, repo.Options{Loc: bundle.Localizer(i18n.DefaultLanguage)}) - vars, err = cliPageVars(ctx, conn, bundle.Localizer(i18n.DefaultLanguage), *category, *pageName, *domain) + vars, article, err = cliPageVars(ctx, conn, bundle.Localizer(i18n.DefaultLanguage), *category, *pageName, *domain) if err != nil { return err } @@ -85,7 +92,10 @@ func render(args []string) error { cb := callbacks.New(bundle.Localizer(i18n.DefaultLanguage), store) cb.SetPageVars(vars) - source = page.ThisVars(source, vars) + if article != nil { + cb.SetContext(page.NewContext(article, article, nil, nil)) + } + source = page.PreRender(source, vars) var handler renderer.Callbacks = cb var recorder *tracer if *trace != "" { @@ -102,23 +112,23 @@ func render(args []string) error { // cliPageVars resolves the page being rendered to a real row when there is one, // so %%this|x%% answers with that page rather than staying put. -func cliPageVars(ctx context.Context, conn *db.DB, loc *i18n.Localizer, category, name, domain string) (*page.Vars, error) { +func cliPageVars(ctx context.Context, conn *db.DB, loc *i18n.Localizer, category, name, domain string) (*page.Vars, *db.Article, error) { ref := name if category != db.DefaultCategory { ref = category + ":" + name } article, err := conn.ArticleByName(ctx, ref) if errors.Is(err, db.ErrNotFound) { - return nil, nil + return nil, nil, nil } if err != nil { - return nil, err + return nil, nil, err } var siteID int64 if site, err := conn.SiteByHosts(ctx, []string{domain}); err == nil { siteID = site.ID } - return page.NewVars(article, nil, repo.NewVarSource(ctx, conn, siteID), loc), nil + return page.NewVars(article, nil, repo.NewVarSource(ctx, conn, siteID), loc), article, nil } func readSource(file string) (string, error) { @@ -194,11 +204,17 @@ func writeTrace(target string, recorder *tracer) error { type cliRepository struct { data *repo.Repository + stub bool } var _ callbacks.Repository = cliRepository{} -func (r cliRepository) RenderModule(pc *page.Context, name string, params map[string]string, _ string) (string, error) { +// Stubbing prints what a module was handed, which is the only way to see the +// arguments the renderer dropped before they ever reached it. +func (r cliRepository) RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) { + if r.data != nil && !r.stub { + return r.data.RenderModule(pc, name, params, body) + } keys := make([]string, 0, len(params)) for key := range params { keys = append(keys, key) From 2a6ddf7954cd293e3a65f6aa56a17c64b97983fa Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 20:59:47 +0900 Subject: [PATCH 147/428] open a page's discussion where wikidot opens it --- internal/articlepage/build.go | 10 +++---- internal/articlepage/render.go | 9 +++++- internal/db/options.go | 21 ++++++++++++++ internal/pageconfig/options.go | 21 ++++++++++---- internal/pageconfig/options_test.go | 29 ++++++++++--------- internal/pageconfig/testdata/options.golden | 4 +-- .../pageconfig/testdata/options_corpus.json | 27 +++++++++++++++++ 7 files changed, 93 insertions(+), 28 deletions(-) diff --git a/internal/articlepage/build.go b/internal/articlepage/build.go index 0ea7f39e..965d7973 100644 --- a/internal/articlepage/build.go +++ b/internal/articlepage/build.go @@ -129,15 +129,13 @@ func (h *Handler) permsObject(req *request, perm *repo.Perms) (*perms.Object, bo // This only reads, so a page nobody has commented on gets no thread written for // it. func (h *Handler) commentsRedirect(req *request) (string, error) { - info, err := h.deps.DB.CommentInfo(req.ctx, req.article.ID) + id, err := h.deps.DB.CommentThreadFor(req.ctx, req.article.ID) if err != nil { return "", err } - if info.ThreadID == 0 { - return "", nil - } - return "/forum/t-" + strconv.FormatInt(info.ThreadID, 10) + "/" + - wikidot.Normalize(req.article.DisplayName()), nil + // The slug is the page name. Normalizing the title instead drops every + // character outside ASCII, which leaves a stranger's page unrecognisable. + return "/forum/t-" + strconv.FormatInt(id, 10) + "/" + req.article.FullName(), nil } func (h *Handler) canonicalURL(req *request) string { diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 96935350..2a47e267 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -498,10 +498,15 @@ func (h *Handler) shellData(req *request, out body, canonical, navTop, navSide s } title := firstNonEmpty(out.title, req.site.Title) + // The site name belongs in the browser tab, not in a share card headline. + document := title + if title != req.site.Title && req.site.Title != "" { + document = title + " - " + req.site.Title + } return shell.Data{ SiteName: req.site.Title, SiteHeadline: req.site.Headline, - SiteTitle: title, + SiteTitle: document, SiteIcon: req.site.Icon, License: license, OGTitle: title, @@ -638,6 +643,8 @@ func (h *Handler) options(req *request) (string, error) { return "", err } options.CommentCount = info.Count + options.CommentThreadID = info.ThreadID + options.CommentSlug = req.article.FullName() watching, err := h.watching(req, info.ThreadID) if err != nil { diff --git a/internal/db/options.go b/internal/db/options.go index 61c8f22d..faddd8c5 100644 --- a/internal/db/options.go +++ b/internal/db/options.go @@ -175,3 +175,24 @@ func (d *DB) ArticlesByTag(ctx context.Context, categorySlug, name string, hidde } return out, nil } + +var qCommentThreadFor = register("CommentThreadFor", ` +WITH existing AS ( + SELECT id FROM web_forumthread WHERE article_id = $1 +), created AS ( + INSERT INTO web_forumthread (name, description, article_id, is_pinned, is_locked, created_at, updated_at) + SELECT '', '', $1, false, false, now(), now() + WHERE NOT EXISTS (SELECT 1 FROM existing) + RETURNING id +) +SELECT id FROM existing UNION ALL SELECT id FROM created`) + +// A page gets its comment thread the first time a reader asks for the +// discussion, so reading the page never writes and the link still lands. +func (d *DB) CommentThreadFor(ctx context.Context, articleID int64) (int64, error) { + var id int64 + if err := d.pool.QueryRow(ctx, qCommentThreadFor, articleID).Scan(&id); err != nil { + return 0, fmt.Errorf("open comment thread of article %d: %w", articleID, err) + } + return id, nil +} diff --git a/internal/pageconfig/options.go b/internal/pageconfig/options.go index 0000eb90..aee98093 100644 --- a/internal/pageconfig/options.go +++ b/internal/pageconfig/options.go @@ -1,6 +1,8 @@ package pageconfig import ( + "strconv" + "github.com/WikitTeam/ProjectWikit/internal/article" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" @@ -16,11 +18,13 @@ type Options struct { Perms perms.Set Rating page.Rating - PathParams article.Params - CommentCount int - CanCreateTags bool - IsWatching bool - Preferences Preferences + PathParams article.Params + CommentCount int + CommentThreadID int64 + CommentSlug string + CanCreateTags bool + IsWatching bool + Preferences Preferences } // Preferences is every preference the registry carries, which today is one. The @@ -67,11 +71,16 @@ func (o Options) JSON() (string, error) { }) } +// Linking the thread directly is what wikidot does. A page whose thread was +// never opened has no id to link, so it goes through the path that opens one. func (o Options) commentThread() any { if !o.HasArticle { return nil } - return "/" + o.NormalizedName + "/comments/show" + if o.CommentThreadID == 0 { + return "/" + o.NormalizedName + "/comments/show" + } + return "/forum/t-" + strconv.FormatInt(o.CommentThreadID, 10) + "/" + o.CommentSlug } func (o Options) preferences() wikijson.Object { diff --git a/internal/pageconfig/options_test.go b/internal/pageconfig/options_test.go index 1561e2f0..7ed0b203 100644 --- a/internal/pageconfig/options_test.go +++ b/internal/pageconfig/options_test.go @@ -43,6 +43,7 @@ type optionsCase struct { Votes votesSpec `json:"votes"` Path string `json:"path"` CommentCount int `json:"comment_count"` + CommentThread int64 `json:"comment_thread_id"` CanCreateTags bool `json:"can_create_tags"` IsWatching bool `json:"is_watching"` SourceEditor bool `json:"advanced_source_editor"` @@ -83,12 +84,12 @@ func optionsCorpus() []optionsCase { { Name: "signed in member", PageID: "main", HasArticle: true, Roles: []permRoleSpec{reader, member}, RatingMode: page.RatingModeUpDown, - Votes: votesSpec{Rates: []int{1, 1, -1}}, CommentCount: 4, + Votes: votesSpec{Rates: []int{1, 1, -1}}, CommentCount: 4, CommentThread: 1201, }, { Name: "editor", PageID: "scp-173", HasArticle: true, Roles: []permRoleSpec{reader, member, editor}, RatingMode: page.RatingModeUpDown, - Votes: votesSpec{Rates: []int{1, 1, 1, -1}}, CommentCount: 1, CanCreateTags: true, + Votes: votesSpec{Rates: []int{1, 1, 1, -1}}, CommentCount: 1, CommentThread: 1202, CanCreateTags: true, }, { Name: "superuser on a locked page", PageID: "main", HasArticle: true, Superuser: true, @@ -194,17 +195,19 @@ func toOptions(c optionsCase) Options { rating = page.RatingOf(c.RatingMode, toStats(c.Votes)) } return Options{ - PageID: c.PageID, - NormalizedName: c.PageID, - HasArticle: c.HasArticle, - Anonymous: c.Anonymous, - Perms: perms.Resolve(toSubject(c), object), - Rating: rating, - PathParams: params, - CommentCount: c.CommentCount, - CanCreateTags: c.CanCreateTags, - IsWatching: c.IsWatching, - Preferences: Preferences{AdvancedSourceEditor: c.SourceEditor}, + PageID: c.PageID, + NormalizedName: c.PageID, + HasArticle: c.HasArticle, + Anonymous: c.Anonymous, + Perms: perms.Resolve(toSubject(c), object), + Rating: rating, + PathParams: params, + CommentCount: c.CommentCount, + CommentThreadID: c.CommentThread, + CommentSlug: c.PageID, + CanCreateTags: c.CanCreateTags, + IsWatching: c.IsWatching, + Preferences: Preferences{AdvancedSourceEditor: c.SourceEditor}, } } diff --git a/internal/pageconfig/testdata/options.golden b/internal/pageconfig/testdata/options.golden index 416a47dd..e947d1e1 100644 --- a/internal/pageconfig/testdata/options.golden +++ b/internal/pageconfig/testdata/options.golden @@ -1,9 +1,9 @@ === anonymous reader {"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 1, "ratingMode": "updown", "ratingVotes": 3, "ratingPopularity": 67, "pathParams": {}, "canRate": false, "canComment": false, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": false, "preferences": {}, "isWatching": false} === signed in member -{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 1, "ratingMode": "updown", "ratingVotes": 3, "ratingPopularity": 67, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 4, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +{"optionsEnabled": true, "editable": false, "lockable": false, "tagable": false, "pageId": "main", "rating": 1, "ratingMode": "updown", "ratingVotes": 3, "ratingPopularity": 67, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/forum/t-1201/main", "commentCount": 4, "canDelete": false, "canCreateTags": false, "canManageFiles": false, "canRename": false, "canCreateHere": false, "canManageAuthors": false, "canResetVotes": false, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} === editor -{"optionsEnabled": true, "editable": true, "lockable": true, "tagable": true, "pageId": "scp-173", "rating": 2, "ratingMode": "updown", "ratingVotes": 4, "ratingPopularity": 75, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/scp-173/comments/show", "commentCount": 1, "canDelete": true, "canCreateTags": true, "canManageFiles": true, "canRename": true, "canCreateHere": true, "canManageAuthors": true, "canResetVotes": true, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} +{"optionsEnabled": true, "editable": true, "lockable": true, "tagable": true, "pageId": "scp-173", "rating": 2, "ratingMode": "updown", "ratingVotes": 4, "ratingPopularity": 75, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/forum/t-1202/scp-173", "commentCount": 1, "canDelete": true, "canCreateTags": true, "canManageFiles": true, "canRename": true, "canCreateHere": true, "canManageAuthors": true, "canResetVotes": true, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} === superuser on a locked page {"optionsEnabled": true, "editable": true, "lockable": true, "tagable": true, "pageId": "main", "rating": 0, "ratingMode": "updown", "ratingVotes": 0, "ratingPopularity": 0, "pathParams": {}, "canRate": true, "canComment": true, "canViewComments": true, "commentThread": "/main/comments/show", "commentCount": 0, "canDelete": true, "canCreateTags": false, "canManageFiles": true, "canRename": true, "canCreateHere": true, "canManageAuthors": true, "canResetVotes": true, "canWatch": true, "preferences": {"qol__advanced_source_editor_enabled": false}, "isWatching": false} === author of a page diff --git a/internal/pageconfig/testdata/options_corpus.json b/internal/pageconfig/testdata/options_corpus.json index 2c92b387..b5bce1e3 100644 --- a/internal/pageconfig/testdata/options_corpus.json +++ b/internal/pageconfig/testdata/options_corpus.json @@ -28,6 +28,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -69,6 +70,7 @@ }, "path": "", "comment_count": 4, + "comment_thread_id": 1201, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -126,6 +128,7 @@ }, "path": "", "comment_count": 1, + "comment_thread_id": 1202, "can_create_tags": true, "is_watching": false, "advanced_source_editor": false @@ -155,6 +158,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -192,6 +196,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -229,6 +234,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -258,6 +264,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -290,6 +297,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -319,6 +327,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -351,6 +360,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -383,6 +393,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -412,6 +423,7 @@ }, "path": "main/offset/20/tag/中文/bare", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -449,6 +461,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": true, "advanced_source_editor": false @@ -486,6 +499,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": true @@ -514,6 +528,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -542,6 +557,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -570,6 +586,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -598,6 +615,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -626,6 +644,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -654,6 +673,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -682,6 +702,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -710,6 +731,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -738,6 +760,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -766,6 +789,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -794,6 +818,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -822,6 +847,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false @@ -850,6 +876,7 @@ }, "path": "", "comment_count": 0, + "comment_thread_id": 0, "can_create_tags": false, "is_watching": false, "advanced_source_editor": false From 05d1c097ab5da1d881e2c5e0017f046ad7350b38 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 20:59:55 +0900 Subject: [PATCH 148/428] serve the scaled copies a gallery links to --- cmd/pwikit/main.go | 9 ++- internal/media/resized.go | 110 +++++++++++++++++++++++++++ internal/media/resized_test.go | 133 +++++++++++++++++++++++++++++++++ internal/routing/routing.go | 1 + internal/thumb/thumb.go | 129 ++++++++++++++++++++++++++++++++ internal/thumb/thumb_test.go | 111 +++++++++++++++++++++++++++ 6 files changed, 490 insertions(+), 3 deletions(-) create mode 100644 internal/media/resized.go create mode 100644 internal/media/resized_test.go create mode 100644 internal/thumb/thumb.go create mode 100644 internal/thumb/thumb_test.go diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index f7af6800..a3b8de66 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -133,8 +133,10 @@ func serve(args []string) error { } var mediaHandler http.Handler = proxy + var resizedHandler http.Handler = proxy if conn != nil { mediaHandler = site.NewHostRules(conn, listenPort(*listen), media.New(p.Files(), conn), proxy) + resizedHandler = site.NewHostRules(conn, listenPort(*listen), media.NewResized(p.Files(), conn), proxy) } var articles http.Handler = proxy @@ -150,9 +152,10 @@ func serve(args []string) error { goHandlers := map[string]http.Handler{ // The bundle is the one route answered above the session layer, so it // is also the one that does not vary on the cookie. - static.Prefix: static.New(assets, proxy), - media.Prefix: respheader.VaryCookie(mediaHandler), - "/": articles, + static.Prefix: static.New(assets, proxy), + media.Prefix: respheader.VaryCookie(mediaHandler), + media.ResizedPrefix: respheader.VaryCookie(resizedHandler), + "/": articles, } mux, err := routing.New(routing.Table, proxy, goHandlers) diff --git a/internal/media/resized.go b/internal/media/resized.go new file mode 100644 index 00000000..a6aa8b8b --- /dev/null +++ b/internal/media/resized.go @@ -0,0 +1,110 @@ +package media + +import ( + "context" + "net/http" + "os" + "path/filepath" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/paths" + "github.com/WikitTeam/ProjectWikit/internal/thumb" +) + +const ( + ResizedPrefix = "/local--resized-images/" + resizedDir = "resized" + jpegMime = "image/jpeg" +) + +type ResizedHandler struct { + root string + files Attachments +} + +var _ http.Handler = (*ResizedHandler)(nil) + +func NewResized(root string, files Attachments) *ResizedHandler { + return &ResizedHandler{root: root, files: files} +} + +func (h *ResizedHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + if r.Method != http.MethodGet && r.Method != http.MethodHead { + w.Header().Set("Allow", "GET, HEAD") + http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) + return + } + rest, ok := strings.CutPrefix(r.URL.Path, ResizedPrefix) + if !ok { + notFound(w) + return + } + // The file name keeps its own extension and the size carries another, so + // the path has one more segment than an attachment's does. + segments := strings.Split(rest, "/") + if len(segments) != 3 { + notFound(w) + return + } + size, ok := thumb.Lookup(strings.TrimSuffix(segments[2], filepath.Ext(segments[2]))) + if !ok { + notFound(w) + return + } + + body, err := h.image(r.Context(), segments[0], segments[1], size) + if err != nil { + notFound(w) + return + } + + w.Header().Set("Content-Type", jpegMime) + w.Header().Set("Content-Length", strconv.Itoa(len(body))) + w.Header().Set("Content-Disposition", "inline") + w.WriteHeader(http.StatusOK) + if r.Method != http.MethodHead { + _, _ = w.Write(body) + } +} + +func (h *ResizedHandler) image(ctx context.Context, articleRef, fileName string, size thumb.Size) ([]byte, error) { + file, err := h.files.ArticleFile(ctx, articleRef, fileName) + if err != nil { + return nil, err + } + if !strings.HasPrefix(file.MimeType, "image/") { + return nil, os.ErrNotExist + } + + stored := filepath.Join(partialQuote(file.ArticleMediaName), partialQuote(file.MediaName)) + cache, err := paths.Resolve(filepath.Join(h.root, resizedDir), filepath.Join(stored, size.Name+".jpg")) + if err != nil { + return nil, err + } + if body, err := os.ReadFile(cache); err == nil { + return body, nil + } + + original, err := paths.Resolve(filepath.Join(h.root, "media"), stored) + if err != nil { + return nil, err + } + src, err := os.Open(original) + if err != nil { + return nil, err + } + defer src.Close() + + body, err := thumb.Generate(src, size) + if err != nil { + return nil, err + } + + // A cache that cannot be written still answers the request, because the + // scaled copy is derived and losing it costs only the work to redo it. + if err := os.MkdirAll(filepath.Dir(cache), 0o755); err == nil { + _ = os.WriteFile(cache, body, 0o644) + } + return body, nil +} diff --git a/internal/media/resized_test.go b/internal/media/resized_test.go new file mode 100644 index 00000000..c84dbbe1 --- /dev/null +++ b/internal/media/resized_test.go @@ -0,0 +1,133 @@ +package media + +import ( + "bytes" + "image" + "image/color" + "image/jpeg" + "net/http" + "net/http/httptest" + "os" + "path/filepath" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func newResizedHandler(t *testing.T, mime string) (*ResizedHandler, string) { + t.Helper() + root := t.TempDir() + dir := filepath.Join(root, "media", "article-uuid") + if err := os.MkdirAll(dir, 0o755); err != nil { + t.Fatalf("MkdirAll() err = %v, want nil", err) + } + + img := image.NewRGBA(image.Rect(0, 0, 1072, 876)) + for y := 0; y < 876; y++ { + for x := 0; x < 1072; x++ { + img.Set(x, y, color.RGBA{R: uint8(x), G: uint8(y), B: 64, A: 255}) + } + } + var buf bytes.Buffer + if err := jpeg.Encode(&buf, img, nil); err != nil { + t.Fatalf("jpeg.Encode() err = %v, want nil", err) + } + if err := os.WriteFile(filepath.Join(dir, "file-uuid"), buf.Bytes(), 0o644); err != nil { + t.Fatalf("WriteFile() err = %v, want nil", err) + } + + files := fakeFiles{"probe/photo.jpg": &db.ArticleFile{ + ArticleMediaName: "article-uuid", + MediaName: "file-uuid", + MimeType: mime, + Size: int64(buf.Len()), + }} + return NewResized(root, files), root +} + +func getResized(t *testing.T, h *ResizedHandler, path string) *httptest.ResponseRecorder { + t.Helper() + w := httptest.NewRecorder() + h.ServeHTTP(w, httptest.NewRequest(http.MethodGet, path, nil)) + return w +} + +func TestResizedServesTheRequestedSize(t *testing.T) { + h, _ := newResizedHandler(t, "image/jpeg") + + w := getResized(t, h, "/local--resized-images/probe/photo.jpg/medium.jpg") + if w.Code != http.StatusOK { + t.Fatalf("GET medium = %d, want %d", w.Code, http.StatusOK) + } + if got := w.Header().Get("Content-Type"); got != "image/jpeg" { + t.Errorf("Content-Type = %q, want %q", got, "image/jpeg") + } + cfg, err := jpeg.DecodeConfig(bytes.NewReader(w.Body.Bytes())) + if err != nil { + t.Fatalf("jpeg.DecodeConfig() err = %v, want nil", err) + } + if cfg.Width != 500 || cfg.Height != 409 { + t.Errorf("GET medium = %dx%d, want 500x409", cfg.Width, cfg.Height) + } +} + +func TestResizedCachesWhatItGenerated(t *testing.T) { + h, root := newResizedHandler(t, "image/jpeg") + + getResized(t, h, "/local--resized-images/probe/photo.jpg/small.jpg") + + cached := filepath.Join(root, "resized", "article-uuid", "file-uuid", "small.jpg") + if _, err := os.Stat(cached); err != nil { + t.Fatalf("Stat(%q) err = %v, want nil", cached, err) + } +} + +func TestResizedAnswersFromTheCacheWhenTheOriginalIsGone(t *testing.T) { + h, root := newResizedHandler(t, "image/jpeg") + getResized(t, h, "/local--resized-images/probe/photo.jpg/square.jpg") + + if err := os.Remove(filepath.Join(root, "media", "article-uuid", "file-uuid")); err != nil { + t.Fatalf("Remove() err = %v, want nil", err) + } + + w := getResized(t, h, "/local--resized-images/probe/photo.jpg/square.jpg") + if w.Code != http.StatusOK { + t.Errorf("GET square = %d, want %d", w.Code, http.StatusOK) + } +} + +func TestResizedRejectsTheSizeWikidotRejects(t *testing.T) { + h, _ := newResizedHandler(t, "image/jpeg") + + w := getResized(t, h, "/local--resized-images/probe/photo.jpg/large.jpg") + if w.Code != http.StatusNotFound { + t.Errorf("GET large = %d, want %d", w.Code, http.StatusNotFound) + } +} + +func TestResizedRejectsWhatIsNotAnImage(t *testing.T) { + h, _ := newResizedHandler(t, "audio/mpeg") + + w := getResized(t, h, "/local--resized-images/probe/photo.jpg/medium.jpg") + if w.Code != http.StatusNotFound { + t.Errorf("GET of an audio attachment = %d, want %d", w.Code, http.StatusNotFound) + } +} + +func TestResizedRejectsAMissingAttachment(t *testing.T) { + h, _ := newResizedHandler(t, "image/jpeg") + + w := getResized(t, h, "/local--resized-images/probe/nothing.jpg/medium.jpg") + if w.Code != http.StatusNotFound { + t.Errorf("GET of a missing attachment = %d, want %d", w.Code, http.StatusNotFound) + } +} + +func TestResizedRejectsAPathThatEscapes(t *testing.T) { + h, _ := newResizedHandler(t, "image/jpeg") + + w := getResized(t, h, "/local--resized-images/probe/photo.jpg/../../medium.jpg") + if w.Code != http.StatusNotFound { + t.Errorf("GET of an escaping path = %d, want %d", w.Code, http.StatusNotFound) + } +} diff --git a/internal/routing/routing.go b/internal/routing/routing.go index e892ed3b..4831c030 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -28,6 +28,7 @@ var Table = []Route{ {Prefix: "/-/static/", Owner: OwnerGo, Label: "static assets"}, {Prefix: "/api/", Owner: OwnerUpstream, Label: "API"}, {Prefix: "/local--files/", Owner: OwnerGo, Label: "site files"}, + {Prefix: "/local--resized-images/", Owner: OwnerGo, Label: "scaled images"}, {Prefix: "/local--code/", Owner: OwnerUpstream, Label: "code blocks"}, {Prefix: "/local--html/", Owner: OwnerUpstream, Label: "embedded HTML"}, {Prefix: "/local--theme/", Owner: OwnerUpstream, Label: "page theme"}, diff --git a/internal/thumb/thumb.go b/internal/thumb/thumb.go new file mode 100644 index 00000000..f89f7c78 --- /dev/null +++ b/internal/thumb/thumb.go @@ -0,0 +1,129 @@ +// Package thumb makes the scaled copies a gallery links to. +package thumb + +import ( + "bytes" + "image" + "image/color" + "image/jpeg" + "io" + "strings" + + _ "image/gif" + _ "image/png" +) + +type Size struct { + Name string + Max int + Square bool +} + +var sizes = []Size{ + {Name: "square", Max: 75, Square: true}, + {Name: "thumbnail", Max: 100}, + {Name: "small", Max: 240}, + {Name: "medium", Max: 500}, +} + +func Lookup(name string) (Size, bool) { + for _, s := range sizes { + if strings.EqualFold(name, s.Name) { + return s, true + } + } + return Size{}, false +} + +func Generate(r io.Reader, s Size) ([]byte, error) { + src, _, err := image.Decode(r) + if err != nil { + return nil, err + } + if s.Square { + src = centreSquare(src) + } + w, h := fit(src.Bounds().Dx(), src.Bounds().Dy(), s.Max) + + var buf bytes.Buffer + if err := jpeg.Encode(&buf, scale(src, w, h), &jpeg.Options{Quality: 85}); err != nil { + return nil, err + } + return buf.Bytes(), nil +} + +// An image already smaller than the box is left alone, because stretching it +// costs bytes and shows nothing that was not there. +func fit(w, h, max int) (int, int) { + long := w + if h > long { + long = h + } + if long <= max || long == 0 { + return w, h + } + return round(w*max, long), round(h*max, long) +} + +func round(n, d int) int { + v := (n + d/2) / d + if v < 1 { + return 1 + } + return v +} + +func centreSquare(src image.Image) image.Image { + b := src.Bounds() + side := b.Dx() + if b.Dy() < side { + side = b.Dy() + } + r := image.Rect(0, 0, side, side).Add(image.Pt( + b.Min.X+(b.Dx()-side)/2, + b.Min.Y+(b.Dy()-side)/2, + )) + if sub, ok := src.(interface { + SubImage(image.Rectangle) image.Image + }); ok { + return sub.SubImage(r) + } + return src +} + +// Averaging over the source pixels a destination pixel covers is what keeps a +// downscale from aliasing, and it needs nothing the standard library lacks. +func scale(src image.Image, w, h int) image.Image { + b := src.Bounds() + if w == b.Dx() && h == b.Dy() { + return src + } + dst := image.NewRGBA(image.Rect(0, 0, w, h)) + for y := 0; y < h; y++ { + y0, y1 := span(b.Min.Y, b.Dy(), y, h) + for x := 0; x < w; x++ { + x0, x1 := span(b.Min.X, b.Dx(), x, w) + var sr, sg, sb, sa, n uint64 + for yy := y0; yy < y1; yy++ { + for xx := x0; xx < x1; xx++ { + r, g, bl, a := src.At(xx, yy).RGBA() + sr, sg, sb, sa = sr+uint64(r), sg+uint64(g), sb+uint64(bl), sa+uint64(a) + n++ + } + } + dst.Set(x, y, color.RGBA64{ + R: uint16(sr / n), G: uint16(sg / n), B: uint16(sb / n), A: uint16(sa / n), + }) + } + } + return dst +} + +func span(min, length, i, out int) (int, int) { + a := min + i*length/out + b := min + (i+1)*length/out + if b <= a { + b = a + 1 + } + return a, b +} diff --git a/internal/thumb/thumb_test.go b/internal/thumb/thumb_test.go new file mode 100644 index 00000000..fc17a6a9 --- /dev/null +++ b/internal/thumb/thumb_test.go @@ -0,0 +1,111 @@ +package thumb + +import ( + "bytes" + "image" + "image/color" + "image/jpeg" + "testing" +) + +func TestFitMatchesTheSizesWikidotServes(t *testing.T) { + const w, h = 1072, 876 + cases := []struct { + size string + wantW int + wantH int + }{ + {"thumbnail", 100, 82}, + {"small", 240, 196}, + {"medium", 500, 409}, + } + for _, c := range cases { + s, ok := Lookup(c.size) + if !ok { + t.Fatalf("Lookup(%q) = _, false, want true", c.size) + } + gotW, gotH := fit(w, h, s.Max) + if gotW != c.wantW { + t.Errorf("fit(%d, %d, %d) width = %d, want %d", w, h, s.Max, gotW, c.wantW) + } + if gotH != c.wantH { + t.Errorf("fit(%d, %d, %d) height = %d, want %d", w, h, s.Max, gotH, c.wantH) + } + } +} + +func TestFitLeavesASmallImageAlone(t *testing.T) { + gotW, gotH := fit(40, 30, 500) + if gotW != 40 || gotH != 30 { + t.Errorf("fit(40, 30, 500) = %d, %d, want 40, 30", gotW, gotH) + } +} + +func TestLookupRejectsTheSizeWikidotRejects(t *testing.T) { + if _, ok := Lookup("large"); ok { + t.Error("Lookup(\"large\") = _, true, want false") + } +} + +func TestLookupIgnoresCase(t *testing.T) { + if _, ok := Lookup("Medium"); !ok { + t.Error("Lookup(\"Medium\") = _, false, want true") + } +} + +func sourceImage(t *testing.T, w, h int) []byte { + t.Helper() + img := image.NewRGBA(image.Rect(0, 0, w, h)) + for y := 0; y < h; y++ { + for x := 0; x < w; x++ { + img.Set(x, y, color.RGBA{R: uint8(x), G: uint8(y), B: 128, A: 255}) + } + } + var buf bytes.Buffer + if err := jpeg.Encode(&buf, img, nil); err != nil { + t.Fatalf("jpeg.Encode() err = %v, want nil", err) + } + return buf.Bytes() +} + +func TestGenerateScalesToTheLongSide(t *testing.T) { + src := sourceImage(t, 1072, 876) + s, _ := Lookup("medium") + + out, err := Generate(bytes.NewReader(src), s) + if err != nil { + t.Fatalf("Generate() err = %v, want nil", err) + } + cfg, err := jpeg.DecodeConfig(bytes.NewReader(out)) + if err != nil { + t.Fatalf("jpeg.DecodeConfig() err = %v, want nil", err) + } + if cfg.Width != 500 || cfg.Height != 409 { + t.Errorf("Generate(medium) = %dx%d, want 500x409", cfg.Width, cfg.Height) + } +} + +func TestGenerateCropsASquare(t *testing.T) { + src := sourceImage(t, 1072, 876) + s, _ := Lookup("square") + + out, err := Generate(bytes.NewReader(src), s) + if err != nil { + t.Fatalf("Generate() err = %v, want nil", err) + } + cfg, err := jpeg.DecodeConfig(bytes.NewReader(out)) + if err != nil { + t.Fatalf("jpeg.DecodeConfig() err = %v, want nil", err) + } + if cfg.Width != 75 || cfg.Height != 75 { + t.Errorf("Generate(square) = %dx%d, want 75x75", cfg.Width, cfg.Height) + } +} + +func TestGenerateRejectsWhatIsNotAnImage(t *testing.T) { + s, _ := Lookup("medium") + + if _, err := Generate(bytes.NewReader([]byte("not an image")), s); err == nil { + t.Error("Generate(text) err = nil, want an error") + } +} From 40f4eea1ef5086801152b9bf05f5417f7a93b275 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 20:59:56 +0900 Subject: [PATCH 149/428] answer the files comments and gallery modules --- internal/db/file.go | 36 ++++++++++++++++++++++ internal/module/module.go | 2 ++ internal/module/render_test.go | 2 +- internal/modules/comments.go | 31 +++++++++++++++++++ internal/modules/files.go | 55 ++++++++++++++++++++++++++++++++++ internal/modules/gallery.go | 46 ++++++++++++++++++++++++++++ internal/page/gallery.go | 11 +++++++ internal/page/gallery_test.go | 29 ++++++++++++++++++ internal/page/template.go | 2 +- internal/repo/modules.go | 8 +++++ 10 files changed, 220 insertions(+), 2 deletions(-) create mode 100644 internal/modules/comments.go create mode 100644 internal/modules/files.go create mode 100644 internal/modules/gallery.go create mode 100644 internal/page/gallery.go create mode 100644 internal/page/gallery_test.go diff --git a/internal/db/file.go b/internal/db/file.go index 5d80f7bb..e01a31f4 100644 --- a/internal/db/file.go +++ b/internal/db/file.go @@ -39,3 +39,39 @@ func (d *DB) ArticleFile(ctx context.Context, articleRef, fileName string) (*Art } return &f, nil } + +type ArticleFileEntry struct { + ID int64 + Name string + MimeType string + Size int64 +} + +var qArticleFiles = register("ArticleFiles", ` +SELECT f.id, f.name, f.mime_type, f.size +FROM web_file f +WHERE f.article_id = $1 AND f.deleted_at IS NULL +ORDER BY f.name, f.id`) + +// The name is unique per article only among the rows still alive, so the id +// breaks the tie for a name that was deleted and uploaded again. +func (d *DB) ArticleFiles(ctx context.Context, articleID int64) ([]ArticleFileEntry, error) { + rows, err := d.pool.Query(ctx, qArticleFiles, articleID) + if err != nil { + return nil, fmt.Errorf("list files of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []ArticleFileEntry + for rows.Next() { + var f ArticleFileEntry + if err := rows.Scan(&f.ID, &f.Name, &f.MimeType, &f.Size); err != nil { + return nil, fmt.Errorf("scan file: %w", err) + } + out = append(out, f) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("list files of article %d: %w", articleID, err) + } + return out, nil +} diff --git a/internal/module/module.go b/internal/module/module.go index e70c894b..f5623cbe 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -40,6 +40,8 @@ type Data interface { ArticleByID(id int64) (*db.Article, error) ArticleAuthors(articleID int64) ([]db.User, error) + ArticleFiles(articleID int64) ([]db.ArticleFileEntry, error) + CommentInfo(articleID int64) (db.CommentInfo, error) RenderUserByID(id *int64) (string, error) RenderUser(u db.User) (string, error) diff --git a/internal/module/render_test.go b/internal/module/render_test.go index 94f876bb..fb1ab7f9 100644 --- a/internal/module/render_test.go +++ b/internal/module/render_test.go @@ -54,7 +54,7 @@ func (f fakeData) CountArticles(db.ListFilter, int, *int) (int, error) { } func TestEveryPortedModuleAnswers(t *testing.T) { - ported := []string{"applicationform", "button", "countpages", "css", "forumcategory", "forumnewthread", "forumstart", "forumthread", "listpages", "listusers", "members", "membershipbypassword", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "time", "wantedpages"} + ported := []string{"applicationform", "button", "comments", "countpages", "css", "files", "forumcategory", "forumnewthread", "forumstart", "forumthread", "gallery", "listpages", "listusers", "members", "membershipbypassword", "newpage", "pagedescription", "pageimage", "pagesbytag", "rate", "recentposts", "redirect", "search", "sitechanges", "tagcloud", "time", "wantedpages"} for _, name := range ported { if !module.Ported(name) { t.Errorf("Ported(%q) = false, want true", name) diff --git a/internal/modules/comments.go b/internal/modules/comments.go new file mode 100644 index 00000000..f073a76f --- /dev/null +++ b/internal/modules/comments.go @@ -0,0 +1,31 @@ +package modules + +import ( + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" +) + +func init() { module.Register("comments", renderComments) } + +func renderComments(env module.Env, _ map[string]string, _ string) (string, error) { + if env.Page == nil || env.Page.Article == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} + } + info, err := env.Data.CommentInfo(env.Page.Article.ID) + if err != nil { + return "", err + } + + var b strings.Builder + b.WriteString(`
` + "\n" + ind8 + + `` + "\n" + ind8 + + `
`) + return b.String(), nil +} diff --git a/internal/modules/files.go b/internal/modules/files.go new file mode 100644 index 00000000..1e4c4291 --- /dev/null +++ b/internal/modules/files.go @@ -0,0 +1,55 @@ +package modules + +import ( + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" +) + +func init() { module.Register("files", renderFiles) } + +// Wikidot wraps the table in a div named after a random number it uses for its +// own paging, which no stylesheet can select, so nothing here answers to it. +func renderFiles(env module.Env, _ map[string]string, _ string) (string, error) { + if env.Page == nil || env.Page.Article == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} + } + files, err := env.Data.ArticleFiles(env.Page.Article.ID) + if err != nil { + return "", err + } + + base := "/local--files/" + env.Page.Article.FullName() + "/" + + var b strings.Builder + b.WriteString(``) + // The last column waits on a file reporting more than the table shows, and + // stays present so a theme sizing four columns still lines up. + for _, f := range files { + b.WriteString(``) + } + b.WriteString("
` + escape.HTML(env.Text("module-files-name")) + + `` + escape.HTML(env.Text("module-files-type")) + + `` + escape.HTML(env.Text("module-files-size")) + `
` + escape.HTML(f.Name) + + `` + escape.HTML(f.MimeType) + + `` + escape.HTML(fileSize(f.Size)) + `
\n" + ind8 + `

` + + `` + + escape.HTML(env.Text("module-files-manage")) + `

`) + return b.String(), nil +} + +// Wikidot divides by 1024 and still writes kB, and a theme lining these up in a +// column would notice a digit more or fewer. +func fileSize(n int64) string { + const unit = 1024 + if n < unit { + return strconv.FormatInt(n, 10) + " bytes" + } + v := float64(n) / unit + if v < unit { + return strconv.FormatFloat(v, 'f', 2, 64) + " kB" + } + return strconv.FormatFloat(v/unit, 'f', 2, 64) + " MB" +} diff --git a/internal/modules/gallery.go b/internal/modules/gallery.go new file mode 100644 index 00000000..5366fae0 --- /dev/null +++ b/internal/modules/gallery.go @@ -0,0 +1,46 @@ +package modules + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/escape" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/thumb" +) + +func init() { module.Register("gallery", renderGallery) } + +const defaultGallerySize = "medium" + +func renderGallery(env module.Env, params map[string]string, _ string) (string, error) { + if env.Page == nil || env.Page.Article == nil { + return "", &module.Error{Message: env.Text("module-failed", "name", env.Name)} + } + name := strings.TrimSpace(params["size"]) + if name == "" { + name = defaultGallerySize + } + size, ok := thumb.Lookup(name) + if !ok { + return "", &module.Error{Message: env.Text("module-gallery-size", "size", params["size"])} + } + + files, err := env.Data.ArticleFiles(env.Page.Article.ID) + if err != nil { + return "", err + } + + base := "/local--resized-images/" + env.Page.Article.FullName() + "/" + var b strings.Builder + b.WriteString(`
`) + for _, f := range files { + if !strings.HasPrefix(f.MimeType, "image/") { + continue + } + url := escape.HTML(base + f.Name + "/" + size.Name + ".jpg") + b.WriteString("\n" + ind8 + `
` + + `
`) + } + b.WriteString("
") + return b.String(), nil +} diff --git a/internal/page/gallery.go b/internal/page/gallery.go new file mode 100644 index 00000000..3d199c62 --- /dev/null +++ b/internal/page/gallery.go @@ -0,0 +1,11 @@ +package page + +import "regexp" + +// The name has to end at the head, or [[galleryish]] would be rewritten into a +// module that does not exist. +var galleryPattern = regexp.MustCompile(`(?i)\[\[gallery(\s[^\]]*)?\]\]`) + +func Galleries(source string) string { + return galleryPattern.ReplaceAllString(source, `[[module Gallery$1]]`) +} diff --git a/internal/page/gallery_test.go b/internal/page/gallery_test.go new file mode 100644 index 00000000..f6b1a4fc --- /dev/null +++ b/internal/page/gallery_test.go @@ -0,0 +1,29 @@ +package page + +import "testing" + +func TestGalleries(t *testing.T) { + cases := []struct{ in, want string }{ + {"", ""}, + {"[[gallery]]", `[[module Gallery]]`}, + {`[[gallery size="medium"]]`, `[[module Gallery size="medium"]]`}, + {"[[GALLERY]]", `[[module Gallery]]`}, + {"before [[gallery]] after", `before [[module Gallery]] after`}, + {"[[galleryish]]", "[[galleryish]]"}, + {"[[gallery-of-x]]", "[[gallery-of-x]]"}, + {"[[galleries size=1]]", "[[galleries size=1]]"}, + {`[[module Gallery size="medium"]]`, `[[module Gallery size="medium"]]`}, + } + for _, c := range cases { + if got := Galleries(c.in); got != c.want { + t.Errorf("Galleries(%q) = %q, want %q", c.in, got, c.want) + } + } +} + +func TestGalleriesLeavesAHeadCarryingABracket(t *testing.T) { + in := `[[gallery size="a]b"]]` + if got := Galleries(in); got != in { + t.Errorf("Galleries(%q) = %q, want it left alone", in, got) + } +} diff --git a/internal/page/template.go b/internal/page/template.go index 44d5f725..6db39e92 100644 --- a/internal/page/template.go +++ b/internal/page/template.go @@ -33,7 +33,7 @@ func ThisVars(source string, vars *Vars) string { // PreRender is everything the source goes through on its way to the renderer. // Both passes are blind to code blocks, the way a %% pair in prose already is. func PreRender(source string, vars *Vars) string { - return Buttons(ThisVars(source, vars)) + return Galleries(Buttons(ThisVars(source, vars))) } // PageVars is the pass the category template goes through, where a variable diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 74a1f508..0348658a 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -100,6 +100,14 @@ func (m moduleData) ArticleAuthors(articleID int64) ([]db.User, error) { return m.repo.db.ArticleAuthors(m.repo.ctx, articleID) } +func (m moduleData) ArticleFiles(articleID int64) ([]db.ArticleFileEntry, error) { + return m.repo.db.ArticleFiles(m.repo.ctx, articleID) +} + +func (m moduleData) CommentInfo(articleID int64) (db.CommentInfo, error) { + return m.repo.db.CommentInfo(m.repo.ctx, articleID) +} + func (m moduleData) TagCloud(limit *int) ([]db.CloudTag, error) { return m.repo.db.TagCloud(m.repo.ctx, limit) } From 30eb529113c2f69d60efb40f08be9ca9fec757f6 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 20:59:56 +0900 Subject: [PATCH 150/428] fix color --- internal/modules/rate.go | 2 +- internal/modules/testdata/rate.golden | 20 ++++++++++---------- static/app.css | 6 +++--- static/system.css | 6 +++--- web/js/articles/article-files.tsx | 14 +++----------- web/js/articles/article-rating.tsx | 2 +- web/js/components/authorship-editor.tsx | 2 +- web/js/components/tag-editor.tsx | 2 +- 8 files changed, 23 insertions(+), 31 deletions(-) diff --git a/internal/modules/rate.go b/internal/modules/rate.go index b093f380..dd8d5f43 100644 --- a/internal/modules/rate.go +++ b/internal/modules/rate.go @@ -16,7 +16,7 @@ func init() { module.Register("rate", renderRate) } const ( starColorRated = "#f0ac00" - starColorUnrated = "#4e6b6b" + starColorUnrated = "#000000" ) func renderRate(env module.Env, _ map[string]string, _ string) (string, error) { diff --git a/internal/modules/testdata/rate.golden b/internal/modules/testdata/rate.golden index 6b69a085..01f94686 100644 --- a/internal/modules/testdata/rate.golden +++ b/internal/modules/testdata/rate.golden @@ -23,37 +23,37 @@ === probe-bare-probecrowd0
评分: +0+–x
=== probestars-rated-anonymous -
评分: 4.5
2/100%
+
评分: 4.5
2/100%
=== probestars-rated-probevoter
评分: 4.5
2/100%
=== probestars-rated-probe-author
评分: 4.5
2/100%
=== probestars-rated-probecrowd0 -
评分: 4.5
2/100%
+
评分: 4.5
2/100%
=== probestars-unrated-anonymous -
评分: —
0/0%
+
评分: —
0/0%
=== probestars-unrated-probevoter -
评分: —
0/0%
+
评分: —
0/0%
=== probestars-unrated-probe-author -
评分: —
0/0%
+
评分: —
0/0%
=== probestars-unrated-probecrowd0 -
评分: —
0/0%
+
评分: —
0/0%
=== probestars-third-anonymous -
评分: 3.3
3/100%
+
评分: 3.3
3/100%
=== probestars-third-probevoter
评分: 3.3
3/100%
=== probestars-third-probe-author
评分: 3.3
3/100%
=== probestars-third-probecrowd0 -
评分: 3.3
3/100%
+
评分: 3.3
3/100%
=== probestars-quarter-anonymous -
评分: 0.8
2/0%
+
评分: 0.8
2/0%
=== probestars-quarter-probevoter
评分: 0.8
2/0%
=== probestars-quarter-probe-author
评分: 0.8
2/0%
=== probestars-quarter-probecrowd0 -
评分: 0.8
2/0%
+
评分: 0.8
2/0%
=== probeoff-unratable-anonymous === probeoff-unratable-probevoter diff --git a/static/app.css b/static/app.css index a1b5226b..2415fb90 100644 --- a/static/app.css +++ b/static/app.css @@ -41,7 +41,7 @@ margin-bottom: 16px; } .w-stars-rate-module .w-stars-rate-number { - color: #4e6b6b; + color: #000000; font-weight: bold; } .w-stars-rate-module .w-stars-rate-rating { @@ -105,7 +105,7 @@ content: "\f005\f005\f005\f005\f005"; letter-spacing: 2px; white-space: nowrap; - color: var(--rated-var, #4e6b6b); + color: var(--rated-var, #000000); } .w-stars-rate-module .w-stars-rate-control .w-stars-rate-stars-wrapper .w-stars-rate-stars-view { overflow: hidden; @@ -139,7 +139,7 @@ text-align: center; margin-left: 8px; margin-right: 8px; - color: #4e6b6b; + color: #000000; font-weight: bold; } diff --git a/static/system.css b/static/system.css index 4a520670..6aeb6622 100644 --- a/static/system.css +++ b/static/system.css @@ -51,7 +51,7 @@ html { background: #eee; } .system-content .heading { - background: repeating-linear-gradient(45deg, rgba(255, 255, 255, 0.062745098), transparent 4px), linear-gradient(to bottom, #000000, #446060); + background: repeating-linear-gradient(45deg, rgba(255, 255, 255, 0.062745098), transparent 4px), linear-gradient(to bottom, #000000, #000000); box-shadow: 0 -1px 3px rgba(0, 0, 0, 0.4980392157) inset; color: white; padding: 16px; @@ -143,12 +143,12 @@ html { } .system-content .content button:hover, .system-content .content input[type=submit]:hover { - background: #446060; + background: #000000; } .system-content .content button:active, .system-content .content input[type=submit]:active { background: #0e1414; - color: #4e6b6b; + color: #000000; } .system-content .login-form { diff --git a/web/js/articles/article-files.tsx b/web/js/articles/article-files.tsx index 18f0c9c2..b1aac10b 100644 --- a/web/js/articles/article-files.tsx +++ b/web/js/articles/article-files.tsx @@ -84,16 +84,8 @@ const Styles = styled.div<{ loading?: boolean }>` } .w-upload-btn { - background: #446060; - &:hover { - background: #517a7a; - } - border-radius: 4px; - color: white; - font-weight: bold; display: inline-block; padding: 4px 8px; - text-decoration: none; text-align: center; } @@ -138,7 +130,7 @@ const Styles = styled.div<{ loading?: boolean }>` border-radius: 999px; & > div { - background: #446060; + background: #000000; border-radius: 999px; height: 5px; } @@ -296,7 +288,7 @@ class ArticleFiles extends Component { {file.file.type} {this.formatSize(file.file.size)} {!file.uploading ? ( - this.onUploadFile(e, file)}> + this.onUploadFile(e, file)}> {t('articles.files.upload')} ) : null} @@ -312,7 +304,7 @@ class ArticleFiles extends Component {
) })} - + {t('articles.files.upload-all')}
diff --git a/web/js/articles/article-rating.tsx b/web/js/articles/article-rating.tsx index b62ec055..aa84c5ef 100644 --- a/web/js/articles/article-rating.tsx +++ b/web/js/articles/article-rating.tsx @@ -64,7 +64,7 @@ const Styles = styled.div<{ loading?: boolean }>` .w-bar-fill { height: 100%; border-radius: inherit; - background-color: #4e6b6b; + background-color: #000000; } .w-rate-num { width: 25px; diff --git a/web/js/components/authorship-editor.tsx b/web/js/components/authorship-editor.tsx index 6cf6e80d..c986e4e9 100644 --- a/web/js/components/authorship-editor.tsx +++ b/web/js/components/authorship-editor.tsx @@ -93,7 +93,7 @@ const UserSuggestion = styled.div` } &:hover, &.active { - background: #446060; + background: #000000; color: white; } ` diff --git a/web/js/components/tag-editor.tsx b/web/js/components/tag-editor.tsx index ed01e7cd..b5e4a32b 100644 --- a/web/js/components/tag-editor.tsx +++ b/web/js/components/tag-editor.tsx @@ -128,7 +128,7 @@ const TagSuggestionTag = styled.div` } &:hover, &.active { - background: #446060; + background: #000000; color: white; } ` From 28565d2c114a8089392dce8a97eb9b4cb60925bb Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 1 Sep 2026 21:13:42 +0900 Subject: [PATCH 151/428] keep reporting an embedded block's height until it lands --- internal/callbacks/injected.js | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/internal/callbacks/injected.js b/internal/callbacks/injected.js index 85fe1cab..fad5ffbe 100644 --- a/internal/callbacks/injected.js +++ b/internal/callbacks/injected.js @@ -1,18 +1,29 @@ + + + + + + + +
+ {{if .BackLink}} {{.T "system.back-home"}} + {{end}} +
+ {{.Before}} +
+

{{esc .Heading}}

+
+
+ {{.Content}} +
+
+
+
+ + +{{end}} diff --git a/internal/userpage/userpage.go b/internal/userpage/userpage.go new file mode 100644 index 00000000..0fba72c1 --- /dev/null +++ b/internal/userpage/userpage.go @@ -0,0 +1,281 @@ +// Package userpage answers the profile a user chip links to. +package userpage + +import ( + "context" + "errors" + "log/slog" + "net/http" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pagerender" + "github.com/WikitTeam/ProjectWikit/internal/printuser" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/shell" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/static" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +const Prefix = "/-/users/" + +const notFoundBody = "User not found" + +type Deps struct { + DB *db.DB + Engine renderer.Renderer + Bundle *i18n.Bundle + Icons roles.IconLoader + Assets *static.Assets + TimeZone *time.Location + Log *slog.Logger +} + +type Handler struct { + deps Deps +} + +var _ http.Handler = (*Handler)(nil) + +func New(d Deps) *Handler { + if d.TimeZone == nil { + d.TimeZone = time.UTC + } + return &Handler{deps: d} +} + +func (h *Handler) log() *slog.Logger { + if h.deps.Log == nil { + return slog.Default() + } + return h.deps.Log +} + +func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + if r.Method != http.MethodGet && r.Method != http.MethodHead { + w.Header().Set("Allow", "GET, HEAD") + http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) + return + } + name, ok := strings.CutPrefix(r.URL.Path, Prefix) + if !ok || name == "" || strings.Contains(name, "/") { + notFound(w) + return + } + + body, err := h.page(r, name) + if err != nil { + h.log().Error("render profile", "path", r.URL.Path, "err", err) + http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) + return + } + if body == "" { + notFound(w) + return + } + + w.Header().Set("Content-Type", "text/html; charset=utf-8") + w.WriteHeader(http.StatusOK) + if r.Method != http.MethodHead { + _, _ = w.Write([]byte(body)) + } +} + +func (h *Handler) page(r *http.Request, name string) (string, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", errors.New("userpage: the request carries no site") + } + viewer := auth.FromContext(ctx) + loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) + + profile, err := h.lookup(r, name) + if errors.Is(err, db.ErrNotFound) { + return "", nil + } + if err != nil { + return "", err + } + + data, err := h.data(r, loc, current, profile, viewer) + if err != nil { + return "", err + } + render := shell.New(loc, h.deps.Assets, h.deps.TimeZone) + content, err := render.Profile(data) + if err != nil { + return "", err + } + + var out strings.Builder + err = render.SystemPage(&out, shell.System{ + Title: data.DisplayName, + BodyClass: "wikit-page", + Content: content, + }) + return out.String(), err +} + +func (h *Handler) lookup(r *http.Request, name string) (*db.Profile, error) { + if id, ok := numericID(name); ok { + return h.deps.DB.ProfileByID(r.Context(), id) + } + return h.deps.DB.ProfileByName(r.Context(), wikidot.CanonicalizeUsername(name)) +} + +// The tail after the id is never looked up, but it has to be there and it has +// to be a slug, or the whole thing is read as a name instead. +func numericID(name string) (int64, bool) { + digits, slug, found := strings.Cut(name, "-") + if !found || slug == "" || !isSlug(slug) { + return 0, false + } + id, err := strconv.ParseInt(digits, 10, 64) + if err != nil || id < 0 { + return 0, false + } + return id, true +} + +func isSlug(s string) bool { + for _, r := range s { + if !(r >= 'a' && r <= 'z' || r >= 'A' && r <= 'Z' || r >= '0' && r <= '9' || r == '-' || r == '_') { + return false + } + } + return true +} + +func (h *Handler) data(r *http.Request, loc *i18n.Localizer, current *db.Site, + profile *db.Profile, viewer *db.User) (shell.Profile, error) { + + ctx := r.Context() + data := shell.Profile{ + ID: profile.ID, + DisplayName: displayName(profile), + Avatar: avatar(profile), + AuthIcon: authIcon(current), + FromWikidot: profile.Type == printuser.TypeWikidot, + IsBot: profile.Type == printuser.TypeBot, + FullName: strings.TrimSpace(profile.FirstName + " " + profile.LastName), + Bio: profile.Bio, + JoinedAt: profile.DateJoined, + } + + titles, err := h.titles(ctx, loc, profile) + if err != nil { + return shell.Profile{}, err + } + data.Subtitle = strings.Join(titles, ", ") + + if viewer != nil && viewer.ID != profile.ID { + blocked, err := h.deps.DB.DirectMessageBlocked(ctx, viewer.ID, profile.ID) + if err != nil { + return shell.Profile{}, err + } + data.CanDirectMessage = true + data.IsBlocked = blocked + config, err := wikijson.Marshal(wikijson.Object{ + {Key: "userId", Value: profile.ID}, + {Key: "isBlocked", Value: blocked}, + }) + if err != nil { + return shell.Profile{}, err + } + data.ActionsConfig = config + } + data.IsSelf = viewer != nil && viewer.ID == profile.ID + + if profile.Bio != "" { + html, err := h.bio(r, loc, current, profile, viewer) + if err != nil { + return shell.Profile{}, err + } + data.BioHTML = html + } + return data, nil +} + +// The two states that outrank every role are answered first, the way the chip +// beside a name answers them. +func (h *Handler) titles(ctx context.Context, loc *i18n.Localizer, profile *db.Profile) ([]string, error) { + switch { + case !profile.IsActive && profile.Type == printuser.TypeWikidot: + return []string{loc.T("user-inactive-title")}, nil + case !profile.IsActive: + return []string{loc.T("user-banned-title")}, nil + case profile.Type == printuser.TypeBot: + return []string{loc.T("user-bot-title")}, nil + } + rs, err := h.deps.DB.RolesByUser(ctx, profile.ID) + if err != nil { + return nil, err + } + return roles.ShowcaseOf(rs).Titles, nil +} + +func (h *Handler) bio(r *http.Request, loc *i18n.Localizer, current *db.Site, + profile *db.Profile, viewer *db.User) (string, error) { + + env := pagerender.Deps{DB: h.deps.DB, Engine: h.deps.Engine, Icons: h.deps.Icons}. + Env(r.Context(), loc, current, viewer) + pc := page.NewContext(nil, nil, nil, viewer) + info, err := env.PageInfo(nil) + if err != nil { + return "", err + } + html, err := env.HTML(profile.Bio, info, env.Callbacks(nil, pc), renderer.ModeInline) + if err != nil { + return "", err + } + return html.Body, nil +} + +func displayName(p *db.Profile) string { + if p.Type == printuser.TypeWikidot { + return "wd:" + firstNonEmpty(p.DisplayName, p.WikidotUsername) + } + return firstNonEmpty(p.DisplayName, p.Username) +} + +func authIcon(s *db.Site) string { + if s.AuthIcon == "" { + return "" + } + return "/local--files/" + s.AuthIcon +} + +func avatar(p *db.Profile) string { + if p.Type == printuser.TypeWikidot { + return printuser.WikidotAvatar + } + if p.Avatar == "" { + return printuser.DefaultAvatar + } + return "/local--files/" + p.Avatar +} + +func firstNonEmpty(values ...string) string { + for _, value := range values { + if value != "" { + return value + } + } + return "" +} + +func notFound(w http.ResponseWriter) { + w.Header().Set("Content-Type", "text/html; charset=utf-8") + w.Header().Set("Content-Length", strconv.Itoa(len(notFoundBody))) + w.WriteHeader(http.StatusNotFound) + _, _ = w.Write([]byte(notFoundBody)) +} diff --git a/internal/userpage/userpage_test.go b/internal/userpage/userpage_test.go new file mode 100644 index 00000000..2013f674 --- /dev/null +++ b/internal/userpage/userpage_test.go @@ -0,0 +1,26 @@ +package userpage + +import "testing" + +func TestNumericIDTakesTheDjangoShape(t *testing.T) { + cases := []struct { + name string + id int64 + ok bool + }{ + {"1-admin", 1, true}, + {"12-probe_author-2", 12, true}, + {"1", 0, false}, + {"1-", 0, false}, + {"1-中文", 0, false}, + {"1-a.b", 0, false}, + {"admin", 0, false}, + {"-1-admin", 0, false}, + } + for _, c := range cases { + id, ok := numericID(c.name) + if ok != c.ok || id != c.id { + t.Errorf("numericID(%q) = %d, %v, want %d, %v", c.name, id, ok, c.id, c.ok) + } + } +} From 84e1cb2347d20f9a71aa394ff3a683a6717de832 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 21:13:47 +0900 Subject: [PATCH 179/428] add the queries a filtered search needs --- internal/db/search.go | 273 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 273 insertions(+) create mode 100644 internal/db/search.go diff --git a/internal/db/search.go b/internal/db/search.go new file mode 100644 index 00000000..7a130a06 --- /dev/null +++ b/internal/db/search.go @@ -0,0 +1,273 @@ +package db + +import ( + "context" + "fmt" + "strings" + "time" +) + +type SearchFilter struct { + Words []string + Category string + AuthorID *int64 + Include [][]int64 + Exclude []int64 + From *time.Time + To *time.Time + Hidden []string +} + +func (f SearchFilter) where(b *listBuilder) string { + parts := []string{"si.article_id IS NOT NULL"} + if len(f.Hidden) > 0 { + parts = append(parts, "NOT (a.category = ANY("+b.arg(f.Hidden)+"))") + } + if f.Category != "" { + parts = append(parts, "a.category = "+b.arg(strings.ToLower(f.Category))) + } + if f.AuthorID != nil { + parts = append(parts, "EXISTS (SELECT 1 FROM web_article_authors aa"+ + " WHERE aa.article_id = a.id AND aa.user_id = "+b.arg(*f.AuthorID)+")") + } + // One name can name several tags and a page needs only one of them. Naming + // two tags asks for a page carrying both. + for _, group := range f.Include { + parts = append(parts, "EXISTS (SELECT 1 FROM web_article_tags at"+ + " WHERE at.article_id = a.id AND at.tag_id = ANY("+b.arg(group)+"))") + } + if len(f.Exclude) > 0 { + parts = append(parts, "NOT EXISTS (SELECT 1 FROM web_article_tags at"+ + " WHERE at.article_id = a.id AND at.tag_id = ANY("+b.arg(f.Exclude)+"))") + } + if f.From != nil { + parts = append(parts, "a.created_at >= "+b.arg(*f.From)) + } + if f.To != nil { + parts = append(parts, "a.created_at <= "+b.arg(*f.To)) + } + for _, word := range f.Words { + parts = append(parts, "si.content_plaintext ILIKE "+b.arg(likeContains(word))) + } + return "FROM web_articlesearchindex si\nJOIN web_article a ON a.id = si.article_id\nWHERE " + + strings.Join(parts, "\n AND ") +} + +type SearchHit struct { + Article Article + Plaintext string +} + +func (f SearchFilter) SelectSQL(offset, limit int) (string, []any) { + b := &listBuilder{} + return f.selectSQL(b, offset, limit), b.args +} + +func (f SearchFilter) selectSQL(b *listBuilder, offset, limit int) string { + return "SELECT " + prefixedArticleColumns + ", si.content_plaintext\n" + + f.where(b) + "\nORDER BY a.created_at DESC, a.id DESC" + + "\nLIMIT " + b.arg(limit) + "\nOFFSET " + b.arg(offset) +} + +func (d *DB) SearchArticles(ctx context.Context, f SearchFilter, offset, limit int) ([]SearchHit, error) { + b := &listBuilder{} + sql := f.selectSQL(b, offset, limit) + + rows, err := d.pool.Query(ctx, sql, b.args...) + if err != nil { + return nil, fmt.Errorf("query search: %w", err) + } + defer rows.Close() + + var out []SearchHit + for rows.Next() { + var hit SearchHit + a := &hit.Article + if err := rows.Scan(&a.ID, &a.Category, &a.Name, &a.Title, &a.ParentID, &a.Locked, + &a.CreatedAt, &a.UpdatedAt, &a.MediaName, &hit.Plaintext); err != nil { + return nil, fmt.Errorf("scan search hit: %w", err) + } + out = append(out, hit) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read search: %w", err) + } + return out, nil +} + +func (f SearchFilter) CountSQL() (string, []any) { + b := &listBuilder{} + return "SELECT COUNT(*)\n" + f.where(b), b.args +} + +func (d *DB) SearchCount(ctx context.Context, f SearchFilter) (int, error) { + sql, args := f.CountSQL() + + var n int + if err := d.pool.QueryRow(ctx, sql, args...).Scan(&n); err != nil { + return 0, fmt.Errorf("count search: %w", err) + } + return n, nil +} + +var qTagIDsByFullName = register("TagIDsByFullName", ` +SELECT t.id +FROM web_tag t +JOIN web_tagscategory c ON c.id = t.category_id +WHERE t.name = $1 AND ($2 = '' OR c.slug = $2)`) + +// A name without a category matches that tag in every category, which is what +// makes one name able to name several tags. +func (d *DB) TagIDsByFullName(ctx context.Context, category, name string) ([]int64, error) { + rows, err := d.pool.Query(ctx, qTagIDsByFullName, name, category) + if err != nil { + return nil, fmt.Errorf("query tag %q: %w", name, err) + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + return nil, fmt.Errorf("scan tag id: %w", err) + } + out = append(out, id) + } + return out, rows.Err() +} + +var qAuthorsOfArticles = register("AuthorsOfArticles", ` +SELECT link.article_id, `+prefixed("u", userColumns)+` +FROM web_article_authors link +JOIN web_user u ON u.id = link.user_id +WHERE link.article_id = ANY($1) +ORDER BY link.article_id, link.id`) + +func (d *DB) AuthorsOfArticles(ctx context.Context, ids []int64) (map[int64][]User, error) { + out := make(map[int64][]User, len(ids)) + if len(ids) == 0 { + return out, nil + } + rows, err := d.pool.Query(ctx, qAuthorsOfArticles, ids) + if err != nil { + return nil, fmt.Errorf("query authors: %w", err) + } + defer rows.Close() + + for rows.Next() { + var id int64 + var u User + dest, finish := userDest(&u) + if err := rows.Scan(append([]any{&id}, dest...)...); err != nil { + return nil, fmt.Errorf("scan author: %w", err) + } + finish() + out[id] = append(out[id], u) + } + return out, rows.Err() +} + +var qVoteStatsOfArticles = register("VoteStatsOfArticles", ` +SELECT article_id, + COALESCE(SUM(rate), 0), + COUNT(rate), + COUNT(rate) FILTER (WHERE rate = 1), + COALESCE(AVG(rate), 0), + COUNT(rate) FILTER (WHERE rate >= 3) +FROM web_vote +WHERE article_id = ANY($1) +GROUP BY article_id`) + +func (d *DB) VoteStatsOfArticles(ctx context.Context, ids []int64) (map[int64]VoteStats, error) { + out := make(map[int64]VoteStats, len(ids)) + if len(ids) == 0 { + return out, nil + } + rows, err := d.pool.Query(ctx, qVoteStatsOfArticles, ids) + if err != nil { + return nil, fmt.Errorf("query votes: %w", err) + } + defer rows.Close() + + for rows.Next() { + var id int64 + var s VoteStats + if err := rows.Scan(&id, &s.Sum, &s.Count, &s.GoodUpDown, &s.Average, &s.GoodStars); err != nil { + return nil, fmt.Errorf("scan votes: %w", err) + } + out[id] = s + } + return out, rows.Err() +} + +var qCommentCountsOfArticles = register("CommentCountsOfArticles", ` +SELECT t.article_id, COUNT(p.id) +FROM web_forumthread t +JOIN web_forumpost p ON p.thread_id = t.id +WHERE t.article_id = ANY($1) +GROUP BY t.article_id`) + +func (d *DB) CommentCountsOfArticles(ctx context.Context, ids []int64) (map[int64]int, error) { + out := make(map[int64]int, len(ids)) + if len(ids) == 0 { + return out, nil + } + rows, err := d.pool.Query(ctx, qCommentCountsOfArticles, ids) + if err != nil { + return nil, fmt.Errorf("query comment counts: %w", err) + } + defer rows.Close() + + for rows.Next() { + var id int64 + var n int + if err := rows.Scan(&id, &n); err != nil { + return nil, fmt.Errorf("scan comment count: %w", err) + } + out[id] = n + } + return out, rows.Err() +} + +var qTagsOfArticles = register("TagsOfArticles", ` +SELECT link.article_id, t.id, c.slug, t.name +FROM web_article_tags link +JOIN web_tag t ON t.id = link.tag_id +JOIN web_tagscategory c ON c.id = t.category_id +WHERE link.article_id = ANY($1) +ORDER BY link.article_id, c.slug, t.name`) + +type ArticleTag struct { + ID int64 + Category string + Name string +} + +func (t ArticleTag) FullName() string { + if t.Category == DefaultCategory || t.Category == "" { + return t.Name + } + return t.Category + ":" + t.Name +} + +func (d *DB) TagsOfArticles(ctx context.Context, ids []int64) (map[int64][]ArticleTag, error) { + out := make(map[int64][]ArticleTag, len(ids)) + if len(ids) == 0 { + return out, nil + } + rows, err := d.pool.Query(ctx, qTagsOfArticles, ids) + if err != nil { + return nil, fmt.Errorf("query tags: %w", err) + } + defer rows.Close() + + for rows.Next() { + var id int64 + var t ArticleTag + if err := rows.Scan(&id, &t.ID, &t.Category, &t.Name); err != nil { + return nil, fmt.Errorf("scan tag: %w", err) + } + out[id] = append(out[id], t) + } + return out, rows.Err() +} From 5d4956c68b03cbce465f06cca7bb734a4dae9ad2 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 21:13:47 +0900 Subject: [PATCH 180/428] let a module answer a method of its own --- internal/module/api.go | 33 +++++++++++++++++++++++++++++ internal/module/module.go | 9 ++++++++ internal/pagerender/pagerender.go | 20 +++++++++++++----- internal/repo/modules.go | 32 ++++++++++++++++++++++++++++ internal/repo/repo.go | 24 ++++++++++++++++++--- internal/webapi/webapi.go | 35 ++++++++++++++++++++++++++++--- 6 files changed, 142 insertions(+), 11 deletions(-) create mode 100644 internal/module/api.go diff --git a/internal/module/api.go b/internal/module/api.go new file mode 100644 index 00000000..7310ed08 --- /dev/null +++ b/internal/module/api.go @@ -0,0 +1,33 @@ +package module + +import ( + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +type API func(env Env, params map[string]string) (wikijson.Object, error) + +// Only the methods that change nothing are registered here. The ones that write +// are checked for a CSRF token first, and nothing does that yet. +var apis = map[string]API{} + +func RegisterAPI(module, method string, fn API) { + if _, ok := registry[module]; !ok { + panic("module: " + module + " is not in the registry") + } + apis[apiKey(module, method)] = fn +} + +func LookupAPI(module, method string) (API, bool) { + info, ok := Lookup(module) + if !ok || info.Removed { + return nil, false + } + fn, ok := apis[apiKey(info.Name, method)] + return fn, ok +} + +func apiKey(module, method string) string { + return strings.ToLower(module) + "." + strings.ToLower(method) +} diff --git a/internal/module/module.go b/internal/module/module.go index 7d092a16..b4b17af5 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -48,6 +48,15 @@ type Data interface { RenderUserByID(id *int64) (string, error) RenderUser(u db.User) (string, error) + SearchArticles(f db.SearchFilter, offset, limit int) ([]db.SearchHit, error) + SearchCount(f db.SearchFilter) (int, error) + TagIDsByFullName(category, name string) ([]int64, error) + AuthorsOfArticles(ids []int64) (map[int64][]db.User, error) + VoteStatsOfArticles(ids []int64) (map[int64]db.VoteStats, error) + CommentCountsOfArticles(ids []int64) (map[int64]int, error) + TagsOfArticles(ids []int64) (map[int64][]db.ArticleTag, error) + UserByDisplayName(name string) (*db.User, error) + SiteChanges(f db.SiteChangeFilter, offset, limit int) ([]db.SiteChange, error) SiteChangeCount(f db.SiteChangeFilter) (int, error) ArticleCategories(hidden []string) ([]string, error) diff --git a/internal/pagerender/pagerender.go b/internal/pagerender/pagerender.go index b18f0bfb..464dec5b 100644 --- a/internal/pagerender/pagerender.go +++ b/internal/pagerender/pagerender.go @@ -13,6 +13,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) type Deps struct { @@ -72,8 +73,21 @@ func (e *Env) PageInfo(source *db.Article) (renderer.PageInfo, error) { } func (e *Env) Callbacks(vars *page.Vars, pc *page.Context) *callbacks.Callbacks { + cb := callbacks.New(e.loc, e.store()) + cb.SetPageVars(vars) + cb.SetContext(pc) + return cb +} + +// ModuleAPI answers a question the page asks one module directly, which reaches +// the same module set a render does. +func (e *Env) ModuleAPI(pc *page.Context, name, method string, params map[string]string) (wikijson.Object, error) { + return e.store().CallAPI(pc, name, method, params) +} + +func (e *Env) store() *repo.Repository { users := printuser.New(e.loc, e.deps.Icons) - store := repo.New(e.ctx, e.deps.DB, users, repo.Options{ + return repo.New(e.ctx, e.deps.DB, users, repo.Options{ Loc: e.loc, Site: e.site, User: e.user, @@ -82,10 +96,6 @@ func (e *Env) Callbacks(vars *page.Vars, pc *page.Context) *callbacks.Callbacks RenderMessageText: e.messageText, Vars: repo.NewVarSource(e.ctx, e.deps.DB, e.site), }) - cb := callbacks.New(e.loc, store) - cb.SetPageVars(vars) - cb.SetContext(pc) - return cb } // The page it renders against is the one the module put in the context, which diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 43611c7c..622f3d97 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -278,6 +278,38 @@ func (m moduleData) ForumPostObject(p *db.ForumThreadPost, thread *perms.Object, return NewPerms(m.repo.ctx, m.repo.db).ForumPost(p, thread, u) } +func (m moduleData) SearchArticles(f db.SearchFilter, offset, limit int) ([]db.SearchHit, error) { + return m.repo.db.SearchArticles(m.repo.ctx, f, offset, limit) +} + +func (m moduleData) SearchCount(f db.SearchFilter) (int, error) { + return m.repo.db.SearchCount(m.repo.ctx, f) +} + +func (m moduleData) TagIDsByFullName(category, name string) ([]int64, error) { + return m.repo.db.TagIDsByFullName(m.repo.ctx, category, name) +} + +func (m moduleData) AuthorsOfArticles(ids []int64) (map[int64][]db.User, error) { + return m.repo.db.AuthorsOfArticles(m.repo.ctx, ids) +} + +func (m moduleData) VoteStatsOfArticles(ids []int64) (map[int64]db.VoteStats, error) { + return m.repo.db.VoteStatsOfArticles(m.repo.ctx, ids) +} + +func (m moduleData) CommentCountsOfArticles(ids []int64) (map[int64]int, error) { + return m.repo.db.CommentCountsOfArticles(m.repo.ctx, ids) +} + +func (m moduleData) TagsOfArticles(ids []int64) (map[int64][]db.ArticleTag, error) { + return m.repo.db.TagsOfArticles(m.repo.ctx, ids) +} + +func (m moduleData) UserByDisplayName(name string) (*db.User, error) { + return m.repo.db.UserByDisplayName(m.repo.ctx, name) +} + func (m moduleData) SiteChanges(f db.SiteChangeFilter, offset, limit int) ([]db.SiteChange, error) { return m.repo.db.SiteChanges(m.repo.ctx, f, offset, limit) } diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 666cc927..884455c7 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -4,6 +4,7 @@ package repo import ( "context" "errors" + "fmt" "strings" "time" @@ -19,6 +20,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/printuser" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) type Repository struct { @@ -89,8 +91,8 @@ func (r *Repository) IncludeSources(refs []renderer.IncludeRef) ([]renderer.Fetc return out, nil } -func (r *Repository) RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) { - html, err := module.Render(module.Env{ +func (r *Repository) moduleEnv(pc *page.Context) module.Env { + return module.Env{ Page: pc, Loc: r.opts.Loc, Site: r.opts.Site, @@ -101,7 +103,23 @@ func (r *Repository) RenderModule(pc *page.Context, name string, params map[stri RenderMessageText: r.opts.RenderMessageText, Vars: r.opts.Vars, - }, name, params, body) + } +} + +// CallAPI answers the page asking a module a question of its own, which is not +// a render and so produces JSON rather than markup. +func (r *Repository) CallAPI(pc *page.Context, name, method string, params map[string]string) (wikijson.Object, error) { + fn, ok := module.LookupAPI(name, method) + if !ok { + return nil, fmt.Errorf("repo: %s has no api method %s", name, method) + } + env := r.moduleEnv(pc) + env.Name = name + return fn(env, params) +} + +func (r *Repository) RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) { + html, err := module.Render(r.moduleEnv(pc), name, params, body) var moduleErr *module.Error if errors.As(err, &moduleErr) { return "", &callbacks.ModuleError{Message: moduleErr.Message} diff --git a/internal/webapi/webapi.go b/internal/webapi/webapi.go index 01d2d3ee..22d6a5eb 100644 --- a/internal/webapi/webapi.go +++ b/internal/webapi/webapi.go @@ -16,6 +16,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/csrf" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/pagerender" "github.com/WikitTeam/ProjectWikit/internal/renderer" @@ -84,13 +85,13 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { } var parsed call - if json.Unmarshal(raw, &parsed) != nil || parsed.Method != renderMethod { + if json.Unmarshal(raw, &parsed) != nil || !h.answers(parsed) { h.forward(w, r, raw, rest) return } loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) - out, status, err := h.render(r, loc, parsed) + out, status, err := h.answer(r, loc, parsed) if err != nil { var moduleErr *callbacks.ModuleError if errors.As(err, &moduleErr) { @@ -104,7 +105,18 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { writeJSON(w, status, out) } -func (h *Handler) render(r *http.Request, loc *i18n.Localizer, parsed call) (string, int, error) { +// A method beyond render is answered only when the module registered it, and a +// module registers only what changes nothing. Everything else goes upstream, +// which is what keeps the CSRF check over there. +func (h *Handler) answers(parsed call) bool { + if parsed.Method == renderMethod { + return true + } + _, ok := module.LookupAPI(parsed.Module, parsed.Method) + return ok +} + +func (h *Handler) answer(r *http.Request, loc *i18n.Localizer, parsed call) (string, int, error) { ctx := r.Context() current := site.FromContext(ctx) if current == nil { @@ -133,6 +145,10 @@ func (h *Handler) render(r *http.Request, loc *i18n.Localizer, parsed call) (str pc.CSRF = token } + if parsed.Method != renderMethod { + return h.callAPI(env, pc, parsed) + } + html, err := env.Callbacks(env.Vars(article), pc).RenderModule(parsed.Module, params(parsed.Params), parsed.Content) if err != nil { return "", 0, err @@ -140,6 +156,19 @@ func (h *Handler) render(r *http.Request, loc *i18n.Localizer, parsed call) (str return field("result", html), http.StatusOK, nil } +func (h *Handler) callAPI(env *pagerender.Env, pc *page.Context, parsed call) (string, int, error) { + + out, err := env.ModuleAPI(pc, parsed.Module, parsed.Method, params(parsed.Params)) + if err != nil { + return "", 0, err + } + body, err := wikijson.Marshal(out) + if err != nil { + return "", 0, err + } + return body, http.StatusOK, nil +} + func peek(body io.ReadCloser) (raw []byte, rest io.Reader, err error) { raw, err = io.ReadAll(io.LimitReader(body, maxParsed)) if err != nil { From 29b668b030eed188b9ca7dbe29efda42e3fd267d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 21:13:48 +0900 Subject: [PATCH 181/428] answer the search module's own query --- internal/modules/search_test.go | 73 +++++ internal/modules/searchapi.go | 363 +++++++++++++++++++++ internal/modules/testdata/oracle_search.py | 92 ++++++ 3 files changed, 528 insertions(+) create mode 100644 internal/modules/searchapi.go create mode 100644 internal/modules/testdata/oracle_search.py diff --git a/internal/modules/search_test.go b/internal/modules/search_test.go index d976f75f..cb4eabc5 100644 --- a/internal/modules/search_test.go +++ b/internal/modules/search_test.go @@ -3,6 +3,7 @@ package modules import ( "strings" "testing" + "time" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/module" @@ -57,3 +58,75 @@ func TestRenderSearchLeavesTheModuleParamsUntrimmed(t *testing.T) { t.Errorf("renderSearch() = %q, want it to contain %q", got, want) } } + +func TestSearchExcerptStaysAroundTheWord(t *testing.T) { + body := "title\n\n" + strings.Repeat("a", 300) + " needle " + strings.Repeat("b", 300) + + got := searchExcerpt(body, []string{"needle"}) + if !strings.Contains(got, "needle") { + t.Errorf("searchExcerpt() = %q, want it to carry the word", got) + } + if runes := []rune(got); len(runes) > 2*searchExcerptPad+len("needle")+2 { + t.Errorf("len(searchExcerpt()) = %d, want at most %d", + len(runes), 2*searchExcerptPad+len("needle")+2) + } + if !strings.HasPrefix(got, "…") || !strings.HasSuffix(got, "…") { + t.Errorf("searchExcerpt() = %q, want it marked as cut on both sides", got) + } +} + +func TestSearchExcerptWithoutAMatch(t *testing.T) { + body := "title\n\n" + strings.Repeat("c", 300) + + got := []rune(searchExcerpt(body, []string{"needle"})) + if len(got) != searchExcerptLen+1 { + t.Errorf("len(searchExcerpt(no match)) = %d, want %d", len(got), searchExcerptLen+1) + } +} + +func TestSearchExcerptCountsCharactersNotBytes(t *testing.T) { + body := "标题\n\n" + strings.Repeat("文", 200) + "针" + strings.Repeat("字", 200) + + got := searchExcerpt(body, []string{"针"}) + if !strings.Contains(got, "针") { + t.Errorf("searchExcerpt() = %q, want it to carry the word", got) + } + if runes := []rune(got); len(runes) > 2*searchExcerptPad+3 { + t.Errorf("len(searchExcerpt()) = %d, want at most %d", len(runes), 2*searchExcerptPad+3) + } +} + +func TestSearchExcerptDropsTheHeading(t *testing.T) { + if got := searchExcerpt("the title\n\nthe body", nil); got != "the body" { + t.Errorf("searchExcerpt() = %q, want %q", got, "the body") + } +} + +func TestSearchTagsSplitsOnBothSeparators(t *testing.T) { + got := searchTags(" alpha, beta -gamma ") + want := []string{"alpha", "beta", "-gamma"} + if len(got) != len(want) { + t.Fatalf("searchTags() = %v, want %v", got, want) + } + for i := range want { + if got[i] != want[i] { + t.Errorf("searchTags()[%d] = %q, want %q", i, got[i], want[i]) + } + } +} + +func TestSearchDate(t *testing.T) { + from := searchDate("2024-03-04", false) + if from == nil || from.Format(time.RFC3339) != "2024-03-04T00:00:00Z" { + t.Errorf("searchDate(start) = %v, want 2024-03-04T00:00:00Z", from) + } + to := searchDate(" 2024-03-04 ", true) + if to == nil || to.Format(time.RFC3339) != "2024-03-04T23:59:59Z" { + t.Errorf("searchDate(end) = %v, want 2024-03-04T23:59:59Z", to) + } + for _, raw := range []string{"", "not a date", "2024-13-40"} { + if got := searchDate(raw, false); got != nil { + t.Errorf("searchDate(%q) = %v, want nil", raw, got) + } + } +} diff --git a/internal/modules/searchapi.go b/internal/modules/searchapi.go new file mode 100644 index 00000000..0d7f863c --- /dev/null +++ b/internal/modules/searchapi.go @@ -0,0 +1,363 @@ +package modules + +import ( + "errors" + "fmt" + "regexp" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/printuser" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +func init() { module.RegisterAPI("search", "search", searchAPI) } + +const ( + searchLimit = 20 + + // What a result shows is the text around the word that was searched for, + // not the head of the page. + searchExcerptPad = 60 + searchExcerptLen = 160 + searchDateLayout = "2006-01-02" +) + +var searchSpaces = regexp.MustCompile(`\s+`) + +func searchAPI(env module.Env, params map[string]string) (wikijson.Object, error) { + query := strings.TrimSpace(params["q"]) + author := strings.TrimSpace(params["author"]) + category := strings.TrimSpace(params["category"]) + tags := searchTags(params["tags"]) + from := searchDate(params["datefrom"], false) + to := searchDate(params["dateto"], true) + + offset, err := strconv.Atoi(strings.TrimSpace(params["offset"])) + if err != nil || offset < 0 { + offset = 0 + } + + empty := wikijson.Object{ + {Key: "results", Value: wikijson.Array{}}, + {Key: "hasMore", Value: false}, + {Key: "total", Value: 0}, + } + if query == "" && author == "" && category == "" && len(tags) == 0 && from == nil && to == nil { + return empty, nil + } + + filter, ok, err := searchFilter(env, query, author, category, tags, from, to) + if err != nil { + return nil, err + } + if !ok { + return empty, nil + } + + total, err := env.Data.SearchCount(filter) + if err != nil { + return nil, err + } + hits, err := env.Data.SearchArticles(filter, offset, searchLimit+1) + if err != nil { + return nil, err + } + hasMore := len(hits) > searchLimit + if hasMore { + hits = hits[:searchLimit] + } + + results, err := searchResults(env, hits, filter, splitWords(query)) + if err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "results", Value: results}, + {Key: "hasMore", Value: hasMore}, + {Key: "total", Value: total}, + }, nil +} + +// A filter that cannot match anything comes back false rather than empty, since +// a tag nobody uses is not the same question as no tag at all. +func searchFilter(env module.Env, query, author, category string, tags []string, + from, to *time.Time) (db.SearchFilter, bool, error) { + + hidden, err := env.Data.HiddenCategories(env.User) + if err != nil { + return db.SearchFilter{}, false, err + } + filter := db.SearchFilter{ + Words: splitWords(query), + Category: category, + From: from, + To: to, + Hidden: hidden, + } + + if author != "" { + found, err := searchAuthor(env, author) + if err != nil { + return db.SearchFilter{}, false, err + } + if found == nil { + return db.SearchFilter{}, false, nil + } + filter.AuthorID = &found.ID + } + + for _, name := range tags { + if excluded, ok := strings.CutPrefix(name, "-"); ok { + ids, err := searchTagIDs(env, excluded) + if err != nil { + return db.SearchFilter{}, false, err + } + filter.Exclude = append(filter.Exclude, ids...) + continue + } + ids, err := searchTagIDs(env, name) + if err != nil { + return db.SearchFilter{}, false, err + } + if len(ids) == 0 { + return db.SearchFilter{}, false, nil + } + filter.Include = append(filter.Include, ids) + } + return filter, true, nil +} + +func searchTagIDs(env module.Env, name string) ([]int64, error) { + category, tag := "", name + if strings.Contains(name, ":") { + category, tag = wikidot.Split(name) + } + return env.Data.TagIDsByFullName(category, tag) +} + +func searchAuthor(env module.Env, name string) (*db.User, error) { + canon := wikidot.CanonicalizeUsername(name) + user, err := env.Data.UserByUsername(canon) + if err == nil && user != nil { + return user, nil + } + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + user, err = env.Data.UserByWikidotName(canon) + if err == nil && user != nil { + return user, nil + } + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + user, err = env.Data.UserByDisplayName(name) + if errors.Is(err, db.ErrNotFound) { + return nil, nil + } + return user, err +} + +func searchResults(env module.Env, hits []db.SearchHit, filter db.SearchFilter, words []string) (wikijson.Array, error) { + ids := make([]int64, 0, len(hits)) + for i := range hits { + ids = append(ids, hits[i].Article.ID) + } + authors, err := env.Data.AuthorsOfArticles(ids) + if err != nil { + return nil, err + } + votes, err := env.Data.VoteStatsOfArticles(ids) + if err != nil { + return nil, err + } + comments, err := env.Data.CommentCountsOfArticles(ids) + if err != nil { + return nil, err + } + tags, err := env.Data.TagsOfArticles(ids) + if err != nil { + return nil, err + } + wanted := map[int64]bool{} + for _, group := range filter.Include { + for _, id := range group { + wanted[id] = true + } + } + + out := make(wikijson.Array, 0, len(hits)) + for i := range hits { + article := &hits[i].Article + rating, err := searchRating(env, article, votes[article.ID]) + if err != nil { + return nil, err + } + out = append(out, wikijson.Object{ + {Key: "title", Value: firstNonBlank(article.Title, article.Name)}, + {Key: "url", Value: "/" + article.FullName()}, + {Key: "excerpt", Value: searchExcerpt(hits[i].Plaintext, words)}, + {Key: "words", Value: words}, + {Key: "author", Value: searchAuthorField(authors[article.ID])}, + {Key: "tags", Value: shownTags(tags[article.ID], wanted)}, + {Key: "comments", Value: comments[article.ID]}, + {Key: "createdAt", Value: searchTime(article.CreatedAt)}, + {Key: "updatedAt", Value: searchTime(article.UpdatedAt)}, + {Key: "rating", Value: rating}, + }) + } + return out, nil +} + +func searchRating(env module.Env, article *db.Article, stats db.VoteStats) (any, error) { + siteMode, err := env.Data.SiteRatingMode() + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + categoryMode, err := env.Data.CategoryRatingMode(article.Category) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + mode := page.RatingMode(siteMode, categoryMode) + rating := page.RatingOf(mode, stats) + + switch mode { + case page.RatingModeDisabled: + return nil, nil + case page.RatingModeStars: + if rating.Votes == 0 { + return "—", nil + } + return fmt.Sprintf("%.1f", rating.Value), nil + case page.RatingModeUpDown: + return fmt.Sprintf("%+d", rating.Value), nil + } + return fmt.Sprintf("%d", rating.Value), nil +} + +func searchAuthorField(authors []db.User) any { + if len(authors) == 0 { + return nil + } + author := authors[0] + return wikijson.Object{ + {Key: "name", Value: author.DisplayLabel()}, + {Key: "url", Value: "/-/users/" + urlName(author)}, + } +} + +func urlName(u db.User) string { + if u.Type == printuser.TypeWikidot { + return firstNonBlank(u.WikidotUsername, u.Username) + } + return u.Username +} + +func shownTags(tags []db.ArticleTag, wanted map[int64]bool) []string { + out := []string{} + if len(wanted) == 0 { + return out + } + for _, tag := range tags { + if wanted[tag.ID] { + out = append(out, tag.FullName()) + } + } + return out +} + +func searchExcerpt(plaintext string, words []string) string { + _, body, found := strings.Cut(plaintext, "\n\n") + if !found { + body = plaintext + } + body = strings.TrimSpace(searchSpaces.ReplaceAllString(body, " ")) + if body == "" { + return "" + } + + runes := []rune(body) + start := 0 + end := min(len(runes), searchExcerptLen) + if at, length, ok := firstWord(body, words); ok { + start = max(0, at-searchExcerptPad) + end = min(len(runes), at+length+searchExcerptPad) + } + + snippet := string(runes[start:end]) + if start > 0 { + snippet = "…" + snippet + } + if end < len(runes) { + snippet += "…" + } + return snippet +} + +// The position is counted in characters rather than bytes, since the excerpt is +// cut in characters and a page of Chinese would otherwise be sliced mid-letter. +func firstWord(body string, words []string) (at, length int, ok bool) { + lower := strings.ToLower(body) + best := -1 + size := 0 + for _, word := range words { + if word == "" { + continue + } + index := strings.Index(lower, strings.ToLower(word)) + if index < 0 { + continue + } + if best < 0 || index < best { + best, size = index, len([]rune(word)) + } + } + if best < 0 { + return 0, 0, false + } + return len([]rune(body[:best])), size, true +} + +func searchTags(raw string) []string { + var out []string + for _, name := range strings.FieldsFunc(raw, func(r rune) bool { return r == ',' || r == ' ' || r == '\t' || r == '\n' }) { + if name != "" { + out = append(out, name) + } + } + return out +} + +func splitWords(query string) []string { + out := []string{} + for _, word := range searchSpaces.Split(strings.TrimSpace(query), -1) { + if word != "" { + out = append(out, word) + } + } + return out +} + +func searchDate(raw string, endOfDay bool) *time.Time { + value, err := time.ParseInLocation(searchDateLayout, strings.TrimSpace(raw), time.UTC) + if err != nil { + return nil + } + if endOfDay { + value = value.Add(23*time.Hour + 59*time.Minute + 59*time.Second) + } + return &value +} + +func searchTime(at time.Time) any { + if at.IsZero() { + return nil + } + return at.UTC().Format("2006-01-02T15:04:05.999999-07:00") +} diff --git a/internal/modules/testdata/oracle_search.py b/internal/modules/testdata/oracle_search.py new file mode 100644 index 00000000..7e1a52bf --- /dev/null +++ b/internal/modules/testdata/oracle_search.py @@ -0,0 +1,92 @@ +"""Compares the search module's api_search against Django's, call by call. + +Run oracle_seed.py first, then start both servers and: + + python internal/modules/testdata/oracle_search.py + +The excerpt is left out of the comparison on purpose: pwikit cuts a window +around the word that was searched for, Django takes the head of the page. +The category filter is pwikit's own, so those cases only check pwikit answers. +""" +import http.client +import json +import sys + +PWIKIT_PORT = 8080 +DJANGO_PORT = 8000 +HOST = 'localhost' +PATH = '/pw-api/modules' + +PWIKIT_ONLY = {'category', 'category-and-word', 'category-unknown'} + + +def cases(): + yield 'word', {'q': 'probe'} + yield 'two-words', {'q': 'probe source'} + yield 'no-match', {'q': 'nothing matches this at all'} + yield 'nothing-asked', {} + yield 'author', {'author': 'probe-author'} + yield 'author-unknown', {'author': 'nobody-at-all'} + yield 'author-and-word', {'q': 'source', 'author': 'probe-author'} + yield 'tag', {'tags': 'alpha'} + yield 'tag-excluded', {'tags': 'alpha -zeta'} + yield 'tag-unknown', {'tags': 'no-such-tag'} + yield 'tag-with-category', {'tags': 'lang:en'} + yield 'dates', {'datefrom': '2021-01-01', 'dateto': '2021-12-31'} + yield 'dates-empty', {'datefrom': '1999-01-01', 'dateto': '1999-12-31'} + yield 'offset', {'q': 'source', 'offset': 1} + yield 'category', {'category': 'probe'} + yield 'category-and-word', {'q': 'source', 'category': 'probestars'} + yield 'category-unknown', {'category': 'nosuchcategory'} + + +def strip(payload): + try: + body = json.loads(payload) + except ValueError: + return payload + for item in body.get('results', []): + item.pop('excerpt', None) + return body + + +def fetch(port, params): + body = json.dumps({'module': 'search', 'method': 'search', 'params': params}).encode('utf-8') + conn = http.client.HTTPConnection('127.0.0.1', port, timeout=30) + conn.putrequest('POST', PATH, skip_host=True, skip_accept_encoding=True) + conn.putheader('Host', HOST) + conn.putheader('Content-Type', 'application/json') + conn.putheader('Content-Length', str(len(body))) + conn.endheaders() + conn.send(body) + resp = conn.getresponse() + payload = resp.read() + conn.close() + return resp.status, strip(payload) + + +def main(): + same = only = unexplained = 0 + + for name, params in cases(): + a = fetch(PWIKIT_PORT, params) + if name in PWIKIT_ONLY: + only += 1 + print('pwikit %-18s total=%s' % (name, a[1].get('total') if isinstance(a[1], dict) else '?')) + continue + b = fetch(DJANGO_PORT, params) + if a == b: + same += 1 + print('same %s' % name) + continue + unexplained += 1 + print('DIFF %s' % name) + print(' pwikit %s' % json.dumps(a[1], ensure_ascii=False)[:400]) + print(' django %s' % json.dumps(b[1], ensure_ascii=False)[:400]) + + print('\n%d same, %d pwikit-only, %d unexplained' % (same, only, unexplained)) + return 1 if unexplained else 0 + + +if __name__ == '__main__': + sys.exit(main()) From f8249009dbda5998fc92a1f4808098c2f0dbb7d9 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 21:13:48 +0900 Subject: [PATCH 182/428] let a search be narrowed to one category --- web/js/api/search-module.ts | 1 + web/js/entrypoints/search.tsx | 8 ++++++-- web/js/locales/zh-hans.json | 1 + 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/web/js/api/search-module.ts b/web/js/api/search-module.ts index 62bb6ef7..0e1bae5f 100644 --- a/web/js/api/search-module.ts +++ b/web/js/api/search-module.ts @@ -4,6 +4,7 @@ export interface SearchModuleParams { q?: string author?: string tags?: string + category?: string datefrom?: string dateto?: string offset?: number diff --git a/web/js/entrypoints/search.tsx b/web/js/entrypoints/search.tsx index dfbb9997..8b03db2e 100644 --- a/web/js/entrypoints/search.tsx +++ b/web/js/entrypoints/search.tsx @@ -49,6 +49,7 @@ function preciseTime(s: string | null): string { const SearchModule: React.FC = ({ placeholder, tags: defaultTags, + category: defaultCategory, q: initialQ, author: initialAuthor, datefrom: initialDateFrom, @@ -57,6 +58,7 @@ const SearchModule: React.FC = ({ const [q, setQ] = useState(initialQ || '') const [author, setAuthor] = useState(initialAuthor || '') const [tags, setTags] = useState(defaultTags || '') + const [category, setCategory] = useState(defaultCategory || '') const [dateFrom, setDateFrom] = useState(initialDateFrom || '') const [dateTo, setDateTo] = useState(initialDateTo || '') @@ -80,6 +82,7 @@ const SearchModule: React.FC = ({ q: q.trim(), author: author.trim(), tags: tags.trim(), + category: category.trim(), datefrom: dateFrom, dateto: dateTo, offset, @@ -101,7 +104,7 @@ const SearchModule: React.FC = ({ }) useEffect(() => { - const hasCriteria = !!(q.trim() || author.trim() || tags.trim() || dateFrom || dateTo) + const hasCriteria = !!(q.trim() || author.trim() || tags.trim() || category.trim() || dateFrom || dateTo) if (!hasCriteria) { seq.current++ setResults([]) @@ -113,7 +116,7 @@ const SearchModule: React.FC = ({ } const t = setTimeout(() => runSearch(0, false), 300) return () => clearTimeout(t) - }, [q, author, tags, dateFrom, dateTo]) + }, [q, author, tags, category, dateFrom, dateTo]) const onLoadMore = useConstCallback(() => runSearch(results.length, true)) @@ -132,6 +135,7 @@ const SearchModule: React.FC = ({
setAuthor(e.target.value)} /> setTags(e.target.value)} /> + setCategory(e.target.value)} />
setDateFrom(e.target.value)} /> – diff --git a/web/js/locales/zh-hans.json b/web/js/locales/zh-hans.json index 92dcc066..f29930d1 100644 --- a/web/js/locales/zh-hans.json +++ b/web/js/locales/zh-hans.json @@ -411,6 +411,7 @@ "search.page.title": "站内搜索", "search.page.updated-label": "最后修改:", "search.placeholder": "搜索…", + "search.category-placeholder": "分类", "search.tags-placeholder": "标签（空格分隔，- 排除）", "search.total": "共 {total} 条结果", "search.updated": "更新 {when}", From c33c4055edb1fbfba943909ee39d021b6dff8be2 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 21:31:31 +0900 Subject: [PATCH 183/428] cut the search excerpt down to the words around the match --- internal/modules/searchapi.go | 2 +- web/js/api/search.ts | 32 --- web/js/reactive/pages/search/Search.styles.ts | 193 ----------------- web/js/reactive/pages/search/Search.tsx | 195 ------------------ web/js/reactive/pages/search/index.ts | 1 - .../highlight-words.tsx} | 0 web/management/commands/search.py | 24 --- web/views/api/search.py | 111 ---------- 8 files changed, 1 insertion(+), 557 deletions(-) delete mode 100644 web/js/api/search.ts delete mode 100644 web/js/reactive/pages/search/Search.styles.ts delete mode 100644 web/js/reactive/pages/search/Search.tsx delete mode 100644 web/js/reactive/pages/search/index.ts rename web/js/{reactive/pages/search/Search.utils.tsx => util/highlight-words.tsx} (100%) delete mode 100644 web/management/commands/search.py delete mode 100644 web/views/api/search.py diff --git a/internal/modules/searchapi.go b/internal/modules/searchapi.go index 0d7f863c..61e9a013 100644 --- a/internal/modules/searchapi.go +++ b/internal/modules/searchapi.go @@ -23,7 +23,7 @@ const ( // What a result shows is the text around the word that was searched for, // not the head of the page. - searchExcerptPad = 60 + searchExcerptPad = 20 searchExcerptLen = 160 searchDateLayout = "2006-01-02" ) diff --git a/web/js/api/search.ts b/web/js/api/search.ts deleted file mode 100644 index b11462a4..00000000 --- a/web/js/api/search.ts +++ /dev/null @@ -1,32 +0,0 @@ -import { FullArticleData } from '~api/articles' -import { wFetch } from '~util/fetch-util' - -interface SearchParams { - mode?: 'source' | 'plain' - limit?: number - cursor?: string -} - -interface SearchArticleData extends FullArticleData { - words: Array - excerpts: Array -} - -export interface SearchResults { - results: Array - cursor: string -} - -export function fetchSearch(text: string, opts?: SearchParams): Promise { - const params = new URLSearchParams() - - params.set('text', text) - params.set('limit', `${opts?.limit ?? 25}`) - params.set('mode', opts?.mode ?? 'plain') - - if (opts?.cursor) { - params.set('cursor', opts.cursor) - } - - return wFetch(`/pw-api/search?${params.toString()}`) -} diff --git a/web/js/reactive/pages/search/Search.styles.ts b/web/js/reactive/pages/search/Search.styles.ts deleted file mode 100644 index 39bd4997..00000000 --- a/web/js/reactive/pages/search/Search.styles.ts +++ /dev/null @@ -1,193 +0,0 @@ -import styled, { css } from 'styled-components' -import BaseLoader from '~util/loader' - -export const Container = styled.div` - width: 100%; - overflow: auto; -` - -export const SearchFieldContainer = styled.div` - padding: 8px 0; - position: sticky; - top: 0; - background: ${({ theme }) => theme.pagePadding}; - - &:after { - content: ''; - position: absolute; - left: 0; - bottom: -16px; - right: 0; - height: 16px; - background: linear-gradient(to bottom, ${({ theme }) => theme.pagePadding}, transparent); - } -` - -export const SearchFieldWrapper = styled.form<{ isDisabled?: boolean }>` - padding: 8px; - border: 1px solid ${({ theme }) => theme.uiBorder}; - display: flex; - align-items: center; - justify-content: center; - gap: 8px; - opacity: 0.8; - background: ${({ theme }) => theme.uiBackground}; - &:has(:hover), - &:has(:focus) { - opacity: 1; - } - - ${({ isDisabled }) => - isDisabled && - css` - opacity: 0.6; - filter: saturate(0%); - - input[type='submit'] { - cursor: not-allowed; - } - `}; -` - -export const SearchField = styled.input.attrs({ - type: 'text', -})` - flex-grow: 1; - border: none; - height: 32px; - outline: none; - font-size: 14px; -` - -export const SearchSubmit = styled.input.attrs({ - type: 'submit', -})` - background: ${({ theme }) => theme.uiSelection}; - color: ${({ theme }) => theme.uiSelectionForeground}; - padding: 12px 32px; - border-radius: 4px; - border: none; - cursor: pointer; - width: 128px; - text-align: center; - - &:hover { - background: ${({ theme }) => theme.uiSelectionHighlight}; - color: ${({ theme }) => theme.uiSelectionForeground}; - } -` - -export const LoaderContainer = styled.div` - position: relative; -` - -export const Loader = styled(BaseLoader)` - position: absolute; - left: 0; - right: 0; - top: 0; - pointer-events: none; -` - -export const SearchResultsWrapper = styled.div` - display: flex; - flex-direction: column; - gap: 8px; - margin-top: 16px; - padding-bottom: 8px; -` - -export const SearchResult = styled.div` - min-width: 0; - border: ${({ theme }) => theme.uiBorder}; - background: ${({ theme }) => theme.windowBackground}; - padding: 8px; - - .highlight { - color: red !important; - font-weight: 600; - } -` - -export const SearchResultTitle = styled.div` - font-size: 16px; - line-height: 18px; - a { - color: ${({ theme }) => theme.primary}; - border-bottom: 1px dotted ${({ theme }) => theme.primary}; - } -` - -export const SearchResultSlug = styled.span` - margin-top: 8px; - background: ${({ theme }) => theme.windowStrong}7f; - padding: 4px; - border-radius: 8px; - font-family: monospace; - display: inline-block; -` - -export const SearchResultExcerpts = styled.div` - margin-top: 16px; - font-size: 11px; - line-height: 14px; -` - -export const SearchResultExcerpt = styled.span`` - -export const SearchResultMeta = styled.dl` - display: flex; - flex-wrap: wrap; - min-width: 0; - gap: 8px; -` - -export const SearchResultMetaItem = styled.div`` - -export const SearchResultMetaKey = styled.span` - font-weight: 600; - padding-right: 4px; -` - -export const SearchResultMetaValue = styled.span`` - -export const Button = styled.button<{ isDisabled?: boolean }>` - background: ${({ theme }) => theme.uiSelection}; - color: ${({ theme }) => theme.uiSelectionForeground}; - padding: 12px 32px; - border-radius: 4px; - border: none; - cursor: pointer; - width: 100%; - text-align: center; - margin: 0; - height: 48px; - position: relative; - - &:hover { - background: ${({ theme }) => theme.uiSelectionHighlight}; - color: ${({ theme }) => theme.uiSelectionForeground}; - } - - ${({ isDisabled }) => - isDisabled && - css` - opacity: 0.6; - filter: saturate(0%); - cursor: not-allowed; - `}; -` - -export const CheckboxContainer = styled.div` - margin-top: 8px; - cursor: pointer; - user-select: none; - padding: 8px; - border-radius: 8px; - background: ${({ theme }) => theme.windowBackground}7f; - display: inline-block; - - label { - cursor: pointer; - } -` diff --git a/web/js/reactive/pages/search/Search.tsx b/web/js/reactive/pages/search/Search.tsx deleted file mode 100644 index 3c3d2449..00000000 --- a/web/js/reactive/pages/search/Search.tsx +++ /dev/null @@ -1,195 +0,0 @@ -import { t } from '~util/i18n' -import React, { useRef, useState } from 'react' -import { sprintf } from 'sprintf-js' -import { useTheme } from 'styled-components' -import { RatingMode } from '~api/rate' -import { fetchSearch, SearchResults } from '~api/search' -import Page from '~reactive/containers/page' -import { highlightWords } from '~reactive/pages/search/Search.utils' -import useConstCallback from '~util/const-callback' -import formatDate from '~util/date-format' -import UserView from '~util/user-view' -import WikidotModal from '~util/wikidot-modal' -import * as Styled from './Search.styles' - -export const Search: React.FC = () => { - const theme = useTheme() - const [searchText, setSearchText] = useState('') - const searchRef = useRef(null) - const containerRef = useRef(null) - const [isSearching, setIsSearching] = useState(false) - const [isSource, setIsSource] = useState(false) - - const [lastSearchText, setLastSearchText] = useState('') - const [lastSource, setLastSource] = useState(false) - const [searchResults, setSearchResults] = useState(undefined) - const [error, setError] = useState(undefined) - - const handleSearchChange = useConstCallback((event: React.ChangeEvent) => { - setSearchText(event.target.value) - }) - - const handleSourceChange = useConstCallback((event: React.ChangeEvent) => { - setIsSource(event.target.checked) - }) - - const handleSearchSubmit = useConstCallback(async (event: React.FormEvent) => { - event.stopPropagation() - event.preventDefault() - if (isSearching) { - return - } - if (!searchText.trim()) { - return - } - setIsSearching(true) - try { - const results = await fetchSearch(searchText, { - mode: isSource ? 'source' : 'plain', - }) - setLastSearchText(searchText) - setLastSource(isSource) - setSearchResults(results) - containerRef.current?.scrollTo(0, 0) - setError(undefined) - } catch (e: any) { - setError(e.error || t('common.server-unreachable')) - } finally { - setIsSearching(false) - } - }) - - const renderRating = useConstCallback((rating: number, mode: RatingMode) => { - if (mode === 'updown') { - return sprintf('%+d', rating) - } - if (mode === 'stars') { - return sprintf('%.1f', rating) - } - return '—' - }) - - const handleLoadMore = useConstCallback(async (event: React.MouseEvent) => { - event.stopPropagation() - event.preventDefault() - if (isSearching) { - return - } - if (!lastSearchText || !searchResults) { - return - } - setIsSearching(true) - try { - const results = await fetchSearch(lastSearchText, { - cursor: searchResults.cursor, - mode: lastSource ? 'source' : 'plain', - }) - setSearchResults({ - results: [...searchResults.results, ...results.results], - cursor: results.cursor, - }) - setError(undefined) - } catch (e: any) { - setError(e.error || t('common.server-unreachable')) - } finally { - setIsSearching(false) - } - }) - - const onCloseError = useConstCallback(() => { - setError(undefined) - }) - - return ( - - {error && ( - -

- {t('search.page.error-label')} {error} -

- - )} - - - - - - - {isSearching && } - - - - - - - - {searchResults?.results?.map((article, index) => { - return ( - - - - {highlightWords(article.title, article.words)} - - - {article.pageId} - - - {t('search.page.author-label')} - - {article.authors?.map(author => ( - - {' '} - - ))} - - - - {t('search.page.created-label')} - {formatDate(new Date(article.createdAt))} - - - {t('search.page.updated-label')} - {formatDate(new Date(article.updatedAt))} - - - {t('search.page.rating-label')} - - {renderRating(article.rating.value, article.rating.mode)} - {article.rating.votes > 0 && ( - <> - {' '} - {t('search.page.rating-detail', { votes: article.rating.votes, popularity: sprintf('%d%%', article.rating.popularity) })} - - )} - - - - {article.excerpts.length > 0 && ( - - {article.excerpts.map((x, i, a) => ( - - {' ...'} - {highlightWords(x, article.words)} - {'... '} - - ))} - - )} - - ) - })} - {searchResults && searchResults.results.length > 0 && searchResults.results.length % 25 === 0 && ( - - {isSearching ? : t('search.page.more')} - - )} - - - - ) -} - -export default Search diff --git a/web/js/reactive/pages/search/index.ts b/web/js/reactive/pages/search/index.ts deleted file mode 100644 index 78c5e486..00000000 --- a/web/js/reactive/pages/search/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { default } from './Search' diff --git a/web/js/reactive/pages/search/Search.utils.tsx b/web/js/util/highlight-words.tsx similarity index 100% rename from web/js/reactive/pages/search/Search.utils.tsx rename to web/js/util/highlight-words.tsx diff --git a/web/management/commands/search.py b/web/management/commands/search.py deleted file mode 100644 index c17c89a2..00000000 --- a/web/management/commands/search.py +++ /dev/null @@ -1,24 +0,0 @@ -from django.core.management.base import BaseCommand -from web.controllers.search import search_articles - - -class Command(BaseCommand): - help = 'Searches for article' - - def add_arguments(self, parser): - parser.add_argument('-t', '--text', required=True, help='Text to search') - parser.add_argument('-s', '--source', required=False, action='store_true', help='Search source code') - parser.add_argument('-c', '--cursor', required=False, help='Cursor for pagination') - parser.add_argument('-l', '--limit', required=False, type=int, default=25, help='Max results') - - def handle(self, *args, **options): - cursor = options.get('cursor') - limit = options.get('limit') - result = search_articles( - options['text'], - is_source=options.get('source'), - cursor=cursor, - limit=limit, - explain=True - ) - print(repr(result)) diff --git a/web/views/api/search.py b/web/views/api/search.py deleted file mode 100644 index 6975b310..00000000 --- a/web/views/api/search.py +++ /dev/null @@ -1,111 +0,0 @@ -from django.http import HttpRequest - -from renderer.utils import render_user_to_json -from . import APIView - -from web.controllers import search, articles - - -class SearchView(APIView): - def get(self, request: HttpRequest): - search_query = request.GET.get('text', '') - cursor = request.GET.get('cursor') - search_mode = request.GET.get('mode', 'plain') - try: - limit = int(request.GET.get('limit', '25')) - if limit < 1: - limit = 1 - if limit > 25: - limit = 25 - except ValueError: - limit = 25 - results, next_cursor = search.search_articles(search_query, is_source=(search_mode == 'source'), cursor=cursor, limit=limit) - output_results = [] - for result in results: - article = result['article'].article - rating, votes, popularity, mode = articles.get_rating(article) - authors = [render_user_to_json(author) for author in article.authors.all()] - output_results.append({ - 'uid': article.id, - 'pageId': article.full_name, - 'title': article.title, - 'createdAt': article.created_at.isoformat(), - 'updatedAt': article.updated_at.isoformat(), - 'createdBy': authors[0], - 'authors': authors, - 'rating': { - 'value': rating, - 'votes': votes, - 'popularity': popularity, - 'mode': str(mode) - }, - 'tags': articles.get_tags(article), - 'words': result['words'], - 'excerpts': self.get_excerpts(result, search_mode == 'source') - }) - return self.render_json(200, { - 'results': output_results, - 'cursor': next_cursor - }) - - @classmethod - def get_excerpts(cls, result, is_source): - original = result['article'].content_source if is_source else result['article'].content_plaintext - original = original.split('\n\n', 1) - if len(original) < 2: - return [] - original = original[1] - original_to_search = original.lower() - words_to_search = list(sorted({x.lower() for x in result['words']}, key=lambda x: len(x), reverse=True)) - ranges = [] - offset = 30 - word_length_cutoff = 2 - has_long_words = bool([x for x in words_to_search if len(x) > word_length_cutoff]) - for word in words_to_search: - # at least for now. - if has_long_words and len(word) <= word_length_cutoff: - continue - word_positions = cls.findall(word, original_to_search) - for position in word_positions: - word_start = position - word_end = len(word) + word_start - word_start = max(0, word_start - offset) - word_end = min(len(original_to_search), word_end + offset) - ranges.append((len(word), word_start, word_end)) - ranges.sort(key=lambda x: x[1]) - i = 0 - while i < len(ranges) - 1: - if ranges[i+1][1] < ranges[i][2]: - # overlap: - # expand this one - # delete next one - ranges[i] = (max(ranges[i][0], ranges[i+1][0]), ranges[i][1], ranges[i+1][2]) - del ranges[i+1] - continue - i += 1 - # sort by max word length in a snippet (including combined snippets). longer words = first. - # this is so that words like 'in', 'with', etc don't fill up the entire available space, if there are OTHER words. - ranges.sort(key=lambda x: (-x[0], x[1]), reverse=False) - ranges = ranges[:25] - excerpts = [] - for _, excerpt_start, excerpt_end in ranges: - excerpts.append(original[excerpt_start:excerpt_end]) - # limit also total excerpt size returned to client - max_excerpt_len = 1024 - combined_len = 0 - for i in range(len(excerpts)): - combined_len += len(excerpts[i]) - if combined_len > max_excerpt_len: - return excerpts[:i] - return excerpts - - @classmethod - def findall(cls, p, s): - # returns all positions of the specified word "p" in the string "s". - # to-do: detect if words are part of other words, and don't treat them as separate. - i = s.find(p) - positions = [] - while i != -1: - positions.append(i) - i = s.find(p, i + 1) - return positions \ No newline at end of file From 60f4020cbbdbc6e767ea4dd4fb0be7752b81c3ce Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 21:31:32 +0900 Subject: [PATCH 184/428] drop the search page --- web/controllers/search.py | 154 +--------------------------------- web/js/entrypoints/search.tsx | 2 +- web/js/locales/zh-hans.json | 12 --- web/js/reactive/paths.ts | 1 - web/js/reactive/router.tsx | 2 - web/urls.py | 5 +- 6 files changed, 3 insertions(+), 173 deletions(-) diff --git a/web/controllers/search.py b/web/controllers/search.py index b973d6c5..449c5aab 100644 --- a/web/controllers/search.py +++ b/web/controllers/search.py @@ -1,14 +1,9 @@ -import json -import base64 import re from datetime import datetime, timezone -from typing import Literal -from uuid import uuid4 -from django.db import models from django.db.models import Q, Count -from django.contrib.postgres.search import SearchQuery, SearchRank, SearchVector, SearchHeadline +from django.contrib.postgres.search import SearchVector from renderer import RenderContext, single_pass_render_text @@ -19,123 +14,6 @@ from web.models.users import User, canonicalize_username -def search_articles(text, user: User=None, is_source=False, cursor=None, limit=25, explain=False): - hidden_categories = articles.get_hidden_categories_for(user) - if is_source: - cursor_parameters = decode_cursor(cursor, 'source', ['id__lt', 'id']) - - results = ArticleSearchIndex.objects.filter( - content_source__icontains=text, - ).exclude( - article__category__in=hidden_categories - ).order_by('-id') - if cursor_parameters: - results = results.filter(cursor_parameters) - results = results[:limit] - if explain: - print(results.explain(analyze=True)) - - output = [] - - results = list(results) - for article in results: - output.append({ - 'article': article, - 'words': [text] - }) - - if results: - next_cursor = encode_cursor('source', [ - dict(id__lt=results[-1].id) - ]) - else: - next_cursor = encode_cursor('source', [ - dict(id=-1) - ]) - - return output, next_cursor - else: - cursor_parameters = decode_cursor(cursor, 'plain', ['rank_str__lt', 'rank_str', 'id__lt', 'id']) - search_query_en = SearchQuery(text, config='english', search_type="websearch") - search_query_ru = SearchQuery(text, config='russian', search_type="websearch") - search_query = search_query_en | search_query_ru - mark_name = str(uuid4()) - mark_open = f'<{mark_name}>' - mark_close = f'' - results = ArticleSearchIndex.objects.annotate( - rank=SearchRank( - models.F('vector_plaintext'), - search_query, - cover_density=True, - normalization=32 - ), - rank_str=models.Func( - 'rank', - template="TO_CHAR(%(expressions)s, '000.999999')", - output_field=models.CharField() - ), - headline_en=SearchHeadline( - models.F('content_plaintext'), - search_query, - config='english', - start_sel=mark_open, - stop_sel=mark_close, - max_words=35, - min_words=20, - max_fragments=3, - fragment_delimiter=' ... ' - ), - headline_ru=SearchHeadline( - models.F('content_plaintext'), - search_query, - config='russian', - start_sel=mark_open, - stop_sel=mark_close, - max_words=35, - min_words=20, - max_fragments=3, - fragment_delimiter=' ... ' - ) - ).filter( - models.Q(vector_plaintext=search_query) - ).exclude( - article__category__in=hidden_categories - ).order_by('-rank_str', '-id') - if cursor_parameters: - results = results.filter(cursor_parameters) - results = results[:limit] - - if explain: - print(results.explain(analyze=True)) - - output = [] - - results = list(results) - for article in results: - highlighted_snippet = article.headline_en + article.headline_ru - - import re - matched = re.findall(r'<%s>(.*?)' % (mark_name, mark_name), highlighted_snippet) - article.matched_words = list(set(matched)) # Dedupe - - output.append({ - 'article': article, - 'words': article.matched_words - }) - - if results: - next_cursor = encode_cursor('plain', [ - dict(rank_str__lt=results[-1].rank_str), - dict(rank_str=results[-1].rank_str, id__lt=results[-1].id) - ]) - else: - next_cursor = encode_cursor('plain', [ - dict(id=-1) - ]) - - return output, next_cursor - - def _parse_date(value, end_of_day=False): if not value: return None @@ -265,36 +143,6 @@ def search_articles_filtered(text, *, author=None, tags=None, date_from=None, da return items, has_more, total -def decode_cursor(cursor: str | None, expected_type: Literal['source', 'plain'], whitelist=None) -> models.Q | None: - if cursor is None: - return None - try: - data = base64.b64decode(cursor).decode('utf-8') - data = json.loads(data) - if (expected_type == 'source' and data.get('t') == 'source') or \ - (expected_type == 'plain' and data.get('t') == 'plain'): - options = None - for option in data.get('o'): - for k in option: - if whitelist is None or k not in whitelist: - del option[k] - if options is None: - options = models.Q(**option) - else: - options |= models.Q(**option) - return options - return None - except: - return None - - -def encode_cursor(cursor_type: Literal['source', 'plain'], parameters: list[dict[str, any]]) -> str: - data = {'t': cursor_type, 'o': parameters} - data = json.dumps(data) - data = base64.b64encode(data.encode('utf-8')).decode('ascii') - return data - - def update_search_index(article: Article): version = articles.get_latest_version(article) diff --git a/web/js/entrypoints/search.tsx b/web/js/entrypoints/search.tsx index 8b03db2e..b167566d 100644 --- a/web/js/entrypoints/search.tsx +++ b/web/js/entrypoints/search.tsx @@ -2,7 +2,7 @@ import { t } from '~util/i18n' import * as React from 'react' import { useEffect, useRef, useState } from 'react' import { searchModule, SearchResultItem } from '../api/search-module' -import { highlightWords } from '../reactive/pages/search/Search.utils' +import { highlightWords } from '~util/highlight-words' import useConstCallback from '../util/const-callback' interface Props { diff --git a/web/js/locales/zh-hans.json b/web/js/locales/zh-hans.json index f29930d1..0b5351fd 100644 --- a/web/js/locales/zh-hans.json +++ b/web/js/locales/zh-hans.json @@ -398,18 +398,6 @@ "search.loading-more": "加载中…", "search.minutes-ago": "{count}分钟前", "search.months-ago": "{count}个月前", - "search.page.author-label": "作者:", - "search.page.created-label": "创建时间:", - "search.page.error-dismiss": "关闭", - "search.page.error-label": "错误:", - "search.page.include-source": "搜索源代码", - "search.page.more": "更多结果", - "search.page.query-placeholder": "您的查询", - "search.page.rating-detail": "来自 {votes} 人 (人气: {popularity})", - "search.page.rating-label": "评分:", - "search.page.submit": "搜索", - "search.page.title": "站内搜索", - "search.page.updated-label": "最后修改:", "search.placeholder": "搜索…", "search.category-placeholder": "分类", "search.tags-placeholder": "标签（空格分隔，- 排除）", diff --git a/web/js/reactive/paths.ts b/web/js/reactive/paths.ts index a127c773..fe94b217 100644 --- a/web/js/reactive/paths.ts +++ b/web/js/reactive/paths.ts @@ -3,6 +3,5 @@ export const Paths = { notificationsAll: '/notifications/all', notificationsUnread: '/notifications/unread', profile: '/profile', - search: '/search', messages: '/messages', } diff --git a/web/js/reactive/router.tsx b/web/js/reactive/router.tsx index 152f36be..3aa5b93b 100644 --- a/web/js/reactive/router.tsx +++ b/web/js/reactive/router.tsx @@ -7,7 +7,6 @@ import { IConfigContext } from '~reactive/config/ConfigContext.types' import Messages from '~reactive/pages/messages' import Notifications from '~reactive/pages/notifications' import Profile from '~reactive/pages/profile' -import Search from '~reactive/pages/search' import { Paths } from '~reactive/paths' import { SYSTEM_THEME } from '~reactive/theme/Theme.consts' @@ -30,7 +29,6 @@ export default function ReactivePage() { } /> } /> } /> - } /> diff --git a/web/urls.py b/web/urls.py index 9653376a..fc58e44c 100644 --- a/web/urls.py +++ b/web/urls.py @@ -25,7 +25,7 @@ from .views import profile, signup, login, tickets, updates as updates_views from .views.theme import SiteThemeFileView -from web.views.api import articles, preview, module, files, notifications, users, search, messages as api_messages, reports as api_reports +from web.views.api import articles, preview, module, files, notifications, users, messages as api_messages, reports as api_reports from web.views.article import ArticleView from web.views.reactive import reactive_view @@ -74,8 +74,6 @@ def make_reactive(routes: list[str]): path('messages/report', api_reports.SubmitReportView.as_view()), path('users//block', api_messages.BlockUserView.as_view()), path('admin/reports//full-conversation', api_reports.AdminReportFullConversationView.as_view()), - - path('search', search.SearchView.as_view()) ] @@ -84,7 +82,6 @@ def make_reactive(routes: list[str]): 'profile', 'notifications/all', 'notifications/unread', - 'search', 'messages', 'messages/', ] From 8947381130795a854530dcd48f4d821c2f8fded4 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 22:10:17 +0900 Subject: [PATCH 185/428] add the queries a vote writes --- internal/db/vote.go | 171 ++++++++++++++++++++++++++++++++++++++++ internal/perms/perms.go | 2 + 2 files changed, 173 insertions(+) create mode 100644 internal/db/vote.go diff --git a/internal/db/vote.go b/internal/db/vote.go new file mode 100644 index 00000000..9752e58e --- /dev/null +++ b/internal/db/vote.go @@ -0,0 +1,171 @@ +package db + +import ( + "context" + "errors" + "fmt" + "net/netip" + "time" + + "github.com/jackc/pgx/v5" +) + +type Vote struct { + ID int64 + Rate float64 + Date *time.Time + RoleID *int64 +} + +type ArticleVote struct { + User User + Rate float64 + Date *time.Time + GroupTitle string + GroupIndex *int +} + +var qArticleVotes = register("ArticleVotes", ` +SELECT `+prefixed("u", userColumns)+`, v.rate, v.date, + COALESCE(NULLIF(r.votes_title, ''), NULLIF(r.name, ''), r.slug), r.index +FROM web_vote v +JOIN web_user u ON u.id = v.user_id +LEFT JOIN web_role r ON r.id = v.role_id +WHERE v.article_id = $1 +ORDER BY v.date DESC, u.username DESC`) + +func (d *DB) ArticleVotes(ctx context.Context, articleID int64) ([]ArticleVote, error) { + rows, err := d.pool.Query(ctx, qArticleVotes, articleID) + if err != nil { + return nil, fmt.Errorf("query votes of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []ArticleVote + for rows.Next() { + var v ArticleVote + var title *string + dest, finish := userDest(&v.User) + dest = append(dest, &v.Rate, &v.Date, &title, &v.GroupIndex) + if err := rows.Scan(dest...); err != nil { + return nil, fmt.Errorf("scan vote: %w", err) + } + finish() + if title != nil { + v.GroupTitle = *title + } + out = append(out, v) + } + return out, rows.Err() +} + +var ( + qVoteOfUser = register("VoteOfUser", ` +SELECT id, rate, date, role_id +FROM web_vote +WHERE article_id = $1 AND user_id = $2`) + + qDeleteVotesOfUser = register("DeleteVotesOfUser", ` +DELETE FROM web_vote WHERE article_id = $1 AND user_id = $2`) + + qInsertVote = register("InsertVote", ` +INSERT INTO web_vote (article_id, user_id, rate, date, role_id) +VALUES ($1, $2, $3, $4, $5)`) +) + +// ReplaceVote drops whatever the user had voted and writes the new value, or +// only drops it when rate is nil. The vote that was there comes back, since the +// action log records what changed. +func (d *DB) ReplaceVote(ctx context.Context, articleID, userID int64, rate *float64, roleID *int64, at time.Time) (*Vote, error) { + tx, err := d.pool.Begin(ctx) + if err != nil { + return nil, fmt.Errorf("begin vote: %w", err) + } + defer tx.Rollback(ctx) + + var old *Vote + var found Vote + err = tx.QueryRow(ctx, qVoteOfUser, articleID, userID).Scan(&found.ID, &found.Rate, &found.Date, &found.RoleID) + switch { + case err == nil: + old = &found + case !errors.Is(err, pgx.ErrNoRows): + return nil, fmt.Errorf("read vote: %w", err) + } + + if _, err := tx.Exec(ctx, qDeleteVotesOfUser, articleID, userID); err != nil { + return nil, fmt.Errorf("delete vote: %w", err) + } + if rate != nil { + if _, err := tx.Exec(ctx, qInsertVote, articleID, userID, *rate, at, roleID); err != nil { + return nil, fmt.Errorf("insert vote: %w", err) + } + } + if err := tx.Commit(ctx); err != nil { + return nil, fmt.Errorf("commit vote: %w", err) + } + return old, nil +} + +var qDeleteArticleVotes = register("DeleteArticleVotes", ` +DELETE FROM web_vote WHERE article_id = $1`) + +func (d *DB) DeleteArticleVotes(ctx context.Context, articleID int64) error { + if _, err := d.pool.Exec(ctx, qDeleteArticleVotes, articleID); err != nil { + return fmt.Errorf("delete votes of article %d: %w", articleID, err) + } + return nil +} + +var qVoteGroupRole = register("VoteGroupRole", ` +SELECT r.id +FROM web_role r +LEFT JOIN web_user_roles link ON link.role_id = r.id AND link.user_id = $1 +WHERE r.group_votes AND (r.slug = ANY($2) OR link.user_id IS NOT NULL) +ORDER BY CASE r.slug WHEN 'registered' THEN 0 WHEN 'everyone' THEN 1 ELSE 2 END, r.index +LIMIT 1`) + +// VoteGroupRole answers which role a vote is filed under. The two built-in +// roles outrank the user's own, and for an anonymous reader only everyone can. +func (d *DB) VoteGroupRole(ctx context.Context, userID *int64) (*int64, error) { + slugs := []string{"everyone"} + var of int64 + if userID != nil { + slugs = append(slugs, "registered") + of = *userID + } + + var id int64 + err := d.pool.QueryRow(ctx, qVoteGroupRole, of, slugs).Scan(&id) + if errors.Is(err, pgx.ErrNoRows) { + return nil, nil + } + if err != nil { + return nil, fmt.Errorf("query vote role: %w", err) + } + return &id, nil +} + +// The action log's own vocabulary, which is not the article log's. +const ( + ActionVote = "vote" + ActionCreateArticle = "create_article" + ActionEditArticle = "edit_article" + ActionRemoveArticle = "remove_article" +) + +var qAddActionLog = register("AddActionLog", ` +INSERT INTO web_actionlogentry (user_id, stale_username, type, meta, created_at, origin_ip) +VALUES ($1, $2, $3, $4, $5, $6)`) + +func (d *DB) AddActionLog(ctx context.Context, userID *int64, username, kind, meta string, ip *netip.Addr, at time.Time) error { + var origin *string + if ip != nil { + text := ip.String() + origin = &text + } + if _, err := d.pool.Exec(ctx, qAddActionLog, userID, username, kind, meta, at, origin); err != nil { + return fmt.Errorf("write action log: %w", err) + } + return nil +} diff --git a/internal/perms/perms.go b/internal/perms/perms.go index cfeba089..9251a841 100644 --- a/internal/perms/perms.go +++ b/internal/perms/perms.go @@ -31,6 +31,8 @@ const ( ViewForumSections = "view_forum_sections" ViewHiddenForumSections = "view_hidden_forum_sections" ViewForumCategories = "view_forum_categories" + + ViewVotesTimestamp = "view_votes_timestamp" ) // lockable is what a locked page takes away from anyone who cannot unlock it. From 53259c2ad6c2627d574a7c508a4de7cc3236d0e6 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 22:10:17 +0900 Subject: [PATCH 186/428] check the token before a module writes --- internal/module/api.go | 31 +++++++++++++++++++--------- internal/webapi/webapi.go | 37 +++++++++++++++++++++++++++++----- internal/webapi/webapi_test.go | 13 +++++++++--- 3 files changed, 64 insertions(+), 17 deletions(-) diff --git a/internal/module/api.go b/internal/module/api.go index 7310ed08..b4057e29 100644 --- a/internal/module/api.go +++ b/internal/module/api.go @@ -8,24 +8,37 @@ import ( type API func(env Env, params map[string]string) (wikijson.Object, error) -// Only the methods that change nothing are registered here. The ones that write -// are checked for a CSRF token first, and nothing does that yet. var apis = map[string]API{} +var writes = map[string]bool{} + func RegisterAPI(module, method string, fn API) { + register(module, method, fn, false) +} + +// A method registered here changes something, so the caller has to have checked +// the CSRF token before it runs. +func RegisterWriteAPI(module, method string, fn API) { + register(module, method, fn, true) +} + +func register(module, method string, fn API, writes_ bool) { if _, ok := registry[module]; !ok { panic("module: " + module + " is not in the registry") } - apis[apiKey(module, method)] = fn + key := apiKey(module, method) + apis[key] = fn + writes[key] = writes_ } -func LookupAPI(module, method string) (API, bool) { - info, ok := Lookup(module) - if !ok || info.Removed { - return nil, false +func LookupAPI(module, method string) (fn API, safe, ok bool) { + info, found := Lookup(module) + if !found || info.Removed { + return nil, false, false } - fn, ok := apis[apiKey(info.Name, method)] - return fn, ok + key := apiKey(info.Name, method) + fn, ok = apis[key] + return fn, !writes[key], ok } func apiKey(module, method string) string { diff --git a/internal/webapi/webapi.go b/internal/webapi/webapi.go index 22d6a5eb..237dc4fa 100644 --- a/internal/webapi/webapi.go +++ b/internal/webapi/webapi.go @@ -19,6 +19,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/module" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/pagerender" + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/roles" "github.com/WikitTeam/ProjectWikit/internal/site" @@ -39,6 +40,7 @@ const maxParsed = 1 << 20 type Deps struct { DB *db.DB + Trust *proxyheader.Trust Engine renderer.Renderer Bundle *i18n.Bundle Icons roles.IconLoader @@ -91,6 +93,19 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { } loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) + if !h.safe(parsed) { + current := site.FromContext(r.Context()) + if current == nil { + h.deps.log().Error("module api", "err", errors.New("the request carries no site")) + writeJSON(w, http.StatusInternalServerError, field("error", loc.T("api-internal-error"))) + return + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + writeJSON(w, http.StatusForbidden, field("error", loc.T("api-csrf-failed"))) + return + } + } + out, status, err := h.answer(r, loc, parsed) if err != nil { var moduleErr *callbacks.ModuleError @@ -105,14 +120,21 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { writeJSON(w, status, out) } -// A method beyond render is answered only when the module registered it, and a -// module registers only what changes nothing. Everything else goes upstream, -// which is what keeps the CSRF check over there. +func (h *Handler) safe(parsed call) bool { + if parsed.Method == renderMethod { + return true + } + _, safe, _ := module.LookupAPI(parsed.Module, parsed.Method) + return safe +} + +// A method the module never registered goes upstream, which is what keeps the +// unported half working. func (h *Handler) answers(parsed call) bool { if parsed.Method == renderMethod { return true } - _, ok := module.LookupAPI(parsed.Module, parsed.Method) + _, _, ok := module.LookupAPI(parsed.Module, parsed.Method) return ok } @@ -136,8 +158,9 @@ func (h *Handler) answer(r *http.Request, loc *i18n.Localizer, parsed call) (str article = found } - env := pagerender.Deps{DB: h.deps.DB, Engine: h.deps.Engine, Icons: h.deps.Icons}. + env := pagerender.Deps{DB: h.deps.DB, Engine: h.deps.Engine, Icons: h.deps.Icons, Trust: h.deps.Trust}. Env(ctx, loc, current, user) + env.SetClient(r) pc := page.NewContext(article, article, page.ParsePathParams(string(parsed.PathParams)), user) // Only a token the visitor already carries, since this response has no page // to plant the cookie a fresh one would need. @@ -210,8 +233,12 @@ func params(raw json.RawMessage) map[string]string { return out } +// A null is kept as a key with nothing in it, since a module reads some of them +// as an instruction rather than as a missing value. func scalar(value any) (string, bool) { switch v := value.(type) { + case nil: + return "", true case string: return v, true case json.Number: diff --git a/internal/webapi/webapi_test.go b/internal/webapi/webapi_test.go index e546bbe5..45d05e99 100644 --- a/internal/webapi/webapi_test.go +++ b/internal/webapi/webapi_test.go @@ -24,12 +24,19 @@ func TestParamsFlattensScalars(t *testing.T) { } func TestParamsDropsWhatIsNotAScalar(t *testing.T) { - got := params(json.RawMessage(`{"a": null, "b": [1], "c": {"d": 1}, "e": "kept"}`)) + got := params(json.RawMessage(`{"b": [1], "c": {"d": 1}, "e": "kept"}`)) if len(got) != 1 || got["e"] != "kept" { t.Errorf("params() = %v, want map[e:kept]", got) } } +func TestParamsKeepsANullAsAnEmptyValue(t *testing.T) { + got := params(json.RawMessage(`{"value": null}`)) + if value, ok := got["value"]; !ok || value != "" { + t.Errorf("params(null)[value] = %q, %v, want \"\", true", value, ok) + } +} + func TestParamsOfWhatIsNotAnObject(t *testing.T) { for _, raw := range []string{"", "[]", "7", "not json"} { if got := params(json.RawMessage(raw)); got != nil { @@ -98,9 +105,9 @@ func post(body string) *http.Request { return r } -func TestWriteMethodsGoUpstreamWithTheirBody(t *testing.T) { +func TestUnportedMethodsGoUpstreamWithTheirBody(t *testing.T) { up := &recorder{} - body := `{"module": "rate", "method": "rate", "params": {"value": 1}}` + body := `{"module": "forumnewthread", "method": "submit", "params": {"name": "x"}}` New(Deps{}, up).ServeHTTP(httptest.NewRecorder(), post(body)) From 0ffbc770abe6c6fa8725f5fdfd42c6b901cf7680 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 22:10:17 +0900 Subject: [PATCH 187/428] answer the rating calls the page makes --- cmd/pwikit/articles.go | 5 +- cmd/pwikit/main.go | 2 +- internal/i18n/locales/zh-hans.json | 4 + internal/module/module.go | 8 + internal/modules/rateapi.go | 234 +++++++++++++++++++++++++++++ internal/pagerender/pagerender.go | 17 +++ internal/repo/modules.go | 45 ++++++ internal/repo/repo.go | 14 +- 8 files changed, 324 insertions(+), 5 deletions(-) create mode 100644 internal/modules/rateapi.go diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go index e97ea48d..afc2d03f 100644 --- a/cmd/pwikit/articles.go +++ b/cmd/pwikit/articles.go @@ -12,6 +12,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/i18n" "github.com/WikitTeam/ProjectWikit/internal/localitem" "github.com/WikitTeam/ProjectWikit/internal/paths" + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" "github.com/WikitTeam/ProjectWikit/internal/roles" "github.com/WikitTeam/ProjectWikit/internal/session" "github.com/WikitTeam/ProjectWikit/internal/static" @@ -30,7 +31,7 @@ type pageStack struct { close func() } -func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handler, sidecar, secret, timezone string, log *slog.Logger) (*pageStack, error) { +func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handler, trust *proxyheader.Trust, sidecar, secret, timezone string, log *slog.Logger) (*pageStack, error) { engine, closeEngine, err := newRenderer(sidecar) if err != nil { return nil, err @@ -58,7 +59,7 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl Log: log, }) items := localitem.Deps{DB: conn, Engine: engine, Bundle: bundle, Icons: icons, Log: log} - api := webapi.Deps{DB: conn, Engine: engine, Bundle: bundle, Icons: icons, Log: log} + api := webapi.Deps{DB: conn, Trust: trust, Engine: engine, Bundle: bundle, Icons: icons, Log: log} stack := &pageStack{ articles: pages, diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 0df248ea..0cf40b95 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -145,7 +145,7 @@ func serve(args []string) error { var articles, codeHandler, htmlHandler, themeHandler http.Handler = proxy, proxy, proxy, proxy var moduleAPI, preview, profile http.Handler = proxy, proxy, proxy if conn != nil { - stack, err := newPageStack(conn, p, assets, proxy, *sidecar, *secret, *timezone, log) + stack, err := newPageStack(conn, p, assets, proxy, trust, *sidecar, *secret, *timezone, log) if err != nil { return err } diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 6053d2a5..4f942e43 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -93,6 +93,10 @@ "module-recentposts-refresh": "刷新", "module-recentposts-select": "选择版块：", "module-recentposts-title": "论坛最新帖子", + "module-rate-bad-value": "无效的评分 {value}", + "module-rate-forbidden": "权限不足", + "module-rate-no-page": "未指定页面", + "module-rate-no-value": "未指定评分值", "module-search-placeholder": "搜索文章标题或内容…", "module-sitechanges-category": "选择分类：", "module-sitechanges-category-all": "所有分类", diff --git a/internal/module/module.go b/internal/module/module.go index b4b17af5..6cd40e67 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -12,6 +12,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) // Error is the failure that reaches the reader as a block on the page rather @@ -48,6 +49,13 @@ type Data interface { RenderUserByID(id *int64) (string, error) RenderUser(u db.User) (string, error) + ArticleVotes(articleID int64) ([]db.ArticleVote, error) + ReplaceVote(articleID, userID int64, rate *float64, roleID *int64) (*db.Vote, error) + VoteGroupRole(userID *int64) (*int64, error) + AddActionLog(user *db.User, kind, meta string) error + ArticleObject(article *db.Article, viewer *db.User) (*perms.Object, error) + UserJSON(u *db.User) (wikijson.Object, error) + SearchArticles(f db.SearchFilter, offset, limit int) ([]db.SearchHit, error) SearchCount(f db.SearchFilter) (int, error) TagIDsByFullName(category, name string) ([]int64, error) diff --git a/internal/modules/rateapi.go b/internal/modules/rateapi.go new file mode 100644 index 00000000..2114f237 --- /dev/null +++ b/internal/modules/rateapi.go @@ -0,0 +1,234 @@ +package modules + +import ( + "errors" + "math" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +func init() { + module.RegisterAPI("rate", "get_rating", rateGetRating) + module.RegisterAPI("rate", "get_votes", rateGetVotes) + module.RegisterWriteAPI("rate", "rate", rateVote) +} + +const migratedVoteDate = "migrated" + +func rateGetRating(env module.Env, _ map[string]string) (wikijson.Object, error) { + article, err := ratedArticle(env) + if err != nil { + return nil, err + } + rating, err := articleRating(env, article) + if err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "pageId", Value: article.FullName()}, + {Key: "rating", Value: rating.Value}, + {Key: "voteCount", Value: rating.Votes}, + {Key: "popularity", Value: rating.Popularity}, + {Key: "ratingMode", Value: rating.Mode}, + }, nil +} + +func rateGetVotes(env module.Env, _ map[string]string) (wikijson.Object, error) { + article, err := ratedArticle(env) + if err != nil { + return nil, err + } + rating, err := articleRating(env, article) + if err != nil { + return nil, err + } + votes, err := env.Data.ArticleVotes(article.ID) + if err != nil { + return nil, err + } + + subject, err := env.Data.Subject(env.User) + if err != nil { + return nil, err + } + withDate := perms.Resolve(subject, nil).Has(perms.ViewVotesTimestamp) + + out := make(wikijson.Array, 0, len(votes)) + for i := range votes { + vote := votes[i] + user, err := env.Data.UserJSON(&vote.User) + if err != nil { + return nil, err + } + fields := wikijson.Object{ + {Key: "user", Value: user}, + {Key: "value", Value: vote.Rate}, + } + if vote.GroupTitle != "" { + fields = append(fields, + wikijson.Field{Key: "visualGroup", Value: vote.GroupTitle}, + wikijson.Field{Key: "visualGroupIndex", Value: vote.GroupIndex}) + } + if withDate { + fields = append(fields, wikijson.Field{Key: "date", Value: voteDate(vote.Date)}) + } + out = append(out, fields) + } + return wikijson.Object{ + {Key: "pageId", Value: article.FullName()}, + {Key: "votes", Value: out}, + {Key: "rating", Value: rating.Value}, + {Key: "popularity", Value: rating.Popularity}, + {Key: "mode", Value: rating.Mode}, + }, nil +} + +func rateVote(env module.Env, params map[string]string) (wikijson.Object, error) { + article, err := ratedArticle(env) + if err != nil { + return nil, err + } + subject, err := env.Data.Subject(env.User) + if err != nil { + return nil, err + } + object, err := env.Data.ArticleObject(article, env.User) + if err != nil { + return nil, err + } + if !perms.Resolve(subject, object).Has(perms.RateArticles) { + return nil, &module.Error{Message: env.Text("module-rate-forbidden")} + } + + raw, given := params["value"] + if !given { + return nil, &module.Error{Message: env.Text("module-rate-no-value")} + } + mode, err := ratingMode(env, article) + if err != nil { + return nil, err + } + value, err := voteValue(env, raw, mode) + if err != nil { + return nil, err + } + + var userID int64 + if env.User != nil { + userID = env.User.ID + } + role, err := env.Data.VoteGroupRole(userIDOrNil(env.User)) + if err != nil { + return nil, err + } + old, err := env.Data.ReplaceVote(article.ID, userID, value, role) + if err != nil { + return nil, err + } + if err := logVote(env, article, old, value); err != nil { + return nil, err + } + return rateGetRating(env, params) +} + +// An empty value is the reader taking their vote back, which is what the null +// the browser sends arrives as. +func voteValue(env module.Env, raw, mode string) (*float64, error) { + if strings.TrimSpace(raw) == "" { + return nil, nil + } + value, err := strconv.ParseFloat(strings.TrimSpace(raw), 64) + if err != nil { + return nil, &module.Error{Message: env.Text("module-rate-bad-value", "value", raw)} + } + switch mode { + case page.RatingModeUpDown: + if value != -1 && value != 0 && value != 1 { + return nil, &module.Error{Message: env.Text("module-rate-bad-value", "value", raw)} + } + case page.RatingModeStars: + if value < 0 || value > 5 || math.Mod(value, 0.5) != 0 { + return nil, &module.Error{Message: env.Text("module-rate-bad-value", "value", raw)} + } + } + return &value, nil +} + +func logVote(env module.Env, article *db.Article, old *db.Vote, value *float64) error { + var was, now any + if old != nil { + was = old.Rate + } + if value != nil { + now = *value + } + meta, err := wikijson.Marshal(wikijson.Object{ + {Key: "article", Value: article.FullName()}, + {Key: "old_vote", Value: was}, + {Key: "new_vote", Value: now}, + {Key: "is_new", Value: value != nil && old == nil}, + {Key: "is_change", Value: value != nil && old != nil}, + {Key: "is_remove", Value: value == nil && old != nil}, + }) + if err != nil { + return err + } + return env.Data.AddActionLog(env.User, db.ActionVote, meta) +} + +func ratedArticle(env module.Env) (*db.Article, error) { + if env.Page == nil || env.Page.Article == nil { + return nil, &module.Error{Message: env.Text("module-rate-no-page")} + } + return env.Page.Article, nil +} + +func articleRating(env module.Env, article *db.Article) (page.Rating, error) { + mode, err := ratingMode(env, article) + if err != nil { + return page.Rating{}, err + } + if mode == page.RatingModeDisabled { + return page.RatingOf(mode, db.VoteStats{}), nil + } + stats, err := env.Data.VoteStats(article.ID) + if err != nil { + return page.Rating{}, err + } + return page.RatingOf(mode, stats), nil +} + +func ratingMode(env module.Env, article *db.Article) (string, error) { + site, err := env.Data.SiteRatingMode() + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", err + } + category, err := env.Data.CategoryRatingMode(article.Category) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", err + } + return page.RatingMode(site, category), nil +} + +// A vote with no timestamp came in with the imported site, and the word stands +// in for the date the frontend would otherwise print. +func voteDate(at *time.Time) string { + if at == nil { + return migratedVoteDate + } + return at.UTC().Format("2006-01-02T15:04:05.999999-07:00") +} + +func userIDOrNil(u *db.User) *int64 { + if u == nil { + return nil + } + return &u.ID +} diff --git a/internal/pagerender/pagerender.go b/internal/pagerender/pagerender.go index 464dec5b..467f7e16 100644 --- a/internal/pagerender/pagerender.go +++ b/internal/pagerender/pagerender.go @@ -4,12 +4,15 @@ package pagerender import ( "context" + "net/http" + "net/netip" "github.com/WikitTeam/ProjectWikit/internal/callbacks" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/i18n" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/printuser" + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/roles" @@ -20,6 +23,7 @@ type Deps struct { DB *db.DB Engine renderer.Renderer Icons roles.IconLoader + Trust *proxyheader.Trust } type Env struct { @@ -28,12 +32,24 @@ type Env struct { loc *i18n.Localizer site *db.Site user *db.User + ip *netip.Addr } func (d Deps) Env(ctx context.Context, loc *i18n.Localizer, site *db.Site, user *db.User) *Env { return &Env{deps: d, ctx: ctx, loc: loc, site: site, user: user} } +// SetClient records who is asking, which only the layer holding the proxy +// trust can answer. +func (e *Env) SetClient(r *http.Request) { + if e.deps.Trust == nil { + return + } + if addr, ok := e.deps.Trust.ClientIP(r); ok { + e.ip = &addr + } +} + func (e *Env) HTML(source string, info renderer.PageInfo, cb *callbacks.Callbacks, mode renderer.Mode) (renderer.Result, error) { return e.deps.Engine.RenderHTML(e.ctx, source, info, cb, mode) } @@ -95,6 +111,7 @@ func (e *Env) store() *repo.Repository { RenderMessage: e.message, RenderMessageText: e.messageText, Vars: repo.NewVarSource(e.ctx, e.deps.DB, e.site), + ClientIP: e.ip, }) } diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 622f3d97..28eca1a6 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -5,9 +5,11 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/form" + "github.com/WikitTeam/ProjectWikit/internal/pageconfig" "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/printuser" "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) type moduleData struct{ repo *Repository } @@ -278,6 +280,49 @@ func (m moduleData) ForumPostObject(p *db.ForumThreadPost, thread *perms.Object, return NewPerms(m.repo.ctx, m.repo.db).ForumPost(p, thread, u) } +func (m moduleData) ArticleVotes(articleID int64) ([]db.ArticleVote, error) { + return m.repo.db.ArticleVotes(m.repo.ctx, articleID) +} + +func (m moduleData) ReplaceVote(articleID, userID int64, rate *float64, roleID *int64) (*db.Vote, error) { + return m.repo.db.ReplaceVote(m.repo.ctx, articleID, userID, rate, roleID, time.Now().UTC()) +} + +func (m moduleData) VoteGroupRole(userID *int64) (*int64, error) { + return m.repo.db.VoteGroupRole(m.repo.ctx, userID) +} + +// The address is the one the entry layer trusted, not whatever the request +// claimed, so a reverse proxy cannot be talked into logging a made-up client. +func (m moduleData) AddActionLog(user *db.User, kind, meta string) error { + var id *int64 + name := "" + if user != nil { + id, name = &user.ID, user.Username + } + return m.repo.db.AddActionLog(m.repo.ctx, id, name, kind, meta, m.repo.opts.ClientIP, time.Now().UTC()) +} + +func (m moduleData) ArticleObject(article *db.Article, viewer *db.User) (*perms.Object, error) { + return NewPerms(m.repo.ctx, m.repo.db).Article(article, viewer) +} + +func (m moduleData) UserJSON(u *db.User) (wikijson.Object, error) { + if u == nil { + return pageconfig.SystemUserJSON().Object(), nil + } + userRoles, err := m.repo.db.RolesByUser(m.repo.ctx, u.ID) + if err != nil { + return nil, err + } + subject, err := NewPerms(m.repo.ctx, m.repo.db).Subject(u, time.Now()) + if err != nil { + return nil, err + } + editor := perms.Resolve(subject, nil).Has(perms.EditArticles) + return pageconfig.SignedInUserJSON(u, userRoles, true, editor).Object(), nil +} + func (m moduleData) SearchArticles(f db.SearchFilter, offset, limit int) ([]db.SearchHit, error) { return m.repo.db.SearchArticles(m.repo.ctx, f, offset, limit) } diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 884455c7..2f3d898f 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -5,6 +5,7 @@ import ( "context" "errors" "fmt" + "net/netip" "strings" "time" @@ -45,6 +46,10 @@ type Options struct { RenderMessageText func(source string) (string, error) Vars page.VarSource + + // ClientIP is what the action log records, and the entry layer is the only + // layer that knows which forwarded address to believe. + ClientIP *netip.Addr } var _ callbacks.Repository = (*Repository)(nil) @@ -109,13 +114,18 @@ func (r *Repository) moduleEnv(pc *page.Context) module.Env { // CallAPI answers the page asking a module a question of its own, which is not // a render and so produces JSON rather than markup. func (r *Repository) CallAPI(pc *page.Context, name, method string, params map[string]string) (wikijson.Object, error) { - fn, ok := module.LookupAPI(name, method) + fn, _, ok := module.LookupAPI(name, method) if !ok { return nil, fmt.Errorf("repo: %s has no api method %s", name, method) } env := r.moduleEnv(pc) env.Name = name - return fn(env, params) + out, err := fn(env, params) + var moduleErr *module.Error + if errors.As(err, &moduleErr) { + return nil, &callbacks.ModuleError{Message: moduleErr.Message} + } + return out, err } func (r *Repository) RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) { From 8075198506861a166cc1d3f5b0d0f4666283291f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 22:19:36 +0900 Subject: [PATCH 188/428] add the queries the article api reads and the log entry it writes --- internal/db/links.go | 64 ++++++++++++++++++++++++++++++++++++++++++++ internal/db/vote.go | 51 +++++++++++++++++++++++++++++++++-- 2 files changed, 113 insertions(+), 2 deletions(-) create mode 100644 internal/db/links.go diff --git a/internal/db/links.go b/internal/db/links.go new file mode 100644 index 00000000..a4448839 --- /dev/null +++ b/internal/db/links.go @@ -0,0 +1,64 @@ +package db + +import ( + "context" + "fmt" +) + +const ( + LinkInclude = "include" + LinkPlain = "link" +) + +type ExternalLink struct { + From string + Type string +} + +var qLinksTo = register("LinksTo", ` +SELECT link_from, link_type +FROM web_externallink +WHERE link_to = $1`) + +func (d *DB) LinksTo(ctx context.Context, fullName string) ([]ExternalLink, error) { + rows, err := d.pool.Query(ctx, qLinksTo, fullName) + if err != nil { + return nil, fmt.Errorf("query links to %q: %w", fullName, err) + } + defer rows.Close() + + var out []ExternalLink + for rows.Next() { + var link ExternalLink + if err := rows.Scan(&link.From, &link.Type); err != nil { + return nil, fmt.Errorf("scan link: %w", err) + } + out = append(out, link) + } + return out, rows.Err() +} + +var qArticleChildren = register("ArticleChildren", ` +SELECT `+articleColumns+` +FROM web_article +WHERE parent_id = $1 +ORDER BY id`) + +func (d *DB) ArticleChildren(ctx context.Context, articleID int64) ([]Article, error) { + rows, err := d.pool.Query(ctx, qArticleChildren, articleID) + if err != nil { + return nil, fmt.Errorf("query children of %d: %w", articleID, err) + } + defer rows.Close() + + var out []Article + for rows.Next() { + var a Article + if err := rows.Scan(&a.ID, &a.Category, &a.Name, &a.Title, &a.ParentID, &a.Locked, + &a.CreatedAt, &a.UpdatedAt, &a.MediaName); err != nil { + return nil, fmt.Errorf("scan child: %w", err) + } + out = append(out, a) + } + return out, rows.Err() +} diff --git a/internal/db/vote.go b/internal/db/vote.go index 9752e58e..a2ed6202 100644 --- a/internal/db/vote.go +++ b/internal/db/vote.go @@ -21,12 +21,13 @@ type ArticleVote struct { User User Rate float64 Date *time.Time + RoleID *int64 GroupTitle string GroupIndex *int } var qArticleVotes = register("ArticleVotes", ` -SELECT `+prefixed("u", userColumns)+`, v.rate, v.date, +SELECT `+prefixed("u", userColumns)+`, v.rate, v.date, v.role_id, COALESCE(NULLIF(r.votes_title, ''), NULLIF(r.name, ''), r.slug), r.index FROM web_vote v JOIN web_user u ON u.id = v.user_id @@ -46,7 +47,7 @@ func (d *DB) ArticleVotes(ctx context.Context, articleID int64) ([]ArticleVote, var v ArticleVote var title *string dest, finish := userDest(&v.User) - dest = append(dest, &v.Rate, &v.Date, &title, &v.GroupIndex) + dest = append(dest, &v.Rate, &v.Date, &v.RoleID, &title, &v.GroupIndex) if err := rows.Scan(dest...); err != nil { return nil, fmt.Errorf("scan vote: %w", err) } @@ -169,3 +170,49 @@ func (d *DB) AddActionLog(ctx context.Context, userID *int64, username, kind, me } return nil } + +// The log types an article carries, which the site changes list reads back. +const ( + LogVotesDeleted = "votes_deleted" +) + +var ( + qLockArticleLog = register("LockArticleLog", `SELECT pg_advisory_xact_lock($1)`) + + qInsertArticleLog = register("InsertArticleLog", ` +INSERT INTO web_articlelogentry (article_id, user_id, type, meta, comment, created_at, rev_number) +SELECT $1, $2, $3, $4, $5, $6, COALESCE(MAX(rev_number), -1) + 1 +FROM web_articlelogentry WHERE article_id = $1 +RETURNING rev_number`) + + qTouchArticle = register("TouchArticle", ` +UPDATE web_article SET updated_at = $2 WHERE id = $1`) +) + +// AddArticleLogEntry numbers the revision under a lock on this article alone, +// so two writers cannot pick the same number and neither waits on a page it is +// not touching. +func (d *DB) AddArticleLogEntry(ctx context.Context, articleID int64, userID *int64, + kind, comment, meta string, at time.Time) (int, error) { + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin log entry: %w", err) + } + defer tx.Rollback(ctx) + + if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { + return 0, fmt.Errorf("lock article log %d: %w", articleID, err) + } + var revNumber int + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, kind, meta, comment, at).Scan(&revNumber); err != nil { + return 0, fmt.Errorf("write log entry: %w", err) + } + if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { + return 0, fmt.Errorf("touch article %d: %w", articleID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, fmt.Errorf("commit log entry: %w", err) + } + return revNumber, nil +} From 17c4ffd1d60de38f157e7890d87a52a57c69bd82 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 22:19:36 +0900 Subject: [PATCH 189/428] give a vote with no group its two empty fields --- internal/modules/rateapi.go | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/internal/modules/rateapi.go b/internal/modules/rateapi.go index 2114f237..f1fa89f6 100644 --- a/internal/modules/rateapi.go +++ b/internal/modules/rateapi.go @@ -67,14 +67,15 @@ func rateGetVotes(env module.Env, _ map[string]string) (wikijson.Object, error) if err != nil { return nil, err } + var group, index any + if vote.RoleID != nil { + group, index = vote.GroupTitle, vote.GroupIndex + } fields := wikijson.Object{ {Key: "user", Value: user}, {Key: "value", Value: vote.Rate}, - } - if vote.GroupTitle != "" { - fields = append(fields, - wikijson.Field{Key: "visualGroup", Value: vote.GroupTitle}, - wikijson.Field{Key: "visualGroupIndex", Value: vote.GroupIndex}) + {Key: "visualGroup", Value: group}, + {Key: "visualGroupIndex", Value: index}, } if withDate { fields = append(fields, wikijson.Field{Key: "date", Value: voteDate(vote.Date)}) From c55f549e95a39c3fbcd97948e60768d8b3b94f5d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Wed, 2 Sep 2026 22:19:36 +0900 Subject: [PATCH 190/428] answer the article api's reads and the vote reset --- cmd/pwikit/articles.go | 33 +-- cmd/pwikit/main.go | 4 +- internal/db/vote.go | 11 +- internal/i18n/locales/zh-hans.json | 1 + internal/pagerender/pagerender.go | 6 +- internal/routing/routing.go | 1 + internal/routing/routing_test.go | 3 +- internal/webapi/articles.go | 394 +++++++++++++++++++++++++++++ 8 files changed, 425 insertions(+), 28 deletions(-) create mode 100644 internal/webapi/articles.go diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go index afc2d03f..238bd1e0 100644 --- a/cmd/pwikit/articles.go +++ b/cmd/pwikit/articles.go @@ -21,14 +21,15 @@ import ( ) type pageStack struct { - articles http.Handler - code http.Handler - html http.Handler - theme http.Handler - moduleAPI http.Handler - preview http.Handler - profile http.Handler - close func() + articles http.Handler + code http.Handler + html http.Handler + theme http.Handler + moduleAPI http.Handler + preview http.Handler + profile http.Handler + articleAPI http.Handler + close func() } func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handler, trust *proxyheader.Trust, sidecar, secret, timezone string, log *slog.Logger) (*pageStack, error) { @@ -62,12 +63,13 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl api := webapi.Deps{DB: conn, Trust: trust, Engine: engine, Bundle: bundle, Icons: icons, Log: log} stack := &pageStack{ - articles: pages, - code: localitem.NewCode(items), - html: localitem.NewHTML(items), - theme: localitem.NewTheme(items), - moduleAPI: webapi.New(api, upstream), - preview: webapi.NewPreview(api), + articles: pages, + code: localitem.NewCode(items), + html: localitem.NewHTML(items), + theme: localitem.NewTheme(items), + moduleAPI: webapi.New(api, upstream), + preview: webapi.NewPreview(api), + articleAPI: webapi.NewArticles(api, upstream), profile: userpage.New(userpage.Deps{ DB: conn, Engine: engine, Bundle: bundle, Icons: icons, Assets: static.NewAssets(assets), TimeZone: location, Log: log, @@ -81,12 +83,13 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl return stack, nil } resolver := auth.NewResolver(session.New(secret), conn, conn, log) - stack.articles = resolver.Middleware(stack.articles) + stack.articleAPI = resolver.Middleware(stack.articleAPI) stack.code = resolver.Middleware(stack.code) stack.html = resolver.Middleware(stack.html) stack.theme = resolver.Middleware(stack.theme) stack.moduleAPI = resolver.Middleware(stack.moduleAPI) stack.preview = resolver.Middleware(stack.preview) stack.profile = resolver.Middleware(stack.profile) + stack.articles = resolver.Middleware(stack.articles) return stack, nil } diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 0cf40b95..8b4f4be2 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -143,7 +143,7 @@ func serve(args []string) error { } var articles, codeHandler, htmlHandler, themeHandler http.Handler = proxy, proxy, proxy, proxy - var moduleAPI, preview, profile http.Handler = proxy, proxy, proxy + var moduleAPI, preview, profile, articleAPI http.Handler = proxy, proxy, proxy, proxy if conn != nil { stack, err := newPageStack(conn, p, assets, proxy, trust, *sidecar, *secret, *timezone, log) if err != nil { @@ -160,6 +160,7 @@ func serve(args []string) error { moduleAPI = served(stack.moduleAPI) preview = served(stack.preview) profile = served(stack.profile) + articleAPI = served(stack.articleAPI) } goHandlers := map[string]http.Handler{ @@ -175,6 +176,7 @@ func serve(args []string) error { webapi.ModulesPath: moduleAPI, webapi.PreviewPath: preview, userpage.Prefix: profile, + webapi.ArticlesPrefix: articleAPI, "/": articles, } diff --git a/internal/db/vote.go b/internal/db/vote.go index a2ed6202..45f169f9 100644 --- a/internal/db/vote.go +++ b/internal/db/vote.go @@ -74,9 +74,8 @@ INSERT INTO web_vote (article_id, user_id, rate, date, role_id) VALUES ($1, $2, $3, $4, $5)`) ) -// ReplaceVote drops whatever the user had voted and writes the new value, or -// only drops it when rate is nil. The vote that was there comes back, since the -// action log records what changed. +// The vote that was there comes back, since the action log records what +// changed rather than what it changed to. func (d *DB) ReplaceVote(ctx context.Context, articleID, userID int64, rate *float64, roleID *int64, at time.Time) (*Vote, error) { tx, err := d.pool.Begin(ctx) if err != nil { @@ -171,7 +170,6 @@ func (d *DB) AddActionLog(ctx context.Context, userID *int64, username, kind, me return nil } -// The log types an article carries, which the site changes list reads back. const ( LogVotesDeleted = "votes_deleted" ) @@ -189,9 +187,8 @@ RETURNING rev_number`) UPDATE web_article SET updated_at = $2 WHERE id = $1`) ) -// AddArticleLogEntry numbers the revision under a lock on this article alone, -// so two writers cannot pick the same number and neither waits on a page it is -// not touching. +// The revision is numbered under a lock on this article alone, so two writers +// cannot pick the same number and neither waits on a page it is not touching. func (d *DB) AddArticleLogEntry(ctx context.Context, articleID int64, userID *int64, kind, comment, meta string, at time.Time) (int, error) { diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 4f942e43..a286eb14 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -2,6 +2,7 @@ "api-bad-page-id": "无效的页面ID", "api-bad-request": "无效请求", "api-csrf-failed": "CSRF 校验失败", + "api-forbidden": "权限不足", "api-internal-error": "服务器内部错误", "api-page-not-found": "页面未找到", "button-copy-clipboard": "复制", diff --git a/internal/pagerender/pagerender.go b/internal/pagerender/pagerender.go index 467f7e16..8c5f2e1d 100644 --- a/internal/pagerender/pagerender.go +++ b/internal/pagerender/pagerender.go @@ -39,8 +39,8 @@ func (d Deps) Env(ctx context.Context, loc *i18n.Localizer, site *db.Site, user return &Env{deps: d, ctx: ctx, loc: loc, site: site, user: user} } -// SetClient records who is asking, which only the layer holding the proxy -// trust can answer. +// Only the layer holding the proxy trust can say which forwarded address to +// believe. func (e *Env) SetClient(r *http.Request) { if e.deps.Trust == nil { return @@ -95,8 +95,6 @@ func (e *Env) Callbacks(vars *page.Vars, pc *page.Context) *callbacks.Callbacks return cb } -// ModuleAPI answers a question the page asks one module directly, which reaches -// the same module set a render does. func (e *Env) ModuleAPI(pc *page.Context, name, method string, params map[string]string) (wikijson.Object, error) { return e.store().CallAPI(pc, name, method, params) } diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 4f85af75..21e76946 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -40,6 +40,7 @@ var Table = []Route{ {Prefix: "/pw-api/", Owner: OwnerUpstream, Label: "API"}, {Prefix: "/pw-api/modules", Owner: OwnerGo, Label: "module API", Exact: true}, {Prefix: "/pw-api/preview", Owner: OwnerGo, Label: "editor preview", Exact: true}, + {Prefix: "/pw-api/articles/", Owner: OwnerGo, Label: "article API"}, {Prefix: "/local--files/", Owner: OwnerGo, Label: "site files"}, {Prefix: "/local--resized-images/", Owner: OwnerGo, Label: "scaled images"}, {Prefix: "/local--code/", Owner: OwnerGo, Label: "code blocks"}, diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go index 59c47407..82d333b7 100644 --- a/internal/routing/routing_test.go +++ b/internal/routing/routing_test.go @@ -67,7 +67,8 @@ func TestMuxRouteLongestPrefixWins(t *testing.T) { {"/forum:start", "/"}, {"/-/login", "/-/"}, {"/-/static/app.js", "/-/static/"}, - {"/pw-api/articles/scp-173/votes", "/pw-api/"}, + {"/pw-api/articles/scp-173/votes", "/pw-api/articles/"}, + {"/pw-api/notifications", "/pw-api/"}, {"/local--files/a/b.png", "/local--files/"}, {"/local--theme/12/style.css", "/local--theme/"}, {"/-", "/"}, diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go new file mode 100644 index 00000000..6dc78126 --- /dev/null +++ b/internal/webapi/articles.go @@ -0,0 +1,394 @@ +package webapi + +import ( + "errors" + "net/http" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pagerender" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +const ArticlesPrefix = "/pw-api/articles/" + +const ( + tailLinks = "links" + tailVersion = "version" + tailVotes = "votes" +) + +type Articles struct { + deps Deps + upstream http.Handler +} + +var _ http.Handler = (*Articles)(nil) + +func NewArticles(d Deps, upstream http.Handler) *Articles { + return &Articles{deps: d, upstream: upstream} +} + +// Only the tails listed here are answered. A page's own URL still belongs to +// the upstream, which is where saving lives. +func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { + name, tail, found := cutLast(strings.TrimPrefix(r.URL.Path, ArticlesPrefix)) + if !found || name == "" { + h.upstream.ServeHTTP(w, r) + return + } + loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) + + switch { + case tail == tailLinks && r.Method == http.MethodGet: + h.answer(w, r, loc, name, h.links) + case tail == tailVersion && r.Method == http.MethodGet: + h.answer(w, r, loc, name, h.version) + case tail == tailVotes && r.Method == http.MethodGet: + h.answer(w, r, loc, name, h.votes) + case tail == tailVotes && r.Method == http.MethodDelete: + h.answer(w, r, loc, name, h.resetVotes) + default: + h.upstream.ServeHTTP(w, r) + } +} + +type answerFunc func(r *http.Request, loc *i18n.Localizer, name string) (string, int, error) + +func (h *Articles) answer(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, name string, fn answerFunc) { + if err := h.viewable(r, name); err != nil { + h.fail(w, loc, err) + return + } + body, status, err := fn(r, loc, name) + if err != nil { + h.fail(w, loc, err) + return + } + writeJSON(w, status, body) +} + +var ( + errForbidden = errors.New("webapi: the visitor may not see this page") + errNotFound = errors.New("webapi: no such page") +) + +func (h *Articles) fail(w http.ResponseWriter, loc *i18n.Localizer, err error) { + switch { + case errors.Is(err, errForbidden): + writeJSON(w, http.StatusForbidden, field("error", loc.T("api-forbidden"))) + case errors.Is(err, errNotFound): + writeJSON(w, http.StatusNotFound, field("error", loc.T("api-page-not-found"))) + default: + h.deps.log().Error("article api", "err", err) + writeJSON(w, http.StatusInternalServerError, field("error", loc.T("api-internal-error"))) + } +} + +// The category is asked rather than the page, so a name with no page behind it +// is still refused to whoever may not read that category at all. +func (h *Articles) viewable(r *http.Request, name string) error { + ctx := r.Context() + user := auth.FromContext(ctx) + perm := repo.NewPerms(ctx, h.deps.DB) + + subject, err := perm.Subject(user, time.Now()) + if err != nil { + return err + } + category, _ := wikidot.Split(name) + object, err := perm.Category(category) + if err != nil { + return err + } + if !perms.Resolve(subject, object).Has(perms.ViewArticles) { + return errForbidden + } + return nil +} + +func (h *Articles) article(r *http.Request, name string) (*db.Article, error) { + found, err := h.deps.DB.ArticleByName(r.Context(), name) + if errors.Is(err, db.ErrNotFound) { + return nil, errNotFound + } + return found, err +} + +func (h *Articles) links(r *http.Request, _ *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + + children, err := h.deps.DB.ArticleChildren(ctx, article.ID) + if err != nil { + return "", 0, err + } + kids := make(wikijson.Array, 0, len(children)) + for i := range children { + kids = append(kids, linkRecord(children[i].FullName(), children[i].Title, true)) + } + + links, err := h.deps.DB.LinksTo(ctx, name) + if err != nil { + return "", 0, err + } + refs := make([]string, 0, len(links)) + for _, link := range links { + refs = append(refs, strings.ToLower(link.From)) + } + titles, err := h.deps.DB.ArticleTitles(ctx, refs) + if err != nil { + return "", 0, err + } + + includes, plain := wikijson.Array{}, wikijson.Array{} + for _, link := range links { + from := strings.ToLower(link.From) + record := linkRecord(from, from, false) + if title, ok := titles[from]; ok { + record = linkRecord(from, title, true) + } + if link.Type == db.LinkInclude { + includes = append(includes, record) + } else if link.Type == db.LinkPlain { + plain = append(plain, record) + } + } + + body, err := wikijson.Marshal(wikijson.Object{ + {Key: "children", Value: kids}, + {Key: "includes", Value: includes}, + {Key: "links", Value: plain}, + }) + return body, http.StatusOK, err +} + +func linkRecord(id, title string, exists bool) wikijson.Object { + return wikijson.Object{ + {Key: "id", Value: id}, + {Key: "title", Value: title}, + {Key: "exists", Value: exists}, + } +} + +func (h *Articles) version(r *http.Request, _ *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + revNumber, err := strconv.Atoi(r.URL.Query().Get("revNum")) + if err != nil { + return "", 0, errNotFound + } + source, err := h.deps.DB.SourceAtRevision(ctx, article.ID, revNumber) + if errors.Is(err, db.ErrNotFound) || (err == nil && source == "") { + return "", 0, errNotFound + } + if err != nil { + return "", 0, err + } + + rendered, err := h.render(r, article, source) + if err != nil { + return "", 0, err + } + body, err := wikijson.Marshal(wikijson.Object{ + {Key: "source", Value: source}, + {Key: "rendered", Value: rendered}, + }) + return body, http.StatusOK, err +} + +func (h *Articles) render(r *http.Request, article *db.Article, source string) (string, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", errors.New("webapi: the request carries no site") + } + user := auth.FromContext(ctx) + loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) + + env := pagerender.Deps{DB: h.deps.DB, Engine: h.deps.Engine, Icons: h.deps.Icons, Trust: h.deps.Trust}. + Env(ctx, loc, current, user) + env.SetClient(r) + + params := page.ParsePathParams(r.URL.Query().Get("pathParams")) + vars := env.Vars(article) + info, err := env.PageInfo(article) + if err != nil { + return "", err + } + pc := page.NewContext(article, article, params, user) + html, err := env.HTML(page.PreRender(source, vars), info, env.Callbacks(vars, pc), renderer.ModeArticle) + if err != nil { + return "", err + } + return html.Body, nil +} + +func (h *Articles) votes(r *http.Request, _ *i18n.Localizer, name string) (string, int, error) { + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + body, err := h.moduleAPI(r, article, "rate", "get_votes") + return body, http.StatusOK, err +} + +func (h *Articles) resetVotes(r *http.Request, loc *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + current := site.FromContext(ctx) + if current == nil { + return "", 0, errors.New("webapi: the request carries no site") + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return field("error", loc.T("api-csrf-failed")), http.StatusForbidden, nil + } + + user := auth.FromContext(ctx) + perm := repo.NewPerms(ctx, h.deps.DB) + subject, err := perm.Subject(user, time.Now()) + if err != nil { + return "", 0, err + } + object, err := perm.Article(article, user) + if err != nil { + return "", 0, err + } + if !perms.Resolve(subject, object).Has(perms.ResetArticleVotes) { + return "", 0, errForbidden + } + + meta, err := h.votesMeta(r, article) + if err != nil { + return "", 0, err + } + if err := h.deps.DB.DeleteArticleVotes(ctx, article.ID); err != nil { + return "", 0, err + } + var userID *int64 + if user != nil { + userID = &user.ID + } + if _, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, + db.LogVotesDeleted, "", meta, time.Now().UTC()); err != nil { + return "", 0, err + } + return field("status", "ok"), http.StatusOK, nil +} + +// The entry records what the votes were, since the rows themselves are about to +// be gone. +func (h *Articles) votesMeta(r *http.Request, article *db.Article) (string, error) { + ctx := r.Context() + votes, err := h.deps.DB.ArticleVotes(ctx, article.ID) + if err != nil { + return "", err + } + rows := make(wikijson.Array, 0, len(votes)) + for i := range votes { + rows = append(rows, wikijson.Object{ + {Key: "user_id", Value: votes[i].User.ID}, + {Key: "vote", Value: votes[i].Rate}, + {Key: "role_id", Value: idOrNil(votes[i].RoleID)}, + {Key: "date", Value: voteDateOrNil(votes[i].Date)}, + }) + } + + rating, err := h.rating(r, article) + if err != nil { + return "", err + } + return wikijson.Marshal(wikijson.Object{ + {Key: "rating_mode", Value: rating.Mode}, + {Key: "rating", Value: rating.Value}, + {Key: "votes_count", Value: rating.Votes}, + {Key: "popularity", Value: rating.Popularity}, + {Key: "votes", Value: rows}, + }) +} + +func (h *Articles) moduleAPI(r *http.Request, article *db.Article, name, method string) (string, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", errors.New("webapi: the request carries no site") + } + user := auth.FromContext(ctx) + env := pagerender.Deps{DB: h.deps.DB, Engine: h.deps.Engine, Icons: h.deps.Icons, Trust: h.deps.Trust}. + Env(ctx, h.deps.Bundle.Localizer(i18n.DefaultLanguage), current, user) + env.SetClient(r) + + out, err := env.ModuleAPI(page.NewContext(article, article, nil, user), name, method, nil) + if err != nil { + return "", err + } + return wikijson.Marshal(out) +} + +func (h *Articles) rating(r *http.Request, article *db.Article) (page.Rating, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return page.Rating{}, errors.New("webapi: the request carries no site") + } + siteMode, err := h.deps.DB.SiteRatingMode(ctx, current.ID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return page.Rating{}, err + } + categoryMode, err := h.deps.DB.CategoryRatingMode(ctx, article.Category) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return page.Rating{}, err + } + mode := page.RatingMode(siteMode, categoryMode) + if mode == page.RatingModeDisabled { + return page.RatingOf(mode, db.VoteStats{}), nil + } + stats, err := h.deps.DB.VoteStats(ctx, article.ID) + if err != nil { + return page.Rating{}, err + } + return page.RatingOf(mode, stats), nil +} + +func idOrNil(id *int64) any { + if id == nil { + return nil + } + return *id +} + +func voteDateOrNil(at *time.Time) any { + if at == nil { + return nil + } + return at.UTC().Format("2006-01-02T15:04:05.999999-07:00") +} + +// The name keeps every slash but the last, since a forum page carries some. +func cutLast(path string) (name, tail string, found bool) { + at := strings.LastIndex(path, "/") + if at < 0 { + return "", "", false + } + return path[:at], path[at+1:], true +} From 826a7b4d6b841fa496dc52e50d392caadf5be828 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:35 +0900 Subject: [PATCH 191/428] give the site a system page theme --- web/migrations/0083_site_system_theme.py | 25 ++++++++++++++++++++++++ web/models/site.py | 22 ++++++++++++++++++--- 2 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 web/migrations/0083_site_system_theme.py diff --git a/web/migrations/0083_site_system_theme.py b/web/migrations/0083_site_system_theme.py new file mode 100644 index 00000000..08533a7b --- /dev/null +++ b/web/migrations/0083_site_system_theme.py @@ -0,0 +1,25 @@ +import django.db.models.deletion +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('web', '0082_invite_links'), + ] + + operations = [ + migrations.AddField( + model_name='site', + name='system_theme', + field=models.ForeignKey( + blank=True, + help_text='登录、注册、个人资料这类页面额外加载的 CSS。留空则只用内置样式。', + null=True, + on_delete=django.db.models.deletion.SET_NULL, + related_name='+', + to='web.theme', + verbose_name='系统页主题', + ), + ), + ] diff --git a/web/models/site.py b/web/models/site.py index 218c80a5..8711a4dc 100644 --- a/web/models/site.py +++ b/web/models/site.py @@ -4,6 +4,7 @@ 'SystemUpdate', 'get_current_site', 'get_site_theme_url', + 'get_site_system_theme_url', 'get_theme_dir', ] @@ -101,6 +102,11 @@ class Meta(SingletonModel.Meta): 'Theme', verbose_name='站点主题', null=True, blank=True, on_delete=models.SET_NULL, related_name='+', ) + system_theme = models.ForeignKey( + 'Theme', verbose_name='系统页主题', null=True, blank=True, + on_delete=models.SET_NULL, related_name='+', + help_text='登录、注册、个人资料这类页面额外加载的 CSS。留空则只用内置样式。', + ) auth_icon = models.ImageField('登录/注册页图标', null=True, blank=True, upload_to='-/sites') footer_license = models.TextField( @@ -157,14 +163,24 @@ def get_current_site(required: bool=True) -> Optional[Site]: def get_site_theme_url() -> str: - default_url = django_settings.STATIC_URL + 'theme.css' + return _theme_url_of('active_theme_id', django_settings.STATIC_URL + 'theme.css') + +# 系统页自带完整样式，没配主题就什么都不加载，所以这里没有回落地址。 +def get_site_system_theme_url() -> str: + return _theme_url_of('system_theme_id', '') + + +def _theme_url_of(field: str, default_url: str) -> str: site = get_current_site(required=False) - if site is None or not site.active_theme_id: + if site is None: + return default_url + theme_id = getattr(site, field, None) + if not theme_id: return default_url theme = (Theme.objects - .filter(pk=site.active_theme_id) + .filter(pk=theme_id) .only('slug', 'mode', 'external_url', 'updated_at') .first()) if theme is None: From ba90986fc9c309bcb4361a4dfdae4a01e0846602 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:35 +0900 Subject: [PATCH 192/428] show the system theme in the backend --- web/admin.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/admin.py b/web/admin.py index 4ad1a242..375c209c 100644 --- a/web/admin.py +++ b/web/admin.py @@ -209,7 +209,7 @@ class SiteAdmin(SingletonModelAdmin): 'fields': ('slug', 'title', 'headline', 'domain', 'media_domain', 'home_page', 'active_theme') }), ('外观', { - 'fields': ('icon', 'auth_icon', 'footer_license') + 'fields': ('icon', 'auth_icon', 'footer_license', 'system_theme') }), ('注册与入组', { 'fields': ('signup_notice', 'default_role', 'verified_role', From 79f7425d32f32a30563bf5702b85c275f446e72b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:35 +0900 Subject: [PATCH 193/428] load the system theme on system pages --- web/context_processors.py | 3 ++- web/templates/system_base.html | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/web/context_processors.py b/web/context_processors.py index 9abc39ce..d96cde35 100644 --- a/web/context_processors.py +++ b/web/context_processors.py @@ -1,4 +1,4 @@ -from web.models.site import get_current_site +from web.models.site import get_current_site, get_site_system_theme_url def site_branding(request): @@ -9,4 +9,5 @@ def site_branding(request): 'site_auth_icon': '/local--files/%s' % site.auth_icon if site.auth_icon else '', 'site_icon': '/local--files/%s' % site.icon if site.icon else '', 'site_signup_notice': site.signup_notice, + 'site_system_theme_url': get_site_system_theme_url(), } diff --git a/web/templates/system_base.html b/web/templates/system_base.html index ca9ab8ef..7ea3c6f0 100644 --- a/web/templates/system_base.html +++ b/web/templates/system_base.html @@ -17,6 +17,8 @@ + {% if site_system_theme_url %}{% endif %} + {% block head %}{% endblock %} From 329865270b0f9130c86ee74a792140621a468124 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:43 +0900 Subject: [PATCH 194/428] link the avatar to the profile --- web/js/entrypoints/page-login-status.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/js/entrypoints/page-login-status.tsx b/web/js/entrypoints/page-login-status.tsx index 1fab32a6..7a8644d9 100644 --- a/web/js/entrypoints/page-login-status.tsx +++ b/web/js/entrypoints/page-login-status.tsx @@ -57,7 +57,7 @@ const PageLoginStatus: React.FC = ({ user, notificationCount }: Props) => return ( <> - + {user.name {user.name || user.username} From 4284430a9eb0785e823581ac96eb32a8297c6342 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:44 +0900 Subject: [PATCH 195/428] point the nav at the profile form --- web/js/reactive/containers/page/Navigation.styles.ts | 8 ++++++-- web/js/reactive/containers/page/Navigation.tsx | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/web/js/reactive/containers/page/Navigation.styles.ts b/web/js/reactive/containers/page/Navigation.styles.ts index 4fba614b..fe5f3ab9 100644 --- a/web/js/reactive/containers/page/Navigation.styles.ts +++ b/web/js/reactive/containers/page/Navigation.styles.ts @@ -1,5 +1,5 @@ import { NavLink } from 'react-router-dom' -import styled from 'styled-components' +import styled, { css } from 'styled-components' export const Container = styled.div` border-bottom: 1px solid ${({ theme }) => theme.windowStrong}; @@ -12,7 +12,7 @@ export const Container = styled.div` overflow-x: auto; ` -export const Link = styled(NavLink)` +const linkStyle = css` padding: 12px 14px; text-decoration: none; color: ${({ theme }) => theme.uiForeground}; @@ -36,3 +36,7 @@ export const Link = styled(NavLink)` font-weight: 500; } ` + +export const Link = styled(NavLink)`${linkStyle}` + +export const ExternalLink = styled.a`${linkStyle}` diff --git a/web/js/reactive/containers/page/Navigation.tsx b/web/js/reactive/containers/page/Navigation.tsx index 0e5fc7e6..c71d2966 100644 --- a/web/js/reactive/containers/page/Navigation.tsx +++ b/web/js/reactive/containers/page/Navigation.tsx @@ -6,7 +6,7 @@ import * as Styled from './Navigation.styles' const Navigation: React.FC = () => { return ( - {t('page.navigation.edit-profile')} + {t('page.navigation.edit-profile')} {t('page.navigation.notifications')} {t('page.navigation.messages')} From e8f2076e38983353bc26605c6f50b17e3789bcfa Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:44 +0900 Subject: [PATCH 196/428] drop the profile route --- web/js/reactive/paths.ts | 1 - web/js/reactive/router.tsx | 2 -- 2 files changed, 3 deletions(-) diff --git a/web/js/reactive/paths.ts b/web/js/reactive/paths.ts index fe94b217..39bf214e 100644 --- a/web/js/reactive/paths.ts +++ b/web/js/reactive/paths.ts @@ -2,6 +2,5 @@ export const Paths = { notifications: '/notifications', notificationsAll: '/notifications/all', notificationsUnread: '/notifications/unread', - profile: '/profile', messages: '/messages', } diff --git a/web/js/reactive/router.tsx b/web/js/reactive/router.tsx index 3aa5b93b..95dce06f 100644 --- a/web/js/reactive/router.tsx +++ b/web/js/reactive/router.tsx @@ -6,7 +6,6 @@ import ConfigContextProvider from '~reactive/config' import { IConfigContext } from '~reactive/config/ConfigContext.types' import Messages from '~reactive/pages/messages' import Notifications from '~reactive/pages/notifications' -import Profile from '~reactive/pages/profile' import { Paths } from '~reactive/paths' import { SYSTEM_THEME } from '~reactive/theme/Theme.consts' @@ -25,7 +24,6 @@ export default function ReactivePage() { - } /> } /> } /> } /> From 3ec4d8d19b45636e750a04b9bf41c8fc42b0d7fd Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:44 +0900 Subject: [PATCH 197/428] delete the profile page --- .../reactive/pages/profile/Profile.styles.ts | 43 ------------------- web/js/reactive/pages/profile/Profile.tsx | 26 ----------- web/js/reactive/pages/profile/index.ts | 1 - 3 files changed, 70 deletions(-) delete mode 100644 web/js/reactive/pages/profile/Profile.styles.ts delete mode 100644 web/js/reactive/pages/profile/Profile.tsx delete mode 100644 web/js/reactive/pages/profile/index.ts diff --git a/web/js/reactive/pages/profile/Profile.styles.ts b/web/js/reactive/pages/profile/Profile.styles.ts deleted file mode 100644 index e0e98498..00000000 --- a/web/js/reactive/pages/profile/Profile.styles.ts +++ /dev/null @@ -1,43 +0,0 @@ -import styled from 'styled-components' - -export const Container = styled.div` - width: 100%; - height: 100%; - display: flex; - align-items: center; - justify-content: center; -` - -export const Link = styled.a` - background: ${({ theme }) => theme.uiSelection}; - color: ${({ theme }) => theme.uiSelectionForeground}; - display: inline-block; - padding: 8px 16px; - white-space: nowrap; - border-radius: 4px; - - &:hover, - &:active, - &:visited { - background: ${({ theme }) => theme.uiSelection}; - color: ${({ theme }) => theme.uiSelectionForeground}; - text-decoration: none; - } - - &:hover { - background: ${({ theme }) => theme.uiSelectionHighlight}; - } -` - -export const Buttons = styled.div` - display: flex; - gap: 8px; - & > * { - flex: 1 1 0; - } -` - -export const Separator = styled.div` - align-self: stretch; - border-left: 1px solid ${({ theme }) => theme.windowStrong}; -` diff --git a/web/js/reactive/pages/profile/Profile.tsx b/web/js/reactive/pages/profile/Profile.tsx deleted file mode 100644 index a9673d1d..00000000 --- a/web/js/reactive/pages/profile/Profile.tsx +++ /dev/null @@ -1,26 +0,0 @@ -import { t } from '~util/i18n' -import React from 'react' -import { useConfigContext } from '~reactive/config' -import { ProfilePage } from '~reactive/containers/page' -import * as Styled from './Profile.styles' - -const Profile: React.FC = () => { - /* useEffect(() => { - window.location.href = '/-/profile/edit' - }, []) */ - const { user } = useConfigContext() - - return ( - - - - {t('profile.public-title')} - - {t('profile.edit')} - - - - ) -} - -export default Profile diff --git a/web/js/reactive/pages/profile/index.ts b/web/js/reactive/pages/profile/index.ts deleted file mode 100644 index aa67a44f..00000000 --- a/web/js/reactive/pages/profile/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { default } from './Profile' From 4727eb0c535180940eb2414959acebd197f6b2a0 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:44 +0900 Subject: [PATCH 198/428] drop what the deleted page left behind --- web/js/locales/zh-hans.json | 2 -- web/urls.py | 1 - 2 files changed, 3 deletions(-) diff --git a/web/js/locales/zh-hans.json b/web/js/locales/zh-hans.json index 0b5351fd..cc679065 100644 --- a/web/js/locales/zh-hans.json +++ b/web/js/locales/zh-hans.json @@ -384,8 +384,6 @@ "page.navigation.messages": "站内信", "page.navigation.notifications": "通知", "page.profile-page.title": "用户界面", - "profile.edit": "编辑", - "profile.public-title": "公开资料", "search.author-placeholder": "作者", "search.comment-count": "{count} 条评论", "search.created": "创建 {when}", diff --git a/web/urls.py b/web/urls.py index fc58e44c..63e705fd 100644 --- a/web/urls.py +++ b/web/urls.py @@ -79,7 +79,6 @@ def make_reactive(routes: list[str]): reactive_pages = [ 'notifications', - 'profile', 'notifications/all', 'notifications/unread', 'messages', From de9bfde5b8f3b1171ec9bc3c08aaaddd8aba7275 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:52 +0900 Subject: [PATCH 199/428] read the csrf token from multipart --- internal/csrf/csrf.go | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/internal/csrf/csrf.go b/internal/csrf/csrf.go index a24bc5c2..e32dfd76 100644 --- a/internal/csrf/csrf.go +++ b/internal/csrf/csrf.go @@ -52,7 +52,12 @@ const ( HeaderName = "X-CSRFToken" FormField = "csrfmiddlewaretoken" - formMime = "application/x-www-form-urlencoded" + formMime = "application/x-www-form-urlencoded" + multipartMime = "multipart/form-data" + + // Big enough for the token, which is all this reads. How much of a file + // stays in memory is the handler's own parse to decide. + tokenMemory = 1 << 16 ) var ( @@ -88,14 +93,22 @@ func Verify(r *http.Request, hosts []string) error { } // A body that is not a form is left unread, since the handler still has to read -// it and a form parse would take it away. +// it and a form parse would take it away. A form's parsed values stay on the +// request, so parsing one here costs the handler nothing. func sentToken(r *http.Request) string { kind, _, err := mime.ParseMediaType(r.Header.Get("Content-Type")) - if err == nil && kind == formMime { - if err := r.ParseForm(); err == nil { - if token := r.PostFormValue(FormField); token != "" { - return token - } + var parsed bool + if err == nil { + switch kind { + case formMime: + parsed = r.ParseForm() == nil + case multipartMime: + parsed = r.ParseMultipartForm(tokenMemory) == nil + } + } + if parsed { + if token := r.PostFormValue(FormField); token != "" { + return token } } return r.Header.Get(HeaderName) From 059e53bb0bc14c6f33b0146c8c08a49359f413d2 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:52 +0900 Subject: [PATCH 200/428] let a pager take its own links --- internal/listpages/render.go | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/internal/listpages/render.go b/internal/listpages/render.go index 32ca4ba6..4f24b8d1 100644 --- a/internal/listpages/render.go +++ b/internal/listpages/render.go @@ -96,6 +96,16 @@ const ( ) func Pagination(loc *i18n.Localizer, basePath string, current, total int) string { + return pagination(loc, func(p int) string { return pageHref(basePath, p) }, true, current, total) +} + +// PaginationLinks pages a view reached by its own URL rather than swapped in +// place, so the numbers carry no hook for the script that re-renders a module. +func PaginationLinks(loc *i18n.Localizer, href func(page int) string, current, total int) string { + return pagination(loc, href, false, current, total) +} + +func pagination(loc *i18n.Localizer, href func(int) string, hook bool, current, total int) string { if total <= 1 { return "" } @@ -124,13 +134,13 @@ func Pagination(loc *i18n.Localizer, basePath string, current, total int) string `` + "\n" + ind16) if current > 1 { - b.WriteString("\n" + ind20 + step(loc, basePath, current-1, "module-listpages-pager-prev") + "\n" + ind16) + b.WriteString("\n" + ind20 + step(loc, href, hook, current-1, "module-listpages-pager-prev") + "\n" + ind16) } b.WriteString("\n" + ind16) writeRange := func(class string, from, to int) { for p := from; p <= to; p++ { - b.WriteString("\n" + ind20 + "\n" + ind24 + number(basePath, class, p, p == current) + "\n" + ind20 + "\n" + ind16) + b.WriteString("\n" + ind20 + "\n" + ind24 + number(href, hook, class, p, p == current) + "\n" + ind20 + "\n" + ind16) } } writeDots := func(show bool) { @@ -150,23 +160,30 @@ func Pagination(loc *i18n.Localizer, basePath string, current, total int) string b.WriteString("\n" + ind16) if current < total { - b.WriteString("\n" + ind20 + step(loc, basePath, current+1, "module-listpages-pager-next") + "\n" + ind16) + b.WriteString("\n" + ind20 + step(loc, href, hook, current+1, "module-listpages-pager-next") + "\n" + ind16) } b.WriteString("\n" + ind12 + "
") return b.String() } -func step(loc *i18n.Localizer, basePath string, target int, label string) string { - return `` + text(loc, label) + `` +func step(loc *i18n.Localizer, href func(int) string, hook bool, target int, label string) string { + return `` + strconv.Itoa(p) + `` } - return `` + strconv.Itoa(p) + `` + return ` Date: Thu, 3 Sep 2026 15:46:52 +0900 Subject: [PATCH 201/428] export the hidden categories --- internal/repo/modules.go | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 28eca1a6..7b566393 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -1,6 +1,7 @@ package repo import ( + "context" "time" "github.com/WikitTeam/ProjectWikit/internal/db" @@ -22,14 +23,18 @@ func (m moduleData) TagArticles(categorySlug, name string, hidden []string) ([]d return m.repo.db.ArticlesByTag(m.repo.ctx, categorySlug, name, hidden) } +func (m moduleData) HiddenCategories(user *db.User) ([]string, error) { + return HiddenCategories(m.repo.ctx, m.repo.db, user) +} + // HiddenCategories asks the same question once per category, the way the page // list does. There is no query for it because permissions are resolved in Go. -func (m moduleData) HiddenCategories(user *db.User) ([]string, error) { - names, err := m.repo.db.CategoryNames(m.repo.ctx) +func HiddenCategories(ctx context.Context, d *db.DB, user *db.User) ([]string, error) { + names, err := d.CategoryNames(ctx) if err != nil { return nil, err } - resolver := NewPerms(m.repo.ctx, m.repo.db) + resolver := NewPerms(ctx, d) subject, err := resolver.Subject(user, time.Now()) if err != nil { return nil, err From 85a76eeccbe56b94de2482aa88abe0447612c905 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:52 +0900 Subject: [PATCH 202/428] add the changelog package --- internal/changelog/changelog.go | 382 ++++++++++++++++++++++++++++++++ 1 file changed, 382 insertions(+) create mode 100644 internal/changelog/changelog.go diff --git a/internal/changelog/changelog.go b/internal/changelog/changelog.go new file mode 100644 index 00000000..e691373a --- /dev/null +++ b/internal/changelog/changelog.go @@ -0,0 +1,382 @@ +// Package changelog turns one article log entry into the flags and comment a +// reader sees beside it. +package changelog + +import ( + "encoding/json" + "errors" + "fmt" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/wikinum" +) + +var ErrUnreadable = errors.New("changelog: the log entry cannot be read") + +type Users func(ids []int64) ([]db.User, error) + +type Flag struct { + ID string + Desc string +} + +type Entry struct { + Flags []Flag + Comment string +} + +var flags = map[string]string{ + "source": "S", "title": "T", "name": "R", "tags": "A", "new": "N", + "parent": "M", "file_added": "F", "file_deleted": "F", "file_renamed": "F", + "votes_deleted": "V", "authorship": "C", "wikidot": "W", +} + +func TypeName(loc *i18n.Localizer, t string) (flag, desc string) { + f, ok := flags[t] + if !ok { + return "?", "?" + } + return f, text(loc, "module-sitechanges-type-"+strings.ReplaceAll(t, "_", "-")) +} + +// A revert's flags are the types it undid, which it keeps in meta rather than +// in the type column. +func Of(loc *i18n.Localizer, users Users, change db.SiteChange) (Entry, error) { + m, err := metaOf(change.Meta) + if err != nil { + return Entry{}, err + } + + var entry Entry + if raw, ok := m["subtypes"]; ok { + var subtypes []string + if err := json.Unmarshal(raw, &subtypes); err != nil { + return Entry{}, ErrUnreadable + } + for _, subtype := range subtypes { + id, desc := TypeName(loc, subtype) + entry.Flags = append(entry.Flags, Flag{ID: id, Desc: desc}) + } + } else { + id, desc := TypeName(loc, change.Type) + entry.Flags = append(entry.Flags, Flag{ID: id, Desc: desc}) + } + + if entry.Comment, err = comment(loc, users, change, m); err != nil { + return Entry{}, err + } + return entry, nil +} + +func comment(loc *i18n.Localizer, users Users, change db.SiteChange, m metaMap) (string, error) { + if strings.TrimSpace(change.Comment) != "" { + return change.Comment, nil + } + + switch change.Type { + case "new": + return text(loc, "module-sitechanges-comment-new"), nil + case "title": + prev, title, err := m.two("prev_title", "title") + if err != nil { + return "", err + } + return text(loc, "module-sitechanges-comment-title", "prev", prev, "title", title), nil + case "name": + prev, name, err := m.two("prev_name", "name") + if err != nil { + return "", err + } + return text(loc, "module-sitechanges-comment-name", "prev", prev, "name", name), nil + case "tags": + return tagComment(loc, m) + case "parent": + return parentComment(loc, m) + case "file_added": + name, err := m.str("name") + if err != nil { + return "", err + } + return text(loc, "module-sitechanges-comment-file-added", "name", name), nil + case "file_deleted": + name, err := m.str("name") + if err != nil { + return "", err + } + return text(loc, "module-sitechanges-comment-file-deleted", "name", name), nil + case "file_renamed": + prev, name, err := m.two("prev_name", "name") + if err != nil { + return "", err + } + return text(loc, "module-sitechanges-comment-file-renamed", "prev", prev, "name", name), nil + case "votes_deleted": + return votesComment(loc, m) + case "authorship": + return authorComment(loc, users, m) + case "revert": + rev, err := m.str("rev_number") + if err != nil { + return "", err + } + return text(loc, "module-sitechanges-comment-revert", "rev", rev), nil + } + return "", nil +} + +func tagComment(loc *i18n.Localizer, m metaMap) (string, error) { + added, err := m.names("added_tags") + if err != nil { + return "", err + } + removed, err := m.names("removed_tags") + if err != nil { + return "", err + } + + var parts []string + if len(added) > 0 { + parts = append(parts, text(loc, "module-sitechanges-comment-tags-added", + "tags", strings.Join(added, ", "))) + } + if len(removed) > 0 { + parts = append(parts, text(loc, "module-sitechanges-comment-tags-removed", + "tags", strings.Join(removed, ", "))) + } + return strings.Join(parts, " "), nil +} + +func parentComment(loc *i18n.Localizer, m metaMap) (string, error) { + prev, parent, err := m.two("prev_parent", "parent") + if err != nil { + return "", err + } + switch { + case m.truthy("prev_parent") && m.truthy("parent"): + return text(loc, "module-sitechanges-comment-parent-changed", "prev", prev, "parent", parent), nil + case m.truthy("prev_parent"): + return text(loc, "module-sitechanges-comment-parent-removed", "prev", prev), nil + case m.truthy("parent"): + return text(loc, "module-sitechanges-comment-parent-set", "parent", parent), nil + } + return "", nil +} + +func votesComment(loc *i18n.Localizer, m metaMap) (string, error) { + mode, err := m.str("rating_mode") + if err != nil { + return "", err + } + votes, err := m.str("votes_count") + if err != nil { + return "", err + } + popularity, err := m.str("popularity") + if err != nil { + return "", err + } + + rating := text(loc, "module-sitechanges-comment-votes-none") + switch mode { + case "updown": + n, err := m.integer("rating") + if err != nil { + return "", err + } + rating = fmt.Sprintf("%+d", n) + case "stars": + f, err := m.float("rating") + if err != nil { + return "", err + } + rating = strconv.FormatFloat(f, 'f', 1, 64) + } + return text(loc, "module-sitechanges-comment-votes", + "rating", rating, "votes", votes, "popularity", popularity), nil +} + +func authorComment(loc *i18n.Localizer, users Users, m metaMap) (string, error) { + label := func(key string) (string, error) { + ids, err := m.ids(key) + if err != nil { + return "", err + } + found, err := users(ids) + if err != nil { + return "", err + } + names := make([]string, 0, len(found)) + for i := range found { + names = append(names, found[i].DisplayLabel()) + } + return strings.Join(names, ", "), nil + } + + added, err := label("added_authors") + if err != nil { + return "", err + } + removed, err := label("removed_authors") + if err != nil { + return "", err + } + + var parts []string + if added != "" { + parts = append(parts, text(loc, "module-sitechanges-comment-authors-added", "names", added)) + } + if removed != "" { + parts = append(parts, text(loc, "module-sitechanges-comment-authors-removed", "names", removed)) + } + return strings.Join(parts, " "), nil +} + +func text(loc *i18n.Localizer, id string, args ...any) string { + if loc == nil { + return id + } + return loc.T(id, args...) +} + +type metaMap map[string]json.RawMessage + +func metaOf(raw []byte) (metaMap, error) { + if len(raw) == 0 { + return metaMap{}, nil + } + var m metaMap + if err := json.Unmarshal(raw, &m); err != nil { + return nil, ErrUnreadable + } + return m, nil +} + +func (m metaMap) str(key string) (string, error) { + raw, ok := m[key] + if !ok { + return "", ErrUnreadable + } + return metaText(raw), nil +} + +func (m metaMap) two(first, second string) (string, string, error) { + a, err := m.str(first) + if err != nil { + return "", "", err + } + b, err := m.str(second) + if err != nil { + return "", "", err + } + return a, b, nil +} + +func (m metaMap) truthy(key string) bool { + switch t := strings.TrimSpace(string(m[key])); t { + case "", "null", "false", "0", "0.0", `""`, "[]", "{}": + return false + } + return true +} + +func (m metaMap) names(key string) ([]string, error) { + raw, ok := m[key] + if !ok { + return nil, nil + } + var items []map[string]json.RawMessage + if err := json.Unmarshal(raw, &items); err != nil { + return nil, ErrUnreadable + } + out := make([]string, 0, len(items)) + for _, item := range items { + name, ok := item["name"] + if !ok { + return nil, ErrUnreadable + } + out = append(out, metaText(name)) + } + return out, nil +} + +func (m metaMap) ids(key string) ([]int64, error) { + raw, ok := m[key] + if !ok { + return nil, nil + } + var ids []int64 + if err := json.Unmarshal(raw, &ids); err != nil { + return nil, ErrUnreadable + } + return ids, nil +} + +func (m metaMap) integer(key string) (int, error) { + raw, ok := m[key] + if !ok { + return 0, ErrUnreadable + } + if quoted, ok := unquoteJSON(raw); ok { + n, err := wikinum.Int(quoted) + if err != nil { + return 0, ErrUnreadable + } + return n, nil + } + f, err := strconv.ParseFloat(strings.TrimSpace(string(raw)), 64) + if err != nil { + return 0, ErrUnreadable + } + return int(f), nil +} + +func (m metaMap) float(key string) (float64, error) { + raw, ok := m[key] + if !ok { + return 0, ErrUnreadable + } + if quoted, ok := unquoteJSON(raw); ok { + f, err := wikinum.Float(quoted) + if err != nil { + return 0, ErrUnreadable + } + return f, nil + } + f, err := strconv.ParseFloat(strings.TrimSpace(string(raw)), 64) + if err != nil { + return 0, ErrUnreadable + } + return f, nil +} + +func unquoteJSON(raw json.RawMessage) (string, bool) { + if !strings.HasPrefix(strings.TrimSpace(string(raw)), `"`) { + return "", false + } + var out string + if err := json.Unmarshal(raw, &out); err != nil { + return "", false + } + return out, true +} + +// The comment lines interpolate whatever the log entry stored, so a value that +// is not a string still has to come out as text. +func metaText(raw json.RawMessage) string { + t := strings.TrimSpace(string(raw)) + switch t { + case "null": + return "None" + case "true": + return "True" + case "false": + return "False" + } + if unquoted, ok := unquoteJSON(raw); ok { + return unquoted + } + return t +} From 304990f752d0ee71cac77e7e92e31892e1503311 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:46:52 +0900 Subject: [PATCH 203/428] read the change flags and comment through it --- internal/modules/sitechanges.go | 357 +------------------------------- 1 file changed, 11 insertions(+), 346 deletions(-) diff --git a/internal/modules/sitechanges.go b/internal/modules/sitechanges.go index 56e18887..c22c45ce 100644 --- a/internal/modules/sitechanges.go +++ b/internal/modules/sitechanges.go @@ -1,13 +1,12 @@ package modules import ( - "encoding/json" "errors" - "fmt" "slices" "strconv" "strings" + "github.com/WikitTeam/ProjectWikit/internal/changelog" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/escape" "github.com/WikitTeam/ProjectWikit/internal/listpages" @@ -30,20 +29,9 @@ var siteChangeTypes = []string{ "authorship", "wikidot", "revert", } -var siteChangeFlags = map[string]string{ - "source": "S", "title": "T", "name": "R", "tags": "A", "new": "N", - "parent": "M", "file_added": "F", "file_deleted": "F", "file_renamed": "F", - "votes_deleted": "V", "authorship": "C", "wikidot": "W", -} - -type siteChangeFlag struct { - id string - desc string -} - type siteChangeRow struct { revNumber int - flags []siteChangeFlag + flags []changelog.Flag comment string author string date string @@ -174,7 +162,7 @@ func siteChangesBuild(env module.Env, path page.PathParams, params map[string]st if t == "revert" { continue } - _, desc := siteChangeTypeName(env, t) + _, desc := changelog.TypeName(env.Loc, t) view.types = append(view.types, siteChangesOption{ name: desc, id: t, selected: slices.Contains(filterTypes, t), }) @@ -253,21 +241,18 @@ func siteChangeUserFilter(env module.Env, filter *db.SiteChangeFilter, userName return nil } -func siteChangeTypeName(env module.Env, t string) (string, string) { - flag, ok := siteChangeFlags[t] - if !ok { - return "?", "?" - } - return flag, env.Text("module-sitechanges-type-" + strings.ReplaceAll(t, "_", "-")) -} - func siteChangeRowOf(env module.Env, change db.SiteChange) (siteChangeRow, error) { - meta, err := siteChangeMetaOf(change.Meta) + entry, err := changelog.Of(env.Loc, env.Data.UsersByIDs, change) + if errors.Is(err, changelog.ErrUnreadable) { + return siteChangeRow{}, errSiteChange + } if err != nil { return siteChangeRow{}, err } row := siteChangeRow{ + flags: entry.Flags, + comment: entry.Comment, revNumber: change.RevNumber, date: renderDate(env, change.CreatedAt), title: change.ArticleTitle, @@ -278,332 +263,12 @@ func siteChangeRowOf(env module.Env, change db.SiteChange) (siteChangeRow, error row.url = "/" + change.ArticleCategory + ":" + change.ArticleName } - if raw, ok := meta["subtypes"]; ok { - var subtypes []string - if err := json.Unmarshal(raw, &subtypes); err != nil { - return siteChangeRow{}, errSiteChange - } - for _, subtype := range subtypes { - id, desc := siteChangeTypeName(env, subtype) - row.flags = append(row.flags, siteChangeFlag{id: id, desc: desc}) - } - } else { - id, desc := siteChangeTypeName(env, change.Type) - row.flags = append(row.flags, siteChangeFlag{id: id, desc: desc}) - } - - if row.comment, err = siteChangeComment(env, change, meta); err != nil { - return siteChangeRow{}, err - } if row.author, err = env.Data.RenderUserByID(change.UserID); err != nil { return siteChangeRow{}, err } return row, nil } -func siteChangeComment(env module.Env, change db.SiteChange, meta siteChangeMeta) (string, error) { - if strings.TrimSpace(change.Comment) != "" { - return change.Comment, nil - } - - switch change.Type { - case "new": - return env.Text("module-sitechanges-comment-new"), nil - case "title": - prev, title, err := meta.two("prev_title", "title") - if err != nil { - return "", err - } - return env.Text("module-sitechanges-comment-title", "prev", prev, "title", title), nil - case "name": - prev, name, err := meta.two("prev_name", "name") - if err != nil { - return "", err - } - return env.Text("module-sitechanges-comment-name", "prev", prev, "name", name), nil - case "tags": - return siteChangeTagComment(env, meta) - case "parent": - return siteChangeParentComment(env, meta) - case "file_added": - name, err := meta.str("name") - if err != nil { - return "", err - } - return env.Text("module-sitechanges-comment-file-added", "name", name), nil - case "file_deleted": - name, err := meta.str("name") - if err != nil { - return "", err - } - return env.Text("module-sitechanges-comment-file-deleted", "name", name), nil - case "file_renamed": - prev, name, err := meta.two("prev_name", "name") - if err != nil { - return "", err - } - return env.Text("module-sitechanges-comment-file-renamed", "prev", prev, "name", name), nil - case "votes_deleted": - return siteChangeVotesComment(env, meta) - case "authorship": - return siteChangeAuthorComment(env, meta) - case "revert": - rev, err := meta.str("rev_number") - if err != nil { - return "", err - } - return env.Text("module-sitechanges-comment-revert", "rev", rev), nil - } - return "", nil -} - -func siteChangeTagComment(env module.Env, meta siteChangeMeta) (string, error) { - added, err := meta.names("added_tags") - if err != nil { - return "", err - } - removed, err := meta.names("removed_tags") - if err != nil { - return "", err - } - - var parts []string - if len(added) > 0 { - parts = append(parts, env.Text("module-sitechanges-comment-tags-added", - "tags", strings.Join(added, ", "))) - } - if len(removed) > 0 { - parts = append(parts, env.Text("module-sitechanges-comment-tags-removed", - "tags", strings.Join(removed, ", "))) - } - return strings.Join(parts, " "), nil -} - -func siteChangeParentComment(env module.Env, meta siteChangeMeta) (string, error) { - prev, parent, err := meta.two("prev_parent", "parent") - if err != nil { - return "", err - } - switch { - case meta.truthy("prev_parent") && meta.truthy("parent"): - return env.Text("module-sitechanges-comment-parent-changed", "prev", prev, "parent", parent), nil - case meta.truthy("prev_parent"): - return env.Text("module-sitechanges-comment-parent-removed", "prev", prev), nil - case meta.truthy("parent"): - return env.Text("module-sitechanges-comment-parent-set", "parent", parent), nil - } - return "", nil -} - -func siteChangeVotesComment(env module.Env, meta siteChangeMeta) (string, error) { - mode, err := meta.str("rating_mode") - if err != nil { - return "", err - } - votes, err := meta.str("votes_count") - if err != nil { - return "", err - } - popularity, err := meta.str("popularity") - if err != nil { - return "", err - } - - rating := env.Text("module-sitechanges-comment-votes-none") - switch mode { - case "updown": - n, err := meta.integer("rating") - if err != nil { - return "", err - } - rating = fmt.Sprintf("%+d", n) - case "stars": - f, err := meta.float("rating") - if err != nil { - return "", err - } - rating = strconv.FormatFloat(f, 'f', 1, 64) - } - return env.Text("module-sitechanges-comment-votes", - "rating", rating, "votes", votes, "popularity", popularity), nil -} - -func siteChangeAuthorComment(env module.Env, meta siteChangeMeta) (string, error) { - label := func(key string) (string, error) { - ids, err := meta.ids(key) - if err != nil { - return "", err - } - users, err := env.Data.UsersByIDs(ids) - if err != nil { - return "", err - } - names := make([]string, 0, len(users)) - for i := range users { - names = append(names, users[i].DisplayLabel()) - } - return strings.Join(names, ", "), nil - } - - added, err := label("added_authors") - if err != nil { - return "", err - } - removed, err := label("removed_authors") - if err != nil { - return "", err - } - - var parts []string - if added != "" { - parts = append(parts, env.Text("module-sitechanges-comment-authors-added", "names", added)) - } - if removed != "" { - parts = append(parts, env.Text("module-sitechanges-comment-authors-removed", "names", removed)) - } - return strings.Join(parts, " "), nil -} - -type siteChangeMeta map[string]json.RawMessage - -func siteChangeMetaOf(raw []byte) (siteChangeMeta, error) { - if len(raw) == 0 { - return siteChangeMeta{}, nil - } - var meta siteChangeMeta - if err := json.Unmarshal(raw, &meta); err != nil { - return nil, errSiteChange - } - return meta, nil -} - -func (m siteChangeMeta) str(key string) (string, error) { - raw, ok := m[key] - if !ok { - return "", errSiteChange - } - return metaText(raw), nil -} - -func (m siteChangeMeta) two(first, second string) (string, string, error) { - a, err := m.str(first) - if err != nil { - return "", "", err - } - b, err := m.str(second) - if err != nil { - return "", "", err - } - return a, b, nil -} - -func (m siteChangeMeta) truthy(key string) bool { - switch text := strings.TrimSpace(string(m[key])); text { - case "", "null", "false", "0", "0.0", `""`, "[]", "{}": - return false - } - return true -} - -func (m siteChangeMeta) names(key string) ([]string, error) { - raw, ok := m[key] - if !ok { - return nil, nil - } - var items []map[string]json.RawMessage - if err := json.Unmarshal(raw, &items); err != nil { - return nil, errSiteChange - } - out := make([]string, 0, len(items)) - for _, item := range items { - name, ok := item["name"] - if !ok { - return nil, errSiteChange - } - out = append(out, metaText(name)) - } - return out, nil -} - -func (m siteChangeMeta) ids(key string) ([]int64, error) { - raw, ok := m[key] - if !ok { - return nil, nil - } - var ids []int64 - if err := json.Unmarshal(raw, &ids); err != nil { - return nil, errSiteChange - } - return ids, nil -} - -func (m siteChangeMeta) integer(key string) (int, error) { - raw, ok := m[key] - if !ok { - return 0, errSiteChange - } - if quoted, ok := unquoteJSON(raw); ok { - n, err := wikinum.Int(quoted) - if err != nil { - return 0, errSiteChange - } - return n, nil - } - f, err := strconv.ParseFloat(strings.TrimSpace(string(raw)), 64) - if err != nil { - return 0, errSiteChange - } - return int(f), nil -} - -func (m siteChangeMeta) float(key string) (float64, error) { - raw, ok := m[key] - if !ok { - return 0, errSiteChange - } - if quoted, ok := unquoteJSON(raw); ok { - f, err := wikinum.Float(quoted) - if err != nil { - return 0, errSiteChange - } - return f, nil - } - f, err := strconv.ParseFloat(strings.TrimSpace(string(raw)), 64) - if err != nil { - return 0, errSiteChange - } - return f, nil -} - -func unquoteJSON(raw json.RawMessage) (string, bool) { - if !strings.HasPrefix(strings.TrimSpace(string(raw)), `"`) { - return "", false - } - var out string - if err := json.Unmarshal(raw, &out); err != nil { - return "", false - } - return out, true -} - -// The comment lines interpolate whatever the log entry stored, so a value that -// is not a string still has to come out as text. -func metaText(raw json.RawMessage) string { - text := strings.TrimSpace(string(raw)) - switch text { - case "null": - return "None" - case "true": - return "True" - case "false": - return "False" - } - if unquoted, ok := unquoteJSON(raw); ok { - return unquoted - } - return text -} - func siteChangesHTML(env module.Env, v siteChangesView) string { var b strings.Builder b.WriteString(`
` + "\n" + ind28) for _, flag := range row.flags { - b.WriteString(`` + - escape.HTML(flag.id) + ``) + b.WriteString(`` + + escape.HTML(flag.ID) + ``) } b.WriteString("\n" + ind24 + `` + "\n" + ind24 + `` + From ce68562ad7446d353c3278489d9a0b059ce89961 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:00 +0900 Subject: [PATCH 204/428] read the system theme id --- internal/db/site.go | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/internal/db/site.go b/internal/db/site.go index 2ac48c8c..ea88d8df 100644 --- a/internal/db/site.go +++ b/internal/db/site.go @@ -19,6 +19,8 @@ type Site struct { Icon string ThemeID *int64 + SystemThemeID *int64 + AuthIcon string FooterLicense string SignupNotice string @@ -30,7 +32,7 @@ type Site struct { var qSiteByHost = register("SiteByHost", ` SELECT id, slug, title, headline, domain, media_domain, home_page, COALESCE(icon, ''), active_theme_id, - COALESCE(auth_icon, ''), footer_license, signup_notice, + system_theme_id, COALESCE(auth_icon, ''), footer_license, signup_notice, membership_password_enabled, membership_password, membership_password_role_id FROM web_site WHERE domain = $1 OR media_domain = $1 @@ -45,7 +47,7 @@ func (d *DB) SiteByHosts(ctx context.Context, hosts []string) (*Site, error) { var s Site err := d.pool.QueryRow(ctx, qSiteByHost, host).Scan( &s.ID, &s.Slug, &s.Title, &s.Headline, &s.Domain, &s.MediaDomain, &s.HomePage, - &s.Icon, &s.ThemeID, + &s.Icon, &s.ThemeID, &s.SystemThemeID, &s.AuthIcon, &s.FooterLicense, &s.SignupNotice, &s.MembershipPasswordEnabled, &s.MembershipPassword, &s.MembershipPasswordRoleID) if errors.Is(err, pgx.ErrNoRows) { From 46f0a272f456f166da9ffd69631be23355a51998 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:00 +0900 Subject: [PATCH 205/428] add the profile update --- internal/db/profile.go | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/internal/db/profile.go b/internal/db/profile.go index ac62ff4c..5f65f9c4 100644 --- a/internal/db/profile.go +++ b/internal/db/profile.go @@ -56,6 +56,20 @@ func (d *DB) profile(ctx context.Context, query string, arg any) (*Profile, erro return &p, nil } +// A nil avatar leaves the stored one alone, so saving the form without picking +// a file does not wipe the picture. +var qUpdateProfile = register("UpdateProfile", ` +UPDATE web_user +SET first_name = $2, last_name = $3, bio = $4, avatar = COALESCE($5, avatar) +WHERE id = $1`) + +func (d *DB) UpdateProfile(ctx context.Context, id int64, firstName, lastName, bio string, avatar *string) error { + if _, err := d.pool.Exec(ctx, qUpdateProfile, id, firstName, lastName, bio, avatar); err != nil { + return fmt.Errorf("update profile %d: %w", id, err) + } + return nil +} + var qDirectMessageBlocked = register("DirectMessageBlocked", ` SELECT EXISTS (SELECT 1 FROM web_directmessageblock WHERE blocker_id = $1 AND blocked_id = $2)`) From ddf168fad9bc2b588ce9fb46092f5814687ba51f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:00 +0900 Subject: [PATCH 206/428] add the user post queries --- internal/db/forum.go | 65 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/internal/db/forum.go b/internal/db/forum.go index 33af542c..d66b9ebc 100644 --- a/internal/db/forum.go +++ b/internal/db/forum.go @@ -578,3 +578,68 @@ func (d *DB) RecentPosts(ctx context.Context, categoryIDs []int64, comments bool } return out, rows.Err() } + +type UserPost struct { + ID int64 + Name string + CreatedAt time.Time + + ThreadID int64 + ThreadName string + ThreadCategoryID *int64 + + ArticleTitle *string + ArticleName *string + ArticleCategory *string +} + +// The same visibility rule the recent-post listing uses, so one reader never +// sees a post on the profile that the forum would have kept from them. +var qUserPosts = register("UserPosts", ` +SELECT p.id, p.name, p.created_at, + t.id, t.name, t.category_id, + a.title, a.name, a.category +FROM web_forumpost p +JOIN web_forumthread t ON t.id = p.thread_id +LEFT JOIN web_article a ON a.id = t.article_id +WHERE p.author_id = $1 + AND (t.category_id = ANY($2) OR ($3::boolean AND t.article_id IS NOT NULL)) +ORDER BY p.created_at DESC +OFFSET $4 LIMIT $5`) + +var qUserPostCount = register("UserPostCount", ` +SELECT count(*) +FROM web_forumpost p +JOIN web_forumthread t ON t.id = p.thread_id +WHERE p.author_id = $1 + AND (t.category_id = ANY($2) OR ($3::boolean AND t.article_id IS NOT NULL))`) + +func (d *DB) UserPostCount(ctx context.Context, authorID int64, categoryIDs []int64, comments bool) (int, error) { + var n int + if err := d.pool.QueryRow(ctx, qUserPostCount, authorID, categoryIDs, comments).Scan(&n); err != nil { + return 0, fmt.Errorf("count posts of user %d: %w", authorID, err) + } + return n, nil +} + +func (d *DB) UserPosts(ctx context.Context, authorID int64, categoryIDs []int64, + comments bool, offset, limit int) ([]UserPost, error) { + + rows, err := d.pool.Query(ctx, qUserPosts, authorID, categoryIDs, comments, offset, limit) + if err != nil { + return nil, fmt.Errorf("query posts of user %d: %w", authorID, err) + } + defer rows.Close() + + var out []UserPost + for rows.Next() { + var p UserPost + if err := rows.Scan(&p.ID, &p.Name, &p.CreatedAt, + &p.ThreadID, &p.ThreadName, &p.ThreadCategoryID, + &p.ArticleTitle, &p.ArticleName, &p.ArticleCategory); err != nil { + return nil, fmt.Errorf("scan post of user %d: %w", authorID, err) + } + out = append(out, p) + } + return out, rows.Err() +} From e7f9e0fbb6c993f3afdfe09f5eb9d88b1bb47946 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:00 +0900 Subject: [PATCH 207/428] resolve a theme by id --- internal/articlepage/render.go | 12 +----------- internal/site/theme.go | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 3cefea49..d09f68cd 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -488,17 +488,7 @@ func (h *Handler) shellData(req *request, out body, canonical, navTop, navSide s } func (h *Handler) themeURL(req *request) (string, error) { - if req.site.ThemeID == nil { - return "", nil - } - theme, err := h.deps.DB.ThemeByID(req.ctx, *req.site.ThemeID) - if errors.Is(err, db.ErrNotFound) { - return "", nil - } - if err != nil { - return "", err - } - return site.ThemeURL(theme), nil + return site.ThemeURLByID(req.ctx, h.deps.DB, req.site.ThemeID) } func (h *Handler) indexed(req *request) (bool, error) { diff --git a/internal/site/theme.go b/internal/site/theme.go index 5efd65d6..0744b85c 100644 --- a/internal/site/theme.go +++ b/internal/site/theme.go @@ -1,6 +1,8 @@ package site import ( + "context" + "errors" "io" "net/http" "os" @@ -24,6 +26,20 @@ func ThemeURL(t *db.Theme) string { return "/-/theme/" + t.Slug + ".css?v=" + strconv.FormatInt(t.UpdatedAt.Unix(), 10) } +func ThemeURLByID(ctx context.Context, d *db.DB, id *int64) (string, error) { + if id == nil { + return "", nil + } + theme, err := d.ThemeByID(ctx, *id) + if errors.Is(err, db.ErrNotFound) { + return "", nil + } + if err != nil { + return "", err + } + return ThemeURL(theme), nil +} + const ( ThemePrefix = "/-/theme/" themeSuffix = ".css" From c493498cd613c6e3ea5765d621fd641776acffd5 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:29 +0900 Subject: [PATCH 208/428] resolve a same-site include --- internal/callbacks/callbacks.go | 55 ++++++++++++++++++--- internal/callbacks/callbacks_test.go | 72 ++++++++++++++++++++++++++++ internal/i18n/locales/zh-hans.json | 1 + 3 files changed, 122 insertions(+), 6 deletions(-) diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go index 073823a9..85d7932f 100644 --- a/internal/callbacks/callbacks.go +++ b/internal/callbacks/callbacks.go @@ -33,12 +33,15 @@ type Repository interface { RenderModule(pc *page.Context, name string, params map[string]string, body string) (string, error) RenderUser(username string, avatar bool) (string, error) PageInfo(refs []string) ([]renderer.PartialPageInfo, error) + + // IncludeSources answers one page per ref, in the order it was asked. IncludeSources(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) } type Callbacks struct { loc *i18n.Localizer repo Repository + site string vars *page.Vars pageCtx *page.Context level int @@ -51,6 +54,8 @@ var _ renderer.Callbacks = (*Callbacks)(nil) // it every such name is left standing. func (c *Callbacks) SetPageVars(vars *page.Vars) { c.vars = vars } +func (c *Callbacks) SetSite(slug string) { c.site = slug } + // SetContext hands the modules the page they are rendering into, which is what // lets one of them redirect the whole request or set the description. func (c *Callbacks) SetContext(pc *page.Context) { c.pageCtx = pc } @@ -145,7 +150,8 @@ func (c *Callbacks) IncludePages(refs []renderer.IncludeRef) ([]renderer.Fetched if c.level <= 0 { out := make([]renderer.FetchedPage, 0, len(refs)) for _, ref := range refs { - c.includeErrors[wikidot.Normalize(ref.FullName)] = true + name, _ := c.localName(ref.FullName) + c.includeErrors[wikidot.Normalize(name)] = true out = append(out, renderer.FetchedPage{FullName: ref.FullName}) } return out, nil @@ -153,10 +159,29 @@ func (c *Callbacks) IncludePages(refs []renderer.IncludeRef) ([]renderer.Fetched if c.repo == nil { return nil, ErrNoRepository } - fetched, err := c.repo.IncludeSources(refs) + + local := make([]renderer.IncludeRef, 0, len(refs)) + asked := make([]string, 0, len(refs)) + for _, ref := range refs { + name, ok := c.localName(ref.FullName) + if !ok { + continue + } + asked = append(asked, ref.FullName) + ref.FullName = name + local = append(local, ref) + } + fetched, err := c.repo.IncludeSources(local) if err != nil { return nil, err } + // ftml pairs the answer with the request by name, so a ref that named this + // wiki has to go back carrying the prefix it arrived with. + for i := range fetched { + if i < len(asked) { + fetched[i].FullName = asked[i] + } + } // %%this|x%% in an included page names the including page, so the pass runs // here, on the way in, rather than wherever the include came from. for i := range fetched { @@ -169,12 +194,30 @@ func (c *Callbacks) IncludePages(refs []renderer.IncludeRef) ([]renderer.Fetched return fetched, nil } +// A ref naming this very wiki means the same as one naming no wiki. One naming +// another is turned away, since looking it up here reads the site as a category. +func (c *Callbacks) localName(fullName string) (string, bool) { + rest, prefixed := strings.CutPrefix(fullName, ":") + if !prefixed { + return fullName, true + } + slug, name, found := strings.Cut(rest, ":") + if !found || c.site == "" || !strings.EqualFold(slug, c.site) { + return "", false + } + return name, true +} + func (c *Callbacks) NoSuchInclude(fullName string) (string, error) { - if c.includeErrors[wikidot.Normalize(fullName)] { - return `[[div class="error-block"]]` + c.text("include-loop", "name", fullName) + `[[/div]]`, nil + name, ok := c.localName(fullName) + if !ok { + return `[[div class="error-block"]]` + c.text("include-off-site", "name", fullName) + `[[/div]]`, nil + } + if c.includeErrors[wikidot.Normalize(name)] { + return `[[div class="error-block"]]` + c.text("include-loop", "name", name) + `[[/div]]`, nil } - return `[[div class="error-block"]]` + c.text("include-missing", "name", fullName) + - ` ([[a href="/` + fullName + `/edit/true" target="_blank"]]` + c.text("include-create") + `[[/a]])[[/div]]`, nil + return `[[div class="error-block"]]` + c.text("include-missing", "name", name) + + ` ([[a href="/` + name + `/edit/true" target="_blank"]]` + c.text("include-create") + `[[/a]])[[/div]]`, nil } func (c *Callbacks) NextIncludeLevel() (bool, error) { diff --git a/internal/callbacks/callbacks_test.go b/internal/callbacks/callbacks_test.go index 0c886ab7..86a50e10 100644 --- a/internal/callbacks/callbacks_test.go +++ b/internal/callbacks/callbacks_test.go @@ -389,3 +389,75 @@ func TestIncludePagesWithoutPageVarsKeepsThisVars(t *testing.T) { t.Errorf("Content = %q, want %q", *got[0].Content, want) } } + +func TestIncludePagesTakesARefNamingThisWikiAsLocal(t *testing.T) { + repo := &fakeRepo{} + c := newCallbacks(t, repo) + c.SetSite("lostmedia") + + got, err := c.IncludePages([]renderer.IncludeRef{{FullName: ":lostmedia:component:box"}}) + if err != nil { + t.Fatalf("IncludePages() err = %v, want nil", err) + } + if len(repo.includeSeen) != 1 { + t.Fatalf("len(refs reaching the repository) = %d, want 1", len(repo.includeSeen)) + } + if repo.includeSeen[0].FullName != "component:box" { + t.Errorf("ref reaching the repository = %q, want %q", repo.includeSeen[0].FullName, "component:box") + } + if len(got) != 1 { + t.Fatalf("len(IncludePages()) = %d, want 1", len(got)) + } + if got[0].FullName != ":lostmedia:component:box" { + t.Errorf("FullName going back = %q, want %q", got[0].FullName, ":lostmedia:component:box") + } +} + +func TestNoSuchIncludeTakesARefNamingThisWikiAsLocal(t *testing.T) { + c := newCallbacks(t, &fakeRepo{}) + c.SetSite("lostmedia") + + got, err := c.NoSuchInclude(":lostmedia:missing") + if err != nil { + t.Fatalf("NoSuchInclude() err = %v, want nil", err) + } + want := `[[div class="error-block"]]插入的页面 "missing" 不存在 ([[a href="/missing/edit/true" target="_blank"]]立刻创建[[/a]])[[/div]]` + if got != want { + t.Errorf("NoSuchInclude() = %q, want %q", got, want) + } +} + +func TestIncludePagesDoesNotLookUpAnOffSiteRef(t *testing.T) { + repo := &fakeRepo{} + c := newCallbacks(t, repo) + + got, err := c.IncludePages([]renderer.IncludeRef{ + {FullName: ":other:component:box"}, + {FullName: "component:box"}, + }) + if err != nil { + t.Fatalf("IncludePages() err = %v, want nil", err) + } + if len(repo.includeSeen) != 1 { + t.Fatalf("len(refs reaching the repository) = %d, want 1", len(repo.includeSeen)) + } + if repo.includeSeen[0].FullName != "component:box" { + t.Errorf("ref reaching the repository = %q, want %q", repo.includeSeen[0].FullName, "component:box") + } + if len(got) != 1 { + t.Errorf("len(IncludePages()) = %d, want 1", len(got)) + } +} + +func TestNoSuchIncludeReportsAnOffSiteRef(t *testing.T) { + c := newCallbacks(t, &fakeRepo{}) + + got, err := c.NoSuchInclude(":other:component:box") + if err != nil { + t.Fatalf("NoSuchInclude() err = %v, want nil", err) + } + want := `[[div class="error-block"]]插入的页面 ":other:component:box" 在别的站点上，暂不支持跨站插入[[/div]]` + if got != want { + t.Errorf("NoSuchInclude() = %q, want %q", got, want) + } +} diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index a286eb14..40d11aee 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -14,6 +14,7 @@ "include-create": "立刻创建", "include-loop": "插入的页面 \"{name}\" 导致了无限包含循环", "include-missing": "插入的页面 \"{name}\" 不存在", + "include-off-site": "插入的页面 \"{name}\" 在别的站点上，暂不支持跨站插入", "module-applicationform-body": "正文", "module-applicationform-login": "请先登录后再提交。", "module-applicationform-subject": "标题", From 4e7302fa8de48697718109db0ae38a591208001d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:29 +0900 Subject: [PATCH 209/428] pass the site slug to ftml --- cmd/pwikit/render.go | 4 +++- internal/pagerender/pagerender.go | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/cmd/pwikit/render.go b/cmd/pwikit/render.go index f1d5f41e..76efe434 100644 --- a/cmd/pwikit/render.go +++ b/cmd/pwikit/render.go @@ -35,6 +35,7 @@ func render(args []string) error { pageName := fs.String("page", "page", "page name reported to ftml") category := fs.String("category", "_default", "page category reported to ftml") domain := fs.String("domain", "example.org", "site domain reported to ftml") + siteSlug := fs.String("site", "", "site slug an include may name to mean this wiki") modules := fs.String("modules", "real", "how to answer modules: real, stub") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { @@ -91,6 +92,7 @@ func render(args []string) error { } cb := callbacks.New(bundle.Localizer(i18n.DefaultLanguage), store) + cb.SetSite(*siteSlug) cb.SetPageVars(vars) if article != nil { cb.SetContext(page.NewContext(article, article, nil, nil)) @@ -103,7 +105,7 @@ func render(args []string) error { handler = recorder } - info := renderer.PageInfo{Page: *pageName, Category: *category, Domain: *domain, Title: *pageName} + info := renderer.PageInfo{Page: *pageName, Category: *category, Site: *siteSlug, Domain: *domain, Title: *pageName} if err := emit(ctx, engine, *output, source, info, handler, renderer.Mode(*mode)); err != nil { return err } diff --git a/internal/pagerender/pagerender.go b/internal/pagerender/pagerender.go index 8c5f2e1d..eebab69a 100644 --- a/internal/pagerender/pagerender.go +++ b/internal/pagerender/pagerender.go @@ -90,6 +90,9 @@ func (e *Env) PageInfo(source *db.Article) (renderer.PageInfo, error) { func (e *Env) Callbacks(vars *page.Vars, pc *page.Context) *callbacks.Callbacks { cb := callbacks.New(e.loc, e.store()) + if e.site != nil { + cb.SetSite(e.site.Slug) + } cb.SetPageVars(vars) cb.SetContext(pc) return cb From 548a0c136f4f8c7396fc0ba538940476ed88cd07 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:38 +0900 Subject: [PATCH 210/428] answer the profile and its form --- internal/shell/shell.go | 86 ++++++++++++++++++++-- internal/shell/templates/profile.html | 19 ++++- internal/shell/templates/profile_edit.html | 65 ++++++++++++++++ internal/shell/templates/profile_feed.html | 22 ++++++ internal/shell/templates/system.html | 3 +- 5 files changed, 187 insertions(+), 8 deletions(-) create mode 100644 internal/shell/templates/profile_edit.html create mode 100644 internal/shell/templates/profile_feed.html diff --git a/internal/shell/shell.go b/internal/shell/shell.go index aba86110..203c8444 100644 --- a/internal/shell/shell.go +++ b/internal/shell/shell.go @@ -30,6 +30,7 @@ var tmpl = template.Must(template.New("shell").Funcs(template.FuncMap{ "esc": escape.HTML, "escjs": escape.JS, "sub": func(a, b int) int { return a - b }, + "feed": newFeed, }).ParseFS(files, "templates/*.html")) type Breadcrumb struct { @@ -176,6 +177,7 @@ func (v view) date() string { // article sits in. type System struct { Title string + ThemeURL string Before string Heading string BodyClass string @@ -201,6 +203,60 @@ type Profile struct { Bio string BioHTML string JoinedAt time.Time + + Roles []ProfileRoles + Edits ProfileFeed + Posts ProfileFeed +} + +type ProfileRoles struct { + Site string + URL string + Names string +} + +type ProfileFeed struct { + Items []ProfileItem + Pagination string +} + +type ProfileFlag struct { + ID string + Desc string +} + +type ProfileItem struct { + URL string + Title string + Site string + At time.Time + Flags []ProfileFlag + Comment string +} + +type feed struct { + View profileView + Label string + Feed ProfileFeed + Empty string +} + +func newFeed(v profileView, label string, f ProfileFeed, empty string) feed { + return feed{View: v, Label: label, Feed: f, Empty: empty} +} + +type ProfileEdit struct { + AuthIcon string + DisplayName string + Avatar string + ProfileURL string + + FullName string + Bio string + + CSRF string + Error string + Saved bool } func (r *Renderer) SystemPage(w io.Writer, d System) error { @@ -211,6 +267,19 @@ func (r *Renderer) Profile(d Profile) (string, error) { return r.execute("profile.html", profileView{Profile: d, r: r}) } +func (r *Renderer) ProfileEdit(d ProfileEdit) (string, error) { + return r.execute("profile_edit.html", profileEditView{ProfileEdit: d, r: r}) +} + +type profileEditView struct { + ProfileEdit + r *Renderer +} + +func (v profileEditView) T(id string, args ...any) string { return v.r.loc.T(id, args...) } +func (v profileEditView) Asset(name string) string { return v.r.assets.URL(name) } +func (v profileEditView) Initial() string { return initial(v.DisplayName) } + type systemView struct { System r *Renderer @@ -228,21 +297,26 @@ type profileView struct { func (v profileView) T(id string, args ...any) string { return v.r.loc.T(id, args...) } func (v profileView) Asset(name string) string { return v.r.assets.URL(name) } +func (v profileView) Initial() string { return initial(v.DisplayName) } + // The letter the avatar box falls back to is the display name's first // character rather than its first byte. -func (v profileView) Initial() string { - for _, r := range v.DisplayName { +func initial(name string) string { + for _, r := range name { return strings.ToUpper(string(r)) } return "" } -func (v profileView) JoinedUnix() string { - return strconv.FormatInt(v.JoinedAt.Unix(), 10) +func (v profileView) ODate(at time.Time) string { + return `` + + escape.HTML(v.date(at)) + `` } -func (v profileView) Joined() string { - at := v.JoinedAt.In(v.r.tz) +func (v profileView) date(at time.Time) string { + at = at.In(v.r.tz) return v.T("profile.date-format", "year", strconv.Itoa(at.Year()), "month", strconv.Itoa(int(at.Month())), diff --git a/internal/shell/templates/profile.html b/internal/shell/templates/profile.html index e46b40b3..4d188908 100644 --- a/internal/shell/templates/profile.html +++ b/internal/shell/templates/profile.html @@ -61,10 +61,27 @@

{{.T "profile.title"}}

{{end}}
{{.T "profile.joined"}}
- {{esc .Joined}} + {{.ODate .JoinedAt}}
+ {{if .Roles}} +
+ {{.T "profile.site-roles"}} + +
+ {{end}} + + {{template "profile_feed.html" (feed $ (.T "profile.edits") .Edits (.T "profile.no-edits"))}} + {{template "profile_feed.html" (feed $ (.T "profile.posts") .Posts (.T "profile.no-posts"))}} +
diff --git a/internal/shell/templates/profile_edit.html b/internal/shell/templates/profile_edit.html new file mode 100644 index 00000000..5889bd46 --- /dev/null +++ b/internal/shell/templates/profile_edit.html @@ -0,0 +1,65 @@ +{{define "profile_edit.html"}} +
+
+ +
+ + {{if .AuthIcon}}ProjectWikit{{else}}ProjectWikit{{end}} + ProjectWikit + + + {{.T "profile.user"}}/{{esc .DisplayName}} +
+
+ +
+ +
+
{{.T "profile.personal"}}/{{.T "profile.user"}}/{{.T "profile.edit"}}
+

{{.T "profile.edit"}}

+
+ +
+ + + {{if .Error}} +
+ ERR + {{esc .Error}} +
+ {{end}} + {{if .Saved}} +
{{.T "profile.saved"}}
+ {{end}} + +
+
+ + +
+
+ + +
+
+ {{.T "profile.avatar"}} +
+ {{if .Avatar}}{{esc .DisplayName}}{{else}}{{esc .Initial}}{{end}} + +
+
+
+ + + +
+ {{.T "profile.back"}} +
+ +
+ +
+ +
+
+{{end}} diff --git a/internal/shell/templates/profile_feed.html b/internal/shell/templates/profile_feed.html new file mode 100644 index 00000000..93ee5662 --- /dev/null +++ b/internal/shell/templates/profile_feed.html @@ -0,0 +1,22 @@ +{{define "profile_feed.html"}} +
+ {{esc .Label}} + {{if .Feed.Items}} +
    + {{range .Feed.Items}} +
  • + + {{esc .Title}} + {{if .Flags}}{{range .Flags}}{{esc .ID}}{{end}}{{end}} + + {{$.View.ODate .At}} + {{esc .Site}}{{if .Comment}}·{{esc .Comment}}{{end}} +
    • + {{end}} +
+ {{.Feed.Pagination}} + {{else}} +
{{esc .Empty}}
+ {{end}} +
+{{end}} diff --git a/internal/shell/templates/system.html b/internal/shell/templates/system.html index c64d25c5..9664bdc3 100644 --- a/internal/shell/templates/system.html +++ b/internal/shell/templates/system.html @@ -16,7 +16,8 @@ - + {{if .ThemeURL}} +{{end}} From b28d7ddd2a68748431472b313d6701775e4f1f71 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:38 +0900 Subject: [PATCH 211/428] style the profile pages --- static/wikit-shell.css | 109 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 106 insertions(+), 3 deletions(-) diff --git a/static/wikit-shell.css b/static/wikit-shell.css index 6df9b769..1c472e34 100644 --- a/static/wikit-shell.css +++ b/static/wikit-shell.css @@ -166,6 +166,12 @@ body.wikit-page .system-content .content .btn-ghost:hover { border-color: var(-- } .wikit-scope .form-row + .form-row { border-top: 1px solid var(--rule); } .wikit-scope .form-row .label { line-height: 1; } +body.wikit-page .system-content .content form label.label { + font-size: 11px; + font-weight: 500; + margin-bottom: 0; +} + .wikit-scope .form-row input, .wikit-scope .form-row textarea { border: none; @@ -370,9 +376,7 @@ body.wikit-page .system-content .content .btn-ghost:hover { border-color: var(-- grid-template-columns: 88px 1fr auto; gap: 20px; align-items: center; - padding-bottom: 24px; - border-bottom: 1px solid var(--rule); - margin-bottom: 24px; + margin-bottom: 28px; } .wikit-scope .profile-head .avatar-big { width: 88px; height: 88px; @@ -399,6 +403,103 @@ body.wikit-page .system-content .content .btn-ghost:hover { border-color: var(-- } .wikit-scope .profile-head .actions { display: flex; gap: 8px; } +.wikit-scope .profile-form { max-width: 560px; display: flex; flex-direction: column; gap: 18px; } +.wikit-scope .form-row .hint { margin-left: 8px; text-transform: none; letter-spacing: 0; } +.wikit-scope .form-row textarea { resize: vertical; line-height: 1.6; } +.wikit-scope .avatar-row .avatar-pick { display: flex; align-items: center; gap: 14px; } +.wikit-scope .avatar-row .avatar-now { + width: 44px; + height: 44px; + flex: none; + border: 1px solid var(--rule); + border-radius: 4px; + background: var(--well); + display: flex; + align-items: center; + justify-content: center; + font-family: var(--font-mono); + font-size: 16px; + color: var(--muted); + overflow: hidden; +} +.wikit-scope .avatar-row .avatar-now img { width: 100%; height: 100%; object-fit: cover; } +.wikit-scope .avatar-row input[type=file] { font-size: 13px; color: var(--muted); } + +.wikit-scope .profile-section { margin-top: 36px; } +.wikit-scope .feed .what-line { display: flex; align-items: baseline; gap: 10px; min-width: 0; } +.wikit-scope .feed .flags { + display: inline-flex; + gap: 4px; + font-family: var(--font-mono); + font-size: 11px; + color: var(--muted); +} +.wikit-scope .feed .from .sep { margin: 0 7px; } +.wikit-scope .feed.roles .when { font-family: inherit; font-size: 13px; color: var(--ink); } +.wikit-scope .profile-section .pager { + margin: 16px 0 0; + font-family: var(--font-mono); + font-size: 11px; + color: var(--muted); + text-align: left; + display: flex; + align-items: center; + gap: 2px; + flex-wrap: wrap; +} +.wikit-scope .profile-section .pager .pager-no { padding: 0 12px 0 0; } +.wikit-scope .profile-section .pager .dots { padding: 0 4px; margin: 0; } +.wikit-scope .profile-section .pager a { + padding: 3px 8px; + margin: 0; + border: 1px solid var(--rule); + border-radius: var(--rad-sm); + color: var(--muted); + text-decoration: none; +} +.wikit-scope .profile-section .pager a:hover { border-color: var(--ink); color: var(--ink); } +.wikit-scope .profile-section .pager .current { + padding: 3px 8px; + margin: 0; + border: 1px solid var(--ink); + border-radius: var(--rad-sm); + background: var(--ink); + color: var(--paper); + font-weight: 500; +} +.wikit-scope .profile-section .label { display: block; margin-bottom: 6px; } +.wikit-scope .feed { list-style: none; margin: 0; padding: 0; } +.wikit-scope .feed li { + display: grid; + grid-template-columns: 1fr auto; + gap: 3px 16px; + align-items: baseline; + padding: 12px 0; + border-top: 1px solid var(--rule); +} +.wikit-scope .feed li:last-child { border-bottom: 1px solid var(--rule); } +.wikit-scope .feed .what { color: var(--ink); text-decoration: none; } +.wikit-scope .feed .what:hover { text-decoration: underline; } +.wikit-scope .feed .when { + font-family: var(--font-mono); + font-size: 11px; + color: var(--muted); + white-space: nowrap; +} +.wikit-scope .feed .from { + grid-column: 1 / -1; + font-size: 12px; + color: var(--muted); +} +.wikit-scope .feed .from .sep { margin: 0 7px; } +.wikit-scope .profile-section .empty { + padding: 12px 0; + border-top: 1px solid var(--rule); + border-bottom: 1px solid var(--rule); + font-size: 13px; + color: var(--muted); +} + @media (max-width: 720px) { .wikit-scope .profile-head { grid-template-columns: 60px 1fr; @@ -426,5 +527,7 @@ body.wikit-page .system-content .content .btn-ghost:hover { border-color: var(-- .wikit-scope .dl dt { padding-bottom: 2px; border-top: 1px solid var(--rule); } .wikit-scope .dl dd { padding-top: 2px; padding-bottom: 14px; border-top: none; } .wikit-scope .app-header .path { display: none; } + .wikit-scope .feed li { grid-template-columns: 1fr; } + .wikit-scope .feed .when { grid-row: 3; } } From 4db1687179a55ddee9537e39669baca564bed76c Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:38 +0900 Subject: [PATCH 212/428] add the profile strings --- internal/i18n/locales/zh-hans.json | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 40d11aee..b117cb79 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -145,17 +145,29 @@ "module-wantedpages-source": "源页面", "profile.account-state": "账号状态", "profile.account-type": "账号类型", + "profile.avatar": "头像", + "profile.back": "返回我的资料页", "profile.bio": "个人简介", + "profile.bio-hint": "支持 Wiki 语法", "profile.block": "拉黑", "profile.bot": "机器人", "profile.date-format": "{year} 年 {month} 月 {day} 日", "profile.date-format-js": "%b%e日, %Y年 %H:%M", "profile.edit": "编辑资料", + "profile.edits": "编辑履历", + "profile.error-avatar-size": "头像文件太大，请压到 5 MB 以内。", + "profile.error-avatar-type": "头像必须是 PNG、JPEG、GIF 或 WebP 图片。", "profile.imported": "从 Wikidot 平台迁移而来的非活跃用户", "profile.joined": "加入时间", "profile.name": "姓名", + "profile.no-edits": "还没有编辑过任何页面。", + "profile.no-posts": "还没有发过帖。", "profile.personal": "个人", + "profile.posts": "发帖履历", + "profile.save": "保存", + "profile.saved": "已保存", "profile.send-message": "发私信", + "profile.site-roles": "站点身分组", "profile.title": "个人资料", "profile.unblock": "取消拉黑", "profile.user": "用户", From 86df7f2aef64610dcb30afb4ce3d2cd3150250ff Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:46 +0900 Subject: [PATCH 213/428] answer the profile's history and its roles --- internal/userpage/userpage.go | 207 +++++++++++++++++++++++++++++++++- 1 file changed, 201 insertions(+), 6 deletions(-) diff --git a/internal/userpage/userpage.go b/internal/userpage/userpage.go index 0fba72c1..aee5dd66 100644 --- a/internal/userpage/userpage.go +++ b/internal/userpage/userpage.go @@ -11,12 +11,17 @@ import ( "time" "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/changelog" "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/escape" "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/listpages" "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/pagerender" + "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/printuser" "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/roles" "github.com/WikitTeam/ProjectWikit/internal/shell" "github.com/WikitTeam/ProjectWikit/internal/site" @@ -36,9 +41,17 @@ type Deps struct { Icons roles.IconLoader Assets *static.Assets TimeZone *time.Location + Files string Log *slog.Logger } +func (d Deps) logger() *slog.Logger { + if d.Log == nil { + return slog.Default() + } + return d.Log +} + type Handler struct { deps Deps } @@ -52,12 +65,7 @@ func New(d Deps) *Handler { return &Handler{deps: d} } -func (h *Handler) log() *slog.Logger { - if h.deps.Log == nil { - return slog.Default() - } - return h.deps.Log -} +func (h *Handler) log() *slog.Logger { return h.deps.logger() } func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodGet && r.Method != http.MethodHead { @@ -116,9 +124,15 @@ func (h *Handler) page(r *http.Request, name string) (string, error) { return "", err } + theme, err := site.ThemeURLByID(ctx, h.deps.DB, current.SystemThemeID) + if err != nil { + return "", err + } + var out strings.Builder err = render.SystemPage(&out, shell.System{ Title: data.DisplayName, + ThemeURL: theme, BodyClass: "wikit-page", Content: content, }) @@ -195,6 +209,16 @@ func (h *Handler) data(r *http.Request, loc *i18n.Localizer, current *db.Site, } data.IsSelf = viewer != nil && viewer.ID == profile.ID + if data.Roles, err = h.roles(ctx, current, profile); err != nil { + return shell.Profile{}, err + } + if data.Edits, err = h.edits(r, loc, current, profile, viewer); err != nil { + return shell.Profile{}, err + } + if data.Posts, err = h.posts(r, loc, current, profile, viewer); err != nil { + return shell.Profile{}, err + } + if profile.Bio != "" { html, err := h.bio(r, loc, current, profile, viewer) if err != nil { @@ -205,6 +229,177 @@ func (h *Handler) data(r *http.Request, loc *i18n.Localizer, current *db.Site, return data, nil } +const historyPerPage = 10 + +const ( + editsParam = "edits" + postsParam = "posts" +) + +// The history is read through the viewer's permissions rather than the profile +// owner's, so a page one visitor may not see stays off the other's profile. +func (h *Handler) edits(r *http.Request, loc *i18n.Localizer, site *db.Site, + profile *db.Profile, viewer *db.User) (shell.ProfileFeed, error) { + + ctx := r.Context() + hidden, err := repo.HiddenCategories(ctx, h.deps.DB, viewer) + if err != nil { + return shell.ProfileFeed{}, err + } + filter := db.SiteChangeFilter{ + Hidden: hidden, + HasUser: true, + UserIDs: []int64{profile.ID}, + } + total, err := h.deps.DB.SiteChangeCount(ctx, filter) + if err != nil { + return shell.ProfileFeed{}, err + } + page, pages := pageOf(r, editsParam, total) + changes, err := h.deps.DB.SiteChanges(ctx, filter, (page-1)*historyPerPage, historyPerPage) + if err != nil { + return shell.ProfileFeed{}, err + } + + feed := shell.ProfileFeed{ + Items: make([]shell.ProfileItem, 0, len(changes)), + Pagination: listpages.PaginationLinks(loc, pageHref(r, editsParam), page, pages), + } + users := func(ids []int64) ([]db.User, error) { return h.deps.DB.UsersByIDs(ctx, ids) } + for _, c := range changes { + entry, err := changelog.Of(loc, users, c) + if err != nil { + return shell.ProfileFeed{}, err + } + article := db.Article{Category: c.ArticleCategory, Name: c.ArticleName, Title: c.ArticleTitle} + feed.Items = append(feed.Items, shell.ProfileItem{ + URL: "/" + article.FullName(), + Title: article.DisplayName(), + Site: site.Title, + At: c.CreatedAt, + Flags: profileFlags(entry.Flags), + Comment: entry.Comment, + }) + } + return feed, nil +} + +func profileFlags(flags []changelog.Flag) []shell.ProfileFlag { + out := make([]shell.ProfileFlag, 0, len(flags)) + for _, f := range flags { + out = append(out, shell.ProfileFlag{ID: f.ID, Desc: f.Desc}) + } + return out +} + +func (h *Handler) posts(r *http.Request, loc *i18n.Localizer, site *db.Site, + profile *db.Profile, viewer *db.User) (shell.ProfileFeed, error) { + + ctx := r.Context() + resolver := repo.NewPerms(ctx, h.deps.DB) + subject, err := resolver.Subject(viewer, time.Now()) + if err != nil { + return shell.ProfileFeed{}, err + } + + var ids []int64 + var comments bool + if perms.Resolve(subject, nil).Has(perms.ViewForumCategories) { + categories, err := h.deps.DB.ForumCategories(ctx) + if err != nil { + return shell.ProfileFeed{}, err + } + for _, c := range categories { + ids = append(ids, c.ID) + comments = comments || c.IsForComments + } + } + + total, err := h.deps.DB.UserPostCount(ctx, profile.ID, ids, comments) + if err != nil { + return shell.ProfileFeed{}, err + } + page, pages := pageOf(r, postsParam, total) + posts, err := h.deps.DB.UserPosts(ctx, profile.ID, ids, comments, + (page-1)*historyPerPage, historyPerPage) + if err != nil { + return shell.ProfileFeed{}, err + } + + feed := shell.ProfileFeed{ + Items: make([]shell.ProfileItem, 0, len(posts)), + Pagination: listpages.PaginationLinks(loc, pageHref(r, postsParam), page, pages), + } + for _, p := range posts { + feed.Items = append(feed.Items, shell.ProfileItem{ + URL: threadURL(p.ThreadID, threadName(p)) + "#post-" + strconv.FormatInt(p.ID, 10), + Title: threadName(p), + Site: site.Title, + At: p.CreatedAt, + }) + } + return feed, nil +} + +func (h *Handler) roles(ctx context.Context, site *db.Site, profile *db.Profile) ([]shell.ProfileRoles, error) { + rs, err := h.deps.DB.RolesByUser(ctx, profile.ID) + if err != nil { + return nil, err + } + names := make([]string, 0, len(rs)) + for _, role := range rs { + names = append(names, firstNonEmpty(role.Name, role.Slug)) + } + if len(names) == 0 { + return nil, nil + } + return []shell.ProfileRoles{{ + Site: site.Title, + URL: "/", + Names: strings.Join(names, ", "), + }}, nil +} + +func pageOf(r *http.Request, key string, total int) (page, pages int) { + pages = max(1, (total+historyPerPage-1)/historyPerPage) + page, err := strconv.Atoi(r.URL.Query().Get(key)) + if err != nil || page < 1 { + page = 1 + } + return min(page, pages), pages +} + +// The other section's page has to survive, so the link is the request's own +// query with one key replaced. +func pageHref(r *http.Request, key string) func(int) string { + return func(p int) string { + q := r.URL.Query() + q.Set(key, strconv.Itoa(p)) + return escape.HTML(r.URL.EscapedPath() + "?" + q.Encode()) + } +} + +// A comment thread carries the name the article was created with, so the +// article's own title is the one a reader recognises. +func threadName(p db.UserPost) string { + if p.ThreadCategoryID == nil && p.ArticleName != nil { + article := db.Article{Category: deref(p.ArticleCategory), Name: deref(p.ArticleName), Title: deref(p.ArticleTitle)} + return article.DisplayName() + } + return p.ThreadName +} + +func threadURL(id int64, name string) string { + return "/forum/t-" + strconv.FormatInt(id, 10) + "/" + wikidot.Normalize(name) +} + +func deref(s *string) string { + if s == nil { + return "" + } + return *s +} + // The two states that outrank every role are answered first, the way the chip // beside a name answers them. func (h *Handler) titles(ctx context.Context, loc *i18n.Localizer, profile *db.Profile) ([]string, error) { From 60152836becde1bba2e5b891a4e1b0184b3ff993 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:46 +0900 Subject: [PATCH 214/428] answer the profile form --- internal/userpage/edit.go | 235 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 235 insertions(+) create mode 100644 internal/userpage/edit.go diff --git a/internal/userpage/edit.go b/internal/userpage/edit.go new file mode 100644 index 00000000..5092f478 --- /dev/null +++ b/internal/userpage/edit.go @@ -0,0 +1,235 @@ +package userpage + +import ( + "crypto/rand" + "encoding/hex" + "errors" + "io" + "net/http" + "net/url" + "os" + "path/filepath" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/shell" + "github.com/WikitTeam/ProjectWikit/internal/site" +) + +const EditPrefix = "/-/profile/edit" + +const loginPath = "/-/login" + +const ( + maxAvatarBytes = 5 << 20 + avatarMemory = 1 << 20 + avatarDirectory = "-/users" +) + +// The extension comes from what the bytes are rather than from what the upload +// called itself, so a name ending in .png cannot decide how the file is served. +var avatarTypes = map[string]string{ + "image/png": ".png", + "image/jpeg": ".jpg", + "image/gif": ".gif", + "image/webp": ".webp", +} + +type EditHandler struct { + deps Deps +} + +var _ http.Handler = (*EditHandler)(nil) + +func NewEdit(d Deps) *EditHandler { return &EditHandler{deps: d} } + +func (h *EditHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + if r.Method != http.MethodGet && r.Method != http.MethodHead && r.Method != http.MethodPost { + w.Header().Set("Allow", "GET, HEAD, POST") + http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) + return + } + + ctx := r.Context() + current := site.FromContext(ctx) + viewer := auth.FromContext(ctx) + if current == nil || viewer == nil { + redirect(w, loginPath+"?to="+url.QueryEscape(EditPrefix), http.StatusFound) + return + } + loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) + + token, isNew := csrf.Token(r) + if isNew { + http.SetCookie(w, &http.Cookie{ + Name: csrf.CookieName, Value: token, Path: "/", + Secure: r.TLS != nil, SameSite: http.SameSiteLaxMode, + }) + } + + var problem string + if r.Method == http.MethodPost { + var err error + problem, err = h.handle(w, r, loc, current, viewer) + switch { + case errors.Is(err, errBadToken): + http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden) + return + case err != nil: + h.deps.logger().Error("save profile", "user", viewer.ID, "err", err) + http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) + return + case problem == "": + redirect(w, EditPrefix+"?saved=1", http.StatusSeeOther) + return + } + } + + body, err := h.page(r, loc, current, viewer, token, problem) + if err != nil { + h.deps.logger().Error("render profile form", "user", viewer.ID, "err", err) + http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) + return + } + w.Header().Set("Content-Type", "text/html; charset=utf-8") + w.WriteHeader(http.StatusOK) + if r.Method != http.MethodHead { + _, _ = w.Write([]byte(body)) + } +} + +// Not http.Redirect, which writes an HTML body for GET where this response has +// none. +func redirect(w http.ResponseWriter, location string, status int) { + w.Header().Set("Location", location) + w.Header().Set("Content-Type", "text/html; charset=utf-8") + w.Header().Set("Content-Length", "0") + w.WriteHeader(status) +} + +var errBadToken = errors.New("userpage: the form carries no valid csrf token") + +func (h *EditHandler) handle(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, + current *db.Site, viewer *db.User) (string, error) { + + if r.ContentLength > maxAvatarBytes { + return loc.T("profile.error-avatar-size"), nil + } + r.Body = http.MaxBytesReader(w, r.Body, maxAvatarBytes) + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return "", errBadToken + } + if err := r.ParseMultipartForm(avatarMemory); err != nil { + return loc.T("profile.error-avatar-size"), nil + } + + avatar, problem, err := h.avatar(r, loc, viewer) + if problem != "" || err != nil { + return problem, err + } + + first, last := splitFullName(r.PostFormValue("full_name")) + bio := strings.TrimSpace(r.PostFormValue("bio")) + return "", h.deps.DB.UpdateProfile(r.Context(), viewer.ID, first, last, bio, avatar) +} + +func (h *EditHandler) avatar(r *http.Request, loc *i18n.Localizer, viewer *db.User) (*string, string, error) { + file, _, err := r.FormFile("avatar") + if errors.Is(err, http.ErrMissingFile) { + return nil, "", nil + } + if err != nil { + return nil, loc.T("profile.error-avatar-type"), nil + } + defer file.Close() + + data, err := io.ReadAll(io.LimitReader(file, maxAvatarBytes+1)) + if err != nil { + return nil, "", err + } + if len(data) == 0 { + return nil, "", nil + } + if len(data) > maxAvatarBytes { + return nil, loc.T("profile.error-avatar-size"), nil + } + ext, ok := avatarTypes[mediaType(http.DetectContentType(data))] + if !ok { + return nil, loc.T("profile.error-avatar-type"), nil + } + + tag := make([]byte, 8) + if _, err := rand.Read(tag); err != nil { + return nil, "", err + } + stored := avatarDirectory + "/" + strconv.FormatInt(viewer.ID, 10) + "-" + hex.EncodeToString(tag) + ext + + full := filepath.Join(h.deps.Files, filepath.FromSlash(stored)) + if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil { + return nil, "", err + } + if err := os.WriteFile(full, data, 0o644); err != nil { + return nil, "", err + } + return &stored, "", nil +} + +func mediaType(header string) string { + kind, _, _ := strings.Cut(header, ";") + return strings.TrimSpace(kind) +} + +func splitFullName(value string) (first, last string) { + value = strings.TrimSpace(value) + if value == "" { + return "", "" + } + if i := strings.LastIndex(value, " "); i >= 0 { + return value[:i], value[i+1:] + } + return value, "" +} + +func (h *EditHandler) page(r *http.Request, loc *i18n.Localizer, current *db.Site, + viewer *db.User, token, problem string) (string, error) { + + profile, err := h.deps.DB.ProfileByID(r.Context(), viewer.ID) + if err != nil { + return "", err + } + + data := shell.ProfileEdit{ + AuthIcon: authIcon(current), + DisplayName: displayName(profile), + Avatar: avatar(profile), + ProfileURL: Prefix + url.PathEscape(profile.Username), + FullName: strings.TrimSpace(profile.FirstName + " " + profile.LastName), + Bio: profile.Bio, + CSRF: token, + Error: problem, + Saved: problem == "" && r.URL.Query().Get("saved") == "1", + } + + render := shell.New(loc, h.deps.Assets, h.deps.TimeZone) + content, err := render.ProfileEdit(data) + if err != nil { + return "", err + } + theme, err := site.ThemeURLByID(r.Context(), h.deps.DB, current.SystemThemeID) + if err != nil { + return "", err + } + + var out strings.Builder + err = render.SystemPage(&out, shell.System{ + Title: loc.T("profile.edit"), + ThemeURL: theme, + BodyClass: "wikit-page", + Content: content, + }) + return out.String(), err +} From 291de9526df3c2b486659e25b95646e765319a4e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:47 +0900 Subject: [PATCH 215/428] test the profile helpers --- internal/userpage/userpage_test.go | 50 +++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/internal/userpage/userpage_test.go b/internal/userpage/userpage_test.go index 2013f674..814b7fbd 100644 --- a/internal/userpage/userpage_test.go +++ b/internal/userpage/userpage_test.go @@ -1,6 +1,10 @@ package userpage -import "testing" +import ( + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) func TestNumericIDTakesTheDjangoShape(t *testing.T) { cases := []struct { @@ -24,3 +28,47 @@ func TestNumericIDTakesTheDjangoShape(t *testing.T) { } } } + +func TestThreadNamePrefersTheArticleTitle(t *testing.T) { + title, name, category := "SCP-173", "scp-173", "_default" + post := db.UserPost{ThreadName: "Comments for scp-173", + ArticleTitle: &title, ArticleName: &name, ArticleCategory: &category} + if got := threadName(post); got != "SCP-173" { + t.Errorf("threadName(comment thread) = %q, want %q", got, "SCP-173") + } +} + +func TestThreadNameKeepsTheThreadNameOutsideComments(t *testing.T) { + id := int64(4) + post := db.UserPost{ThreadName: "Announcements", ThreadCategoryID: &id} + if got := threadName(post); got != "Announcements" { + t.Errorf("threadName(forum thread) = %q, want %q", got, "Announcements") + } +} + +func TestThreadURL(t *testing.T) { + if got, want := threadURL(2, "Probe Thread"), "/forum/t-2/probe-thread"; got != want { + t.Errorf("threadURL(2, %q) = %q, want %q", "Probe Thread", got, want) + } +} + +func TestSplitFullName(t *testing.T) { + cases := []struct{ in, first, last string }{ + {"Ada Lovelace", "Ada", "Lovelace"}, + {"Jean Luc Picard", "Jean Luc", "Picard"}, + {"Cher", "Cher", ""}, + {" ", "", ""}, + } + for _, c := range cases { + first, last := splitFullName(c.in) + if first != c.first || last != c.last { + t.Errorf("splitFullName(%q) = %q, %q, want %q, %q", c.in, first, last, c.first, c.last) + } + } +} + +func TestMediaTypeDropsTheCharset(t *testing.T) { + if got, want := mediaType("text/plain; charset=utf-8"), "text/plain"; got != want { + t.Errorf("mediaType(%q) = %q, want %q", "text/plain; charset=utf-8", got, want) + } +} From bba3b220e919b110c94b843b8a4c334383dfe19f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:47 +0900 Subject: [PATCH 216/428] route the profile form --- cmd/pwikit/articles.go | 47 ++++++++++++++++++++----------------- cmd/pwikit/main.go | 3 +++ internal/routing/routing.go | 1 + 3 files changed, 30 insertions(+), 21 deletions(-) diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go index 238bd1e0..471429af 100644 --- a/cmd/pwikit/articles.go +++ b/cmd/pwikit/articles.go @@ -21,15 +21,16 @@ import ( ) type pageStack struct { - articles http.Handler - code http.Handler - html http.Handler - theme http.Handler - moduleAPI http.Handler - preview http.Handler - profile http.Handler - articleAPI http.Handler - close func() + articles http.Handler + code http.Handler + html http.Handler + theme http.Handler + moduleAPI http.Handler + preview http.Handler + profile http.Handler + profileForm http.Handler + articleAPI http.Handler + close func() } func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handler, trust *proxyheader.Trust, sidecar, secret, timezone string, log *slog.Logger) (*pageStack, error) { @@ -62,19 +63,22 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl items := localitem.Deps{DB: conn, Engine: engine, Bundle: bundle, Icons: icons, Log: log} api := webapi.Deps{DB: conn, Trust: trust, Engine: engine, Bundle: bundle, Icons: icons, Log: log} + profiles := userpage.Deps{ + DB: conn, Engine: engine, Bundle: bundle, Icons: icons, + Assets: static.NewAssets(assets), TimeZone: location, Files: p.Files(), Log: log, + } + stack := &pageStack{ - articles: pages, - code: localitem.NewCode(items), - html: localitem.NewHTML(items), - theme: localitem.NewTheme(items), - moduleAPI: webapi.New(api, upstream), - preview: webapi.NewPreview(api), - articleAPI: webapi.NewArticles(api, upstream), - profile: userpage.New(userpage.Deps{ - DB: conn, Engine: engine, Bundle: bundle, Icons: icons, - Assets: static.NewAssets(assets), TimeZone: location, Log: log, - }), - close: closeEngine, + articles: pages, + code: localitem.NewCode(items), + html: localitem.NewHTML(items), + theme: localitem.NewTheme(items), + moduleAPI: webapi.New(api, upstream), + preview: webapi.NewPreview(api), + articleAPI: webapi.NewArticles(api, upstream), + profile: userpage.New(profiles), + profileForm: userpage.NewEdit(profiles), + close: closeEngine, } // Without the key nothing can be verified, so every visitor stays @@ -90,6 +94,7 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl stack.moduleAPI = resolver.Middleware(stack.moduleAPI) stack.preview = resolver.Middleware(stack.preview) stack.profile = resolver.Middleware(stack.profile) + stack.profileForm = resolver.Middleware(stack.profileForm) stack.articles = resolver.Middleware(stack.articles) return stack, nil } diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 8b4f4be2..66e32dfa 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -144,6 +144,7 @@ func serve(args []string) error { var articles, codeHandler, htmlHandler, themeHandler http.Handler = proxy, proxy, proxy, proxy var moduleAPI, preview, profile, articleAPI http.Handler = proxy, proxy, proxy, proxy + var profileForm http.Handler = proxy if conn != nil { stack, err := newPageStack(conn, p, assets, proxy, trust, *sidecar, *secret, *timezone, log) if err != nil { @@ -160,6 +161,7 @@ func serve(args []string) error { moduleAPI = served(stack.moduleAPI) preview = served(stack.preview) profile = served(stack.profile) + profileForm = served(stack.profileForm) articleAPI = served(stack.articleAPI) } @@ -176,6 +178,7 @@ func serve(args []string) error { webapi.ModulesPath: moduleAPI, webapi.PreviewPath: preview, userpage.Prefix: profile, + userpage.EditPrefix: profileForm, webapi.ArticlesPrefix: articleAPI, "/": articles, } diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 21e76946..282e7b6f 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -37,6 +37,7 @@ var Table = []Route{ {Prefix: "/-/static/", Owner: OwnerGo, Label: "static assets"}, {Prefix: "/-/theme/", Owner: OwnerGo, Label: "site theme"}, {Prefix: "/-/users/", Owner: OwnerGo, Label: "user profiles"}, + {Prefix: "/-/profile/edit", Owner: OwnerGo, Label: "profile form", Exact: true}, {Prefix: "/pw-api/", Owner: OwnerUpstream, Label: "API"}, {Prefix: "/pw-api/modules", Owner: OwnerGo, Label: "module API", Exact: true}, {Prefix: "/pw-api/preview", Owner: OwnerGo, Label: "editor preview", Exact: true}, From f965a1923fc1ebe6452a9edd39d36280b8d430c5 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:47 +0900 Subject: [PATCH 217/428] test the profile views --- internal/shell/shell_test.go | 83 ++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/internal/shell/shell_test.go b/internal/shell/shell_test.go index aacc130c..9cfd9426 100644 --- a/internal/shell/shell_test.go +++ b/internal/shell/shell_test.go @@ -338,3 +338,86 @@ func writeCorpus(t *testing.T, c corpusFile) { t.Fatalf("WriteFile(%s) err = %v, want nil", corpusPath, err) } } + +func profileTestRenderer(t *testing.T) *Renderer { + t.Helper() + bundle, err := i18n.Load("") + if err != nil { + t.Fatalf("i18n.Load() err = %v, want nil", err) + } + return New(bundle.Localizer(i18n.DefaultLanguage), static.NewAssets(nil), time.UTC) +} + +func TestProfileFeedRendersOneRowPerItem(t *testing.T) { + at := time.Date(2026, 9, 1, 12, 0, 0, 0, time.UTC) + got, err := profileTestRenderer(t).Profile(Profile{ + DisplayName: "probe-author", + JoinedAt: at, + Edits: ProfileFeed{Items: []ProfileItem{ + {URL: "/scp-173", Title: "SCP-173", Site: "Test Wiki", At: at, + Flags: []ProfileFlag{{ID: "S", Desc: "source"}}, Comment: "typo"}, + {URL: "/component:box", Title: "Box", Site: "Test Wiki", At: at}, + }}, + }) + if err != nil { + t.Fatalf("Profile() err = %v, want nil", err) + } + if n := strings.Count(got, `Box`) { + t.Error(`Profile() does not link "Box" to /component:box`) + } + if !strings.Contains(got, `>Test Wiki<`) { + t.Error(`Profile() does not name the site a row came from`) + } + if !strings.Contains(got, `S`) { + t.Error(`Profile() does not flag what an edit changed`) + } + if !strings.Contains(got, "typo") { + t.Error(`Profile() does not show an edit comment`) + } +} + +func TestProfileFeedFallsBackToTheEmptyLine(t *testing.T) { + got, err := profileTestRenderer(t).Profile(Profile{DisplayName: "probe-author"}) + if err != nil { + t.Fatalf("Profile() err = %v, want nil", err) + } + if n := strings.Count(got, `class="empty"`); n != 2 { + t.Errorf("count of empty feeds = %d, want 2", n) + } + if strings.Contains(got, `
    `) { + t.Error("Profile() renders a feed list with no items") + } +} + +func TestProfileEditCarriesTheToken(t *testing.T) { + got, err := profileTestRenderer(t).ProfileEdit(ProfileEdit{ + DisplayName: "probe-author", CSRF: "tok", FullName: "Ada Lovelace", + }) + if err != nil { + t.Fatalf("ProfileEdit() err = %v, want nil", err) + } + if !strings.Contains(got, `name="csrfmiddlewaretoken" value="tok"`) { + t.Error("ProfileEdit() does not carry the csrf token") + } + if !strings.Contains(got, `enctype="multipart/form-data"`) { + t.Error("ProfileEdit() posts a form that cannot carry a file") + } + if strings.Contains(got, `class="error-inline"`) { + t.Error("ProfileEdit() shows an error block with no error") + } +} + +func TestProfileEditShowsTheProblem(t *testing.T) { + got, err := profileTestRenderer(t).ProfileEdit(ProfileEdit{ + DisplayName: "probe-author", Error: "too big", + }) + if err != nil { + t.Fatalf("ProfileEdit() err = %v, want nil", err) + } + if !strings.Contains(got, "too big") { + t.Error("ProfileEdit() does not show the error it was given") + } +} From 9f4a15b3edc1b85f51b1501afb79b579f9ce950a Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 15:47:47 +0900 Subject: [PATCH 218/428] exempt the profile pages and probe the login redirect --- internal/difftest/corpus/default.txt | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/internal/difftest/corpus/default.txt b/internal/difftest/corpus/default.txt index 549bc432..c898c10b 100644 --- a/internal/difftest/corpus/default.txt +++ b/internal/difftest/corpus/default.txt @@ -32,13 +32,18 @@ # page names above are the local seed set, not a real wiki # user profiles. probe-author carries a bio, a first and last name; the wikidot -# account is inactive and reached by the name it kept. -/-/users/probe-author -/-/users/PROBE-AUTHOR -/-/users/probevoter -/-/users/probe-wd-original -/-/users/probe-staff +# account is inactive and reached by the name it kept. the five that resolve +# carry an edit and a post history that only pwikit renders. +!/-/users/probe-author +!/-/users/PROBE-AUTHOR +!/-/users/probevoter +!/-/users/probe-wd-original +!/-/users/probe-staff /-/users/nobody-at-all /-/users/1 /-/users/1- HEAD /-/users/probe-author + +# anonymous only. logged in the two forms have nothing in common, so the +# login redirect is the whole of what this compares. +/-/profile/edit From 3630ba0404dca1e66f1f2123fc7ea43fb31ba626 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 17:14:52 +0900 Subject: [PATCH 219/428] put the system theme next to the site theme --- web/admin.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/web/admin.py b/web/admin.py index 375c209c..943bb65b 100644 --- a/web/admin.py +++ b/web/admin.py @@ -206,10 +206,11 @@ class SiteAdmin(SingletonModelAdmin): inlines = [SettingsAdmin] fieldsets = ( (None, { - 'fields': ('slug', 'title', 'headline', 'domain', 'media_domain', 'home_page', 'active_theme') + 'fields': ('slug', 'title', 'headline', 'domain', 'media_domain', 'home_page', + 'active_theme', 'system_theme') }), ('外观', { - 'fields': ('icon', 'auth_icon', 'footer_license', 'system_theme') + 'fields': ('icon', 'auth_icon', 'footer_license') }), ('注册与入组', { 'fields': ('signup_notice', 'default_role', 'verified_role', From b0c19f58b46a609f0379c9b3b5ec01e78bf0aca1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 17:15:53 +0900 Subject: [PATCH 220/428] add the statement that writes an article version --- internal/db/article_write.go | 82 ++++++++++++++ internal/db/article_write_test.go | 178 ++++++++++++++++++++++++++++++ 2 files changed, 260 insertions(+) create mode 100644 internal/db/article_write.go create mode 100644 internal/db/article_write_test.go diff --git a/internal/db/article_write.go b/internal/db/article_write.go new file mode 100644 index 00000000..6596de42 --- /dev/null +++ b/internal/db/article_write.go @@ -0,0 +1,82 @@ +package db + +import ( + "context" + "encoding/json" + "fmt" + "time" +) + +const ( + LogNew = "new" + LogSource = "source" +) + +type Revision struct { + VersionID int64 + RevNumber int +} + +type VersionWrite struct { + ArticleID int64 + Source string + UserID *int64 + Kind string + Comment string + At time.Time + + // Title rides along on the revision that created the page and nowhere else, + // so an empty one still has to be written. + Title string +} + +var qInsertArticleVersion = register("InsertArticleVersion", ` +INSERT INTO web_articleversion (article_id, source, created_at) +VALUES ($1, $2, $3) +RETURNING id`) + +// The version and the revision naming it go in together, so a failed write +// cannot leave behind a version nothing points at. +func (d *DB) CreateArticleVersion(ctx context.Context, w VersionWrite) (Revision, error) { + tx, err := d.pool.Begin(ctx) + if err != nil { + return Revision{}, fmt.Errorf("begin version: %w", err) + } + defer tx.Rollback(ctx) + + var rev Revision + if err := tx.QueryRow(ctx, qInsertArticleVersion, w.ArticleID, w.Source, w.At).Scan(&rev.VersionID); err != nil { + return Revision{}, fmt.Errorf("write version of %d: %w", w.ArticleID, err) + } + + meta, err := versionMeta(rev.VersionID, w) + if err != nil { + return Revision{}, err + } + if _, err := tx.Exec(ctx, qLockArticleLog, w.ArticleID); err != nil { + return Revision{}, fmt.Errorf("lock article log %d: %w", w.ArticleID, err) + } + if err := tx.QueryRow(ctx, qInsertArticleLog, w.ArticleID, w.UserID, w.Kind, meta, + w.Comment, w.At).Scan(&rev.RevNumber); err != nil { + return Revision{}, fmt.Errorf("write revision of %d: %w", w.ArticleID, err) + } + if _, err := tx.Exec(ctx, qTouchArticle, w.ArticleID, w.At); err != nil { + return Revision{}, fmt.Errorf("touch article %d: %w", w.ArticleID, err) + } + if err := tx.Commit(ctx); err != nil { + return Revision{}, fmt.Errorf("commit version of %d: %w", w.ArticleID, err) + } + return rev, nil +} + +func versionMeta(versionID int64, w VersionWrite) (string, error) { + fields := map[string]any{"version_id": versionID} + if w.Kind == LogNew { + fields["title"] = w.Title + } + encoded, err := json.Marshal(fields) + if err != nil { + return "", fmt.Errorf("encode revision meta of %d: %w", w.ArticleID, err) + } + return string(encoded), nil +} diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go new file mode 100644 index 00000000..cd4cc175 --- /dev/null +++ b/internal/db/article_write_test.go @@ -0,0 +1,178 @@ +package db + +import ( + "context" + "encoding/json" + "os" + "testing" + "time" +) + +func writeTestDB(t *testing.T) *DB { + t.Helper() + dsn := os.Getenv(EnvDSN) + if dsn == "" { + t.Skipf("%s not set, skipping the database test", EnvDSN) + } + conn, err := Open(context.Background(), dsn) + if err != nil { + t.Fatalf("Open() err = %v, want nil", err) + } + t.Cleanup(conn.Close) + return conn +} + +func scratchArticle(t *testing.T, d *DB) int64 { + t.Helper() + ctx := context.Background() + name := "probe-write-" + time.Now().Format("20060102150405.000000") + var id int64 + err := d.pool.QueryRow(ctx, ` +INSERT INTO web_article (category, name, title, locked, created_at, updated_at, media_name) +VALUES ('_default', $1, 'Probe', false, now(), now(), $2) +RETURNING id`, name, name).Scan(&id) + if err != nil { + t.Fatalf("insert scratch article err = %v, want nil", err) + } + t.Cleanup(func() { + clean := context.Background() + for _, sql := range []string{ + `DELETE FROM web_articlelogentry WHERE article_id = $1`, + `DELETE FROM web_articleversion WHERE article_id = $1`, + `DELETE FROM web_article WHERE id = $1`, + } { + if _, err := d.pool.Exec(clean, sql, id); err != nil { + t.Errorf("clean up scratch article err = %v, want nil", err) + } + } + }) + return id +} + +func TestCreateArticleVersionNumbersFromZero(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchArticle(t, d) + at := time.Now().UTC().Truncate(time.Second) + + first, err := d.CreateArticleVersion(ctx, VersionWrite{ + ArticleID: id, Source: "one", Kind: LogNew, Title: "Probe", At: at, + }) + if err != nil { + t.Fatalf("CreateArticleVersion(new) err = %v, want nil", err) + } + if first.RevNumber != 0 { + t.Errorf("CreateArticleVersion(new).RevNumber = %d, want 0", first.RevNumber) + } + + second, err := d.CreateArticleVersion(ctx, VersionWrite{ + ArticleID: id, Source: "two", Kind: LogSource, Comment: "fixed a typo", At: at, + }) + if err != nil { + t.Fatalf("CreateArticleVersion(source) err = %v, want nil", err) + } + if second.RevNumber != 1 { + t.Errorf("CreateArticleVersion(source).RevNumber = %d, want 1", second.RevNumber) + } + if second.VersionID == first.VersionID { + t.Errorf("CreateArticleVersion(source).VersionID = %d, want a new one", second.VersionID) + } + + source, err := d.LatestSource(ctx, id) + if err != nil { + t.Fatalf("LatestSource() err = %v, want nil", err) + } + if source != "two" { + t.Errorf("LatestSource() = %q, want %q", source, "two") + } +} + +func TestCreateArticleVersionMetaNamesTheVersion(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchArticle(t, d) + at := time.Now().UTC().Truncate(time.Second) + + rev, err := d.CreateArticleVersion(ctx, VersionWrite{ + ArticleID: id, Source: "one", Kind: LogNew, Title: "Probe", At: at, + }) + if err != nil { + t.Fatalf("CreateArticleVersion(new) err = %v, want nil", err) + } + + var kind, comment string + var raw []byte + err = d.pool.QueryRow(ctx, ` +SELECT type, comment, meta FROM web_articlelogentry WHERE article_id = $1 AND rev_number = 0`, + id).Scan(&kind, &comment, &raw) + if err != nil { + t.Fatalf("read revision err = %v, want nil", err) + } + if kind != LogNew { + t.Errorf("revision type = %q, want %q", kind, LogNew) + } + + var meta map[string]any + if err := json.Unmarshal(raw, &meta); err != nil { + t.Fatalf("decode meta err = %v, want nil", err) + } + if got, want := meta["version_id"], float64(rev.VersionID); got != want { + t.Errorf("meta version_id = %v, want %v", got, want) + } + if got, want := meta["title"], "Probe"; got != want { + t.Errorf("meta title = %v, want %q", got, want) + } +} + +func TestCreateArticleVersionKeepsTheTitleOffAnEdit(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchArticle(t, d) + at := time.Now().UTC().Truncate(time.Second) + + if _, err := d.CreateArticleVersion(ctx, VersionWrite{ + ArticleID: id, Source: "one", Kind: LogNew, Title: "Probe", At: at, + }); err != nil { + t.Fatalf("CreateArticleVersion(new) err = %v, want nil", err) + } + if _, err := d.CreateArticleVersion(ctx, VersionWrite{ + ArticleID: id, Source: "two", Kind: LogSource, Title: "Probe", At: at, + }); err != nil { + t.Fatalf("CreateArticleVersion(source) err = %v, want nil", err) + } + + var raw []byte + err := d.pool.QueryRow(ctx, ` +SELECT meta FROM web_articlelogentry WHERE article_id = $1 AND rev_number = 1`, id).Scan(&raw) + if err != nil { + t.Fatalf("read revision err = %v, want nil", err) + } + var meta map[string]any + if err := json.Unmarshal(raw, &meta); err != nil { + t.Fatalf("decode meta err = %v, want nil", err) + } + if _, ok := meta["title"]; ok { + t.Errorf("meta of an edit carries title = %v, want it absent", meta["title"]) + } +} + +func TestCreateArticleVersionTouchesTheArticle(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchArticle(t, d) + at := time.Date(2030, 4, 5, 6, 7, 8, 0, time.UTC) + + if _, err := d.CreateArticleVersion(ctx, VersionWrite{ + ArticleID: id, Source: "one", Kind: LogNew, At: at, + }); err != nil { + t.Fatalf("CreateArticleVersion(new) err = %v, want nil", err) + } + + var updated time.Time + if err := d.pool.QueryRow(ctx, `SELECT updated_at FROM web_article WHERE id = $1`, id).Scan(&updated); err != nil { + t.Fatalf("read article err = %v, want nil", err) + } + if !updated.Equal(at) { + t.Errorf("article updated_at = %v, want %v", updated, at) + } +} From d2954034e9649d202b2d0dded11ffaedb49a438a Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 17:16:17 +0900 Subject: [PATCH 221/428] add the statement that replaces an article's links --- internal/db/article_write.go | 45 ++++++++++++ internal/db/article_write_test.go | 109 ++++++++++++++++++++++++++++++ 2 files changed, 154 insertions(+) diff --git a/internal/db/article_write.go b/internal/db/article_write.go index 6596de42..f1ee0119 100644 --- a/internal/db/article_write.go +++ b/internal/db/article_write.go @@ -80,3 +80,48 @@ func versionMeta(versionID int64, w VersionWrite) (string, error) { } return string(encoded), nil } + +type ArticleLink struct { + To string + Kind string +} + +var ( + qDropArticleLinks = register("DropArticleLinks", ` +DELETE FROM web_externallink WHERE link_from = $1`) + + qInsertArticleLinks = register("InsertArticleLinks", ` +INSERT INTO web_externallink (link_from, link_type, link_to) +SELECT $1, kind, target +FROM unnest($2::text[], $3::text[]) AS t(kind, target) +ON CONFLICT DO NOTHING`) +) + +// The whole set is replaced under one transaction, so nobody reads a page as +// having no links at all while it is being saved. +func (d *DB) ReplaceArticleLinks(ctx context.Context, from string, links []ArticleLink) error { + tx, err := d.pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin links of %q: %w", from, err) + } + defer tx.Rollback(ctx) + + if _, err := tx.Exec(ctx, qDropArticleLinks, from); err != nil { + return fmt.Errorf("drop links of %q: %w", from, err) + } + if len(links) > 0 { + kinds := make([]string, 0, len(links)) + targets := make([]string, 0, len(links)) + for _, link := range links { + kinds = append(kinds, link.Kind) + targets = append(targets, link.To) + } + if _, err := tx.Exec(ctx, qInsertArticleLinks, from, kinds, targets); err != nil { + return fmt.Errorf("write links of %q: %w", from, err) + } + } + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit links of %q: %w", from, err) + } + return nil +} diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go index cd4cc175..672491c9 100644 --- a/internal/db/article_write_test.go +++ b/internal/db/article_write_test.go @@ -176,3 +176,112 @@ func TestCreateArticleVersionTouchesTheArticle(t *testing.T) { t.Errorf("article updated_at = %v, want %v", updated, at) } } + +func linkSet(t *testing.T, d *DB, from string) map[string]bool { + t.Helper() + rows, err := d.pool.Query(context.Background(), ` +SELECT link_type, link_to FROM web_externallink WHERE link_from = $1`, from) + if err != nil { + t.Fatalf("read links err = %v, want nil", err) + } + defer rows.Close() + + out := map[string]bool{} + for rows.Next() { + var kind, to string + if err := rows.Scan(&kind, &to); err != nil { + t.Fatalf("scan link err = %v, want nil", err) + } + out[kind+" "+to] = true + } + return out +} + +func scratchLinkOwner(t *testing.T, d *DB) string { + t.Helper() + from := "probe-links-" + time.Now().Format("20060102150405.000000") + t.Cleanup(func() { + if _, err := d.pool.Exec(context.Background(), + `DELETE FROM web_externallink WHERE link_from = $1`, from); err != nil { + t.Errorf("clean up links err = %v, want nil", err) + } + }) + return from +} + +func TestReplaceArticleLinksWritesBothKinds(t *testing.T) { + d := writeTestDB(t) + from := scratchLinkOwner(t, d) + + err := d.ReplaceArticleLinks(context.Background(), from, []ArticleLink{ + {To: "component:box", Kind: LinkInclude}, + {To: "scp-173", Kind: LinkPlain}, + }) + if err != nil { + t.Fatalf("ReplaceArticleLinks() err = %v, want nil", err) + } + + got := linkSet(t, d, from) + for _, want := range []string{"include component:box", "link scp-173"} { + if !got[want] { + t.Errorf("links of %q missing %q, got %v", from, want, got) + } + } + if len(got) != 2 { + t.Errorf("len(links) = %d, want 2", len(got)) + } +} + +func TestReplaceArticleLinksDropsWhatIsGone(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + from := scratchLinkOwner(t, d) + + if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "old", Kind: LinkPlain}}); err != nil { + t.Fatalf("ReplaceArticleLinks(first) err = %v, want nil", err) + } + if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "new", Kind: LinkPlain}}); err != nil { + t.Fatalf("ReplaceArticleLinks(second) err = %v, want nil", err) + } + + got := linkSet(t, d, from) + if got["link old"] { + t.Errorf("links of %q still carry the dropped one, got %v", from, got) + } + if !got["link new"] { + t.Errorf("links of %q missing %q, got %v", from, "link new", got) + } +} + +func TestReplaceArticleLinksCollapsesRepeats(t *testing.T) { + d := writeTestDB(t) + from := scratchLinkOwner(t, d) + + err := d.ReplaceArticleLinks(context.Background(), from, []ArticleLink{ + {To: "component:box", Kind: LinkInclude}, + {To: "component:box", Kind: LinkInclude}, + {To: "component:box", Kind: LinkPlain}, + }) + if err != nil { + t.Fatalf("ReplaceArticleLinks() err = %v, want nil", err) + } + if got := linkSet(t, d, from); len(got) != 2 { + t.Errorf("len(links) = %d, want 2, got %v", len(got), got) + } +} + +func TestReplaceArticleLinksEmptiesTheSet(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + from := scratchLinkOwner(t, d) + + if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "old", Kind: LinkPlain}}); err != nil { + t.Fatalf("ReplaceArticleLinks(first) err = %v, want nil", err) + } + if err := d.ReplaceArticleLinks(ctx, from, nil); err != nil { + t.Fatalf("ReplaceArticleLinks(none) err = %v, want nil", err) + } + if got := linkSet(t, d, from); len(got) != 0 { + t.Errorf("len(links) = %d, want 0, got %v", len(got), got) + } +} From 7cea2b5af9a377dbef6f9db5d28062a6b643ffc1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 17:16:17 +0900 Subject: [PATCH 222/428] keep an include apart from a link when collecting backlinks --- internal/pagerender/pagerender.go | 18 +++++++++ internal/pagerender/pagerender_test.go | 52 ++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 internal/pagerender/pagerender_test.go diff --git a/internal/pagerender/pagerender.go b/internal/pagerender/pagerender.go index eebab69a..2a279d8d 100644 --- a/internal/pagerender/pagerender.go +++ b/internal/pagerender/pagerender.go @@ -6,6 +6,7 @@ import ( "context" "net/http" "net/netip" + "strings" "github.com/WikitTeam/ProjectWikit/internal/callbacks" "github.com/WikitTeam/ProjectWikit/internal/db" @@ -58,6 +59,23 @@ func (e *Env) Text(source string, info renderer.PageInfo, cb *callbacks.Callback return e.deps.Engine.RenderText(e.ctx, source, info, cb, mode) } +// ftml answers with the pages a source pulls in and the pages it points at, in +// that order. Handing the two back swapped would invert every backlink on the site. +func (e *Env) Backlinks(source string, info renderer.PageInfo, cb *callbacks.Callbacks) ([]db.ArticleLink, error) { + result, err := e.deps.Engine.CollectBacklinks(e.ctx, source, info, cb, renderer.ModeSystem) + if err != nil { + return nil, err + } + links := make([]db.ArticleLink, 0, len(result.IncludedPages)+len(result.LinkedPages)) + for _, name := range result.IncludedPages { + links = append(links, db.ArticleLink{To: strings.ToLower(name), Kind: db.LinkInclude}) + } + for _, name := range result.LinkedPages { + links = append(links, db.ArticleLink{To: strings.ToLower(name), Kind: db.LinkPlain}) + } + return links, nil +} + func (e *Env) CodeAndHTML(source string, info renderer.PageInfo, cb *callbacks.Callbacks, mode renderer.Mode) (renderer.Parts, error) { return e.deps.Engine.CollectCodeAndHTML(e.ctx, source, info, cb, mode) } diff --git a/internal/pagerender/pagerender_test.go b/internal/pagerender/pagerender_test.go new file mode 100644 index 00000000..828afd72 --- /dev/null +++ b/internal/pagerender/pagerender_test.go @@ -0,0 +1,52 @@ +package pagerender + +import ( + "context" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/renderer" +) + +func TestBacklinksKeepsIncludesApartFromLinks(t *testing.T) { + engine := &renderer.Fake{Result: renderer.Result{ + IncludedPages: []string{"Component:Box"}, + LinkedPages: []string{"SCP-173"}, + }} + env := Deps{Engine: engine}.Env(context.Background(), nil, nil, nil) + + got, err := env.Backlinks("source", renderer.PageInfo{}, nil) + if err != nil { + t.Fatalf("Backlinks() err = %v, want nil", err) + } + want := []db.ArticleLink{ + {To: "component:box", Kind: db.LinkInclude}, + {To: "scp-173", Kind: db.LinkPlain}, + } + if len(got) != len(want) { + t.Fatalf("len(Backlinks()) = %d, want %d", len(got), len(want)) + } + for i := range want { + if got[i] != want[i] { + t.Errorf("Backlinks()[%d] = %+v, want %+v", i, got[i], want[i]) + } + } +} + +func TestBacklinksCollectsInSystemMode(t *testing.T) { + engine := &renderer.Fake{} + env := Deps{Engine: engine}.Env(context.Background(), nil, nil, nil) + + if _, err := env.Backlinks("source", renderer.PageInfo{}, nil); err != nil { + t.Fatalf("Backlinks() err = %v, want nil", err) + } + if len(engine.Calls) != 1 { + t.Fatalf("len(engine calls) = %d, want 1", len(engine.Calls)) + } + if got, want := engine.Calls[0].Op, "CollectBacklinks"; got != want { + t.Errorf("engine call = %q, want %q", got, want) + } + if got, want := engine.Calls[0].Mode, renderer.ModeSystem; got != want { + t.Errorf("mode = %q, want %q", got, want) + } +} From 233a4cf3073062df9031ef376870d0cd1bdc1a02 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 17:46:28 +0900 Subject: [PATCH 223/428] add the words the article api refuses with --- internal/i18n/locales/zh-hans.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index b117cb79..de6c3663 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -1,10 +1,15 @@ { + "api-bad-json": "请求体中的JSON格式无效", "api-bad-page-id": "无效的页面ID", "api-bad-request": "无效请求", "api-csrf-failed": "CSRF 校验失败", "api-forbidden": "权限不足", "api-internal-error": "服务器内部错误", + "api-missing-source": "缺少页面源代码", + "api-missing-title": "缺少页面标题", + "api-page-exists": "此ID的页面已存在", "api-page-not-found": "页面未找到", + "api-source-too-long": "超过页面大小限制", "button-copy-clipboard": "复制", "collapsible-hide": "- 关闭折叠", "collapsible-open": "+ 打开折叠", From bd5146c97d898e602fb3839f358f15f3c0e8325f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 17:46:28 +0900 Subject: [PATCH 224/428] add the statements a new page needs --- internal/db/article_write.go | 99 ++++++++++++++++ internal/db/article_write_test.go | 180 ++++++++++++++++++++++++++++++ 2 files changed, 279 insertions(+) diff --git a/internal/db/article_write.go b/internal/db/article_write.go index f1ee0119..4760e1ee 100644 --- a/internal/db/article_write.go +++ b/internal/db/article_write.go @@ -2,6 +2,7 @@ package db import ( "context" + "crypto/rand" "encoding/json" "fmt" "time" @@ -10,6 +11,7 @@ import ( const ( LogNew = "new" LogSource = "source" + LogParent = "parent" ) type Revision struct { @@ -125,3 +127,100 @@ func (d *DB) ReplaceArticleLinks(ctx context.Context, from string, links []Artic } return nil } + +var ( + qInsertArticle = register("InsertArticle", ` +INSERT INTO web_article (category, name, title, locked, created_at, updated_at, media_name) +VALUES ($1, $2, $3, false, $4, $4, $5) +RETURNING id`) + + qInsertArticleAuthor = register("InsertArticleAuthor", ` +INSERT INTO web_article_authors (article_id, user_id) +VALUES ($1, $2) +ON CONFLICT DO NOTHING`) +) + +func (d *DB) CreateArticle(ctx context.Context, category, name, title string, authorID *int64, at time.Time) (int64, error) { + media, err := mediaName() + if err != nil { + return 0, err + } + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin article %q: %w", name, err) + } + defer tx.Rollback(ctx) + + var id int64 + if err := tx.QueryRow(ctx, qInsertArticle, category, name, title, at, media).Scan(&id); err != nil { + return 0, fmt.Errorf("write article %q: %w", name, err) + } + if authorID != nil { + if _, err := tx.Exec(ctx, qInsertArticleAuthor, id, *authorID); err != nil { + return 0, fmt.Errorf("credit author of %q: %w", name, err) + } + } + if err := tx.Commit(ctx); err != nil { + return 0, fmt.Errorf("commit article %q: %w", name, err) + } + return id, nil +} + +// The directory a page's files live in is named after the row rather than after +// the page, so renaming a page moves nothing on disk. +func mediaName() (string, error) { + var b [16]byte + if _, err := rand.Read(b[:]); err != nil { + return "", fmt.Errorf("pick a media name: %w", err) + } + b[6] = b[6]&0x0f | 0x40 + b[8] = b[8]&0x3f | 0x80 + return fmt.Sprintf("%x-%x-%x-%x-%x", b[0:4], b[4:6], b[6:8], b[8:10], b[10:16]), nil +} + +var qSetArticleParent = register("SetArticleParent", ` +UPDATE web_article SET parent_id = $2 WHERE id = $1`) + +func (d *DB) SetArticleParent(ctx context.Context, articleID int64, parentID *int64, + userID *int64, meta string, at time.Time) (int, error) { + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin parent of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + if _, err := tx.Exec(ctx, qSetArticleParent, articleID, parentID); err != nil { + return 0, fmt.Errorf("set parent of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { + return 0, fmt.Errorf("lock article log %d: %w", articleID, err) + } + var revNumber int + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogParent, meta, "", at).Scan(&revNumber); err != nil { + return 0, fmt.Errorf("write revision of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { + return 0, fmt.Errorf("touch article %d: %w", articleID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, fmt.Errorf("commit parent of %d: %w", articleID, err) + } + return revNumber, nil +} + +// Nothing stops a second row for the same pair, so the check rides inside the +// insert rather than following it. +var qSubscribeToArticle = register("SubscribeToArticle", ` +INSERT INTO web_usernotificationsubscription (subscriber_id, article_id, forum_thread_id) +SELECT $1, $2, NULL +WHERE NOT EXISTS (SELECT 1 FROM web_usernotificationsubscription + WHERE subscriber_id = $1 AND article_id = $2 AND forum_thread_id IS NULL)`) + +func (d *DB) SubscribeToArticle(ctx context.Context, userID, articleID int64) error { + if _, err := d.pool.Exec(ctx, qSubscribeToArticle, userID, articleID); err != nil { + return fmt.Errorf("subscribe %d to article %d: %w", userID, articleID, err) + } + return nil +} diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go index 672491c9..92247d9c 100644 --- a/internal/db/article_write_test.go +++ b/internal/db/article_write_test.go @@ -285,3 +285,183 @@ func TestReplaceArticleLinksEmptiesTheSet(t *testing.T) { t.Errorf("len(links) = %d, want 0, got %v", len(got), got) } } + +func dropArticle(t *testing.T, d *DB, id int64) { + t.Helper() + t.Cleanup(func() { + clean := context.Background() + for _, sql := range []string{ + `DELETE FROM web_articlelogentry WHERE article_id = $1`, + `DELETE FROM web_articleversion WHERE article_id = $1`, + `DELETE FROM web_article_authors WHERE article_id = $1`, + `DELETE FROM web_article WHERE id = $1`, + } { + if _, err := d.pool.Exec(clean, sql, id); err != nil { + t.Errorf("clean up article err = %v, want nil", err) + } + } + }) +} + +func TestCreateArticleCreditsTheAuthor(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + + var author int64 + if err := d.pool.QueryRow(ctx, `SELECT id FROM web_user ORDER BY id LIMIT 1`).Scan(&author); err != nil { + t.Fatalf("read a user err = %v, want nil", err) + } + name := "probe-new-" + time.Now().Format("20060102150405.000000") + + id, err := d.CreateArticle(ctx, "_default", name, "Probe", &author, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + + var authors int + if err := d.pool.QueryRow(ctx, + `SELECT count(*) FROM web_article_authors WHERE article_id = $1 AND user_id = $2`, + id, author).Scan(&authors); err != nil { + t.Fatalf("read authors err = %v, want nil", err) + } + if authors != 1 { + t.Errorf("count(authors) = %d, want 1", authors) + } +} + +func TestCreateArticleWithoutAnAuthor(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + name := "probe-new-" + time.Now().Format("20060102150405.000000") + + id, err := d.CreateArticle(ctx, "_default", name, "Probe", nil, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + + article, err := d.ArticleByID(ctx, id) + if err != nil { + t.Fatalf("ArticleByID() err = %v, want nil", err) + } + if article.Title != "Probe" { + t.Errorf("ArticleByID().Title = %q, want %q", article.Title, "Probe") + } + if article.Locked { + t.Error("ArticleByID().Locked = true, want false") + } +} + +func TestCreateArticleNamesTheMediaDirectoryApart(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + stamp := time.Now().Format("20060102150405.000000") + + first, err := d.CreateArticle(ctx, "_default", "probe-media-a-"+stamp, "A", nil, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateArticle(a) err = %v, want nil", err) + } + dropArticle(t, d, first) + second, err := d.CreateArticle(ctx, "_default", "probe-media-b-"+stamp, "B", nil, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateArticle(b) err = %v, want nil", err) + } + dropArticle(t, d, second) + + var a, b string + if err := d.pool.QueryRow(ctx, `SELECT media_name FROM web_article WHERE id = $1`, first).Scan(&a); err != nil { + t.Fatalf("read media_name err = %v, want nil", err) + } + if err := d.pool.QueryRow(ctx, `SELECT media_name FROM web_article WHERE id = $1`, second).Scan(&b); err != nil { + t.Fatalf("read media_name err = %v, want nil", err) + } + if a == b { + t.Errorf("media_name of two articles = %q for both, want them apart", a) + } + if len(a) != 36 { + t.Errorf("len(media_name) = %d, want 36", len(a)) + } +} + +func TestSetArticleParentRecordsTheMove(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + at := time.Now().UTC().Truncate(time.Second) + stamp := time.Now().Format("20060102150405.000000") + + parent, err := d.CreateArticle(ctx, "_default", "probe-parent-"+stamp, "Parent", nil, at) + if err != nil { + t.Fatalf("CreateArticle(parent) err = %v, want nil", err) + } + dropArticle(t, d, parent) + child, err := d.CreateArticle(ctx, "_default", "probe-child-"+stamp, "Child", nil, at) + if err != nil { + t.Fatalf("CreateArticle(child) err = %v, want nil", err) + } + dropArticle(t, d, child) + + rev, err := d.SetArticleParent(ctx, child, &parent, nil, `{"parent":"probe-parent"}`, at) + if err != nil { + t.Fatalf("SetArticleParent() err = %v, want nil", err) + } + if rev != 0 { + t.Errorf("SetArticleParent().RevNumber = %d, want 0", rev) + } + + article, err := d.ArticleByID(ctx, child) + if err != nil { + t.Fatalf("ArticleByID() err = %v, want nil", err) + } + if article.ParentID == nil || *article.ParentID != parent { + t.Errorf("ArticleByID().ParentID = %v, want %d", article.ParentID, parent) + } + + var kind string + if err := d.pool.QueryRow(ctx, + `SELECT type FROM web_articlelogentry WHERE article_id = $1 AND rev_number = 0`, + child).Scan(&kind); err != nil { + t.Fatalf("read revision err = %v, want nil", err) + } + if kind != LogParent { + t.Errorf("revision type = %q, want %q", kind, LogParent) + } +} + +func TestSubscribeToArticleOnlyOnce(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + + var user int64 + if err := d.pool.QueryRow(ctx, `SELECT id FROM web_user ORDER BY id LIMIT 1`).Scan(&user); err != nil { + t.Fatalf("read a user err = %v, want nil", err) + } + id, err := d.CreateArticle(ctx, "_default", + "probe-sub-"+time.Now().Format("20060102150405.000000"), "Probe", nil, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + t.Cleanup(func() { + if _, err := d.pool.Exec(context.Background(), + `DELETE FROM web_usernotificationsubscription WHERE article_id = $1`, id); err != nil { + t.Errorf("clean up subscription err = %v, want nil", err) + } + }) + + for i := 0; i < 2; i++ { + if err := d.SubscribeToArticle(ctx, user, id); err != nil { + t.Fatalf("SubscribeToArticle(%d) err = %v, want nil", i, err) + } + } + + var rows int + if err := d.pool.QueryRow(ctx, + `SELECT count(*) FROM web_usernotificationsubscription WHERE article_id = $1 AND subscriber_id = $2`, + id, user).Scan(&rows); err != nil { + t.Fatalf("count subscriptions err = %v, want nil", err) + } + if rows != 1 { + t.Errorf("count(subscriptions) = %d, want 1", rows) + } +} From b14c0b60c36645fe785bca29a22aaae2b8859a33 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 17:46:28 +0900 Subject: [PATCH 225/428] answer the call that creates a page --- internal/webapi/articles.go | 7 +- internal/webapi/create.go | 233 ++++++++++++++++++++++++++++++++++++ 2 files changed, 239 insertions(+), 1 deletion(-) create mode 100644 internal/webapi/create.go diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index 6dc78126..71f1e42c 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -43,12 +43,17 @@ func NewArticles(d Deps, upstream http.Handler) *Articles { // Only the tails listed here are answered. A page's own URL still belongs to // the upstream, which is where saving lives. func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { + loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) + if r.URL.Path == CreatePath && r.Method == http.MethodPost { + h.create(w, r, loc) + return + } + name, tail, found := cutLast(strings.TrimPrefix(r.URL.Path, ArticlesPrefix)) if !found || name == "" { h.upstream.ServeHTTP(w, r) return } - loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) switch { case tail == tailLinks && r.Method == http.MethodGet: diff --git a/internal/webapi/create.go b/internal/webapi/create.go new file mode 100644 index 00000000..c4181549 --- /dev/null +++ b/internal/webapi/create.go @@ -0,0 +1,233 @@ +package webapi + +import ( + "encoding/json" + "errors" + "io" + "net/http" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/pagerender" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" +) + +const CreatePath = ArticlesPrefix + "new" + +const ( + sourceLimit = 200000 + bodyLimit = 4 * sourceLimit +) + +type createInput struct { + PageID string `json:"pageId"` + Title *string `json:"title"` + Source *string `json:"source"` + Parent *string `json:"parent"` +} + +// A refusal the visitor caused carries the message it should show, so it comes +// back as a body rather than as an error. +type refusal struct { + key string + status int +} + +func refuse(key string, status int) refusal { return refusal{key: key, status: status} } + +func (h *Articles) create(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) { + body, status, err := h.createArticle(r, loc) + if err != nil { + h.fail(w, loc, err) + return + } + writeJSON(w, status, body) +} + +func (h *Articles) createArticle(r *http.Request, loc *i18n.Localizer) (string, int, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", 0, errors.New("webapi: the request carries no site") + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return field("error", loc.T("api-csrf-failed")), http.StatusForbidden, nil + } + + input, bad := readCreateInput(r) + if bad != nil { + return field("error", loc.T(bad.key)), bad.status, nil + } + name := wikidot.Normalize(input.PageID) + user := auth.FromContext(ctx) + + if bad := h.mayCreate(r, name, user); bad != nil { + return field("error", loc.T(bad.key)), bad.status, nil + } + if _, err := h.deps.DB.ArticleByName(ctx, name); err == nil { + return field("error", loc.T("api-page-exists")), http.StatusConflict, nil + } else if !errors.Is(err, db.ErrNotFound) { + return "", 0, err + } + + if err := h.writeNewArticle(r, current, name, input, user); err != nil { + return "", 0, err + } + return field("status", "ok"), http.StatusCreated, nil +} + +func readCreateInput(r *http.Request) (createInput, *refusal) { + raw, err := io.ReadAll(io.LimitReader(r.Body, bodyLimit+1)) + if err != nil || len(raw) > bodyLimit { + return createInput{}, ptr(refuse("api-bad-request", http.StatusBadRequest)) + } + if len(raw) == 0 { + return createInput{}, ptr(refuse("api-bad-request", http.StatusBadRequest)) + } + var input createInput + if err := json.Unmarshal(raw, &input); err != nil { + return createInput{}, ptr(refuse("api-bad-json", http.StatusBadRequest)) + } + + switch { + case input.PageID == "" || !wikidot.NameAllowed(input.PageID): + return createInput{}, ptr(refuse("api-bad-page-id", http.StatusBadRequest)) + case input.Source == nil || strings.TrimSpace(*input.Source) == "": + return createInput{}, ptr(refuse("api-missing-source", http.StatusBadRequest)) + case input.Title == nil: + return createInput{}, ptr(refuse("api-missing-title", http.StatusBadRequest)) + case len(*input.Source) > sourceLimit: + return createInput{}, ptr(refuse("api-source-too-long", http.StatusBadRequest)) + } + return input, nil +} + +func ptr[T any](v T) *T { return &v } + +func (h *Articles) mayCreate(r *http.Request, name string, user *db.User) *refusal { + ctx := r.Context() + perm := repo.NewPerms(ctx, h.deps.DB) + subject, err := perm.Subject(user, time.Now()) + if err != nil { + return ptr(refuse("api-internal-error", http.StatusInternalServerError)) + } + category, _ := wikidot.Split(name) + object, err := perm.Category(category) + if err != nil { + return ptr(refuse("api-internal-error", http.StatusInternalServerError)) + } + if !perms.Resolve(subject, object).Has(perms.CreateArticles) { + return ptr(refuse("api-forbidden", http.StatusForbidden)) + } + return nil +} + +func (h *Articles) writeNewArticle(r *http.Request, current *db.Site, name string, + input createInput, user *db.User) error { + + ctx := r.Context() + category, bare := wikidot.Split(name) + at := time.Now().UTC() + var userID *int64 + if user != nil { + userID = &user.ID + } + + id, err := h.deps.DB.CreateArticle(ctx, category, bare, *input.Title, userID, at) + if err != nil { + return err + } + if _, err := h.deps.DB.CreateArticleVersion(ctx, db.VersionWrite{ + ArticleID: id, + Source: *input.Source, + UserID: userID, + Kind: db.LogNew, + Title: *input.Title, + At: at, + }); err != nil { + return err + } + if err := h.refreshLinks(r, current, id, *input.Source); err != nil { + return err + } + if err := h.setParent(r, current, id, input, userID, at); err != nil { + return err + } + if user != nil { + return h.deps.DB.SubscribeToArticle(ctx, user.ID, id) + } + return nil +} + +// The pass runs as nobody, so a page's links are the same set whoever saved it. +func (h *Articles) refreshLinks(r *http.Request, current *db.Site, id int64, source string) error { + ctx := r.Context() + article, err := h.deps.DB.ArticleByID(ctx, id) + if err != nil { + return err + } + loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) + env := pagerender.Deps{DB: h.deps.DB, Engine: h.deps.Engine, Icons: h.deps.Icons}. + Env(ctx, loc, current, nil) + + info, err := env.PageInfo(article) + if err != nil { + return err + } + pc := page.NewContext(article, article, nil, nil) + links, err := env.Backlinks(source, info, env.Callbacks(env.Vars(article), pc)) + if err != nil { + return err + } + return h.deps.DB.ReplaceArticleLinks(ctx, strings.ToLower(article.FullName()), links) +} + +func (h *Articles) setParent(r *http.Request, current *db.Site, id int64, + input createInput, userID *int64, at time.Time) error { + + if input.Parent == nil { + return nil + } + ctx := r.Context() + wanted := wikidot.Normalize(*input.Parent) + parent, err := h.deps.DB.ArticleByName(ctx, wanted) + if errors.Is(err, db.ErrNotFound) { + parent = nil + } else if err != nil { + return err + } + + var parentID *int64 + if parent != nil { + parentID = &parent.ID + } + meta, err := parentMeta(wanted, parentID) + if err != nil { + return err + } + _, err = h.deps.DB.SetArticleParent(ctx, id, parentID, userID, meta, at) + return err +} + +// A page created with a parent had none a moment ago, so the previous half of +// the entry is always empty. +func parentMeta(wanted string, parentID *int64) (string, error) { + encoded, err := json.Marshal(map[string]any{ + "parent": wanted, + "prev_parent": nil, + "parent_id": parentID, + "prev_parent_id": nil, + }) + if err != nil { + return "", err + } + return string(encoded), nil +} From d45f188012cc3d077df7fd9274f95ee8a2334cf1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 20:44:35 +0900 Subject: [PATCH 226/428] let an ordered sequence of statements be registered --- internal/db/db.go | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/internal/db/db.go b/internal/db/db.go index a0c1f325..6eefcb43 100644 --- a/internal/db/db.go +++ b/internal/db/db.go @@ -16,6 +16,10 @@ var ErrNotFound = errors.New("db: not found") // than in a _test.go file because other packages' tests gate on the same name. const EnvDSN = "PWIKIT_TEST_DSN" +// A test that writes needs a database of its own. Rows it leaves standing for a +// moment are visible to every other package's tests while they run. +const EnvWriteDSN = "PWIKIT_TEST_WRITE_DSN" + type DB struct { pool *pgxpool.Pool } @@ -50,6 +54,15 @@ func register(name, sql string) string { return sql } +// Each statement of an ordered sequence is registered on its own, so the +// schema-drift test still sees every one of them. +func registerAll(name string, sqls []string) []string { + for i, sql := range sqls { + register(fmt.Sprintf("%s.%d", name, i), sql) + } + return sqls +} + // prefixed qualifies a column list with a table alias so joins can reuse the // one list the scan order is written against. func prefixed(alias, columns string) string { From a65d0f2d04a8ba376529eb5bba5926e8ca82eca0 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 20:44:36 +0900 Subject: [PATCH 227/428] add the statements a tag change needs --- internal/db/tag_write.go | 224 ++++++++++++++++++++++++++++++++++ internal/db/tag_write_test.go | 191 +++++++++++++++++++++++++++++ 2 files changed, 415 insertions(+) create mode 100644 internal/db/tag_write.go create mode 100644 internal/db/tag_write_test.go diff --git a/internal/db/tag_write.go b/internal/db/tag_write.go new file mode 100644 index 00000000..0cae1c92 --- /dev/null +++ b/internal/db/tag_write.go @@ -0,0 +1,224 @@ +package db + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "slices" + "strings" + "time" + + "github.com/jackc/pgx/v5" +) + +const LogTags = "tags" + +const defaultTagCategory = "_default" + +type taggedName struct { + ID int64 `json:"id"` + Name string `json:"name"` +} + +var ( + qFindTagCategory = register("FindTagCategory", ` +SELECT id FROM web_tagscategory WHERE slug = $1`) + + qInsertTagCategory = register("InsertTagCategory", ` +INSERT INTO web_tagscategory (name, description, slug) +VALUES ($1, '', $1) +RETURNING id`) + + qFindTag = register("FindTag", ` +SELECT id FROM web_tag WHERE category_id = $1 AND name = $2`) + + qInsertTag = register("InsertTag", ` +INSERT INTO web_tag (category_id, name) VALUES ($1, $2) RETURNING id`) + + qReadArticleTags = register("ReadArticleTags", ` +SELECT t.id, c.slug, t.name +FROM web_article_tags at +JOIN web_tag t ON t.id = at.tag_id +JOIN web_tagscategory c ON c.id = t.category_id +WHERE at.article_id = $1 +ORDER BY t.id`) + + qDropArticleTags = register("DropArticleTags", ` +DELETE FROM web_article_tags WHERE article_id = $1 AND NOT (tag_id = ANY($2))`) + + qInsertArticleTag = register("InsertArticleTag", ` +INSERT INTO web_article_tags (article_id, tag_id) VALUES ($1, $2)`) + + qDropOrphanTags = register("DropOrphanTags", ` +DELETE FROM web_tag +WHERE NOT EXISTS (SELECT 1 FROM web_article_tags at WHERE at.tag_id = web_tag.id)`) + + // Only a category whose name was never set apart from its slug is swept up, + // which is how one somebody typed out survives losing its last tag. + qDropOrphanTagCategories = register("DropOrphanTagCategories", ` +DELETE FROM web_tagscategory +WHERE slug = name + AND NOT EXISTS (SELECT 1 FROM web_tag t WHERE t.category_id = web_tagscategory.id)`) +) + +// A name with a space in it is dropped rather than refused, so one bad entry +// does not cost the page the rest of its tags. +func (d *DB) SetArticleTags(ctx context.Context, articleID int64, tags []string, + allowCreate bool, userID *int64, at time.Time) (int, bool, error) { + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, false, fmt.Errorf("begin tags of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + wanted, err := resolveTags(ctx, tx, tags, allowCreate) + if err != nil { + return 0, false, fmt.Errorf("resolve tags of %d: %w", articleID, err) + } + held, err := readArticleTags(ctx, tx, articleID) + if err != nil { + return 0, false, fmt.Errorf("read tags of %d: %w", articleID, err) + } + + added := tagsMissingFrom(wanted, held) + removed := tagsMissingFrom(held, wanted) + if len(added) == 0 && len(removed) == 0 { + return 0, false, nil + } + + keep := make([]int64, 0, len(wanted)) + for _, tag := range wanted { + keep = append(keep, tag.ID) + } + if _, err := tx.Exec(ctx, qDropArticleTags, articleID, keep); err != nil { + return 0, false, fmt.Errorf("drop tags of %d: %w", articleID, err) + } + for _, tag := range added { + if _, err := tx.Exec(ctx, qInsertArticleTag, articleID, tag.ID); err != nil { + return 0, false, fmt.Errorf("tag %d: %w", articleID, err) + } + } + if allowCreate { + if _, err := tx.Exec(ctx, qDropOrphanTags); err != nil { + return 0, false, fmt.Errorf("sweep tags: %w", err) + } + if _, err := tx.Exec(ctx, qDropOrphanTagCategories); err != nil { + return 0, false, fmt.Errorf("sweep tag categories: %w", err) + } + } + + meta, err := json.Marshal(map[string]any{"added_tags": added, "removed_tags": removed}) + if err != nil { + return 0, false, fmt.Errorf("encode tag meta of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { + return 0, false, fmt.Errorf("lock article log %d: %w", articleID, err) + } + var revNumber int + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogTags, string(meta), "", at).Scan(&revNumber); err != nil { + return 0, false, fmt.Errorf("write revision of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { + return 0, false, fmt.Errorf("touch article %d: %w", articleID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, false, fmt.Errorf("commit tags of %d: %w", articleID, err) + } + return revNumber, true, nil +} + +func resolveTags(ctx context.Context, tx pgx.Tx, tags []string, allowCreate bool) ([]taggedName, error) { + var out []taggedName + for _, raw := range tags { + if strings.Contains(raw, " ") { + continue + } + category, name := splitTagName(strings.ToLower(raw)) + id, err := tagID(ctx, tx, category, name, allowCreate) + if err != nil { + return nil, err + } + if id == 0 { + continue + } + tag := taggedName{ID: id, Name: tagFullName(category, name)} + if !slices.ContainsFunc(out, func(other taggedName) bool { return other.ID == tag.ID }) { + out = append(out, tag) + } + } + return out, nil +} + +func tagID(ctx context.Context, tx pgx.Tx, category, name string, allowCreate bool) (int64, error) { + var categoryID int64 + err := tx.QueryRow(ctx, qFindTagCategory, category).Scan(&categoryID) + if errors.Is(err, pgx.ErrNoRows) { + if !allowCreate { + return 0, nil + } + if err := tx.QueryRow(ctx, qInsertTagCategory, category).Scan(&categoryID); err != nil { + return 0, err + } + } else if err != nil { + return 0, err + } + + var id int64 + err = tx.QueryRow(ctx, qFindTag, categoryID, name).Scan(&id) + if errors.Is(err, pgx.ErrNoRows) { + if !allowCreate { + return 0, nil + } + if err := tx.QueryRow(ctx, qInsertTag, categoryID, name).Scan(&id); err != nil { + return 0, err + } + } else if err != nil { + return 0, err + } + return id, nil +} + +func readArticleTags(ctx context.Context, tx pgx.Tx, articleID int64) ([]taggedName, error) { + rows, err := tx.Query(ctx, qReadArticleTags, articleID) + if err != nil { + return nil, err + } + defer rows.Close() + + var out []taggedName + for rows.Next() { + var id int64 + var category, name string + if err := rows.Scan(&id, &category, &name); err != nil { + return nil, err + } + out = append(out, taggedName{ID: id, Name: tagFullName(category, name)}) + } + return out, rows.Err() +} + +func splitTagName(full string) (category, name string) { + if c, n, ok := strings.Cut(full, ":"); ok { + return c, n + } + return defaultTagCategory, full +} + +func tagFullName(category, name string) string { + if category == defaultTagCategory { + return name + } + return category + ":" + name +} + +func tagsMissingFrom(want, have []taggedName) []taggedName { + out := []taggedName{} + for _, tag := range want { + if !slices.ContainsFunc(have, func(other taggedName) bool { return other.ID == tag.ID }) { + out = append(out, tag) + } + } + return out +} diff --git a/internal/db/tag_write_test.go b/internal/db/tag_write_test.go new file mode 100644 index 00000000..0308076e --- /dev/null +++ b/internal/db/tag_write_test.go @@ -0,0 +1,191 @@ +package db + +import ( + "context" + "encoding/json" + "testing" + "time" +) + +func tagNamesOf(t *testing.T, d *DB, articleID int64) []string { + t.Helper() + rows, err := d.pool.Query(context.Background(), ` +SELECT c.slug, t.name +FROM web_article_tags at +JOIN web_tag t ON t.id = at.tag_id +JOIN web_tagscategory c ON c.id = t.category_id +WHERE at.article_id = $1 +ORDER BY c.slug, t.name`, articleID) + if err != nil { + t.Fatalf("read tags err = %v, want nil", err) + } + defer rows.Close() + + var out []string + for rows.Next() { + var category, name string + if err := rows.Scan(&category, &name); err != nil { + t.Fatalf("scan tag err = %v, want nil", err) + } + out = append(out, tagFullName(category, name)) + } + return out +} + +func scratchTagged(t *testing.T, d *DB) int64 { + t.Helper() + id, err := d.CreateArticle(context.Background(), "_default", + "probe-tags-"+time.Now().Format("20060102150405.000000"), "Probe", nil, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + t.Cleanup(func() { + clean := context.Background() + if _, err := d.pool.Exec(clean, `DELETE FROM web_article_tags WHERE article_id = $1`, id); err != nil { + t.Errorf("clean up tags err = %v, want nil", err) + } + if _, err := d.pool.Exec(clean, qDropOrphanTags); err != nil { + t.Errorf("sweep tags err = %v, want nil", err) + } + if _, err := d.pool.Exec(clean, qDropOrphanTagCategories); err != nil { + t.Errorf("sweep tag categories err = %v, want nil", err) + } + }) + return id +} + +func TestSetArticleTagsCreatesWhatItIsAllowedTo(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchTagged(t, d) + stamp := time.Now().Format("150405.000000") + + _, wrote, err := d.SetArticleTags(ctx, id, + []string{"probe" + stamp, "probecat" + stamp + ":one"}, true, nil, time.Now().UTC()) + if err != nil { + t.Fatalf("SetArticleTags() err = %v, want nil", err) + } + if !wrote { + t.Fatal("SetArticleTags() wrote no revision, want one") + } + + got := tagNamesOf(t, d, id) + want := []string{"probe" + stamp, "probecat" + stamp + ":one"} + if len(got) != len(want) { + t.Fatalf("tags = %v, want %v", got, want) + } + for i := range want { + if got[i] != want[i] { + t.Errorf("tags[%d] = %q, want %q", i, got[i], want[i]) + } + } +} + +func TestSetArticleTagsSkipsWhatItMayNotCreate(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchTagged(t, d) + + _, wrote, err := d.SetArticleTags(ctx, id, + []string{"probe-never-seen-" + time.Now().Format("150405.000000")}, false, nil, time.Now().UTC()) + if err != nil { + t.Fatalf("SetArticleTags() err = %v, want nil", err) + } + if wrote { + t.Error("SetArticleTags() wrote a revision, want none") + } + if got := tagNamesOf(t, d, id); len(got) != 0 { + t.Errorf("tags = %v, want none", got) + } +} + +func TestSetArticleTagsDropsANameWithASpace(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchTagged(t, d) + stamp := time.Now().Format("150405.000000") + + if _, _, err := d.SetArticleTags(ctx, id, + []string{"two words", "probe" + stamp}, true, nil, time.Now().UTC()); err != nil { + t.Fatalf("SetArticleTags() err = %v, want nil", err) + } + got := tagNamesOf(t, d, id) + if len(got) != 1 || got[0] != "probe"+stamp { + t.Errorf("tags = %v, want [%q]", got, "probe"+stamp) + } +} + +func TestSetArticleTagsRecordsWhatMoved(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchTagged(t, d) + stamp := time.Now().Format("150405.000000") + at := time.Now().UTC() + + if _, _, err := d.SetArticleTags(ctx, id, []string{"probeold" + stamp}, true, nil, at); err != nil { + t.Fatalf("SetArticleTags(first) err = %v, want nil", err) + } + if _, _, err := d.SetArticleTags(ctx, id, []string{"probenew" + stamp}, true, nil, at.Add(time.Second)); err != nil { + t.Fatalf("SetArticleTags(second) err = %v, want nil", err) + } + + var raw []byte + if err := d.pool.QueryRow(ctx, + `SELECT meta FROM web_articlelogentry WHERE article_id = $1 AND rev_number = 1`, id).Scan(&raw); err != nil { + t.Fatalf("read revision err = %v, want nil", err) + } + var meta map[string][]taggedName + if err := json.Unmarshal(raw, &meta); err != nil { + t.Fatalf("decode meta err = %v, want nil", err) + } + if len(meta["added_tags"]) != 1 || meta["added_tags"][0].Name != "probenew"+stamp { + t.Errorf("meta added_tags = %v, want one named %q", meta["added_tags"], "probenew"+stamp) + } + if len(meta["removed_tags"]) != 1 || meta["removed_tags"][0].Name != "probeold"+stamp { + t.Errorf("meta removed_tags = %v, want one named %q", meta["removed_tags"], "probeold"+stamp) + } +} + +func TestSetArticleTagsKeepsQuietWhenNothingMoves(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchTagged(t, d) + stamp := time.Now().Format("150405.000000") + at := time.Now().UTC() + + if _, _, err := d.SetArticleTags(ctx, id, []string{"probe" + stamp}, true, nil, at); err != nil { + t.Fatalf("SetArticleTags(first) err = %v, want nil", err) + } + _, wrote, err := d.SetArticleTags(ctx, id, []string{"probe" + stamp}, true, nil, at.Add(time.Second)) + if err != nil { + t.Fatalf("SetArticleTags(second) err = %v, want nil", err) + } + if wrote { + t.Error("SetArticleTags() wrote a revision for an unchanged set, want none") + } +} + +func TestSetArticleTagsSweepsATagNothingCarries(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + id := scratchTagged(t, d) + stamp := time.Now().Format("150405.000000") + at := time.Now().UTC() + + if _, _, err := d.SetArticleTags(ctx, id, []string{"probegone" + stamp}, true, nil, at); err != nil { + t.Fatalf("SetArticleTags(first) err = %v, want nil", err) + } + if _, _, err := d.SetArticleTags(ctx, id, []string{"probekept" + stamp}, true, nil, at.Add(time.Second)); err != nil { + t.Fatalf("SetArticleTags(second) err = %v, want nil", err) + } + + var left int + if err := d.pool.QueryRow(ctx, + `SELECT count(*) FROM web_tag WHERE name = $1`, "probegone"+stamp).Scan(&left); err != nil { + t.Fatalf("count tags err = %v, want nil", err) + } + if left != 0 { + t.Errorf("count(tag nothing carries) = %d, want 0", left) + } +} From c0378dcbc901b29d2d2971824c95e23127b60363 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 20:44:36 +0900 Subject: [PATCH 228/428] add the statements an edit needs --- internal/db/article_write.go | 219 ++++++++++++++++ internal/db/article_write_test.go | 402 +++++++++++++++++++++++++++++- 2 files changed, 617 insertions(+), 4 deletions(-) diff --git a/internal/db/article_write.go b/internal/db/article_write.go index 4760e1ee..7b087552 100644 --- a/internal/db/article_write.go +++ b/internal/db/article_write.go @@ -5,13 +5,20 @@ import ( "crypto/rand" "encoding/json" "fmt" + "slices" "time" + + "github.com/jackc/pgx/v5" ) const ( LogNew = "new" LogSource = "source" LogParent = "parent" + LogTitle = "title" + LogName = "name" + + LogAuthorship = "authorship" ) type Revision struct { @@ -224,3 +231,215 @@ func (d *DB) SubscribeToArticle(ctx context.Context, userID, articleID int64) er } return nil } + +var ( + qReadArticleTitle = register("ReadArticleTitle", ` +SELECT title FROM web_article WHERE id = $1 FOR UPDATE`) + + qUpdateArticleTitle = register("UpdateArticleTitle", ` +UPDATE web_article SET title = $2 WHERE id = $1`) +) + +// The old title is read under the same lock that replaces it, so the revision +// cannot name a title some other writer has already moved past. +func (d *DB) UpdateArticleTitle(ctx context.Context, articleID int64, title string, + userID *int64, at time.Time) (int, error) { + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin title of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + var previous string + if err := tx.QueryRow(ctx, qReadArticleTitle, articleID).Scan(&previous); err != nil { + return 0, fmt.Errorf("read title of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qUpdateArticleTitle, articleID, title); err != nil { + return 0, fmt.Errorf("set title of %d: %w", articleID, err) + } + + meta, err := json.Marshal(map[string]any{"title": title, "prev_title": previous}) + if err != nil { + return 0, fmt.Errorf("encode title meta of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { + return 0, fmt.Errorf("lock article log %d: %w", articleID, err) + } + var revNumber int + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogTitle, string(meta), "", at).Scan(&revNumber); err != nil { + return 0, fmt.Errorf("write revision of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { + return 0, fmt.Errorf("touch article %d: %w", articleID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, fmt.Errorf("commit title of %d: %w", articleID, err) + } + return revNumber, nil +} + +// Locking leaves no revision behind, so the page history says nothing about it. +var qSetArticleLock = register("SetArticleLock", ` +UPDATE web_article SET locked = $2 WHERE id = $1`) + +func (d *DB) SetArticleLock(ctx context.Context, articleID int64, locked bool) error { + if _, err := d.pool.Exec(ctx, qSetArticleLock, articleID, locked); err != nil { + return fmt.Errorf("set lock of %d: %w", articleID, err) + } + return nil +} + +var ( + qKnownUsers = register("KnownUsers", ` +SELECT id FROM web_user WHERE id = ANY($1)`) + + qReadArticleAuthors = register("ReadArticleAuthors", ` +SELECT user_id FROM web_article_authors WHERE article_id = $1 ORDER BY user_id`) + + qDropArticleAuthors = register("DropArticleAuthors", ` +DELETE FROM web_article_authors WHERE article_id = $1 AND NOT (user_id = ANY($2))`) +) + +// An empty list means the caller had nothing to say, not that the page should +// lose the credit it has. +func (d *DB) SetArticleAuthors(ctx context.Context, articleID int64, authorIDs []int64, + userID *int64, at time.Time) (int, bool, error) { + + if len(authorIDs) == 0 { + return 0, false, nil + } + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, false, fmt.Errorf("begin authors of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + wanted, err := scanIDs(ctx, tx, qKnownUsers, authorIDs) + if err != nil { + return 0, false, fmt.Errorf("look up authors of %d: %w", articleID, err) + } + if len(wanted) == 0 { + return 0, false, nil + } + held, err := scanIDs(ctx, tx, qReadArticleAuthors, articleID) + if err != nil { + return 0, false, fmt.Errorf("read authors of %d: %w", articleID, err) + } + + added := missingFrom(wanted, held) + removed := missingFrom(held, wanted) + if len(added) == 0 && len(removed) == 0 { + return 0, false, nil + } + if _, err := tx.Exec(ctx, qDropArticleAuthors, articleID, wanted); err != nil { + return 0, false, fmt.Errorf("drop authors of %d: %w", articleID, err) + } + for _, id := range added { + if _, err := tx.Exec(ctx, qInsertArticleAuthor, articleID, id); err != nil { + return 0, false, fmt.Errorf("credit author of %d: %w", articleID, err) + } + } + + meta, err := json.Marshal(map[string]any{"added_authors": added, "removed_authors": removed}) + if err != nil { + return 0, false, fmt.Errorf("encode authorship meta of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { + return 0, false, fmt.Errorf("lock article log %d: %w", articleID, err) + } + var revNumber int + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogAuthorship, string(meta), "", at).Scan(&revNumber); err != nil { + return 0, false, fmt.Errorf("write revision of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { + return 0, false, fmt.Errorf("touch article %d: %w", articleID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, false, fmt.Errorf("commit authors of %d: %w", articleID, err) + } + return revNumber, true, nil +} + +func scanIDs(ctx context.Context, tx pgx.Tx, sql string, arg any) ([]int64, error) { + rows, err := tx.Query(ctx, sql, arg) + if err != nil { + return nil, err + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + return nil, err + } + out = append(out, id) + } + return out, rows.Err() +} + +func missingFrom(want, have []int64) []int64 { + out := []int64{} + for _, id := range want { + if !slices.Contains(have, id) { + out = append(out, id) + } + } + return out +} + +var ( + qRenameArticle = register("RenameArticle", ` +UPDATE web_article SET category = $2, name = $3 WHERE id = $1`) + + qDropLinksFrom = register("DropLinksFrom", ` +DELETE FROM web_externallink WHERE link_from = $1`) + + qMoveLinksFrom = register("MoveLinksFrom", ` +UPDATE web_externallink SET link_from = $2 WHERE link_from = $1`) +) + +// What a page points at moves with it, but what points at the page does not. +// Everyone who linked to the old name keeps linking to the old name. +func (d *DB) RenameArticle(ctx context.Context, articleID int64, category, name, from string, + userID *int64, at time.Time) (int, error) { + + to := (&Article{Category: category, Name: name}).FullName() + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin rename of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + if _, err := tx.Exec(ctx, qRenameArticle, articleID, category, name); err != nil { + return 0, fmt.Errorf("rename article %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qDropLinksFrom, to); err != nil { + return 0, fmt.Errorf("drop links of %q: %w", to, err) + } + if _, err := tx.Exec(ctx, qMoveLinksFrom, from, to); err != nil { + return 0, fmt.Errorf("move links of %q: %w", from, err) + } + + meta, err := json.Marshal(map[string]any{"name": to, "prev_name": from}) + if err != nil { + return 0, fmt.Errorf("encode rename meta of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { + return 0, fmt.Errorf("lock article log %d: %w", articleID, err) + } + var revNumber int + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogName, string(meta), "", at).Scan(&revNumber); err != nil { + return 0, fmt.Errorf("write revision of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { + return 0, fmt.Errorf("touch article %d: %w", articleID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, fmt.Errorf("commit rename of %d: %w", articleID, err) + } + return revNumber, nil +} diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go index 92247d9c..9e50c914 100644 --- a/internal/db/article_write_test.go +++ b/internal/db/article_write_test.go @@ -10,9 +10,9 @@ import ( func writeTestDB(t *testing.T) *DB { t.Helper() - dsn := os.Getenv(EnvDSN) + dsn := os.Getenv(EnvWriteDSN) if dsn == "" { - t.Skipf("%s not set, skipping the database test", EnvDSN) + t.Skipf("%s not set, skipping the write test", EnvWriteDSN) } conn, err := Open(context.Background(), dsn) if err != nil { @@ -66,7 +66,7 @@ func TestCreateArticleVersionNumbersFromZero(t *testing.T) { } second, err := d.CreateArticleVersion(ctx, VersionWrite{ - ArticleID: id, Source: "two", Kind: LogSource, Comment: "fixed a typo", At: at, + ArticleID: id, Source: "two", Kind: LogSource, Comment: "fixed a typo", At: at.Add(time.Second), }) if err != nil { t.Fatalf("CreateArticleVersion(source) err = %v, want nil", err) @@ -401,7 +401,8 @@ func TestSetArticleParentRecordsTheMove(t *testing.T) { } dropArticle(t, d, child) - rev, err := d.SetArticleParent(ctx, child, &parent, nil, `{"parent":"probe-parent"}`, at) + meta := `{"parent": "probe-parent", "prev_parent": null, "parent_id": null, "prev_parent_id": null}` + rev, err := d.SetArticleParent(ctx, child, &parent, nil, meta, at) if err != nil { t.Fatalf("SetArticleParent() err = %v, want nil", err) } @@ -465,3 +466,396 @@ func TestSubscribeToArticleOnlyOnce(t *testing.T) { t.Errorf("count(subscriptions) = %d, want 1", rows) } } + +func TestUpdateArticleTitleRecordsWhatItWas(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + at := time.Now().UTC().Truncate(time.Second) + + id, err := d.CreateArticle(ctx, "_default", + "probe-title-"+time.Now().Format("20060102150405.000000"), "Before", nil, at) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + + rev, err := d.UpdateArticleTitle(ctx, id, "After", nil, at) + if err != nil { + t.Fatalf("UpdateArticleTitle() err = %v, want nil", err) + } + if rev != 0 { + t.Errorf("UpdateArticleTitle() = %d, want 0", rev) + } + + article, err := d.ArticleByID(ctx, id) + if err != nil { + t.Fatalf("ArticleByID() err = %v, want nil", err) + } + if article.Title != "After" { + t.Errorf("ArticleByID().Title = %q, want %q", article.Title, "After") + } + + var kind string + var raw []byte + if err := d.pool.QueryRow(ctx, + `SELECT type, meta FROM web_articlelogentry WHERE article_id = $1 AND rev_number = 0`, + id).Scan(&kind, &raw); err != nil { + t.Fatalf("read revision err = %v, want nil", err) + } + if kind != LogTitle { + t.Errorf("revision type = %q, want %q", kind, LogTitle) + } + var meta map[string]any + if err := json.Unmarshal(raw, &meta); err != nil { + t.Fatalf("decode meta err = %v, want nil", err) + } + if got, want := meta["prev_title"], "Before"; got != want { + t.Errorf("meta prev_title = %v, want %q", got, want) + } + if got, want := meta["title"], "After"; got != want { + t.Errorf("meta title = %v, want %q", got, want) + } +} + +func TestSetArticleLockLeavesNoRevision(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + + id, err := d.CreateArticle(ctx, "_default", + "probe-lock-"+time.Now().Format("20060102150405.000000"), "Probe", nil, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + + if err := d.SetArticleLock(ctx, id, true); err != nil { + t.Fatalf("SetArticleLock() err = %v, want nil", err) + } + article, err := d.ArticleByID(ctx, id) + if err != nil { + t.Fatalf("ArticleByID() err = %v, want nil", err) + } + if !article.Locked { + t.Error("ArticleByID().Locked = false, want true") + } + + var revisions int + if err := d.pool.QueryRow(ctx, + `SELECT count(*) FROM web_articlelogentry WHERE article_id = $1`, id).Scan(&revisions); err != nil { + t.Fatalf("count revisions err = %v, want nil", err) + } + if revisions != 0 { + t.Errorf("count(revisions) after locking = %d, want 0", revisions) + } +} + +func twoUsers(t *testing.T, d *DB) (int64, int64) { + t.Helper() + rows, err := d.pool.Query(context.Background(), `SELECT id FROM web_user ORDER BY id LIMIT 2`) + if err != nil { + t.Fatalf("read users err = %v, want nil", err) + } + defer rows.Close() + + var ids []int64 + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + t.Fatalf("scan user err = %v, want nil", err) + } + ids = append(ids, id) + } + if len(ids) < 2 { + t.Skip("the database holds fewer than two users") + } + return ids[0], ids[1] +} + +func authorsOf(t *testing.T, d *DB, id int64) []int64 { + t.Helper() + rows, err := d.pool.Query(context.Background(), + `SELECT user_id FROM web_article_authors WHERE article_id = $1 ORDER BY user_id`, id) + if err != nil { + t.Fatalf("read authors err = %v, want nil", err) + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var user int64 + if err := rows.Scan(&user); err != nil { + t.Fatalf("scan author err = %v, want nil", err) + } + out = append(out, user) + } + return out +} + +func TestSetArticleAuthorsReplacesTheCredit(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + first, second := twoUsers(t, d) + at := time.Now().UTC().Truncate(time.Second) + + id, err := d.CreateArticle(ctx, "_default", + "probe-authors-"+time.Now().Format("20060102150405.000000"), "Probe", &first, at) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + + rev, wrote, err := d.SetArticleAuthors(ctx, id, []int64{second}, nil, at) + if err != nil { + t.Fatalf("SetArticleAuthors() err = %v, want nil", err) + } + if !wrote { + t.Fatal("SetArticleAuthors() wrote no revision, want one") + } + if rev != 0 { + t.Errorf("SetArticleAuthors() = %d, want 0", rev) + } + + got := authorsOf(t, d, id) + if len(got) != 1 || got[0] != second { + t.Errorf("authors = %v, want [%d]", got, second) + } + + var raw []byte + if err := d.pool.QueryRow(ctx, + `SELECT meta FROM web_articlelogentry WHERE article_id = $1 AND rev_number = 0`, id).Scan(&raw); err != nil { + t.Fatalf("read revision err = %v, want nil", err) + } + var meta map[string][]int64 + if err := json.Unmarshal(raw, &meta); err != nil { + t.Fatalf("decode meta err = %v, want nil", err) + } + if len(meta["added_authors"]) != 1 || meta["added_authors"][0] != second { + t.Errorf("meta added_authors = %v, want [%d]", meta["added_authors"], second) + } + if len(meta["removed_authors"]) != 1 || meta["removed_authors"][0] != first { + t.Errorf("meta removed_authors = %v, want [%d]", meta["removed_authors"], first) + } +} + +func TestSetArticleAuthorsKeepsQuietWhenNothingMoves(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + first, _ := twoUsers(t, d) + at := time.Now().UTC().Truncate(time.Second) + + id, err := d.CreateArticle(ctx, "_default", + "probe-samecredit-"+time.Now().Format("20060102150405.000000"), "Probe", &first, at) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + + _, wrote, err := d.SetArticleAuthors(ctx, id, []int64{first}, nil, at) + if err != nil { + t.Fatalf("SetArticleAuthors() err = %v, want nil", err) + } + if wrote { + t.Error("SetArticleAuthors() wrote a revision, want none") + } +} + +func TestSetArticleAuthorsIgnoresAnEmptyList(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + first, _ := twoUsers(t, d) + at := time.Now().UTC().Truncate(time.Second) + + id, err := d.CreateArticle(ctx, "_default", + "probe-nocredit-"+time.Now().Format("20060102150405.000000"), "Probe", &first, at) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + + if _, wrote, err := d.SetArticleAuthors(ctx, id, nil, nil, at); err != nil || wrote { + t.Errorf("SetArticleAuthors(nil) = %v, %v, want false, nil", wrote, err) + } + if got := authorsOf(t, d, id); len(got) != 1 || got[0] != first { + t.Errorf("authors = %v, want [%d]", got, first) + } +} + +func TestRenameArticleTakesItsLinksAlong(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + at := time.Now().UTC().Truncate(time.Second) + stamp := time.Now().Format("20060102150405.000000") + from := "probe-from-" + stamp + to := "probe-to-" + stamp + + id, err := d.CreateArticle(ctx, "_default", from, "Probe", nil, at) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + t.Cleanup(func() { + for _, name := range []string{from, to} { + if _, err := d.pool.Exec(context.Background(), + `DELETE FROM web_externallink WHERE link_from = $1`, name); err != nil { + t.Errorf("clean up links err = %v, want nil", err) + } + } + }) + + if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "main", Kind: LinkPlain}}); err != nil { + t.Fatalf("ReplaceArticleLinks() err = %v, want nil", err) + } + + rev, err := d.RenameArticle(ctx, id, "_default", to, from, nil, at) + if err != nil { + t.Fatalf("RenameArticle() err = %v, want nil", err) + } + if rev != 0 { + t.Errorf("RenameArticle() = %d, want 0", rev) + } + + article, err := d.ArticleByID(ctx, id) + if err != nil { + t.Fatalf("ArticleByID() err = %v, want nil", err) + } + if article.Name != to { + t.Errorf("ArticleByID().Name = %q, want %q", article.Name, to) + } + if got := linkSet(t, d, to); !got["link main"] { + t.Errorf("links of %q = %v, want them moved over", to, got) + } + if got := linkSet(t, d, from); len(got) != 0 { + t.Errorf("links of %q = %v, want none left", from, got) + } + + var kind string + var raw []byte + if err := d.pool.QueryRow(ctx, + `SELECT type, meta FROM web_articlelogentry WHERE article_id = $1 AND rev_number = 0`, + id).Scan(&kind, &raw); err != nil { + t.Fatalf("read revision err = %v, want nil", err) + } + if kind != LogName { + t.Errorf("revision type = %q, want %q", kind, LogName) + } + var meta map[string]string + if err := json.Unmarshal(raw, &meta); err != nil { + t.Fatalf("decode meta err = %v, want nil", err) + } + if meta["prev_name"] != from || meta["name"] != to { + t.Errorf("meta = %v, want prev_name %q and name %q", meta, from, to) + } +} + +func TestRenameArticleClearsWhatSatUnderTheNewName(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + at := time.Now().UTC().Truncate(time.Second) + stamp := time.Now().Format("20060102150405.000000") + from := "probe-old-" + stamp + to := "probe-new-" + stamp + + id, err := d.CreateArticle(ctx, "_default", from, "Probe", nil, at) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + dropArticle(t, d, id) + t.Cleanup(func() { + for _, name := range []string{from, to} { + if _, err := d.pool.Exec(context.Background(), + `DELETE FROM web_externallink WHERE link_from = $1`, name); err != nil { + t.Errorf("clean up links err = %v, want nil", err) + } + } + }) + + if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "kept", Kind: LinkPlain}}); err != nil { + t.Fatalf("ReplaceArticleLinks(from) err = %v, want nil", err) + } + if err := d.ReplaceArticleLinks(ctx, to, []ArticleLink{{To: "stale", Kind: LinkPlain}}); err != nil { + t.Fatalf("ReplaceArticleLinks(to) err = %v, want nil", err) + } + + if _, err := d.RenameArticle(ctx, id, "_default", to, from, nil, at); err != nil { + t.Fatalf("RenameArticle() err = %v, want nil", err) + } + got := linkSet(t, d, to) + if got["link stale"] { + t.Errorf("links of %q still carry the stale one, got %v", to, got) + } + if !got["link kept"] { + t.Errorf("links of %q missing the moved one, got %v", to, got) + } +} + +func TestDeleteArticleTakesEverythingThatPointsAtIt(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + at := time.Now().UTC().Truncate(time.Second) + stamp := time.Now().Format("20060102150405.000000") + name := "probe-doomed-" + stamp + + var author int64 + if err := d.pool.QueryRow(ctx, `SELECT id FROM web_user ORDER BY id LIMIT 1`).Scan(&author); err != nil { + t.Fatalf("read a user err = %v, want nil", err) + } + id, err := d.CreateArticle(ctx, "_default", name, "Probe", &author, at) + if err != nil { + t.Fatalf("CreateArticle() err = %v, want nil", err) + } + if _, err := d.CreateArticleVersion(ctx, VersionWrite{ + ArticleID: id, Source: "body", Kind: LogNew, Title: "Probe", At: at, + }); err != nil { + t.Fatalf("CreateArticleVersion() err = %v, want nil", err) + } + if err := d.SubscribeToArticle(ctx, author, id); err != nil { + t.Fatalf("SubscribeToArticle() err = %v, want nil", err) + } + if err := d.ReplaceArticleLinks(ctx, name, []ArticleLink{{To: "main", Kind: LinkPlain}}); err != nil { + t.Fatalf("ReplaceArticleLinks() err = %v, want nil", err) + } + + child, err := d.CreateArticle(ctx, "_default", "probe-orphan-"+stamp, "Child", nil, at) + if err != nil { + t.Fatalf("CreateArticle(child) err = %v, want nil", err) + } + dropArticle(t, d, child) + if _, err := d.SetArticleParent(ctx, child, &id, nil, + `{"parent": "x", "prev_parent": null, "parent_id": null, "prev_parent_id": null}`, at); err != nil { + t.Fatalf("SetArticleParent() err = %v, want nil", err) + } + + if err := d.DeleteArticle(ctx, id, name); err != nil { + t.Fatalf("DeleteArticle() err = %v, want nil", err) + } + + for _, probe := range []struct { + what string + sql string + }{ + {"article", `SELECT count(*) FROM web_article WHERE id = $1`}, + {"versions", `SELECT count(*) FROM web_articleversion WHERE article_id = $1`}, + {"revisions", `SELECT count(*) FROM web_articlelogentry WHERE article_id = $1`}, + {"authors", `SELECT count(*) FROM web_article_authors WHERE article_id = $1`}, + {"subscriptions", `SELECT count(*) FROM web_usernotificationsubscription WHERE article_id = $1`}, + } { + var left int + if err := d.pool.QueryRow(ctx, probe.sql, id).Scan(&left); err != nil { + t.Fatalf("count %s err = %v, want nil", probe.what, err) + } + if left != 0 { + t.Errorf("count(%s) after deleting = %d, want 0", probe.what, left) + } + } + if got := linkSet(t, d, name); len(got) != 0 { + t.Errorf("links of %q after deleting = %v, want none", name, got) + } + + orphan, err := d.ArticleByID(ctx, child) + if err != nil { + t.Fatalf("ArticleByID(child) err = %v, want nil", err) + } + if orphan.ParentID != nil { + t.Errorf("child ParentID after deleting the parent = %v, want nil", orphan.ParentID) + } +} From 562f7bc3a45a645363101d52cb0517c58b4a898d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 20:44:36 +0900 Subject: [PATCH 229/428] delete every row that points at a page --- internal/db/article_delete.go | 57 +++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 internal/db/article_delete.go diff --git a/internal/db/article_delete.go b/internal/db/article_delete.go new file mode 100644 index 00000000..16207a2e --- /dev/null +++ b/internal/db/article_delete.go @@ -0,0 +1,57 @@ +package db + +import ( + "context" + "fmt" +) + +// Nothing in the schema cascades, so every row that points at the page has to +// be named here. The order is the one the foreign keys allow. +var articleChildren = []string{ + `DELETE FROM web_forumpostversion WHERE post_id IN ( + SELECT p.id FROM web_forumpost p + JOIN web_forumthread t ON t.id = p.thread_id + WHERE t.article_id = $1)`, + `UPDATE web_forumpost SET reply_to_id = NULL WHERE thread_id IN ( + SELECT id FROM web_forumthread WHERE article_id = $1)`, + `DELETE FROM web_forumpost WHERE thread_id IN ( + SELECT id FROM web_forumthread WHERE article_id = $1)`, + `DELETE FROM web_usernotificationsubscription WHERE forum_thread_id IN ( + SELECT id FROM web_forumthread WHERE article_id = $1)`, + `DELETE FROM web_forumthread WHERE article_id = $1`, + `DELETE FROM web_usernotificationsubscription WHERE article_id = $1`, + `DELETE FROM web_vote WHERE article_id = $1`, + `DELETE FROM web_file WHERE article_id = $1`, + `DELETE FROM web_article_tags WHERE article_id = $1`, + `DELETE FROM web_article_authors WHERE article_id = $1`, + `DELETE FROM web_articlelogentry WHERE article_id = $1`, + `DELETE FROM web_articleversion WHERE article_id = $1`, + `UPDATE web_articlesearchindex SET article_id = NULL WHERE article_id = $1`, + `UPDATE web_article SET parent_id = NULL WHERE parent_id = $1`, + `DELETE FROM web_article WHERE id = $1`, +} + +var qDeleteArticle = registerAll("DeleteArticle", articleChildren) + +// The files on disk are left to the caller, which is the only layer that knows +// where the state directory is. +func (d *DB) DeleteArticle(ctx context.Context, articleID int64, fullName string) error { + tx, err := d.pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin delete of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + if _, err := tx.Exec(ctx, qDropLinksFrom, fullName); err != nil { + return fmt.Errorf("drop links of %q: %w", fullName, err) + } + for _, sql := range qDeleteArticle { + if _, err := tx.Exec(ctx, sql, articleID); err != nil { + return fmt.Errorf("delete article %d: %w", articleID, err) + } + } + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit delete of %d: %w", articleID, err) + } + return nil +} From 7932d6e4c5c82689ab9ba04746c6c920da27b482 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:12:55 +0900 Subject: [PATCH 230/428] read the tag setting off a category --- internal/db/options.go | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/internal/db/options.go b/internal/db/options.go index faddd8c5..25c1c04e 100644 --- a/internal/db/options.go +++ b/internal/db/options.go @@ -33,6 +33,39 @@ func (d *DB) SiteCanCreateTags(ctx context.Context, siteID int64) (string, error return mode, nil } +var qCategoryCanCreateTags = register("CategoryCanCreateTags", ` +SELECT s.can_user_create_tags +FROM web_settings s +JOIN web_category c ON c.id = s.category_id +WHERE c.name = $1`) + +// A category with no row of its own reads the same as one left on default. Both +// hand the question back to the site. +func (d *DB) CategoryCanCreateTags(ctx context.Context, category string) (string, error) { + var mode string + err := d.pool.QueryRow(ctx, qCategoryCanCreateTags, category).Scan(&mode) + if errors.Is(err, pgx.ErrNoRows) { + return "", ErrNotFound + } + if err != nil { + return "", fmt.Errorf("query tag setting of category %q: %w", category, err) + } + return mode, nil +} + +// Creating tags is off unless something turns it on, and the category has the +// last word. +func CreatingTagsAllowed(siteMode, categoryMode string) bool { + mode := CreateTagsDisabled + if siteMode != "" && siteMode != CreateTagsDefault { + mode = siteMode + } + if categoryMode != "" && categoryMode != CreateTagsDefault { + mode = categoryMode + } + return mode == CreateTagsEnabled +} + type CommentInfo struct { ThreadID int64 Count int From 386d2a783aa6139e4183ffc41de1a0079bb3c801 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:12:55 +0900 Subject: [PATCH 231/428] add the statements the search index needs --- internal/db/search_write.go | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 internal/db/search_write.go diff --git a/internal/db/search_write.go b/internal/db/search_write.go new file mode 100644 index 00000000..5f9f5b0f --- /dev/null +++ b/internal/db/search_write.go @@ -0,0 +1,36 @@ +package db + +import ( + "context" + "fmt" +) + +var ( + // Two configurations are stacked because a page can hold either language and + // the column is the only place the search reads from. + qUpdateSearchIndex = register("UpdateSearchIndex", ` +UPDATE web_articlesearchindex +SET content_source = $2, + content_plaintext = $3, + vector_plaintext = to_tsvector('english', $3) || to_tsvector('russian', $3) +WHERE article_id = $1`) + + qInsertSearchIndex = register("InsertSearchIndex", ` +INSERT INTO web_articlesearchindex (article_id, content_source, content_plaintext, vector_plaintext) +SELECT $1, $2, $3, to_tsvector('english', $3) || to_tsvector('russian', $3) +WHERE NOT EXISTS (SELECT 1 FROM web_articlesearchindex WHERE article_id = $1)`) +) + +func (d *DB) UpdateSearchIndex(ctx context.Context, articleID int64, source, plaintext string) error { + tag, err := d.pool.Exec(ctx, qUpdateSearchIndex, articleID, source, plaintext) + if err != nil { + return fmt.Errorf("update search index of %d: %w", articleID, err) + } + if tag.RowsAffected() > 0 { + return nil + } + if _, err := d.pool.Exec(ctx, qInsertSearchIndex, articleID, source, plaintext); err != nil { + return fmt.Errorf("write search index of %d: %w", articleID, err) + } + return nil +} From 44a296a73ff1e8d40443e45622fe4187450481d1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:12:55 +0900 Subject: [PATCH 232/428] reach the user json without a module --- internal/repo/modules.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 7b566393..154c0363 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -313,14 +313,18 @@ func (m moduleData) ArticleObject(article *db.Article, viewer *db.User) (*perms. } func (m moduleData) UserJSON(u *db.User) (wikijson.Object, error) { + return UserJSON(m.repo.ctx, m.repo.db, u) +} + +func UserJSON(ctx context.Context, d *db.DB, u *db.User) (wikijson.Object, error) { if u == nil { return pageconfig.SystemUserJSON().Object(), nil } - userRoles, err := m.repo.db.RolesByUser(m.repo.ctx, u.ID) + userRoles, err := d.RolesByUser(ctx, u.ID) if err != nil { return nil, err } - subject, err := NewPerms(m.repo.ctx, m.repo.db).Subject(u, time.Now()) + subject, err := NewPerms(ctx, d).Subject(u, time.Now()) if err != nil { return nil, err } From 918bae642dd730af0d005670c7f72fc84374f881 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:12:56 +0900 Subject: [PATCH 233/428] hand the files root to the article api --- cmd/pwikit/articles.go | 3 ++- internal/webapi/webapi.go | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go index 471429af..daf9b5ce 100644 --- a/cmd/pwikit/articles.go +++ b/cmd/pwikit/articles.go @@ -61,7 +61,8 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl Log: log, }) items := localitem.Deps{DB: conn, Engine: engine, Bundle: bundle, Icons: icons, Log: log} - api := webapi.Deps{DB: conn, Trust: trust, Engine: engine, Bundle: bundle, Icons: icons, Log: log} + api := webapi.Deps{DB: conn, Trust: trust, Engine: engine, Bundle: bundle, Icons: icons, + Files: p.Files(), Log: log} profiles := userpage.Deps{ DB: conn, Engine: engine, Bundle: bundle, Icons: icons, diff --git a/internal/webapi/webapi.go b/internal/webapi/webapi.go index 237dc4fa..dfc51da3 100644 --- a/internal/webapi/webapi.go +++ b/internal/webapi/webapi.go @@ -44,6 +44,7 @@ type Deps struct { Engine renderer.Renderer Bundle *i18n.Bundle Icons roles.IconLoader + Files string Log *slog.Logger } From 8a277627bef76aad475700c39bf58f10a10267a0 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:13:07 +0900 Subject: [PATCH 234/428] share the render environment the api builds --- internal/webapi/create.go | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/internal/webapi/create.go b/internal/webapi/create.go index c4181549..bf52f7a1 100644 --- a/internal/webapi/create.go +++ b/internal/webapi/create.go @@ -174,9 +174,7 @@ func (h *Articles) refreshLinks(r *http.Request, current *db.Site, id int64, sou if err != nil { return err } - loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) - env := pagerender.Deps{DB: h.deps.DB, Engine: h.deps.Engine, Icons: h.deps.Icons}. - Env(ctx, loc, current, nil) + env := h.env(r, current, nil) info, err := env.PageInfo(article) if err != nil { @@ -190,6 +188,12 @@ func (h *Articles) refreshLinks(r *http.Request, current *db.Site, id int64, sou return h.deps.DB.ReplaceArticleLinks(ctx, strings.ToLower(article.FullName()), links) } +func (h *Articles) env(r *http.Request, current *db.Site, viewer *db.User) *pagerender.Env { + loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) + return pagerender.Deps{DB: h.deps.DB, Engine: h.deps.Engine, Icons: h.deps.Icons}. + Env(r.Context(), loc, current, viewer) +} + func (h *Articles) setParent(r *http.Request, current *db.Site, id int64, input createInput, userID *int64, at time.Time) error { From 39a32713df6bc0956a89aab0f277b4aaaee07458 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:13:07 +0900 Subject: [PATCH 235/428] answer the call that edits a page --- internal/webapi/update.go | 497 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 497 insertions(+) create mode 100644 internal/webapi/update.go diff --git a/internal/webapi/update.go b/internal/webapi/update.go new file mode 100644 index 00000000..4726aa11 --- /dev/null +++ b/internal/webapi/update.go @@ -0,0 +1,497 @@ +package webapi + +import ( + "encoding/json" + "errors" + "io" + "net/http" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/renderer" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +// A key that is present and null does not mean the same as a key that is +// absent, so the body is kept as fields until each one is asked for. +type fields map[string]json.RawMessage + +func (f fields) has(key string) bool { _, ok := f[key]; return ok } + +func (f fields) text(key string) (string, bool) { + var out string + if raw, ok := f[key]; ok && json.Unmarshal(raw, &out) == nil { + return out, true + } + return "", false +} + +func (f fields) flag(key string) (bool, bool) { + var out bool + if raw, ok := f[key]; ok && json.Unmarshal(raw, &out) == nil { + return out, true + } + return false, false +} + +func (f fields) list(key string) ([]string, bool) { + var out []string + if raw, ok := f[key]; ok && json.Unmarshal(raw, &out) == nil { + return out, true + } + return nil, false +} + +type editor struct { + handler *Articles + req *http.Request + loc *i18n.Localizer + site *db.Site + user *db.User + userID *int64 + subject perms.Subject + perm *repo.Perms + at time.Time + + article *db.Article + body fields +} + +func (h *Articles) update(r *http.Request, loc *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", 0, errors.New("webapi: the request carries no site") + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return field("error", loc.T("api-csrf-failed")), http.StatusForbidden, nil + } + + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + raw, err := io.ReadAll(io.LimitReader(r.Body, bodyLimit+1)) + if err != nil || len(raw) == 0 || len(raw) > bodyLimit { + return field("error", loc.T("api-bad-request")), http.StatusBadRequest, nil + } + var body fields + if err := json.Unmarshal(raw, &body); err != nil { + return field("error", loc.T("api-bad-json")), http.StatusBadRequest, nil + } + if bad := validateEdit(body); bad != nil { + return field("error", loc.T(bad.key)), bad.status, nil + } + + user := auth.FromContext(ctx) + perm := repo.NewPerms(ctx, h.deps.DB) + subject, err := perm.Subject(user, time.Now()) + if err != nil { + return "", 0, err + } + e := &editor{ + handler: h, req: r, loc: loc, site: current, user: user, + perm: perm, subject: subject, at: time.Now().UTC(), + article: article, body: body, + } + if user != nil { + e.userID = &user.ID + } + + if bad, err := e.apply(); err != nil { + return "", 0, err + } else if bad != nil { + return field("error", loc.T(bad.key)), bad.status, nil + } + return e.answer() +} + +func validateEdit(body fields) *refusal { + id, ok := body.text("pageId") + if !ok || id == "" || !wikidot.NameAllowed(id) { + return ptr(refuse("api-bad-page-id", http.StatusBadRequest)) + } + if body.has("source") { + source, ok := body.text("source") + if !ok || strings.TrimSpace(source) == "" { + return ptr(refuse("api-missing-source", http.StatusBadRequest)) + } + if len(source) > sourceLimit { + return ptr(refuse("api-source-too-long", http.StatusBadRequest)) + } + } + if body.has("title") { + if _, ok := body.text("title"); !ok { + return ptr(refuse("api-missing-title", http.StatusBadRequest)) + } + } + return nil +} + +// The order the pieces run in is the order the page's own history will show +// them, so a rename lands before the edit that follows it. +func (e *editor) apply() (*refusal, error) { + for _, step := range []func() (*refusal, error){ + e.rename, e.retitle, e.rewrite, e.retag, e.reparent, e.relock, e.recredit, + } { + if bad, err := step(); err != nil || bad != nil { + return bad, err + } + } + return nil, nil +} + +func (e *editor) may(permission string) bool { + object, err := e.perm.Article(e.article, e.user) + if err != nil { + return false + } + return perms.Resolve(e.subject, object).Has(permission) +} + +func (e *editor) rename() (*refusal, error) { + asked, _ := e.body.text("pageId") + from := e.article.FullName() + if strings.EqualFold(asked, from) { + return nil, nil + } + wanted := wikidot.Normalize(asked) + if strings.EqualFold(wanted, from) { + return nil, nil + } + + category, _ := wikidot.Split(wanted) + target, err := e.perm.Category(category) + if err != nil { + return nil, err + } + if !e.may(perms.MoveArticles) || !perms.Resolve(e.subject, target).Has(perms.MoveArticles) { + return ptr(refuse("api-forbidden", http.StatusForbidden)), nil + } + + forced, _ := e.body.flag("forcePageId") + taken, err := e.handler.deps.DB.ArticleByName(e.req.Context(), wanted) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + if taken != nil && taken.ID != e.article.ID && !forced { + return ptr(refuse("api-page-exists", http.StatusConflict)), nil + } + free, err := e.free(wanted) + if err != nil { + return nil, err + } + + newCategory, newName := wikidot.Split(free) + if _, err := e.handler.deps.DB.RenameArticle(e.req.Context(), e.article.ID, + newCategory, newName, from, e.userID, e.at); err != nil { + return nil, err + } + e.article.Category, e.article.Name = newCategory, newName + return nil, nil +} + +// Without a free name the move would fail on the unique constraint. +func (e *editor) free(wanted string) (string, error) { + for i := 1; ; i++ { + candidate := wanted + if i > 1 { + candidate = wanted + "-" + strconv.Itoa(i) + } + found, err := e.handler.deps.DB.ArticleByName(e.req.Context(), candidate) + if errors.Is(err, db.ErrNotFound) { + return candidate, nil + } + if err != nil { + return "", err + } + if found.ID == e.article.ID { + return candidate, nil + } + } +} + +func (e *editor) retitle() (*refusal, error) { + title, ok := e.body.text("title") + if !ok || title == e.article.Title { + return nil, nil + } + if !e.may(perms.EditArticles) { + return ptr(refuse("api-forbidden", http.StatusForbidden)), nil + } + if _, err := e.handler.deps.DB.UpdateArticleTitle(e.req.Context(), e.article.ID, title, e.userID, e.at); err != nil { + return nil, err + } + e.article.Title = title + return nil, nil +} + +func (e *editor) rewrite() (*refusal, error) { + source, ok := e.body.text("source") + if !ok { + return nil, nil + } + ctx := e.req.Context() + previous, err := e.handler.deps.DB.LatestSource(ctx, e.article.ID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + if source == previous { + return nil, nil + } + if !e.may(perms.EditArticles) { + return ptr(refuse("api-forbidden", http.StatusForbidden)), nil + } + + comment, _ := e.body.text("comment") + if _, err := e.handler.deps.DB.CreateArticleVersion(ctx, db.VersionWrite{ + ArticleID: e.article.ID, + Source: source, + UserID: e.userID, + Kind: db.LogSource, + Comment: comment, + At: e.at, + }); err != nil { + return nil, err + } + return nil, e.handler.refreshLinks(e.req, e.site, e.article.ID, source) +} + +func (e *editor) retag() (*refusal, error) { + tags, ok := e.body.list("tags") + if !ok { + return nil, nil + } + if !e.may(perms.TagArticles) { + return ptr(refuse("api-forbidden", http.StatusForbidden)), nil + } + allow, err := e.mayCreateTags() + if err != nil { + return nil, err + } + _, _, err = e.handler.deps.DB.SetArticleTags(e.req.Context(), e.article.ID, tags, allow, e.userID, e.at) + return nil, err +} + +func (e *editor) mayCreateTags() (bool, error) { + ctx := e.req.Context() + siteMode, err := e.handler.deps.DB.SiteCanCreateTags(ctx, e.site.ID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return false, err + } + own, err := e.handler.deps.DB.CategoryCanCreateTags(ctx, e.article.Category) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return false, err + } + return db.CreatingTagsAllowed(siteMode, own), nil +} + +func (e *editor) reparent() (*refusal, error) { + if !e.body.has("parent") { + return nil, nil + } + if !e.may(perms.EditArticles) { + return ptr(refuse("api-forbidden", http.StatusForbidden)), nil + } + ctx := e.req.Context() + + wanted, _ := e.body.text("parent") + var parentID *int64 + if wanted != "" { + parent, err := e.handler.deps.DB.ArticleByName(ctx, wikidot.Normalize(wanted)) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + if parent != nil { + parentID = &parent.ID + } + } + if samePointer(e.article.ParentID, parentID) { + return nil, nil + } + + previous, err := e.parentName(e.article.ParentID) + if err != nil { + return nil, err + } + meta, err := json.Marshal(map[string]any{ + "parent": nullable(wanted), "prev_parent": nullable(previous), + "parent_id": parentID, "prev_parent_id": e.article.ParentID, + }) + if err != nil { + return nil, err + } + if _, err := e.handler.deps.DB.SetArticleParent(ctx, e.article.ID, parentID, e.userID, string(meta), e.at); err != nil { + return nil, err + } + e.article.ParentID = parentID + return nil, nil +} + +func (e *editor) parentName(id *int64) (string, error) { + if id == nil { + return "", nil + } + parent, err := e.handler.deps.DB.ArticleByID(e.req.Context(), *id) + if errors.Is(err, db.ErrNotFound) { + return "", nil + } + if err != nil { + return "", err + } + return parent.FullName(), nil +} + +func (e *editor) relock() (*refusal, error) { + locked, ok := e.body.flag("locked") + if !ok || locked == e.article.Locked { + return nil, nil + } + if !e.may(perms.LockArticles) { + return ptr(refuse("api-forbidden", http.StatusForbidden)), nil + } + if err := e.handler.deps.DB.SetArticleLock(e.req.Context(), e.article.ID, locked); err != nil { + return nil, err + } + e.article.Locked = locked + return nil, nil +} + +func (e *editor) recredit() (*refusal, error) { + raw, ok := e.body.list("authorsIds") + if !ok { + return nil, nil + } + if !e.may(perms.EditArticles) || !e.may(perms.ManageArticleAuthors) { + return ptr(refuse("api-forbidden", http.StatusForbidden)), nil + } + + ids := make([]int64, 0, len(raw)) + for _, one := range raw { + if id, err := strconv.ParseInt(one, 10, 64); err == nil { + ids = append(ids, id) + } + } + _, _, err := e.handler.deps.DB.SetArticleAuthors(e.req.Context(), e.article.ID, ids, e.userID, e.at) + return nil, err +} + +func (e *editor) answer() (string, int, error) { + ctx := e.req.Context() + article, err := e.handler.deps.DB.ArticleByID(ctx, e.article.ID) + if err != nil { + return "", 0, err + } + source, err := e.handler.deps.DB.LatestSource(ctx, article.ID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", 0, err + } + if err := e.reindex(article, source); err != nil { + return "", 0, err + } + + body, err := e.handler.articleJSON(e.req, article, source) + if err != nil { + return "", 0, err + } + return body, http.StatusOK, nil +} + +// A source the engine cannot read still has to be searchable, so the raw text +// stands in for the rendering. +func (e *editor) reindex(article *db.Article, source string) error { + if source == "" { + return nil + } + indexed := article.Title + "\n\n" + source + plaintext := indexed + if text, err := e.handler.renderText(e.req, e.site, article, source); err == nil { + plaintext = article.Title + "\n\n" + text + } + return e.handler.deps.DB.UpdateSearchIndex(e.req.Context(), article.ID, indexed, plaintext) +} + +func samePointer(a, b *int64) bool { + if a == nil || b == nil { + return a == nil && b == nil + } + return *a == *b +} + +func nullable(s string) any { + if s == "" { + return nil + } + return s +} + +func (h *Articles) renderText(r *http.Request, current *db.Site, article *db.Article, source string) (string, error) { + env := h.env(r, current, nil) + info, err := env.PageInfo(article) + if err != nil { + return "", err + } + result, err := env.Text(source, info, env.Callbacks(nil, nil), renderer.ModeSystem) + if err != nil { + return "", err + } + return result.Body, nil +} + +func (h *Articles) articleJSON(r *http.Request, article *db.Article, source string) (string, error) { + ctx := r.Context() + tags, err := h.deps.DB.ArticleTags(ctx, article.ID) + if err != nil { + return "", err + } + authors, err := h.deps.DB.ArticleAuthors(ctx, article.ID) + if err != nil { + return "", err + } + + rendered := make(wikijson.Array, 0, len(authors)) + for i := range authors { + one, err := repo.UserJSON(ctx, h.deps.DB, &authors[i]) + if err != nil { + return "", err + } + rendered = append(rendered, one) + } + if len(rendered) == 0 { + nobody, err := repo.UserJSON(ctx, h.deps.DB, nil) + if err != nil { + return "", err + } + rendered = append(rendered, nobody) + } + + parent := "" + if article.ParentID != nil { + if found, err := h.deps.DB.ArticleByID(ctx, *article.ParentID); err == nil { + parent = found.FullName() + } else if !errors.Is(err, db.ErrNotFound) { + return "", err + } + } + + return wikijson.Marshal(wikijson.Object{ + {Key: "uid", Value: article.ID}, + {Key: "pageId", Value: article.FullName()}, + {Key: "title", Value: article.Title}, + {Key: "source", Value: source}, + {Key: "tags", Value: tags}, + {Key: "author", Value: rendered[0]}, + {Key: "authors", Value: rendered}, + {Key: "parent", Value: nullable(parent)}, + {Key: "locked", Value: article.Locked}, + }) +} From 4bebdd6b288280c9ef0d437455d7337cb346570b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:13:07 +0900 Subject: [PATCH 236/428] answer the call that deletes a page --- internal/webapi/delete.go | 63 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 internal/webapi/delete.go diff --git a/internal/webapi/delete.go b/internal/webapi/delete.go new file mode 100644 index 00000000..d834f1e1 --- /dev/null +++ b/internal/webapi/delete.go @@ -0,0 +1,63 @@ +package webapi + +import ( + "errors" + "net/http" + "os" + "path/filepath" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/site" +) + +func (h *Articles) remove(r *http.Request, loc *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", 0, errors.New("webapi: the request carries no site") + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return field("error", loc.T("api-csrf-failed")), http.StatusForbidden, nil + } + + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + user := auth.FromContext(ctx) + perm := repo.NewPerms(ctx, h.deps.DB) + subject, err := perm.Subject(user, time.Now()) + if err != nil { + return "", 0, err + } + object, err := perm.Article(article, user) + if err != nil { + return "", 0, err + } + if !perms.Resolve(subject, object).Has(perms.DeleteArticles) { + return "", 0, errForbidden + } + + if err := h.deps.DB.DeleteArticle(ctx, article.ID, article.FullName()); err != nil { + return "", 0, err + } + h.dropMedia(article.MediaName) + return field("status", "ok"), http.StatusOK, nil +} + +// The rows are already gone, so a directory that will not go is logged and left +// rather than failing a delete the reader has been told succeeded. +func (h *Articles) dropMedia(mediaName string) { + if h.deps.Files == "" || mediaName == "" { + return + } + dir := filepath.Join(h.deps.Files, "media", mediaName) + if err := os.RemoveAll(dir); err != nil { + h.deps.log().Error("remove article media", "dir", dir, "err", err) + } +} From f6bceff07925850644ed901530de07dd2da0a881 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:13:08 +0900 Subject: [PATCH 237/428] route what a page's own path writes --- internal/webapi/articles.go | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index 71f1e42c..f083a72e 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -50,7 +50,11 @@ func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { } name, tail, found := cutLast(strings.TrimPrefix(r.URL.Path, ArticlesPrefix)) - if !found || name == "" { + if !found { + h.page(w, r, loc, strings.TrimPrefix(r.URL.Path, ArticlesPrefix)) + return + } + if name == "" { h.upstream.ServeHTTP(w, r) return } @@ -69,6 +73,21 @@ func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { } } +// The page's own path answers only what it writes. Reading one is still the +// upstream's, which is where the editor asks for it. +func (h *Articles) page(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, name string) { + switch { + case name == "": + h.upstream.ServeHTTP(w, r) + case r.Method == http.MethodPut: + h.answer(w, r, loc, name, h.update) + case r.Method == http.MethodDelete: + h.answer(w, r, loc, name, h.remove) + default: + h.upstream.ServeHTTP(w, r) + } +} + type answerFunc func(r *http.Request, loc *i18n.Localizer, name string) (string, int, error) func (h *Articles) answer(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, name string, fn answerFunc) { From 80e944aa2ed561df378e398bb34cbacc4e6e8bb1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:56:43 +0900 Subject: [PATCH 238/428] answer the call that reads a page's history --- internal/db/article_log.go | 56 +++++++++ internal/i18n/locales/zh-hans.json | 1 + internal/webapi/articles.go | 5 +- internal/webapi/log.go | 192 +++++++++++++++++++++++++++++ 4 files changed, 253 insertions(+), 1 deletion(-) create mode 100644 internal/db/article_log.go create mode 100644 internal/webapi/log.go diff --git a/internal/db/article_log.go b/internal/db/article_log.go new file mode 100644 index 00000000..e615e090 --- /dev/null +++ b/internal/db/article_log.go @@ -0,0 +1,56 @@ +package db + +import ( + "context" + "fmt" + "time" +) + +type LogEntry struct { + RevNumber int + Type string + Meta []byte + Comment string + CreatedAt time.Time + UserID *int64 +} + +var ( + // A null limit asks for the whole history, which is what the caller wants + // when it is not paging. + qArticleLog = register("ArticleLog", ` +SELECT rev_number, type, meta, comment, created_at, user_id +FROM web_articlelogentry +WHERE article_id = $1 +ORDER BY rev_number DESC +OFFSET $2 LIMIT $3`) + + qArticleLogCount = register("ArticleLogCount", ` +SELECT count(*) FROM web_articlelogentry WHERE article_id = $1`) +) + +func (d *DB) ArticleLog(ctx context.Context, articleID int64, offset int, limit *int) ([]LogEntry, error) { + rows, err := d.pool.Query(ctx, qArticleLog, articleID, offset, limit) + if err != nil { + return nil, fmt.Errorf("query log of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []LogEntry + for rows.Next() { + var e LogEntry + if err := rows.Scan(&e.RevNumber, &e.Type, &e.Meta, &e.Comment, &e.CreatedAt, &e.UserID); err != nil { + return nil, fmt.Errorf("scan log entry of article %d: %w", articleID, err) + } + out = append(out, e) + } + return out, rows.Err() +} + +func (d *DB) ArticleLogCount(ctx context.Context, articleID int64) (int, error) { + var n int + if err := d.pool.QueryRow(ctx, qArticleLogCount, articleID).Scan(&n); err != nil { + return 0, fmt.Errorf("count log of article %d: %w", articleID, err) + } + return n, nil +} diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index de6c3663..76a787af 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -1,6 +1,7 @@ { "api-bad-json": "请求体中的JSON格式无效", "api-bad-page-id": "无效的页面ID", + "api-bad-range": "无效的列表范围参数", "api-bad-request": "无效请求", "api-csrf-failed": "CSRF 校验失败", "api-forbidden": "权限不足", diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index f083a72e..4e4e689b 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -27,6 +27,7 @@ const ( tailLinks = "links" tailVersion = "version" tailVotes = "votes" + tailLog = "log" ) type Articles struct { @@ -64,6 +65,8 @@ func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { h.answer(w, r, loc, name, h.links) case tail == tailVersion && r.Method == http.MethodGet: h.answer(w, r, loc, name, h.version) + case tail == tailLog && r.Method == http.MethodGet: + h.answer(w, r, loc, name, h.log) case tail == tailVotes && r.Method == http.MethodGet: h.answer(w, r, loc, name, h.votes) case tail == tailVotes && r.Method == http.MethodDelete: @@ -405,7 +408,7 @@ func voteDateOrNil(at *time.Time) any { if at == nil { return nil } - return at.UTC().Format("2006-01-02T15:04:05.999999-07:00") + return isoTime(*at) } // The name keeps every slash but the last, since a forum page carries some. diff --git a/internal/webapi/log.go b/internal/webapi/log.go new file mode 100644 index 00000000..70fb0b95 --- /dev/null +++ b/internal/webapi/log.go @@ -0,0 +1,192 @@ +package webapi + +import ( + "bytes" + "encoding/json" + "net/http" + "slices" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/changelog" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +const defaultLogPage = 25 + +func (h *Articles) log(r *http.Request, loc *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + + from, to, all, ok := logRange(r) + if !ok { + return field("error", loc.T("api-bad-range")), http.StatusBadRequest, nil + } + total, err := h.deps.DB.ArticleLogCount(ctx, article.ID) + if err != nil { + return "", 0, err + } + offset, limit := 0, (*int)(nil) + if !all { + offset = from + span := to - from + if span < 0 { + span = 0 + } + limit = &span + } + entries, err := h.deps.DB.ArticleLog(ctx, article.ID, offset, limit) + if err != nil { + return "", 0, err + } + + users := func(ids []int64) ([]db.User, error) { return h.deps.DB.UsersByIDs(ctx, ids) } + rendered := make(wikijson.Array, 0, len(entries)) + for _, entry := range entries { + one, err := h.logEntryJSON(r, loc, users, entry) + if err != nil { + return "", 0, err + } + rendered = append(rendered, one) + } + + body, err := wikijson.Marshal(wikijson.Object{ + {Key: "count", Value: total}, + {Key: "entries", Value: rendered}, + }) + return body, http.StatusOK, err +} + +// A range that is not a pair of numbers is refused rather than quietly replaced +// with the default. +func logRange(r *http.Request) (from, to int, all, ok bool) { + query := r.URL.Query() + from, to = 0, defaultLogPage + if raw := query.Get("from"); raw != "" { + if from, ok = number(raw); !ok { + return 0, 0, false, false + } + } + if raw := query.Get("to"); raw != "" { + if to, ok = number(raw); !ok { + return 0, 0, false, false + } + } + return from, to, query.Get("all") != "", true +} + +func number(raw string) (int, bool) { + n, err := strconv.Atoi(raw) + return n, err == nil +} + +func (h *Articles) logEntryJSON(r *http.Request, loc *i18n.Localizer, users changelog.Users, + entry db.LogEntry) (wikijson.Object, error) { + + author, err := h.logEntryUser(r, entry.UserID) + if err != nil { + return nil, err + } + told, err := changelog.Of(loc, users, db.SiteChange{ + Type: entry.Type, Meta: entry.Meta, Comment: entry.Comment, + }) + if err != nil { + return nil, err + } + + meta, err := decodeMeta(entry.Meta) + if err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "revNumber", Value: entry.RevNumber}, + {Key: "user", Value: author}, + {Key: "comment", Value: entry.Comment}, + {Key: "defaultComment", Value: told.Comment}, + {Key: "createdAt", Value: isoTime(entry.CreatedAt)}, + {Key: "type", Value: entry.Type}, + {Key: "meta", Value: fromJSON(meta)}, + }, nil +} + +func (h *Articles) logEntryUser(r *http.Request, id *int64) (wikijson.Object, error) { + if id == nil { + return repo.UserJSON(r.Context(), h.deps.DB, nil) + } + found, err := h.deps.DB.UserByID(r.Context(), *id) + if err != nil { + return nil, err + } + return repo.UserJSON(r.Context(), h.deps.DB, found) +} + +// Numbers are kept as written rather than turned into floats, so a revision id +// goes back out as the whole number it was stored as. +func decodeMeta(raw []byte) (any, error) { + if len(raw) == 0 { + return nil, nil + } + decoder := json.NewDecoder(bytes.NewReader(raw)) + decoder.UseNumber() + var value any + if err := decoder.Decode(&value); err != nil { + return nil, err + } + return value, nil +} + +// Whatever the revision stored goes back out unchanged, so a key this version +// never learned to write still reaches the reader. +func fromJSON(value any) any { + switch v := value.(type) { + case json.Number: + if whole, err := v.Int64(); err == nil { + return whole + } + fraction, err := v.Float64() + if err != nil { + return v.String() + } + return fraction + case map[string]any: + out := make(wikijson.Object, 0, len(v)) + for _, key := range sortedKeys(v) { + out = append(out, wikijson.Field{Key: key, Value: fromJSON(v[key])}) + } + return out + case []any: + out := make(wikijson.Array, 0, len(v)) + for _, one := range v { + out = append(out, fromJSON(one)) + } + return out + } + return value +} + +// jsonb keeps its own key order, shorter first and then bytewise, and that is +// the order the revision was read out in. +func sortedKeys(fields map[string]any) []string { + keys := make([]string, 0, len(fields)) + for key := range fields { + keys = append(keys, key) + } + slices.SortFunc(keys, func(a, b string) int { + if len(a) != len(b) { + return len(a) - len(b) + } + return strings.Compare(a, b) + }) + return keys +} + +func isoTime(at time.Time) string { + return at.UTC().Format("2006-01-02T15:04:05.999999-07:00") +} From f4930efacd96e079062ad2f1411c712be3028f19 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Thu, 3 Sep 2026 21:57:17 +0900 Subject: [PATCH 239/428] answer the call that reverts a page to a revision --- internal/db/article_revert.go | 316 ++++++++++++++++++++++ internal/db/article_write.go | 8 +- internal/i18n/locales/zh-hans.json | 1 + internal/webapi/articles.go | 2 + internal/webapi/revert.go | 224 +++++++++++++++ internal/webapi/revert_apply.go | 420 +++++++++++++++++++++++++++++ internal/webapi/revert_test.go | 132 +++++++++ internal/webapi/update.go | 19 +- 8 files changed, 1118 insertions(+), 4 deletions(-) create mode 100644 internal/db/article_revert.go create mode 100644 internal/webapi/revert.go create mode 100644 internal/webapi/revert_apply.go create mode 100644 internal/webapi/revert_test.go diff --git a/internal/db/article_revert.go b/internal/db/article_revert.go new file mode 100644 index 00000000..7acdb671 --- /dev/null +++ b/internal/db/article_revert.go @@ -0,0 +1,316 @@ +package db + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "time" + + "github.com/jackc/pgx/v5" +) + +const LogRevert = "revert" + +type RestoredVote struct { + UserID int64 + RoleID *int64 + Rate float64 + Date *time.Time +} + +var ( + qArticleLogAbove = register("ArticleLogAbove", ` +SELECT rev_number, type, meta, comment, created_at, user_id +FROM web_articlelogentry +WHERE article_id = $1 AND rev_number > $2 +ORDER BY rev_number DESC`) + + // The version before another is the one written last before it, which is not + // the one with the next lower id when an import wrote them out of order. + qPreviousVersionSource = register("PreviousVersionSource", ` +SELECT p.source +FROM web_articleversion v +JOIN web_articleversion p ON p.article_id = v.article_id AND p.created_at < v.created_at +WHERE v.id = $1 +ORDER BY p.created_at DESC +LIMIT 1`) +) + +func (d *DB) ArticleLogAbove(ctx context.Context, articleID int64, revNumber int) ([]LogEntry, error) { + rows, err := d.pool.Query(ctx, qArticleLogAbove, articleID, revNumber) + if err != nil { + return nil, fmt.Errorf("query log of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []LogEntry + for rows.Next() { + var e LogEntry + if err := rows.Scan(&e.RevNumber, &e.Type, &e.Meta, &e.Comment, &e.CreatedAt, &e.UserID); err != nil { + return nil, fmt.Errorf("scan log entry of article %d: %w", articleID, err) + } + out = append(out, e) + } + return out, rows.Err() +} + +func (d *DB) PreviousVersionSource(ctx context.Context, versionID int64) (string, error) { + var source string + err := d.pool.QueryRow(ctx, qPreviousVersionSource, versionID).Scan(&source) + if errors.Is(err, pgx.ErrNoRows) { + return "", ErrNotFound + } + if err != nil { + return "", fmt.Errorf("query version before %d: %w", versionID, err) + } + return source, nil +} + +var ( + qReadFileName = register("ReadFileName", ` +SELECT name FROM web_file WHERE id = $1 FOR UPDATE`) + + qRenameFile = register("RenameFile", ` +UPDATE web_file SET name = $2 WHERE id = $1`) + + qSoftDeleteFile = register("SoftDeleteFile", ` +UPDATE web_file SET deleted_at = $2, deleted_by_id = $3 +WHERE id = $1 AND deleted_at IS NULL +RETURNING name`) + + qRestoreFile = register("RestoreFile", ` +UPDATE web_file SET deleted_at = NULL, deleted_by_id = NULL +WHERE id = $1 AND deleted_at IS NOT NULL +RETURNING name`) +) + +// A file that is already in the asked-for state reports no name, which is how +// the caller knows to leave it out of the revision it writes. +func (d *DB) RenameFile(ctx context.Context, fileID int64, name string) (string, bool, error) { + tx, err := d.pool.Begin(ctx) + if err != nil { + return "", false, fmt.Errorf("begin rename of file %d: %w", fileID, err) + } + defer tx.Rollback(ctx) + + var previous string + err = tx.QueryRow(ctx, qReadFileName, fileID).Scan(&previous) + if errors.Is(err, pgx.ErrNoRows) { + return "", false, nil + } + if err != nil { + return "", false, fmt.Errorf("read file %d: %w", fileID, err) + } + if _, err := tx.Exec(ctx, qRenameFile, fileID, name); err != nil { + return "", false, fmt.Errorf("rename file %d: %w", fileID, err) + } + if err := tx.Commit(ctx); err != nil { + return "", false, fmt.Errorf("commit rename of file %d: %w", fileID, err) + } + return previous, true, nil +} + +func (d *DB) SoftDeleteFile(ctx context.Context, fileID int64, at time.Time, byUserID *int64) (string, bool, error) { + return d.fileName(ctx, qSoftDeleteFile, fileID, at, byUserID) +} + +func (d *DB) RestoreFile(ctx context.Context, fileID int64) (string, bool, error) { + return d.fileName(ctx, qRestoreFile, fileID) +} + +func (d *DB) fileName(ctx context.Context, sql string, fileID int64, args ...any) (string, bool, error) { + var name string + err := d.pool.QueryRow(ctx, sql, append([]any{fileID}, args...)...).Scan(&name) + if errors.Is(err, pgx.ErrNoRows) { + return "", false, nil + } + if err != nil { + return "", false, fmt.Errorf("touch file %d: %w", fileID, err) + } + return name, true, nil +} + +var ( + qSetArticleTagIDs = register("SetArticleTagIDs", ` +DELETE FROM web_article_tags WHERE article_id = $1 AND NOT (tag_id = ANY($2))`) + + qKnownTags = register("KnownTags", `SELECT id FROM web_tag WHERE id = ANY($1)`) + + qKnownUser = register("KnownUser", `SELECT id FROM web_user WHERE id = $1`) +) + +// The revision that records this is written by the caller, so nothing is logged +// here. +func (d *DB) SetArticleTagIDs(ctx context.Context, articleID int64, tagIDs []int64) error { + tx, err := d.pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin tags of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + wanted, err := scanIDs(ctx, tx, qKnownTags, tagIDs) + if err != nil { + return fmt.Errorf("look up tags of %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qSetArticleTagIDs, articleID, wanted); err != nil { + return fmt.Errorf("drop tags of %d: %w", articleID, err) + } + held, err := scanIDs(ctx, tx, qArticleTagIDs, articleID) + if err != nil { + return fmt.Errorf("read tags of %d: %w", articleID, err) + } + for _, id := range missingFrom(wanted, held) { + if _, err := tx.Exec(ctx, qInsertArticleTag, articleID, id); err != nil { + return fmt.Errorf("tag %d: %w", articleID, err) + } + } + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit tags of %d: %w", articleID, err) + } + return nil +} + +// A vote whose voter is gone is dropped rather than failing the restore, since +// the row it would need points at a user that no longer exists. +func (d *DB) RestoreArticleVotes(ctx context.Context, articleID int64, votes []RestoredVote) error { + tx, err := d.pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin votes of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + if _, err := tx.Exec(ctx, qDeleteArticleVotes, articleID); err != nil { + return fmt.Errorf("drop votes of %d: %w", articleID, err) + } + for _, vote := range votes { + var known int64 + err := tx.QueryRow(ctx, qKnownUser, vote.UserID).Scan(&known) + if errors.Is(err, pgx.ErrNoRows) { + continue + } + if err != nil { + return fmt.Errorf("look up voter %d: %w", vote.UserID, err) + } + if _, err := tx.Exec(ctx, qInsertVote, articleID, vote.UserID, vote.Rate, vote.Date, vote.RoleID); err != nil { + return fmt.Errorf("restore vote of %d: %w", vote.UserID, err) + } + } + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit votes of %d: %w", articleID, err) + } + return nil +} + +type RevertWrite struct { + ArticleID int64 + UserID *int64 + Meta json.RawMessage + At time.Time +} + +func (d *DB) WriteRevertEntry(ctx context.Context, w RevertWrite) (int, error) { + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin revert of %d: %w", w.ArticleID, err) + } + defer tx.Rollback(ctx) + + if _, err := tx.Exec(ctx, qLockArticleLog, w.ArticleID); err != nil { + return 0, fmt.Errorf("lock article log %d: %w", w.ArticleID, err) + } + var revNumber int + if err := tx.QueryRow(ctx, qInsertArticleLog, w.ArticleID, w.UserID, LogRevert, + string(w.Meta), "", w.At).Scan(&revNumber); err != nil { + return 0, fmt.Errorf("write revision of %d: %w", w.ArticleID, err) + } + if _, err := tx.Exec(ctx, qTouchArticle, w.ArticleID, w.At); err != nil { + return 0, fmt.Errorf("touch article %d: %w", w.ArticleID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, fmt.Errorf("commit revert of %d: %w", w.ArticleID, err) + } + return revNumber, nil +} + +var ( + qAddArticleVersion = register("AddArticleVersion", ` +INSERT INTO web_articleversion (article_id, source, created_at) +VALUES ($1, $2, $3) +RETURNING id`) + + qSetArticleTitle = register("SetArticleTitle", ` +UPDATE web_article SET title = $2 WHERE id = $1`) + + qMoveArticleParent = register("MoveArticleParent", ` +UPDATE web_article SET parent_id = $2 WHERE id = $1`) + + qArticleAuthorIDs = register("ArticleAuthorIDs", ` +SELECT user_id FROM web_article_authors WHERE article_id = $1 ORDER BY user_id`) +) + +// The revision a revert writes names every piece it moved, so the pieces +// themselves leave no revisions of their own. +func (d *DB) AddArticleVersion(ctx context.Context, articleID int64, source string, at time.Time) (int64, error) { + var id int64 + if err := d.pool.QueryRow(ctx, qAddArticleVersion, articleID, source, at).Scan(&id); err != nil { + return 0, fmt.Errorf("write version of %d: %w", articleID, err) + } + return id, nil +} + +func (d *DB) SetArticleTitle(ctx context.Context, articleID int64, title string) error { + if _, err := d.pool.Exec(ctx, qSetArticleTitle, articleID, title); err != nil { + return fmt.Errorf("set title of %d: %w", articleID, err) + } + return nil +} + +func (d *DB) MoveArticleParent(ctx context.Context, articleID int64, parentID *int64) error { + if _, err := d.pool.Exec(ctx, qMoveArticleParent, articleID, parentID); err != nil { + return fmt.Errorf("set parent of %d: %w", articleID, err) + } + return nil +} + +func (d *DB) MoveArticle(ctx context.Context, articleID int64, category, name, from string) error { + to := (&Article{Category: category, Name: name}).FullName() + + tx, err := d.pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin move of %d: %w", articleID, err) + } + defer tx.Rollback(ctx) + + if _, err := tx.Exec(ctx, qRenameArticle, articleID, category, name); err != nil { + return fmt.Errorf("move article %d: %w", articleID, err) + } + if _, err := tx.Exec(ctx, qDropLinksFrom, to); err != nil { + return fmt.Errorf("drop links of %q: %w", to, err) + } + if _, err := tx.Exec(ctx, qMoveLinksFrom, from, to); err != nil { + return fmt.Errorf("move links of %q: %w", from, err) + } + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit move of %d: %w", articleID, err) + } + return nil +} + +func (d *DB) ArticleAuthorIDs(ctx context.Context, articleID int64) ([]int64, error) { + rows, err := d.pool.Query(ctx, qArticleAuthorIDs, articleID) + if err != nil { + return nil, fmt.Errorf("query authors of %d: %w", articleID, err) + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + return nil, fmt.Errorf("scan author of %d: %w", articleID, err) + } + out = append(out, id) + } + return out, rows.Err() +} diff --git a/internal/db/article_write.go b/internal/db/article_write.go index 7b087552..b00815cd 100644 --- a/internal/db/article_write.go +++ b/internal/db/article_write.go @@ -19,6 +19,10 @@ const ( LogName = "name" LogAuthorship = "authorship" + + LogFileAdded = "file_added" + LogFileDeleted = "file_deleted" + LogFileRenamed = "file_renamed" ) type Revision struct { @@ -362,6 +366,8 @@ func (d *DB) SetArticleAuthors(ctx context.Context, articleID int64, authorIDs [ return revNumber, true, nil } +// The result is never nil. A nil slice reaches Postgres as NULL, and a delete +// guarded by NOT (x = ANY(NULL)) then clears nothing at all. func scanIDs(ctx context.Context, tx pgx.Tx, sql string, arg any) ([]int64, error) { rows, err := tx.Query(ctx, sql, arg) if err != nil { @@ -369,7 +375,7 @@ func scanIDs(ctx context.Context, tx pgx.Tx, sql string, arg any) ([]int64, erro } defer rows.Close() - var out []int64 + out := []int64{} for rows.Next() { var id int64 if err := rows.Scan(&id); err != nil { diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 76a787af..c60b708c 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -2,6 +2,7 @@ "api-bad-json": "请求体中的JSON格式无效", "api-bad-page-id": "无效的页面ID", "api-bad-range": "无效的列表范围参数", + "api-bad-revision": "无效的版本号", "api-bad-request": "无效请求", "api-csrf-failed": "CSRF 校验失败", "api-forbidden": "权限不足", diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index 4e4e689b..a3e20062 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -67,6 +67,8 @@ func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { h.answer(w, r, loc, name, h.version) case tail == tailLog && r.Method == http.MethodGet: h.answer(w, r, loc, name, h.log) + case tail == tailLog && r.Method == http.MethodPut: + h.answer(w, r, loc, name, h.revert) case tail == tailVotes && r.Method == http.MethodGet: h.answer(w, r, loc, name, h.votes) case tail == tailVotes && r.Method == http.MethodDelete: diff --git a/internal/webapi/revert.go b/internal/webapi/revert.go new file mode 100644 index 00000000..66f31c9c --- /dev/null +++ b/internal/webapi/revert.go @@ -0,0 +1,224 @@ +package webapi + +import ( + "encoding/json" + "slices" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +// The walk that fills this runs newest first, so the oldest entry above the +// target is the one whose value survives. +type plan struct { + sourceFrom *int64 + title *string + name *string + + parentID *int64 + parentSet bool + + addedTags []int64 + removedTags []int64 + + addedAuthors []int64 + removedAuthors []int64 + + filesDeleted map[int64]bool + filesRestored map[int64]bool + filesRenamed map[int64]string + + votes json.RawMessage +} + +func newPlan() *plan { + return &plan{ + filesDeleted: map[int64]bool{}, + filesRestored: map[int64]bool{}, + filesRenamed: map[int64]string{}, + } +} + +// A page's creation cannot be undone, so the walk stops rather than trying. +func planRevert(entries []db.LogEntry) (*plan, error) { + p := newPlan() + for _, entry := range entries { + meta, err := decodeMeta(entry.Meta) + if err != nil { + return nil, err + } + fields, _ := meta.(map[string]any) + if entry.Type == db.LogNew { + break + } + p.undo(entry.Type, fields) + } + return p, nil +} + +func (p *plan) undo(kind string, meta map[string]any) { + switch kind { + case db.LogSource: + p.sourceFrom = wholeAt(meta, "version_id") + case db.LogTitle: + p.title = textAt(meta, "prev_title") + case db.LogName: + p.name = textAt(meta, "prev_name") + case db.LogParent: + p.parentID, p.parentSet = wholeAt(meta, "prev_parent_id"), true + case db.LogTags: + p.swapTags(namedIDs(meta, "added_tags"), namedIDs(meta, "removed_tags")) + case db.LogAuthorship: + p.swapAuthors(wholeList(meta, "added_authors"), wholeList(meta, "removed_authors")) + case db.LogVotesDeleted: + p.votes, _ = json.Marshal(meta) + case db.LogFileAdded: + p.markFile(meta, true, false) + case db.LogFileDeleted: + p.markFile(meta, false, true) + case db.LogFileRenamed: + if id := wholeAt(meta, "id"); id != nil { + if previous := textAt(meta, "prev_name"); previous != nil { + p.filesRenamed[*id] = *previous + } + } + case db.LogRevert: + p.undoRevert(meta) + } +} + +// A revert entry keeps what it undid under a key per kind, so undoing one is +// the same work read out of a different shape. +func (p *plan) undoRevert(meta map[string]any) { + if inner := objectAt(meta, "source"); inner != nil { + p.sourceFrom = wholeAt(inner, "version_id") + } + if inner := objectAt(meta, "title"); inner != nil { + p.title = textAt(inner, "prev_title") + } + if inner := objectAt(meta, "name"); inner != nil { + p.name = textAt(inner, "prev_name") + } + if inner := objectAt(meta, "parent"); inner != nil { + p.parentID, p.parentSet = wholeAt(inner, "prev_parent_id"), true + } + if inner := objectAt(meta, "tags"); inner != nil { + p.swapTags(wholeList(inner, "added"), wholeList(inner, "removed")) + } + if inner := objectAt(meta, "authorship"); inner != nil { + p.swapAuthors(wholeList(inner, "added"), wholeList(inner, "removed")) + } + if inner := objectAt(meta, "files"); inner != nil { + for _, one := range objectList(inner, "added") { + p.markFile(one, true, false) + } + for _, one := range objectList(inner, "deleted") { + p.markFile(one, false, true) + } + for _, one := range objectList(inner, "renamed") { + if id := wholeAt(one, "id"); id != nil { + if previous := textAt(one, "prev_name"); previous != nil { + p.filesRenamed[*id] = *previous + } + } + } + } + if inner := objectAt(meta, "votes"); inner != nil { + p.votes, _ = json.Marshal(inner) + } +} + +func (p *plan) markFile(meta map[string]any, deleted, restored bool) { + id := wholeAt(meta, "id") + if id == nil { + return + } + p.filesDeleted[*id] = deleted + p.filesRestored[*id] = restored +} + +// What an entry added is now removed and what it removed is now added, so each +// id moves to the other list rather than joining both. +func (p *plan) swapTags(added, removed []int64) { + p.addedTags, p.removedTags = swapped(p.addedTags, p.removedTags, added, removed) +} + +func (p *plan) swapAuthors(added, removed []int64) { + p.addedAuthors, p.removedAuthors = swapped(p.addedAuthors, p.removedAuthors, added, removed) +} + +func swapped(added, removed, entryAdded, entryRemoved []int64) ([]int64, []int64) { + for _, id := range entryAdded { + added = dropFirst(added, id) + removed = append(removed, id) + } + for _, id := range entryRemoved { + removed = dropFirst(removed, id) + added = append(added, id) + } + return added, removed +} + +func dropFirst(list []int64, id int64) []int64 { + if at := slices.Index(list, id); at >= 0 { + return slices.Delete(list, at, at+1) + } + return list +} + +func textAt(meta map[string]any, key string) *string { + if value, ok := meta[key].(string); ok { + return &value + } + return nil +} + +func wholeAt(meta map[string]any, key string) *int64 { + number, ok := meta[key].(json.Number) + if !ok { + return nil + } + value, err := number.Int64() + if err != nil { + return nil + } + return &value +} + +func objectAt(meta map[string]any, key string) map[string]any { + inner, _ := meta[key].(map[string]any) + return inner +} + +func wholeList(meta map[string]any, key string) []int64 { + raw, _ := meta[key].([]any) + out := make([]int64, 0, len(raw)) + for _, one := range raw { + if number, ok := one.(json.Number); ok { + if value, err := number.Int64(); err == nil { + out = append(out, value) + } + } + } + return out +} + +func objectList(meta map[string]any, key string) []map[string]any { + raw, _ := meta[key].([]any) + out := make([]map[string]any, 0, len(raw)) + for _, one := range raw { + if inner, ok := one.(map[string]any); ok { + out = append(out, inner) + } + } + return out +} + +func namedIDs(meta map[string]any, key string) []int64 { + out := make([]int64, 0) + for _, one := range objectList(meta, key) { + if id := wholeAt(one, "id"); id != nil { + out = append(out, *id) + } + } + return out +} diff --git a/internal/webapi/revert_apply.go b/internal/webapi/revert_apply.go new file mode 100644 index 00000000..98858e55 --- /dev/null +++ b/internal/webapi/revert_apply.go @@ -0,0 +1,420 @@ +package webapi + +import ( + "encoding/json" + "errors" + "net/http" + "slices" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +type reverter struct { + handler *Articles + req *http.Request + site *db.Site + article *db.Article + userID *int64 + at time.Time + + plan *plan + subtypes []string + meta map[string]any +} + +func (h *Articles) revert(r *http.Request, loc *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", 0, errors.New("webapi: the request carries no site") + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return field("error", loc.T("api-csrf-failed")), http.StatusForbidden, nil + } + + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + user := auth.FromContext(ctx) + perm := repo.NewPerms(ctx, h.deps.DB) + subject, err := perm.Subject(user, time.Now()) + if err != nil { + return "", 0, err + } + object, err := perm.Article(article, user) + if err != nil { + return "", 0, err + } + if !perms.Resolve(subject, object).Has(perms.EditArticles) { + return "", 0, errForbidden + } + + target, ok := revertTarget(r) + if !ok { + return field("error", loc.T("api-bad-revision")), http.StatusBadRequest, nil + } + + entries, err := h.deps.DB.ArticleLogAbove(ctx, article.ID, target) + if err != nil { + return "", 0, err + } + wanted, err := planRevert(entries) + if err != nil { + return "", 0, err + } + + rev := &reverter{ + handler: h, req: r, site: current, article: article, + at: time.Now().UTC(), plan: wanted, meta: map[string]any{}, + } + if user != nil { + rev.userID = &user.ID + } + if err := rev.apply(target); err != nil { + return "", 0, err + } + + body, err := wikijson.Marshal(wikijson.Object{{Key: "pageId", Value: rev.article.FullName()}}) + return body, http.StatusOK, err +} + +func revertTarget(r *http.Request) (int, bool) { + raw, err := readBody(r) + if err != nil { + return 0, false + } + var body fields + if json.Unmarshal(raw, &body) != nil { + return 0, false + } + value, ok := body["revNumber"] + if !ok { + return 0, false + } + var target int + if json.Unmarshal(value, &target) != nil { + return 0, false + } + return target, true +} + +// The links a new source writes are keyed by the name the page still has, so +// the rename has to come after it. +func (rev *reverter) apply(target int) error { + for _, step := range []func() error{ + rev.files, rev.tags, rev.source, rev.title, rev.name, rev.parent, rev.votes, rev.authors, + } { + if err := step(); err != nil { + return err + } + } + rev.meta["rev_number"] = target + rev.meta["subtypes"] = rev.subtypes + + encoded, err := json.Marshal(rev.meta) + if err != nil { + return err + } + if _, err := rev.handler.deps.DB.WriteRevertEntry(rev.req.Context(), db.RevertWrite{ + ArticleID: rev.article.ID, UserID: rev.userID, Meta: encoded, At: rev.at, + }); err != nil { + return err + } + return rev.reindex() +} + +func (rev *reverter) mark(kind string) { + if !slices.Contains(rev.subtypes, kind) { + rev.subtypes = append(rev.subtypes, kind) + } +} + +func (rev *reverter) files() error { + ctx := rev.req.Context() + var renamed, deleted, restored []any + + for id, name := range rev.plan.filesRenamed { + previous, ok, err := rev.handler.deps.DB.RenameFile(ctx, id, name) + if err != nil { + return err + } + if ok { + renamed = append(renamed, map[string]any{"id": id, "name": name, "prev_name": previous}) + } + } + for id, drop := range rev.plan.filesDeleted { + if !drop { + continue + } + name, ok, err := rev.handler.deps.DB.SoftDeleteFile(ctx, id, rev.at, rev.userID) + if err != nil { + return err + } + if ok { + deleted = append(deleted, map[string]any{"id": id, "name": name}) + } + } + for id, back := range rev.plan.filesRestored { + if !back { + continue + } + name, ok, err := rev.handler.deps.DB.RestoreFile(ctx, id) + if err != nil { + return err + } + if ok { + restored = append(restored, map[string]any{"id": id, "name": name}) + } + } + + if renamed == nil && deleted == nil && restored == nil { + return nil + } + if restored != nil { + rev.mark(db.LogFileAdded) + } + if deleted != nil { + rev.mark(db.LogFileDeleted) + } + if renamed != nil { + rev.mark(db.LogFileRenamed) + } + rev.meta["files"] = map[string]any{ + "added": orEmpty(restored), "deleted": orEmpty(deleted), "renamed": orEmpty(renamed), + } + return nil +} + +func (rev *reverter) tags() error { + ctx := rev.req.Context() + held, err := rev.handler.deps.DB.ArticleTagIDs(ctx, rev.article.ID) + if err != nil { + return err + } + + var added, removed []int64 + for _, id := range rev.plan.removedTags { + if at := slices.Index(held, id); at >= 0 { + held = slices.Delete(held, at, at+1) + removed = append(removed, id) + } + } + for _, id := range rev.plan.addedTags { + held = append(held, id) + added = append(added, id) + } + if err := rev.handler.deps.DB.SetArticleTagIDs(ctx, rev.article.ID, held); err != nil { + return err + } + if added == nil && removed == nil { + return nil + } + rev.mark(db.LogTags) + rev.meta["tags"] = map[string]any{"added": orEmptyIDs(added), "removed": orEmptyIDs(removed)} + return nil +} + +func (rev *reverter) source() error { + if rev.plan.sourceFrom == nil { + return nil + } + ctx := rev.req.Context() + source, err := rev.handler.deps.DB.PreviousVersionSource(ctx, *rev.plan.sourceFrom) + if errors.Is(err, db.ErrNotFound) { + return nil + } + if err != nil { + return err + } + + version, err := rev.handler.deps.DB.AddArticleVersion(ctx, rev.article.ID, source, rev.at) + if err != nil { + return err + } + rev.mark(db.LogSource) + rev.meta["source"] = map[string]any{"version_id": version} + return rev.handler.refreshLinks(rev.req, rev.site, rev.article.ID, source) +} + +func (rev *reverter) title() error { + if rev.plan.title == nil { + return nil + } + previous := rev.article.Title + if err := rev.handler.deps.DB.SetArticleTitle(rev.req.Context(), rev.article.ID, *rev.plan.title); err != nil { + return err + } + rev.article.Title = *rev.plan.title + rev.mark(db.LogTitle) + rev.meta["title"] = map[string]any{"prev_title": previous, "title": *rev.plan.title} + return nil +} + +func (rev *reverter) name() error { + if rev.plan.name == nil { + return nil + } + from := rev.article.FullName() + category, bare := wikidot.Split(*rev.plan.name) + if err := rev.handler.deps.DB.MoveArticle(rev.req.Context(), rev.article.ID, category, bare, from); err != nil { + return err + } + rev.article.Category, rev.article.Name = category, bare + rev.mark(db.LogName) + rev.meta["name"] = map[string]any{"prev_name": from, "name": rev.article.FullName()} + return nil +} + +func (rev *reverter) parent() error { + if !rev.plan.parentSet { + return nil + } + ctx := rev.req.Context() + previous, err := rev.handler.parentName(ctx, rev.article.ParentID) + if err != nil { + return err + } + wanted, err := rev.handler.parentName(ctx, rev.plan.parentID) + if err != nil { + return err + } + if err := rev.handler.deps.DB.MoveArticleParent(ctx, rev.article.ID, rev.plan.parentID); err != nil { + return err + } + rev.mark(db.LogParent) + rev.meta["parent"] = map[string]any{ + "parent": nullable(wanted), "parent_id": rev.plan.parentID, + "prev_parent": nullable(previous), "prev_parent_id": rev.article.ParentID, + } + rev.article.ParentID = rev.plan.parentID + return nil +} + +func (rev *reverter) votes() error { + if rev.plan.votes == nil { + return nil + } + ctx := rev.req.Context() + current, err := rev.handler.votesMeta(rev.req, rev.article) + if err != nil { + return err + } + var kept map[string]any + if err := json.Unmarshal([]byte(current), &kept); err != nil { + return err + } + + restored, err := restoredVotes(rev.plan.votes) + if err != nil { + return err + } + if err := rev.handler.deps.DB.RestoreArticleVotes(ctx, rev.article.ID, restored); err != nil { + return err + } + rev.mark(db.LogVotesDeleted) + rev.meta["votes"] = kept + return nil +} + +func restoredVotes(raw json.RawMessage) ([]db.RestoredVote, error) { + var stored struct { + Votes []struct { + UserID *int64 `json:"user_id"` + RoleID *int64 `json:"role_id"` + Rate float64 `json:"vote"` + Date *string `json:"date"` + } `json:"votes"` + } + if err := json.Unmarshal(raw, &stored); err != nil { + return nil, err + } + + out := make([]db.RestoredVote, 0, len(stored.Votes)) + for _, one := range stored.Votes { + if one.UserID == nil { + continue + } + vote := db.RestoredVote{UserID: *one.UserID, RoleID: one.RoleID, Rate: one.Rate} + if one.Date != nil { + if at, err := time.Parse(time.RFC3339Nano, *one.Date); err == nil { + vote.Date = &at + } + } + out = append(out, vote) + } + return out, nil +} + +func (rev *reverter) authors() error { + ctx := rev.req.Context() + held, err := rev.handler.deps.DB.ArticleAuthorIDs(ctx, rev.article.ID) + if err != nil { + return err + } + + var added, removed []int64 + for _, id := range rev.plan.removedAuthors { + if at := slices.Index(held, id); at >= 0 { + held = slices.Delete(held, at, at+1) + removed = append(removed, id) + } + } + for _, id := range rev.plan.addedAuthors { + held = append(held, id) + added = append(added, id) + } + if _, _, err := rev.handler.deps.DB.SetArticleAuthors(ctx, rev.article.ID, held, rev.userID, rev.at); err != nil { + return err + } + if added == nil && removed == nil { + return nil + } + rev.mark(db.LogAuthorship) + rev.meta["authorship"] = map[string]any{"added": orEmptyIDs(added), "removed": orEmptyIDs(removed)} + return nil +} + +func (rev *reverter) reindex() error { + ctx := rev.req.Context() + article, err := rev.handler.deps.DB.ArticleByID(ctx, rev.article.ID) + if err != nil { + return err + } + source, err := rev.handler.deps.DB.LatestSource(ctx, article.ID) + if errors.Is(err, db.ErrNotFound) { + return nil + } + if err != nil { + return err + } + indexed := article.Title + "\n\n" + source + plaintext := indexed + if text, err := rev.handler.renderText(rev.req, rev.site, article, source); err == nil { + plaintext = article.Title + "\n\n" + text + } + return rev.handler.deps.DB.UpdateSearchIndex(ctx, article.ID, indexed, plaintext) +} + +func orEmpty(list []any) []any { + if list == nil { + return []any{} + } + return list +} + +func orEmptyIDs(list []int64) []int64 { + if list == nil { + return []int64{} + } + return list +} diff --git a/internal/webapi/revert_test.go b/internal/webapi/revert_test.go new file mode 100644 index 00000000..17cf49e1 --- /dev/null +++ b/internal/webapi/revert_test.go @@ -0,0 +1,132 @@ +package webapi + +import ( + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func entry(rev int, kind, meta string) db.LogEntry { + return db.LogEntry{RevNumber: rev, Type: kind, Meta: []byte(meta)} +} + +func TestPlanRevertTakesTheOldestTitleAboveTheTarget(t *testing.T) { + got, err := planRevert([]db.LogEntry{ + entry(3, db.LogTitle, `{"title": "third", "prev_title": "second"}`), + entry(2, db.LogTitle, `{"title": "second", "prev_title": "first"}`), + }) + if err != nil { + t.Fatalf("planRevert() err = %v, want nil", err) + } + if got.title == nil || *got.title != "first" { + t.Errorf("planRevert().title = %v, want %q", got.title, "first") + } +} + +func TestPlanRevertStopsAtTheCreation(t *testing.T) { + got, err := planRevert([]db.LogEntry{ + entry(2, db.LogTitle, `{"title": "b", "prev_title": "a"}`), + entry(1, db.LogNew, `{"title": "a", "version_id": 7}`), + entry(0, db.LogTitle, `{"title": "a", "prev_title": "never"}`), + }) + if err != nil { + t.Fatalf("planRevert() err = %v, want nil", err) + } + if got.title == nil || *got.title != "a" { + t.Errorf("planRevert().title = %v, want %q", got.title, "a") + } +} + +func TestPlanRevertSwapsTagsAround(t *testing.T) { + got, err := planRevert([]db.LogEntry{ + entry(1, db.LogTags, `{"added_tags": [{"id": 5, "name": "new"}], "removed_tags": [{"id": 9, "name": "old"}]}`), + }) + if err != nil { + t.Fatalf("planRevert() err = %v, want nil", err) + } + if len(got.removedTags) != 1 || got.removedTags[0] != 5 { + t.Errorf("planRevert().removedTags = %v, want [5]", got.removedTags) + } + if len(got.addedTags) != 1 || got.addedTags[0] != 9 { + t.Errorf("planRevert().addedTags = %v, want [9]", got.addedTags) + } +} + +func TestPlanRevertLeavesATagOnOneSideOnly(t *testing.T) { + got, err := planRevert([]db.LogEntry{ + entry(2, db.LogTags, `{"added_tags": [], "removed_tags": [{"id": 5, "name": "x"}]}`), + entry(1, db.LogTags, `{"added_tags": [{"id": 5, "name": "x"}], "removed_tags": []}`), + }) + if err != nil { + t.Fatalf("planRevert() err = %v, want nil", err) + } + if len(got.addedTags) != 0 { + t.Errorf("planRevert().addedTags = %v, want none", got.addedTags) + } + if len(got.removedTags) != 1 || got.removedTags[0] != 5 { + t.Errorf("planRevert().removedTags = %v, want [5]", got.removedTags) + } +} + +func TestPlanRevertReadsAParentBackToNothing(t *testing.T) { + got, err := planRevert([]db.LogEntry{ + entry(1, db.LogParent, `{"parent": "main", "parent_id": 4, "prev_parent": null, "prev_parent_id": null}`), + }) + if err != nil { + t.Fatalf("planRevert() err = %v, want nil", err) + } + if !got.parentSet { + t.Fatal("planRevert().parentSet = false, want true") + } + if got.parentID != nil { + t.Errorf("planRevert().parentID = %v, want nil", got.parentID) + } +} + +func TestPlanRevertUnwrapsARevertEntry(t *testing.T) { + got, err := planRevert([]db.LogEntry{ + entry(2, db.LogRevert, `{"rev_number": 0, "subtypes": ["title", "tags"], + "title": {"title": "b", "prev_title": "a"}, + "tags": {"added": [3], "removed": [4]}}`), + }) + if err != nil { + t.Fatalf("planRevert() err = %v, want nil", err) + } + if got.title == nil || *got.title != "a" { + t.Errorf("planRevert().title = %v, want %q", got.title, "a") + } + if len(got.removedTags) != 1 || got.removedTags[0] != 3 { + t.Errorf("planRevert().removedTags = %v, want [3]", got.removedTags) + } + if len(got.addedTags) != 1 || got.addedTags[0] != 4 { + t.Errorf("planRevert().addedTags = %v, want [4]", got.addedTags) + } +} + +func TestPlanRevertNamesTheVersionASourceCameFrom(t *testing.T) { + got, err := planRevert([]db.LogEntry{ + entry(2, db.LogSource, `{"version_id": 31}`), + entry(1, db.LogSource, `{"version_id": 30}`), + }) + if err != nil { + t.Fatalf("planRevert() err = %v, want nil", err) + } + if got.sourceFrom == nil || *got.sourceFrom != 30 { + t.Errorf("planRevert().sourceFrom = %v, want 30", got.sourceFrom) + } +} + +func TestPlanRevertFlipsAFileAddition(t *testing.T) { + got, err := planRevert([]db.LogEntry{ + entry(1, db.LogFileAdded, `{"id": 12, "name": "a.png"}`), + }) + if err != nil { + t.Fatalf("planRevert() err = %v, want nil", err) + } + if !got.filesDeleted[12] { + t.Error("planRevert().filesDeleted[12] = false, want true") + } + if got.filesRestored[12] { + t.Error("planRevert().filesRestored[12] = true, want false") + } +} diff --git a/internal/webapi/update.go b/internal/webapi/update.go index 4726aa11..8e1716cc 100644 --- a/internal/webapi/update.go +++ b/internal/webapi/update.go @@ -1,6 +1,7 @@ package webapi import ( + "context" "encoding/json" "errors" "io" @@ -80,8 +81,8 @@ func (h *Articles) update(r *http.Request, loc *i18n.Localizer, name string) (st if err != nil { return "", 0, err } - raw, err := io.ReadAll(io.LimitReader(r.Body, bodyLimit+1)) - if err != nil || len(raw) == 0 || len(raw) > bodyLimit { + raw, err := readBody(r) + if err != nil { return field("error", loc.T("api-bad-request")), http.StatusBadRequest, nil } var body fields @@ -115,6 +116,14 @@ func (h *Articles) update(r *http.Request, loc *i18n.Localizer, name string) (st return e.answer() } +func readBody(r *http.Request) ([]byte, error) { + raw, err := io.ReadAll(io.LimitReader(r.Body, bodyLimit+1)) + if err != nil || len(raw) == 0 || len(raw) > bodyLimit { + return nil, errors.New("webapi: the body is missing or too long") + } + return raw, nil +} + func validateEdit(body fields) *refusal { id, ok := body.text("pageId") if !ok || id == "" || !wikidot.NameAllowed(id) { @@ -338,10 +347,14 @@ func (e *editor) reparent() (*refusal, error) { } func (e *editor) parentName(id *int64) (string, error) { + return e.handler.parentName(e.req.Context(), id) +} + +func (h *Articles) parentName(ctx context.Context, id *int64) (string, error) { if id == nil { return "", nil } - parent, err := e.handler.deps.DB.ArticleByID(e.req.Context(), *id) + parent, err := h.deps.DB.ArticleByID(ctx, *id) if errors.Is(err, db.ErrNotFound) { return "", nil } From 0ef6dd6907e11f88f0fb5324960db74aeebb8c18 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 18:31:25 +0900 Subject: [PATCH 240/428] share the media name escaping with the write side --- internal/media/media.go | 8 ++++---- internal/media/resized.go | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/internal/media/media.go b/internal/media/media.go index c42aef0a..44525c17 100644 --- a/internal/media/media.go +++ b/internal/media/media.go @@ -155,7 +155,7 @@ func (h *Handler) locate(ctx context.Context, rest string) (full, mimeType strin } for i, s := range segments { - segments[i] = partialQuote(s) + segments[i] = QuoteName(s) } full, err := paths.Resolve(root, filepath.Join(segments...)) if err != nil { @@ -164,9 +164,9 @@ func (h *Handler) locate(ctx context.Context, rest string) (full, mimeType strin return full, mimeType, size, true } -// partialQuote is not urlencoding: the write side escapes only ':' and '/', -// so widening this set would stop finding files already on disk. -func partialQuote(s string) string { +// Not urlencoding. Widening this set would put new uploads in directories where +// the files already on disk are not. +func QuoteName(s string) string { return strings.NewReplacer(":", "%3A", "/", "%2F", "?", "%3F").Replace(s) } diff --git a/internal/media/resized.go b/internal/media/resized.go index a6aa8b8b..e63e4985 100644 --- a/internal/media/resized.go +++ b/internal/media/resized.go @@ -77,7 +77,7 @@ func (h *ResizedHandler) image(ctx context.Context, articleRef, fileName string, return nil, os.ErrNotExist } - stored := filepath.Join(partialQuote(file.ArticleMediaName), partialQuote(file.MediaName)) + stored := filepath.Join(QuoteName(file.ArticleMediaName), QuoteName(file.MediaName)) cache, err := paths.Resolve(filepath.Join(h.root, resizedDir), filepath.Join(stored, size.Name+".jpg")) if err != nil { return nil, err From 694e68f9bf7e3212b38595def2b462baace1426b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 18:31:31 +0900 Subject: [PATCH 241/428] add the statements the file api needs --- internal/db/file_write.go | 130 ++++++++++++++++++++ internal/db/file_write_test.go | 215 +++++++++++++++++++++++++++++++++ 2 files changed, 345 insertions(+) create mode 100644 internal/db/file_write.go create mode 100644 internal/db/file_write_test.go diff --git a/internal/db/file_write.go b/internal/db/file_write.go new file mode 100644 index 00000000..ec60fa50 --- /dev/null +++ b/internal/db/file_write.go @@ -0,0 +1,130 @@ +package db + +import ( + "context" + "errors" + "fmt" + "time" + + "github.com/jackc/pgx/v5" +) + +type FileRecord struct { + ID int64 + Name string + MimeType string + Size int64 + CreatedAt time.Time + AuthorID *int64 +} + +// Newest last. Ordering by name instead would reshuffle the whole list every +// time one file is renamed. +var qArticleFileList = register("ArticleFileList", ` +SELECT id, name, mime_type, size, created_at, author_id +FROM web_file +WHERE article_id = $1 AND deleted_at IS NULL +ORDER BY id`) + +func (d *DB) ArticleFileList(ctx context.Context, articleID int64) ([]FileRecord, error) { + rows, err := d.pool.Query(ctx, qArticleFileList, articleID) + if err != nil { + return nil, fmt.Errorf("list files of article %d: %w", articleID, err) + } + defer rows.Close() + + var out []FileRecord + for rows.Next() { + var f FileRecord + if err := rows.Scan(&f.ID, &f.Name, &f.MimeType, &f.Size, &f.CreatedAt, &f.AuthorID); err != nil { + return nil, fmt.Errorf("scan file: %w", err) + } + out = append(out, f) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("list files of article %d: %w", articleID, err) + } + return out, nil +} + +// A deleted row still occupies the disk, so the two totals differ by exactly +// what a purge would free. +var qFileSpaceUsage = register("FileSpaceUsage", ` +SELECT COALESCE(SUM(size) FILTER (WHERE deleted_at IS NULL), 0), COALESCE(SUM(size), 0) +FROM web_file`) + +func (d *DB) FileSpaceUsage(ctx context.Context) (live, total int64, err error) { + if err := d.pool.QueryRow(ctx, qFileSpaceUsage).Scan(&live, &total); err != nil { + return 0, 0, fmt.Errorf("sum file sizes: %w", err) + } + return live, total, nil +} + +type FileRow struct { + ID int64 + ArticleID int64 + Name string + MediaName string + Deleted bool +} + +var qFileByID = register("FileByID", ` +SELECT id, article_id, name, media_name, deleted_at IS NOT NULL +FROM web_file +WHERE id = $1`) + +func (d *DB) FileByID(ctx context.Context, fileID int64) (*FileRow, error) { + var f FileRow + err := d.pool.QueryRow(ctx, qFileByID, fileID).Scan(&f.ID, &f.ArticleID, &f.Name, &f.MediaName, &f.Deleted) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("lookup file %d: %w", fileID, err) + } + return &f, nil +} + +var qLiveFileNamed = register("LiveFileNamed", ` +SELECT id +FROM web_file +WHERE article_id = $1 AND name = $2 AND deleted_at IS NULL +ORDER BY id +LIMIT 1`) + +func (d *DB) LiveFileNamed(ctx context.Context, articleID int64, name string) (int64, error) { + var id int64 + err := d.pool.QueryRow(ctx, qLiveFileNamed, articleID, name).Scan(&id) + if errors.Is(err, pgx.ErrNoRows) { + return 0, ErrNotFound + } + if err != nil { + return 0, fmt.Errorf("lookup file %q in article %d: %w", name, articleID, err) + } + return id, nil +} + +type FileWrite struct { + ArticleID int64 + Name string + MediaName string + MimeType string + Size int64 + AuthorID *int64 + At time.Time +} + +var qInsertFile = register("InsertFile", ` +INSERT INTO web_file (article_id, name, media_name, mime_type, size, author_id, created_at) +VALUES ($1, $2, $3, $4, $5, $6, $7) +RETURNING id`) + +func (d *DB) AddArticleFile(ctx context.Context, w FileWrite) (int64, error) { + var id int64 + err := d.pool.QueryRow(ctx, qInsertFile, w.ArticleID, w.Name, w.MediaName, + w.MimeType, w.Size, w.AuthorID, w.At).Scan(&id) + if err != nil { + return 0, fmt.Errorf("write file %q of article %d: %w", w.Name, w.ArticleID, err) + } + return id, nil +} diff --git a/internal/db/file_write_test.go b/internal/db/file_write_test.go new file mode 100644 index 00000000..955b76d7 --- /dev/null +++ b/internal/db/file_write_test.go @@ -0,0 +1,215 @@ +package db + +import ( + "context" + "errors" + "testing" + "time" +) + +func scratchFile(t *testing.T, d *DB, articleID int64, name string, size int64) int64 { + t.Helper() + id, err := d.AddArticleFile(context.Background(), FileWrite{ + ArticleID: articleID, + Name: name, + MediaName: name + ".bin", + MimeType: "application/octet-stream", + Size: size, + At: time.Now().UTC(), + }) + if err != nil { + t.Fatalf("AddArticleFile(%q) err = %v, want nil", name, err) + } + t.Cleanup(func() { + if _, err := d.pool.Exec(context.Background(), `DELETE FROM web_file WHERE id = $1`, id); err != nil { + t.Errorf("clean up scratch file err = %v, want nil", err) + } + }) + return id +} + +func TestAddArticleFileIsFoundByName(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + id := scratchFile(t, d, article, "probe-upload.txt", 12) + + found, err := d.LiveFileNamed(ctx, article, "probe-upload.txt") + if err != nil { + t.Fatalf("LiveFileNamed() err = %v, want nil", err) + } + if found != id { + t.Errorf("LiveFileNamed() = %d, want %d", found, id) + } +} + +func TestLiveFileNamedMissesAnotherName(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + scratchFile(t, d, article, "probe-upload.txt", 12) + + if _, err := d.LiveFileNamed(ctx, article, "probe-other.txt"); !errors.Is(err, ErrNotFound) { + t.Errorf("LiveFileNamed() err = %v, want ErrNotFound", err) + } +} + +func TestLiveFileNamedMissesADeletedFile(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + id := scratchFile(t, d, article, "probe-upload.txt", 12) + + if _, _, err := d.SoftDeleteFile(ctx, id, time.Now().UTC(), nil); err != nil { + t.Fatalf("SoftDeleteFile() err = %v, want nil", err) + } + if _, err := d.LiveFileNamed(ctx, article, "probe-upload.txt"); !errors.Is(err, ErrNotFound) { + t.Errorf("LiveFileNamed() err = %v, want ErrNotFound", err) + } +} + +func TestArticleFileListLeavesOutADeletedFile(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + kept := scratchFile(t, d, article, "probe-kept.txt", 4) + gone := scratchFile(t, d, article, "probe-gone.txt", 4) + + if _, _, err := d.SoftDeleteFile(ctx, gone, time.Now().UTC(), nil); err != nil { + t.Fatalf("SoftDeleteFile() err = %v, want nil", err) + } + list, err := d.ArticleFileList(ctx, article) + if err != nil { + t.Fatalf("ArticleFileList() err = %v, want nil", err) + } + if len(list) != 1 { + t.Fatalf("len(ArticleFileList()) = %d, want 1", len(list)) + } + if list[0].ID != kept { + t.Errorf("ArticleFileList()[0].ID = %d, want %d", list[0].ID, kept) + } +} + +func TestArticleFileListOrdersByUpload(t *testing.T) { + d := writeTestDB(t) + article := scratchArticle(t, d) + first := scratchFile(t, d, article, "zzz-first.txt", 4) + second := scratchFile(t, d, article, "aaa-second.txt", 4) + + list, err := d.ArticleFileList(context.Background(), article) + if err != nil { + t.Fatalf("ArticleFileList() err = %v, want nil", err) + } + if len(list) != 2 { + t.Fatalf("len(ArticleFileList()) = %d, want 2", len(list)) + } + if list[0].ID != first { + t.Errorf("ArticleFileList()[0].ID = %d, want %d", list[0].ID, first) + } + if list[1].ID != second { + t.Errorf("ArticleFileList()[1].ID = %d, want %d", list[1].ID, second) + } +} + +func TestArticleFileListCarriesWhatWasWritten(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + at := time.Date(2026, 3, 4, 5, 6, 7, 891000000, time.UTC) + + id, err := d.AddArticleFile(ctx, FileWrite{ + ArticleID: article, + Name: "probe-detail.pdf", + MediaName: "8ab0e9f2.pdf", + MimeType: "application/pdf", + Size: 4096, + At: at, + }) + if err != nil { + t.Fatalf("AddArticleFile() err = %v, want nil", err) + } + t.Cleanup(func() { + if _, err := d.pool.Exec(context.Background(), `DELETE FROM web_file WHERE id = $1`, id); err != nil { + t.Errorf("clean up scratch file err = %v, want nil", err) + } + }) + + list, err := d.ArticleFileList(ctx, article) + if err != nil { + t.Fatalf("ArticleFileList() err = %v, want nil", err) + } + if len(list) != 1 { + t.Fatalf("len(ArticleFileList()) = %d, want 1", len(list)) + } + got := list[0] + if got.Name != "probe-detail.pdf" { + t.Errorf("ArticleFileList()[0].Name = %q, want %q", got.Name, "probe-detail.pdf") + } + if got.MimeType != "application/pdf" { + t.Errorf("ArticleFileList()[0].MimeType = %q, want %q", got.MimeType, "application/pdf") + } + if got.Size != 4096 { + t.Errorf("ArticleFileList()[0].Size = %d, want 4096", got.Size) + } + if !got.CreatedAt.Equal(at) { + t.Errorf("ArticleFileList()[0].CreatedAt = %v, want %v", got.CreatedAt.UTC(), at) + } + if got.AuthorID != nil { + t.Errorf("ArticleFileList()[0].AuthorID = %v, want nil", *got.AuthorID) + } +} + +func TestFileByIDReportsADeletedFile(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + id := scratchFile(t, d, article, "probe-gone.txt", 4) + + if _, _, err := d.SoftDeleteFile(ctx, id, time.Now().UTC(), nil); err != nil { + t.Fatalf("SoftDeleteFile() err = %v, want nil", err) + } + found, err := d.FileByID(ctx, id) + if err != nil { + t.Fatalf("FileByID() err = %v, want nil", err) + } + if !found.Deleted { + t.Errorf("FileByID().Deleted = false, want true") + } + if found.ArticleID != article { + t.Errorf("FileByID().ArticleID = %d, want %d", found.ArticleID, article) + } +} + +func TestFileByIDOfNothing(t *testing.T) { + d := writeTestDB(t) + if _, err := d.FileByID(context.Background(), -1); !errors.Is(err, ErrNotFound) { + t.Errorf("FileByID(-1) err = %v, want ErrNotFound", err) + } +} + +func TestFileSpaceUsageCountsADeletedFileOnlyInTheTotal(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + + beforeLive, beforeTotal, err := d.FileSpaceUsage(ctx) + if err != nil { + t.Fatalf("FileSpaceUsage() err = %v, want nil", err) + } + scratchFile(t, d, article, "probe-kept.txt", 100) + gone := scratchFile(t, d, article, "probe-gone.txt", 700) + if _, _, err := d.SoftDeleteFile(ctx, gone, time.Now().UTC(), nil); err != nil { + t.Fatalf("SoftDeleteFile() err = %v, want nil", err) + } + + live, total, err := d.FileSpaceUsage(ctx) + if err != nil { + t.Fatalf("FileSpaceUsage() err = %v, want nil", err) + } + if live-beforeLive != 100 { + t.Errorf("FileSpaceUsage() live grew by %d, want 100", live-beforeLive) + } + if total-beforeTotal != 800 { + t.Errorf("FileSpaceUsage() total grew by %d, want 800", total-beforeTotal) + } +} From feb9b010c77bb246574daca742254dff3bb72fe6 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 18:33:02 +0900 Subject: [PATCH 242/428] answer the call that reads a page --- internal/difftest/corpus/articles.txt | 9 +++++++ internal/webapi/articles.go | 13 +++++++--- internal/webapi/fetch.go | 36 +++++++++++++++++++++++++++ internal/webapi/update.go | 19 +++++++++----- 4 files changed, 67 insertions(+), 10 deletions(-) create mode 100644 internal/webapi/fetch.go diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 7b73d004..0aae342c 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -77,3 +77,12 @@ OPTIONS /probe:full /probe:changes/p/2 /probe:changes/perpage/10/category/probe /probe:changes/username/~probe/source/true + +/pw-api/articles/probe:full +/pw-api/articles/probe:bare +/pw-api/articles/probe:tagged +/pw-api/articles/probestars:unrated +/pw-api/articles/probe:parent +/pw-api/articles/_default:main +/pw-api/articles/no-such-page +# the editor asks for a page's source and metadata through these. diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index a3e20062..0626e018 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -41,8 +41,6 @@ func NewArticles(d Deps, upstream http.Handler) *Articles { return &Articles{deps: d, upstream: upstream} } -// Only the tails listed here are answered. A page's own URL still belongs to -// the upstream, which is where saving lives. func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) if r.URL.Path == CreatePath && r.Method == http.MethodPost { @@ -78,12 +76,12 @@ func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { } } -// The page's own path answers only what it writes. Reading one is still the -// upstream's, which is where the editor asks for it. func (h *Articles) page(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, name string) { switch { case name == "": h.upstream.ServeHTTP(w, r) + case r.Method == http.MethodGet: + h.answer(w, r, loc, name, h.fetch) case r.Method == http.MethodPut: h.answer(w, r, loc, name, h.update) case r.Method == http.MethodDelete: @@ -399,6 +397,13 @@ func (h *Articles) rating(r *http.Request, article *db.Article) (page.Rating, er return page.RatingOf(mode, stats), nil } +func textOrNil(s *string) any { + if s == nil { + return nil + } + return *s +} + func idOrNil(id *int64) any { if id == nil { return nil diff --git a/internal/webapi/fetch.go b/internal/webapi/fetch.go new file mode 100644 index 00000000..505aa9a9 --- /dev/null +++ b/internal/webapi/fetch.go @@ -0,0 +1,36 @@ +package webapi + +import ( + "context" + "errors" + "net/http" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" +) + +func (h *Articles) fetch(r *http.Request, _ *i18n.Localizer, name string) (string, int, error) { + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + source, err := h.latestSource(r.Context(), article.ID) + if err != nil { + return "", 0, err + } + body, err := h.articleJSON(r, article, source) + return body, http.StatusOK, err +} + +// A page with no version behind it still answers, with a null where its source +// would be, which is not the same as a page whose source is empty. +func (h *Articles) latestSource(ctx context.Context, articleID int64) (*string, error) { + source, err := h.deps.DB.LatestSource(ctx, articleID) + if errors.Is(err, db.ErrNotFound) { + return nil, nil + } + if err != nil { + return nil, err + } + return &source, nil +} diff --git a/internal/webapi/update.go b/internal/webapi/update.go index 8e1716cc..15ffc4f8 100644 --- a/internal/webapi/update.go +++ b/internal/webapi/update.go @@ -6,6 +6,7 @@ import ( "errors" "io" "net/http" + "slices" "strconv" "strings" "time" @@ -404,12 +405,14 @@ func (e *editor) answer() (string, int, error) { if err != nil { return "", 0, err } - source, err := e.handler.deps.DB.LatestSource(ctx, article.ID) - if err != nil && !errors.Is(err, db.ErrNotFound) { + source, err := e.handler.latestSource(ctx, article.ID) + if err != nil { return "", 0, err } - if err := e.reindex(article, source); err != nil { - return "", 0, err + if source != nil { + if err := e.reindex(article, *source); err != nil { + return "", 0, err + } } body, err := e.handler.articleJSON(e.req, article, source) @@ -460,12 +463,16 @@ func (h *Articles) renderText(r *http.Request, current *db.Site, article *db.Art return result.Body, nil } -func (h *Articles) articleJSON(r *http.Request, article *db.Article, source string) (string, error) { +func (h *Articles) articleJSON(r *http.Request, article *db.Article, source *string) (string, error) { ctx := r.Context() tags, err := h.deps.DB.ArticleTags(ctx, article.ID) if err != nil { return "", err } + for i := range tags { + tags[i] = strings.ToLower(tags[i]) + } + slices.Sort(tags) authors, err := h.deps.DB.ArticleAuthors(ctx, article.ID) if err != nil { return "", err @@ -500,7 +507,7 @@ func (h *Articles) articleJSON(r *http.Request, article *db.Article, source stri {Key: "uid", Value: article.ID}, {Key: "pageId", Value: article.FullName()}, {Key: "title", Value: article.Title}, - {Key: "source", Value: source}, + {Key: "source", Value: textOrNil(source)}, {Key: "tags", Value: tags}, {Key: "author", Value: rendered[0]}, {Key: "authors", Value: rendered}, From 31f3bb1d782c595c21a17fb87687db8228ecbd89 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 18:33:08 +0900 Subject: [PATCH 243/428] answer the calls that read and write a page's files --- cmd/pwikit/articles.go | 12 +- cmd/pwikit/main.go | 40 ++- internal/i18n/locales/zh-hans.json | 4 + internal/routing/routing.go | 1 + internal/webapi/articles.go | 5 + internal/webapi/files.go | 430 +++++++++++++++++++++++++++++ internal/webapi/webapi.go | 4 + 7 files changed, 492 insertions(+), 4 deletions(-) create mode 100644 internal/webapi/files.go diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go index daf9b5ce..79fed366 100644 --- a/cmd/pwikit/articles.go +++ b/cmd/pwikit/articles.go @@ -30,10 +30,16 @@ type pageStack struct { profile http.Handler profileForm http.Handler articleAPI http.Handler + fileAPI http.Handler close func() } -func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handler, trust *proxyheader.Trust, sidecar, secret, timezone string, log *slog.Logger) (*pageStack, error) { +type limits struct { + soft int64 + hard int64 +} + +func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handler, trust *proxyheader.Trust, size limits, sidecar, secret, timezone string, log *slog.Logger) (*pageStack, error) { engine, closeEngine, err := newRenderer(sidecar) if err != nil { return nil, err @@ -62,7 +68,7 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl }) items := localitem.Deps{DB: conn, Engine: engine, Bundle: bundle, Icons: icons, Log: log} api := webapi.Deps{DB: conn, Trust: trust, Engine: engine, Bundle: bundle, Icons: icons, - Files: p.Files(), Log: log} + Files: p.Files(), SoftLimit: size.soft, HardLimit: size.hard, Log: log} profiles := userpage.Deps{ DB: conn, Engine: engine, Bundle: bundle, Icons: icons, @@ -77,6 +83,7 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl moduleAPI: webapi.New(api, upstream), preview: webapi.NewPreview(api), articleAPI: webapi.NewArticles(api, upstream), + fileAPI: webapi.NewFileItems(api, upstream), profile: userpage.New(profiles), profileForm: userpage.NewEdit(profiles), close: closeEngine, @@ -89,6 +96,7 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl } resolver := auth.NewResolver(session.New(secret), conn, conn, log) stack.articleAPI = resolver.Middleware(stack.articleAPI) + stack.fileAPI = resolver.Middleware(stack.fileAPI) stack.code = resolver.Middleware(stack.code) stack.html = resolver.Middleware(stack.html) stack.theme = resolver.Middleware(stack.theme) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 66e32dfa..e245cbce 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -10,6 +10,7 @@ import ( "net" "net/http" "os" + "strconv" "strings" "text/tabwriter" "time" @@ -36,6 +37,8 @@ const ( envSecretKey = "SECRET_KEY" envTimeZone = "PWIKIT_TIMEZONE" envGoogleTag = "GOOGLE_TAG_ID" + envUploadLimit = "MEDIA_UPLOAD_LIMIT" + envStorageLimit = "ABSOLUTE_MEDIA_UPLOAD_LIMIT" defaultUpstream = "http://127.0.0.1:8000" defaultListen = "127.0.0.1:8080" ) @@ -94,6 +97,8 @@ func serve(args []string) error { sidecar := fs.String("sidecar", os.Getenv(envSidecar), "path to the ftml sidecar binary; without it the linked-in ftml is used") timezone := fs.String("timezone", envOr(envTimeZone, "UTC"), "time zone dates are shown in") bareOrigin := fs.Bool("bare-origin", false, "drop the port from the Origin header before forwarding") + uploadLimit := fs.String("upload-limit", envOr(envUploadLimit, "0"), "size the files still attached to pages may reach, such as 4GB; 0 for no ceiling") + storageLimit := fs.String("storage-limit", envOr(envStorageLimit, "0"), "size every file on disk may reach, deleted ones counted; 0 for no ceiling") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -142,11 +147,21 @@ func serve(args []string) error { resizedHandler = site.NewHostRules(conn, listenPort(*listen), media.NewResized(p.Files(), conn), proxy) } + soft, err := parseSize(*uploadLimit) + if err != nil { + return fmt.Errorf("parse -upload-limit: %w", err) + } + hard, err := parseSize(*storageLimit) + if err != nil { + return fmt.Errorf("parse -storage-limit: %w", err) + } + var articles, codeHandler, htmlHandler, themeHandler http.Handler = proxy, proxy, proxy, proxy var moduleAPI, preview, profile, articleAPI http.Handler = proxy, proxy, proxy, proxy - var profileForm http.Handler = proxy + var profileForm, fileAPI http.Handler = proxy, proxy if conn != nil { - stack, err := newPageStack(conn, p, assets, proxy, trust, *sidecar, *secret, *timezone, log) + stack, err := newPageStack(conn, p, assets, proxy, trust, limits{soft: soft, hard: hard}, + *sidecar, *secret, *timezone, log) if err != nil { return err } @@ -163,6 +178,7 @@ func serve(args []string) error { profile = served(stack.profile) profileForm = served(stack.profileForm) articleAPI = served(stack.articleAPI) + fileAPI = served(stack.fileAPI) } goHandlers := map[string]http.Handler{ @@ -180,6 +196,7 @@ func serve(args []string) error { userpage.Prefix: profile, userpage.EditPrefix: profileForm, webapi.ArticlesPrefix: articleAPI, + webapi.FilesPrefix: fileAPI, "/": articles, } @@ -223,6 +240,25 @@ func assetFS(dir string) (iofs.FS, error) { return os.DirFS(dir), nil } +var sizeUnits = map[string]int64{"B": 1, "KB": 1 << 10, "MB": 1 << 20, "GB": 1 << 30, "TB": 1 << 40} + +func parseSize(spec string) (int64, error) { + digits := strings.TrimLeft(spec, "0123456789") + number, err := strconv.ParseInt(spec[:len(spec)-len(digits)], 10, 64) + if err != nil { + return 0, fmt.Errorf("no leading number in %q", spec) + } + unit := strings.ToUpper(strings.TrimSpace(digits)) + if unit == "" { + return number, nil + } + scale, ok := sizeUnits[unit] + if !ok { + return 0, fmt.Errorf("unknown size unit %q", unit) + } + return number * scale, nil +} + func envOr(key, fallback string) string { if v := os.Getenv(key); v != "" { return v diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index c60b708c..47b04b6d 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -5,13 +5,17 @@ "api-bad-revision": "无效的版本号", "api-bad-request": "无效请求", "api-csrf-failed": "CSRF 校验失败", + "api-file-exists": "同名文件已存在", + "api-file-not-found": "文件不存在", "api-forbidden": "权限不足", "api-internal-error": "服务器内部错误", + "api-missing-file-name": "缺少文件名", "api-missing-source": "缺少页面源代码", "api-missing-title": "缺少页面标题", "api-page-exists": "此ID的页面已存在", "api-page-not-found": "页面未找到", "api-source-too-long": "超过页面大小限制", + "api-upload-too-large": "超过文件上传限制", "button-copy-clipboard": "复制", "collapsible-hide": "- 关闭折叠", "collapsible-open": "+ 打开折叠", diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 282e7b6f..fd38f41c 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -42,6 +42,7 @@ var Table = []Route{ {Prefix: "/pw-api/modules", Owner: OwnerGo, Label: "module API", Exact: true}, {Prefix: "/pw-api/preview", Owner: OwnerGo, Label: "editor preview", Exact: true}, {Prefix: "/pw-api/articles/", Owner: OwnerGo, Label: "article API"}, + {Prefix: "/pw-api/files/", Owner: OwnerGo, Label: "file API"}, {Prefix: "/local--files/", Owner: OwnerGo, Label: "site files"}, {Prefix: "/local--resized-images/", Owner: OwnerGo, Label: "scaled images"}, {Prefix: "/local--code/", Owner: OwnerGo, Label: "code blocks"}, diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index 0626e018..c5bfed06 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -28,6 +28,7 @@ const ( tailVersion = "version" tailVotes = "votes" tailLog = "log" + tailFiles = "files" ) type Articles struct { @@ -71,6 +72,10 @@ func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { h.answer(w, r, loc, name, h.votes) case tail == tailVotes && r.Method == http.MethodDelete: h.answer(w, r, loc, name, h.resetVotes) + case tail == tailFiles && r.Method == http.MethodGet: + h.answer(w, r, loc, name, h.files) + case tail == tailFiles && r.Method == http.MethodPost: + h.answer(w, r, loc, name, h.upload) default: h.upstream.ServeHTTP(w, r) } diff --git a/internal/webapi/files.go b/internal/webapi/files.go new file mode 100644 index 00000000..ecc5f917 --- /dev/null +++ b/internal/webapi/files.go @@ -0,0 +1,430 @@ +package webapi + +import ( + "crypto/rand" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "os" + "path/filepath" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/media" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +const FilesPrefix = "/pw-api/files/" + +const uploadChunk = 102400 + +var errFileNotFound = errors.New("webapi: no such file") + +// A file's own path carries no page name, so it reaches the same handlers +// through an entry point of its own. +type FileItems struct { + articles *Articles +} + +var _ http.Handler = (*FileItems)(nil) + +func NewFileItems(d Deps, upstream http.Handler) *FileItems { + return &FileItems{articles: NewArticles(d, upstream)} +} + +func (h *FileItems) ServeHTTP(w http.ResponseWriter, r *http.Request) { + a := h.articles + loc := a.deps.Bundle.Localizer(i18n.DefaultLanguage) + + id, err := strconv.ParseInt(strings.TrimPrefix(r.URL.Path, FilesPrefix), 10, 64) + if err != nil { + a.upstream.ServeHTTP(w, r) + return + } + switch r.Method { + case http.MethodDelete: + a.answerFile(w, r, loc, id, a.removeFile) + case http.MethodPut: + a.answerFile(w, r, loc, id, a.renameFile) + default: + a.upstream.ServeHTTP(w, r) + } +} + +type fileFunc func(r *http.Request, loc *i18n.Localizer, file *db.FileRow, article *db.Article) (string, int, error) + +func (h *Articles) answerFile(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, + id int64, fn fileFunc) { + + file, article, err := h.fileAndArticle(r, id) + if err != nil { + h.failFile(w, loc, err) + return + } + if err := h.viewable(r, article.FullName()); err != nil { + h.failFile(w, loc, err) + return + } + if err := h.mayManageFiles(r, article); err != nil { + h.failFile(w, loc, err) + return + } + body, status, err := fn(r, loc, file, article) + if err != nil { + h.failFile(w, loc, err) + return + } + writeJSON(w, status, body) +} + +func (h *Articles) failFile(w http.ResponseWriter, loc *i18n.Localizer, err error) { + if errors.Is(err, errFileNotFound) { + writeJSON(w, http.StatusNotFound, field("error", loc.T("api-file-not-found"))) + return + } + h.fail(w, loc, err) +} + +func (h *Articles) fileAndArticle(r *http.Request, id int64) (*db.FileRow, *db.Article, error) { + ctx := r.Context() + file, err := h.deps.DB.FileByID(ctx, id) + if errors.Is(err, db.ErrNotFound) || (err == nil && file.Deleted) { + return nil, nil, errFileNotFound + } + if err != nil { + return nil, nil, err + } + article, err := h.deps.DB.ArticleByID(ctx, file.ArticleID) + if errors.Is(err, db.ErrNotFound) { + return nil, nil, errNotFound + } + if err != nil { + return nil, nil, err + } + return file, article, nil +} + +func (h *Articles) mayManageFiles(r *http.Request, article *db.Article) error { + ctx := r.Context() + user := auth.FromContext(ctx) + perm := repo.NewPerms(ctx, h.deps.DB) + + subject, err := perm.Subject(user, time.Now()) + if err != nil { + return err + } + object, err := perm.Article(article, user) + if err != nil { + return err + } + if !perms.Resolve(subject, object).Has(perms.ManageArticleFiles) { + return errForbidden + } + return nil +} + +func (h *Articles) files(r *http.Request, _ *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + found, err := h.deps.DB.ArticleFileList(ctx, article.ID) + if err != nil { + return "", 0, err + } + rendered := make(wikijson.Array, 0, len(found)) + for i := range found { + one, err := h.fileJSON(r, found[i]) + if err != nil { + return "", 0, err + } + rendered = append(rendered, one) + } + + live, total, err := h.deps.DB.FileSpaceUsage(ctx) + if err != nil { + return "", 0, err + } + body, err := wikijson.Marshal(wikijson.Object{ + {Key: "pageId", Value: article.FullName()}, + {Key: "files", Value: rendered}, + {Key: "softLimit", Value: h.deps.SoftLimit}, + {Key: "hardLimit", Value: h.deps.HardLimit}, + {Key: "softUsed", Value: live}, + {Key: "hardUsed", Value: total}, + }) + return body, http.StatusOK, err +} + +func (h *Articles) fileJSON(r *http.Request, file db.FileRecord) (wikijson.Object, error) { + ctx := r.Context() + var author *db.User + if file.AuthorID != nil { + found, err := h.deps.DB.UserByID(ctx, *file.AuthorID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + author = found + } + rendered, err := repo.UserJSON(ctx, h.deps.DB, author) + if err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "id", Value: file.ID}, + {Key: "name", Value: file.Name}, + {Key: "size", Value: file.Size}, + {Key: "createdAt", Value: isoTime(file.CreatedAt)}, + {Key: "author", Value: rendered}, + {Key: "mimeType", Value: file.MimeType}, + }, nil +} + +func (h *Articles) upload(r *http.Request, loc *i18n.Localizer, name string) (string, int, error) { + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", 0, errors.New("webapi: the request carries no site") + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return field("error", loc.T("api-csrf-failed")), http.StatusForbidden, nil + } + + article, err := h.article(r, name) + if err != nil { + return "", 0, err + } + if err := h.mayManageFiles(r, article); err != nil { + return "", 0, err + } + + fileName, ok := uploadName(r) + if !ok { + return field("error", loc.T("api-missing-file-name")), http.StatusBadRequest, nil + } + if _, err := h.deps.DB.LiveFileNamed(ctx, article.ID, fileName); err == nil { + return field("error", loc.T("api-file-exists")), http.StatusConflict, nil + } else if !errors.Is(err, db.ErrNotFound) { + return "", 0, err + } + + unique, err := randomName() + if err != nil { + return "", 0, err + } + mediaName := unique + filepath.Ext(fileName) + stored := filepath.Join(h.deps.Files, "media", + media.QuoteName(article.MediaName), media.QuoteName(mediaName)) + size, over, err := h.store(r, stored) + if err != nil { + return "", 0, err + } + if over { + return field("error", loc.T("api-upload-too-large")), http.StatusRequestEntityTooLarge, nil + } + + var userID *int64 + if user := auth.FromContext(ctx); user != nil { + userID = &user.ID + } + at := time.Now().UTC() + id, err := h.deps.DB.AddArticleFile(ctx, db.FileWrite{ + ArticleID: article.ID, + Name: fileName, + MediaName: mediaName, + MimeType: uploadMime(r), + Size: size, + AuthorID: userID, + At: at, + }) + if err != nil { + _ = os.Remove(stored) + return "", 0, err + } + meta, err := json.Marshal(map[string]any{"name": fileName, "id": id}) + if err != nil { + return "", 0, err + } + if _, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, + db.LogFileAdded, "", string(meta), at); err != nil { + return "", 0, err + } + return field("status", "ok"), http.StatusOK, nil +} + +// Reading the whole body first would hold an upload of any size in memory, so +// the ceiling is checked as the bytes land and a refusal cleans up after itself. +func (h *Articles) store(r *http.Request, stored string) (size int64, over bool, err error) { + live, total, err := h.deps.DB.FileSpaceUsage(r.Context()) + if err != nil { + return 0, false, err + } + if err := os.MkdirAll(filepath.Dir(stored), 0o755); err != nil { + return 0, false, err + } + out, err := os.Create(stored) + if err != nil { + return 0, false, err + } + defer out.Close() + + buf := make([]byte, uploadChunk) + for { + n, readErr := r.Body.Read(buf) + size += int64(n) + if overLimit(h.deps.SoftLimit, live+size) || overLimit(h.deps.HardLimit, total+size) { + out.Close() + _ = os.Remove(stored) + return 0, true, nil + } + if n > 0 { + if _, err := out.Write(buf[:n]); err != nil { + out.Close() + _ = os.Remove(stored) + return 0, false, err + } + } + if readErr == io.EOF { + return size, false, nil + } + if readErr != nil { + out.Close() + _ = os.Remove(stored) + return 0, false, readErr + } + } +} + +func randomName() (string, error) { + var b [16]byte + if _, err := rand.Read(b[:]); err != nil { + return "", err + } + b[6] = (b[6] & 0x0f) | 0x40 + b[8] = (b[8] & 0x3f) | 0x80 + return fmt.Sprintf("%x-%x-%x-%x-%x", b[0:4], b[4:6], b[6:8], b[8:10], b[10:16]), nil +} + +func overLimit(limit, used int64) bool { + return limit > 0 && used > limit +} + +func uploadName(r *http.Request) (string, bool) { + raw := r.Header.Get("x-file-name") + if raw == "" { + return "", false + } + // Percent escapes only. A '+' is a character a file name may legitimately + // carry, not a stand-in for a space. + decoded, err := url.PathUnescape(raw) + if err != nil { + return raw, true + } + return decoded, true +} + +func uploadMime(r *http.Request) string { + if mime := r.Header.Get("Content-Type"); mime != "" { + return mime + } + return "application/octet-stream" +} + +func (h *Articles) removeFile(r *http.Request, loc *i18n.Localizer, + file *db.FileRow, article *db.Article) (string, int, error) { + + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", 0, errors.New("webapi: the request carries no site") + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return field("error", loc.T("api-csrf-failed")), http.StatusForbidden, nil + } + + var userID *int64 + if user := auth.FromContext(ctx); user != nil { + userID = &user.ID + } + at := time.Now().UTC() + if _, _, err := h.deps.DB.SoftDeleteFile(ctx, file.ID, at, userID); err != nil { + return "", 0, err + } + meta, err := json.Marshal(map[string]any{"name": file.Name, "id": file.ID}) + if err != nil { + return "", 0, err + } + if _, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, + db.LogFileDeleted, "", string(meta), at); err != nil { + return "", 0, err + } + return field("status", "ok"), http.StatusOK, nil +} + +func (h *Articles) renameFile(r *http.Request, loc *i18n.Localizer, + file *db.FileRow, article *db.Article) (string, int, error) { + + ctx := r.Context() + current := site.FromContext(ctx) + if current == nil { + return "", 0, errors.New("webapi: the request carries no site") + } + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + return field("error", loc.T("api-csrf-failed")), http.StatusForbidden, nil + } + + raw, err := readBody(r) + if err != nil { + return field("error", loc.T("api-bad-request")), http.StatusBadRequest, nil + } + var body fields + if json.Unmarshal(raw, &body) != nil || !body.has("name") { + return field("error", loc.T("api-bad-request")), http.StatusBadRequest, nil + } + wanted, _ := body.text("name") + if wanted == "" { + return field("error", loc.T("api-missing-file-name")), http.StatusBadRequest, nil + } + + taken, err := h.deps.DB.LiveFileNamed(ctx, article.ID, wanted) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return "", 0, err + } + if err == nil && taken != file.ID { + return field("error", loc.T("api-file-exists")), http.StatusConflict, nil + } + + previous, _, err := h.deps.DB.RenameFile(ctx, file.ID, wanted) + if err != nil { + return "", 0, err + } + if previous == wanted { + return field("status", "ok"), http.StatusOK, nil + } + + var userID *int64 + if user := auth.FromContext(ctx); user != nil { + userID = &user.ID + } + meta, err := json.Marshal(map[string]any{"name": wanted, "prev_name": previous, "id": file.ID}) + if err != nil { + return "", 0, err + } + if _, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, + db.LogFileRenamed, "", string(meta), time.Now().UTC()); err != nil { + return "", 0, err + } + return field("status", "ok"), http.StatusOK, nil +} diff --git a/internal/webapi/webapi.go b/internal/webapi/webapi.go index dfc51da3..3c3a9ffa 100644 --- a/internal/webapi/webapi.go +++ b/internal/webapi/webapi.go @@ -46,6 +46,10 @@ type Deps struct { Icons roles.IconLoader Files string Log *slog.Logger + + // Zero means no ceiling at all, which is what an unconfigured site gets. + SoftLimit int64 + HardLimit int64 } type Handler struct { From 2b1cc694bf8e38115a3e9a5121a58fc2539846ef Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 20:32:58 +0900 Subject: [PATCH 244/428] grey the highlight on a thread starter's post --- static/app.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/app.css b/static/app.css index 2415fb90..77e1dffc 100644 --- a/static/app.css +++ b/static/app.css @@ -166,7 +166,7 @@ /* New forum triks */ .thread-container .post .long .head.op-post { - background: #e4f0c8; + background: #e0e0e0; } /* =============== */ From 2ef01edbd5a4248356c5b721d36e8ab5402713ed Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 20:33:04 +0900 Subject: [PATCH 245/428] give a forum post the id hooks a wikidot theme reaches for --- internal/difftest/corpus/articles.txt | 2 + internal/modules/forumthread.go | 13 +- internal/repo/testdata/forumthread.golden | 696 +++++++++++----------- 3 files changed, 357 insertions(+), 354 deletions(-) diff --git a/internal/difftest/corpus/articles.txt b/internal/difftest/corpus/articles.txt index 0aae342c..fe90c22a 100644 --- a/internal/difftest/corpus/articles.txt +++ b/internal/difftest/corpus/articles.txt @@ -67,6 +67,8 @@ OPTIONS /probe:full /forum/t-999999/p/2 /forum:new-thread /forum:new-thread/c/999999 +!/forum/t-121 +# a thread that actually holds posts, unlike the misses above it. /search:site /search:site/q/scp /search:site/q/%20spaced%20/author/probe-author diff --git a/internal/modules/forumthread.go b/internal/modules/forumthread.go index e20dc3e4..b8cacfd6 100644 --- a/internal/modules/forumthread.go +++ b/internal/modules/forumthread.go @@ -652,26 +652,27 @@ func forumThreadHTML(env module.Env, view forumThreadView) string { func forumPostsHTML(posts []forumThreadPost) string { var b strings.Builder for _, post := range posts { + id := strconv.FormatInt(post.id, 10) head := `
    ` if post.isOP { head = `
    ` } - b.WriteString("\n" + ind8 + `
    ` + - "\n" + ind12 + `
    ` + + b.WriteString("\n" + ind8 + `
    ` + + "\n" + ind12 + `
    ` + "\n" + ind16 + `
    ` + "\n" + ind20 + head + - "\n" + ind24 + `
    ` + + "\n" + ind24 + `
    ` + "\n" + ind28 + escape.HTML(post.name) + "\n" + ind24 + `
    ` + "\n" + ind24 + `
    ` + "\n" + ind28 + post.author + " " + post.createdAt + " " + post.authorRate + "\n" + ind24 + `
    ` + "\n" + ind20 + `
    ` + - "\n" + ind20 + `
    ` + + "\n" + ind20 + `
    ` + "\n" + ind24 + post.content + "\n" + ind20 + `
    ` + - "\n" + ind20 + `
    ` + + "\n" + ind20 + `
    ` + "\n" + ind16 + `
    ` + "\n" + ind12 + `
    ` + "\n" + ind12) diff --git a/internal/repo/testdata/forumthread.golden b/internal/repo/testdata/forumthread.golden index 23b19582..242bae7b 100644 --- a/internal/repo/testdata/forumthread.golden +++ b/internal/repo/testdata/forumthread.golden @@ -47,11 +47,11 @@ status: 200
    -
    +
    -
    +
    Probe Deep Thread post 0
    @@ -67,19 +67,19 @@ status: 200 09.10.2023 11:43
    -
    +

    Probe Deep Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Deep reply 0
    @@ -95,19 +95,19 @@ status: 200 09.10.2023 11:45
    -
    +

    reply naming @probe-author and @nobody-at-all

    -
    +
    -
    +
    -
    +
    Probe Deep reply 0 0
    @@ -123,10 +123,10 @@ status: 200 09.10.2023 11:46
    -
    +

    a reply to a reply

    -
    +
    @@ -135,31 +135,31 @@ status: 200
    -
    +
    -
    +
    Probe Deep reply 1
    系统 09.10.2023 11:47
    -
    +

    a reply the site itself made

    -
    +
    -
    +
    -
    +
    @@ -175,10 +175,10 @@ status: 200 09.10.2023 11:48
    -
    +

    a reply whose title is only spaces

    -
    +
    @@ -187,11 +187,11 @@ status: 200
    -
    +
    -
    +
    Probe Deep Thread post 1
    @@ -207,10 +207,10 @@ status: 200 09.10.2023 11:44
    -
    +

    Probe Deep Thread body 1 edited

    -
    +
    @@ -270,11 +270,11 @@ status: 200
    -
    +
    -
    +
    Probe Deep Thread post 0
    @@ -290,19 +290,19 @@ status: 200 09.10.2023 11:43
    -
    +

    Probe Deep Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Deep reply 0
    @@ -318,19 +318,19 @@ status: 200 09.10.2023 11:45
    -
    +

    reply naming @probe-author and @nobody-at-all

    -
    +
    -
    +
    -
    +
    Probe Deep reply 0 0
    @@ -346,10 +346,10 @@ status: 200 09.10.2023 11:46
    -
    +

    a reply to a reply

    -
    +
    @@ -358,31 +358,31 @@ status: 200
    -
    +
    -
    +
    Probe Deep reply 1
    系统 09.10.2023 11:47
    -
    +

    a reply the site itself made

    -
    +
    -
    +
    -
    +
    @@ -398,10 +398,10 @@ status: 200 09.10.2023 11:48
    -
    +

    a reply whose title is only spaces

    -
    +
    @@ -410,11 +410,11 @@ status: 200
    -
    +
    -
    +
    Probe Deep Thread post 1
    @@ -430,10 +430,10 @@ status: 200 09.10.2023 11:44
    -
    +

    Probe Deep Thread body 1 edited

    -
    +
    @@ -455,11 +455,11 @@ status: 200
    -
    +
    -
    +
    Probe Deep Thread post 0
    @@ -475,19 +475,19 @@ status: 200 09.10.2023 11:43
    -
    +

    Probe Deep Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Deep reply 0
    @@ -503,19 +503,19 @@ status: 200 09.10.2023 11:45
    -
    +

    reply naming @probe-author and @nobody-at-all

    -
    +
    -
    +
    -
    +
    Probe Deep reply 0 0
    @@ -531,10 +531,10 @@ status: 200 09.10.2023 11:46
    -
    +

    a reply to a reply

    -
    +
    @@ -543,31 +543,31 @@ status: 200
    -
    +
    -
    +
    Probe Deep reply 1
    系统 09.10.2023 11:47
    -
    +

    a reply the site itself made

    -
    +
    -
    +
    -
    +
    @@ -583,10 +583,10 @@ status: 200 09.10.2023 11:48
    -
    +

    a reply whose title is only spaces

    -
    +
    @@ -595,11 +595,11 @@ status: 200
    -
    +
    -
    +
    Probe Deep Thread post 1
    @@ -615,10 +615,10 @@ status: 200 09.10.2023 11:44
    -
    +

    Probe Deep Thread body 1 edited

    -
    +
    @@ -678,11 +678,11 @@ status: 200
    -
    +
    -
    +
    Probe Locked Thread post 0
    @@ -698,10 +698,10 @@ status: 200 09.10.2023 11:15
    -
    +

    Probe Locked Thread body 0

    -
    +
    @@ -780,11 +780,11 @@ status: 200
    -
    +
    -
    +
    Probe Long Thread post 0
    @@ -800,20 +800,20 @@ status: 200 09.10.2023 11:49
    -
    +

    Probe Long Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 1
    @@ -829,20 +829,20 @@ status: 200 09.10.2023 11:50
    -
    +

    Probe Long Thread body 1

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 2
    @@ -858,20 +858,20 @@ status: 200 09.10.2023 11:51
    -
    +

    Probe Long Thread body 2

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 3
    @@ -887,20 +887,20 @@ status: 200 09.10.2023 11:52
    -
    +

    Probe Long Thread body 3

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 4
    @@ -916,20 +916,20 @@ status: 200 09.10.2023 11:53
    -
    +

    Probe Long Thread body 4

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 5
    @@ -945,20 +945,20 @@ status: 200 09.10.2023 11:54
    -
    +

    Probe Long Thread body 5

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 6
    @@ -974,20 +974,20 @@ status: 200 09.10.2023 11:55
    -
    +

    Probe Long Thread body 6

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 7
    @@ -1003,20 +1003,20 @@ status: 200 09.10.2023 11:56
    -
    +

    Probe Long Thread body 7

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 8
    @@ -1032,20 +1032,20 @@ status: 200 09.10.2023 11:57
    -
    +

    Probe Long Thread body 8

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 9
    @@ -1061,10 +1061,10 @@ status: 200 09.10.2023 11:58
    -
    +

    Probe Long Thread body 9

    -
    +
    @@ -1162,11 +1162,11 @@ status: 200
    -
    +
    -
    +
    Probe Long Thread post 10
    @@ -1182,20 +1182,20 @@ status: 200 09.10.2023 11:59
    -
    +

    Probe Long Thread body 10

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 11
    @@ -1211,10 +1211,10 @@ status: 200 09.10.2023 12:00
    -
    +

    Probe Long Thread body 11

    -
    +
    @@ -1312,11 +1312,11 @@ status: 200
    -
    +
    -
    +
    Probe Long Thread post 10
    @@ -1332,20 +1332,20 @@ status: 200 09.10.2023 11:59
    -
    +

    Probe Long Thread body 10

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 11
    @@ -1361,10 +1361,10 @@ status: 200 09.10.2023 12:00
    -
    +

    Probe Long Thread body 11

    -
    +
    @@ -1462,11 +1462,11 @@ status: 200
    -
    +
    -
    +
    Probe Long Thread post 0
    @@ -1482,20 +1482,20 @@ status: 200 09.10.2023 11:49
    -
    +

    Probe Long Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 1
    @@ -1511,20 +1511,20 @@ status: 200 09.10.2023 11:50
    -
    +

    Probe Long Thread body 1

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 2
    @@ -1540,20 +1540,20 @@ status: 200 09.10.2023 11:51
    -
    +

    Probe Long Thread body 2

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 3
    @@ -1569,20 +1569,20 @@ status: 200 09.10.2023 11:52
    -
    +

    Probe Long Thread body 3

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 4
    @@ -1598,20 +1598,20 @@ status: 200 09.10.2023 11:53
    -
    +

    Probe Long Thread body 4

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 5
    @@ -1627,20 +1627,20 @@ status: 200 09.10.2023 11:54
    -
    +

    Probe Long Thread body 5

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 6
    @@ -1656,20 +1656,20 @@ status: 200 09.10.2023 11:55
    -
    +

    Probe Long Thread body 6

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 7
    @@ -1685,20 +1685,20 @@ status: 200 09.10.2023 11:56
    -
    +

    Probe Long Thread body 7

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 8
    @@ -1714,20 +1714,20 @@ status: 200 09.10.2023 11:57
    -
    +

    Probe Long Thread body 8

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 9
    @@ -1743,10 +1743,10 @@ status: 200 09.10.2023 11:58
    -
    +

    Probe Long Thread body 9

    -
    +
    @@ -1844,11 +1844,11 @@ status: 200
    -
    +
    -
    +
    Probe Long Thread post 0
    @@ -1864,20 +1864,20 @@ status: 200 09.10.2023 11:49
    -
    +

    Probe Long Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 1
    @@ -1893,20 +1893,20 @@ status: 200 09.10.2023 11:50
    -
    +

    Probe Long Thread body 1

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 2
    @@ -1922,20 +1922,20 @@ status: 200 09.10.2023 11:51
    -
    +

    Probe Long Thread body 2

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 3
    @@ -1951,20 +1951,20 @@ status: 200 09.10.2023 11:52
    -
    +

    Probe Long Thread body 3

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 4
    @@ -1980,20 +1980,20 @@ status: 200 09.10.2023 11:53
    -
    +

    Probe Long Thread body 4

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 5
    @@ -2009,20 +2009,20 @@ status: 200 09.10.2023 11:54
    -
    +

    Probe Long Thread body 5

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 6
    @@ -2038,20 +2038,20 @@ status: 200 09.10.2023 11:55
    -
    +

    Probe Long Thread body 6

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 7
    @@ -2067,20 +2067,20 @@ status: 200 09.10.2023 11:56
    -
    +

    Probe Long Thread body 7

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 8
    @@ -2096,20 +2096,20 @@ status: 200 09.10.2023 11:57
    -
    +

    Probe Long Thread body 8

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 9
    @@ -2125,10 +2125,10 @@ status: 200 09.10.2023 11:58
    -
    +

    Probe Long Thread body 9

    -
    +
    @@ -2226,11 +2226,11 @@ status: 200
    -
    +
    -
    +
    Probe Long Thread post 10
    @@ -2246,20 +2246,20 @@ status: 200 09.10.2023 11:59
    -
    +

    Probe Long Thread body 10

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 11
    @@ -2275,10 +2275,10 @@ status: 200 09.10.2023 12:00
    -
    +

    Probe Long Thread body 11

    -
    +
    @@ -2357,11 +2357,11 @@ status: 200
    -
    +
    -
    +
    Probe Deep Thread post 0
    @@ -2377,19 +2377,19 @@ status: 200 09.10.2023 11:43
    -
    +

    Probe Deep Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Deep reply 0
    @@ -2405,19 +2405,19 @@ status: 200 09.10.2023 11:45
    -
    +

    reply naming @probe-author and @nobody-at-all

    -
    +
    -
    +
    -
    +
    Probe Deep reply 0 0
    @@ -2433,10 +2433,10 @@ status: 200 09.10.2023 11:46
    -
    +

    a reply to a reply

    -
    +
    @@ -2445,31 +2445,31 @@ status: 200
    -
    +
    -
    +
    Probe Deep reply 1
    系统 09.10.2023 11:47
    -
    +

    a reply the site itself made

    -
    +
    -
    +
    -
    +
    @@ -2485,10 +2485,10 @@ status: 200 09.10.2023 11:48
    -
    +

    a reply whose title is only spaces

    -
    +
    @@ -2497,11 +2497,11 @@ status: 200
    -
    +
    -
    +
    Probe Deep Thread post 1
    @@ -2517,10 +2517,10 @@ status: 200 09.10.2023 11:44
    -
    +

    Probe Deep Thread body 1 edited

    -
    +
    @@ -2599,11 +2599,11 @@ status: 200
    -
    +
    -
    +
    Probe Long Thread post 0
    @@ -2619,20 +2619,20 @@ status: 200 09.10.2023 11:49
    -
    +

    Probe Long Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 1
    @@ -2648,20 +2648,20 @@ status: 200 09.10.2023 11:50
    -
    +

    Probe Long Thread body 1

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 2
    @@ -2677,20 +2677,20 @@ status: 200 09.10.2023 11:51
    -
    +

    Probe Long Thread body 2

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 3
    @@ -2706,20 +2706,20 @@ status: 200 09.10.2023 11:52
    -
    +

    Probe Long Thread body 3

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 4
    @@ -2735,20 +2735,20 @@ status: 200 09.10.2023 11:53
    -
    +

    Probe Long Thread body 4

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 5
    @@ -2764,20 +2764,20 @@ status: 200 09.10.2023 11:54
    -
    +

    Probe Long Thread body 5

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 6
    @@ -2793,20 +2793,20 @@ status: 200 09.10.2023 11:55
    -
    +

    Probe Long Thread body 6

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 7
    @@ -2822,20 +2822,20 @@ status: 200 09.10.2023 11:56
    -
    +

    Probe Long Thread body 7

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 8
    @@ -2851,20 +2851,20 @@ status: 200 09.10.2023 11:57
    -
    +

    Probe Long Thread body 8

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 9
    @@ -2880,10 +2880,10 @@ status: 200 09.10.2023 11:58
    -
    +

    Probe Long Thread body 9

    -
    +
    @@ -2981,11 +2981,11 @@ status: 200
    -
    +
    -
    +
    Probe Long Thread post 0
    @@ -3001,20 +3001,20 @@ status: 200 09.10.2023 11:49
    -
    +

    Probe Long Thread body 0

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 1
    @@ -3030,20 +3030,20 @@ status: 200 09.10.2023 11:50
    -
    +

    Probe Long Thread body 1

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 2
    @@ -3059,20 +3059,20 @@ status: 200 09.10.2023 11:51
    -
    +

    Probe Long Thread body 2

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 3
    @@ -3088,20 +3088,20 @@ status: 200 09.10.2023 11:52
    -
    +

    Probe Long Thread body 3

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 4
    @@ -3117,20 +3117,20 @@ status: 200 09.10.2023 11:53
    -
    +

    Probe Long Thread body 4

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 5
    @@ -3146,20 +3146,20 @@ status: 200 09.10.2023 11:54
    -
    +

    Probe Long Thread body 5

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 6
    @@ -3175,20 +3175,20 @@ status: 200 09.10.2023 11:55
    -
    +

    Probe Long Thread body 6

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 7
    @@ -3204,20 +3204,20 @@ status: 200 09.10.2023 11:56
    -
    +

    Probe Long Thread body 7

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 8
    @@ -3233,20 +3233,20 @@ status: 200 09.10.2023 11:57
    -
    +

    Probe Long Thread body 8

    -
    +
    -
    +
    -
    +
    Probe Long Thread post 9
    @@ -3262,10 +3262,10 @@ status: 200 09.10.2023 11:58
    -
    +

    Probe Long Thread body 9

    -
    +
    @@ -3336,11 +3336,11 @@ status: 200
    -
    +
    -
    +
    probe post 0
    @@ -3356,20 +3356,20 @@ status: 200 09.10.2023 11:41 +1
    -
    +

    probe comment 0

    -
    +
    -
    +
    -
    +
    probe post 1
    @@ -3385,10 +3385,10 @@ status: 200 09.10.2023 11:42 +1
    -
    +

    probe comment 1

    -
    +
    @@ -3436,11 +3436,11 @@ status: 200
    -
    +
    -
    +
    probe post 0
    @@ -3456,20 +3456,20 @@ status: 200 09.10.2023 11:41 +1
    -
    +

    probe comment 0

    -
    +
    -
    +
    -
    +
    probe post 1
    @@ -3485,10 +3485,10 @@ status: 200 09.10.2023 11:42 +1
    -
    +

    probe comment 1

    -
    +
    @@ -3536,11 +3536,11 @@ status: 200
    -
    +
    -
    +
    probe post 0
    @@ -3556,20 +3556,20 @@ status: 200 09.10.2023 11:39 4.0
    -
    +

    probe comment 0

    -
    +
    -
    +
    -
    +
    probe post 1
    @@ -3585,10 +3585,10 @@ status: 200 09.10.2023 11:40 5.0
    -
    +

    probe comment 1

    -
    +
    From 132d10ac6723febbbf09e39d774a336a03890f25 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 20:33:10 +0900 Subject: [PATCH 246/428] give the post options the button classes a wikidot theme reaches for --- web/js/entrypoints/forum-post-options.tsx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/js/entrypoints/forum-post-options.tsx b/web/js/entrypoints/forum-post-options.tsx index 874e445f..6c451ef3 100644 --- a/web/js/entrypoints/forum-post-options.tsx +++ b/web/js/entrypoints/forum-post-options.tsx @@ -315,25 +315,25 @@ const ForumPostOptions: React.FC = ({ )} {canReply && ( - + {t('forum-post-options.reply')} )}{' '} {(canEdit || canDelete) && ( - + {t('forum-post-options.options')} )} {open && (
    {canEdit && ( - + {t('forum-post-options.edit')} )}{' '} {canDelete && ( - + {t('forum-post-options.delete')} )} From 2c9c586b7ccbbf8d54a355115c2f7c440ec22999 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 22:37:26 +0900 Subject: [PATCH 247/428] hand back the log entry a write leaves behind --- internal/db/article_revert.go | 18 ++--- internal/db/article_write.go | 107 +++++++++++++++--------------- internal/db/article_write_test.go | 16 ++--- internal/db/tag_write.go | 34 +++++----- internal/db/vote.go | 21 +++--- 5 files changed, 99 insertions(+), 97 deletions(-) diff --git a/internal/db/article_revert.go b/internal/db/article_revert.go index 7acdb671..63c2dbcd 100644 --- a/internal/db/article_revert.go +++ b/internal/db/article_revert.go @@ -209,28 +209,28 @@ type RevertWrite struct { At time.Time } -func (d *DB) WriteRevertEntry(ctx context.Context, w RevertWrite) (int, error) { +func (d *DB) WriteRevertEntry(ctx context.Context, w RevertWrite) (Revision, error) { tx, err := d.pool.Begin(ctx) if err != nil { - return 0, fmt.Errorf("begin revert of %d: %w", w.ArticleID, err) + return Revision{}, fmt.Errorf("begin revert of %d: %w", w.ArticleID, err) } defer tx.Rollback(ctx) if _, err := tx.Exec(ctx, qLockArticleLog, w.ArticleID); err != nil { - return 0, fmt.Errorf("lock article log %d: %w", w.ArticleID, err) + return Revision{}, fmt.Errorf("lock article log %d: %w", w.ArticleID, err) } - var revNumber int + var rev Revision if err := tx.QueryRow(ctx, qInsertArticleLog, w.ArticleID, w.UserID, LogRevert, - string(w.Meta), "", w.At).Scan(&revNumber); err != nil { - return 0, fmt.Errorf("write revision of %d: %w", w.ArticleID, err) + string(w.Meta), "", w.At).Scan(&rev.EntryID, &rev.RevNumber); err != nil { + return Revision{}, fmt.Errorf("write revision of %d: %w", w.ArticleID, err) } if _, err := tx.Exec(ctx, qTouchArticle, w.ArticleID, w.At); err != nil { - return 0, fmt.Errorf("touch article %d: %w", w.ArticleID, err) + return Revision{}, fmt.Errorf("touch article %d: %w", w.ArticleID, err) } if err := tx.Commit(ctx); err != nil { - return 0, fmt.Errorf("commit revert of %d: %w", w.ArticleID, err) + return Revision{}, fmt.Errorf("commit revert of %d: %w", w.ArticleID, err) } - return revNumber, nil + return rev, nil } var ( diff --git a/internal/db/article_write.go b/internal/db/article_write.go index b00815cd..d26a1ca6 100644 --- a/internal/db/article_write.go +++ b/internal/db/article_write.go @@ -27,6 +27,7 @@ const ( type Revision struct { VersionID int64 + EntryID int64 RevNumber int } @@ -70,7 +71,7 @@ func (d *DB) CreateArticleVersion(ctx context.Context, w VersionWrite) (Revision return Revision{}, fmt.Errorf("lock article log %d: %w", w.ArticleID, err) } if err := tx.QueryRow(ctx, qInsertArticleLog, w.ArticleID, w.UserID, w.Kind, meta, - w.Comment, w.At).Scan(&rev.RevNumber); err != nil { + w.Comment, w.At).Scan(&rev.EntryID, &rev.RevNumber); err != nil { return Revision{}, fmt.Errorf("write revision of %d: %w", w.ArticleID, err) } if _, err := tx.Exec(ctx, qTouchArticle, w.ArticleID, w.At); err != nil { @@ -194,31 +195,31 @@ var qSetArticleParent = register("SetArticleParent", ` UPDATE web_article SET parent_id = $2 WHERE id = $1`) func (d *DB) SetArticleParent(ctx context.Context, articleID int64, parentID *int64, - userID *int64, meta string, at time.Time) (int, error) { + userID *int64, meta string, at time.Time) (Revision, error) { tx, err := d.pool.Begin(ctx) if err != nil { - return 0, fmt.Errorf("begin parent of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("begin parent of %d: %w", articleID, err) } defer tx.Rollback(ctx) if _, err := tx.Exec(ctx, qSetArticleParent, articleID, parentID); err != nil { - return 0, fmt.Errorf("set parent of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("set parent of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { - return 0, fmt.Errorf("lock article log %d: %w", articleID, err) + return Revision{}, fmt.Errorf("lock article log %d: %w", articleID, err) } - var revNumber int - if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogParent, meta, "", at).Scan(&revNumber); err != nil { - return 0, fmt.Errorf("write revision of %d: %w", articleID, err) + var rev Revision + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogParent, meta, "", at).Scan(&rev.EntryID, &rev.RevNumber); err != nil { + return Revision{}, fmt.Errorf("write revision of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { - return 0, fmt.Errorf("touch article %d: %w", articleID, err) + return Revision{}, fmt.Errorf("touch article %d: %w", articleID, err) } if err := tx.Commit(ctx); err != nil { - return 0, fmt.Errorf("commit parent of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("commit parent of %d: %w", articleID, err) } - return revNumber, nil + return rev, nil } // Nothing stops a second row for the same pair, so the check rides inside the @@ -247,40 +248,40 @@ UPDATE web_article SET title = $2 WHERE id = $1`) // The old title is read under the same lock that replaces it, so the revision // cannot name a title some other writer has already moved past. func (d *DB) UpdateArticleTitle(ctx context.Context, articleID int64, title string, - userID *int64, at time.Time) (int, error) { + userID *int64, at time.Time) (Revision, error) { tx, err := d.pool.Begin(ctx) if err != nil { - return 0, fmt.Errorf("begin title of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("begin title of %d: %w", articleID, err) } defer tx.Rollback(ctx) var previous string if err := tx.QueryRow(ctx, qReadArticleTitle, articleID).Scan(&previous); err != nil { - return 0, fmt.Errorf("read title of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("read title of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qUpdateArticleTitle, articleID, title); err != nil { - return 0, fmt.Errorf("set title of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("set title of %d: %w", articleID, err) } meta, err := json.Marshal(map[string]any{"title": title, "prev_title": previous}) if err != nil { - return 0, fmt.Errorf("encode title meta of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("encode title meta of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { - return 0, fmt.Errorf("lock article log %d: %w", articleID, err) + return Revision{}, fmt.Errorf("lock article log %d: %w", articleID, err) } - var revNumber int - if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogTitle, string(meta), "", at).Scan(&revNumber); err != nil { - return 0, fmt.Errorf("write revision of %d: %w", articleID, err) + var rev Revision + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogTitle, string(meta), "", at).Scan(&rev.EntryID, &rev.RevNumber); err != nil { + return Revision{}, fmt.Errorf("write revision of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { - return 0, fmt.Errorf("touch article %d: %w", articleID, err) + return Revision{}, fmt.Errorf("touch article %d: %w", articleID, err) } if err := tx.Commit(ctx); err != nil { - return 0, fmt.Errorf("commit title of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("commit title of %d: %w", articleID, err) } - return revNumber, nil + return rev, nil } // Locking leaves no revision behind, so the page history says nothing about it. @@ -308,62 +309,62 @@ DELETE FROM web_article_authors WHERE article_id = $1 AND NOT (user_id = ANY($2) // An empty list means the caller had nothing to say, not that the page should // lose the credit it has. func (d *DB) SetArticleAuthors(ctx context.Context, articleID int64, authorIDs []int64, - userID *int64, at time.Time) (int, bool, error) { + userID *int64, at time.Time) (Revision, bool, error) { if len(authorIDs) == 0 { - return 0, false, nil + return Revision{}, false, nil } tx, err := d.pool.Begin(ctx) if err != nil { - return 0, false, fmt.Errorf("begin authors of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("begin authors of %d: %w", articleID, err) } defer tx.Rollback(ctx) wanted, err := scanIDs(ctx, tx, qKnownUsers, authorIDs) if err != nil { - return 0, false, fmt.Errorf("look up authors of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("look up authors of %d: %w", articleID, err) } if len(wanted) == 0 { - return 0, false, nil + return Revision{}, false, nil } held, err := scanIDs(ctx, tx, qReadArticleAuthors, articleID) if err != nil { - return 0, false, fmt.Errorf("read authors of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("read authors of %d: %w", articleID, err) } added := missingFrom(wanted, held) removed := missingFrom(held, wanted) if len(added) == 0 && len(removed) == 0 { - return 0, false, nil + return Revision{}, false, nil } if _, err := tx.Exec(ctx, qDropArticleAuthors, articleID, wanted); err != nil { - return 0, false, fmt.Errorf("drop authors of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("drop authors of %d: %w", articleID, err) } for _, id := range added { if _, err := tx.Exec(ctx, qInsertArticleAuthor, articleID, id); err != nil { - return 0, false, fmt.Errorf("credit author of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("credit author of %d: %w", articleID, err) } } meta, err := json.Marshal(map[string]any{"added_authors": added, "removed_authors": removed}) if err != nil { - return 0, false, fmt.Errorf("encode authorship meta of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("encode authorship meta of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { - return 0, false, fmt.Errorf("lock article log %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("lock article log %d: %w", articleID, err) } - var revNumber int - if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogAuthorship, string(meta), "", at).Scan(&revNumber); err != nil { - return 0, false, fmt.Errorf("write revision of %d: %w", articleID, err) + var rev Revision + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogAuthorship, string(meta), "", at).Scan(&rev.EntryID, &rev.RevNumber); err != nil { + return Revision{}, false, fmt.Errorf("write revision of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { - return 0, false, fmt.Errorf("touch article %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("touch article %d: %w", articleID, err) } if err := tx.Commit(ctx); err != nil { - return 0, false, fmt.Errorf("commit authors of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("commit authors of %d: %w", articleID, err) } - return revNumber, true, nil + return rev, true, nil } // The result is never nil. A nil slice reaches Postgres as NULL, and a delete @@ -410,42 +411,42 @@ UPDATE web_externallink SET link_from = $2 WHERE link_from = $1`) // What a page points at moves with it, but what points at the page does not. // Everyone who linked to the old name keeps linking to the old name. func (d *DB) RenameArticle(ctx context.Context, articleID int64, category, name, from string, - userID *int64, at time.Time) (int, error) { + userID *int64, at time.Time) (Revision, error) { to := (&Article{Category: category, Name: name}).FullName() tx, err := d.pool.Begin(ctx) if err != nil { - return 0, fmt.Errorf("begin rename of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("begin rename of %d: %w", articleID, err) } defer tx.Rollback(ctx) if _, err := tx.Exec(ctx, qRenameArticle, articleID, category, name); err != nil { - return 0, fmt.Errorf("rename article %d: %w", articleID, err) + return Revision{}, fmt.Errorf("rename article %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qDropLinksFrom, to); err != nil { - return 0, fmt.Errorf("drop links of %q: %w", to, err) + return Revision{}, fmt.Errorf("drop links of %q: %w", to, err) } if _, err := tx.Exec(ctx, qMoveLinksFrom, from, to); err != nil { - return 0, fmt.Errorf("move links of %q: %w", from, err) + return Revision{}, fmt.Errorf("move links of %q: %w", from, err) } meta, err := json.Marshal(map[string]any{"name": to, "prev_name": from}) if err != nil { - return 0, fmt.Errorf("encode rename meta of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("encode rename meta of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { - return 0, fmt.Errorf("lock article log %d: %w", articleID, err) + return Revision{}, fmt.Errorf("lock article log %d: %w", articleID, err) } - var revNumber int - if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogName, string(meta), "", at).Scan(&revNumber); err != nil { - return 0, fmt.Errorf("write revision of %d: %w", articleID, err) + var rev Revision + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogName, string(meta), "", at).Scan(&rev.EntryID, &rev.RevNumber); err != nil { + return Revision{}, fmt.Errorf("write revision of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { - return 0, fmt.Errorf("touch article %d: %w", articleID, err) + return Revision{}, fmt.Errorf("touch article %d: %w", articleID, err) } if err := tx.Commit(ctx); err != nil { - return 0, fmt.Errorf("commit rename of %d: %w", articleID, err) + return Revision{}, fmt.Errorf("commit rename of %d: %w", articleID, err) } - return revNumber, nil + return rev, nil } diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go index 9e50c914..e12fdd89 100644 --- a/internal/db/article_write_test.go +++ b/internal/db/article_write_test.go @@ -406,8 +406,8 @@ func TestSetArticleParentRecordsTheMove(t *testing.T) { if err != nil { t.Fatalf("SetArticleParent() err = %v, want nil", err) } - if rev != 0 { - t.Errorf("SetArticleParent().RevNumber = %d, want 0", rev) + if rev.RevNumber != 0 { + t.Errorf("SetArticleParent().RevNumber = %d, want 0", rev.RevNumber) } article, err := d.ArticleByID(ctx, child) @@ -483,8 +483,8 @@ func TestUpdateArticleTitleRecordsWhatItWas(t *testing.T) { if err != nil { t.Fatalf("UpdateArticleTitle() err = %v, want nil", err) } - if rev != 0 { - t.Errorf("UpdateArticleTitle() = %d, want 0", rev) + if rev.RevNumber != 0 { + t.Errorf("UpdateArticleTitle().RevNumber = %d, want 0", rev.RevNumber) } article, err := d.ArticleByID(ctx, id) @@ -611,8 +611,8 @@ func TestSetArticleAuthorsReplacesTheCredit(t *testing.T) { if !wrote { t.Fatal("SetArticleAuthors() wrote no revision, want one") } - if rev != 0 { - t.Errorf("SetArticleAuthors() = %d, want 0", rev) + if rev.RevNumber != 0 { + t.Errorf("SetArticleAuthors().RevNumber = %d, want 0", rev.RevNumber) } got := authorsOf(t, d, id) @@ -710,8 +710,8 @@ func TestRenameArticleTakesItsLinksAlong(t *testing.T) { if err != nil { t.Fatalf("RenameArticle() err = %v, want nil", err) } - if rev != 0 { - t.Errorf("RenameArticle() = %d, want 0", rev) + if rev.RevNumber != 0 { + t.Errorf("RenameArticle().RevNumber = %d, want 0", rev.RevNumber) } article, err := d.ArticleByID(ctx, id) diff --git a/internal/db/tag_write.go b/internal/db/tag_write.go index 0cae1c92..24281ee1 100644 --- a/internal/db/tag_write.go +++ b/internal/db/tag_write.go @@ -65,27 +65,27 @@ WHERE slug = name // A name with a space in it is dropped rather than refused, so one bad entry // does not cost the page the rest of its tags. func (d *DB) SetArticleTags(ctx context.Context, articleID int64, tags []string, - allowCreate bool, userID *int64, at time.Time) (int, bool, error) { + allowCreate bool, userID *int64, at time.Time) (Revision, bool, error) { tx, err := d.pool.Begin(ctx) if err != nil { - return 0, false, fmt.Errorf("begin tags of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("begin tags of %d: %w", articleID, err) } defer tx.Rollback(ctx) wanted, err := resolveTags(ctx, tx, tags, allowCreate) if err != nil { - return 0, false, fmt.Errorf("resolve tags of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("resolve tags of %d: %w", articleID, err) } held, err := readArticleTags(ctx, tx, articleID) if err != nil { - return 0, false, fmt.Errorf("read tags of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("read tags of %d: %w", articleID, err) } added := tagsMissingFrom(wanted, held) removed := tagsMissingFrom(held, wanted) if len(added) == 0 && len(removed) == 0 { - return 0, false, nil + return Revision{}, false, nil } keep := make([]int64, 0, len(wanted)) @@ -93,40 +93,40 @@ func (d *DB) SetArticleTags(ctx context.Context, articleID int64, tags []string, keep = append(keep, tag.ID) } if _, err := tx.Exec(ctx, qDropArticleTags, articleID, keep); err != nil { - return 0, false, fmt.Errorf("drop tags of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("drop tags of %d: %w", articleID, err) } for _, tag := range added { if _, err := tx.Exec(ctx, qInsertArticleTag, articleID, tag.ID); err != nil { - return 0, false, fmt.Errorf("tag %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("tag %d: %w", articleID, err) } } if allowCreate { if _, err := tx.Exec(ctx, qDropOrphanTags); err != nil { - return 0, false, fmt.Errorf("sweep tags: %w", err) + return Revision{}, false, fmt.Errorf("sweep tags: %w", err) } if _, err := tx.Exec(ctx, qDropOrphanTagCategories); err != nil { - return 0, false, fmt.Errorf("sweep tag categories: %w", err) + return Revision{}, false, fmt.Errorf("sweep tag categories: %w", err) } } meta, err := json.Marshal(map[string]any{"added_tags": added, "removed_tags": removed}) if err != nil { - return 0, false, fmt.Errorf("encode tag meta of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("encode tag meta of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { - return 0, false, fmt.Errorf("lock article log %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("lock article log %d: %w", articleID, err) } - var revNumber int - if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogTags, string(meta), "", at).Scan(&revNumber); err != nil { - return 0, false, fmt.Errorf("write revision of %d: %w", articleID, err) + var rev Revision + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, LogTags, string(meta), "", at).Scan(&rev.EntryID, &rev.RevNumber); err != nil { + return Revision{}, false, fmt.Errorf("write revision of %d: %w", articleID, err) } if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { - return 0, false, fmt.Errorf("touch article %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("touch article %d: %w", articleID, err) } if err := tx.Commit(ctx); err != nil { - return 0, false, fmt.Errorf("commit tags of %d: %w", articleID, err) + return Revision{}, false, fmt.Errorf("commit tags of %d: %w", articleID, err) } - return revNumber, true, nil + return rev, true, nil } func resolveTags(ctx context.Context, tx pgx.Tx, tags []string, allowCreate bool) ([]taggedName, error) { diff --git a/internal/db/vote.go b/internal/db/vote.go index 45f169f9..d87fdc53 100644 --- a/internal/db/vote.go +++ b/internal/db/vote.go @@ -181,7 +181,7 @@ var ( INSERT INTO web_articlelogentry (article_id, user_id, type, meta, comment, created_at, rev_number) SELECT $1, $2, $3, $4, $5, $6, COALESCE(MAX(rev_number), -1) + 1 FROM web_articlelogentry WHERE article_id = $1 -RETURNING rev_number`) +RETURNING id, rev_number`) qTouchArticle = register("TouchArticle", ` UPDATE web_article SET updated_at = $2 WHERE id = $1`) @@ -190,26 +190,27 @@ UPDATE web_article SET updated_at = $2 WHERE id = $1`) // The revision is numbered under a lock on this article alone, so two writers // cannot pick the same number and neither waits on a page it is not touching. func (d *DB) AddArticleLogEntry(ctx context.Context, articleID int64, userID *int64, - kind, comment, meta string, at time.Time) (int, error) { + kind, comment, meta string, at time.Time) (Revision, error) { tx, err := d.pool.Begin(ctx) if err != nil { - return 0, fmt.Errorf("begin log entry: %w", err) + return Revision{}, fmt.Errorf("begin log entry: %w", err) } defer tx.Rollback(ctx) if _, err := tx.Exec(ctx, qLockArticleLog, articleID); err != nil { - return 0, fmt.Errorf("lock article log %d: %w", articleID, err) + return Revision{}, fmt.Errorf("lock article log %d: %w", articleID, err) } - var revNumber int - if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, kind, meta, comment, at).Scan(&revNumber); err != nil { - return 0, fmt.Errorf("write log entry: %w", err) + var rev Revision + if err := tx.QueryRow(ctx, qInsertArticleLog, articleID, userID, kind, meta, comment, at). + Scan(&rev.EntryID, &rev.RevNumber); err != nil { + return Revision{}, fmt.Errorf("write log entry: %w", err) } if _, err := tx.Exec(ctx, qTouchArticle, articleID, at); err != nil { - return 0, fmt.Errorf("touch article %d: %w", articleID, err) + return Revision{}, fmt.Errorf("touch article %d: %w", articleID, err) } if err := tx.Commit(ctx); err != nil { - return 0, fmt.Errorf("commit log entry: %w", err) + return Revision{}, fmt.Errorf("commit log entry: %w", err) } - return revNumber, nil + return rev, nil } From 994bcbe262e84f7be02e57c18effe2b5440c95d4 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 22:37:42 +0900 Subject: [PATCH 248/428] add the statements a notification needs --- internal/db/article_log.go | 21 ++++ internal/db/notify_write.go | 108 ++++++++++++++++++ internal/db/notify_write_test.go | 181 +++++++++++++++++++++++++++++++ 3 files changed, 310 insertions(+) create mode 100644 internal/db/notify_write.go create mode 100644 internal/db/notify_write_test.go diff --git a/internal/db/article_log.go b/internal/db/article_log.go index e615e090..cba15211 100644 --- a/internal/db/article_log.go +++ b/internal/db/article_log.go @@ -2,8 +2,11 @@ package db import ( "context" + "errors" "fmt" "time" + + "github.com/jackc/pgx/v5" ) type LogEntry struct { @@ -54,3 +57,21 @@ func (d *DB) ArticleLogCount(ctx context.Context, articleID int64) (int, error) } return n, nil } + +var qLogEntryByID = register("LogEntryByID", ` +SELECT rev_number, type, meta, comment, created_at, user_id +FROM web_articlelogentry +WHERE id = $1`) + +func (d *DB) LogEntryByID(ctx context.Context, id int64) (LogEntry, error) { + var e LogEntry + err := d.pool.QueryRow(ctx, qLogEntryByID, id). + Scan(&e.RevNumber, &e.Type, &e.Meta, &e.Comment, &e.CreatedAt, &e.UserID) + if errors.Is(err, pgx.ErrNoRows) { + return LogEntry{}, ErrNotFound + } + if err != nil { + return LogEntry{}, fmt.Errorf("read log entry %d: %w", id, err) + } + return e, nil +} diff --git a/internal/db/notify_write.go b/internal/db/notify_write.go new file mode 100644 index 00000000..ea68bab0 --- /dev/null +++ b/internal/db/notify_write.go @@ -0,0 +1,108 @@ +package db + +import ( + "context" + "fmt" + "time" +) + +const ( + NotifyWelcome = "welcome" + NotifyNewPostReply = "new_post_reply" + NotifyNewThreadPost = "new_thread_post" + NotifyNewArticleRevision = "new_article_revision" + NotifyForumMention = "forum_mention" + NotifyDirectMessage = "direct_message" +) + +var ( + qInsertNotification = register("InsertNotification", ` +INSERT INTO web_usernotification (type, meta, created_at) +VALUES ($1, $2, $3) +RETURNING id`) + + qInsertNotificationMappings = register("InsertNotificationMappings", ` +INSERT INTO web_usernotificationmapping (notification_id, recipient_id, is_viewed) +SELECT $1, recipient, false +FROM unnest($2::bigint[]) AS recipient`) +) + +// The notification and the rows naming its readers go in together, so nobody +// ends up with a notification that reaches no one. +func (d *DB) SendNotification(ctx context.Context, kind, meta string, recipients []int64, at time.Time) error { + if len(recipients) == 0 { + return nil + } + tx, err := d.pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin notification: %w", err) + } + defer tx.Rollback(ctx) + + var id int64 + if err := tx.QueryRow(ctx, qInsertNotification, kind, meta, at).Scan(&id); err != nil { + return fmt.Errorf("write notification %q: %w", kind, err) + } + if _, err := tx.Exec(ctx, qInsertNotificationMappings, id, recipients); err != nil { + return fmt.Errorf("write recipients of notification %d: %w", id, err) + } + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit notification %q: %w", kind, err) + } + return nil +} + +var qArticleSubscribers = register("ArticleSubscribers", ` +SELECT subscriber_id +FROM web_usernotificationsubscription +WHERE article_id = $1 +ORDER BY subscriber_id`) + +func (d *DB) ArticleSubscribers(ctx context.Context, articleID int64) ([]int64, error) { + return d.subscriberIDs(ctx, qArticleSubscribers, articleID) +} + +var qThreadSubscribers = register("ThreadSubscribers", ` +SELECT subscriber_id +FROM web_usernotificationsubscription +WHERE forum_thread_id = $1 +ORDER BY subscriber_id`) + +func (d *DB) ThreadSubscribers(ctx context.Context, threadID int64) ([]int64, error) { + return d.subscriberIDs(ctx, qThreadSubscribers, threadID) +} + +func (d *DB) subscriberIDs(ctx context.Context, sql string, id int64) ([]int64, error) { + rows, err := d.pool.Query(ctx, sql, id) + if err != nil { + return nil, fmt.Errorf("list subscribers of %d: %w", id, err) + } + defer rows.Close() + + var out []int64 + for rows.Next() { + var one int64 + if err := rows.Scan(&one); err != nil { + return nil, fmt.Errorf("scan subscriber: %w", err) + } + out = append(out, one) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("list subscribers of %d: %w", id, err) + } + return out, nil +} + +var qSubscribeToThread = register("SubscribeToThread", ` +INSERT INTO web_usernotificationsubscription (subscriber_id, forum_thread_id) +SELECT $1, $2 +WHERE NOT EXISTS ( + SELECT 1 FROM web_usernotificationsubscription + WHERE subscriber_id = $1 AND forum_thread_id = $2)`) + +func (d *DB) SubscribeToThread(ctx context.Context, userID, threadID int64) error { + if _, err := d.pool.Exec(ctx, qSubscribeToThread, userID, threadID); err != nil { + return fmt.Errorf("subscribe %d to thread %d: %w", userID, threadID, err) + } + return nil +} diff --git a/internal/db/notify_write_test.go b/internal/db/notify_write_test.go new file mode 100644 index 00000000..fbd3d880 --- /dev/null +++ b/internal/db/notify_write_test.go @@ -0,0 +1,181 @@ +package db + +import ( + "context" + "testing" + "time" +) + +func scratchUser(t *testing.T, d *DB, name string) int64 { + t.Helper() + ctx := context.Background() + var id int64 + err := d.pool.QueryRow(ctx, ` +INSERT INTO web_user (password, is_superuser, first_name, last_name, email, date_joined, + username, type, bio, is_forum_active, is_active, can_send_direct_messages) +VALUES ('!', false, '', '', $1, now(), $2, 'normal', '', true, true, true) +RETURNING id`, name+"@example.invalid", name).Scan(&id) + if err != nil { + t.Fatalf("insert scratch user err = %v, want nil", err) + } + t.Cleanup(func() { + clean := context.Background() + for _, sql := range []string{ + `DELETE FROM web_usernotificationmapping WHERE recipient_id = $1`, + `DELETE FROM web_usernotificationsubscription WHERE subscriber_id = $1`, + `DELETE FROM web_user WHERE id = $1`, + } { + if _, err := d.pool.Exec(clean, sql, id); err != nil { + t.Errorf("clean up scratch user err = %v, want nil", err) + } + } + }) + return id +} + +func dropNotification(t *testing.T, d *DB, after int64) { + t.Helper() + t.Cleanup(func() { + clean := context.Background() + for _, sql := range []string{ + `DELETE FROM web_usernotificationmapping WHERE notification_id > $1`, + `DELETE FROM web_usernotification WHERE id > $1`, + } { + if _, err := d.pool.Exec(clean, sql, after); err != nil { + t.Errorf("clean up notification err = %v, want nil", err) + } + } + }) +} + +func highestNotification(t *testing.T, d *DB) int64 { + t.Helper() + var id int64 + err := d.pool.QueryRow(context.Background(), + `SELECT COALESCE(MAX(id), 0) FROM web_usernotification`).Scan(&id) + if err != nil { + t.Fatalf("read highest notification err = %v, want nil", err) + } + return id +} + +func TestSendNotificationReachesEveryRecipient(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + dropNotification(t, d, highestNotification(t, d)) + first := scratchUser(t, d, "probe-notify-a") + second := scratchUser(t, d, "probe-notify-b") + + err := d.SendNotification(ctx, NotifyNewArticleRevision, `{"probe": true}`, + []int64{first, second}, time.Now().UTC()) + if err != nil { + t.Fatalf("SendNotification() err = %v, want nil", err) + } + + var count int + err = d.pool.QueryRow(ctx, ` +SELECT count(*) FROM web_usernotificationmapping m +JOIN web_usernotification n ON n.id = m.notification_id +WHERE n.type = $1 AND m.recipient_id = ANY($2) AND m.is_viewed = false`, + NotifyNewArticleRevision, []int64{first, second}).Scan(&count) + if err != nil { + t.Fatalf("count recipients err = %v, want nil", err) + } + if count != 2 { + t.Errorf("SendNotification() reached %d recipients, want 2", count) + } +} + +func TestSendNotificationToNobodyWritesNothing(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + before := highestNotification(t, d) + + if err := d.SendNotification(ctx, NotifyWelcome, `{}`, nil, time.Now().UTC()); err != nil { + t.Fatalf("SendNotification() err = %v, want nil", err) + } + if got := highestNotification(t, d); got != before { + t.Errorf("highest notification = %d, want %d", got, before) + } +} + +func TestArticleSubscribersListsWhoAsked(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + first := scratchUser(t, d, "probe-sub-a") + second := scratchUser(t, d, "probe-sub-b") + + for _, id := range []int64{first, second} { + if err := d.SubscribeToArticle(ctx, id, article); err != nil { + t.Fatalf("SubscribeToArticle(%d) err = %v, want nil", id, err) + } + } + got, err := d.ArticleSubscribers(ctx, article) + if err != nil { + t.Fatalf("ArticleSubscribers() err = %v, want nil", err) + } + if len(got) != 2 { + t.Fatalf("len(ArticleSubscribers()) = %d, want 2", len(got)) + } + if got[0] != first || got[1] != second { + t.Errorf("ArticleSubscribers() = %v, want [%d %d]", got, first, second) + } +} + +func TestSubscribeToThreadOnlyOnce(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + user := scratchUser(t, d, "probe-sub-thread") + var thread int64 + if err := d.pool.QueryRow(ctx, `SELECT id FROM web_forumthread ORDER BY id LIMIT 1`).Scan(&thread); err != nil { + t.Skipf("no forum thread in the write database, skipping") + } + + for i := 0; i < 2; i++ { + if err := d.SubscribeToThread(ctx, user, thread); err != nil { + t.Fatalf("SubscribeToThread() err = %v, want nil", err) + } + } + got, err := d.ThreadSubscribers(ctx, thread) + if err != nil { + t.Fatalf("ThreadSubscribers() err = %v, want nil", err) + } + seen := 0 + for _, id := range got { + if id == user { + seen++ + } + } + if seen != 1 { + t.Errorf("ThreadSubscribers() holds the subscriber %d times, want 1", seen) + } +} + +func TestLogEntryByIDReadsWhatWasWritten(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + article := scratchArticle(t, d) + + rev, err := d.AddArticleLogEntry(ctx, article, nil, LogTitle, "why", `{"title": "After"}`, time.Now().UTC()) + if err != nil { + t.Fatalf("AddArticleLogEntry() err = %v, want nil", err) + } + if rev.EntryID == 0 { + t.Fatal("AddArticleLogEntry().EntryID = 0, want the row id") + } + + entry, err := d.LogEntryByID(ctx, rev.EntryID) + if err != nil { + t.Fatalf("LogEntryByID() err = %v, want nil", err) + } + if entry.Type != LogTitle { + t.Errorf("LogEntryByID().Type = %q, want %q", entry.Type, LogTitle) + } + if entry.Comment != "why" { + t.Errorf("LogEntryByID().Comment = %q, want %q", entry.Comment, "why") + } + if entry.RevNumber != rev.RevNumber { + t.Errorf("LogEntryByID().RevNumber = %d, want %d", entry.RevNumber, rev.RevNumber) + } +} From 9f72fa8db2e98db46468c8d625cf69fd94a780cf Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 22:37:56 +0900 Subject: [PATCH 249/428] tell subscribers and the action log what a save did --- internal/webapi/articles.go | 8 +- internal/webapi/create.go | 26 +++++- internal/webapi/delete.go | 7 ++ internal/webapi/files.go | 24 +++-- internal/webapi/notify.go | 156 ++++++++++++++++++++++++++++++++ internal/webapi/revert_apply.go | 8 +- internal/webapi/update.go | 46 +++++++--- 7 files changed, 248 insertions(+), 27 deletions(-) create mode 100644 internal/webapi/notify.go diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index c5bfed06..0986779e 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -321,8 +321,12 @@ func (h *Articles) resetVotes(r *http.Request, loc *i18n.Localizer, name string) if user != nil { userID = &user.ID } - if _, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, - db.LogVotesDeleted, "", meta, time.Now().UTC()); err != nil { + rev, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, + db.LogVotesDeleted, "", meta, time.Now().UTC()) + if err != nil { + return "", 0, err + } + if err := h.notifyRevision(r, article, rev); err != nil { return "", 0, err } return field("status", "ok"), http.StatusOK, nil diff --git a/internal/webapi/create.go b/internal/webapi/create.go index bf52f7a1..c5df9259 100644 --- a/internal/webapi/create.go +++ b/internal/webapi/create.go @@ -145,14 +145,25 @@ func (h *Articles) writeNewArticle(r *http.Request, current *db.Site, name strin if err != nil { return err } - if _, err := h.deps.DB.CreateArticleVersion(ctx, db.VersionWrite{ + rev, err := h.deps.DB.CreateArticleVersion(ctx, db.VersionWrite{ ArticleID: id, Source: *input.Source, UserID: userID, Kind: db.LogNew, Title: *input.Title, At: at, - }); err != nil { + }) + if err != nil { + return err + } + fresh, err := h.deps.DB.ArticleByID(ctx, id) + if err != nil { + return err + } + if err := h.logCreate(r, fresh, user); err != nil { + return err + } + if err := h.notifyRevision(r, fresh, rev); err != nil { return err } if err := h.refreshLinks(r, current, id, *input.Source); err != nil { @@ -217,8 +228,15 @@ func (h *Articles) setParent(r *http.Request, current *db.Site, id int64, if err != nil { return err } - _, err = h.deps.DB.SetArticleParent(ctx, id, parentID, userID, meta, at) - return err + rev, err := h.deps.DB.SetArticleParent(ctx, id, parentID, userID, meta, at) + if err != nil { + return err + } + child, err := h.deps.DB.ArticleByID(ctx, id) + if err != nil { + return err + } + return h.notifyRevision(r, child, rev) } // A page created with a parent had none a moment ago, so the previous half of diff --git a/internal/webapi/delete.go b/internal/webapi/delete.go index d834f1e1..5f42fe21 100644 --- a/internal/webapi/delete.go +++ b/internal/webapi/delete.go @@ -43,9 +43,16 @@ func (h *Articles) remove(r *http.Request, loc *i18n.Localizer, name string) (st return "", 0, errForbidden } + rating, err := h.rating(r, article) + if err != nil { + return "", 0, err + } if err := h.deps.DB.DeleteArticle(ctx, article.ID, article.FullName()); err != nil { return "", 0, err } + if err := h.logDelete(r, article, user, rating); err != nil { + return "", 0, err + } h.dropMedia(article.MediaName) return field("status", "ok"), http.StatusOK, nil } diff --git a/internal/webapi/files.go b/internal/webapi/files.go index ecc5f917..cf104443 100644 --- a/internal/webapi/files.go +++ b/internal/webapi/files.go @@ -257,8 +257,12 @@ func (h *Articles) upload(r *http.Request, loc *i18n.Localizer, name string) (st if err != nil { return "", 0, err } - if _, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, - db.LogFileAdded, "", string(meta), at); err != nil { + rev, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, + db.LogFileAdded, "", string(meta), at) + if err != nil { + return "", 0, err + } + if err := h.notifyRevision(r, article, rev); err != nil { return "", 0, err } return field("status", "ok"), http.StatusOK, nil @@ -366,8 +370,12 @@ func (h *Articles) removeFile(r *http.Request, loc *i18n.Localizer, if err != nil { return "", 0, err } - if _, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, - db.LogFileDeleted, "", string(meta), at); err != nil { + rev, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, + db.LogFileDeleted, "", string(meta), at) + if err != nil { + return "", 0, err + } + if err := h.notifyRevision(r, article, rev); err != nil { return "", 0, err } return field("status", "ok"), http.StatusOK, nil @@ -422,8 +430,12 @@ func (h *Articles) renameFile(r *http.Request, loc *i18n.Localizer, if err != nil { return "", 0, err } - if _, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, - db.LogFileRenamed, "", string(meta), time.Now().UTC()); err != nil { + rev, err := h.deps.DB.AddArticleLogEntry(ctx, article.ID, userID, + db.LogFileRenamed, "", string(meta), time.Now().UTC()) + if err != nil { + return "", 0, err + } + if err := h.notifyRevision(r, article, rev); err != nil { return "", 0, err } return field("status", "ok"), http.StatusOK, nil diff --git a/internal/webapi/notify.go b/internal/webapi/notify.go new file mode 100644 index 00000000..87c907f5 --- /dev/null +++ b/internal/webapi/notify.go @@ -0,0 +1,156 @@ +package webapi + +import ( + "encoding/json" + "net/http" + "net/netip" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/repo" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +// Every log entry a save writes is announced on its own, so an edit that both +// renames and retitles arrives as two. +func (h *Articles) notifyRevision(r *http.Request, article *db.Article, rev db.Revision) error { + ctx := r.Context() + if rev.EntryID == 0 { + return nil + } + entry, err := h.deps.DB.LogEntryByID(ctx, rev.EntryID) + if err != nil { + return err + } + editor := auth.FromContext(ctx) + if err := h.logEdit(r, article, entry, editor); err != nil { + return err + } + readers, err := h.revisionReaders(r, article, editor) + if err != nil || len(readers) == 0 { + return err + } + + who, err := repo.UserJSON(ctx, h.deps.DB, editor) + if err != nil { + return err + } + meta, err := decodeMeta(entry.Meta) + if err != nil { + return err + } + body, err := wikijson.Marshal(wikijson.Object{ + {Key: "user", Value: who}, + {Key: "article", Value: wikijson.Object{ + {Key: "uid", Value: article.ID}, + {Key: "pageId", Value: article.FullName()}, + {Key: "title", Value: article.Title}, + }}, + {Key: "rev_id", Value: rev.EntryID}, + {Key: "rev_meta", Value: fromJSON(meta)}, + {Key: "rev_number", Value: entry.RevNumber}, + {Key: "rev_type", Value: entry.Type}, + {Key: "comment", Value: entry.Comment}, + }) + if err != nil { + return err + } + return h.deps.DB.SendNotification(ctx, db.NotifyNewArticleRevision, body, readers, time.Now().UTC()) +} + +func (h *Articles) revisionReaders(r *http.Request, article *db.Article, editor *db.User) ([]int64, error) { + ctx := r.Context() + subscribers, err := h.deps.DB.ArticleSubscribers(ctx, article.ID) + if err != nil { + return nil, err + } + perm := repo.NewPerms(ctx, h.deps.DB) + at := time.Now() + + out := make([]int64, 0, len(subscribers)) + for _, id := range subscribers { + if editor != nil && id == editor.ID { + continue + } + reader, err := h.deps.DB.UserByID(ctx, id) + if err != nil { + return nil, err + } + subject, err := perm.Subject(reader, at) + if err != nil { + return nil, err + } + object, err := perm.Article(article, reader) + if err != nil { + return nil, err + } + if perms.Resolve(subject, object).Has(perms.ViewArticles) { + out = append(out, id) + } + } + return out, nil +} + +// The revision that created the page is left out, since the page's own entry +// already says it was created. +func (h *Articles) logEdit(r *http.Request, article *db.Article, entry db.LogEntry, editor *db.User) error { + if entry.Type == db.LogNew { + return nil + } + meta, err := decodeMeta(entry.Meta) + if err != nil { + return err + } + body, err := wikijson.Marshal(wikijson.Object{ + {Key: "article", Value: article.FullName()}, + {Key: "comment", Value: entry.Comment}, + {Key: "edit_type", Value: entry.Type}, + {Key: "rev_number", Value: entry.RevNumber}, + {Key: "log_entry_meta", Value: fromJSON(meta)}, + }) + if err != nil { + return err + } + return h.act(r, editor, db.ActionEditArticle, body) +} + +func (h *Articles) logCreate(r *http.Request, article *db.Article, editor *db.User) error { + body, err := json.Marshal(map[string]any{"article": article.FullName()}) + if err != nil { + return err + } + return h.act(r, editor, db.ActionCreateArticle, string(body)) +} + +func (h *Articles) logDelete(r *http.Request, article *db.Article, editor *db.User, rating page.Rating) error { + body, err := json.Marshal(map[string]any{ + "article": article.FullName(), + "rating": rating.Value, + "votes": rating.Votes, + "popularity": rating.Popularity, + }) + if err != nil { + return err + } + return h.act(r, editor, db.ActionRemoveArticle, string(body)) +} + +// The address is the one the entry layer trusted, not whatever the request +// claimed, so a reverse proxy cannot be talked into logging a made-up client. +func (h *Articles) act(r *http.Request, user *db.User, kind, meta string) error { + var id *int64 + name := "" + if user != nil { + id, name = &user.ID, user.Username + } + var ip *netip.Addr + if h.deps.Trust != nil { + if addr, ok := h.deps.Trust.ClientIP(r); ok { + ip = &addr + } + } + return h.deps.DB.AddActionLog(r.Context(), id, name, kind, meta, ip, time.Now().UTC()) +} diff --git a/internal/webapi/revert_apply.go b/internal/webapi/revert_apply.go index 98858e55..8a28a0e8 100644 --- a/internal/webapi/revert_apply.go +++ b/internal/webapi/revert_apply.go @@ -125,9 +125,13 @@ func (rev *reverter) apply(target int) error { if err != nil { return err } - if _, err := rev.handler.deps.DB.WriteRevertEntry(rev.req.Context(), db.RevertWrite{ + written, err := rev.handler.deps.DB.WriteRevertEntry(rev.req.Context(), db.RevertWrite{ ArticleID: rev.article.ID, UserID: rev.userID, Meta: encoded, At: rev.at, - }); err != nil { + }) + if err != nil { + return err + } + if err := rev.handler.notifyRevision(rev.req, rev.article, written); err != nil { return err } return rev.reindex() diff --git a/internal/webapi/update.go b/internal/webapi/update.go index 15ffc4f8..ada2a224 100644 --- a/internal/webapi/update.go +++ b/internal/webapi/update.go @@ -202,12 +202,13 @@ func (e *editor) rename() (*refusal, error) { } newCategory, newName := wikidot.Split(free) - if _, err := e.handler.deps.DB.RenameArticle(e.req.Context(), e.article.ID, - newCategory, newName, from, e.userID, e.at); err != nil { + rev, err := e.handler.deps.DB.RenameArticle(e.req.Context(), e.article.ID, + newCategory, newName, from, e.userID, e.at) + if err != nil { return nil, err } e.article.Category, e.article.Name = newCategory, newName - return nil, nil + return nil, e.announce(rev) } // Without a free name the move would fail on the unique constraint. @@ -238,11 +239,12 @@ func (e *editor) retitle() (*refusal, error) { if !e.may(perms.EditArticles) { return ptr(refuse("api-forbidden", http.StatusForbidden)), nil } - if _, err := e.handler.deps.DB.UpdateArticleTitle(e.req.Context(), e.article.ID, title, e.userID, e.at); err != nil { + rev, err := e.handler.deps.DB.UpdateArticleTitle(e.req.Context(), e.article.ID, title, e.userID, e.at) + if err != nil { return nil, err } e.article.Title = title - return nil, nil + return nil, e.announce(rev) } func (e *editor) rewrite() (*refusal, error) { @@ -263,17 +265,21 @@ func (e *editor) rewrite() (*refusal, error) { } comment, _ := e.body.text("comment") - if _, err := e.handler.deps.DB.CreateArticleVersion(ctx, db.VersionWrite{ + rev, err := e.handler.deps.DB.CreateArticleVersion(ctx, db.VersionWrite{ ArticleID: e.article.ID, Source: source, UserID: e.userID, Kind: db.LogSource, Comment: comment, At: e.at, - }); err != nil { + }) + if err != nil { + return nil, err + } + if err := e.handler.refreshLinks(e.req, e.site, e.article.ID, source); err != nil { return nil, err } - return nil, e.handler.refreshLinks(e.req, e.site, e.article.ID, source) + return nil, e.announce(rev) } func (e *editor) retag() (*refusal, error) { @@ -288,8 +294,11 @@ func (e *editor) retag() (*refusal, error) { if err != nil { return nil, err } - _, _, err = e.handler.deps.DB.SetArticleTags(e.req.Context(), e.article.ID, tags, allow, e.userID, e.at) - return nil, err + rev, _, err := e.handler.deps.DB.SetArticleTags(e.req.Context(), e.article.ID, tags, allow, e.userID, e.at) + if err != nil { + return nil, err + } + return nil, e.announce(rev) } func (e *editor) mayCreateTags() (bool, error) { @@ -340,7 +349,11 @@ func (e *editor) reparent() (*refusal, error) { if err != nil { return nil, err } - if _, err := e.handler.deps.DB.SetArticleParent(ctx, e.article.ID, parentID, e.userID, string(meta), e.at); err != nil { + rev, err := e.handler.deps.DB.SetArticleParent(ctx, e.article.ID, parentID, e.userID, string(meta), e.at) + if err != nil { + return nil, err + } + if err := e.announce(rev); err != nil { return nil, err } e.article.ParentID = parentID @@ -395,8 +408,15 @@ func (e *editor) recredit() (*refusal, error) { ids = append(ids, id) } } - _, _, err := e.handler.deps.DB.SetArticleAuthors(e.req.Context(), e.article.ID, ids, e.userID, e.at) - return nil, err + rev, _, err := e.handler.deps.DB.SetArticleAuthors(e.req.Context(), e.article.ID, ids, e.userID, e.at) + if err != nil { + return nil, err + } + return nil, e.announce(rev) +} + +func (e *editor) announce(rev db.Revision) error { + return e.handler.notifyRevision(e.req, e.article, rev) } func (e *editor) answer() (string, int, error) { From 8248c81fe9c0693c35a9a0c30f9ac4e2ba53296a Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 22:38:15 +0900 Subject: [PATCH 250/428] add the statements a forum post needs --- internal/db/forum_write.go | 281 +++++++++++++++++++++++++++++++++++++ 1 file changed, 281 insertions(+) create mode 100644 internal/db/forum_write.go diff --git a/internal/db/forum_write.go b/internal/db/forum_write.go new file mode 100644 index 00000000..b9bdee5d --- /dev/null +++ b/internal/db/forum_write.go @@ -0,0 +1,281 @@ +package db + +import ( + "context" + "errors" + "fmt" + "time" + + "github.com/jackc/pgx/v5" +) + +type ForumPostVersion struct { + CreatedAt time.Time + AuthorID *int64 +} + +var qForumPostVersions = register("ForumPostVersions", ` +SELECT created_at, author_id +FROM web_forumpostversion +WHERE post_id = $1 +ORDER BY created_at DESC`) + +func (d *DB) ForumPostVersions(ctx context.Context, postID int64) ([]ForumPostVersion, error) { + rows, err := d.pool.Query(ctx, qForumPostVersions, postID) + if err != nil { + return nil, fmt.Errorf("list versions of post %d: %w", postID, err) + } + defer rows.Close() + + var out []ForumPostVersion + for rows.Next() { + var v ForumPostVersion + if err := rows.Scan(&v.CreatedAt, &v.AuthorID); err != nil { + return nil, fmt.Errorf("scan post version: %w", err) + } + out = append(out, v) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("list versions of post %d: %w", postID, err) + } + return out, nil +} + +var ( + qForumPostSource = register("ForumPostSource", ` +SELECT source FROM web_forumpostversion +WHERE post_id = $1 +ORDER BY created_at DESC +LIMIT 1`) + + qForumPostSourceAt = register("ForumPostSourceAt", ` +SELECT source FROM web_forumpostversion +WHERE post_id = $1 AND created_at <= $2 +ORDER BY created_at DESC +LIMIT 1`) +) + +// A post with no version behind it reads as empty rather than as missing, which +// is the same thing the thread page shows for it. +func (d *DB) ForumPostSource(ctx context.Context, postID int64, at *time.Time) (string, error) { + var source string + var err error + if at == nil { + err = d.pool.QueryRow(ctx, qForumPostSource, postID).Scan(&source) + } else { + err = d.pool.QueryRow(ctx, qForumPostSourceAt, postID, *at).Scan(&source) + } + if errors.Is(err, pgx.ErrNoRows) { + return "", nil + } + if err != nil { + return "", fmt.Errorf("read source of post %d: %w", postID, err) + } + return source, nil +} + +type ForumPostWrite struct { + ThreadID int64 + Name string + Source string + AuthorID *int64 + ReplyToID *int64 + At time.Time +} + +var ( + qInsertForumPost = register("InsertForumPost", ` +INSERT INTO web_forumpost (thread_id, name, author_id, reply_to_id, created_at, updated_at) +VALUES ($1, $2, $3, $4, $5, $5) +RETURNING id`) + + qInsertForumPostVersion = register("InsertForumPostVersion", ` +INSERT INTO web_forumpostversion (post_id, source, author_id, created_at) +VALUES ($1, $2, $3, $4)`) + + qTouchForumThread = register("TouchForumThread", ` +UPDATE web_forumthread SET updated_at = $2 WHERE id = $1`) +) + +// The post, its first version and the thread's timestamp move together, so a +// post that fails halfway leaves no body-less row behind. +func (d *DB) CreateForumPost(ctx context.Context, w ForumPostWrite) (int64, error) { + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin post: %w", err) + } + defer tx.Rollback(ctx) + + var id int64 + if err := tx.QueryRow(ctx, qInsertForumPost, w.ThreadID, w.Name, w.AuthorID, + w.ReplyToID, w.At).Scan(&id); err != nil { + return 0, fmt.Errorf("write post in thread %d: %w", w.ThreadID, err) + } + if _, err := tx.Exec(ctx, qInsertForumPostVersion, id, w.Source, w.AuthorID, w.At); err != nil { + return 0, fmt.Errorf("write first version of post %d: %w", id, err) + } + if _, err := tx.Exec(ctx, qTouchForumThread, w.ThreadID, w.At); err != nil { + return 0, fmt.Errorf("touch thread %d: %w", w.ThreadID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, fmt.Errorf("commit post in thread %d: %w", w.ThreadID, err) + } + return id, nil +} + +var qRenameForumPost = register("RenameForumPost", ` +UPDATE web_forumpost SET name = $2, updated_at = $3 WHERE id = $1`) + +// A body that did not change leaves no version, so the edit history only holds +// the times the text actually moved. +func (d *DB) UpdateForumPost(ctx context.Context, postID int64, name, source, previous string, + authorID *int64, at time.Time) error { + + tx, err := d.pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin edit of post %d: %w", postID, err) + } + defer tx.Rollback(ctx) + + if source != previous { + if _, err := tx.Exec(ctx, qInsertForumPostVersion, postID, source, authorID, at); err != nil { + return fmt.Errorf("write version of post %d: %w", postID, err) + } + } + if _, err := tx.Exec(ctx, qRenameForumPost, postID, name, at); err != nil { + return fmt.Errorf("edit post %d: %w", postID, err) + } + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit edit of post %d: %w", postID, err) + } + return nil +} + +// Replies to a deleted post become roots of the thread rather than following it +// down, so a whole branch does not vanish with one post. +var forumPostChildren = []string{ + `UPDATE web_forumpost SET reply_to_id = NULL WHERE reply_to_id = $1`, + `DELETE FROM web_forumpostversion WHERE post_id = $1`, + `DELETE FROM web_forumpost WHERE id = $1`, +} + +var qDeleteForumPost = registerAll("DeleteForumPost", forumPostChildren) + +func (d *DB) DeleteForumPost(ctx context.Context, postID int64) error { + tx, err := d.pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin delete of post %d: %w", postID, err) + } + defer tx.Rollback(ctx) + + for _, sql := range qDeleteForumPost { + if _, err := tx.Exec(ctx, sql, postID); err != nil { + return fmt.Errorf("delete post %d: %w", postID, err) + } + } + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit delete of post %d: %w", postID, err) + } + return nil +} + +type ForumThreadWrite struct { + CategoryID int64 + Name string + Description string + AuthorID *int64 + At time.Time +} + +var qInsertForumThread = register("InsertForumThread", ` +INSERT INTO web_forumthread (category_id, name, description, author_id, created_at, updated_at, is_pinned, is_locked) +VALUES ($1, $2, $3, $4, $5, $5, false, false) +RETURNING id`) + +// The thread and its first post go in together, so a thread that fails halfway +// does not show up empty in the category listing. +func (d *DB) CreateForumThread(ctx context.Context, w ForumThreadWrite, source string) (int64, int64, error) { + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, 0, fmt.Errorf("begin thread: %w", err) + } + defer tx.Rollback(ctx) + + var threadID int64 + if err := tx.QueryRow(ctx, qInsertForumThread, w.CategoryID, w.Name, w.Description, + w.AuthorID, w.At).Scan(&threadID); err != nil { + return 0, 0, fmt.Errorf("write thread in category %d: %w", w.CategoryID, err) + } + var postID int64 + if err := tx.QueryRow(ctx, qInsertForumPost, threadID, w.Name, w.AuthorID, + nil, w.At).Scan(&postID); err != nil { + return 0, 0, fmt.Errorf("write first post of thread %d: %w", threadID, err) + } + if _, err := tx.Exec(ctx, qInsertForumPostVersion, postID, source, w.AuthorID, w.At); err != nil { + return 0, 0, fmt.Errorf("write first version of post %d: %w", postID, err) + } + if err := tx.Commit(ctx); err != nil { + return 0, 0, fmt.Errorf("commit thread in category %d: %w", w.CategoryID, err) + } + return threadID, postID, nil +} + +type ForumThreadEdit struct { + Name *string + Description *string + Locked *bool + Pinned *bool + CategoryID *int64 +} + +var qUpdateForumThread = register("UpdateForumThread", ` +UPDATE web_forumthread SET + name = COALESCE($2, name), + description = COALESCE($3, description), + is_locked = COALESCE($4, is_locked), + is_pinned = COALESCE($5, is_pinned), + category_id = COALESCE($6, category_id) +WHERE id = $1`) + +func (d *DB) UpdateForumThread(ctx context.Context, threadID int64, e ForumThreadEdit) error { + _, err := d.pool.Exec(ctx, qUpdateForumThread, threadID, + e.Name, e.Description, e.Locked, e.Pinned, e.CategoryID) + if err != nil { + return fmt.Errorf("edit thread %d: %w", threadID, err) + } + return nil +} + +var qActiveUsersByNames = register("ActiveUsersByNames", ` +SELECT `+userColumns+` +FROM web_user +WHERE lower(username) = ANY($1) AND is_active AND type IN ('normal', 'bot') +ORDER BY id`) + +// A mention names someone by the name they type, which is matched without case +// so a post that writes it differently still reaches them. +func (d *DB) ActiveUsersByNames(ctx context.Context, names []string) ([]User, error) { + if len(names) == 0 { + return nil, nil + } + rows, err := d.pool.Query(ctx, qActiveUsersByNames, names) + if err != nil { + return nil, fmt.Errorf("look up mentioned users: %w", err) + } + defer rows.Close() + + var out []User + for rows.Next() { + var u User + dest, finish := userDest(&u) + if err := rows.Scan(dest...); err != nil { + return nil, fmt.Errorf("scan mentioned user: %w", err) + } + finish() + out = append(out, u) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("read mentioned users: %w", err) + } + return out, nil +} From b7ca7ee988d19ed282680d42994e4a03b82b832f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 22:38:24 +0900 Subject: [PATCH 251/428] answer the calls that read a forum post --- internal/module/module.go | 13 +++ internal/modules/forumpostapi.go | 175 +++++++++++++++++++++++++++++++ internal/repo/modules.go | 44 ++++++++ 3 files changed, 232 insertions(+) create mode 100644 internal/modules/forumpostapi.go diff --git a/internal/module/module.go b/internal/module/module.go index 6cd40e67..3e0400d7 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -5,6 +5,7 @@ package module import ( "slices" "strings" + "time" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/form" @@ -106,6 +107,18 @@ type Data interface { ArticleHasAuthor(articleID, userID int64) (bool, error) RolesByUser(id int64) ([]roles.Role, error) + ForumPostVersions(postID int64) ([]db.ForumPostVersion, error) + ForumPostSource(postID int64, at *time.Time) (string, error) + CreateForumPost(w db.ForumPostWrite) (int64, error) + CreateForumThread(w db.ForumThreadWrite, source string) (int64, int64, error) + UpdateForumPost(postID int64, name, source, previous string, authorID *int64) error + UpdateForumThread(threadID int64, e db.ForumThreadEdit) error + DeleteForumPost(postID int64) error + SendNotification(kind, meta string, recipients []int64) error + ThreadSubscribers(threadID int64) ([]int64, error) + SubscribeToThread(userID, threadID int64) error + ActiveUsersByNames(names []string) ([]db.User, error) + Subject(user *db.User) (perms.Subject, error) ForumSectionObject(s *db.ForumSection) *perms.Object ForumThreadObject(t *db.ForumThread, u *db.User) (*perms.Object, error) diff --git a/internal/modules/forumpostapi.go b/internal/modules/forumpostapi.go new file mode 100644 index 00000000..5343bc7d --- /dev/null +++ b/internal/modules/forumpostapi.go @@ -0,0 +1,175 @@ +package modules + +import ( + "errors" + "strconv" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +func init() { + module.RegisterAPI("forumpost", "fetch", forumPostFetch) + module.RegisterAPI("forumpost", "fetchversions", forumPostVersions) + module.RegisterAPI("forumthread", "for_article", forumThreadForArticle) + module.RegisterAPI("forumnewpost", "preview", forumPostPreview) +} + +func forumPostPreview(env module.Env, params map[string]string) (wikijson.Object, error) { + source, ok := params["source"] + if !ok { + return nil, &module.Error{Message: env.Text("module-forumpost-no-source")} + } + html, err := env.RenderMessage(source) + if err != nil { + return nil, err + } + return wikijson.Object{{Key: "result", Value: html}}, nil +} + +func forumThreadForArticle(env module.Env, _ map[string]string) (wikijson.Object, error) { + if env.Page == nil || env.Page.Article == nil { + return nil, &module.Error{Message: env.Text("module-forumthread-no-page")} + } + info, err := env.Data.CommentInfo(env.Page.Article.ID) + if err != nil { + return nil, err + } + return wikijson.Object{{Key: "threadId", Value: idOrNothing(info.ThreadID)}}, nil +} + +func forumPostFetch(env module.Env, params map[string]string) (wikijson.Object, error) { + post, err := readablePost(env, params) + if err != nil { + return nil, err + } + at, err := postDate(params) + if err != nil { + return nil, err + } + source, err := env.Data.ForumPostSource(post.ID, at) + if err != nil { + return nil, err + } + content, err := env.RenderMessage(source) + if err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "postId", Value: post.ID}, + {Key: "createdAt", Value: isoTime(post.CreatedAt)}, + {Key: "updatedAt", Value: isoTime(post.UpdatedAt)}, + {Key: "name", Value: post.Name}, + {Key: "source", Value: source}, + {Key: "content", Value: content}, + }, nil +} + +func forumPostVersions(env module.Env, params map[string]string) (wikijson.Object, error) { + post, err := readablePost(env, params) + if err != nil { + return nil, err + } + found, err := env.Data.ForumPostVersions(post.ID) + if err != nil { + return nil, err + } + + out := make(wikijson.Array, 0, len(found)) + for _, version := range found { + author, err := postVersionAuthor(env, version.AuthorID) + if err != nil { + return nil, err + } + out = append(out, wikijson.Object{ + {Key: "createdAt", Value: isoTime(version.CreatedAt)}, + {Key: "author", Value: author}, + }) + } + return wikijson.Object{{Key: "versions", Value: out}}, nil +} + +func postVersionAuthor(env module.Env, id *int64) (wikijson.Object, error) { + if id == nil { + return env.Data.UserJSON(nil) + } + user, err := env.Data.UserByID(*id) + if err != nil { + return nil, err + } + return env.Data.UserJSON(user) +} + +func readablePost(env module.Env, params map[string]string) (*db.ForumThreadPost, error) { + post, err := postByParam(env, params) + if err != nil { + return nil, err + } + allowed, err := postPermissions(env, post) + if err != nil { + return nil, err + } + if !allowed.Has(perms.ViewForumPosts) { + return nil, &module.Error{Message: env.Text("module-forumpost-cannot-view")} + } + return post, nil +} + +func postByParam(env module.Env, params map[string]string) (*db.ForumThreadPost, error) { + id, err := strconv.ParseInt(params["postid"], 10, 64) + if err != nil { + return nil, &module.Error{Message: env.Text("module-forumpost-missing", "id", params["postid"])} + } + post, err := env.Data.ForumPost(id) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + if post == nil { + return nil, &module.Error{Message: env.Text("module-forumpost-missing", "id", params["postid"])} + } + return post, nil +} + +func postPermissions(env module.Env, post *db.ForumThreadPost) (perms.Set, error) { + subject, err := env.Data.Subject(env.User) + if err != nil { + return perms.Set{}, err + } + thread, err := env.Data.ForumThread(post.ThreadID) + if err != nil { + return perms.Set{}, err + } + object, err := env.Data.ForumThreadObject(thread, env.User) + if err != nil { + return perms.Set{}, err + } + return perms.Resolve(subject, env.Data.ForumPostObject(post, object, env.User)), nil +} + +// A date the caller could not parse asks for the newest version, which is what +// an absent one asks for too. +func postDate(params map[string]string) (*time.Time, error) { + raw, ok := params["atdate"] + if !ok || raw == "" { + return nil, nil + } + at, err := time.Parse(time.RFC3339, raw) + if err != nil { + return nil, nil + } + return &at, nil +} + +func idOrNothing(id int64) any { + if id == 0 { + return nil + } + return id +} + +func isoTime(at time.Time) string { + return at.UTC().Format("2006-01-02T15:04:05.999999-07:00") +} diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 154c0363..90ccee2b 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -395,3 +395,47 @@ func (m moduleData) MemberCount(roleID *int64) (int, error) { func (m moduleData) RoleByRef(ref string) (*roles.Role, error) { return m.repo.db.RoleByRef(m.repo.ctx, ref) } + +func (m moduleData) ForumPostVersions(postID int64) ([]db.ForumPostVersion, error) { + return m.repo.db.ForumPostVersions(m.repo.ctx, postID) +} + +func (m moduleData) ForumPostSource(postID int64, at *time.Time) (string, error) { + return m.repo.db.ForumPostSource(m.repo.ctx, postID, at) +} + +func (m moduleData) CreateForumPost(w db.ForumPostWrite) (int64, error) { + return m.repo.db.CreateForumPost(m.repo.ctx, w) +} + +func (m moduleData) CreateForumThread(w db.ForumThreadWrite, source string) (int64, int64, error) { + return m.repo.db.CreateForumThread(m.repo.ctx, w, source) +} + +func (m moduleData) UpdateForumPost(postID int64, name, source, previous string, authorID *int64) error { + return m.repo.db.UpdateForumPost(m.repo.ctx, postID, name, source, previous, authorID, time.Now().UTC()) +} + +func (m moduleData) UpdateForumThread(threadID int64, e db.ForumThreadEdit) error { + return m.repo.db.UpdateForumThread(m.repo.ctx, threadID, e) +} + +func (m moduleData) DeleteForumPost(postID int64) error { + return m.repo.db.DeleteForumPost(m.repo.ctx, postID) +} + +func (m moduleData) SendNotification(kind, meta string, recipients []int64) error { + return m.repo.db.SendNotification(m.repo.ctx, kind, meta, recipients, time.Now().UTC()) +} + +func (m moduleData) ThreadSubscribers(threadID int64) ([]int64, error) { + return m.repo.db.ThreadSubscribers(m.repo.ctx, threadID) +} + +func (m moduleData) SubscribeToThread(userID, threadID int64) error { + return m.repo.db.SubscribeToThread(m.repo.ctx, userID, threadID) +} + +func (m moduleData) ActiveUsersByNames(names []string) ([]db.User, error) { + return m.repo.db.ActiveUsersByNames(m.repo.ctx, names) +} From 2ac7903898d01e7d6d67d1c54e296766b646624e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 4 Sep 2026 22:38:53 +0900 Subject: [PATCH 252/428] answer the calls that write a forum post --- internal/i18n/locales/zh-hans.json | 18 +- internal/modules/forumwriteapi.go | 627 +++++++++++++++++++++++++++++ internal/webapi/webapi_test.go | 2 +- 3 files changed, 645 insertions(+), 2 deletions(-) create mode 100644 internal/modules/forumwriteapi.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 47b04b6d..e862419e 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -54,6 +54,7 @@ "module-forum-title-named": "论坛 — {name}", "module-forum-view-post": "查看", "module-forumcategory-forbidden": "权限不足，无法查看该版块", + "module-forumcategory-not-given": "版块未找到或未指定", "module-forumcategory-pinned": "置顶：", "module-forumcategory-replies": "回复数", "module-forumcategory-sort": "排序方式：", @@ -63,6 +64,13 @@ "module-forumcategory-thread": "主题标题", "module-forumnewthread-forbidden": "权限不足，无法创建主题", "module-forumnewthread-style-note": "希望没人试图给论坛页面加样式", + "module-forumpost-cannot-create": "权限不足，无法创建帖子", + "module-forumpost-cannot-delete": "权限不足，无法删除帖子", + "module-forumpost-cannot-edit": "权限不足，无法编辑帖子", + "module-forumpost-cannot-view": "权限不足，无法查看帖子", + "module-forumpost-missing": "帖子 \"{id}\" 不存在", + "module-forumpost-no-source": "未提供帖子内容", + "module-forumpost-other-thread": "无法回复其他主题中的帖子", "module-forumstart-hide-hidden": "隐藏隐藏版块", "module-forumstart-posts": "帖子数", "module-forumstart-section": "版块名称", @@ -70,12 +78,21 @@ "module-forumstart-threads": "主题数", "module-forumstart-title": "论坛版块", "module-forumthread-article": "这是页面 {link} 的讨论", + "module-forumthread-cannot-create": "权限不足，无法创建主题", + "module-forumthread-cannot-edit": "权限不足，无法编辑主题", + "module-forumthread-cannot-lock": "权限不足，无法锁定主题", + "module-forumthread-cannot-move": "权限不足，无法移动主题", + "module-forumthread-cannot-pin": "权限不足，无法置顶主题", "module-forumthread-comments-forbidden": "权限不足，无法查看讨论", "module-forumthread-created-by": "创建者：", "module-forumthread-date": "日期：", "module-forumthread-description": "简短描述：", "module-forumthread-forbidden": "权限不足，无法查看主题", + "module-forumthread-no-page": "未指定页面", + "module-forumthread-no-source": "未提供首帖内容", + "module-forumthread-no-title": "未指定主题标题", "module-forumthread-not-found": "未找到主题 \"{name}\"", + "module-forumthread-not-given": "主题未找到或未指定", "module-forumthread-posts": "帖子数：", "module-frontforum-no-category": "[[module FrontForum]] 缺少 category 参数", "module-gallery-size": "不支持的图库尺寸：{size}", @@ -108,7 +125,6 @@ "module-recentposts-title": "论坛最新帖子", "module-rate-bad-value": "无效的评分 {value}", "module-rate-forbidden": "权限不足", - "module-rate-no-page": "未指定页面", "module-rate-no-value": "未指定评分值", "module-search-placeholder": "搜索文章标题或内容…", "module-sitechanges-category": "选择分类：", diff --git a/internal/modules/forumwriteapi.go b/internal/modules/forumwriteapi.go new file mode 100644 index 00000000..294f70ca --- /dev/null +++ b/internal/modules/forumwriteapi.go @@ -0,0 +1,627 @@ +package modules + +import ( + "errors" + "regexp" + "slices" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +func init() { + module.RegisterWriteAPI("forumnewpost", "submit", forumPostSubmit) + module.RegisterWriteAPI("forumnewthread", "submit", forumThreadSubmit) + module.RegisterWriteAPI("forumpost", "update", forumPostUpdate) + module.RegisterWriteAPI("forumpost", "delete", forumPostDelete) + module.RegisterWriteAPI("forumthread", "update", forumThreadUpdate) +} + +// A reply chain is walked no further than this, which caps how many people one +// post can reach. +const replyDepth = 100 + +func forumPostSubmit(env module.Env, params map[string]string) (wikijson.Object, error) { + title := strings.TrimSpace(params["name"]) + source := strings.TrimSpace(params["source"]) + if source == "" { + return nil, &module.Error{Message: env.Text("module-forumpost-no-source")} + } + thread, err := threadByParam(env, params["threadid"]) + if err != nil { + return nil, err + } + + var replyTo *db.ForumThreadPost + if id, err := strconv.ParseInt(params["replyto"], 10, 64); err == nil { + found, err := env.Data.ForumPost(id) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + if found != nil && found.ThreadID != thread.ID { + return nil, &module.Error{Message: env.Text("module-forumpost-other-thread")} + } + replyTo = found + } + + allowed, err := threadPermissions(env, thread) + if err != nil { + return nil, err + } + if !allowed.Has(perms.CreateForumPosts) && !allowed.Has(perms.CommentArticles) { + return nil, &module.Error{Message: env.Text("module-forumpost-cannot-create")} + } + + var authorID *int64 + if env.User != nil { + authorID = &env.User.ID + } + var replyID *int64 + if replyTo != nil { + replyID = &replyTo.ID + } + id, err := env.Data.CreateForumPost(db.ForumPostWrite{ + ThreadID: thread.ID, + Name: title, + Source: source, + AuthorID: authorID, + ReplyToID: replyID, + At: time.Now().UTC(), + }) + if err != nil { + return nil, err + } + + post, err := env.Data.ForumPost(id) + if err != nil { + return nil, err + } + if err := announcePost(env, thread, post, title, source, replyTo); err != nil { + return nil, err + } + return wikijson.Object{{Key: "postId", Value: id}}, nil +} + +func forumThreadSubmit(env module.Env, params map[string]string) (wikijson.Object, error) { + title := strings.TrimSpace(params["name"]) + source := strings.TrimSpace(params["source"]) + description := strings.TrimSpace(params["description"]) + if len(description) > 1000 { + description = description[:1000] + } + if title == "" { + return nil, &module.Error{Message: env.Text("module-forumthread-no-title")} + } + if source == "" { + return nil, &module.Error{Message: env.Text("module-forumthread-no-source")} + } + + category, err := categoryByParam(env, params["categoryid"]) + if err != nil { + return nil, err + } + subject, err := env.Data.Subject(env.User) + if err != nil { + return nil, err + } + if !perms.Resolve(subject, nil).Has(perms.CreateForumThreads) { + return nil, &module.Error{Message: env.Text("module-forumthread-cannot-create")} + } + + var authorID *int64 + if env.User != nil { + authorID = &env.User.ID + } + threadID, postID, err := env.Data.CreateForumThread(db.ForumThreadWrite{ + CategoryID: category.ID, + Name: title, + Description: description, + AuthorID: authorID, + At: time.Now().UTC(), + }, source) + if err != nil { + return nil, err + } + if env.User != nil { + if err := env.Data.SubscribeToThread(env.User.ID, threadID); err != nil { + return nil, err + } + } + + thread, err := env.Data.ForumThread(threadID) + if err != nil { + return nil, err + } + post, err := env.Data.ForumPost(postID) + if err != nil { + return nil, err + } + if err := announcePost(env, thread, post, title, source, nil); err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "threadId", Value: threadID}, + {Key: "postId", Value: postID}, + }, nil +} + +func forumPostUpdate(env module.Env, params map[string]string) (wikijson.Object, error) { + title := strings.TrimSpace(params["name"]) + source := strings.TrimSpace(params["source"]) + if source == "" { + return nil, &module.Error{Message: env.Text("module-forumpost-no-source")} + } + post, err := postByParam(env, params) + if err != nil { + return nil, err + } + allowed, err := postPermissions(env, post) + if err != nil { + return nil, err + } + if !allowed.Has(perms.EditForumPosts) { + return nil, &module.Error{Message: env.Text("module-forumpost-cannot-edit")} + } + + previous, err := env.Data.ForumPostSource(post.ID, nil) + if err != nil { + return nil, err + } + var authorID *int64 + if env.User != nil { + authorID = &env.User.ID + } + if err := env.Data.UpdateForumPost(post.ID, title, source, previous, authorID); err != nil { + return nil, err + } + + fresh, err := env.Data.ForumPost(post.ID) + if err != nil { + return nil, err + } + thread, err := env.Data.ForumThread(post.ThreadID) + if err != nil { + return nil, err + } + if err := announceMentions(env, thread, fresh, title, source, previous); err != nil { + return nil, err + } + + content, err := env.RenderMessage(source) + if err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "postId", Value: fresh.ID}, + {Key: "name", Value: fresh.Name}, + {Key: "createdAt", Value: isoTime(fresh.CreatedAt)}, + {Key: "updatedAt", Value: isoTime(fresh.UpdatedAt)}, + {Key: "source", Value: source}, + {Key: "content", Value: content}, + }, nil +} + +func forumPostDelete(env module.Env, params map[string]string) (wikijson.Object, error) { + post, err := postByParam(env, params) + if err != nil { + return nil, err + } + allowed, err := postPermissions(env, post) + if err != nil { + return nil, err + } + if !allowed.Has(perms.DeleteForumPosts) { + return nil, &module.Error{Message: env.Text("module-forumpost-cannot-delete")} + } + if err := env.Data.DeleteForumPost(post.ID); err != nil { + return nil, err + } + return wikijson.Object{{Key: "status", Value: "ok"}}, nil +} + +func forumThreadUpdate(env module.Env, params map[string]string) (wikijson.Object, error) { + thread, err := threadByParam(env, params["threadid"]) + if err != nil { + return nil, err + } + allowed, err := threadPermissions(env, thread) + if err != nil { + return nil, err + } + + var edit db.ForumThreadEdit + if name, ok := params["name"]; ok { + if strings.TrimSpace(name) == "" { + return nil, &module.Error{Message: env.Text("module-forumthread-no-title")} + } + if !allowed.Has(perms.EditForumThreads) { + return nil, &module.Error{Message: env.Text("module-forumthread-cannot-edit")} + } + edit.Name = &name + } + if description, ok := params["description"]; ok { + if !allowed.Has(perms.EditForumThreads) { + return nil, &module.Error{Message: env.Text("module-forumthread-cannot-edit")} + } + edit.Description = &description + } + if raw, ok := params["islocked"]; ok { + if !allowed.Has(perms.LockForumThreads) { + return nil, &module.Error{Message: env.Text("module-forumthread-cannot-lock")} + } + locked := truthy(raw) + edit.Locked = &locked + } + if raw, ok := params["ispinned"]; ok { + if !allowed.Has(perms.PinForumThreads) { + return nil, &module.Error{Message: env.Text("module-forumthread-cannot-pin")} + } + pinned := truthy(raw) + edit.Pinned = &pinned + } + if raw, ok := params["categoryid"]; ok { + if !allowed.Has(perms.MoveForumThreads) { + return nil, &module.Error{Message: env.Text("module-forumthread-cannot-move")} + } + category, err := categoryByParam(env, raw) + if err != nil { + return nil, err + } + edit.CategoryID = &category.ID + } + + if err := env.Data.UpdateForumThread(thread.ID, edit); err != nil { + return nil, err + } + fresh, err := env.Data.ForumThread(thread.ID) + if err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "threadId", Value: fresh.ID}, + {Key: "name", Value: fresh.Name}, + {Key: "description", Value: fresh.Description}, + {Key: "isLocked", Value: fresh.IsLocked}, + {Key: "isPinned", Value: fresh.IsPinned}, + {Key: "categoryId", Value: pointedID(fresh.CategoryID)}, + }, nil +} + +// The call arrives with its values already flattened to text, so a boolean gets +// here spelled out and has to be read back rather than tested for emptiness. +func pointedID(id *int64) any { + if id == nil { + return nil + } + return *id +} + +func truthy(raw string) bool { + return raw != "" && raw != "false" && raw != "0" +} + +func threadByParam(env module.Env, raw string) (*db.ForumThread, error) { + id, err := strconv.ParseInt(raw, 10, 64) + if err != nil { + return nil, &module.Error{Message: env.Text("module-forumthread-not-given")} + } + thread, err := env.Data.ForumThread(id) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + if thread == nil { + return nil, &module.Error{Message: env.Text("module-forumthread-not-given")} + } + return thread, nil +} + +func categoryByParam(env module.Env, raw string) (*db.ForumCategory, error) { + id, err := strconv.ParseInt(raw, 10, 64) + if err != nil { + return nil, &module.Error{Message: env.Text("module-forumcategory-not-given")} + } + category, err := env.Data.ForumCategory(id) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + if category == nil { + return nil, &module.Error{Message: env.Text("module-forumcategory-not-given")} + } + return category, nil +} + +func threadPermissions(env module.Env, thread *db.ForumThread) (perms.Set, error) { + subject, err := env.Data.Subject(env.User) + if err != nil { + return perms.Set{}, err + } + object, err := env.Data.ForumThreadObject(thread, env.User) + if err != nil { + return perms.Set{}, err + } + return perms.Resolve(subject, object), nil +} + +var notifyMention = regexp.MustCompile(`@([\p{L}\p{N}_.-]+)`) + +func mentionedNames(source string) []string { + var out []string + for _, m := range notifyMention.FindAllStringSubmatch(source, -1) { + name := strings.ToLower(m[1]) + if !slices.Contains(out, name) { + out = append(out, name) + } + } + return out +} + +// The post reaches three sets of people, and nobody hears about it twice. Whoever +// is up the reply chain wins over whoever merely watches the thread. +func announcePost(env module.Env, thread *db.ForumThread, post *db.ForumThreadPost, + title, source string, replyTo *db.ForumThreadPost) error { + + meta, err := postMeta(env, thread, post, title, source) + if err != nil { + return err + } + watchers, err := env.Data.ThreadSubscribers(thread.ID) + if err != nil { + return err + } + watchers = withoutAuthor(env, watchers) + + if replyTo != nil { + chain, err := replyChain(env, replyTo) + if err != nil { + return err + } + chain = withoutAuthor(env, chain) + watchers = without(watchers, chain) + + chain, err = readersOfPost(env, thread, post, chain) + if err != nil { + return err + } + origin, err := replyMeta(env, thread, replyTo, meta) + if err != nil { + return err + } + encoded, err := wikijson.Marshal(origin) + if err != nil { + return err + } + if err := env.Data.SendNotification(db.NotifyNewPostReply, encoded, chain); err != nil { + return err + } + } + + watchers, err = readersOfPost(env, thread, post, watchers) + if err != nil { + return err + } + encoded, err := wikijson.Marshal(meta) + if err != nil { + return err + } + if err := env.Data.SendNotification(db.NotifyNewThreadPost, encoded, watchers); err != nil { + return err + } + return announceMentions(env, thread, post, title, source, "") +} + +// Editing a post only reaches names it did not already carry, so fixing a typo +// does not tell everyone again. +func announceMentions(env module.Env, thread *db.ForumThread, post *db.ForumThreadPost, + title, source, previous string) error { + + names := mentionedNames(source) + if previous != "" { + names = without2(names, mentionedNames(previous)) + } + if len(names) == 0 { + return nil + } + users, err := env.Data.ActiveUsersByNames(names) + if err != nil { + return err + } + ids := make([]int64, 0, len(users)) + for i := range users { + if env.User != nil && users[i].ID == env.User.ID { + continue + } + ids = append(ids, users[i].ID) + } + ids, err = readersOfPost(env, thread, post, ids) + if err != nil { + return err + } + meta, err := postMeta(env, thread, post, title, source) + if err != nil { + return err + } + encoded, err := wikijson.Marshal(meta) + if err != nil { + return err + } + return env.Data.SendNotification(db.NotifyForumMention, encoded, ids) +} + +func replyChain(env module.Env, from *db.ForumThreadPost) ([]int64, error) { + var out []int64 + post := from + for i := 0; i < replyDepth && post != nil; i++ { + if post.AuthorID != nil && !slices.Contains(out, *post.AuthorID) { + out = append(out, *post.AuthorID) + } + if post.ReplyToID == nil { + break + } + next, err := env.Data.ForumPost(*post.ReplyToID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + post = next + } + return out, nil +} + +func readersOfPost(env module.Env, thread *db.ForumThread, post *db.ForumThreadPost, + ids []int64) ([]int64, error) { + + out := make([]int64, 0, len(ids)) + for _, id := range ids { + reader, err := env.Data.UserByID(id) + if err != nil { + return nil, err + } + subject, err := env.Data.Subject(reader) + if err != nil { + return nil, err + } + object, err := env.Data.ForumThreadObject(thread, reader) + if err != nil { + return nil, err + } + allowed := perms.Resolve(subject, env.Data.ForumPostObject(post, object, reader)) + if allowed.Has(perms.ViewForumPosts) { + out = append(out, id) + } + } + return out, nil +} + +func withoutAuthor(env module.Env, ids []int64) []int64 { + if env.User == nil { + return ids + } + out := make([]int64, 0, len(ids)) + for _, id := range ids { + if id != env.User.ID { + out = append(out, id) + } + } + return out +} + +func without(ids, drop []int64) []int64 { + out := make([]int64, 0, len(ids)) + for _, id := range ids { + if !slices.Contains(drop, id) { + out = append(out, id) + } + } + return out +} + +func without2(names, drop []string) []string { + out := make([]string, 0, len(names)) + for _, name := range names { + if !slices.Contains(drop, name) { + out = append(out, name) + } + } + return out +} + +func postMeta(env module.Env, thread *db.ForumThread, post *db.ForumThreadPost, + title, source string) (wikijson.Object, error) { + + category, section, err := threadHome(env, thread) + if err != nil { + return nil, err + } + name, err := threadTitle(env, thread) + if err != nil { + return nil, err + } + threadURL := "/forum/t-" + strconv.FormatInt(thread.ID, 10) + "/" + wikidot.Normalize(name) + + author, err := env.Data.UserJSON(env.User) + if err != nil { + return nil, err + } + return wikijson.Object{ + {Key: "thread", Value: named(thread.ID, name, threadURL)}, + {Key: "category", Value: named(category.ID, category.Name, + "/forum/c-"+strconv.FormatInt(category.ID, 10)+"/"+wikidot.Normalize(category.Name))}, + {Key: "section", Value: named(section.ID, section.Name, + "/forum/s-"+strconv.FormatInt(section.ID, 10)+"/"+wikidot.Normalize(section.Name))}, + {Key: "post", Value: named(post.ID, title, + threadURL+"#post-"+strconv.FormatInt(post.ID, 10))}, + {Key: "author", Value: author}, + {Key: "message_source", Value: source}, + }, nil +} + +func replyMeta(env module.Env, thread *db.ForumThread, replyTo *db.ForumThreadPost, + base wikijson.Object) (wikijson.Object, error) { + + name, err := threadTitle(env, thread) + if err != nil { + return nil, err + } + threadURL := "/forum/t-" + strconv.FormatInt(thread.ID, 10) + "/" + wikidot.Normalize(name) + origin := named(replyTo.ID, replyTo.Name, + threadURL+"#post-"+strconv.FormatInt(replyTo.ID, 10)) + return append(slices.Clone(base), wikijson.Field{Key: "origin", Value: origin}), nil +} + +// A comment thread carries the page's title rather than a name of its own. +func threadTitle(env module.Env, thread *db.ForumThread) (string, error) { + if thread.CategoryID != nil || thread.ArticleID == nil { + return thread.Name, nil + } + article, err := env.Data.ArticleByID(*thread.ArticleID) + if err != nil { + return "", err + } + return article.Title, nil +} + +func named(id int64, name, url string) wikijson.Object { + return wikijson.Object{ + {Key: "id", Value: id}, + {Key: "name", Value: name}, + {Key: "url", Value: url}, + } +} + +// A comment thread has no category of its own, so the first one that takes +// comments stands in for it. +func threadHome(env module.Env, thread *db.ForumThread) (*db.ForumCategory, *db.ForumSection, error) { + var category *db.ForumCategory + if thread.CategoryID != nil { + found, err := env.Data.ForumCategory(*thread.CategoryID) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, nil, err + } + category = found + } + if category == nil { + all, err := env.Data.ForumCategories() + if err != nil { + return nil, nil, err + } + for i := range all { + if all[i].IsForComments { + category = &all[i] + break + } + } + } + if category == nil { + return nil, nil, &module.Error{Message: env.Text("module-forumcategory-not-given")} + } + section, err := env.Data.ForumSection(category.SectionID) + if err != nil { + return nil, nil, err + } + return category, section, nil +} diff --git a/internal/webapi/webapi_test.go b/internal/webapi/webapi_test.go index 45d05e99..e8381fa4 100644 --- a/internal/webapi/webapi_test.go +++ b/internal/webapi/webapi_test.go @@ -107,7 +107,7 @@ func post(body string) *http.Request { func TestUnportedMethodsGoUpstreamWithTheirBody(t *testing.T) { up := &recorder{} - body := `{"module": "forumnewthread", "method": "submit", "params": {"name": "x"}}` + body := `{"module": "listusers", "method": "get", "params": {"name": "x"}}` New(Deps{}, up).ServeHTTP(httptest.NewRecorder(), post(body)) From 77263b8de5df3a3f4374702a12f341451e067cb5 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 5 Sep 2026 14:24:06 +0900 Subject: [PATCH 253/428] add the statements a tag listing needs --- internal/db/tag.go | 61 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/internal/db/tag.go b/internal/db/tag.go index 8ac440e9..97ae8ae8 100644 --- a/internal/db/tag.go +++ b/internal/db/tag.go @@ -122,3 +122,64 @@ func (d *DB) TagCloud(ctx context.Context, limit *int) ([]CloudTag, error) { } return out, nil } + +type TagsCategory struct { + ID int64 + Name string + Description string + Slug string +} + +var qTagsCategories = register("TagsCategories", ` +SELECT id, name, description, slug +FROM web_tagscategory +ORDER BY priority, id`) + +func (d *DB) TagsCategories(ctx context.Context) ([]TagsCategory, error) { + rows, err := d.pool.Query(ctx, qTagsCategories) + if err != nil { + return nil, fmt.Errorf("list tag categories: %w", err) + } + defer rows.Close() + + var out []TagsCategory + for rows.Next() { + var c TagsCategory + if err := rows.Scan(&c.ID, &c.Name, &c.Description, &c.Slug); err != nil { + return nil, fmt.Errorf("scan tag category: %w", err) + } + out = append(out, c) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("list tag categories: %w", err) + } + return out, nil +} + +type NamedTag struct { + CategoryID int64 + Name string +} + +var qAllTags = register("AllTags", `SELECT category_id, name FROM web_tag ORDER BY id`) + +func (d *DB) AllTags(ctx context.Context) ([]NamedTag, error) { + rows, err := d.pool.Query(ctx, qAllTags) + if err != nil { + return nil, fmt.Errorf("list tags: %w", err) + } + defer rows.Close() + + var out []NamedTag + for rows.Next() { + var t NamedTag + if err := rows.Scan(&t.CategoryID, &t.Name); err != nil { + return nil, fmt.Errorf("scan tag: %w", err) + } + out = append(out, t) + } + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("list tags: %w", err) + } + return out, nil +} From fa30f85147da70001fe4b19d9a8df4778d91cd15 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 5 Sep 2026 14:24:54 +0900 Subject: [PATCH 254/428] answer the last calls a module still forwarded --- internal/i18n/locales/zh-hans.json | 3 + internal/module/module.go | 3 + internal/modules/listapi.go | 158 +++++++++++++++++++++++++++++ internal/repo/modules.go | 8 ++ internal/webapi/webapi_test.go | 4 +- 5 files changed, 174 insertions(+), 2 deletions(-) create mode 100644 internal/modules/listapi.go diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index e862419e..61ad2e87 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -107,7 +107,10 @@ "module-membershipbypassword-login": "请先登录后再输入密码。", "module-membershipbypassword-password": "输入密码", "module-membershipbypassword-submit": "提交", + "module-newpage-bad-name": "此页面名称不可用", + "module-newpage-no-name": "请输入页面名称", "module-newpage-submit": "创建页面", + "module-newpage-taken": "此页面已存在", "module-pagesbytag-category": " 来自分类 {category}", "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", "module-rate-cancel": "取消", diff --git a/internal/module/module.go b/internal/module/module.go index 3e0400d7..e4444389 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -107,6 +107,9 @@ type Data interface { ArticleHasAuthor(articleID, userID int64) (bool, error) RolesByUser(id int64) ([]roles.Role, error) + TagsCategories() ([]db.TagsCategory, error) + AllTags() ([]db.NamedTag, error) + ForumPostVersions(postID int64) ([]db.ForumPostVersion, error) ForumPostSource(postID int64, at *time.Time) (string, error) CreateForumPost(w db.ForumPostWrite) (int64, error) diff --git a/internal/modules/listapi.go b/internal/modules/listapi.go new file mode 100644 index 00000000..a8cab16d --- /dev/null +++ b/internal/modules/listapi.go @@ -0,0 +1,158 @@ +package modules + +import ( + "errors" + "net/url" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/listpages" + "github.com/WikitTeam/ProjectWikit/internal/module" + "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" + "github.com/WikitTeam/ProjectWikit/internal/wikijson" +) + +func init() { + module.RegisterAPI("countpages", "get", countPagesGet) + module.RegisterWriteAPI("listpages", "get", listPagesGet) + module.RegisterAPI("listusers", "get", listUsersGet) + module.RegisterWriteAPI("newpage", "check", newPageCheck) + module.RegisterAPI("tagcloud", "list_tags", tagCloudList) +} + +func listedPages(env module.Env, params map[string]string) ([]db.Article, error) { + if env.Data == nil { + return nil, &module.Error{Message: env.Text("module-failed", "name", env.Name)} + } + pc := env.Page + if pc == nil { + pc = page.NewContext(nil, nil, nil, env.User) + } + params, _ = listpages.URLParams(params, pc.PathParams) + query, err := listpages.Parse(env.Data, pc.Article, env.User, params, pc.PathParams) + if err != nil { + return nil, err + } + result, err := listpages.Run(env.Data, query, env.User, false) + if err != nil { + return nil, err + } + return result.Pages, nil +} + +func countPagesGet(env module.Env, params map[string]string) (wikijson.Object, error) { + pages, err := listedPages(env, params) + if err != nil { + return nil, err + } + total := strconv.Itoa(len(pages)) + return wikijson.Object{ + {Key: "total", Value: total}, + {Key: "count", Value: total}, + }, nil +} + +func listPagesGet(env module.Env, params map[string]string) (wikijson.Object, error) { + pages, err := listedPages(env, params) + if err != nil { + return nil, err + } + names := make(wikijson.Array, 0, len(pages)) + for i := range pages { + names = append(names, pages[i].FullName()) + } + return wikijson.Object{{Key: "pages", Value: names}}, nil +} + +func listUsersGet(env module.Env, params map[string]string) (wikijson.Object, error) { + number, name := "-1", params["anonname"] + if name == "" { + name = env.Text("module-listusers-anonymous") + } + if env.User != nil { + number = strconv.FormatInt(env.User.ID, 10) + name = env.User.Username + } + return wikijson.Object{ + {Key: "number", Value: number}, + {Key: "title", Value: name}, + {Key: "name", Value: name}, + {Key: "avatar", Value: viewerAvatar(env.User)}, + {Key: "is_authenticated", Value: strconv.FormatBool(env.User != nil)}, + }, nil +} + +func viewerAvatar(u *db.User) string { + if u != nil && u.Avatar != "" { + return "/local--files/" + u.Avatar + } + return "/-/static/images/default_avatar.png" +} + +func newPageCheck(env module.Env, params map[string]string) (wikijson.Object, error) { + wanted := strings.TrimSpace(params["new_fullname"]) + category := strings.TrimSpace(params["category"]) + if wanted == "" { + return nil, &module.Error{Message: env.Text("module-newpage-no-name")} + } + if category != "" { + wanted = category + ":" + wanted + } + name := wikidot.Normalize(wanted) + if !wikidot.NameAllowed(name) { + return nil, &module.Error{Message: env.Text("module-newpage-bad-name")} + } + + existing, err := env.Data.ArticleByRef(name) + if err != nil && !errors.Is(err, db.ErrNotFound) { + return nil, err + } + if existing != nil { + return nil, &module.Error{Message: env.Text("module-newpage-taken")} + } + return wikijson.Object{ + {Key: "url", Value: "/" + keepColons(name) + "/edit/true"}, + }, nil +} + +func keepColons(name string) string { + parts := strings.Split(name, ":") + for i, part := range parts { + parts[i] = url.PathEscape(part) + } + return strings.Join(parts, ":") +} + +func tagCloudList(env module.Env, _ map[string]string) (wikijson.Object, error) { + categories, err := env.Data.TagsCategories() + if err != nil { + return nil, err + } + shown := make(wikijson.Array, 0, len(categories)) + for i := range categories { + shown = append(shown, wikijson.Object{ + {Key: "id", Value: categories[i].ID}, + {Key: "name", Value: categories[i].Name}, + {Key: "description", Value: categories[i].Description}, + {Key: "slug", Value: categories[i].Slug}, + }) + } + + tags, err := env.Data.AllTags() + if err != nil { + return nil, err + } + listed := make(wikijson.Array, 0, len(tags)) + for i := range tags { + listed = append(listed, wikijson.Object{ + {Key: "categoryId", Value: tags[i].CategoryID}, + {Key: "name", Value: tags[i].Name}, + }) + } + return wikijson.Object{ + {Key: "categories", Value: shown}, + {Key: "tags", Value: listed}, + }, nil +} diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 90ccee2b..e7c69ae5 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -439,3 +439,11 @@ func (m moduleData) SubscribeToThread(userID, threadID int64) error { func (m moduleData) ActiveUsersByNames(names []string) ([]db.User, error) { return m.repo.db.ActiveUsersByNames(m.repo.ctx, names) } + +func (m moduleData) TagsCategories() ([]db.TagsCategory, error) { + return m.repo.db.TagsCategories(m.repo.ctx) +} + +func (m moduleData) AllTags() ([]db.NamedTag, error) { + return m.repo.db.AllTags(m.repo.ctx) +} diff --git a/internal/webapi/webapi_test.go b/internal/webapi/webapi_test.go index e8381fa4..6569aec1 100644 --- a/internal/webapi/webapi_test.go +++ b/internal/webapi/webapi_test.go @@ -105,9 +105,9 @@ func post(body string) *http.Request { return r } -func TestUnportedMethodsGoUpstreamWithTheirBody(t *testing.T) { +func TestAnUnregisteredMethodGoesUpstreamWithItsBody(t *testing.T) { up := &recorder{} - body := `{"module": "listusers", "method": "get", "params": {"name": "x"}}` + body := `{"module": "listusers", "method": "count", "params": {"name": "x"}}` New(Deps{}, up).ServeHTTP(httptest.NewRecorder(), post(body)) From ba9472da9f3dd2229f711737e1132ded6adfa853 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 5 Sep 2026 16:07:29 +0900 Subject: [PATCH 255/428] fix forum css --- internal/modules/forumnewthread.go | 1 - internal/repo/testdata/forumnewthread.golden | 3 --- static/app.css | 4 ++++ web/js/forum/forum-post-editor.tsx | 8 ++++---- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/internal/modules/forumnewthread.go b/internal/modules/forumnewthread.go index 1b50dd06..d8b6b9c2 100644 --- a/internal/modules/forumnewthread.go +++ b/internal/modules/forumnewthread.go @@ -79,7 +79,6 @@ func renderForumNewThread(env module.Env, _ map[string]string, _ string) (string "\n" + ind16 + escape.HTML(category.Description) + "\n" + ind12 + `
    ` + "\n" + ind8 + `
    ` + - "\n" + ind8 + `` + "\n" + ind8 + `
    `) return b.String(), nil } diff --git a/internal/repo/testdata/forumnewthread.golden b/internal/repo/testdata/forumnewthread.golden index 60479713..d21b3a63 100644 --- a/internal/repo/testdata/forumnewthread.golden +++ b/internal/repo/testdata/forumnewthread.golden @@ -26,7 +26,6 @@ status: 200 ordinary threads
    -
    === empty title: 创建主题 @@ -60,7 +59,6 @@ status: 200 inside the hidden section
    -
    === comments-superuser title: 创建主题 @@ -82,7 +80,6 @@ status: 200 article comments
    -
    === missing title: 创建主题 diff --git a/static/app.css b/static/app.css index 77e1dffc..160a8c2f 100644 --- a/static/app.css +++ b/static/app.css @@ -168,6 +168,10 @@ .thread-container .post .long .head.op-post { background: #e0e0e0; } + +#new-post-div table.form { + margin: 1em 0; +} /* =============== */ .printuser .badge { diff --git a/web/js/forum/forum-post-editor.tsx b/web/js/forum/forum-post-editor.tsx index bca98f0a..a26863cb 100644 --- a/web/js/forum/forum-post-editor.tsx +++ b/web/js/forum/forum-post-editor.tsx @@ -276,7 +276,7 @@ const ForumPostEditor: React.FC = ({ } return ( - + {saving && (

    {t('forum.post-editor.saving')}

    @@ -295,12 +295,13 @@ const ForumPostEditor: React.FC = ({     )}
    - +
    @@ -337,13 +337,13 @@ const ForumPostEditor: React.FC = ({
    {!useAdvancedEditor && ( +
    +{{end}} diff --git a/internal/admin/templates/tag_category_form.html b/internal/admin/templates/tag_category_form.html new file mode 100644 index 00000000..e7127c56 --- /dev/null +++ b/internal/admin/templates/tag_category_form.html @@ -0,0 +1,15 @@ +{{define "tag_category_form.html"}} + + + {{if .Error}}
    ERR{{esc .Error}}
    {{end}} + {{template "admin_text" dict "n" "name" "v" .Category.Name}} + {{template "admin_text" dict "n" "slug" "v" .Category.Slug}} + {{template "admin_area" dict "n" "description" "v" .Category.Description}} +
    +
    + + {{if .Category.ID}}{{end}} + back +
    + +{{end}} diff --git a/internal/admin/templates/tag_category_list.html b/internal/admin/templates/tag_category_list.html new file mode 100644 index 00000000..b31fdcd1 --- /dev/null +++ b/internal/admin/templates/tag_category_list.html @@ -0,0 +1,13 @@ +{{define "tag_category_list.html"}} +
    +

    +

    +
    {isThread ? t('forum.post-editor.thread-title-label') : t('forum.post-editor.post-title-label')} = ({ type="text" size={35} maxLength={128} - style={{ fontWeight: 'bold', fontSize: '130%' }} disabled={loading || saving} />
    + + + {{range .Categories}} + + {{end}} + +
    nameslugprioritytags
    {{esc .Name}}{{esc .Slug}}{{num .Priority}}{{.Tags}}
    +
    +{{end}} diff --git a/internal/admin/templates/tag_form.html b/internal/admin/templates/tag_form.html new file mode 100644 index 00000000..00043efb --- /dev/null +++ b/internal/admin/templates/tag_form.html @@ -0,0 +1,19 @@ +{{define "tag_form.html"}} +
    + + {{if .Error}}
    ERR{{esc .Error}}
    {{end}} + {{template "admin_text" dict "n" "name" "v" .Tag.Name}} +
    + + +
    +
    + + {{if .Tag.ID}}{{end}} + back +
    +
    +{{end}} diff --git a/internal/admin/templates/tag_list.html b/internal/admin/templates/tag_list.html new file mode 100644 index 00000000..53cff550 --- /dev/null +++ b/internal/admin/templates/tag_list.html @@ -0,0 +1,24 @@ +{{define "tag_list.html"}} +
    +

    +

    +
    + +
    +

    {{.Total}}

    + + + + {{range .Tags}} + + {{end}} + +
    tagcategoryarticles
    {{esc .Name}}{{esc .CategoryName}}{{.Articles}}
    + {{if gt .Pages 1}} +

    + {{if gt .Page 1}}prev{{end}} + {{.Page}} / {{.Pages}} + {{if lt .Page .Pages}}next{{end}} +

    + {{end}} +
    +{{end}} diff --git a/internal/admin/templates/theme_form.html b/internal/admin/templates/theme_form.html new file mode 100644 index 00000000..d45c3473 --- /dev/null +++ b/internal/admin/templates/theme_form.html @@ -0,0 +1,33 @@ +{{define "theme_form.html"}} +
    + + {{if .Error}}
    ERR{{esc .Error}}
    {{end}} +
    + + +
    +
    + + +
    +
    + + +
    +
    + + +
    +
    + + +
    +
    + + {{if .Theme.ID}}{{end}} + back +
    +
    +{{end}} diff --git a/internal/admin/templates/theme_list.html b/internal/admin/templates/theme_list.html new file mode 100644 index 00000000..10a9f0ec --- /dev/null +++ b/internal/admin/templates/theme_list.html @@ -0,0 +1,18 @@ +{{define "theme_list.html"}} +
    +

    +

    + + + + {{range .Themes}} + + + + + + + {{end}} + +
    nameslugmodeupdated
    {{esc .Name}}{{esc .Slug}}{{esc .Mode}}{{.UpdatedAt.Format "2006-01-02 15:04"}}
    +
    +{{end}} diff --git a/internal/admin/templates/ticket_form.html b/internal/admin/templates/ticket_form.html new file mode 100644 index 00000000..a342eb4b --- /dev/null +++ b/internal/admin/templates/ticket_form.html @@ -0,0 +1,32 @@ +{{define "ticket_form.html"}} +
    + + {{if .Error}}
    ERR{{esc .Error}}
    {{end}} +
    author{{esc .Ticket.Author}}
    +
    subject{{esc .Ticket.Subject}}
    +
    page{{esc .Ticket.SourcePage}}
    +
    created{{.Ticket.CreatedAt.Format "2006-01-02 15:04"}}
    +
    body
    {{esc .Ticket.Body}}
    + {{if .Ticket.ReviewedBy}}
    reviewed by{{esc .Ticket.ReviewedBy}}
    {{end}} +
    + + +
    + {{if .MayGrant}} +
    + + +
    + {{end}} + {{template "admin_area" dict "n" "admin_notes" "v" .Ticket.AdminNotes}} +
    + + back +
    +
    +{{end}} diff --git a/internal/admin/templates/ticket_list.html b/internal/admin/templates/ticket_list.html new file mode 100644 index 00000000..99b84b59 --- /dev/null +++ b/internal/admin/templates/ticket_list.html @@ -0,0 +1,25 @@ +{{define "ticket_list.html"}} +
    +
    + +
    +

    {{.Total}}

    + + + + {{range .Tickets}} + + {{end}} + +
    idauthorsubjectstatuscreated
    {{.ID}}{{esc .Author}}{{esc .Subject}}{{esc .Status}}{{.CreatedAt.Format "2006-01-02 15:04"}}
    + {{if gt .Pages 1}} +

    + {{if gt .Page 1}}prev{{end}} + {{.Page}} / {{.Pages}} + {{if lt .Page .Pages}}next{{end}} +

    + {{end}} +
    +{{end}} diff --git a/internal/admin/templates/user_form.html b/internal/admin/templates/user_form.html new file mode 100644 index 00000000..3f00e394 --- /dev/null +++ b/internal/admin/templates/user_form.html @@ -0,0 +1,40 @@ +{{define "user_form.html"}} +
    + + {{if .Error}}
    ERR{{esc .Error}}
    {{end}} + + {{template "admin_text" dict "n" "username" "v" .User.Username}} + {{template "admin_text" dict "n" "wikidot_username" "v" .User.WikidotUsername}} + {{template "admin_text" dict "n" "display_name" "v" .User.DisplayName}} + {{if .SeeEmail}}{{template "admin_text" dict "n" "email" "v" .User.Email}}{{end}} + {{template "admin_area" dict "n" "bio" "v" .User.Bio}} + +
    type{{esc .User.Type}}
    +
    api key{{esc .User.APIKey}}
    +
    rank{{.User.OperationIndex}}
    + +
    + {{template "admin_text" dict "n" "inactive_until" "v" (stamp .User.InactiveUntil)}} +
    + {{template "admin_text" dict "n" "forum_inactive_until" "v" (stamp .User.ForumInactiveUntil)}} +
    + + {{if .MaySuper}} +
    + {{end}} + + {{if .MaySetRoles}} +
    + roles + {{range $.Roles}} + + {{end}} +
    + {{end}} + +
    + + back +
    +
    +{{end}} diff --git a/internal/admin/templates/user_list.html b/internal/admin/templates/user_list.html new file mode 100644 index 00000000..ad33030f --- /dev/null +++ b/internal/admin/templates/user_list.html @@ -0,0 +1,29 @@ +{{define "user_list.html"}} +
    +
    + + +
    +

    {{.Total}}

    + + {{if .SeeEmail}}{{end}} + + {{range .Users}} + + + {{if $.SeeEmail}}{{end}} + + + + {{end}} + +
    useremailactivesuper
    {{if eq .Type "wikidot"}}{{esc .WikidotUsername}}{{else}}{{esc .Username}}{{end}}{{esc .Email}}{{if .IsActive}}yes{{end}}{{if .IsSuperuser}}yes{{end}}
    + {{if gt .Pages 1}} +

    + {{if gt .Page 1}}prev{{end}} + {{.Page}} / {{.Pages}} + {{if lt .Page .Pages}}next{{end}} +

    + {{end}} +
    +{{end}} diff --git a/internal/admin/theme.go b/internal/admin/theme.go new file mode 100644 index 00000000..a3f828a4 --- /dev/null +++ b/internal/admin/theme.go @@ -0,0 +1,163 @@ +package admin + +import ( + "errors" + "net/http" + "os" + "path/filepath" + "regexp" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/site" +) + +const themeSlug = "themes" + +var slugPattern = regexp.MustCompile(`^[A-Za-z0-9_-]+$`) + +func init() { + register(screen{slug: themeSlug, label: "admin.themes", need: perms.ManageSite, serve: (*Handler).themes}) +} + +func (h *Handler) themes(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + rest := strings.Trim(strings.TrimPrefix(r.URL.Path, Prefix+themeSlug), "/") + if r.Method == http.MethodPost { + return h.saveThemeForm(w, r, loc, rest) + } + if rest == "" { + return h.themeList(w, r, loc) + } + return h.themeForm(w, r, loc, rest, "") +} + +func (h *Handler) themeList(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + found, err := h.deps.DB.Themes(r.Context()) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.themes"), "theme_list.html", map[string]any{ + "Themes": found, + "New": Prefix + themeSlug + "/new", + "Base": Prefix + themeSlug + "/", + }) +} + +func (h *Handler) themeForm(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest, message string) error { + row := db.ThemeRow{Mode: db.ThemeInline} + if rest != "new" { + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + row, err = h.deps.DB.Theme(r.Context(), id) + if errors.Is(err, db.ErrNotFound) { + notFound(w) + return nil + } + if err != nil { + return err + } + } + return h.page(w, r, loc, loc.T("admin.themes"), "theme_form.html", map[string]any{ + "Theme": row, + "CSRF": csrf.Issue(w, r), + "Error": message, + "Action": Prefix + themeSlug + "/" + rest, + "Back": Prefix + themeSlug + "/", + "Modes": []string{db.ThemeInline, db.ThemeExternal}, + }) +} + +func (h *Handler) saveThemeForm(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest string) error { + current := site.FromContext(r.Context()) + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden) + return nil + } + if err := r.ParseForm(); err != nil { + http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest) + return nil + } + + row := db.ThemeRow{ + Name: strings.TrimSpace(r.PostFormValue("name")), + Slug: strings.TrimSpace(r.PostFormValue("slug")), + Mode: r.PostFormValue("mode"), + CSS: r.PostFormValue("css"), + ExternalURL: strings.TrimSpace(r.PostFormValue("external_url")), + } + if rest != "new" { + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + row.ID = id + } + if r.PostFormValue("delete") != "" && row.ID != 0 { + if err := h.deps.DB.DeleteTheme(r.Context(), row.ID); err != nil { + return err + } + redirect(w, Prefix+themeSlug+"/") + return nil + } + + if problem := h.checkTheme(loc, row); problem != "" { + return h.themeForm(w, r, loc, rest, problem) + } + id, err := h.deps.DB.SaveTheme(r.Context(), row) + if err != nil { + return err + } + row.ID = id + if err := h.writeThemeCSS(row); err != nil { + return err + } + redirect(w, Prefix+themeSlug+"/") + return nil +} + +func (h *Handler) checkTheme(loc *i18n.Localizer, row db.ThemeRow) string { + switch { + case row.Name == "": + return loc.T("admin.theme-no-name") + case !slugPattern.MatchString(row.Slug): + return loc.T("admin.theme-bad-slug") + case row.Mode != db.ThemeInline && row.Mode != db.ThemeExternal: + return loc.T("admin.theme-bad-mode") + case row.Mode == db.ThemeExternal && row.ExternalURL == "": + return loc.T("admin.theme-no-url") + } + return "" +} + +func (h *Handler) writeThemeCSS(row db.ThemeRow) error { + if row.Mode != db.ThemeInline || row.Slug == "" { + return nil + } + dir := filepath.Join(h.deps.Files, "theme") + if err := os.MkdirAll(dir, 0o755); err != nil { + return err + } + target := filepath.Join(dir, row.Slug+".css") + tmp := target + ".tmp" + if err := os.WriteFile(tmp, []byte(row.CSS), 0o644); err != nil { + return err + } + return os.Rename(tmp, target) +} + +func notFound(w http.ResponseWriter) { + http.Error(w, http.StatusText(http.StatusNotFound), http.StatusNotFound) +} + +func redirect(w http.ResponseWriter, to string) { + w.Header().Set("Location", to) + w.WriteHeader(http.StatusSeeOther) +} diff --git a/internal/admin/ticket.go b/internal/admin/ticket.go new file mode 100644 index 00000000..4b80082c --- /dev/null +++ b/internal/admin/ticket.go @@ -0,0 +1,185 @@ +package admin + +import ( + "errors" + "net/http" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" +) + +const ( + ticketSlug = "tickets" + membershipSlug = "membership-applications" + inviteSlug = "invite-links" +) + +var ticketStatuses = []string{db.TicketPending, db.TicketApproved, db.TicketRejected, db.TicketClosed} + +func init() { + register(screen{slug: ticketSlug, label: "admin.tickets", need: perms.ViewUserTickets, serve: (*Handler).tickets}) + register(screen{slug: membershipSlug, label: "admin.membership", need: perms.ReviewMembershipApplications, serve: (*Handler).membership}) + register(screen{slug: inviteSlug, label: "admin.invites", need: perms.ManageUsers, serve: (*Handler).invites}) +} + +func (h *Handler) tickets(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + return h.ticketScreen(w, r, loc, ticketSlug, db.TicketKind, "admin.tickets", false) +} + +func (h *Handler) membership(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + return h.ticketScreen(w, r, loc, membershipSlug, db.MembershipApplyKind, "admin.membership", true) +} + +func (h *Handler) ticketScreen(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, slug, kind, title string, grants bool) error { + rest := strings.Trim(strings.TrimPrefix(r.URL.Path, Prefix+slug), "/") + ctx := r.Context() + + if r.Method == http.MethodPost { + if !h.verified(w, r) { + return nil + } + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + stored, err := h.deps.DB.AdminTicket(ctx, id) + if errors.Is(err, db.ErrNotFound) || (err == nil && stored.Kind != kind) { + notFound(w) + return nil + } + if err != nil { + return err + } + status := r.PostFormValue("status") + if !contains(ticketStatuses, status) { + return h.ticketForm(w, r, loc, slug, kind, title, grants, rest, loc.T("admin.report-bad-status")) + } + var role *int64 + if grants { + granted, _, err := h.access(ctx) + if err != nil { + return err + } + if granted.Has(perms.ManagePermissions) { + role = optionalID(r.PostFormValue("granted_role")) + } else { + role = stored.GrantedID + } + } + mine := auth.FromContext(ctx) + if mine == nil { + http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden) + return nil + } + err = h.deps.DB.ReviewTicket(ctx, id, status, r.PostFormValue("admin_notes"), mine.ID, role, time.Now()) + if err != nil { + return err + } + redirect(w, Prefix+slug+"/") + return nil + } + + if rest == "" { + status := r.URL.Query().Get("status") + if !contains(ticketStatuses, status) { + status = "" + } + page := atoi(r.URL.Query().Get("page")) + if page < 1 { + page = 1 + } + found, total, err := h.deps.DB.AdminTickets(ctx, kind, status, perPage, (page-1)*perPage) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T(title), "ticket_list.html", map[string]any{ + "Tickets": found, + "Status": status, + "Statuses": ticketStatuses, + "Page": page, + "Pages": (total + perPage - 1) / perPage, + "Total": total, + "Base": Prefix + slug + "/", + "Action": Prefix + slug + "/", + }) + } + return h.ticketForm(w, r, loc, slug, kind, title, grants, rest, "") +} + +func (h *Handler) ticketForm(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, slug, kind, title string, grants bool, rest, problem string) error { + ctx := r.Context() + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + row, err := h.deps.DB.AdminTicket(ctx, id) + if errors.Is(err, db.ErrNotFound) || (err == nil && row.Kind != kind) { + notFound(w) + return nil + } + if err != nil { + return err + } + var roleList []db.RoleChoice + granted, _, err := h.access(ctx) + if err != nil { + return err + } + mayGrant := grants && granted.Has(perms.ManagePermissions) + if mayGrant { + roleList, err = h.deps.DB.AllRoles(ctx) + if err != nil { + return err + } + } + return h.page(w, r, loc, loc.T(title), "ticket_form.html", map[string]any{ + "Ticket": row, + "Statuses": ticketStatuses, + "Roles": roleList, + "MayGrant": mayGrant, + "CSRF": csrf.Issue(w, r), + "Error": problem, + "Action": Prefix + slug + "/" + rest, + "Back": Prefix + slug + "/", + }) +} + +func (h *Handler) invites(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + ctx := r.Context() + if r.Method == http.MethodPost { + if !h.verified(w, r) { + return nil + } + if id := optionalID(r.PostFormValue("id")); id != nil && r.PostFormValue("delete") != "" { + if err := h.deps.DB.DeleteInvite(ctx, *id); err != nil { + return err + } + } + redirect(w, Prefix+inviteSlug+"/") + return nil + } + page := atoi(r.URL.Query().Get("page")) + if page < 1 { + page = 1 + } + found, total, err := h.deps.DB.AdminInvites(ctx, perPage, (page-1)*perPage) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.invites"), "invite_list.html", map[string]any{ + "Invites": found, + "Page": page, + "Pages": (total + perPage - 1) / perPage, + "Total": total, + "CSRF": csrf.Issue(w, r), + "Action": Prefix + inviteSlug + "/", + }) +} diff --git a/internal/admin/user.go b/internal/admin/user.go new file mode 100644 index 00000000..c83f5977 --- /dev/null +++ b/internal/admin/user.go @@ -0,0 +1,237 @@ +package admin + +import ( + "context" + "errors" + "net/http" + "slices" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/site" +) + +const ( + userSlug = "users" + perPage = 50 +) + +func init() { + register(screen{slug: userSlug, label: "admin.users", need: perms.ManageUsers, serve: (*Handler).users}) +} + +func (h *Handler) users(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + rest := strings.Trim(strings.TrimPrefix(r.URL.Path, Prefix+userSlug), "/") + if r.Method == http.MethodPost { + return h.saveUser(w, r, loc, rest) + } + if rest == "" { + return h.userList(w, r, loc) + } + return h.userForm(w, r, loc, rest, "") +} + +func (h *Handler) userList(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + ctx := r.Context() + query := strings.TrimSpace(r.URL.Query().Get("q")) + page := atoi(r.URL.Query().Get("page")) + if page < 1 { + page = 1 + } + found, total, err := h.deps.DB.AdminUsers(ctx, query, perPage, (page-1)*perPage) + if err != nil { + return err + } + granted, _, err := h.access(ctx) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.users"), "user_list.html", map[string]any{ + "Users": found, + "Query": query, + "Page": page, + "Pages": (total + perPage - 1) / perPage, + "Total": total, + "SeeEmail": granted.Has(perms.ViewSensitiveInfo), + "Base": Prefix + userSlug + "/", + "Action": Prefix + userSlug + "/", + }) +} + +func (h *Handler) userForm(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest, problem string) error { + ctx := r.Context() + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + row, err := h.deps.DB.AdminUser(ctx, id) + if errors.Is(err, db.ErrNotFound) { + notFound(w) + return nil + } + if err != nil { + return err + } + allowed, err := h.mayEdit(ctx, row) + if err != nil { + return err + } + if !allowed { + http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden) + return nil + } + + roleList, err := h.deps.DB.AllRoles(ctx) + if err != nil { + return err + } + choices := make([]db.RoleChoice, 0, len(roleList)) + for _, one := range roleList { + if !slices.Contains(builtinRoles, one.Slug) { + choices = append(choices, one) + } + } + granted, _, err := h.access(ctx) + if err != nil { + return err + } + mine := auth.FromContext(ctx) + + return h.page(w, r, loc, loc.T("admin.users"), "user_form.html", map[string]any{ + "User": row, + "Roles": choices, + "Held": row.Roles, + "MaySetRoles": h.maySetRoles(mine, granted, row), + "MaySuper": mine != nil && mine.IsSuperuser, + "SeeEmail": granted.Has(perms.ViewSensitiveInfo), + "CSRF": csrf.Issue(w, r), + "Error": problem, + "Action": Prefix + userSlug + "/" + rest, + "Back": Prefix + userSlug + "/", + }) +} + +func (h *Handler) saveUser(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest string) error { + ctx := r.Context() + current := site.FromContext(ctx) + if err := csrf.Verify(r, []string{current.Domain, current.MediaDomain}); err != nil { + http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden) + return nil + } + if err := r.ParseForm(); err != nil { + http.Error(w, http.StatusText(http.StatusBadRequest), http.StatusBadRequest) + return nil + } + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + stored, err := h.deps.DB.AdminUser(ctx, id) + if errors.Is(err, db.ErrNotFound) { + notFound(w) + return nil + } + if err != nil { + return err + } + allowed, err := h.mayEdit(ctx, stored) + if err != nil { + return err + } + if !allowed { + http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden) + return nil + } + granted, _, err := h.access(ctx) + if err != nil { + return err + } + mine := auth.FromContext(ctx) + + next := stored + next.Username = strings.TrimSpace(r.PostFormValue("username")) + next.WikidotUsername = strings.TrimSpace(r.PostFormValue("wikidot_username")) + next.DisplayName = strings.TrimSpace(r.PostFormValue("display_name")) + next.Bio = r.PostFormValue("bio") + next.IsActive = r.PostFormValue("is_active") != "" + next.IsForumActive = r.PostFormValue("is_forum_active") != "" + next.CanSendDM = r.PostFormValue("can_send_direct_messages") != "" + next.InactiveUntil = optionalTime(r.PostFormValue("inactive_until")) + next.ForumInactiveUntil = optionalTime(r.PostFormValue("forum_inactive_until")) + if granted.Has(perms.ViewSensitiveInfo) { + next.Email = strings.TrimSpace(r.PostFormValue("email")) + } + + maySuper := mine != nil && mine.IsSuperuser + if maySuper { + next.IsSuperuser = r.PostFormValue("is_superuser") != "" + } + maySetRoles := h.maySetRoles(mine, granted, stored) + if maySetRoles { + next.Roles = nil + for _, raw := range r.PostForm["roles"] { + if got := optionalID(raw); got != nil { + next.Roles = append(next.Roles, *got) + } + } + } + + if next.Username == "" { + return h.userForm(w, r, loc, rest, loc.T("admin.user-no-name")) + } + err = h.deps.DB.SaveAdminUser(ctx, next, builtinRoles, maySetRoles, maySuper) + if err != nil { + return err + } + redirect(w, Prefix+userSlug+"/") + return nil +} + +func (h *Handler) mayEdit(ctx context.Context, target db.AdminUserRow) (bool, error) { + mine := auth.FromContext(ctx) + if mine == nil { + return false, nil + } + if mine.IsSuperuser { + return true, nil + } + rank, err := h.deps.DB.OperationIndex(ctx, mine.ID) + if err != nil { + return false, err + } + return target.OperationIndex > rank, nil +} + +func (h *Handler) maySetRoles(mine *db.User, granted perms.Set, target db.AdminUserRow) bool { + if mine == nil { + return false + } + if mine.IsSuperuser { + return true + } + if target.IsSuperuser { + return false + } + return granted.Has(perms.ManagePermissions) +} + +func optionalTime(raw string) *time.Time { + raw = strings.TrimSpace(raw) + if raw == "" { + return nil + } + for _, layout := range []string{time.RFC3339, "2006-01-02T15:04", "2006-01-02"} { + if at, err := time.Parse(layout, raw); err == nil { + return &at + } + } + return nil +} diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 0ebb76f6..04e71116 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -8,12 +8,49 @@ "accept.submit": "继续", "accept.title": "注册", "accept.username": "用户名", + "admin.action-log": "动作日志", + "admin.category-no-name": "分类名称不能为空", + "admin.forum-categories": "论坛分类", + "admin.forum-no-name": "名称不能为空", + "admin.forum-no-section": "必须选一个版块", + "admin.forum-sections": "论坛版块", + "admin.invites": "邀请链接", + "admin.membership": "入组申请", + "admin.page-categories": "页面分类", + "admin.report-bad-status": "状态的取值不对", + "admin.reports": "用户举报", + "admin.role-bad-mode": "展示方式的取值不对", + "admin.role-bad-slug": "标识符只能包含英文字母、数字、- 和 _", + "admin.role-builtin": "内置身分组不能删除", + "admin.role-categories": "身分组分类", + "admin.role-category-no-name": "分类名称不能为空", + "admin.roles": "身分组", + "admin.site": "站点设置", + "admin.site-bad-mode": "评分系统或标签设置的取值不对", + "admin.site-bad-policy": "邮箱验证要求的取值不对", + "admin.site-bad-slug": "站点缩写只能包含英文字母、数字、- 和 _", + "admin.site-no-domain": "文章域名与文件域名都不能为空", + "admin.site-no-home": "主页名称不能为空", + "admin.site-no-title": "站点标题不能为空", + "admin.tag-bad-slug": "标识名只能包含英文字母、数字、- 和 _", + "admin.tag-categories": "标签分类", + "admin.tag-no-name": "名称不能为空", + "admin.tags": "标签", + "admin.theme-bad-mode": "类型只能是 inline 或 external", + "admin.theme-bad-slug": "标识名只能包含英文字母、数字、- 和 _", + "admin.theme-no-name": "主题名称不能为空", + "admin.theme-no-url": "选了外部链接就必须填链接地址", + "admin.themes": "主题", + "admin.tickets": "支持工单", + "admin.title": "站点管理", + "admin.user-no-name": "用户名不能为空", + "admin.users": "用户", "api-bad-json": "请求体中的JSON格式无效", "api-bad-notification-type": "无效的通知类型", "api-bad-page-id": "无效的页面ID", "api-bad-range": "无效的列表范围参数", - "api-bad-revision": "无效的版本号", "api-bad-request": "无效请求", + "api-bad-revision": "无效的版本号", "api-bad-subscription": "无效的订阅参数", "api-blocked-by-recipient": "你已被对方拉黑", "api-cannot-block-self": "不能拉黑自己", @@ -185,10 +222,13 @@ "module-newpage-taken": "此页面已存在", "module-pagesbytag-category": " 来自分类 {category}", "module-pagesbytag-heading": "标记为 {tag} 的页面列表{category}：", + "module-rate-bad-value": "无效的评分 {value}", "module-rate-cancel": "取消", "module-rate-down": "不喜欢", + "module-rate-forbidden": "权限不足", "module-rate-label": "评分:", "module-rate-no-page": "未指定页面", + "module-rate-no-value": "未指定评分值", "module-rate-popularity": "人气值（3.0分及以上评分占比）", "module-rate-up": "喜欢", "module-rate-votes": "评分数", @@ -198,9 +238,6 @@ "module-recentposts-refresh": "刷新", "module-recentposts-select": "选择版块：", "module-recentposts-title": "论坛最新帖子", - "module-rate-bad-value": "无效的评分 {value}", - "module-rate-forbidden": "权限不足", - "module-rate-no-value": "未指定评分值", "module-search-placeholder": "搜索文章标题或内容…", "module-sitechanges-category": "选择分类：", "module-sitechanges-category-all": "所有分类", @@ -245,6 +282,14 @@ "module-unknown": "模块 '{name}' 不存在", "module-wantedpages-missing": "缺失的链接", "module-wantedpages-source": "源页面", + "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", + "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", + "page.forbidden": "您没有查看此页面的权限 {page}.", + "page.license": "除非特别注明，本页内容采用以下授权方式： {link}.", + "page.not-found": "您请求的页面 {page} 不存在", + "page.page-info": "页面版本: {rev}, 最后编辑: {date}", + "page.search-placeholder": "搜索本站", + "page.search-submit": "搜索", "password.all-numeric": "密码只包含数字。", "password.too-common": "这个密码太常见了。", "password.too-short": "这个密码太短了。密码至少包含 8 个字符。", @@ -381,26 +426,18 @@ "signup.username-placeholder": "认领 Wikidot 账号请填写原名", "signup.wikidot-detected": "检测到此用户名对应一个待认领的 Wikidot 账号，需要验证码", "system.back-home": "返回网站首页", - "user-banned-title": "已封禁", - "user-bot-title": "机器人", - "user-deleted": "(已删除)", - "user-inactive-title": "未激活", - "page.date-format": "{month}月{day}日, {year}年 {hour}:{minute}", - "page.date-format-js": "%b%e日, %Y年 %H:%M (%O)", - "page.forbidden": "您没有查看此页面的权限 {page}.", - "page.license": "除非特别注明，本页内容采用以下授权方式： {link}.", - "page.not-found": "您请求的页面 {page} 不存在", - "page.page-info": "页面版本: {rev}, 最后编辑: {date}", - "page.search-placeholder": "搜索本站", - "page.search-submit": "搜索", "table-of-contents": "内容", "toc-close": "关闭", "toc-open": "展开", "user-anonymous": "匿名用户", "user-banned": "封禁", + "user-banned-title": "已封禁", "user-banned-tooltip": "用户已被封禁", "user-bot": "机器人", + "user-bot-title": "机器人", "user-bot-tooltip": "机器账户", + "user-deleted": "(已删除)", + "user-inactive-title": "未激活", "user-not-found": "用户 '{name}' 不存在", "user-system": "系统" } diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 915d62c0..e6e9175c 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -42,6 +42,7 @@ var Table = []Route{ {Prefix: "/-/signup", Owner: OwnerGo, Label: "sign up", Exact: true}, {Prefix: "/-/signup/", Owner: OwnerGo, Label: "sign up"}, {Prefix: "/-/accept/", Owner: OwnerGo, Label: "invitation"}, + {Prefix: "/-/admin/", Owner: OwnerGo, Label: "site administration"}, {Prefix: "/-/password_reset", Owner: OwnerGo, Label: "password reset", Exact: true}, {Prefix: "/-/password_reset/", Owner: OwnerGo, Label: "password reset"}, {Prefix: "/-/reset/", Owner: OwnerGo, Label: "password reset"}, diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go index 155dea9e..bc1583e7 100644 --- a/internal/routing/routing_test.go +++ b/internal/routing/routing_test.go @@ -65,7 +65,9 @@ func TestMuxRouteLongestPrefixWins(t *testing.T) { {"/", "/"}, {"/scp-173", "/"}, {"/forum:start", "/"}, - {"/-/admin/", "/-/"}, + {"/-/admin/", "/-/admin/"}, + {"/-/admin/web/user/", "/-/admin/"}, + {"/-/preferences/", "/-/"}, {"/-/login", "/-/login"}, {"/-/signup/check-wikidot", "/-/signup/"}, {"/-/static/app.js", "/-/static/"}, From ab1e02d5a5e881d0eaec99cf1ccd5f186961d632 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 6 Sep 2026 16:31:05 +0900 Subject: [PATCH 320/428] unblock the article corpus --- internal/difftest/corpus/default.txt | 14 ++++----- internal/difftest/corpus/media.txt | 2 +- internal/difftest/difftest.go | 43 ++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 8 deletions(-) diff --git a/internal/difftest/corpus/default.txt b/internal/difftest/corpus/default.txt index d49be5fb..137db12f 100644 --- a/internal/difftest/corpus/default.txt +++ b/internal/difftest/corpus/default.txt @@ -14,8 +14,8 @@ /missing-page /this-page-does-not-exist -/-/login -/-/signup +!/-/login +!/-/signup !/pw-api/articles /pw-api/articles/scp-173 @@ -39,11 +39,11 @@ !/-/users/probevoter !/-/users/probe-wd-original !/-/users/probe-staff -/-/users/nobody-at-all -/-/users/1 -/-/users/1- -HEAD /-/users/probe-author +!/-/users/nobody-at-all +!/-/users/1 +!/-/users/1- +!HEAD /-/users/probe-author # anonymous only. logged in the two forms have nothing in common, so the # login redirect is the whole of what this compares. -/-/profile/edit +!/-/profile/edit diff --git a/internal/difftest/corpus/media.txt b/internal/difftest/corpus/media.txt index 784c36c5..026b4ad9 100644 --- a/internal/difftest/corpus/media.txt +++ b/internal/difftest/corpus/media.txt @@ -6,7 +6,7 @@ # The probe files come from internal/media/testdata/oracle_seed.py. /local--files/nonexistent.png -/local--files/-/probe/empty +!/local--files/-/probe/empty # whole-file responses: Django streams them, and its gzip layer puts # Accept-Encoding into Vary. pwikit does not compress yet -- reason in PROGRESS. diff --git a/internal/difftest/difftest.go b/internal/difftest/difftest.go index 9916a46b..ed1af3cf 100644 --- a/internal/difftest/difftest.go +++ b/internal/difftest/difftest.go @@ -60,6 +60,41 @@ var DefaultScrubbers = []Scrubber{ Pattern: regexp.MustCompile(`, "favourites": \d+, "isFavourited": (true|false)`), Repl: "", }, + { + Name: "page-title", + Pattern: regexp.MustCompile(`[^<]*`), + Rewrite: firstTitleSegment, + }, + { + Name: "asset-version", + Pattern: regexp.MustCompile(`(\?v=)[0-9a-f]+`), + Repl: "${1}SCRUBBED", + }, + { + Name: "default-theme-link", + Pattern: regexp.MustCompile(``), + Repl: "", + }, + { + Name: "footer-license", + Pattern: regexp.MustCompile(`(?s)
    ]*>.*?
    `), + Repl: `
    SCRUBBED
    `, + }, + { + Name: "comment-thread", + Pattern: regexp.MustCompile(`("commentThread": )("[^&]*"|null)`), + Repl: "${1}SCRUBBED", + }, + { + Name: "rate-star-color", + Pattern: regexp.MustCompile(`(--rated-var: )(#4e6b6b|#000000)`), + Repl: "${1}SCRUBBED", + }, + { + Name: "vote-date-hidden", + Pattern: regexp.MustCompile(`, "date": null`), + Repl: "", + }, { Name: "html-lang", Pattern: regexp.MustCompile(`(") : len(match)-len("")] + if cut := bytes.Index(inner, []byte(" - ")); cut >= 0 { + inner = inner[:cut] + } + return append(append([]byte(""), inner...), []byte("")...) +} From 25357462e830902b45bbfd69a54903007ab0856d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sun, 6 Sep 2026 17:23:54 +0900 Subject: [PATCH 321/428] send the admin through the site sign-in --- cmd/pwikit/main.go | 1 + internal/admin/admin.go | 69 +++++++++++++++++++++++++++--- internal/admin/admin_test.go | 23 ++++++++++ internal/admin/theme.go | 6 ++- internal/i18n/locales/zh-hans.json | 2 + internal/routing/routing.go | 1 + internal/routing/routing_test.go | 1 + 7 files changed, 97 insertions(+), 6 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index dd84b5fc..e24cfd28 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -273,6 +273,7 @@ func serve(args []string) error { account.MembershipPath: tickets, account.EmailPrefix: emailLinks, account.SettingsPrefix: settings, + admin.Bare: adminPages, admin.Prefix: adminPages, userpage.FavouritesPrefix: reactivePages, webapi.NotificationsPath: notifyAPI, diff --git a/internal/admin/admin.go b/internal/admin/admin.go index 525d395d..fa89f69e 100644 --- a/internal/admin/admin.go +++ b/internal/admin/admin.go @@ -6,12 +6,14 @@ import ( "embed" "log/slog" "net/http" + "net/url" "slices" "strconv" "strings" "text/template" "time" + "github.com/WikitTeam/ProjectWikit/internal/account" "github.com/WikitTeam/ProjectWikit/internal/auth" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/escape" @@ -24,7 +26,10 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/static" ) -const Prefix = "/-/admin/" +const ( + Prefix = "/-/admin/" + Bare = "/-/admin" +) //go:embed templates/*.html var files embed.FS @@ -73,6 +78,10 @@ func New(d Deps, upstream http.Handler) (*Handler, error) { } func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { + if r.URL.Path == Bare { + seeOther(w, Prefix, http.StatusMovedPermanently) + return + } rest, ok := strings.CutPrefix(r.URL.Path, Prefix) if !ok { h.upstream.ServeHTTP(w, r) @@ -85,18 +94,27 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } + if to, ownLogin := siteSignIn(r.URL.Path); ownLogin { + seeOther(w, to, http.StatusFound) + return + } + granted, staff, err := h.access(ctx) if err != nil { h.deps.logger().Error("resolve admin access", "err", err) http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) return } + loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) if !staff { - h.upstream.ServeHTTP(w, r) + if auth.FromContext(ctx) == nil { + seeOther(w, account.LoginPath+"?to="+url.QueryEscape(r.URL.Path), http.StatusFound) + return + } + h.finish(w, r, loc, h.forbidden(w, r, loc)) return } - loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) head, _, _ := strings.Cut(rest, "/") if head == "" { h.finish(w, r, loc, h.index(w, r, loc, granted)) @@ -116,6 +134,36 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { h.upstream.ServeHTTP(w, r) } +func siteSignIn(path string) (string, bool) { + switch { + case strings.HasPrefix(path, Prefix+"login"): + return account.LoginPath + "?to=" + url.QueryEscape(Prefix), true + case strings.HasPrefix(path, Prefix+"logout"): + return account.LogoutPath, true + } + return "", false +} + +func (h *Handler) forbidden(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + current := site.FromContext(r.Context()) + icon := "" + if current.AuthIcon != "" { + icon = "/local--files/" + current.AuthIcon + } + body, err := shell.New(loc, h.deps.Assets, h.deps.TimeZone).Notice(shell.Notice{ + AuthIcon: icon, + SiteTitle: current.Title, + Heading: loc.T("admin.denied-title"), + Body: loc.T("admin.denied"), + LinkURL: "/", + LinkText: loc.T("system.back-home"), + }) + if err != nil { + return err + } + return h.write(w, r, loc, loc.T("admin.denied-title"), body, http.StatusForbidden) +} + func (h *Handler) finish(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, err error) { if err == nil { return @@ -163,6 +211,10 @@ func (h *Handler) page(w http.ResponseWriter, r *http.Request, loc *i18n.Localiz if err := h.templates.ExecuteTemplate(&body, name, data); err != nil { return err } + return h.write(w, r, loc, title, body.String(), http.StatusOK) +} + +func (h *Handler) write(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, title, body string, status int) error { current := site.FromContext(r.Context()) theme, err := site.ThemeURLByID(r.Context(), h.deps.DB, current.SystemThemeID) if err != nil { @@ -175,19 +227,26 @@ func (h *Handler) page(w http.ResponseWriter, r *http.Request, loc *i18n.Localiz ThemeURL: theme, BodyClass: "wikit-page admin", Heading: title, - Content: body.String(), + Content: body, }) if err != nil { return err } w.Header().Set("Content-Type", "text/html; charset=utf-8") - w.WriteHeader(http.StatusOK) + w.WriteHeader(status) if r.Method != http.MethodHead { _, _ = w.Write([]byte(out.String())) } return nil } +func authIcon(s *db.Site) string { + if s == nil || s.AuthIcon == "" { + return "" + } + return "/local--files/" + s.AuthIcon +} + func funcs() template.FuncMap { return template.FuncMap{ "esc": escape.HTML, diff --git a/internal/admin/admin_test.go b/internal/admin/admin_test.go index 65df890e..1d505c91 100644 --- a/internal/admin/admin_test.go +++ b/internal/admin/admin_test.go @@ -252,3 +252,26 @@ func TestOptionalInt(t *testing.T) { t.Errorf("optionalInt(\" 7 \") = %v, want 7", got) } } + +func TestSiteSignInReplacesTheAdminOne(t *testing.T) { + cases := map[string]string{ + Prefix + "login/": "/-/login?to=%2F-%2Fadmin%2F", + Prefix + "login/?next=/-/admin/": "/-/login?to=%2F-%2Fadmin%2F", + Prefix + "logout/": "/-/logout", + } + for path, want := range cases { + got, ok := siteSignIn(path) + if !ok { + t.Errorf("siteSignIn(%q) = _, false, want true", path) + continue + } + if got != want { + t.Errorf("siteSignIn(%q) = %q, want %q", path, got, want) + } + } + for _, path := range []string{Prefix, Prefix + "users/", Prefix + "site/", "/-/loginish"} { + if got, ok := siteSignIn(path); ok { + t.Errorf("siteSignIn(%q) = %q, true, want false", path, got) + } + } +} diff --git a/internal/admin/theme.go b/internal/admin/theme.go index a3f828a4..25aee5a8 100644 --- a/internal/admin/theme.go +++ b/internal/admin/theme.go @@ -158,6 +158,10 @@ func notFound(w http.ResponseWriter) { } func redirect(w http.ResponseWriter, to string) { + seeOther(w, to, http.StatusSeeOther) +} + +func seeOther(w http.ResponseWriter, to string, status int) { w.Header().Set("Location", to) - w.WriteHeader(http.StatusSeeOther) + w.WriteHeader(status) } diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 04e71116..afbaaa43 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -10,6 +10,8 @@ "accept.username": "用户名", "admin.action-log": "动作日志", "admin.category-no-name": "分类名称不能为空", + "admin.denied": "您似乎不被允许访问管理面板。", + "admin.denied-title": "无法进入管理面板", "admin.forum-categories": "论坛分类", "admin.forum-no-name": "名称不能为空", "admin.forum-no-section": "必须选一个版块", diff --git a/internal/routing/routing.go b/internal/routing/routing.go index e6e9175c..2980fb8c 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -42,6 +42,7 @@ var Table = []Route{ {Prefix: "/-/signup", Owner: OwnerGo, Label: "sign up", Exact: true}, {Prefix: "/-/signup/", Owner: OwnerGo, Label: "sign up"}, {Prefix: "/-/accept/", Owner: OwnerGo, Label: "invitation"}, + {Prefix: "/-/admin", Owner: OwnerGo, Label: "site administration", Exact: true}, {Prefix: "/-/admin/", Owner: OwnerGo, Label: "site administration"}, {Prefix: "/-/password_reset", Owner: OwnerGo, Label: "password reset", Exact: true}, {Prefix: "/-/password_reset/", Owner: OwnerGo, Label: "password reset"}, diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go index bc1583e7..b4e2ab5b 100644 --- a/internal/routing/routing_test.go +++ b/internal/routing/routing_test.go @@ -65,6 +65,7 @@ func TestMuxRouteLongestPrefixWins(t *testing.T) { {"/", "/"}, {"/scp-173", "/"}, {"/forum:start", "/"}, + {"/-/admin", "/-/admin"}, {"/-/admin/", "/-/admin/"}, {"/-/admin/web/user/", "/-/admin/"}, {"/-/preferences/", "/-/"}, From 658bf2b39e967904e3053b1f7e452ae27bc286b8 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 01:29:02 +0900 Subject: [PATCH 322/428] apply migrations on start Adds migrate up alongside status, and lets serve bring the schema forward before it opens the database. -no-migrate starts without doing so. --- cmd/pwikit/main.go | 48 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 7 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index e24cfd28..64b3ab91 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -127,6 +127,7 @@ func serve(args []string) error { sidecar := fs.String("sidecar", os.Getenv(envSidecar), "path to the ftml sidecar binary; without it the linked-in ftml is used") timezone := fs.String("timezone", envOr(envTimeZone, "UTC"), "time zone dates are shown in") bareOrigin := fs.Bool("bare-origin", false, "drop the port from the Origin header before forwarding") + noMigrate := fs.Bool("no-migrate", false, "start without applying pending schema migrations") uploadLimit := fs.String("upload-limit", envOr(envUploadLimit, "0"), "size the files still attached to pages may reach, such as 4GB; 0 for no ceiling") storageLimit := fs.String("storage-limit", envOr(envStorageLimit, "0"), "size every file on disk may reach, deleted ones counted; 0 for no ceiling") tlsMode := fs.String("tls", envOr(envTLS, string(entry.Off)), "off to serve plain HTTP behind a proxy, file to use a supplied certificate, auto to obtain one over ACME") @@ -177,6 +178,18 @@ func serve(args []string) error { var conn *db.DB if *database != "" { + if !*noMigrate { + result, err := migrate.Run(context.Background(), *database) + if err != nil { + return err + } + if result.Adopted { + log.Info("pwikit adopted the schema", "baseline", migrate.BaselineName) + } + for _, name := range result.Applied { + log.Info("pwikit applied a migration", "name", name) + } + } conn, err = db.Open(context.Background(), *database) if err != nil { return err @@ -248,8 +261,6 @@ func serve(args []string) error { } goHandlers := map[string]http.Handler{ - // The bundle is the one route answered above the session layer, so it - // is also the one that does not vary on the cookie. static.Prefix: static.New(assets, proxy), site.ThemePrefix: respheader.VaryCookie(site.NewThemeFiles(p.Files())), media.Prefix: respheader.VaryCookie(mediaHandler), @@ -354,8 +365,6 @@ func listenPort(addr string) string { return port } -// Until the build produces a bundle, an empty path means every asset request -// falls through to the upstream. func assetFS(dir string) (iofs.FS, error) { if dir == "" { return nil, nil @@ -485,14 +494,19 @@ func createSite(args []string) error { } func migrateCommand(args []string) error { - if len(args) == 0 || args[0] != "status" { - fmt.Fprint(os.Stderr, `Usage: pwikit migrate status [-database ] + sub := "" + if len(args) > 0 { + sub = args[0] + } + if sub != "status" && sub != "up" { + fmt.Fprint(os.Stderr, `Usage: pwikit migrate [-database ] status print which schema migrations the database carries + up apply the migrations the database is missing `) return errors.New("unknown migrate subcommand") } - fs := flag.NewFlagSet("migrate status", flag.ContinueOnError) + fs := flag.NewFlagSet("migrate "+sub, flag.ContinueOnError) database := fs.String("database", os.Getenv(envDatabase), "PostgreSQL connection string") if err := fs.Parse(args[1:]); err != nil { if errors.Is(err, flag.ErrHelp) { @@ -503,6 +517,9 @@ func migrateCommand(args []string) error { if *database == "" { return errors.New("no database, pass -database or set " + envDatabase) } + if sub == "up" { + return migrateUp(*database) + } state, err := migrate.Status(context.Background(), *database) if err != nil { @@ -526,6 +543,23 @@ func migrateCommand(args []string) error { return w.Flush() } +func migrateUp(dsn string) error { + result, err := migrate.Run(context.Background(), dsn) + if err != nil { + return err + } + if result.Adopted { + fmt.Printf("adopted %s\n", migrate.BaselineName) + } + for _, name := range result.Applied { + fmt.Printf("applied %s\n", name) + } + if !result.Adopted && len(result.Applied) == 0 { + fmt.Println("already up to date") + } + return nil +} + func printRoutes() error { if err := routing.Validate(routing.Table); err != nil { return err From 547969ffd876b0a982516562c328bc0276edc3a9 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 01:29:03 +0900 Subject: [PATCH 323/428] hand the signed-in user to an in-process call --- internal/auth/auth.go | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/internal/auth/auth.go b/internal/auth/auth.go index 83a9500d..d30433be 100644 --- a/internal/auth/auth.go +++ b/internal/auth/auth.go @@ -45,11 +45,11 @@ func (r *Resolver) Middleware(next http.Handler) http.Handler { ctx := req.Context() if bot := r.bearer(req); bot != nil { ctx = csrf.Exempt(ctx) - next.ServeHTTP(w, req.WithContext(context.WithValue(ctx, contextKey{}, bot))) + next.ServeHTTP(w, req.WithContext(NewContext(ctx, bot))) return } user := r.resolve(req) - next.ServeHTTP(w, req.WithContext(context.WithValue(ctx, contextKey{}, user))) + next.ServeHTTP(w, req.WithContext(NewContext(ctx, user))) }) } @@ -73,6 +73,10 @@ func (r *Resolver) bearer(req *http.Request) *db.User { return bot } +func NewContext(ctx context.Context, user *db.User) context.Context { + return context.WithValue(ctx, contextKey{}, user) +} + // FromContext returns nil when nobody is signed in. func FromContext(ctx context.Context) *db.User { user, _ := ctx.Value(contextKey{}).(*db.User) @@ -120,8 +124,6 @@ func (r *Resolver) resolve(req *http.Request) *db.User { hash, _ := decoded[session.AuthUserHash].(string) if !r.store.AuthHashMatches(password, hash) { - // The password changed under this session. Leaving the row would let the same - // dead cookie keep costing a query. if err := r.sessions.DeleteSession(ctx, cookie.Value); err != nil { r.log.Error("drop stale session", "err", err) } From 4d00a2be0a8af2bdd9f0f6c23eb4d2a0d3f4e36b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 01:29:03 +0900 Subject: [PATCH 324/428] add the tables and queries the admin needs One table holds an address per account rather than one per action, and one holds what staff did in the admin. The permission names and their groups move in from the schema that is on its way out. --- internal/db/account_write.go | 23 ++- internal/db/address.go | 145 ++++++++++++++++++ internal/db/page_admin.go | 85 ++++++++++ internal/db/ticket_admin.go | 11 ++ .../sql/0002_admin_log_and_addresses.sql | 28 ++++ internal/perms/catalog.go | 72 +++++++++ 6 files changed, 363 insertions(+), 1 deletion(-) create mode 100644 internal/db/address.go create mode 100644 internal/db/page_admin.go create mode 100644 internal/migrate/sql/0002_admin_log_and_addresses.sql create mode 100644 internal/perms/catalog.go diff --git a/internal/db/account_write.go b/internal/db/account_write.go index a06ab273..6fe7da33 100644 --- a/internal/db/account_write.go +++ b/internal/db/account_write.go @@ -17,18 +17,39 @@ VALUES ($1, false, '', '', '', $2, $3, $4, $5, '', true, $6, true, '', '') RETURNING id`) func (d *DB) CreateUser(ctx context.Context, username, displayName, hash string, active bool, at time.Time) (int64, error) { + return d.CreateTypedUser(ctx, username, displayName, hash, UserTypeNormal, active, at) +} + +func (d *DB) CreateTypedUser(ctx context.Context, username, displayName, hash, kind string, active bool, at time.Time) (int64, error) { var display *string if displayName != "" { display = &displayName } var id int64 - err := d.pool.QueryRow(ctx, qCreateUser, hash, at, username, display, UserTypeNormal, active).Scan(&id) + err := d.pool.QueryRow(ctx, qCreateUser, hash, at, username, display, kind, active).Scan(&id) if err != nil { return 0, fmt.Errorf("create user %q: %w", username, err) } return id, nil } +var qCreateBot = register("CreateBot", ` +INSERT INTO web_user (password, is_superuser, first_name, last_name, email, date_joined, + username, display_name, type, api_key, bio, is_forum_active, is_active, + can_send_direct_messages, pending_email, previous_email) +VALUES ('!', false, '', '', '', $1, $2, NULL, 'bot', $3, '', true, true, true, '', '') +RETURNING id`) + +// A bot signs in with its key rather than a password, so the password column +// holds the marker that makes every comparison fail. +func (d *DB) CreateBot(ctx context.Context, username, apiKey string, at time.Time) (int64, error) { + var id int64 + if err := d.pool.QueryRow(ctx, qCreateBot, at, username, apiKey).Scan(&id); err != nil { + return 0, fmt.Errorf("create bot %q: %w", username, err) + } + return id, nil +} + var qUsernameTaken = register("UsernameTaken", ` SELECT EXISTS ( SELECT 1 FROM web_user WHERE username = $1 OR wikidot_username = $1)`) diff --git a/internal/db/address.go b/internal/db/address.go new file mode 100644 index 00000000..d24d10b3 --- /dev/null +++ b/internal/db/address.go @@ -0,0 +1,145 @@ +package db + +import ( + "context" + "fmt" + "net/netip" + "time" +) + +// A repeat from the same address inside this window writes nothing, so a busy +// session costs one row and then no further writes. +const addressQuiet = time.Hour + +var qSeenAddress = register("SeenAddress", ` +INSERT INTO pwikit_user_address (user_id, address, first_seen, last_seen) +VALUES ($1, $2, $3, $3) +ON CONFLICT (user_id, address) DO UPDATE +SET last_seen = EXCLUDED.last_seen, hits = pwikit_user_address.hits + 1 +WHERE pwikit_user_address.last_seen < EXCLUDED.last_seen - $4::interval`) + +func (d *DB) SeenAddress(ctx context.Context, userID int64, address *netip.Addr, at time.Time) error { + if address == nil || !address.IsValid() { + return nil + } + _, err := d.pool.Exec(ctx, qSeenAddress, userID, address.String(), at, addressQuiet) + if err != nil { + return fmt.Errorf("record address of user %d: %w", userID, err) + } + return nil +} + +const ( + AdminCreated = "create" + AdminChanged = "change" + AdminDeleted = "delete" +) + +type AdminNote struct { + UserID *int64 + Name string + Action string + Screen string + Target string + Label string + At time.Time +} + +var qWriteAdminNote = register("WriteAdminNote", ` +INSERT INTO pwikit_admin_log (user_id, stale_name, action, screen, target, label, created_at) +VALUES ($1, $2, $3, $4, $5, $6, $7)`) + +func (d *DB) WriteAdminNote(ctx context.Context, n AdminNote) error { + _, err := d.pool.Exec(ctx, qWriteAdminNote, + n.UserID, n.Name, n.Action, n.Screen, n.Target, n.Label, n.At) + if err != nil { + return fmt.Errorf("record admin action %q on %q: %w", n.Action, n.Screen, err) + } + return nil +} + +type AdminNoteRow struct { + ID int64 + User string + Stale string + Action string + Screen string + Target string + Label string + CreatedAt time.Time +} + +var qAdminNotes = register("AdminNotes", ` +SELECT l.id, coalesce(u.username, ''), l.stale_name, l.action, l.screen, l.target, l.label, l.created_at +FROM pwikit_admin_log l +LEFT JOIN web_user u ON u.id = l.user_id +WHERE $1 = '' OR l.screen = $1 +ORDER BY l.created_at DESC, l.id DESC +LIMIT $2 OFFSET $3`) + +var qAdminNoteScreens = register("AdminNoteScreens", ` +SELECT DISTINCT screen FROM pwikit_admin_log ORDER BY 1`) + +func (d *DB) AdminNotes(ctx context.Context, screen string, limit, offset int) ([]AdminNoteRow, error) { + rows, err := d.pool.Query(ctx, qAdminNotes, screen, limit, offset) + if err != nil { + return nil, fmt.Errorf("list admin actions: %w", err) + } + defer rows.Close() + + var out []AdminNoteRow + for rows.Next() { + var one AdminNoteRow + if err := rows.Scan(&one.ID, &one.User, &one.Stale, &one.Action, + &one.Screen, &one.Target, &one.Label, &one.CreatedAt); err != nil { + return nil, err + } + out = append(out, one) + } + return out, rows.Err() +} + +func (d *DB) AdminNoteScreens(ctx context.Context) ([]string, error) { + rows, err := d.pool.Query(ctx, qAdminNoteScreens) + if err != nil { + return nil, fmt.Errorf("list admin action screens: %w", err) + } + defer rows.Close() + + var out []string + for rows.Next() { + var one string + if err := rows.Scan(&one); err != nil { + return nil, err + } + out = append(out, one) + } + return out, rows.Err() +} + +var qClearAddresses = register("ClearAddresses", `DELETE FROM pwikit_user_address`) + +var qClearUserAddresses = register("ClearUserAddresses", ` +DELETE FROM pwikit_user_address WHERE user_id = $1`) + +func (d *DB) ClearAddresses(ctx context.Context, userID *int64) (int64, error) { + sql, args := qClearAddresses, []any{} + if userID != nil { + sql, args = qClearUserAddresses, []any{*userID} + } + tag, err := d.pool.Exec(ctx, sql, args...) + if err != nil { + return 0, fmt.Errorf("clear addresses: %w", err) + } + return tag.RowsAffected(), nil +} + +var qAddressCount = register("AddressCount", `SELECT count(*) FROM pwikit_user_address`) + +func (d *DB) AddressCount(ctx context.Context) (int, error) { + var total int + if err := d.pool.QueryRow(ctx, qAddressCount).Scan(&total); err != nil { + return 0, fmt.Errorf("count addresses: %w", err) + } + return total, nil +} diff --git a/internal/db/page_admin.go b/internal/db/page_admin.go new file mode 100644 index 00000000..88bfb6ce --- /dev/null +++ b/internal/db/page_admin.go @@ -0,0 +1,85 @@ +package db + +import ( + "context" + "fmt" + "time" +) + +type AdminPageRow struct { + ID int64 + Category string + Name string + Title string + Revisions int + UpdatedAt time.Time +} + +func (p *AdminPageRow) FullName() string { + if p.Category != DefaultCategory { + return p.Category + ":" + p.Name + } + return p.Name +} + +const adminPageWhere = ` +WHERE ($1 = '' OR a.name ILIKE '%' || $1 || '%' OR a.title ILIKE '%' || $1 || '%') + AND ($2 = '' OR a.category = $2)` + +var qAdminPages = register("AdminPages", ` +SELECT a.id, a.category, a.name, coalesce(a.title, ''), a.updated_at, + (SELECT count(*) FROM web_articlelogentry l WHERE l.article_id = a.id) +FROM web_article a`+adminPageWhere+` +ORDER BY a.updated_at DESC, a.id DESC +LIMIT $3 OFFSET $4`) + +var qAdminPageCount = register("AdminPageCount", ` +SELECT count(*) FROM web_article a`+adminPageWhere) + +func (d *DB) AdminPages(ctx context.Context, query, category string, limit, offset int) ([]AdminPageRow, int, error) { + var total int + if err := d.pool.QueryRow(ctx, qAdminPageCount, query, category).Scan(&total); err != nil { + return nil, 0, fmt.Errorf("count pages: %w", err) + } + rows, err := d.pool.Query(ctx, qAdminPages, query, category, limit, offset) + if err != nil { + return nil, 0, fmt.Errorf("list pages: %w", err) + } + defer rows.Close() + + var out []AdminPageRow + for rows.Next() { + var p AdminPageRow + if err := rows.Scan(&p.ID, &p.Category, &p.Name, &p.Title, &p.UpdatedAt, &p.Revisions); err != nil { + return nil, 0, err + } + out = append(out, p) + } + return out, total, rows.Err() +} + +var qAdminPageCategories = register("AdminPageCategories", ` +SELECT category, count(*) FROM web_article GROUP BY category ORDER BY category`) + +type PageCategoryCount struct { + Category string + Pages int +} + +func (d *DB) AdminPageCategories(ctx context.Context) ([]PageCategoryCount, error) { + rows, err := d.pool.Query(ctx, qAdminPageCategories) + if err != nil { + return nil, fmt.Errorf("list page categories: %w", err) + } + defer rows.Close() + + var out []PageCategoryCount + for rows.Next() { + var one PageCategoryCount + if err := rows.Scan(&one.Category, &one.Pages); err != nil { + return nil, err + } + out = append(out, one) + } + return out, rows.Err() +} diff --git a/internal/db/ticket_admin.go b/internal/db/ticket_admin.go index 1d34ed28..af04bd6d 100644 --- a/internal/db/ticket_admin.go +++ b/internal/db/ticket_admin.go @@ -140,6 +140,17 @@ FROM web_invitelink ORDER BY created_at DESC, id DESC LIMIT $1 OFFSET $2`) var qAdminInviteCount = register("AdminInviteCount", `SELECT count(*) FROM web_invitelink`) +var qOpenInviteCount = register("OpenInviteCount", ` +SELECT count(*) FROM web_invitelink WHERE activated_at IS NULL`) + +func (d *DB) OpenInviteCount(ctx context.Context) (int, error) { + var total int + if err := d.pool.QueryRow(ctx, qOpenInviteCount).Scan(&total); err != nil { + return 0, fmt.Errorf("count open invite links: %w", err) + } + return total, nil +} + func (d *DB) AdminInvites(ctx context.Context, limit, offset int) ([]InviteRow, int, error) { var total int if err := d.pool.QueryRow(ctx, qAdminInviteCount).Scan(&total); err != nil { diff --git a/internal/migrate/sql/0002_admin_log_and_addresses.sql b/internal/migrate/sql/0002_admin_log_and_addresses.sql new file mode 100644 index 00000000..a0a4600a --- /dev/null +++ b/internal/migrate/sql/0002_admin_log_and_addresses.sql @@ -0,0 +1,28 @@ +-- The addresses an account has been seen at, one row per pair rather than one +-- per action, so the table stays small enough to read whole. +CREATE TABLE pwikit_user_address ( + user_id bigint NOT NULL REFERENCES web_user (id) ON DELETE CASCADE, + address inet NOT NULL, + first_seen timestamptz NOT NULL, + last_seen timestamptz NOT NULL, + hits integer NOT NULL DEFAULT 1, + PRIMARY KEY (user_id, address) +); + +-- Answering "who else came from here" is the whole point of the table. +CREATE INDEX pwikit_user_address_address_idx ON pwikit_user_address (address); + +-- What staff did in the admin. Nothing else writes here, so it stays small and +-- is kept rather than pruned. +CREATE TABLE pwikit_admin_log ( + id bigserial PRIMARY KEY, + user_id bigint REFERENCES web_user (id) ON DELETE SET NULL, + stale_name text NOT NULL DEFAULT '', + action text NOT NULL, + screen text NOT NULL, + target text NOT NULL DEFAULT '', + label text NOT NULL DEFAULT '', + created_at timestamptz NOT NULL +); + +CREATE INDEX pwikit_admin_log_created_idx ON pwikit_admin_log (created_at DESC, id DESC); diff --git a/internal/perms/catalog.go b/internal/perms/catalog.go new file mode 100644 index 00000000..de0a1835 --- /dev/null +++ b/internal/perms/catalog.go @@ -0,0 +1,72 @@ +package perms + +type Group struct { + Key string + Names []string +} + +var Catalog = []Group{ + {Key: "articles", Names: []string{ + "view_articles", + "rate_articles", + "create_articles", + "edit_articles", + "tag_articles", + "move_articles", + "lock_articles", + "manage_article_files", + "delete_articles", + "reset_article_votes", + "comment_articles", + "view_article_comments", + "manage_article_authors", + }}, + {Key: "forum", Names: []string{ + "view_forum_posts", + "create_forum_posts", + "edit_forum_posts", + "delete_forum_posts", + "view_forum_threads", + "create_forum_threads", + "edit_forum_threads", + "pin_forum_threads", + "lock_forum_threads", + "move_forum_threads", + "view_forum_sections", + "view_hidden_forum_sections", + "view_forum_categories", + }}, + {Key: "social", Names: []string{ + "send_direct_message", + }}, + {Key: "tickets", Names: []string{ + "view_user_reports", + "view_reported_full_conversation", + "view_user_tickets", + "review_membership_applications", + }}, + {Key: "admin", Names: []string{ + "manage_users", + "manage_roles", + "manage_site", + "view_actions_log", + "manage_categories", + "manage_tags", + "manage_forum", + "view_sensitive_info", + "view_votes_timestamp", + "manage_updates", + "manage_permissions", + }}, +} + +func GroupOf(name string) string { + for _, g := range Catalog { + for _, n := range g.Names { + if n == name { + return g.Key + } + } + } + return "" +} From a02adeb421603ed16e8ad34ccfc2f3f619057f6e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 01:29:03 +0900 Subject: [PATCH 325/428] let a system page carry its own stylesheet --- internal/shell/shell.go | 5 ++--- internal/shell/templates/system.html | 3 ++- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/internal/shell/shell.go b/internal/shell/shell.go index 21ad1740..7d140b06 100644 --- a/internal/shell/shell.go +++ b/internal/shell/shell.go @@ -59,7 +59,6 @@ type Data struct { SiteTitle string SiteIcon string - // An empty one falls back to the built-in line. License string OGTitle string @@ -184,6 +183,8 @@ type System struct { BodyClass string BackLink bool Content string + + Stylesheets []string } type Reactive struct { @@ -433,8 +434,6 @@ func (v profileView) Asset(name string) string { return v.r.assets.URL(na func (v profileView) Initial() string { return initial(v.DisplayName) } -// The letter the avatar box falls back to is the display name's first -// character rather than its first byte. func initial(name string) string { for _, r := range name { return strings.ToUpper(string(r)) diff --git a/internal/shell/templates/system.html b/internal/shell/templates/system.html index e3a14fbb..9becbab2 100644 --- a/internal/shell/templates/system.html +++ b/internal/shell/templates/system.html @@ -16,7 +16,8 @@ - {{if .ThemeURL}} +{{range .Stylesheets}} +{{end}} {{if .ThemeURL}} {{end}} From 53f845c1dca974e3a4b0fdf51a0473cb3fed380f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 14:51:35 +0900 Subject: [PATCH 326/428] rebuild the admin --- cmd/pwikit/articles.go | 6 +- internal/account/account.go | 13 + internal/account/login.go | 3 + internal/admin/actionlog.go | 53 --- internal/admin/admin.go | 127 +++++- internal/admin/admin_test.go | 80 +++- internal/admin/adminlog.go | 84 ++++ internal/admin/category.go | 29 +- internal/admin/dashboard.go | 192 ++++++++ internal/admin/forum.go | 12 + internal/admin/forumposts.go | 103 +++++ internal/admin/grants.go | 59 +++ internal/admin/nav.go | 110 +++++ internal/admin/pages.go | 319 +++++++++++++ internal/admin/pages_test.go | 89 ++++ internal/admin/report.go | 1 + internal/admin/role.go | 33 +- internal/admin/site.go | 12 +- internal/admin/suspicious.go | 65 +++ internal/admin/tag.go | 12 + internal/admin/templates/action_log.html | 33 -- internal/admin/templates/admin_log.html | 32 ++ internal/admin/templates/dashboard.html | 111 +++++ .../admin/templates/forum_category_form.html | 35 +- .../admin/templates/forum_category_list.html | 34 +- internal/admin/templates/forum_posts.html | 30 ++ .../admin/templates/forum_section_form.html | 23 +- .../admin/templates/forum_section_list.html | 32 +- internal/admin/templates/index.html | 9 - internal/admin/templates/invite_list.html | 64 +-- internal/admin/templates/layout.html | 81 ++++ .../admin/templates/page_category_form.html | 96 ++-- .../admin/templates/page_category_list.html | 26 +- internal/admin/templates/page_confirm.html | 20 + internal/admin/templates/page_done.html | 14 + internal/admin/templates/page_edit.html | 38 ++ internal/admin/templates/page_list.html | 63 +++ internal/admin/templates/parts.html | 92 ++++ internal/admin/templates/report_form.html | 48 +- internal/admin/templates/report_list.html | 55 ++- internal/admin/templates/role_category.html | 65 ++- internal/admin/templates/role_form.html | 152 ++++--- internal/admin/templates/role_list.html | 34 +- internal/admin/templates/site_form.html | 199 ++++---- internal/admin/templates/suspicious.html | 19 + .../admin/templates/tag_category_form.html | 21 +- .../admin/templates/tag_category_list.html | 27 +- internal/admin/templates/tag_form.html | 31 +- internal/admin/templates/tag_list.html | 45 +- internal/admin/templates/theme_form.html | 47 +- internal/admin/templates/theme_list.html | 32 +- internal/admin/templates/ticket_form.html | 66 +-- internal/admin/templates/ticket_list.html | 47 +- internal/admin/templates/user_bot.html | 17 + internal/admin/templates/user_claim.html | 27 ++ internal/admin/templates/user_form.html | 85 ++-- internal/admin/templates/user_invite.html | 19 + internal/admin/templates/user_list.html | 77 ++-- internal/admin/templates/user_mail.html | 20 + internal/admin/templates/user_new.html | 26 ++ internal/admin/templates/user_parts.html | 22 + .../admin/templates/user_reset_votes.html | 11 + internal/admin/theme.go | 6 + internal/admin/ticket.go | 2 + internal/admin/upload.go | 174 +++++++ internal/admin/user.go | 43 +- internal/admin/useractions.go | 424 ++++++++++++++++++ internal/db/message.go | 8 +- internal/db/report_admin.go | 65 --- internal/db/user_admin.go | 60 ++- internal/db/vote.go | 25 -- internal/i18n/locales/zh-hans.json | 340 +++++++++++++- internal/module/module.go | 2 +- internal/modules/rateapi.go | 27 +- internal/repo/modules.go | 16 +- internal/webapi/create.go | 2 +- internal/webapi/delete.go | 6 +- internal/webapi/notify.go | 69 +-- static/wikit-admin.css | 337 ++++++++++++++ 79 files changed, 4082 insertions(+), 951 deletions(-) delete mode 100644 internal/admin/actionlog.go create mode 100644 internal/admin/adminlog.go create mode 100644 internal/admin/dashboard.go create mode 100644 internal/admin/forumposts.go create mode 100644 internal/admin/grants.go create mode 100644 internal/admin/nav.go create mode 100644 internal/admin/pages.go create mode 100644 internal/admin/pages_test.go create mode 100644 internal/admin/suspicious.go delete mode 100644 internal/admin/templates/action_log.html create mode 100644 internal/admin/templates/admin_log.html create mode 100644 internal/admin/templates/dashboard.html create mode 100644 internal/admin/templates/forum_posts.html delete mode 100644 internal/admin/templates/index.html create mode 100644 internal/admin/templates/layout.html create mode 100644 internal/admin/templates/page_confirm.html create mode 100644 internal/admin/templates/page_done.html create mode 100644 internal/admin/templates/page_edit.html create mode 100644 internal/admin/templates/page_list.html create mode 100644 internal/admin/templates/parts.html create mode 100644 internal/admin/templates/suspicious.html create mode 100644 internal/admin/templates/user_bot.html create mode 100644 internal/admin/templates/user_claim.html create mode 100644 internal/admin/templates/user_invite.html create mode 100644 internal/admin/templates/user_mail.html create mode 100644 internal/admin/templates/user_new.html create mode 100644 internal/admin/templates/user_parts.html create mode 100644 internal/admin/templates/user_reset_votes.html create mode 100644 internal/admin/upload.go create mode 100644 internal/admin/useractions.go create mode 100644 static/wikit-admin.css diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go index 1401f82d..779d6d81 100644 --- a/cmd/pwikit/articles.go +++ b/cmd/pwikit/articles.go @@ -141,7 +141,7 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl Tokens: token.Generator{Secret: secret}, Verifier: account.NewVerifier(), Mail: mail.New(mailConfig()), - Assets: static.NewAssets(assets), TimeZone: location, Log: log, + Assets: static.NewAssets(assets), TimeZone: location, Trust: trust, Log: log, } stack.login = account.NewLogin(accounts) stack.logout = account.NewLogout(accounts) @@ -153,7 +153,9 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl stack.settings = account.NewSettings(accounts) adminPages, err := admin.New(admin.Deps{ - DB: conn, Bundle: bundle, Assets: static.NewAssets(assets), Files: p.Files(), TimeZone: location, Log: log, + DB: conn, Bundle: bundle, Assets: static.NewAssets(assets), Files: p.Files(), TimeZone: location, + Tokens: token.Generator{Secret: secret}, Articles: stack.articleAPI, + Mail: mail.New(mailConfig()), Log: log, }, upstream) if err != nil { return nil, err diff --git a/internal/account/account.go b/internal/account/account.go index 4a95c6e6..0b07959e 100644 --- a/internal/account/account.go +++ b/internal/account/account.go @@ -5,12 +5,14 @@ import ( "context" "log/slog" "net/http" + "net/netip" "strings" "time" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/i18n" "github.com/WikitTeam/ProjectWikit/internal/mail" + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/roles" "github.com/WikitTeam/ProjectWikit/internal/session" @@ -38,9 +40,20 @@ type Deps struct { Bundle *i18n.Bundle Assets *static.Assets TimeZone *time.Location + Trust *proxyheader.Trust Log *slog.Logger } +func (d Deps) clientIP(r *http.Request) *netip.Addr { + if d.Trust == nil { + return nil + } + if addr, ok := d.Trust.ClientIP(r); ok { + return &addr + } + return nil +} + func (d Deps) logger() *slog.Logger { if d.Log == nil { return slog.Default() diff --git a/internal/account/login.go b/internal/account/login.go index ecb354f4..bdb67bbb 100644 --- a/internal/account/login.go +++ b/internal/account/login.go @@ -171,6 +171,9 @@ func (d Deps) signIn(ctx context.Context, w http.ResponseWriter, r *http.Request if err := d.DB.SetLastLogin(ctx, user.ID, now); err != nil { return err } + if err := d.DB.SeenAddress(ctx, user.ID, d.clientIP(r), now); err != nil { + return err + } http.SetCookie(w, &http.Cookie{ Name: session.CookieName, Value: key, Path: "/", Expires: now.Add(session.CookieAge), MaxAge: int(session.CookieAge / time.Second), diff --git a/internal/admin/actionlog.go b/internal/admin/actionlog.go deleted file mode 100644 index 9f7619be..00000000 --- a/internal/admin/actionlog.go +++ /dev/null @@ -1,53 +0,0 @@ -package admin - -import ( - "net/http" - - "github.com/WikitTeam/ProjectWikit/internal/i18n" - "github.com/WikitTeam/ProjectWikit/internal/perms" -) - -const actionLogSlug = "action-log" - -func init() { - register(screen{slug: actionLogSlug, label: "admin.action-log", need: perms.ViewActionsLog, serve: (*Handler).actionLog}) -} - -func (h *Handler) actionLog(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { - if r.Method != http.MethodGet && r.Method != http.MethodHead { - w.Header().Set("Allow", "GET, HEAD") - http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) - return nil - } - ctx := r.Context() - kinds, err := h.deps.DB.ActionLogTypes(ctx) - if err != nil { - return err - } - kind := r.URL.Query().Get("type") - if !contains(kinds, kind) { - kind = "" - } - page := atoi(r.URL.Query().Get("page")) - if page < 1 { - page = 1 - } - found, total, err := h.deps.DB.AdminActionLog(ctx, kind, perPage, (page-1)*perPage) - if err != nil { - return err - } - granted, _, err := h.access(ctx) - if err != nil { - return err - } - return h.page(w, r, loc, loc.T("admin.action-log"), "action_log.html", map[string]any{ - "Entries": found, - "Kinds": kinds, - "Kind": kind, - "Page": page, - "Pages": (total + perPage - 1) / perPage, - "Total": total, - "SeeIP": granted.Has(perms.ViewSensitiveInfo), - "Action": Prefix + actionLogSlug + "/", - }) -} diff --git a/internal/admin/admin.go b/internal/admin/admin.go index fa89f69e..e42bacfd 100644 --- a/internal/admin/admin.go +++ b/internal/admin/admin.go @@ -18,12 +18,14 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/escape" "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/mail" "github.com/WikitTeam/ProjectWikit/internal/pageconfig" "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/shell" "github.com/WikitTeam/ProjectWikit/internal/site" "github.com/WikitTeam/ProjectWikit/internal/static" + "github.com/WikitTeam/ProjectWikit/internal/token" ) const ( @@ -40,7 +42,12 @@ type Deps struct { Assets *static.Assets Files string TimeZone *time.Location - Log *slog.Logger + Tokens token.Generator + + Articles http.Handler + Mail mail.Sender + + Log *slog.Logger } func (d Deps) logger() *slog.Logger { @@ -61,6 +68,54 @@ var screens []screen func register(s screen) { screens = append(screens, s) } +type railEntry struct { + slug string + icon string +} + +var groups = []struct { + key string + label string + icon string + entries []railEntry +}{ + {"site", "admin.group-site", "fa-cog", []railEntry{ + {pageSlug, "fa-file-alt"}, + {siteSlug, "fa-cog"}, + {themeSlug, "fa-palette"}, + {pageCategorySlug, "fa-folder-open"}, + {tagSlug, "fa-tag"}, + {tagCategorySlug, "fa-tags"}, + }}, + {"members", "admin.group-members", "fa-users", []railEntry{ + {userSlug, "fa-user"}, + {roleSlug, "fa-shield-alt"}, + {roleCategorySlug, "fa-sitemap"}, + {inviteSlug, "fa-envelope"}, + }}, + {"forum", "admin.group-forum", "fa-comments", []railEntry{ + {sectionSlug, "fa-list-alt"}, + {categorySlug, "fa-th-list"}, + {recentPostSlug, "fa-comment-dots"}, + }}, + {"queue", "admin.group-queue", "fa-flag", []railEntry{ + {reportSlug, "fa-exclamation-triangle"}, + {ticketSlug, "fa-life-ring"}, + {membershipSlug, "fa-check-circle"}, + }}, + {"records", "admin.group-records", "fa-clipboard-list", []railEntry{ + {adminLogSlug, "fa-clock"}, + {suspiciousSlug, "fa-eye"}, + }}, +} + +type grantKey struct{} + +func grantsFrom(ctx context.Context) perms.Set { + got, _ := ctx.Value(grantKey{}).(perms.Set) + return got +} + type Handler struct { deps Deps upstream http.Handler @@ -115,6 +170,7 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } + r = r.WithContext(context.WithValue(ctx, grantKey{}, granted)) head, _, _ := strings.Cut(rest, "/") if head == "" { h.finish(w, r, loc, h.index(w, r, loc, granted)) @@ -191,27 +247,45 @@ func (h *Handler) access(ctx context.Context) (perms.Set, bool, error) { return perms.Resolve(subject, nil), true, nil } -func (h *Handler) index(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, granted perms.Set) error { - type entry struct { - Href string - Label string +func (h *Handler) page(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, title, name string, data any) error { + tpl, err := h.bind(loc) + if err != nil { + return err } - list := make([]entry, 0, len(screens)) - for _, s := range screens { - if !granted.Has(s.need) { - continue - } - list = append(list, entry{Href: Prefix + s.slug + "/", Label: loc.T(s.label)}) + var body strings.Builder + if err := tpl.ExecuteTemplate(&body, name, data); err != nil { + return err + } + var out strings.Builder + if err := tpl.ExecuteTemplate(&out, "layout.html", h.layout(r, loc, title, body.String())); err != nil { + return err } - return h.page(w, r, loc, loc.T("admin.title"), "index.html", map[string]any{"Screens": list}) + return h.write(w, r, loc, title, out.String(), http.StatusOK) } -func (h *Handler) page(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, title, name string, data any) error { - var body strings.Builder - if err := h.templates.ExecuteTemplate(&body, name, data); err != nil { - return err +// Cloned per request rather than bound once at startup, because the language +// will eventually come from the request and a bound one would have to be undone. +func (h *Handler) bind(loc *i18n.Localizer) (*template.Template, error) { + tpl, err := h.templates.Clone() + if err != nil { + return nil, err } - return h.write(w, r, loc, title, body.String(), http.StatusOK) + return tpl.Funcs(template.FuncMap{ + "t": loc.T, + "enum": func(prefix, value string) string { + id := prefix + value + if text := loc.T(id); text != id { + return text + } + return value + }, + "screen": func(slug string) string { + if label := screenLabel(slug); label != "" { + return loc.T(label) + } + return slug + }, + }), nil } func (h *Handler) write(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, title, body string, status int) error { @@ -222,12 +296,13 @@ func (h *Handler) write(w http.ResponseWriter, r *http.Request, loc *i18n.Locali } var out strings.Builder err = shell.New(loc, h.deps.Assets, h.deps.TimeZone).SystemPage(&out, shell.System{ - Title: title, - SiteTitle: current.Title, - ThemeURL: theme, - BodyClass: "wikit-page admin", - Heading: title, - Content: body, + Title: title, + SiteTitle: current.Title, + ThemeURL: theme, + BodyClass: "wikit-page admin", + Heading: title, + Content: body, + Stylesheets: []string{"wikit-admin.css"}, }) if err != nil { return err @@ -249,7 +324,11 @@ func authIcon(s *db.Site) string { func funcs() template.FuncMap { return template.FuncMap{ - "esc": escape.HTML, + "esc": escape.HTML, + "urlq": url.QueryEscape, + "t": func(id string, _ ...any) string { return id }, + "enum": func(_, value string) string { return value }, + "screen": func(slug string) string { return slug }, "dict": func(pairs ...any) map[string]any { out := make(map[string]any, len(pairs)/2) for i := 0; i+1 < len(pairs); i += 2 { diff --git a/internal/admin/admin_test.go b/internal/admin/admin_test.go index 1d505c91..3d03066a 100644 --- a/internal/admin/admin_test.go +++ b/internal/admin/admin_test.go @@ -1,6 +1,7 @@ package admin import ( + "regexp" "slices" "testing" @@ -36,12 +37,35 @@ func TestRegisteredScreensAreReachable(t *testing.T) { } } +func TestEveryScreenIsOnTheRail(t *testing.T) { + placed := make(map[string]string) + for _, g := range groups { + for _, e := range g.entries { + if was, ok := placed[e.slug]; ok { + t.Errorf("rail lists %q under both %q and %q, want one group", e.slug, was, g.key) + } + placed[e.slug] = g.key + if e.icon == "" { + t.Errorf("rail entry %q icon = \"\", want an icon", e.slug) + } + if !slices.ContainsFunc(screens, func(s screen) bool { return s.slug == e.slug }) { + t.Errorf("rail lists %q, want a registered screen", e.slug) + } + } + } + for _, s := range screens { + if _, ok := placed[s.slug]; !ok { + t.Errorf("rail has no entry for screen %q, want one", s.slug) + } + } +} + func TestTemplatesParse(t *testing.T) { h, err := New(Deps{}, nil) if err != nil { t.Fatalf("New() err = %v, want nil", err) } - for _, name := range []string{"index.html", "theme_list.html", "theme_form.html"} { + for _, name := range []string{"layout.html", "dashboard.html", "suspicious.html", "layout.html", "row_text", "pager", "save_row", "theme_list.html", "theme_form.html"} { if h.templates.Lookup(name) == nil { t.Errorf("Lookup(%q) = nil, want the template", name) } @@ -201,12 +225,12 @@ func TestOptionalTime(t *testing.T) { } } -func TestAllSixteenScreensAreRegistered(t *testing.T) { +func TestEveryScreenIsRegistered(t *testing.T) { want := []string{ "themes", "site", "roles", "role-categories", "users", "reports", - "forum-sections", "forum-categories", "action-log", + "forum-sections", "forum-categories", "admin-log", "tags", "tag-categories", "page-categories", - "tickets", "membership-applications", "invite-links", + "tickets", "membership-applications", "invite-links", "suspicious", "forum-posts", "pages", } got := make([]string, 0, len(screens)) for _, s := range screens { @@ -228,11 +252,11 @@ func TestEveryScreenHasItsTemplates(t *testing.T) { t.Fatalf("New() err = %v, want nil", err) } for _, name := range []string{ - "index.html", "theme_list.html", "theme_form.html", "site_form.html", + "dashboard.html", "suspicious.html", "layout.html", "row_text", "pager", "save_row", "theme_list.html", "theme_form.html", "site_form.html", "role_list.html", "role_form.html", "role_category.html", "user_list.html", "user_form.html", "report_list.html", "report_form.html", "forum_section_list.html", "forum_section_form.html", - "forum_category_list.html", "forum_category_form.html", "action_log.html", + "forum_category_list.html", "forum_category_form.html", "admin_log.html", "tag_list.html", "tag_form.html", "tag_category_list.html", "tag_category_form.html", "page_category_list.html", "page_category_form.html", "ticket_list.html", "ticket_form.html", "invite_list.html", @@ -275,3 +299,47 @@ func TestSiteSignInReplacesTheAdminOne(t *testing.T) { } } } + +func TestEveryTemplateKeyIsInTheCatalog(t *testing.T) { + bundle, err := i18n.Load("") + if err != nil { + t.Fatalf("Load() err = %v, want nil", err) + } + loc := bundle.Localizer(i18n.DefaultLanguage) + + patterns := []*regexp.Regexp{ + regexp.MustCompile(`\{\{t "([^"]+)"`), + regexp.MustCompile(`"[klh]" "(admin\.[^"]+)"`), + } + entries, err := files.ReadDir("templates") + if err != nil { + t.Fatalf("ReadDir() err = %v, want nil", err) + } + for _, entry := range entries { + raw, err := files.ReadFile("templates/" + entry.Name()) + if err != nil { + t.Fatalf("ReadFile(%q) err = %v, want nil", entry.Name(), err) + } + for _, pattern := range patterns { + for _, found := range pattern.FindAllStringSubmatch(string(raw), -1) { + if loc.T(found[1]) == found[1] { + t.Errorf("%s uses %q, want a key the catalog holds", entry.Name(), found[1]) + } + } + } + } +} + +func TestEveryScreenLabelIsInTheCatalog(t *testing.T) { + loc := testLocalizer(t) + for _, s := range screens { + if loc.T(s.label) == s.label { + t.Errorf("screen %q label %q is not in the catalog, want it there", s.slug, s.label) + } + } + for _, g := range groups { + if loc.T(g.label) == g.label { + t.Errorf("group %q label %q is not in the catalog, want it there", g.key, g.label) + } + } +} diff --git a/internal/admin/adminlog.go b/internal/admin/adminlog.go new file mode 100644 index 00000000..8b781cb8 --- /dev/null +++ b/internal/admin/adminlog.go @@ -0,0 +1,84 @@ +package admin + +import ( + "net/http" + "strconv" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" +) + +const adminLogSlug = "admin-log" + +const adminLogPerPage = 60 + +func init() { + register(screen{slug: adminLogSlug, label: "admin.admin-log", need: perms.ViewActionsLog, serve: (*Handler).adminLog}) +} + +func (h *Handler) note(r *http.Request, action, screen, target, label string) { + entry := db.AdminNote{ + Action: action, + Screen: screen, + Target: target, + Label: label, + At: time.Now().UTC(), + } + if by := auth.FromContext(r.Context()); by != nil { + entry.UserID = &by.ID + entry.Name = by.Username + } + if err := h.deps.DB.WriteAdminNote(r.Context(), entry); err != nil { + h.deps.logger().Error("record admin action", "screen", screen, "action", action, "err", err) + } +} + +func (h *Handler) noteID(r *http.Request, action, screen string, id int64, label string) { + h.note(r, action, screen, strconv.FormatInt(id, 10), label) +} + +func (h *Handler) adminLog(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + if r.Method != http.MethodGet && r.Method != http.MethodHead { + w.Header().Set("Allow", "GET, HEAD") + http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) + return nil + } + ctx := r.Context() + screen := r.URL.Query().Get("screen") + page := atoi(r.URL.Query().Get("page")) + if page < 1 { + page = 1 + } + found, err := h.deps.DB.AdminNotes(ctx, screen, adminLogPerPage+1, (page-1)*adminLogPerPage) + if err != nil { + return err + } + more := len(found) > adminLogPerPage + if more { + found = found[:adminLogPerPage] + } + screens, err := h.deps.DB.AdminNoteScreens(ctx) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.admin-log"), "admin_log.html", map[string]any{ + "Notes": found, + "Screens": screens, + "Screen": screen, + "Page": page, + "More": more, + "Action": Prefix + adminLogSlug + "/", + }) +} + +func screenLabel(slug string) string { + for _, s := range screens { + if s.slug == slug { + return s.label + } + } + return "" +} diff --git a/internal/admin/category.go b/internal/admin/category.go index f0fb655b..6234bc48 100644 --- a/internal/admin/category.go +++ b/internal/admin/category.go @@ -3,7 +3,6 @@ package admin import ( "errors" "net/http" - "slices" "strconv" "strings" @@ -74,7 +73,7 @@ func (h *Handler) pageCategoryForm(w http.ResponseWriter, r *http.Request, loc * type cell struct { Role db.RoleChoice - Grants []grantState + Grants []grantGroup Present bool } byRole := map[int64]db.CategoryOverride{} @@ -84,15 +83,11 @@ func (h *Handler) pageCategoryForm(w http.ResponseWriter, r *http.Request, loc * cells := make([]cell, 0, len(roleList)) for _, one := range roleList { override, present := byRole[one.ID] - states := make([]grantState, 0, len(catalog)) - for _, name := range catalog { - states = append(states, grantState{ - Name: name, - Allow: slices.Contains(override.Allow, name), - Deny: slices.Contains(override.Deny, name), - }) - } - cells = append(cells, cell{Role: one, Grants: states, Present: present}) + cells = append(cells, cell{ + Role: one, + Grants: grantGroups(catalog, override.Allow, override.Deny), + Present: present, + }) } return h.page(w, r, loc, loc.T("admin.page-categories"), "page_category_form.html", map[string]any{ @@ -108,12 +103,6 @@ func (h *Handler) pageCategoryForm(w http.ResponseWriter, r *http.Request, loc * }) } -type grantState struct { - Name string - Allow bool - Deny bool -} - func (h *Handler) savePageCategory(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest string) error { ctx := r.Context() if !h.verified(w, r) { @@ -136,6 +125,7 @@ func (h *Handler) savePageCategory(w http.ResponseWriter, r *http.Request, loc * row.ID = id } if r.PostFormValue("delete") != "" && row.ID != 0 { + h.noteID(r, db.AdminDeleted, pageCategorySlug, row.ID, row.Name) if err := h.deps.DB.DeleteCategory(ctx, row.ID); err != nil { return err } @@ -148,6 +138,10 @@ func (h *Handler) savePageCategory(w http.ResponseWriter, r *http.Request, loc * if !contains(ratingModes, row.Settings.RatingMode) || !contains(tagModes, row.Settings.CreateTags) { return h.pageCategoryForm(w, r, loc, rest, loc.T("admin.site-bad-mode")) } + did := db.AdminChanged + if row.ID == 0 { + did = db.AdminCreated + } if err := h.deps.DB.SaveCategory(ctx, row); err != nil { return err } @@ -198,6 +192,7 @@ func (h *Handler) savePageCategory(w http.ResponseWriter, r *http.Request, loc * if err := h.deps.DB.SaveCategoryOverrides(ctx, row.ID, overrides); err != nil { return err } + h.noteID(r, did, pageCategorySlug, row.ID, row.Name) redirect(w, Prefix+pageCategorySlug+"/") return nil } diff --git a/internal/admin/dashboard.go b/internal/admin/dashboard.go new file mode 100644 index 00000000..528f09bb --- /dev/null +++ b/internal/admin/dashboard.go @@ -0,0 +1,192 @@ +package admin + +import ( + "context" + "errors" + "net/http" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/changelog" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/site" +) + +const dashboardRows = 8 + +type queueItem struct { + Href string + Label string + Count int +} + +type changeRow struct { + Flags []changelog.Flag + Title string + Href string + User string + Comment string + CreatedAt time.Time +} + +type actionRow struct { + Action string + Screen string + User string + Label string + CreatedAt time.Time +} + +func (h *Handler) index(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, granted perms.Set) error { + ctx := r.Context() + current := site.FromContext(ctx) + + settings, err := h.deps.DB.SiteSettings(ctx, current.ID) + if err != nil { + return err + } + queue, err := h.queue(ctx, loc, granted) + if err != nil { + return err + } + changes, err := h.recentChanges(ctx, loc) + if err != nil { + return err + } + + data := map[string]any{ + "Site": current, + "Settings": settings, + "Queue": queue, + "Changes": changes, + "SiteHref": Prefix + siteSlug + "/", + "MaySite": granted.Has(perms.ManageSite), + } + if granted.Has(perms.ViewActionsLog) { + actions, err := h.recentActions(ctx) + if err != nil { + return err + } + data["Actions"] = actions + data["ActionsHref"] = Prefix + adminLogSlug + "/" + } + return h.page(w, r, loc, loc.T("admin.dashboard"), "dashboard.html", data) +} + +func (h *Handler) queue(ctx context.Context, loc *i18n.Localizer, granted perms.Set) ([]queueItem, error) { + var out []queueItem + if granted.Has(perms.ViewUserReports) { + _, total, err := h.deps.DB.AdminReports(ctx, db.ReportPending, 1, 0) + if err != nil { + return nil, err + } + out = append(out, queueItem{Prefix + reportSlug + "/?status=" + db.ReportPending, loc.T("admin.reports"), total}) + } + if granted.Has(perms.ViewUserTickets) { + _, total, err := h.deps.DB.AdminTickets(ctx, db.TicketKind, db.TicketPending, 1, 0) + if err != nil { + return nil, err + } + out = append(out, queueItem{Prefix + ticketSlug + "/?status=" + db.TicketPending, loc.T("admin.tickets"), total}) + } + if granted.Has(perms.ReviewMembershipApplications) { + _, total, err := h.deps.DB.AdminTickets(ctx, db.MembershipApplyKind, db.TicketPending, 1, 0) + if err != nil { + return nil, err + } + out = append(out, queueItem{Prefix + membershipSlug + "/?status=" + db.TicketPending, loc.T("admin.membership"), total}) + } + if granted.Has(perms.ManageUsers) { + total, err := h.deps.DB.OpenInviteCount(ctx) + if err != nil { + return nil, err + } + out = append(out, queueItem{Prefix + inviteSlug + "/", loc.T("admin.open-invites"), total}) + } + return out, nil +} + +func (h *Handler) recentChanges(ctx context.Context, loc *i18n.Localizer) ([]changeRow, error) { + found, err := h.deps.DB.SiteChanges(ctx, db.SiteChangeFilter{}, 0, dashboardRows) + if err != nil { + return nil, err + } + var ids []int64 + for _, c := range found { + if c.UserID != nil { + ids = append(ids, *c.UserID) + } + } + names, err := h.userNames(ctx, ids) + if err != nil { + return nil, err + } + users := func(want []int64) ([]db.User, error) { return h.deps.DB.UsersByIDs(ctx, want) } + + out := make([]changeRow, 0, len(found)) + for _, c := range found { + row := changeRow{ + Title: c.ArticleTitle, + Href: "/" + c.ArticleName, + CreatedAt: c.CreatedAt, + } + if c.ArticleCategory != "_default" { + row.Href = "/" + c.ArticleCategory + ":" + c.ArticleName + } + if row.Title == "" { + row.Title = c.ArticleName + } + if c.UserID != nil { + row.User = names[*c.UserID] + } + entry, err := changelog.Of(loc, users, c) + switch { + case errors.Is(err, changelog.ErrUnreadable): + case err != nil: + return nil, err + default: + row.Flags = entry.Flags + row.Comment = entry.Comment + } + out = append(out, row) + } + return out, nil +} + +func (h *Handler) recentActions(ctx context.Context) ([]actionRow, error) { + found, err := h.deps.DB.AdminNotes(ctx, "", dashboardRows, 0) + if err != nil { + return nil, err + } + out := make([]actionRow, 0, len(found)) + for _, e := range found { + who := e.User + if who == "" { + who = e.Stale + } + out = append(out, actionRow{ + Action: e.Action, + Screen: e.Screen, + User: who, + Label: e.Label, + CreatedAt: e.CreatedAt, + }) + } + return out, nil +} + +func (h *Handler) userNames(ctx context.Context, ids []int64) (map[int64]string, error) { + out := map[int64]string{} + if len(ids) == 0 { + return out, nil + } + users, err := h.deps.DB.UsersByIDs(ctx, ids) + if err != nil { + return nil, err + } + for _, u := range users { + out[u.ID] = u.DisplayLabel() + } + return out, nil +} diff --git a/internal/admin/forum.go b/internal/admin/forum.go index ea100f55..c2367f10 100644 --- a/internal/admin/forum.go +++ b/internal/admin/forum.go @@ -50,15 +50,21 @@ func (h *Handler) forumSections(w http.ResponseWriter, r *http.Request, loc *i18 if err := h.deps.DB.DeleteForumSection(ctx, row.ID); err != nil { return err } + h.noteID(r, db.AdminDeleted, sectionSlug, row.ID, row.Name) redirect(w, Prefix+sectionSlug+"/") return nil } if row.Name == "" { return h.forumSectionForm(w, r, loc, rest, loc.T("admin.forum-no-name")) } + did := db.AdminChanged + if row.ID == 0 { + did = db.AdminCreated + } if err := h.deps.DB.SaveForumSection(ctx, row); err != nil { return err } + h.noteID(r, did, sectionSlug, row.ID, row.Name) redirect(w, Prefix+sectionSlug+"/") return nil } @@ -133,6 +139,7 @@ func (h *Handler) forumCategories(w http.ResponseWriter, r *http.Request, loc *i if err := h.deps.DB.DeleteForumCategory(ctx, row.ID); err != nil { return err } + h.noteID(r, db.AdminDeleted, categorySlug, row.ID, row.Name) redirect(w, Prefix+categorySlug+"/") return nil } @@ -142,9 +149,14 @@ func (h *Handler) forumCategories(w http.ResponseWriter, r *http.Request, loc *i if row.SectionID == 0 { return h.forumCategoryForm(w, r, loc, rest, loc.T("admin.forum-no-section")) } + did := db.AdminChanged + if row.ID == 0 { + did = db.AdminCreated + } if err := h.deps.DB.SaveForumCategory(ctx, row); err != nil { return err } + h.noteID(r, did, categorySlug, row.ID, row.Name) redirect(w, Prefix+categorySlug+"/") return nil } diff --git a/internal/admin/forumposts.go b/internal/admin/forumposts.go new file mode 100644 index 00000000..af5ed8ed --- /dev/null +++ b/internal/admin/forumposts.go @@ -0,0 +1,103 @@ +package admin + +import ( + "context" + "net/http" + "strconv" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" +) + +const recentPostSlug = "forum-posts" + +const recentPostsPerPage = 40 + +func init() { + register(screen{slug: recentPostSlug, label: "admin.forum-posts", need: perms.ManageForum, serve: (*Handler).forumPosts}) +} + +type recentPostRow struct { + ID int64 + Name string + Author string + Thread string + Category string + Href string + CreatedAt time.Time +} + +func (h *Handler) forumPosts(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + if r.Method != http.MethodGet && r.Method != http.MethodHead { + w.Header().Set("Allow", "GET, HEAD") + http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) + return nil + } + ctx := r.Context() + page := atoi(r.URL.Query().Get("page")) + if page < 1 { + page = 1 + } + comments := r.URL.Query().Get("comments") != "off" + + rows, err := h.recentPosts(ctx, comments, (page-1)*recentPostsPerPage, recentPostsPerPage) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.forum-posts"), "forum_posts.html", map[string]any{ + "Posts": rows, + "Comments": comments, + "Page": page, + "More": len(rows) == recentPostsPerPage, + "Action": Prefix + recentPostSlug + "/", + }) +} + +func (h *Handler) recentPosts(ctx context.Context, comments bool, offset, limit int) ([]recentPostRow, error) { + categories, err := h.deps.DB.ForumCategories(ctx) + if err != nil { + return nil, err + } + ids := make([]int64, 0, len(categories)) + named := make(map[int64]string, len(categories)) + for _, c := range categories { + ids = append(ids, c.ID) + named[c.ID] = c.Name + } + + posts, err := h.deps.DB.RecentPosts(ctx, ids, comments, offset, limit) + if err != nil { + return nil, err + } + var authors []int64 + for _, p := range posts { + if p.AuthorID != nil { + authors = append(authors, *p.AuthorID) + } + } + names, err := h.userNames(ctx, authors) + if err != nil { + return nil, err + } + + out := make([]recentPostRow, 0, len(posts)) + for _, p := range posts { + row := recentPostRow{ + ID: p.ID, + Name: p.Name, + Thread: p.ThreadName, + Href: "/forum/t-" + strconv.FormatInt(p.ThreadID, 10) + + "#post-" + strconv.FormatInt(p.ID, 10), + CreatedAt: p.CreatedAt, + } + if p.AuthorID != nil { + row.Author = names[*p.AuthorID] + } + if p.ThreadCategoryID != nil { + row.Category = named[*p.ThreadCategoryID] + } + out = append(out, row) + } + return out, nil +} diff --git a/internal/admin/grants.go b/internal/admin/grants.go new file mode 100644 index 00000000..1254106d --- /dev/null +++ b/internal/admin/grants.go @@ -0,0 +1,59 @@ +package admin + +import ( + "slices" + + "github.com/WikitTeam/ProjectWikit/internal/perms" +) + +type grantRow struct { + Name string + Allow bool + Deny bool +} + +type grantGroup struct { + Key string + Rows []grantRow +} + +func grantGroups(catalog, allow, deny []string) []grantGroup { + row := func(name string) grantRow { + return grantRow{ + Name: name, + Allow: slices.Contains(allow, name), + Deny: slices.Contains(deny, name), + } + } + known := make(map[string]bool, len(catalog)) + for _, name := range catalog { + known[name] = true + } + + groups := make([]grantGroup, 0, len(perms.Catalog)+1) + placed := make(map[string]bool, len(catalog)) + for _, g := range perms.Catalog { + group := grantGroup{Key: g.Key} + for _, name := range g.Names { + if !known[name] { + continue + } + group.Rows = append(group.Rows, row(name)) + placed[name] = true + } + if len(group.Rows) > 0 { + groups = append(groups, group) + } + } + + rest := grantGroup{} + for _, name := range catalog { + if !placed[name] { + rest.Rows = append(rest.Rows, row(name)) + } + } + if len(rest.Rows) > 0 { + groups = append(groups, rest) + } + return groups +} diff --git a/internal/admin/nav.go b/internal/admin/nav.go new file mode 100644 index 00000000..dd378221 --- /dev/null +++ b/internal/admin/nav.go @@ -0,0 +1,110 @@ +package admin + +import ( + "net/http" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/site" +) + +type navItem struct { + Href string + Label string + Icon string + Active bool +} + +type navGroup struct { + Key string + Label string + Icon string + Items []navItem + Open bool +} + +type layoutView struct { + SiteTitle string + AdminURL string + Here string + User string + Title string + Dashboard navItem + Groups []navGroup + Open *navGroup + Body string + + loc *i18n.Localizer +} + +func (v layoutView) T(id string, args ...any) string { return v.loc.T(id, args...) } + +func (h *Handler) layout(r *http.Request, loc *i18n.Localizer, title, body string) layoutView { + ctx := r.Context() + granted := grantsFrom(ctx) + active, _, _ := strings.Cut(strings.TrimPrefix(r.URL.Path, Prefix), "/") + + v := layoutView{ + Title: title, + Body: body, + AdminURL: Prefix, + Here: r.URL.Path, + loc: loc, + } + if current := site.FromContext(ctx); current != nil { + v.SiteTitle = current.Title + } + if user := auth.FromContext(ctx); user != nil { + v.User = user.DisplayLabel() + } + v.Dashboard = navItem{ + Href: Prefix, + Label: loc.T("admin.dashboard"), + Icon: "fa-tachometer-alt", + Active: active == "", + } + + labels := make(map[string]string, len(screens)) + needs := make(map[string]string, len(screens)) + for _, s := range screens { + labels[s.slug] = s.label + needs[s.slug] = s.need + } + for _, g := range groups { + group := navGroup{Key: g.key, Label: loc.T(g.label), Icon: g.icon} + for _, e := range g.entries { + label, ok := labels[e.slug] + if !ok || !granted.Has(needs[e.slug]) { + continue + } + item := navItem{ + Href: Prefix + e.slug + "/", + Label: loc.T(label), + Icon: e.icon, + Active: e.slug == active, + } + if item.Active { + group.Open = true + } + group.Items = append(group.Items, item) + } + if len(group.Items) > 0 { + v.Groups = append(v.Groups, group) + } + } + + if q := r.URL.Query(); q.Has("g") { + want := q.Get("g") + for i := range v.Groups { + v.Groups[i].Open = v.Groups[i].Key == want + } + } + for i := range v.Groups { + if v.Groups[i].Open { + v.Open = &v.Groups[i] + break + } + } + return v +} diff --git a/internal/admin/pages.go b/internal/admin/pages.go new file mode 100644 index 00000000..29e93cd9 --- /dev/null +++ b/internal/admin/pages.go @@ -0,0 +1,319 @@ +package admin + +import ( + "bytes" + "encoding/json" + "errors" + "net/http" + "strconv" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/webapi" +) + +const pageSlug = "pages" + +const ( + pageActionDelete = "delete" + pageActionRevert = "revert" + pageActionRename = "rename" +) + +func init() { + register(screen{slug: pageSlug, label: "admin.pages", need: perms.EditArticles, serve: (*Handler).pages}) +} + +func (h *Handler) pages(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + rest := strings.Trim(strings.TrimPrefix(r.URL.Path, Prefix+pageSlug), "/") + if rest == "" { + if r.Method == http.MethodPost { + return h.pageBatch(w, r, loc) + } + return h.pageList(w, r, loc, "") + } + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + if r.Method == http.MethodPost { + return h.savePage(w, r, loc, id) + } + return h.pageForm(w, r, loc, id, "") +} + +func (h *Handler) pageList(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, problem string) error { + ctx := r.Context() + query := strings.TrimSpace(r.URL.Query().Get("q")) + category := r.URL.Query().Get("c") + page := atoi(r.URL.Query().Get("page")) + if page < 1 { + page = 1 + } + found, total, err := h.deps.DB.AdminPages(ctx, query, category, perPage, (page-1)*perPage) + if err != nil { + return err + } + categories, err := h.deps.DB.AdminPageCategories(ctx) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.pages"), "page_list.html", map[string]any{ + "Pages": found, + "Categories": categories, + "Query": query, + "Category": category, + "Page": page, + "Pages_": (total + perPage - 1) / perPage, + "Total": total, + "Error": problem, + "CSRF": csrf.Issue(w, r), + "Action": Prefix + pageSlug + "/", + "Base": Prefix + pageSlug + "/", + }) +} + +func (h *Handler) pageForm(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, id int64, problem string) error { + ctx := r.Context() + article, err := h.deps.DB.ArticleByID(ctx, id) + if errors.Is(err, db.ErrNotFound) { + notFound(w) + return nil + } + if err != nil { + return err + } + source, err := h.deps.DB.LatestSource(ctx, id) + if err != nil { + return err + } + one := 1 + log, err := h.deps.DB.ArticleLog(ctx, id, 0, &one) + if err != nil { + return err + } + head := 0 + if len(log) > 0 { + head = log[0].RevNumber + } + return h.page(w, r, loc, article.FullName(), "page_edit.html", map[string]any{ + "Article": article, + "Full": article.FullName(), + "Source": source, + "Head": head, + "Error": problem, + "CSRF": csrf.Issue(w, r), + "Action": Prefix + pageSlug + "/" + strconv.FormatInt(id, 10), + "Back": Prefix + pageSlug + "/", + }) +} + +func (h *Handler) savePage(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, id int64) error { + if !h.verified(w, r) { + return nil + } + ctx := r.Context() + article, err := h.deps.DB.ArticleByID(ctx, id) + if errors.Is(err, db.ErrNotFound) { + notFound(w) + return nil + } + if err != nil { + return err + } + + body := map[string]any{"pageId": article.FullName()} + if r.PostFormValue("action") == pageActionRename { + wanted := strings.TrimSpace(r.PostFormValue("full_name")) + if wanted == "" || wanted == article.FullName() { + return h.pageForm(w, r, loc, id, loc.T("admin.page-no-name")) + } + body["pageId"] = wanted + } else { + source := r.PostFormValue("source") + if strings.TrimSpace(source) == "" { + return h.pageForm(w, r, loc, id, loc.T("admin.page-no-source")) + } + body["source"] = source + body["title"] = strings.TrimSpace(r.PostFormValue("title")) + } + + status, answer, err := h.callArticle(r, http.MethodPut, article.FullName(), "", body) + if err != nil { + return err + } + if status != http.StatusOK { + return h.pageForm(w, r, loc, id, apiProblem(loc, answer)) + } + h.noteID(r, db.AdminChanged, pageSlug, id, article.FullName()) + redirect(w, Prefix+pageSlug+"/"+strconv.FormatInt(id, 10)) + return nil +} + +type batchResult struct { + Full string + Problem string +} + +func (h *Handler) pageBatch(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + if !h.verified(w, r) { + return nil + } + ctx := r.Context() + action := r.PostFormValue("action") + steps := atoi(r.PostFormValue("steps")) + if action == pageActionRevert && steps < 1 { + steps = 1 + } + + var picked []db.AdminPageRow + for _, raw := range r.PostForm["id"] { + id, err := strconv.ParseInt(raw, 10, 64) + if err != nil { + continue + } + article, err := h.deps.DB.ArticleByID(ctx, id) + if errors.Is(err, db.ErrNotFound) { + continue + } + if err != nil { + return err + } + picked = append(picked, db.AdminPageRow{ + ID: article.ID, Category: article.Category, Name: article.Name, Title: article.Title, + }) + } + if len(picked) == 0 { + return h.pageList(w, r, loc, loc.T("admin.page-none-picked")) + } + + if r.PostFormValue("confirm") == "" { + return h.page(w, r, loc, loc.T("admin.pages"), "page_confirm.html", map[string]any{ + "Picked": picked, + "What": action, + "Steps": steps, + "CSRF": csrf.Issue(w, r), + "Action": Prefix + pageSlug + "/", + "Back": Prefix + pageSlug + "/", + }) + } + + results := make([]batchResult, 0, len(picked)) + for _, one := range picked { + results = append(results, batchResult{ + Full: one.FullName(), + Problem: h.applyOne(r, loc, one, action, steps), + }) + } + return h.page(w, r, loc, loc.T("admin.pages"), "page_done.html", map[string]any{ + "Results": results, + "What": action, + "Back": Prefix + pageSlug + "/", + }) +} + +func (h *Handler) applyOne(r *http.Request, loc *i18n.Localizer, one db.AdminPageRow, action string, steps int) string { + switch action { + case pageActionDelete: + status, answer, err := h.callArticle(r, http.MethodDelete, one.FullName(), "", nil) + if err != nil { + return err.Error() + } + if status != http.StatusOK { + return apiProblem(loc, answer) + } + h.noteID(r, db.AdminDeleted, pageSlug, one.ID, one.FullName()) + return "" + case pageActionRevert: + target, err := h.revertTarget(r, one.ID, steps) + if err != nil { + return err.Error() + } + if target < 0 { + return loc.T("admin.page-no-older") + } + status, answer, err := h.callArticle(r, http.MethodPut, one.FullName(), "log", + map[string]any{"revNumber": target}) + if err != nil { + return err.Error() + } + if status != http.StatusOK { + return apiProblem(loc, answer) + } + h.noteID(r, db.AdminChanged, pageSlug, one.ID, one.FullName()) + return "" + } + return loc.T("admin.page-bad-action") +} + +func (h *Handler) revertTarget(r *http.Request, id int64, steps int) (int, error) { + limit := steps + 1 + log, err := h.deps.DB.ArticleLog(r.Context(), id, 0, &limit) + if err != nil { + return 0, err + } + if len(log) <= steps { + return -1, nil + } + return log[steps].RevNumber, nil +} + +// Driven in process because the article API is the only place that knows what +// a page write drags along. The context carries the admin into the history. +func (h *Handler) callArticle(r *http.Request, method, name, tail string, body any) (int, string, error) { + if h.deps.Articles == nil { + return 0, "", errors.New("admin: no article API to call") + } + var payload []byte + if body != nil { + var err error + if payload, err = json.Marshal(body); err != nil { + return 0, "", err + } + } + url := webapi.ArticlesPrefix + name + if tail != "" { + url += "/" + tail + } + ctx := csrf.Exempt(r.Context()) + sub, err := http.NewRequestWithContext(ctx, method, url, bytes.NewReader(payload)) + if err != nil { + return 0, "", err + } + sub.Header.Set("Content-Type", "application/json") + sub.Host = r.Host + + rec := &recorder{status: http.StatusOK} + h.deps.Articles.ServeHTTP(rec, sub) + return rec.status, rec.body.String(), nil +} + +type recorder struct { + status int + body bytes.Buffer + header http.Header +} + +func (rec *recorder) Header() http.Header { + if rec.header == nil { + rec.header = http.Header{} + } + return rec.header +} + +func (rec *recorder) Write(p []byte) (int, error) { return rec.body.Write(p) } +func (rec *recorder) WriteHeader(status int) { rec.status = status } + +func apiProblem(loc *i18n.Localizer, answer string) string { + var body struct { + Error string `json:"error"` + } + if json.Unmarshal([]byte(answer), &body) == nil && body.Error != "" { + return body.Error + } + return loc.T("admin.page-failed") +} diff --git a/internal/admin/pages_test.go b/internal/admin/pages_test.go new file mode 100644 index 00000000..4cbad384 --- /dev/null +++ b/internal/admin/pages_test.go @@ -0,0 +1,89 @@ +package admin + +import ( + "net/http" + "net/http/httptest" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +type seenRequest struct { + user *db.User + method string + path string + body string + exempt bool +} + +func recordingArticles(into *seenRequest) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + into.user = auth.FromContext(r.Context()) + into.method = r.Method + into.path = r.URL.Path + into.exempt = csrf.Verify(r, nil) == nil + buf := make([]byte, 256) + n, _ := r.Body.Read(buf) + into.body = string(buf[:n]) + w.WriteHeader(http.StatusOK) + _, _ = w.Write([]byte(`{"status":"ok"}`)) + }) +} + +func TestCallArticleKeepsTheSignedInUser(t *testing.T) { + var seen seenRequest + h := &Handler{deps: Deps{Articles: recordingArticles(&seen)}} + + mine := &db.User{ID: 42, Username: "wikitadmin"} + outer := httptest.NewRequest(http.MethodPost, Prefix+pageSlug+"/", nil) + outer = outer.WithContext(auth.NewContext(outer.Context(), mine)) + + status, answer, err := h.callArticle(outer, http.MethodPut, "scp-173", "", map[string]any{"pageId": "scp-173"}) + if err != nil { + t.Fatalf("callArticle() err = %v, want nil", err) + } + if status != http.StatusOK { + t.Errorf("callArticle() status = %d, want %d", status, http.StatusOK) + } + if answer == "" { + t.Error("callArticle() answer = \"\", want the API body") + } + if seen.user == nil { + t.Fatal("the article API saw no user, want the signed-in one") + } + if seen.user.ID != mine.ID { + t.Errorf("the article API saw user %d, want %d", seen.user.ID, mine.ID) + } +} + +func TestCallArticleBuildsTheApiRequest(t *testing.T) { + var seen seenRequest + h := &Handler{deps: Deps{Articles: recordingArticles(&seen)}} + outer := httptest.NewRequest(http.MethodPost, Prefix+pageSlug+"/", nil) + + if _, _, err := h.callArticle(outer, http.MethodPut, "scp-173", "log", map[string]any{"revNumber": 3}); err != nil { + t.Fatalf("callArticle() err = %v, want nil", err) + } + if want := "/pw-api/articles/scp-173/log"; seen.path != want { + t.Errorf("path = %q, want %q", seen.path, want) + } + if seen.method != http.MethodPut { + t.Errorf("method = %q, want %q", seen.method, http.MethodPut) + } + if want := `{"revNumber":3}`; seen.body != want { + t.Errorf("body = %q, want %q", seen.body, want) + } + if !seen.exempt { + t.Error("csrf.Verify() = error, want the sub request to be exempt") + } +} + +func TestCallArticleWithoutTheApi(t *testing.T) { + h := &Handler{} + outer := httptest.NewRequest(http.MethodPost, Prefix+pageSlug+"/", nil) + if _, _, err := h.callArticle(outer, http.MethodDelete, "scp-173", "", nil); err == nil { + t.Error("callArticle() err = nil, want an error") + } +} diff --git a/internal/admin/report.go b/internal/admin/report.go index 53ba1329..32581940 100644 --- a/internal/admin/report.go +++ b/internal/admin/report.go @@ -124,6 +124,7 @@ func (h *Handler) saveReport(w http.ResponseWriter, r *http.Request, loc *i18n.L if err != nil { return err } + h.noteID(r, db.AdminChanged, reportSlug, id, status) redirect(w, Prefix+reportSlug+"/") return nil } diff --git a/internal/admin/role.go b/internal/admin/role.go index 57829ffe..1737d5ca 100644 --- a/internal/admin/role.go +++ b/internal/admin/role.go @@ -91,23 +91,9 @@ func (h *Handler) roleForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc return err } - type grant struct { - Name string - Allow bool - Deny bool - } - grants := make([]grant, 0, len(catalog)) - for _, name := range catalog { - grants = append(grants, grant{ - Name: name, - Allow: slices.Contains(row.Allow, name), - Deny: slices.Contains(row.Deny, name), - }) - } - return h.page(w, r, loc, loc.T("admin.roles"), "role_form.html", map[string]any{ "Role": row, - "Grants": grants, + "Grants": grantGroups(catalog, row.Allow, row.Deny), "Categories": categories, "InlineModes": inlineModes, "ProfileModes": profileModes, @@ -165,6 +151,7 @@ func (h *Handler) saveRole(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if err := h.deps.DB.DeleteRole(ctx, stored.ID); err != nil { return err } + h.noteID(r, db.AdminDeleted, roleSlug, stored.ID, stored.Slug) redirect(w, Prefix+roleSlug+"/") return nil } @@ -184,7 +171,10 @@ func (h *Handler) saveRole(w http.ResponseWriter, r *http.Request, loc *i18n.Loc next.InlineVisualMode = r.PostFormValue("inline_visual_mode") next.ProfileVisualMode = r.PostFormValue("profile_visual_mode") next.Color = strings.TrimSpace(r.PostFormValue("color")) - next.Icon = strings.TrimSpace(r.PostFormValue("icon")) + next.Icon, err = h.pickIcon(r, "icon", stored.Icon, roleIcon) + if err != nil { + return h.roleForm(w, r, loc, rest, iconMessage(loc, err)) + } next.BadgeText = strings.TrimSpace(r.PostFormValue("badge_text")) next.BadgeBg = strings.TrimSpace(r.PostFormValue("badge_bg")) next.BadgeTextColor = strings.TrimSpace(r.PostFormValue("badge_text_color")) @@ -214,9 +204,14 @@ func (h *Handler) saveRole(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if problem := checkRole(loc, next); problem != "" { return h.roleForm(w, r, loc, rest, problem) } + did := db.AdminChanged + if next.ID == 0 { + did = db.AdminCreated + } if _, err := h.deps.DB.SaveRole(ctx, next, mayGrant); err != nil { return err } + h.noteID(r, did, roleSlug, next.ID, next.Slug) redirect(w, Prefix+roleSlug+"/") return nil } @@ -266,6 +261,7 @@ func (h *Handler) roleCategories(w http.ResponseWriter, r *http.Request, loc *i1 if err := h.deps.DB.DeleteRoleCategory(ctx, *id); err != nil { return err } + h.noteID(r, db.AdminDeleted, roleCategorySlug, *id, "") redirect(w, Prefix+roleCategorySlug+"/") return nil } @@ -277,9 +273,14 @@ func (h *Handler) roleCategories(w http.ResponseWriter, r *http.Request, loc *i1 if id != nil { row.ID = *id } + did := db.AdminChanged + if row.ID == 0 { + did = db.AdminCreated + } if err := h.deps.DB.SaveRoleCategory(ctx, row); err != nil { return err } + h.noteID(r, did, roleCategorySlug, row.ID, row.Name) redirect(w, Prefix+roleCategorySlug+"/") return nil } diff --git a/internal/admin/site.go b/internal/admin/site.go index c6abbfa2..b45b01f6 100644 --- a/internal/admin/site.go +++ b/internal/admin/site.go @@ -84,14 +84,21 @@ func (h *Handler) saveSite(w http.ResponseWriter, r *http.Request, loc *i18n.Loc } next := *current + next.Slug = strings.TrimSpace(r.PostFormValue("slug")) next.Title = strings.TrimSpace(r.PostFormValue("title")) next.Headline = strings.TrimSpace(r.PostFormValue("headline")) next.Domain = strings.TrimSpace(r.PostFormValue("domain")) next.MediaDomain = strings.TrimSpace(r.PostFormValue("media_domain")) next.HomePage = strings.TrimSpace(r.PostFormValue("home_page")) - next.Icon = strings.TrimSpace(r.PostFormValue("icon")) - next.AuthIcon = strings.TrimSpace(r.PostFormValue("auth_icon")) + next.Icon, err = h.pickIcon(r, "icon", current.Icon, siteIcons) + if err != nil { + return h.iconProblem(w, r, loc, err) + } + next.AuthIcon, err = h.pickIcon(r, "auth_icon", current.AuthIcon, siteIcons) + if err != nil { + return h.iconProblem(w, r, loc, err) + } next.FooterLicense = r.PostFormValue("footer_license") next.SignupNotice = r.PostFormValue("signup_notice") next.PasswordHelp = r.PostFormValue("password_help") @@ -117,6 +124,7 @@ func (h *Handler) saveSite(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if err := h.deps.DB.SaveSite(ctx, &next, settings, granted.Has(perms.ManagePermissions)); err != nil { return err } + h.note(r, db.AdminChanged, siteSlug, "", next.Title) redirect(w, Prefix+siteSlug+"/") return nil } diff --git a/internal/admin/suspicious.go b/internal/admin/suspicious.go new file mode 100644 index 00000000..8188b44d --- /dev/null +++ b/internal/admin/suspicious.go @@ -0,0 +1,65 @@ +package admin + +import ( + "net/http" + "strconv" + + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" +) + +const suspiciousSlug = "suspicious" + +func init() { + register(screen{slug: suspiciousSlug, label: "admin.suspicious", need: perms.ViewSensitiveInfo, serve: (*Handler).suspicious}) +} + +func (h *Handler) suspicious(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + if r.Method == http.MethodPost { + return h.clearAddresses(w, r, loc) + } + if r.Method != http.MethodGet && r.Method != http.MethodHead { + w.Header().Set("Allow", "GET, HEAD, POST") + http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) + return nil + } + return h.suspiciousScreen(w, r, loc, 0) +} + +func (h *Handler) suspiciousScreen(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, cleared int64) error { + total, err := h.deps.DB.AddressCount(r.Context()) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.suspicious"), "suspicious.html", map[string]any{ + "Total": total, + "Cleared": cleared, + "CSRF": csrf.Issue(w, r), + "Action": Prefix + suspiciousSlug + "/", + }) +} + +func (h *Handler) clearAddresses(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + if !h.verified(w, r) { + return nil + } + if r.PostFormValue("confirm") == "" { + return h.suspiciousScreen(w, r, loc, 0) + } + var only *int64 + if raw := r.PostFormValue("user"); raw != "" { + id, err := strconv.ParseInt(raw, 10, 64) + if err != nil { + return h.suspiciousScreen(w, r, loc, 0) + } + only = &id + } + gone, err := h.deps.DB.ClearAddresses(r.Context(), only) + if err != nil { + return err + } + h.note(r, db.AdminDeleted, suspiciousSlug, "", strconv.FormatInt(gone, 10)) + return h.suspiciousScreen(w, r, loc, gone) +} diff --git a/internal/admin/tag.go b/internal/admin/tag.go index dc888ede..20ad4902 100644 --- a/internal/admin/tag.go +++ b/internal/admin/tag.go @@ -46,15 +46,21 @@ func (h *Handler) tags(w http.ResponseWriter, r *http.Request, loc *i18n.Localiz if err := h.deps.DB.DeleteTag(ctx, row.ID); err != nil { return err } + h.noteID(r, db.AdminDeleted, tagSlug, row.ID, row.Name) redirect(w, Prefix+tagSlug+"/") return nil } if row.Name == "" { return h.tagForm(w, r, loc, rest, loc.T("admin.tag-no-name")) } + did := db.AdminChanged + if row.ID == 0 { + did = db.AdminCreated + } if err := h.deps.DB.SaveTag(ctx, row); err != nil { return err } + h.noteID(r, did, tagSlug, row.ID, row.Name) redirect(w, Prefix+tagSlug+"/") return nil } @@ -141,6 +147,7 @@ func (h *Handler) tagCategories(w http.ResponseWriter, r *http.Request, loc *i18 if err := h.deps.DB.DeleteTagCategory(ctx, row.ID); err != nil { return err } + h.noteID(r, db.AdminDeleted, tagCategorySlug, row.ID, row.Name) redirect(w, Prefix+tagCategorySlug+"/") return nil } @@ -150,9 +157,14 @@ func (h *Handler) tagCategories(w http.ResponseWriter, r *http.Request, loc *i18 if !slugPattern.MatchString(row.Slug) { return h.tagCategoryForm(w, r, loc, rest, loc.T("admin.tag-bad-slug")) } + did := db.AdminChanged + if row.ID == 0 { + did = db.AdminCreated + } if err := h.deps.DB.SaveTagCategory(ctx, row); err != nil { return err } + h.noteID(r, did, tagCategorySlug, row.ID, row.Name) redirect(w, Prefix+tagCategorySlug+"/") return nil } diff --git a/internal/admin/templates/action_log.html b/internal/admin/templates/action_log.html deleted file mode 100644 index 2bc87a6d..00000000 --- a/internal/admin/templates/action_log.html +++ /dev/null @@ -1,33 +0,0 @@ -{{define "action_log.html"}} -
    -
    - - -
    -

    {{.Total}}

    - - {{if .SeeIP}}{{end}} - - {{range .Entries}} - - - - - {{if $.SeeIP}}{{end}} - - - {{end}} - -
    usertypewhenipmeta
    {{if .User}}{{esc .User}}{{else}}{{esc .Stale}}{{end}}{{esc .Type}}{{.CreatedAt.Format "2006-01-02 15:04"}}{{esc .OriginIP}}{{esc .Meta}}
    - {{if gt .Pages 1}} -

    - {{if gt .Page 1}}prev{{end}} - {{.Page}} / {{.Pages}} - {{if lt .Page .Pages}}next{{end}} -

    - {{end}} -
    -{{end}} diff --git a/internal/admin/templates/admin_log.html b/internal/admin/templates/admin_log.html new file mode 100644 index 00000000..c238723b --- /dev/null +++ b/internal/admin/templates/admin_log.html @@ -0,0 +1,32 @@ +{{define "admin_log.html"}} + + + + {{range .Notes}} + + + + + {{else}} + + {{end}} + +
    {{.CreatedAt.Format "2006-01-02"}}
    {{.CreatedAt.Format "15:04:05"}}    		 + {{if .User}}{{esc .User}}{{else if .Stale}}{{esc .Stale}}{{else}}—{{end}} + {{enum "admin.did-" .Action}} +
    {{screen .Screen}}{{if .Label}} · {{esc .Label}}{{end}}
    + {{if .Target}}
    #{{esc .Target}}
    {{end}} +
    {{t "admin.empty"}}
    + +{{end}} diff --git a/internal/admin/templates/dashboard.html b/internal/admin/templates/dashboard.html new file mode 100644 index 00000000..e07fe29c --- /dev/null +++ b/internal/admin/templates/dashboard.html @@ -0,0 +1,111 @@ +{{define "dashboard.html"}} +
    + +
    +
    +
    +
    {{t "admin.dash-site"}}
    + {{if .MaySite}}{{t "admin.settings"}}{{end}} +
    +
    + + + + + + + + + + + + + + +
    {{t "admin.f-site-title"}}{{esc .Site.Title}}
    {{t "admin.f-site-slug"}}{{esc .Site.Slug}}
    {{t "admin.f-domain"}}{{esc .Site.Domain}}
    {{t "admin.f-media-domain"}}{{esc .Site.MediaDomain}}
    {{t "admin.f-home-page"}}{{esc .Site.HomePage}}
    {{t "admin.f-rating-mode"}}{{enum "admin.rating-" .Settings.RatingMode}}
    {{t "admin.f-user-tags"}}{{enum "admin.tagmode-" .Settings.CreateTags}}
    {{t "admin.f-membership-password"}}{{if .Site.MembershipPasswordEnabled}}{{t "admin.on"}}{{else}}{{t "admin.off"}}{{end}}
    +
    +
    +
    + +
    +
    +
    {{t "admin.dash-queue"}}
    +
    + + + {{range .Queue}} + + + + + {{else}} + + {{end}} + +
    {{esc .Label}}{{.Count}}
    {{t "admin.queue-none"}}
    +
    +
    +
    + +
    + +
    + +
    +
    +
    +
    {{t "admin.dash-changes"}}
    +
    +
    +
    + + + {{range .Changes}} + + + + + {{else}} + + {{end}} + +
    {{.CreatedAt.Format "2006-01-02"}}
    {{.CreatedAt.Format "15:04:05"}}    		 + {{if .User}}{{esc .User}}{{else}}—{{end}} + {{range .Flags}}{{esc .Desc}}{{end}} + + {{if .Comment}}
    {{esc .Comment}}
    {{end}} +
    {{t "admin.empty"}}
    +
    +
    +
    +
    + +
    + {{if .Actions}} +
    +
    +
    {{t "admin.dash-actions"}}
    + {{t "admin.view-all"}} +
    +
    + + + {{range .Actions}} + + + + + {{end}} + +
    {{.CreatedAt.Format "2006-01-02"}}
    {{.CreatedAt.Format "15:04:05"}}    		 + {{if .User}}{{esc .User}}{{else}}—{{end}} + {{enum "admin.did-" .Action}} +
    {{screen .Screen}}{{if .Label}} · {{esc .Label}}{{end}}
    +
    +
    +
    + {{end}} +
    + +
    +{{end}} diff --git a/internal/admin/templates/forum_category_form.html b/internal/admin/templates/forum_category_form.html index 0b494c00..60ead482 100644 --- a/internal/admin/templates/forum_category_form.html +++ b/internal/admin/templates/forum_category_form.html @@ -1,21 +1,24 @@ {{define "forum_category_form.html"}} -
    +{{template "form_error" .Error}} + - {{if .Error}}
    ERR{{esc .Error}}
    {{end}} - {{template "admin_text" dict "n" "name" "v" .Category.Name}} - {{template "admin_area" dict "n" "description" "v" .Category.Description}} -
    - - -
    -
    -
    -
    - - {{if .Category.ID}}{{end}} - back +
    +
    {{t "admin.forum-categories"}}
    +
    + {{template "row_text" dict "n" "name" "k" "admin.f-name" "v" .Category.Name "w" "narrow-4"}} + {{template "row_area" dict "n" "description" "k" "admin.f-description" "v" .Category.Description}} +
    + +
    + +
    +
    + {{template "row_number" dict "n" "order" "k" "admin.f-order" "v" .Category.Order}} + {{template "row_check" dict "n" "is_for_comments" "k" "admin.f-for-comments" "l" "admin.l-for-comments" "v" .Category.IsForComments}} + {{template "save_row" dict "back" .Back "del" .Category.ID}} +
    {{end}} diff --git a/internal/admin/templates/forum_category_list.html b/internal/admin/templates/forum_category_list.html index 2f7efc3d..998ff818 100644 --- a/internal/admin/templates/forum_category_list.html +++ b/internal/admin/templates/forum_category_list.html @@ -1,19 +1,21 @@ {{define "forum_category_list.html"}} -
    -

    +

    - - - - {{range .Categories}} - - - - - - - - {{end}} - -
    namesectionordercommentsthreads
    {{esc .Name}}{{esc .SectionName}}{{.Order}}{{if .IsForComments}}yes{{end}}{{.Threads}}
    +
    +
    {{t "admin.new-category"}}
    + + + + {{range .Categories}} + + + + + + + + {{else}} + + {{end}} + +
    {{t "admin.f-name"}}{{t "admin.f-section"}}{{t "admin.f-order"}}{{t "admin.f-for-comments"}}{{t "admin.f-threads"}}
    {{esc .Name}}{{esc .SectionName}}{{.Order}}{{template "yes" .IsForComments}}{{.Threads}}
    {{t "admin.empty"}}
    {{end}} diff --git a/internal/admin/templates/forum_posts.html b/internal/admin/templates/forum_posts.html new file mode 100644 index 00000000..14e09b90 --- /dev/null +++ b/internal/admin/templates/forum_posts.html @@ -0,0 +1,30 @@ +{{define "forum_posts.html"}} + + + + {{range .Posts}} + + + + + {{else}} + + {{end}} + +
    {{.CreatedAt.Format "2006-01-02"}}
    {{.CreatedAt.Format "15:04:05"}}    		 + {{if .Author}}{{esc .Author}}{{else}}—{{end}} + {{if .Category}}{{esc .Category}}{{end}} + + {{if .Name}}
    {{esc .Thread}}
    {{end}} +
    {{t "admin.empty"}}
    + +{{end}} diff --git a/internal/admin/templates/forum_section_form.html b/internal/admin/templates/forum_section_form.html index 789522ca..ff9979f5 100644 --- a/internal/admin/templates/forum_section_form.html +++ b/internal/admin/templates/forum_section_form.html @@ -1,16 +1,17 @@ {{define "forum_section_form.html"}} -
    +{{template "form_error" .Error}} + - {{if .Error}}
    ERR{{esc .Error}}
    {{end}} - {{template "admin_text" dict "n" "name" "v" .Section.Name}} - {{template "admin_area" dict "n" "description" "v" .Section.Description}} -
    -
    -
    -
    - - {{if .Section.ID}}{{end}} - back +
    +
    {{t "admin.forum-sections"}}
    +
    + {{template "row_text" dict "n" "name" "k" "admin.f-name" "v" .Section.Name "w" "narrow-4"}} + {{template "row_area" dict "n" "description" "k" "admin.f-description" "v" .Section.Description}} + {{template "row_number" dict "n" "order" "k" "admin.f-order" "v" .Section.Order}} + {{template "row_check" dict "n" "is_hidden" "k" "admin.f-hidden" "l" "admin.l-section-hidden" "v" .Section.IsHidden}} + {{template "row_check" dict "n" "is_hidden_for_users" "k" "admin.f-staff-only" "l" "admin.l-section-staff-only" "v" .Section.IsHiddenForUser}} + {{template "save_row" dict "back" .Back "del" .Section.ID}} +
    {{end}} diff --git a/internal/admin/templates/forum_section_list.html b/internal/admin/templates/forum_section_list.html index b3a488c8..e055ee9b 100644 --- a/internal/admin/templates/forum_section_list.html +++ b/internal/admin/templates/forum_section_list.html @@ -1,18 +1,20 @@ {{define "forum_section_list.html"}} -
    -

    +

    - - - - {{range .Sections}} - - - - - - - {{end}} - -
    nameorderhiddencategories
    {{esc .Name}}{{.Order}}{{if .IsHidden}}yes{{end}}{{.Categories}}
    +
    +
    {{t "admin.new-section"}}
    + + + + {{range .Sections}} + + + + + + + {{else}} + + {{end}} + +
    {{t "admin.f-name"}}{{t "admin.f-order"}}{{t "admin.f-hidden"}}{{t "admin.f-categories"}}
    {{esc .Name}}{{.Order}}{{template "yes" .IsHidden}}{{.Categories}}
    {{t "admin.empty"}}
    {{end}} diff --git a/internal/admin/templates/index.html b/internal/admin/templates/index.html deleted file mode 100644 index a10dc19f..00000000 --- a/internal/admin/templates/index.html +++ /dev/null @@ -1,9 +0,0 @@ -{{define "index.html"}} -
    - -
    -{{end}} diff --git a/internal/admin/templates/invite_list.html b/internal/admin/templates/invite_list.html index 53aa4066..1bf83943 100644 --- a/internal/admin/templates/invite_list.html +++ b/internal/admin/templates/invite_list.html @@ -1,32 +1,36 @@ {{define "invite_list.html"}} -
    -

    {{.Total}}

    - - - - {{range .Invites}} - - - - - - - - {{end}} - -
    kindtocreatedactivated
    {{esc .Kind}}{{if .Email}}{{esc .Email}}{{else}}{{esc .WikidotUsername}}{{end}}{{.CreatedAt.Format "2006-01-02 15:04"}}{{if .ActivatedAt}}{{esc .ActivatedUsername}}{{end}}{{if not .ActivatedAt}} -
    - - - -
    - {{end}}
    - {{if gt .Pages 1}} -

    - {{if gt .Page 1}}prev{{end}} - {{.Page}} / {{.Pages}} - {{if lt .Page .Pages}}next{{end}} -

    - {{end}} -
    +

    {{t "admin.count" "n" .Total}}

    + + + + + + + + + + + + {{range .Invites}} + + + + + + + + {{else}} + + {{end}} + +
    {{t "admin.f-invite-kind"}}{{t "admin.f-invite-to"}}{{t "admin.f-created"}}{{t "admin.f-activated"}}
    {{enum "admin.invite-kind-" .Kind}}{{if .Email}}{{esc .Email}}{{else if .WikidotUsername}}{{esc .WikidotUsername}}{{else}}—{{end}}{{.CreatedAt.Format "2006-01-02 15:04"}}{{if .ActivatedAt}}{{esc .ActivatedUsername}}{{else}}{{t "admin.invite-open"}}{{end}} + {{if not .ActivatedAt}} +
    + + + +
    + {{end}} +
    {{t "admin.empty"}}
    +{{template "pager" dict "Base" (printf "%s?" .Action) "Page" .Page "Pages" .Pages}} {{end}} diff --git a/internal/admin/templates/layout.html b/internal/admin/templates/layout.html new file mode 100644 index 00000000..c50a3805 --- /dev/null +++ b/internal/admin/templates/layout.html @@ -0,0 +1,81 @@ +{{define "layout.html"}} +
    + + + +
    +
    + +
    +
    + +
    + +
    + + {{range .Groups}} + + {{end}} + +
    +
    + +
    +

    {{esc .Title}}

    + {{.Body}} +
    + +
    +
    +
    + +{{end}} diff --git a/internal/admin/templates/page_category_form.html b/internal/admin/templates/page_category_form.html index 5ffbb010..eeff7dec 100644 --- a/internal/admin/templates/page_category_form.html +++ b/internal/admin/templates/page_category_form.html @@ -1,48 +1,72 @@ {{define "page_category_form.html"}} -
    +{{template "form_error" .Error}} + - {{if .Error}}
    ERR{{esc .Error}}
    {{end}} - {{template "admin_text" dict "n" "name" "v" .Category.Name}} -
    -
    - - -
    -
    - - + +
    +
    {{t "admin.page-categories"}}
    +
    + {{template "row_text" dict "n" "name" "k" "admin.f-name" "v" .Category.Name "w" "narrow-4"}} + {{template "row_check" dict "n" "is_indexed" "k" "admin.f-indexed" "l" "admin.l-indexed" "v" .Category.IsIndexed}} +
    + +
    + +
    +
    +
    + +
    + +
    +
    +
    {{if .MayGrant}} {{range .Cells}} {{$rid := .Role.ID}} -
    - - - - - {{range .Grants}} - - - - - - - {{end}} - -
    permissionallowdenyinherit
    {{esc .Name}}
    -
    +
    +
    {{esc .Role.Label}}
    +
    +
    + {{t "admin.f-override"}} +
    + +
    +
    + + + + + + + + + + + {{range .Grants}} + + {{range .Rows}} + + + + + + + {{end}} + {{end}} + +
    {{t "admin.f-permission"}}{{t "admin.perm-allow"}}{{t "admin.perm-inherit"}}{{t "admin.perm-deny"}}
    {{if .Key}}{{t (printf "admin.perm-group-%s" .Key)}}{{else}}{{t "admin.perm-group-other"}}{{end}}
    {{enum "admin.perm-" .Name}}{{esc .Name}}
    +
    +
    {{end}} {{end}} -
    - - {{if .Category.ID}}{{end}} - back -
    + {{template "save_row" dict "back" .Back "del" .Category.ID}} {{end}} diff --git a/internal/admin/templates/page_category_list.html b/internal/admin/templates/page_category_list.html index 2a7923ad..a03a2b34 100644 --- a/internal/admin/templates/page_category_list.html +++ b/internal/admin/templates/page_category_list.html @@ -1,13 +1,19 @@ {{define "page_category_list.html"}} -
    -

    +

    - - - - {{range .Categories}} - - {{end}} - -
    nameindexedarticles
    {{esc .Name}}{{if .IsIndexed}}yes{{end}}{{.Articles}}
    +
    +
    {{t "admin.new-category"}}
    + + + + {{range .Categories}} + + + + + + {{else}} + + {{end}} + +
    {{t "admin.f-name"}}{{t "admin.f-indexed"}}{{t "admin.f-articles"}}
    {{esc .Name}}{{template "yes" .IsIndexed}}{{.Articles}}
    {{t "admin.empty"}}
    {{end}} diff --git a/internal/admin/templates/page_confirm.html b/internal/admin/templates/page_confirm.html new file mode 100644 index 00000000..9661fd8b --- /dev/null +++ b/internal/admin/templates/page_confirm.html @@ -0,0 +1,20 @@ +{{define "page_confirm.html"}} +
    +

    + {{if eq .What "delete"}}{{t "admin.confirm-delete" "n" (len .Picked)}}{{else}}{{t "admin.confirm-revert" "n" (len .Picked) "steps" .Steps}}{{end}} +

    +

    {{if eq .What "delete"}}{{t "admin.warn-delete"}}{{else}}{{t "admin.warn-revert"}}{{end}}

    +
      + {{range .Picked}}
    • {{esc .FullName}}
      • {{end}} +
    +
    + + + + + {{range .Picked}}{{end}} + + {{t "admin.cancel"}} +
    +
    +{{end}} diff --git a/internal/admin/templates/page_done.html b/internal/admin/templates/page_done.html new file mode 100644 index 00000000..5c67bfe8 --- /dev/null +++ b/internal/admin/templates/page_done.html @@ -0,0 +1,14 @@ +{{define "page_done.html"}} + + + + {{range .Results}} + + + + + {{end}} + +
    {{t "admin.f-page"}}{{t "admin.f-result"}}
    {{esc .Full}}{{if .Problem}}{{esc .Problem}}{{else}}{{t "admin.done"}}{{end}}
    +
    {{t "admin.back-to-list"}}
    +{{end}} diff --git a/internal/admin/templates/page_edit.html b/internal/admin/templates/page_edit.html new file mode 100644 index 00000000..e6af988f --- /dev/null +++ b/internal/admin/templates/page_edit.html @@ -0,0 +1,38 @@ +{{define "page_edit.html"}} +{{template "form_error" .Error}} + +
    +
    {{t "admin.page-source"}}
    +
    +
    + + {{template "row_static" dict "k" "admin.f-page" "v" .Full}} + {{template "row_static" dict "k" "admin.f-revisions" "v" (printf "#%d" .Head)}} + {{template "row_text" dict "n" "title" "k" "admin.f-title" "v" .Article.Title "w" "narrow-5"}} +
    + +
    +
    +
    + + {{t "admin.back-to-list"}} + {{t "admin.open-page"}} +
    +
    +
    +
    + +
    +
    {{t "admin.rename"}}
    +
    +
    + + + {{template "row_text" dict "n" "full_name" "k" "admin.f-new-name" "v" .Full "w" "narrow-5" "h" "admin.h-rename"}} +
    + +
    +
    +
    +
    +{{end}} diff --git a/internal/admin/templates/page_list.html b/internal/admin/templates/page_list.html new file mode 100644 index 00000000..4d8d5952 --- /dev/null +++ b/internal/admin/templates/page_list.html @@ -0,0 +1,63 @@ +{{define "page_list.html"}} +{{template "form_error" .Error}} +
    +
    + + + +
    +
    + + + +

    {{t "admin.count" "n" .Total}}

    + +
    + + + + + + + + + + + + + + {{range .Pages}} + + + + + + + + + {{else}} + + {{end}} + +
    {{t "admin.f-page"}}{{t "admin.f-title"}}{{t "admin.f-revisions"}}{{t "admin.f-updated"}}
    {{esc .FullName}}{{if .Title}}{{esc .Title}}{{else}}—{{end}}{{.Revisions}}{{.UpdatedAt.Format "2006-01-02 15:04"}}{{t "admin.edit"}}
    {{t "admin.empty"}}
    + +
    + {{t "admin.batch"}} + + + + + {{t "admin.h-steps"}} + +
    +
    + +{{template "pager" dict "Base" (printf "%s?q=%s&c=%s&" .Action (urlq .Query) (urlq .Category)) "Page" .Page "Pages" .Pages_}} +{{end}} diff --git a/internal/admin/templates/parts.html b/internal/admin/templates/parts.html new file mode 100644 index 00000000..f975f04a --- /dev/null +++ b/internal/admin/templates/parts.html @@ -0,0 +1,92 @@ +{{define "form_error"}}{{if .}}
    {{esc .}}
    {{end}}{{end}} + +{{define "row_text"}} +
    + +
    + + {{if .h}}{{t .h}}{{end}} +
    +
    +{{end}} + +{{define "row_area"}} +
    + +
    + + {{if .h}}{{t .h}}{{end}} +
    +
    +{{end}} + +{{define "row_number"}} +
    + +
    +
    +{{end}} + +{{define "row_check"}} +
    + {{t .k}} +
    + + {{if .h}}{{t .h}}{{end}} +
    +
    +{{end}} + +{{define "row_static"}} +
    + {{t .k}} +
    {{if .v}}{{esc .v}}{{else}}—{{end}}
    +
    +{{end}} + +{{define "row_pre"}} +
    + {{t .k}} + 
    {{esc .v}}
    +
    +{{end}} + +{{define "yes"}}{{if .}}{{t "admin.yes"}}{{end}}{{end}} + +{{define "pager"}} +{{if gt .Pages 1}} + +{{end}} +{{end}} + +{{define "save_row"}} +
    + + {{if .back}}{{t "admin.back-to-list"}}{{end}} + {{if .del}}{{end}} +
    +{{end}} + +{{define "row_image"}} +
    + +
    +
    + {{if .v}}{{end}} + +
    + {{if .v}} + + {{esc .v}} + {{end}} + {{if .h}}{{t .h}}{{end}} +
    +
    +{{end}} diff --git a/internal/admin/templates/report_form.html b/internal/admin/templates/report_form.html index 4e103a0a..cbe44334 100644 --- a/internal/admin/templates/report_form.html +++ b/internal/admin/templates/report_form.html @@ -1,30 +1,34 @@ {{define "report_form.html"}} -
    +{{template "form_error" .Error}} + - {{if .Error}}
    ERR{{esc .Error}}
    {{end}} -
    reporter{{esc .Report.Reporter}}
    -
    reported{{esc .Report.Reported}}
    -
    created{{.Report.CreatedAt.Format "2006-01-02 15:04"}}
    -
    reason
    {{esc .Report.Reason}}
    - {{if .SeeAll}} -
    messages
    {{esc .Report.Messages}}
    - {{end}} - {{if .Report.ReviewedBy}} -
    reviewed by{{esc .Report.ReviewedBy}}
    - {{end}} - -
    - - +
    +
    {{t "admin.report-content"}}
    +
    + {{template "row_static" dict "k" "admin.f-reporter" "v" .Report.Reporter}} + {{template "row_static" dict "k" "admin.f-reported" "v" .Report.Reported}} + {{template "row_static" dict "k" "admin.f-created" "v" (.Report.CreatedAt.Format "2006-01-02 15:04")}} + {{template "row_pre" dict "k" "admin.f-reason" "v" .Report.Reason}} + {{if .SeeAll}}{{template "row_pre" dict "k" "admin.f-messages" "v" .Report.Messages}}{{end}} +
    - {{template "admin_area" dict "n" "admin_notes" "v" .Report.AdminNotes}} -
    - - back +
    +
    {{t "admin.review"}}
    +
    +
    + +
    + +
    +
    + {{template "row_area" dict "n" "admin_notes" "k" "admin.f-admin-notes" "v" .Report.AdminNotes}} + {{if .Report.ReviewedBy}}{{template "row_static" dict "k" "admin.f-reviewed-by" "v" .Report.ReviewedBy}}{{end}} + {{template "save_row" dict "back" .Back}} +
    {{end}} diff --git a/internal/admin/templates/report_list.html b/internal/admin/templates/report_list.html index 478cb811..acae1556 100644 --- a/internal/admin/templates/report_list.html +++ b/internal/admin/templates/report_list.html @@ -1,33 +1,28 @@ {{define "report_list.html"}} -
    -
    - - -
    -

    {{.Total}}

    - - - - {{range .Reports}} - - - - - - - - {{end}} - -
    idreporterreportedstatuscreated
    {{.ID}}{{esc .Reporter}}{{esc .Reported}}{{esc .Status}}{{.CreatedAt.Format "2006-01-02 15:04"}}
    - {{if gt .Pages 1}} -

    - {{if gt .Page 1}}prev{{end}} - {{.Page}} / {{.Pages}} - {{if lt .Page .Pages}}next{{end}} -

    +
    +
+

{{t "admin.count" "n" .Total}}

+ + + + + + {{range .Reports}} + + + + + + + + {{else}} + + {{end}} + +
{{t "admin.f-id"}}{{t "admin.f-reporter"}}{{t "admin.f-reported"}}{{t "admin.f-status"}}{{t "admin.f-created"}}
#{{.ID}}{{esc .Reporter}}{{esc .Reported}}{{enum "admin.report-status-" .Status}}{{.CreatedAt.Format "2006-01-02 15:04"}}
{{t "admin.empty"}}
+{{template "pager" dict "Base" (printf "%s?status=%s&" .Action (urlq .Status)) "Page" .Page "Pages" .Pages}} {{end}} diff --git a/internal/admin/templates/role_category.html b/internal/admin/templates/role_category.html index 0b235e89..627657fc 100644 --- a/internal/admin/templates/role_category.html +++ b/internal/admin/templates/role_category.html @@ -1,35 +1,34 @@ {{define "role_category.html"}} -
- {{if .Error}}
ERR{{esc .Error}}
{{end}} - - - - {{range .Categories}} - - - - - - {{end}} - - - - - -
nameroles
-
- - - - - {{if not .Roles}}{{end}} -
- 		{{.Roles}}
-
- - - -
-
-
+{{template "form_error" .Error}} + + + + {{range .Categories}} + + + + + + {{end}} + + + + + + +
{{t "admin.f-name"}}{{t "admin.f-roles"}}
+
+ + + + + {{if not .Roles}}{{end}} +
+ 		{{.Roles}}
+
+ + + +
+
{{end}} diff --git a/internal/admin/templates/role_form.html b/internal/admin/templates/role_form.html index c504160d..2694e499 100644 --- a/internal/admin/templates/role_form.html +++ b/internal/admin/templates/role_form.html @@ -1,67 +1,109 @@ {{define "role_form.html"}} -
+{{template "form_error" .Error}} + - {{if .Error}}
ERR{{esc .Error}}
{{end}} -
- - +
+
{{t "admin.role-basics"}}
+
+ {{template "row_text" dict "n" "name" "k" "admin.f-name" "v" .Role.Name "w" "narrow-4"}} + {{template "row_text" dict "n" "short_name" "k" "admin.f-short-name" "v" .Role.ShortName "w" "narrow-3"}} +
+ +
+ + {{if .Builtin}}{{t "admin.h-builtin-slug"}}{{end}} +
+
+
+ +
+ +
+
+ {{template "row_number" dict "n" "index" "k" "admin.f-order" "v" .Role.Index}} + {{template "row_check" dict "n" "is_staff" "k" "admin.f-is-staff" "l" "admin.l-is-staff" "v" .Role.IsStaff}} +
- {{template "admin_text" dict "n" "name" "v" .Role.Name}} - {{template "admin_text" dict "n" "short_name" "v" .Role.ShortName}} -
- - -
-
- - -
-
-
- {{template "admin_text" dict "n" "votes_title" "v" .Role.VotesTitle}} -
- - + +
+
{{t "admin.role-votes"}}
+
+ {{template "row_check" dict "n" "group_votes" "k" "admin.f-group-votes" "l" "admin.l-group-votes" "v" .Role.GroupVotes}} + {{template "row_text" dict "n" "votes_title" "k" "admin.f-votes-title" "v" .Role.VotesTitle "w" "narrow-3"}} +
-
- - + +
+
{{t "admin.role-badge"}}
+
+
+ {{t "admin.f-preview"}} +
+ {{if .Role.BadgeText}}{{esc .Role.BadgeText}}{{else}}{{esc .Role.Slug}}{{end}} + {{t "admin.h-badge-preview"}} +
+
+
+ +
+ +
+
+
+ +
+ +
+
+ {{template "row_text" dict "n" "badge_text" "k" "admin.f-badge-text" "v" .Role.BadgeText "w" "narrow-3" "h" "admin.h-badge-text"}} + {{template "row_text" dict "n" "badge_bg" "k" "admin.f-badge-bg" "v" .Role.BadgeBg "w" "narrow-2"}} + {{template "row_text" dict "n" "badge_text_color" "k" "admin.f-badge-text-color" "v" .Role.BadgeTextColor "w" "narrow-2"}} + {{template "row_check" dict "n" "badge_show_border" "k" "admin.f-badge-border" "l" "admin.l-badge-border" "v" .Role.BadgeShowBorder}} + {{template "row_text" dict "n" "color" "k" "admin.f-icon-color" "v" .Role.Color "w" "narrow-2" "h" "admin.h-icon-color"}} + {{template "row_image" dict "n" "icon" "k" "admin.f-icon" "v" .Role.Icon "h" "admin.h-icon" "accept" ".svg,image/svg+xml"}} +
- {{template "admin_text" dict "n" "color" "v" .Role.Color}} - {{template "admin_text" dict "n" "icon" "v" .Role.Icon}} - {{template "admin_text" dict "n" "badge_text" "v" .Role.BadgeText}} - {{template "admin_text" dict "n" "badge_bg" "v" .Role.BadgeBg}} - {{template "admin_text" dict "n" "badge_text_color" "v" .Role.BadgeTextColor}} -
{{if .MayGrant}} - - - - {{range .Grants}} - - - - - - - {{end}} - -
permissionallowdenyinherit
{{esc .Name}}
+
+
{{t "admin.permissions"}}
+
+

{{t "admin.h-permissions"}}

+ + + + + + + + + + + {{range .Grants}} + + {{range .Rows}} + + + + + + + {{end}} + {{end}} + +
{{t "admin.f-permission"}}{{t "admin.perm-allow"}}{{t "admin.perm-inherit"}}{{t "admin.perm-deny"}}
{{if .Key}}{{t (printf "admin.perm-group-%s" .Key)}}{{else}}{{t "admin.perm-group-other"}}{{end}}
{{enum "admin.perm-" .Name}}{{esc .Name}}
+
+
{{end}} -
- - {{if and .Role.ID (not .Builtin)}}{{end}} - back -
+ {{template "save_row" dict "back" .Back "del" (and .Role.ID (not .Builtin))}} {{end}} diff --git a/internal/admin/templates/role_list.html b/internal/admin/templates/role_list.html index ee0b3ca1..490be83f 100644 --- a/internal/admin/templates/role_list.html +++ b/internal/admin/templates/role_list.html @@ -1,19 +1,21 @@ {{define "role_list.html"}} -
-

+

- - - - {{range .Roles}} - - - - - - - - {{end}} - -
roleslugindexstaffusers
{{if .Name}}{{esc .Name}}{{else}}{{esc .Slug}}{{end}}{{esc .Slug}}{{.Index}}{{if .IsStaff}}yes{{end}}{{.Users}}
+
+
{{t "admin.new-role"}}
+ + + + {{range .Roles}} + + + + + + + + {{else}} + + {{end}} + +
{{t "admin.f-role"}}{{t "admin.f-slug"}}{{t "admin.f-order"}}{{t "admin.f-is-staff"}}{{t "admin.f-users"}}
{{if .Name}}{{esc .Name}}{{else}}{{esc .Slug}}{{end}}{{esc .Slug}}{{.Index}}{{template "yes" .IsStaff}}{{.Users}}
{{t "admin.empty"}}
{{end}} diff --git a/internal/admin/templates/site_form.html b/internal/admin/templates/site_form.html index 7659b1e2..e829e0a0 100644 --- a/internal/admin/templates/site_form.html +++ b/internal/admin/templates/site_form.html @@ -1,100 +1,129 @@ {{define "site_form.html"}} -
+{{template "form_error" .Error}} + - {{if .Error}}
ERR{{esc .Error}}
{{end}} - {{template "admin_text" dict "n" "slug" "v" .Site.Slug}} - {{template "admin_text" dict "n" "title" "v" .Site.Title}} - {{template "admin_text" dict "n" "headline" "v" .Site.Headline}} - {{template "admin_text" dict "n" "domain" "v" .Site.Domain}} - {{template "admin_text" dict "n" "media_domain" "v" .Site.MediaDomain}} - {{template "admin_text" dict "n" "home_page" "v" .Site.HomePage}} - -
- - -
-
- - +
+
{{t "admin.site-identity"}}
+
+ {{template "row_text" dict "n" "title" "k" "admin.f-site-title" "v" .Site.Title "w" "narrow-5"}} + {{template "row_text" dict "n" "headline" "k" "admin.f-headline" "v" .Site.Headline "w" "narrow-5"}} + {{template "row_text" dict "n" "slug" "k" "admin.f-site-slug" "v" .Site.Slug "w" "narrow-3"}} + {{template "row_text" dict "n" "domain" "k" "admin.f-domain" "v" .Site.Domain "w" "narrow-4"}} + {{template "row_text" dict "n" "media_domain" "k" "admin.f-media-domain" "v" .Site.MediaDomain "w" "narrow-4" "h" "admin.h-media-domain"}} + {{template "row_text" dict "n" "home_page" "k" "admin.f-home-page" "v" .Site.HomePage "w" "narrow-3"}} +
- {{template "admin_text" dict "n" "icon" "v" .Site.Icon}} - {{template "admin_text" dict "n" "auth_icon" "v" .Site.AuthIcon}} - {{template "admin_area" dict "n" "footer_license" "v" .Site.FooterLicense}} - {{template "admin_area" dict "n" "signup_notice" "v" .Site.SignupNotice}} - {{template "admin_area" dict "n" "password_help" "v" .Site.PasswordHelp}} - -
- - +
+
{{t "admin.site-look"}}
+
+
+ +
+ +
+
+
+ +
+ + {{t "admin.h-system-theme"}} +
+
+ {{template "row_image" dict "n" "icon" "k" "admin.f-favicon" "v" .Site.Icon "h" "admin.h-favicon"}} + {{template "row_image" dict "n" "auth_icon" "k" "admin.f-auth-icon" "v" .Site.AuthIcon "h" "admin.h-auth-icon"}} + {{template "row_area" dict "n" "footer_license" "k" "admin.f-footer-license" "v" .Site.FooterLicense "h" "admin.h-footer-license"}} +
-
- - + +
+
{{t "admin.site-content"}}
+
+
+ +
+ +
+
+
+ +
+ +
+
+
-
- - + +
+
{{t "admin.site-accounts"}}
+
+
+ +
+ +
+
+ {{template "row_area" dict "n" "signup_notice" "k" "admin.f-signup-notice" "v" .Site.SignupNotice}} + {{template "row_area" dict "n" "password_help" "k" "admin.f-password-help" "v" .Site.PasswordHelp "h" "admin.h-password-help"}} + {{if .MayGrant}} +
+ +
+ + {{t "admin.h-default-role"}} +
+
+
+ +
+ + {{t "admin.h-verified-role"}} +
+
+ {{end}} +
{{if .MayGrant}} -
- - -
-
- - -
-
- -
- {{template "admin_text" dict "n" "membership_password" "v" .Site.MembershipPassword}} -
- - +
+
{{t "admin.site-membership"}}
+
+ {{template "row_check" dict "n" "membership_password_enabled" "k" "admin.f-membership-password" "l" "admin.l-membership-password" "v" .Site.MembershipPasswordEnabled}} + {{template "row_text" dict "n" "membership_password" "k" "admin.f-password" "v" .Site.MembershipPassword "w" "narrow-3"}} +
+ +
+ +
+
+
{{end}} -
+
+ +
{{end}} - -{{define "admin_text"}} -
- - -
-{{end}} - -{{define "admin_area"}} -
- - -
-{{end}} diff --git a/internal/admin/templates/suspicious.html b/internal/admin/templates/suspicious.html new file mode 100644 index 00000000..61986487 --- /dev/null +++ b/internal/admin/templates/suspicious.html @@ -0,0 +1,19 @@ +{{define "suspicious.html"}} +{{if .Cleared}}
{{t "admin.addresses-cleared" "n" .Cleared}}
{{end}} +
+
+
{{t "admin.suspicious"}}
+ {{t "admin.count" "n" .Total}} +
+
+

{{t "admin.h-suspicious"}}

+
+
+ + + + {{t "admin.h-clear-addresses"}} +
+
+
+{{end}} diff --git a/internal/admin/templates/tag_category_form.html b/internal/admin/templates/tag_category_form.html index e7127c56..ea78fb2e 100644 --- a/internal/admin/templates/tag_category_form.html +++ b/internal/admin/templates/tag_category_form.html @@ -1,15 +1,16 @@ {{define "tag_category_form.html"}} -
+{{template "form_error" .Error}} + - {{if .Error}}
ERR{{esc .Error}}
{{end}} - {{template "admin_text" dict "n" "name" "v" .Category.Name}} - {{template "admin_text" dict "n" "slug" "v" .Category.Slug}} - {{template "admin_area" dict "n" "description" "v" .Category.Description}} -
-
- - {{if .Category.ID}}{{end}} - back +
+
{{t "admin.tag-categories"}}
+
+ {{template "row_text" dict "n" "name" "k" "admin.f-name" "v" .Category.Name "w" "narrow-4"}} + {{template "row_text" dict "n" "slug" "k" "admin.f-slug" "v" .Category.Slug "w" "narrow-3"}} + {{template "row_area" dict "n" "description" "k" "admin.f-description" "v" .Category.Description}} + {{template "row_number" dict "n" "priority" "k" "admin.f-priority" "v" (num .Category.Priority)}} + {{template "save_row" dict "back" .Back "del" .Category.ID}} +
{{end}} diff --git a/internal/admin/templates/tag_category_list.html b/internal/admin/templates/tag_category_list.html index b31fdcd1..fb8d201a 100644 --- a/internal/admin/templates/tag_category_list.html +++ b/internal/admin/templates/tag_category_list.html @@ -1,13 +1,20 @@ {{define "tag_category_list.html"}} -
-

+

- - - - {{range .Categories}} - - {{end}} - -
nameslugprioritytags
{{esc .Name}}{{esc .Slug}}{{num .Priority}}{{.Tags}}
+
+
{{t "admin.new-category"}}
+ + + + {{range .Categories}} + + + + + + + {{else}} + + {{end}} + +
{{t "admin.f-name"}}{{t "admin.f-slug"}}{{t "admin.f-priority"}}{{t "admin.f-tags"}}
{{esc .Name}}{{esc .Slug}}{{num .Priority}}{{.Tags}}
{{t "admin.empty"}}
{{end}} diff --git a/internal/admin/templates/tag_form.html b/internal/admin/templates/tag_form.html index 00043efb..10fe981c 100644 --- a/internal/admin/templates/tag_form.html +++ b/internal/admin/templates/tag_form.html @@ -1,19 +1,22 @@ {{define "tag_form.html"}} -
+{{template "form_error" .Error}} + - {{if .Error}}
ERR{{esc .Error}}
{{end}} - {{template "admin_text" dict "n" "name" "v" .Tag.Name}} -
- - -
-
- - {{if .Tag.ID}}{{end}} - back +
+
{{t "admin.tags"}}
+
+ {{template "row_text" dict "n" "name" "k" "admin.f-name" "v" .Tag.Name "w" "narrow-4"}} +
+ +
+ +
+
+ {{template "save_row" dict "back" .Back "del" .Tag.ID}} +
{{end}} diff --git a/internal/admin/templates/tag_list.html b/internal/admin/templates/tag_list.html index 53cff550..5b36cc50 100644 --- a/internal/admin/templates/tag_list.html +++ b/internal/admin/templates/tag_list.html @@ -1,24 +1,27 @@ {{define "tag_list.html"}} -
-

+

-
- -
-

{{.Total}}

- - - - {{range .Tags}} - - {{end}} - -
tagcategoryarticles
{{esc .Name}}{{esc .CategoryName}}{{.Articles}}
- {{if gt .Pages 1}} -

- {{if gt .Page 1}}prev{{end}} - {{.Page}} / {{.Pages}} - {{if lt .Page .Pages}}next{{end}} -

- {{end}} +
+
{{t "admin.new-tag"}}
+
+
+ + +
+
+

{{t "admin.count" "n" .Total}}

+ + + + {{range .Tags}} + + + + + + {{else}} + + {{end}} + +
{{t "admin.f-tag"}}{{t "admin.f-category"}}{{t "admin.f-articles"}}
{{esc .Name}}{{if .CategoryName}}{{esc .CategoryName}}{{else}}—{{end}}{{.Articles}}
{{t "admin.empty"}}
+{{template "pager" dict "Base" (printf "%s?q=%s&" .Action (urlq .Query)) "Page" .Page "Pages" .Pages}} {{end}} diff --git a/internal/admin/templates/theme_form.html b/internal/admin/templates/theme_form.html index d45c3473..ac719acf 100644 --- a/internal/admin/templates/theme_form.html +++ b/internal/admin/templates/theme_form.html @@ -1,33 +1,24 @@ {{define "theme_form.html"}} -
+{{template "form_error" .Error}} + - {{if .Error}}
ERR{{esc .Error}}
{{end}} -
- - -
-
- - -
-
- - -
-
- - -
-
- - -
-
- - {{if .Theme.ID}}{{end}} - back +
+
{{t "admin.theme-settings"}}
+
+ {{template "row_text" dict "n" "name" "k" "admin.f-name" "v" .Theme.Name "w" "narrow-5"}} + {{template "row_text" dict "n" "slug" "k" "admin.f-slug" "v" .Theme.Slug "w" "narrow-3" "h" "admin.h-theme-slug"}} +
+ +
+ +
+
+ {{template "row_text" dict "n" "external_url" "k" "admin.f-external-url" "v" .Theme.ExternalURL}} + {{template "row_area" dict "n" "css" "k" "admin.f-css" "v" .Theme.CSS "rows" 20}} + {{template "save_row" dict "back" .Back "del" .Theme.ID}} +
{{end}} diff --git a/internal/admin/templates/theme_list.html b/internal/admin/templates/theme_list.html index 10a9f0ec..171e02fc 100644 --- a/internal/admin/templates/theme_list.html +++ b/internal/admin/templates/theme_list.html @@ -1,18 +1,20 @@ {{define "theme_list.html"}} -
-

+

- - - - {{range .Themes}} - - - - - - - {{end}} - -
nameslugmodeupdated
{{esc .Name}}{{esc .Slug}}{{esc .Mode}}{{.UpdatedAt.Format "2006-01-02 15:04"}}
+
+
{{t "admin.new-theme"}}
+ + + + {{range .Themes}} + + + + + + + {{else}} + + {{end}} + +
{{t "admin.f-name"}}{{t "admin.f-slug"}}{{t "admin.f-theme-mode"}}{{t "admin.f-updated"}}
{{esc .Name}}{{esc .Slug}}{{enum "admin.theme-mode-" .Mode}}{{.UpdatedAt.Format "2006-01-02 15:04"}}
{{t "admin.empty"}}
{{end}} diff --git a/internal/admin/templates/ticket_form.html b/internal/admin/templates/ticket_form.html index a342eb4b..07fdeab9 100644 --- a/internal/admin/templates/ticket_form.html +++ b/internal/admin/templates/ticket_form.html @@ -1,32 +1,46 @@ {{define "ticket_form.html"}} -
+{{template "form_error" .Error}} + - {{if .Error}}
ERR{{esc .Error}}
{{end}} -
author{{esc .Ticket.Author}}
-
subject{{esc .Ticket.Subject}}
-
page{{esc .Ticket.SourcePage}}
-
created{{.Ticket.CreatedAt.Format "2006-01-02 15:04"}}
-
body
{{esc .Ticket.Body}}
- {{if .Ticket.ReviewedBy}}
reviewed by{{esc .Ticket.ReviewedBy}}
{{end}} -
- - + +
+
{{t "admin.ticket-content"}}
+
+ {{template "row_static" dict "k" "admin.f-author" "v" .Ticket.Author}} + {{template "row_static" dict "k" "admin.f-subject" "v" .Ticket.Subject}} + {{template "row_static" dict "k" "admin.f-source-page" "v" .Ticket.SourcePage}} + {{template "row_static" dict "k" "admin.f-created" "v" (.Ticket.CreatedAt.Format "2006-01-02 15:04")}} + {{template "row_pre" dict "k" "admin.f-body" "v" .Ticket.Body}} +
- {{if .MayGrant}} -
- - -
- {{end}} - {{template "admin_area" dict "n" "admin_notes" "v" .Ticket.AdminNotes}} -
- - back + +
+
{{t "admin.review"}}
+
+
+ +
+ +
+
+ {{if .MayGrant}} +
+ +
+ + {{t "admin.h-granted-role"}} +
+
+ {{end}} + {{template "row_area" dict "n" "admin_notes" "k" "admin.f-admin-notes" "v" .Ticket.AdminNotes}} + {{if .Ticket.ReviewedBy}}{{template "row_static" dict "k" "admin.f-reviewed-by" "v" .Ticket.ReviewedBy}}{{end}} + {{template "save_row" dict "back" .Back}} +
{{end}} diff --git a/internal/admin/templates/ticket_list.html b/internal/admin/templates/ticket_list.html index 99b84b59..e9ba72b4 100644 --- a/internal/admin/templates/ticket_list.html +++ b/internal/admin/templates/ticket_list.html @@ -1,25 +1,28 @@ {{define "ticket_list.html"}} -
-
- -
-

{{.Total}}

- - - - {{range .Tickets}} - - {{end}} - -
idauthorsubjectstatuscreated
{{.ID}}{{esc .Author}}{{esc .Subject}}{{esc .Status}}{{.CreatedAt.Format "2006-01-02 15:04"}}
- {{if gt .Pages 1}} -

- {{if gt .Page 1}}prev{{end}} - {{.Page}} / {{.Pages}} - {{if lt .Page .Pages}}next{{end}} -

+
+ +

{{t "admin.count" "n" .Total}}

+ + + + + + {{range .Tickets}} + + + + + + + + {{else}} + + {{end}} + +
{{t "admin.f-id"}}{{t "admin.f-author"}}{{t "admin.f-subject"}}{{t "admin.f-status"}}{{t "admin.f-created"}}
#{{.ID}}{{esc .Author}}{{esc .Subject}}{{enum "admin.ticket-status-" .Status}}{{.CreatedAt.Format "2006-01-02 15:04"}}
{{t "admin.empty"}}
+{{template "pager" dict "Base" (printf "%s?status=%s&" .Action (urlq .Status)) "Page" .Page "Pages" .Pages}} {{end}} diff --git a/internal/admin/templates/user_bot.html b/internal/admin/templates/user_bot.html new file mode 100644 index 00000000..4950e2cd --- /dev/null +++ b/internal/admin/templates/user_bot.html @@ -0,0 +1,17 @@ +{{define "user_bot.html"}} +{{template "form_error" .Error}} +
+ +
+
{{t "admin.new-bot"}}
+
+

{{t "admin.h-bot"}}

+ {{template "row_text" dict "n" "username" "k" "admin.f-username" "v" "" "w" "narrow-4"}} +
+ + {{t "admin.back-to-list"}} +
+
+
+
+{{end}} diff --git a/internal/admin/templates/user_claim.html b/internal/admin/templates/user_claim.html new file mode 100644 index 00000000..81aff6b6 --- /dev/null +++ b/internal/admin/templates/user_claim.html @@ -0,0 +1,27 @@ +{{define "user_claim.html"}} +{{template "form_error" .Error}} +{{template "made_link" .}} +
+ +
+
{{t "admin.new-claim-link"}}
+
+

{{t "admin.h-claim-link"}}

+
+ +
+ + {{if not .Waiting}}{{t "admin.no-unclaimed"}}{{end}} +
+
+ {{template "role_picks" .}} +
+ + {{t "admin.invites"}} +
+
+
+
+{{end}} diff --git a/internal/admin/templates/user_form.html b/internal/admin/templates/user_form.html index 3f00e394..aa85dda8 100644 --- a/internal/admin/templates/user_form.html +++ b/internal/admin/templates/user_form.html @@ -1,40 +1,69 @@ {{define "user_form.html"}} -
+{{template "form_error" .Error}} + - {{if .Error}}
ERR{{esc .Error}}
{{end}} - {{template "admin_text" dict "n" "username" "v" .User.Username}} - {{template "admin_text" dict "n" "wikidot_username" "v" .User.WikidotUsername}} - {{template "admin_text" dict "n" "display_name" "v" .User.DisplayName}} - {{if .SeeEmail}}{{template "admin_text" dict "n" "email" "v" .User.Email}}{{end}} - {{template "admin_area" dict "n" "bio" "v" .User.Bio}} - -
type{{esc .User.Type}}
-
api key{{esc .User.APIKey}}
-
rank{{.User.OperationIndex}}
- -
- {{template "admin_text" dict "n" "inactive_until" "v" (stamp .User.InactiveUntil)}} -
- {{template "admin_text" dict "n" "forum_inactive_until" "v" (stamp .User.ForumInactiveUntil)}} -
+
+
{{t "admin.user-identity"}}
+
+ {{template "row_text" dict "n" "username" "k" "admin.f-username" "v" .User.Username "w" "narrow-4"}} + {{template "row_text" dict "n" "wikidot_username" "k" "admin.f-wikidot-username" "v" .User.WikidotUsername "w" "narrow-4"}} + {{template "row_text" dict "n" "display_name" "k" "admin.f-display-name" "v" .User.DisplayName "w" "narrow-4"}} + {{if .SeeEmail}}{{template "row_text" dict "n" "email" "k" "admin.f-email" "v" .User.Email "w" "narrow-5"}}{{end}} + {{template "row_area" dict "n" "bio" "k" "admin.f-bio" "v" .User.Bio}} + {{template "row_static" dict "k" "admin.f-user-type" "v" .User.Type}} + {{template "row_static" dict "k" "admin.f-api-key" "v" .User.APIKey}} + {{template "row_static" dict "k" "admin.f-rank" "v" (printf "%d" .User.OperationIndex)}} +
+
- {{if .MaySuper}} -
- {{end}} +
+
{{t "admin.user-state"}}
+
+ {{template "row_check" dict "n" "is_active" "k" "admin.f-active" "l" "admin.l-active" "v" .User.IsActive}} +
+ +
+ + {{t "admin.h-until"}} +
+
+ {{template "row_check" dict "n" "is_forum_active" "k" "admin.f-forum-active" "l" "admin.l-forum-active" "v" .User.IsForumActive}} +
+ +
+ + {{t "admin.h-until"}} +
+
+ {{template "row_check" dict "n" "can_send_direct_messages" "k" "admin.f-can-message" "l" "admin.l-can-message" "v" .User.CanSendDM}} + {{if .MaySuper}} + {{template "row_check" dict "n" "is_superuser" "k" "admin.f-superuser" "l" "admin.l-superuser" "v" .User.IsSuperuser}} + {{end}} +
+
{{if .MaySetRoles}} -
- roles - {{range $.Roles}} - - {{end}} +
+
{{t "admin.roles"}}
+
+
+ {{t "admin.f-roles"}} +
+ {{range $.Roles}} + + {{end}} +
+
+
{{end}} -
- - back +
+ + {{t "admin.back-to-list"}} + {{t "admin.activate"}} + {{t "admin.reset-votes"}}
{{end}} diff --git a/internal/admin/templates/user_invite.html b/internal/admin/templates/user_invite.html new file mode 100644 index 00000000..a9fe86fa --- /dev/null +++ b/internal/admin/templates/user_invite.html @@ -0,0 +1,19 @@ +{{define "user_invite.html"}} +{{template "form_error" .Error}} +{{template "made_link" .}} +
+ +
+
{{t "admin.new-invite-link"}}
+
+

{{t "admin.h-invite-link"}}

+ {{template "row_text" dict "n" "email" "k" "admin.f-email" "v" "" "w" "narrow-5"}} + {{template "role_picks" .}} +
+ + {{t "admin.invites"}} +
+
+
+
+{{end}} diff --git a/internal/admin/templates/user_list.html b/internal/admin/templates/user_list.html index ad33030f..6ae7516b 100644 --- a/internal/admin/templates/user_list.html +++ b/internal/admin/templates/user_list.html @@ -1,29 +1,54 @@ {{define "user_list.html"}} -
-
- - -
-

{{.Total}}

- - {{if .SeeEmail}}{{end}} - - {{range .Users}} - - - {{if $.SeeEmail}}{{end}} - - - - {{end}} - -
useremailactivesuper
{{if eq .Type "wikidot"}}{{esc .WikidotUsername}}{{else}}{{esc .Username}}{{end}}{{esc .Email}}{{if .IsActive}}yes{{end}}{{if .IsSuperuser}}yes{{end}}
- {{if gt .Pages 1}} -

- {{if gt .Page 1}}prev{{end}} - {{.Page}} / {{.Pages}} - {{if lt .Page .Pages}}next{{end}} -

- {{end}} +
+
{{t "admin.new-user"}}
+
+ {{t "admin.mail-invite"}} + {{t "admin.new-invite-link"}} + {{t "admin.new-claim-link"}} + {{t "admin.new-bot"}} +
+
+
+ + + +
+
+ +

{{t "admin.count" "n" .Total}}

+ + + + + + {{if .SeeEmail}}{{end}} + + + + + + {{range .Users}} + + + + {{if $.SeeEmail}}{{end}} + + + + {{else}} + + {{end}} + +
{{t "admin.f-user"}}{{t "admin.f-user-type"}}{{t "admin.f-email"}}{{t "admin.f-state"}}
{{if eq .Type "wikidot"}}{{esc .WikidotUsername}}{{else}}{{esc .Username}}{{end}}{{enum "admin.user-type-" .Type}}{{if .Email}}{{esc .Email}}{{else}}—{{end}} + {{if .IsSuperuser}}{{t "admin.superuser"}} + {{else if .IsActive}}{{t "admin.active"}} + {{else}}{{t "admin.inactive"}}{{end}} + {{t "admin.edit"}}
{{t "admin.empty"}}
+{{template "pager" dict "Base" (printf "%s?q=%s&type=%s&" .Action (urlq .Query) (urlq .Kind)) "Page" .Page "Pages" .Pages}} {{end}} diff --git a/internal/admin/templates/user_mail.html b/internal/admin/templates/user_mail.html new file mode 100644 index 00000000..82a5f6c0 --- /dev/null +++ b/internal/admin/templates/user_mail.html @@ -0,0 +1,20 @@ +{{define "user_mail.html"}} +{{template "form_error" .Error}} +{{if .Done}}
{{t "admin.invite-sent" "email" .Done}}
{{end}} +
+ +
+
{{if .Target}}{{t "admin.activate"}}{{else}}{{t "admin.mail-invite"}}{{end}}
+
+

{{if .Target}}{{t "admin.h-activate"}}{{else}}{{t "admin.h-mail-invite"}}{{end}}

+ {{if .Target}}{{template "row_static" dict "k" "admin.f-user" "v" .Target}}{{end}} + {{template "row_text" dict "n" "email" "k" "admin.f-email" "v" .Email "w" "narrow-5"}} + {{template "role_picks" .}} +
+ + {{t "admin.back-to-list"}} +
+
+
+
+{{end}} diff --git a/internal/admin/templates/user_new.html b/internal/admin/templates/user_new.html new file mode 100644 index 00000000..7d9cd1e3 --- /dev/null +++ b/internal/admin/templates/user_new.html @@ -0,0 +1,26 @@ +{{define "user_new.html"}} +{{template "form_error" .Error}} +
+ +
+
{{t "admin.new-user"}}
+
+ {{template "row_text" dict "n" "username" "k" "admin.f-username" "v" "" "w" "narrow-4"}} + {{template "row_text" dict "n" "display_name" "k" "admin.f-display-name" "v" "" "w" "narrow-4"}} +
+ +
+ + {{t "admin.h-new-password"}} +
+
+ {{template "row_check" dict "n" "is_active" "k" "admin.f-active" "l" "admin.l-active" "v" true}} + {{template "role_picks" .}} +
+ + {{t "admin.back-to-list"}} +
+
+
+
+{{end}} diff --git a/internal/admin/templates/user_parts.html b/internal/admin/templates/user_parts.html new file mode 100644 index 00000000..1625e8d9 --- /dev/null +++ b/internal/admin/templates/user_parts.html @@ -0,0 +1,22 @@ +{{define "role_picks"}} +{{if .Roles}} +
+ {{t "admin.f-roles"}} +
+ {{range .Roles}} + + {{end}} +
+
+{{end}} +{{end}} + +{{define "made_link"}} +{{if .Link}} +
+

{{t "admin.link-made"}}

+

{{t "admin.h-link-made"}}

+ +
+{{end}} +{{end}} diff --git a/internal/admin/templates/user_reset_votes.html b/internal/admin/templates/user_reset_votes.html new file mode 100644 index 00000000..79eb3d06 --- /dev/null +++ b/internal/admin/templates/user_reset_votes.html @@ -0,0 +1,11 @@ +{{define "user_reset_votes.html"}} +
+

{{t "admin.reset-votes-confirm" "name" .User.Username}}

+

{{t "admin.reset-votes-warning"}}

+
+ + + {{t "admin.cancel"}} +
+
+{{end}} diff --git a/internal/admin/theme.go b/internal/admin/theme.go index 25aee5a8..0c101529 100644 --- a/internal/admin/theme.go +++ b/internal/admin/theme.go @@ -104,6 +104,7 @@ func (h *Handler) saveThemeForm(w http.ResponseWriter, r *http.Request, loc *i18 if err := h.deps.DB.DeleteTheme(r.Context(), row.ID); err != nil { return err } + h.noteID(r, db.AdminDeleted, themeSlug, row.ID, row.Name) redirect(w, Prefix+themeSlug+"/") return nil } @@ -111,6 +112,10 @@ func (h *Handler) saveThemeForm(w http.ResponseWriter, r *http.Request, loc *i18 if problem := h.checkTheme(loc, row); problem != "" { return h.themeForm(w, r, loc, rest, problem) } + did := db.AdminChanged + if row.ID == 0 { + did = db.AdminCreated + } id, err := h.deps.DB.SaveTheme(r.Context(), row) if err != nil { return err @@ -119,6 +124,7 @@ func (h *Handler) saveThemeForm(w http.ResponseWriter, r *http.Request, loc *i18 if err := h.writeThemeCSS(row); err != nil { return err } + h.noteID(r, did, themeSlug, row.ID, row.Name) redirect(w, Prefix+themeSlug+"/") return nil } diff --git a/internal/admin/ticket.go b/internal/admin/ticket.go index 4b80082c..f1267112 100644 --- a/internal/admin/ticket.go +++ b/internal/admin/ticket.go @@ -82,6 +82,7 @@ func (h *Handler) ticketScreen(w http.ResponseWriter, r *http.Request, loc *i18n if err != nil { return err } + h.noteID(r, db.AdminChanged, slug, id, status) redirect(w, Prefix+slug+"/") return nil } @@ -162,6 +163,7 @@ func (h *Handler) invites(w http.ResponseWriter, r *http.Request, loc *i18n.Loca if err := h.deps.DB.DeleteInvite(ctx, *id); err != nil { return err } + h.noteID(r, db.AdminDeleted, inviteSlug, *id, "") } redirect(w, Prefix+inviteSlug+"/") return nil diff --git a/internal/admin/upload.go b/internal/admin/upload.go new file mode 100644 index 00000000..980fe1ea --- /dev/null +++ b/internal/admin/upload.go @@ -0,0 +1,174 @@ +package admin + +import ( + "crypto/rand" + "encoding/hex" + "errors" + "io" + "net/http" + "os" + "path" + "path/filepath" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/paths" +) + +const uploadRoot = "-" + +const maxIconBytes = 2 << 20 + +var ( + errUploadType = errors.New("admin: the file is not of an accepted type") + errUploadSize = errors.New("admin: the file is too large") +) + +type uploadRule struct { + dir string + exts []string + check func(head []byte) bool +} + +var siteIcons = uploadRule{ + dir: "sites", + exts: []string{".png", ".jpg", ".jpeg", ".gif", ".webp", ".ico"}, + check: func(head []byte) bool { + return strings.HasPrefix(http.DetectContentType(head), "image/") + }, +} + +var roleIcon = uploadRule{ + dir: "roles", + exts: []string{".svg"}, + check: func(head []byte) bool { return strings.Contains(string(head), " maxIconBytes { + return "", errUploadSize + } + ext := strings.ToLower(filepath.Ext(header.Filename)) + if !contains(rule.exts, ext) { + return "", errUploadType + } + + src, err := header.Open() + if err != nil { + return "", err + } + defer src.Close() + + head := make([]byte, 1024) + n, err := io.ReadFull(src, head) + if err != nil && !errors.Is(err, io.ErrUnexpectedEOF) && !errors.Is(err, io.EOF) { + return "", err + } + if !rule.check(head[:n]) { + return "", errUploadType + } + if _, err := src.Seek(0, io.SeekStart); err != nil { + return "", err + } + + name, full, err := h.freeName(rule.dir, cleanName(header.Filename, ext)) + if err != nil { + return "", err + } + if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil { + return "", err + } + dst, err := os.OpenFile(full, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0o644) + if err != nil { + return "", err + } + defer dst.Close() + if _, err := io.Copy(dst, io.LimitReader(src, maxIconBytes)); err != nil { + return "", err + } + return path.Join(uploadRoot, rule.dir, name), nil +} + +func (h *Handler) freeName(dir, name string) (string, string, error) { + base := strings.TrimSuffix(name, filepath.Ext(name)) + ext := filepath.Ext(name) + for i := 0; i < 8; i++ { + full, err := paths.Resolve(h.deps.Files, filepath.Join(uploadRoot, dir, name)) + if err != nil { + return "", "", err + } + if _, err := os.Stat(full); errors.Is(err, os.ErrNotExist) { + return name, full, nil + } + var suffix [3]byte + if _, err := rand.Read(suffix[:]); err != nil { + return "", "", err + } + name = base + "-" + hex.EncodeToString(suffix[:]) + ext + } + return "", "", errors.New("admin: no free name for the upload") +} + +func cleanName(name, ext string) string { + base := strings.TrimSuffix(filepath.Base(name), filepath.Ext(name)) + var b strings.Builder + for _, r := range base { + switch { + case r >= 'a' && r <= 'z', r >= '0' && r <= '9', r == '-', r == '_': + b.WriteRune(r) + case r >= 'A' && r <= 'Z': + b.WriteRune(r + 32) + default: + b.WriteByte('-') + } + } + trimmed := strings.Trim(b.String(), "-") + if trimmed == "" { + trimmed = "icon" + } + if len(trimmed) > 60 { + trimmed = trimmed[:60] + } + return trimmed + ext +} + +func (h *Handler) pickIcon(r *http.Request, field, stored string, rule uploadRule) (string, error) { + if r.PostFormValue("clear_"+field) != "" { + return "", nil + } + name, err := h.store(r, field, rule) + if err != nil { + return "", err + } + if name == "" { + return stored, nil + } + return name, nil +} + +func iconMessage(loc *i18n.Localizer, err error) string { + switch { + case errors.Is(err, errUploadType): + return loc.T("admin.icon-bad-type") + case errors.Is(err, errUploadSize): + return loc.T("admin.icon-too-large") + } + return "" +} + +func (h *Handler) iconProblem(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, err error) error { + if message := iconMessage(loc, err); message != "" { + return h.siteForm(w, r, loc, message, "") + } + return err +} diff --git a/internal/admin/user.go b/internal/admin/user.go index c83f5977..f5d299b3 100644 --- a/internal/admin/user.go +++ b/internal/admin/user.go @@ -22,12 +22,44 @@ const ( perPage = 50 ) +var userTypes = []string{"normal", "wikidot", "bot", "system"} + func init() { register(screen{slug: userSlug, label: "admin.users", need: perms.ManageUsers, serve: (*Handler).users}) } func (h *Handler) users(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { rest := strings.Trim(strings.TrimPrefix(r.URL.Path, Prefix+userSlug), "/") + if id, tail, ok := strings.Cut(rest, "/"); ok { + switch tail { + case actionResetVote: + return h.resetVotes(w, r, loc, id) + case actionActivate: + return h.activate(w, r, loc, id) + } + notFound(w) + return nil + } + if contains(userActions, rest) { + if r.Method != http.MethodPost { + return h.userAction(w, r, loc, rest) + } + if !h.verified(w, r) { + return nil + } + switch rest { + case actionNew: + return h.saveNewUser(w, r, loc) + case actionInvite: + return h.saveInviteLink(w, r, loc) + case actionClaim: + return h.saveClaimLink(w, r, loc) + case actionBot: + return h.saveBot(w, r, loc) + case actionMail: + return h.sendInvite(w, r, loc, nil) + } + } if r.Method == http.MethodPost { return h.saveUser(w, r, loc, rest) } @@ -40,11 +72,15 @@ func (h *Handler) users(w http.ResponseWriter, r *http.Request, loc *i18n.Locali func (h *Handler) userList(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { ctx := r.Context() query := strings.TrimSpace(r.URL.Query().Get("q")) + kind := r.URL.Query().Get("type") + if !contains(userTypes, kind) { + kind = "" + } page := atoi(r.URL.Query().Get("page")) if page < 1 { page = 1 } - found, total, err := h.deps.DB.AdminUsers(ctx, query, perPage, (page-1)*perPage) + found, total, err := h.deps.DB.AdminUsers(ctx, query, kind, perPage, (page-1)*perPage) if err != nil { return err } @@ -55,6 +91,8 @@ func (h *Handler) userList(w http.ResponseWriter, r *http.Request, loc *i18n.Loc return h.page(w, r, loc, loc.T("admin.users"), "user_list.html", map[string]any{ "Users": found, "Query": query, + "Kind": kind, + "Types": userTypes, "Page": page, "Pages": (total + perPage - 1) / perPage, "Total": total, @@ -109,6 +147,8 @@ func (h *Handler) userForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc "Roles": choices, "Held": row.Roles, "MaySetRoles": h.maySetRoles(mine, granted, row), + "ResetVotes": Prefix + userSlug + "/" + rest + "/" + actionResetVote, + "Activate": Prefix + userSlug + "/" + rest + "/" + actionActivate, "MaySuper": mine != nil && mine.IsSuperuser, "SeeEmail": granted.Has(perms.ViewSensitiveInfo), "CSRF": csrf.Issue(w, r), @@ -191,6 +231,7 @@ func (h *Handler) saveUser(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if err != nil { return err } + h.noteID(r, db.AdminChanged, userSlug, next.ID, next.Username) redirect(w, Prefix+userSlug+"/") return nil } diff --git a/internal/admin/useractions.go b/internal/admin/useractions.go new file mode 100644 index 00000000..78778db3 --- /dev/null +++ b/internal/admin/useractions.go @@ -0,0 +1,424 @@ +package admin + +import ( + "crypto/rand" + "encoding/base64" + "errors" + "net/http" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/csrf" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/password" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/token" +) + +const ( + actionNew = "new" + actionMail = "invite" + actionInvite = "invite-link" + actionClaim = "claim-link" + actionBot = "bot" + actionResetVote = "reset-votes" + actionActivate = "activate" +) + +const ( + inviteKindRegister = "register" + inviteKindClaim = "claim" + inviteByLink = "link" + inviteByMail = "email" + acceptPrefix = "/-/accept/" +) + +var userActions = []string{actionNew, actionMail, actionInvite, actionClaim, actionBot} + +func (h *Handler) userAction(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, what string) error { + switch what { + case actionNew: + return h.newUser(w, r, loc, "") + case actionInvite: + return h.inviteLink(w, r, loc, "", "") + case actionClaim: + return h.claimLink(w, r, loc, "", "") + case actionBot: + return h.newBot(w, r, loc, "") + case actionMail: + return h.mailInvite(w, r, loc, nil, "", "") + } + notFound(w) + return nil +} + +func (h *Handler) newUser(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, problem string) error { + roleList, err := h.deps.DB.AllRoles(r.Context()) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.new-user"), "user_new.html", map[string]any{ + "Roles": h.grantableRoles(r, roleList), + "CSRF": csrf.Issue(w, r), + "Error": problem, + "Action": Prefix + userSlug + "/" + actionNew, + "Back": Prefix + userSlug + "/", + }) +} + +func (h *Handler) saveNewUser(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + ctx := r.Context() + name := strings.TrimSpace(r.PostFormValue("username")) + secret := r.PostFormValue("password") + switch { + case name == "": + return h.newUser(w, r, loc, loc.T("admin.user-no-name")) + case len(secret) < 8: + return h.newUser(w, r, loc, loc.T("admin.password-too-short")) + } + taken, err := h.deps.DB.UsernameTaken(ctx, name) + if err != nil { + return err + } + if taken { + return h.newUser(w, r, loc, loc.T("admin.name-taken")) + } + hash, err := password.Hash(secret) + if err != nil { + return err + } + id, err := h.deps.DB.CreateUser(ctx, name, strings.TrimSpace(r.PostFormValue("display_name")), + hash, r.PostFormValue("is_active") != "", time.Now()) + if err != nil { + return err + } + if err := h.grantPicked(r, id); err != nil { + return err + } + h.noteID(r, db.AdminCreated, userSlug, id, name) + redirect(w, Prefix+userSlug+"/"+strconv.FormatInt(id, 10)) + return nil +} + +func (h *Handler) newBot(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, problem string) error { + return h.page(w, r, loc, loc.T("admin.new-bot"), "user_bot.html", map[string]any{ + "CSRF": csrf.Issue(w, r), + "Error": problem, + "Action": Prefix + userSlug + "/" + actionBot, + "Back": Prefix + userSlug + "/", + }) +} + +func (h *Handler) saveBot(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + ctx := r.Context() + name := strings.TrimSpace(r.PostFormValue("username")) + if name == "" { + return h.newBot(w, r, loc, loc.T("admin.user-no-name")) + } + taken, err := h.deps.DB.UsernameTaken(ctx, name) + if err != nil { + return err + } + if taken { + return h.newBot(w, r, loc, loc.T("admin.name-taken")) + } + var raw [32]byte + if _, err := rand.Read(raw[:]); err != nil { + return err + } + id, err := h.deps.DB.CreateBot(ctx, name, base64.RawURLEncoding.EncodeToString(raw[:]), time.Now()) + if err != nil { + return err + } + h.noteID(r, db.AdminCreated, userSlug, id, name) + redirect(w, Prefix+userSlug+"/"+strconv.FormatInt(id, 10)) + return nil +} + +func (h *Handler) inviteLink(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, problem, made string) error { + roleList, err := h.deps.DB.AllRoles(r.Context()) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.new-invite-link"), "user_invite.html", map[string]any{ + "Roles": h.grantableRoles(r, roleList), + "CSRF": csrf.Issue(w, r), + "Error": problem, + "Link": made, + "Action": Prefix + userSlug + "/" + actionInvite, + "Back": Prefix + inviteSlug + "/", + }) +} + +func (h *Handler) saveInviteLink(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + ctx := r.Context() + email := strings.TrimSpace(r.PostFormValue("email")) + if email == "" { + return h.inviteLink(w, r, loc, loc.T("admin.invite-no-email"), "") + } + if _, err := h.deps.DB.UserByEmail(ctx, email); err == nil { + return h.inviteLink(w, r, loc, loc.T("admin.invite-email-taken"), "") + } else if !errors.Is(err, db.ErrNotFound) { + return err + } + now := time.Now() + id, err := h.deps.DB.CreateInvitedUser(ctx, email, now) + if err != nil { + return err + } + if err := h.grantPicked(r, id); err != nil { + return err + } + link, err := h.mintLink(w, r, inviteKindRegister, id, email, "", now) + if err != nil { + return err + } + h.noteID(r, db.AdminCreated, inviteSlug, id, email) + return h.inviteLink(w, r, loc, "", link) +} + +func (h *Handler) claimLink(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, problem, made string) error { + ctx := r.Context() + waiting, err := h.deps.DB.UnclaimedWikidotUsers(ctx) + if err != nil { + return err + } + roleList, err := h.deps.DB.AllRoles(ctx) + if err != nil { + return err + } + return h.page(w, r, loc, loc.T("admin.new-claim-link"), "user_claim.html", map[string]any{ + "Waiting": waiting, + "Roles": h.grantableRoles(r, roleList), + "CSRF": csrf.Issue(w, r), + "Error": problem, + "Link": made, + "Action": Prefix + userSlug + "/" + actionClaim, + "Back": Prefix + inviteSlug + "/", + }) +} + +func (h *Handler) saveClaimLink(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { + ctx := r.Context() + id, err := strconv.ParseInt(r.PostFormValue("user"), 10, 64) + if err != nil { + return h.claimLink(w, r, loc, loc.T("admin.claim-no-user"), "") + } + row, err := h.deps.DB.AdminUser(ctx, id) + if errors.Is(err, db.ErrNotFound) || row.Type != db.UserTypeWikidot || row.IsActive { + return h.claimLink(w, r, loc, loc.T("admin.claim-no-user"), "") + } + if err != nil { + return err + } + if err := h.grantPicked(r, id); err != nil { + return err + } + link, err := h.mintLink(w, r, inviteKindClaim, id, "", row.WikidotUsername, time.Now()) + if err != nil { + return err + } + h.noteID(r, db.AdminCreated, inviteSlug, id, row.WikidotUsername) + return h.claimLink(w, r, loc, "", link) +} + +func (h *Handler) mintLink(w http.ResponseWriter, r *http.Request, kind string, id int64, email, wikidotName string, now time.Time) (string, error) { + return h.mintLinkAs(w, r, kind, inviteByLink, id, email, wikidotName, now) +} + +func (h *Handler) mintLinkAs(w http.ResponseWriter, r *http.Request, kind, delivery string, id int64, email, wikidotName string, now time.Time) (string, error) { + ctx := r.Context() + current := site.FromContext(ctx) + minted := h.deps.Tokens.Make(token.InviteValue(id, false), now) + uid := base64.RawURLEncoding.EncodeToString([]byte(strconv.FormatInt(id, 10))) + + var owner *int64 + if by := auth.FromContext(ctx); by != nil { + owner = &by.ID + } + if _, err := h.deps.DB.CreateInviteLink(ctx, kind, delivery, email, wikidotName, + minted, uid, owner, id, now); err != nil { + return "", err + } + return scheme(r) + "://" + current.Domain + acceptPrefix + uid + "/" + minted, nil +} + +func (h *Handler) resetVotes(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest string) error { + ctx := r.Context() + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + row, err := h.deps.DB.AdminUser(ctx, id) + if errors.Is(err, db.ErrNotFound) { + notFound(w) + return nil + } + if err != nil { + return err + } + if r.Method != http.MethodPost { + return h.page(w, r, loc, loc.T("admin.reset-votes"), "user_reset_votes.html", map[string]any{ + "User": row, + "CSRF": csrf.Issue(w, r), + "Action": Prefix + userSlug + "/" + rest + "/" + actionResetVote, + "Back": Prefix + userSlug + "/" + rest, + }) + } + if !h.verified(w, r) { + return nil + } + if _, err := h.deps.DB.ResetUserVotes(ctx, id); err != nil { + return err + } + h.noteID(r, db.AdminChanged, userSlug, id, row.Username) + redirect(w, Prefix+userSlug+"/"+rest) + return nil +} + +func (h *Handler) grantableRoles(r *http.Request, all []db.RoleChoice) []db.RoleChoice { + if !grantsFrom(r.Context()).Has(perms.ManagePermissions) { + return nil + } + out := make([]db.RoleChoice, 0, len(all)) + for _, one := range all { + if !contains(builtinRoles, one.Slug) { + out = append(out, one) + } + } + return out +} + +func (h *Handler) grantPicked(r *http.Request, userID int64) error { + if !grantsFrom(r.Context()).Has(perms.ManagePermissions) { + return nil + } + for _, raw := range r.PostForm["roles"] { + role, err := strconv.ParseInt(raw, 10, 64) + if err != nil { + continue + } + if err := h.deps.DB.GrantRole(r.Context(), userID, role); err != nil { + return err + } + } + return nil +} + +func scheme(r *http.Request) string { + if r.TLS != nil { + return "https" + } + return "http" +} + +func (h *Handler) mailInvite(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, + target *db.AdminUserRow, problem, done string) error { + + roleList, err := h.deps.DB.AllRoles(r.Context()) + if err != nil { + return err + } + action := Prefix + userSlug + "/" + actionMail + name := "" + if target != nil { + action = Prefix + userSlug + "/" + strconv.FormatInt(target.ID, 10) + "/" + actionActivate + name = target.WikidotUsername + if name == "" { + name = target.Username + } + } + return h.page(w, r, loc, loc.T("admin.mail-invite"), "user_mail.html", map[string]any{ + "Roles": h.grantableRoles(r, roleList), + "Target": name, + "Email": strings.TrimSpace(r.PostFormValue("email")), + "CSRF": csrf.Issue(w, r), + "Error": problem, + "Done": done, + "Action": action, + "Back": Prefix + userSlug + "/", + }) +} + +func (h *Handler) sendInvite(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, target *db.AdminUserRow) error { + ctx := r.Context() + if h.deps.Mail == nil { + return h.mailInvite(w, r, loc, target, loc.T("admin.no-mailer"), "") + } + email := strings.TrimSpace(r.PostFormValue("email")) + if email == "" { + return h.mailInvite(w, r, loc, target, loc.T("admin.invite-no-email"), "") + } + if held, err := h.deps.DB.UserByEmail(ctx, email); err == nil { + if target == nil || held.ID != target.ID { + return h.mailInvite(w, r, loc, target, loc.T("admin.invite-email-taken"), "") + } + } else if !errors.Is(err, db.ErrNotFound) { + return err + } + + now := time.Now() + kind, wikidotName := inviteKindRegister, "" + id := int64(0) + if target == nil { + fresh, err := h.deps.DB.CreateInvitedUser(ctx, email, now) + if err != nil { + return err + } + id = fresh + } else { + id = target.ID + if err := h.deps.DB.SetEmail(ctx, id, email); err != nil { + return err + } + if target.Type == db.UserTypeWikidot { + kind, wikidotName = inviteKindClaim, target.WikidotUsername + } + } + if err := h.grantPicked(r, id); err != nil { + return err + } + + link, err := h.mintLinkAs(w, r, kind, inviteByMail, id, email, wikidotName, now) + if err != nil { + return err + } + current := site.FromContext(ctx) + err = h.deps.Mail.Send(ctx, []string{email}, + loc.T("email.invite-subject", "site", current.Title), + loc.T("email.invite-body", "link", link, "site", current.Title)) + if err != nil { + h.deps.logger().Error("send invitation", "err", err) + return h.mailInvite(w, r, loc, target, loc.T("admin.invite-not-sent"), "") + } + h.noteID(r, db.AdminCreated, inviteSlug, id, email) + return h.mailInvite(w, r, loc, target, "", email) +} + +func (h *Handler) activate(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest string) error { + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + row, err := h.deps.DB.AdminUser(r.Context(), id) + if errors.Is(err, db.ErrNotFound) { + notFound(w) + return nil + } + if err != nil { + return err + } + if r.Method != http.MethodPost { + return h.mailInvite(w, r, loc, &row, "", "") + } + if !h.verified(w, r) { + return nil + } + return h.sendInvite(w, r, loc, &row) +} diff --git a/internal/db/message.go b/internal/db/message.go index 49e34acf..d56055f8 100644 --- a/internal/db/message.go +++ b/internal/db/message.go @@ -218,10 +218,10 @@ type SuspiciousUser struct { } var qSuspiciousUsers = register("SuspiciousUsers", ` -SELECT DISTINCT ON (l.user_id, l.origin_ip) l.user_id, u.username, host(l.origin_ip) -FROM web_actionlogentry l -JOIN web_user u ON u.id = l.user_id -ORDER BY l.user_id, l.origin_ip`) +SELECT a.user_id, u.username, host(a.address) +FROM pwikit_user_address a +JOIN web_user u ON u.id = a.user_id +ORDER BY a.user_id, a.address`) func (d *DB) SuspiciousUsers(ctx context.Context) ([]SuspiciousUser, error) { rows, err := d.pool.Query(ctx, qSuspiciousUsers) diff --git a/internal/db/report_admin.go b/internal/db/report_admin.go index b0908641..c4bf77da 100644 --- a/internal/db/report_admin.go +++ b/internal/db/report_admin.go @@ -102,68 +102,3 @@ func (d *DB) ReviewReport(ctx context.Context, id int64, status, notes string, b } return nil } - -type ActionLogRow struct { - ID int64 - User string - Stale string - Type string - Meta string - OriginIP string - CreatedAt time.Time -} - -var qAdminActionLog = register("AdminActionLog", ` -SELECT l.id, coalesce(u.username, ''), l.stale_username, l.type, l.meta::text, - coalesce(host(l.origin_ip), ''), l.created_at -FROM web_actionlogentry l -LEFT JOIN web_user u ON u.id = l.user_id -WHERE $1 = '' OR l.type = $1 -ORDER BY l.created_at DESC, l.id DESC -LIMIT $2 OFFSET $3`) - -var qAdminActionLogCount = register("AdminActionLogCount", ` -SELECT count(*) FROM web_actionlogentry l WHERE $1 = '' OR l.type = $1`) - -var qActionLogTypes = register("ActionLogTypes", ` -SELECT DISTINCT type FROM web_actionlogentry ORDER BY 1`) - -func (d *DB) AdminActionLog(ctx context.Context, kind string, limit, offset int) ([]ActionLogRow, int, error) { - var total int - if err := d.pool.QueryRow(ctx, qAdminActionLogCount, kind).Scan(&total); err != nil { - return nil, 0, fmt.Errorf("count action log entries: %w", err) - } - rows, err := d.pool.Query(ctx, qAdminActionLog, kind, limit, offset) - if err != nil { - return nil, 0, fmt.Errorf("list action log entries: %w", err) - } - defer rows.Close() - - var out []ActionLogRow - for rows.Next() { - var l ActionLogRow - if err := rows.Scan(&l.ID, &l.User, &l.Stale, &l.Type, &l.Meta, &l.OriginIP, &l.CreatedAt); err != nil { - return nil, 0, err - } - out = append(out, l) - } - return out, total, rows.Err() -} - -func (d *DB) ActionLogTypes(ctx context.Context) ([]string, error) { - rows, err := d.pool.Query(ctx, qActionLogTypes) - if err != nil { - return nil, fmt.Errorf("list action log types: %w", err) - } - defer rows.Close() - - var out []string - for rows.Next() { - var kind string - if err := rows.Scan(&kind); err != nil { - return nil, err - } - out = append(out, kind) - } - return out, rows.Err() -} diff --git a/internal/db/user_admin.go b/internal/db/user_admin.go index 4e7ab01b..88d4ecfd 100644 --- a/internal/db/user_admin.go +++ b/internal/db/user_admin.go @@ -36,18 +36,19 @@ const adminUserColumns = `id, type, username, coalesce(wikidot_username, ''), co is_active, inactive_until, is_forum_active, forum_inactive_until, can_send_direct_messages, is_superuser` +const adminUserWhere = ` +WHERE ($1 = '' OR username ILIKE '%' || $1 || '%' OR wikidot_username ILIKE '%' || $1 || '%' + OR display_name ILIKE '%' || $1 || '%' OR email ILIKE '%' || $1 || '%') + AND ($2 = '' OR type = $2)` + var qAdminUsers = register("AdminUsers", ` SELECT `+adminUserColumns+` -FROM web_user -WHERE $1 = '' OR username ILIKE '%' || $1 || '%' OR wikidot_username ILIKE '%' || $1 || '%' - OR display_name ILIKE '%' || $1 || '%' OR email ILIKE '%' || $1 || '%' +FROM web_user`+adminUserWhere+` ORDER BY CASE WHEN type = 'wikidot' THEN wikidot_username ELSE username END, id -LIMIT $2 OFFSET $3`) +LIMIT $3 OFFSET $4`) var qAdminUserCount = register("AdminUserCount", ` -SELECT count(*) FROM web_user -WHERE $1 = '' OR username ILIKE '%' || $1 || '%' OR wikidot_username ILIKE '%' || $1 || '%' - OR display_name ILIKE '%' || $1 || '%' OR email ILIKE '%' || $1 || '%'`) +SELECT count(*) FROM web_user`+adminUserWhere) func scanAdminUser(row pgx.Row, u *AdminUserRow) error { return row.Scan(&u.ID, &u.Type, &u.Username, &u.WikidotUsername, &u.DisplayName, @@ -55,12 +56,12 @@ func scanAdminUser(row pgx.Row, u *AdminUserRow) error { &u.IsForumActive, &u.ForumInactiveUntil, &u.CanSendDM, &u.IsSuperuser) } -func (d *DB) AdminUsers(ctx context.Context, query string, limit, offset int) ([]AdminUserRow, int, error) { +func (d *DB) AdminUsers(ctx context.Context, query, kind string, limit, offset int) ([]AdminUserRow, int, error) { var total int - if err := d.pool.QueryRow(ctx, qAdminUserCount, query).Scan(&total); err != nil { + if err := d.pool.QueryRow(ctx, qAdminUserCount, query, kind).Scan(&total); err != nil { return nil, 0, fmt.Errorf("count users: %w", err) } - rows, err := d.pool.Query(ctx, qAdminUsers, query, limit, offset) + rows, err := d.pool.Query(ctx, qAdminUsers, query, kind, limit, offset) if err != nil { return nil, 0, fmt.Errorf("list users: %w", err) } @@ -154,3 +155,42 @@ func (d *DB) SaveAdminUser(ctx context.Context, u AdminUserRow, builtin []string } return tx.Commit(ctx) } + +var qResetUserVotes = register("ResetUserVotes", `DELETE FROM web_vote WHERE user_id = $1`) + +func (d *DB) ResetUserVotes(ctx context.Context, userID int64) (int64, error) { + tag, err := d.pool.Exec(ctx, qResetUserVotes, userID) + if err != nil { + return 0, fmt.Errorf("reset votes of user %d: %w", userID, err) + } + return tag.RowsAffected(), nil +} + +var qUnclaimedWikidotUsers = register("UnclaimedWikidotUsers", ` +SELECT id, coalesce(wikidot_username, '') +FROM web_user +WHERE type = 'wikidot' AND NOT is_active +ORDER BY wikidot_username, id`) + +type UserChoice struct { + ID int64 + Name string +} + +func (d *DB) UnclaimedWikidotUsers(ctx context.Context) ([]UserChoice, error) { + rows, err := d.pool.Query(ctx, qUnclaimedWikidotUsers) + if err != nil { + return nil, fmt.Errorf("list unclaimed wikidot users: %w", err) + } + defer rows.Close() + + var out []UserChoice + for rows.Next() { + var one UserChoice + if err := rows.Scan(&one.ID, &one.Name); err != nil { + return nil, err + } + out = append(out, one) + } + return out, rows.Err() +} diff --git a/internal/db/vote.go b/internal/db/vote.go index d87fdc53..a659fa96 100644 --- a/internal/db/vote.go +++ b/internal/db/vote.go @@ -4,7 +4,6 @@ import ( "context" "errors" "fmt" - "net/netip" "time" "github.com/jackc/pgx/v5" @@ -146,30 +145,6 @@ func (d *DB) VoteGroupRole(ctx context.Context, userID *int64) (*int64, error) { return &id, nil } -// The action log's own vocabulary, which is not the article log's. -const ( - ActionVote = "vote" - ActionCreateArticle = "create_article" - ActionEditArticle = "edit_article" - ActionRemoveArticle = "remove_article" -) - -var qAddActionLog = register("AddActionLog", ` -INSERT INTO web_actionlogentry (user_id, stale_username, type, meta, created_at, origin_ip) -VALUES ($1, $2, $3, $4, $5, $6)`) - -func (d *DB) AddActionLog(ctx context.Context, userID *int64, username, kind, meta string, ip *netip.Addr, at time.Time) error { - var origin *string - if ip != nil { - text := ip.String() - origin = &text - } - if _, err := d.pool.Exec(ctx, qAddActionLog, userID, username, kind, meta, at, origin); err != nil { - return fmt.Errorf("write action log: %w", err) - } - return nil -} - const ( LogVotesDeleted = "votes_deleted" ) diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index afbaaa43..87d897f5 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -8,45 +8,377 @@ "accept.submit": "继续", "accept.title": "注册", "accept.username": "用户名", - "admin.action-log": "动作日志", + "admin.activate": "激活账号", + "admin.active": "启用", + "admin.add": "新增", + "admin.addresses-cleared": "已清掉 {n} 条 IP 记录。", + "admin.admin-log": "操作记录", + "admin.all": "全部", + "admin.back": "返回", + "admin.back-to-list": "返回列表", + "admin.batch": "对选中的页面", + "admin.batch-delete": "删除", + "admin.batch-revert": "回退", + "admin.cancel": "取消", "admin.category-no-name": "分类名称不能为空", + "admin.claim-no-user": "请选择一个还没被认领的 Wikidot 账号", + "admin.clear-addresses": "清空 IP 记录", + "admin.clear-icon": "清除当前图标", + "admin.confirm-delete": "确认删除这 {n} 个页面", + "admin.confirm-revert": "确认把这 {n} 个页面各回退 {steps} 个版本", + "admin.count": "共 {n} 条", + "admin.create": "创建", + "admin.dash-actions": "最近的操作", + "admin.dash-changes": "最近的变更", + "admin.dash-queue": "待处理", + "admin.dash-site": "站点", + "admin.dashboard": "仪表板", + "admin.delete": "删除", "admin.denied": "您似乎不被允许访问管理面板。", "admin.denied-title": "无法进入管理面板", + "admin.did-change": "修改", + "admin.did-create": "新建", + "admin.did-delete": "删除", + "admin.done": "已完成", + "admin.edit": "编辑", + "admin.email-at_signup": "注册时必填", + "admin.email-optional": "可选", + "admin.email-required": "必须验证", + "admin.empty": "还没有内容", + "admin.f-activated": "使用情况", + "admin.f-active": "账号启用", + "admin.f-active-theme": "站点主题", + "admin.f-admin-notes": "处理备注", + "admin.f-api-key": "API 密钥", + "admin.f-articles": "文章数", + "admin.f-auth-icon": "登录页图标", + "admin.f-author": "提交人", + "admin.f-badge-bg": "徽章背景色", + "admin.f-badge-border": "徽章边框", + "admin.f-badge-text": "徽章文字", + "admin.f-badge-text-color": "徽章文字色", + "admin.f-bio": "简介", + "admin.f-body": "正文", + "admin.f-can-message": "可发私信", + "admin.f-categories": "分类数", + "admin.f-category": "分类", + "admin.f-created": "提交时间", + "admin.f-css": "CSS", + "admin.f-default-role": "注册后的身分组", + "admin.f-description": "说明", + "admin.f-display-name": "显示名", + "admin.f-domain": "文章域名", + "admin.f-email": "邮箱", + "admin.f-email-policy": "邮箱验证要求", + "admin.f-external-url": "外部链接", + "admin.f-favicon": "站点图标", + "admin.f-footer-license": "页脚授权说明", + "admin.f-for-comments": "承载文章评论", + "admin.f-forum-active": "论坛启用", + "admin.f-forum-inactive-until": "论坛停用至", + "admin.f-granted-role": "通过后发放的身分组", + "admin.f-group-votes": "评分合并计票", + "admin.f-headline": "副标题", + "admin.f-hidden": "隐藏", + "admin.f-home-page": "主页名称", + "admin.f-icon": "图标", + "admin.f-icon-color": "图标颜色", + "admin.f-id": "编号", + "admin.f-inactive-until": "停用至", + "admin.f-indexed": "计入索引", + "admin.f-inline-mode": "用户名旁显示", + "admin.f-invite-kind": "类型", + "admin.f-invite-to": "发给谁", + "admin.f-is-staff": "可进管理后台", + "admin.f-media-domain": "文件域名", + "admin.f-membership-password": "密码入组", + "admin.f-membership-role": "入组后的身分组", + "admin.f-messages": "相关消息", + "admin.f-name": "名称", + "admin.f-new-name": "新名称", + "admin.f-order": "排序", + "admin.f-override": "覆盖", + "admin.f-page": "页面", + "admin.f-password": "口令", + "admin.f-password-help": "找回密码求助文案", + "admin.f-permission": "权限", + "admin.f-preview": "预览", + "admin.f-priority": "优先级", + "admin.f-profile-mode": "个人资料显示", + "admin.f-rank": "权限级别", + "admin.f-rating-mode": "评分系统", + "admin.f-reason": "举报理由", + "admin.f-reported": "被举报人", + "admin.f-reporter": "举报人", + "admin.f-result": "结果", + "admin.f-reviewed-by": "处理人", + "admin.f-revisions": "版本", + "admin.f-role": "身分组", + "admin.f-roles": "身分组", + "admin.f-section": "版块", + "admin.f-short-name": "简称", + "admin.f-signup-notice": "注册页提示", + "admin.f-site-slug": "站点缩写", + "admin.f-site-title": "站点标题", + "admin.f-slug": "标识名", + "admin.f-source": "源代码", + "admin.f-source-page": "来源页面", + "admin.f-staff-only": "仅管理员可见", + "admin.f-state": "状态", + "admin.f-status": "状态", + "admin.f-subject": "标题", + "admin.f-superuser": "超级管理员", + "admin.f-system-theme": "系统页主题", + "admin.f-tag": "标签", + "admin.f-tags": "标签数", + "admin.f-theme-mode": "样式来源", + "admin.f-threads": "主题数", + "admin.f-title": "标题", + "admin.f-updated": "更新时间", + "admin.f-user": "用户", + "admin.f-user-tags": "用户可否新建标签", + "admin.f-user-type": "类型", + "admin.f-username": "用户名", + "admin.f-users": "人数", + "admin.f-verified-role": "认领后的身分组", + "admin.f-votes-title": "计票组名称", + "admin.f-wikidot-account": "Wikidot 账号", + "admin.f-wikidot-username": "Wikidot 用户名", "admin.forum-categories": "论坛分类", "admin.forum-no-name": "名称不能为空", "admin.forum-no-section": "必须选一个版块", + "admin.forum-posts": "最近的发帖", "admin.forum-sections": "论坛版块", + "admin.group-forum": "论坛", + "admin.group-members": "成员", + "admin.group-queue": "处理", + "admin.group-records": "记录", + "admin.group-site": "站点", + "admin.h-activate": "把这个邮箱绑到该账号上，并寄出接受链接。对方走完链接账号才会启用。", + "admin.h-auth-icon": "登录、注册、找回密码这些页面顶上的图标。留空用内置的那个。", + "admin.h-badge-preview": "挂件与个人资料上显示的样子", + "admin.h-badge-text": "留空则显示标识名", + "admin.h-bot": "机器人不用密码登录，凭 API 密钥调用接口。", + "admin.h-builtin-slug": "内置身分组的标识名不能改", + "admin.h-claim-link": "只列出还没被认领的 Wikidot 账号。生成链接不改动账号，认领成功时它才转成普通账号，用户名沿用原来的 Wikidot 用户名。", + "admin.h-clear-addresses": "清掉之后要等账号再次登录或操作才会重新积累，已经存在的关联会一起消失。", + "admin.h-default-role": "任何人注册完成后自动获得", + "admin.h-favicon": "浏览器标签页上的那个小图标。PNG / JPEG / GIF / WebP / ICO，2 MB 以内。", + "admin.h-footer-license": "可使用wikitext。[[module time]] 会被渲染，其余模块按纯文本处理", + "admin.h-granted-role": "状态改为通过时立刻发放", + "admin.h-icon": "一个 SVG 文件。只有「用户名旁显示」选了图标时才会用到，颜色由下面那一项注进去。", + "admin.h-icon-color": "会被写进图标 SVG 里", + "admin.h-invite-link": "会先建一个停用的账号占位，对方走完链接才启用。", + "admin.h-link-made": "链接只显示这一次，复制走。它也记在邀请链接那一屏里。", + "admin.h-mail-invite": "会先建一个停用的账号占位，并把接受邀请的链接寄到这个邮箱。", + "admin.h-media-domain": "文件放在独立域名上，是一道安全边界，不要和文章域名填成同一个", + "admin.h-new-password": "至少 8 位。之后可以由本人在设置里改。", + "admin.h-password-help": "找回密码页上「收不到邮件？」点开后显示的内容。留空使用用默认文本。支持 wikitext，但不会渲染任何模块。", + "admin.h-permissions": "继承表示交给分类与站点默认值决定；拒绝优先于允许", + "admin.h-rename": "带分类就写成 分类:名称，不带分类就只写名称。", + "admin.h-steps": "回退几个版本", + "admin.h-suspicious": "把共用同一个地址的账号连起来；按住节点可以进行拖拽操作。", + "admin.h-system-theme": "登录、个人资料、管理后台这些页面用的主题", + "admin.h-theme-slug": "决定 /-/theme/<标识名>.css 这条地址", + "admin.h-until": "留空表示不设期限", + "admin.h-verified-role": "认领 Wikidot 账号成功后自动获得", + "admin.icon-bad-type": "这个文件的类型不对", + "admin.icon-too-large": "图标不能超过 2 MB", + "admin.inactive": "已停用", + "admin.invite-email-taken": "这个邮箱已经属于站点里的某个账号", + "admin.invite-kind-claim": "认领", + "admin.invite-kind-register": "邀请注册", + "admin.invite-no-email": "请填写邮箱", + "admin.invite-not-sent": "邮件没能发出去，检查一下邮件服务配置。", + "admin.invite-open": "未使用", + "admin.invite-sent": "邀请已发往 {email}。", "admin.invites": "邀请链接", + "admin.l-active": "账号可以登录", + "admin.l-badge-border": "给徽章描一圈边", + "admin.l-can-message": "可以给别人发私信", + "admin.l-for-comments": "这个分类用来放文章的评论", + "admin.l-forum-active": "可以在论坛发言", + "admin.l-group-votes": "在评分明细里单独成组", + "admin.l-indexed": "计入站点索引与搜索", + "admin.l-is-staff": "允许进入管理后台", + "admin.l-membership-password": "允许凭口令加入本站", + "admin.l-override": "为这个身分组单独设定权限", + "admin.l-section-hidden": "对所有人隐藏这个版块", + "admin.l-section-staff-only": "只有管理员看得到", + "admin.l-superuser": "拥有全部权限，不受身分组限制", + "admin.link-made": "链接已生成", + "admin.mail-invite": "邮件邀请", + "admin.make-link": "生成链接", "admin.membership": "入组申请", + "admin.name-taken": "这个用户名已经被占用", + "admin.new-bot": "新建机器人", + "admin.new-category": "新建分类", + "admin.new-claim-link": "生成认领链接", + "admin.new-invite-link": "生成邀请链接", + "admin.new-role": "新建身分组", + "admin.new-role-category": "新分类名称", + "admin.new-section": "新建版块", + "admin.new-tag": "新建标签", + "admin.new-theme": "新建主题", + "admin.new-user": "新建用户", + "admin.no-mailer": "这台服务器没有配置邮件发送，只能用生成链接的方式邀请。", + "admin.no-unclaimed": "没有还没被认领的 Wikidot 账号", + "admin.off": "已关闭", + "admin.on": "已开启", + "admin.open-invites": "未使用的邀请链接", + "admin.open-page": "打开页面", + "admin.page-bad-action": "不认识的操作", "admin.page-categories": "页面分类", + "admin.page-failed": "操作失败", + "admin.page-no-name": "新名称不能为空，也不能和原来的一样", + "admin.page-no-older": "这个页面没有那么多历史版本", + "admin.page-no-source": "源代码不能为空", + "admin.page-none-picked": "请先勾选页面", + "admin.page-source": "编辑源代码", + "admin.pages": "页面", + "admin.password-too-short": "密码至少要 8 位", + "admin.perm-allow": "允许", + "admin.perm-comment_articles": "评论文章", + "admin.perm-create_articles": "创建文章", + "admin.perm-create_forum_posts": "创建论坛帖子", + "admin.perm-create_forum_threads": "创建论坛主题", + "admin.perm-delete_articles": "删除文章", + "admin.perm-delete_forum_posts": "删除论坛帖子", + "admin.perm-deny": "拒绝", + "admin.perm-edit_articles": "编辑文章", + "admin.perm-edit_forum_posts": "编辑论坛帖子", + "admin.perm-edit_forum_threads": "编辑论坛主题", + "admin.perm-group-admin": "管理后台", + "admin.perm-group-articles": "文章", + "admin.perm-group-forum": "论坛", + "admin.perm-group-other": "其他", + "admin.perm-group-social": "用户互动", + "admin.perm-group-tickets": "工单管理", + "admin.perm-inherit": "继承", + "admin.perm-lock_articles": "锁定文章", + "admin.perm-lock_forum_threads": "锁定论坛主题", + "admin.perm-manage_article_authors": "管理文章作者", + "admin.perm-manage_article_files": "管理文章文件", + "admin.perm-manage_categories": "管理分类", + "admin.perm-manage_forum": "管理论坛", + "admin.perm-manage_permissions": "访问权限表", + "admin.perm-manage_roles": "管理角色", + "admin.perm-manage_site": "管理站点", + "admin.perm-manage_tags": "管理标签", + "admin.perm-manage_updates": "管理系统更新", + "admin.perm-manage_users": "管理用户", + "admin.perm-move_articles": "移动文章", + "admin.perm-move_forum_threads": "移动论坛主题", + "admin.perm-pin_forum_threads": "置顶论坛主题", + "admin.perm-rate_articles": "给文章投票", + "admin.perm-reset_article_votes": "重置投票", + "admin.perm-review_membership_applications": "审核入组申请", + "admin.perm-send_direct_message": "发送私信", + "admin.perm-tag_articles": "编辑文章标签", + "admin.perm-view_actions_log": "查看操作记录", + "admin.perm-view_article_comments": "查看文章评论", + "admin.perm-view_articles": "浏览文章", + "admin.perm-view_forum_categories": "浏览论坛分类", + "admin.perm-view_forum_posts": "浏览论坛帖子", + "admin.perm-view_forum_sections": "浏览论坛版块", + "admin.perm-view_forum_threads": "浏览论坛主题", + "admin.perm-view_hidden_forum_sections": "浏览隐藏的论坛版块", + "admin.perm-view_reported_full_conversation": "查看被检举会话全部记录", + "admin.perm-view_sensitive_info": "查看敏感信息", + "admin.perm-view_user_reports": "查看用户检举", + "admin.perm-view_user_tickets": "查看用户工单", + "admin.perm-view_votes_timestamp": "查看投票时间", + "admin.permissions": "权限", + "admin.posts-with-comments": "含文章评论", + "admin.posts-without-comments": "只看论坛", + "admin.queue-none": "没有你能处理的队列", + "admin.rating-default": "跟随站点", + "admin.rating-disabled": "关闭", + "admin.rating-stars": "星级", + "admin.rating-updown": "顶踩", + "admin.rename": "重命名", "admin.report-bad-status": "状态的取值不对", + "admin.report-content": "举报内容", + "admin.report-status-dismissed": "已驳回", + "admin.report-status-pending": "待处理", + "admin.report-status-reviewed": "已处理", "admin.reports": "用户举报", + "admin.reset-votes": "重置评分", + "admin.reset-votes-confirm": "确认清空 {name} 的全部评分", + "admin.reset-votes-warning": "这个账号投过的每一票都会被删掉，受影响文章的分数会立刻变化。无法撤销。", + "admin.review": "处理", + "admin.revoke": "作废", "admin.role-bad-mode": "展示方式的取值不对", "admin.role-bad-slug": "标识符只能包含英文字母、数字、- 和 _", + "admin.role-badge": "徽章与图标", + "admin.role-basics": "基本信息", "admin.role-builtin": "内置身分组不能删除", "admin.role-categories": "身分组分类", "admin.role-category-no-name": "分类名称不能为空", + "admin.role-inline-badge": "徽章", + "admin.role-inline-hidden": "不显示", + "admin.role-inline-icon": "图标", + "admin.role-profile-badge": "徽章", + "admin.role-profile-hidden": "不显示", + "admin.role-profile-status": "状态", + "admin.role-votes": "评分显示", "admin.roles": "身分组", + "admin.save": "保存", + "admin.search": "搜索", + "admin.search-pages": "页面名或标题", + "admin.search-tags": "标签名", + "admin.search-users": "用户名、显示名或邮箱", + "admin.send": "发送", + "admin.settings": "设置", + "admin.sign-out": "登出", "admin.site": "站点设置", + "admin.site-accounts": "注册与账号", "admin.site-bad-mode": "评分系统或标签设置的取值不对", "admin.site-bad-policy": "邮箱验证要求的取值不对", "admin.site-bad-slug": "站点缩写只能包含英文字母、数字、- 和 _", + "admin.site-content": "内容默认值", + "admin.site-identity": "站点信息", + "admin.site-look": "外观", + "admin.site-membership": "密码入组", "admin.site-no-domain": "文章域名与文件域名都不能为空", "admin.site-no-home": "主页名称不能为空", "admin.site-no-title": "站点标题不能为空", + "admin.superuser": "超级管理员", + "admin.suspicious": "可疑活动", "admin.tag-bad-slug": "标识名只能包含英文字母、数字、- 和 _", "admin.tag-categories": "标签分类", "admin.tag-no-name": "名称不能为空", + "admin.tagmode-default": "跟随站点", + "admin.tagmode-disabled": "不允许", + "admin.tagmode-enabled": "允许", "admin.tags": "标签", "admin.theme-bad-mode": "类型只能是 inline 或 external", "admin.theme-bad-slug": "标识名只能包含英文字母、数字、- 和 _", + "admin.theme-mode-external": "外部链接", + "admin.theme-mode-inline": "内嵌 CSS", "admin.theme-no-name": "主题名称不能为空", "admin.theme-no-url": "选了外部链接就必须填链接地址", + "admin.theme-settings": "主题设置", "admin.themes": "主题", + "admin.ticket-content": "工单内容", + "admin.ticket-status-approved": "已通过", + "admin.ticket-status-closed": "已关闭", + "admin.ticket-status-pending": "待处理", + "admin.ticket-status-rejected": "已拒绝", "admin.tickets": "支持工单", "admin.title": "站点管理", + "admin.user-identity": "身分", "admin.user-no-name": "用户名不能为空", + "admin.user-state": "状态与限制", + "admin.user-type-bot": "机器人", + "admin.user-type-normal": "普通用户", + "admin.user-type-system": "系统用户", + "admin.user-type-wikidot": "Wikidot 用户", "admin.users": "用户", + "admin.view-all": "查看全部", + "admin.warn-delete": "页面会连同它的历史、附件和评分会一起删掉。无法撤销。", + "admin.warn-revert": "回退会连同标题、标签、父页面、评分和附件一起还原。", + "admin.yes": "是", "api-bad-json": "请求体中的JSON格式无效", "api-bad-notification-type": "无效的通知类型", "api-bad-page-id": "无效的页面ID", @@ -105,6 +437,8 @@ "email.changed-title": "邮箱已更换", "email.dead": "这个链接已经被使用过或者过期，请回到设置页重新发起。", "email.dead-title": "链接已失效", + "email.invite-body": "你好，\n\n有人邀请你加入 {site}。点击下面的链接即可接受邀请并设置密码：\n\n{link}\n\n如果你不想接受，忽略这封邮件即可。\n\n此致，\n{site}\n", + "email.invite-subject": "邀请你加入 {site}", "email.moved-body": "{name} 你好，\n\n你在 {site} 的绑定邮箱刚刚被更改为了 {email}。\n\n如果这是你本人的操作，无需理会这封邮件。\n\n如果不是你，请点击下面的链接立刻撤销该改绑操作。撤销之后账号上的所有登录状态和密码都会作废，你需要重新设置密码：\n\n{link}\n\n此致，\n{site}\n", "email.moved-subject": "{site} 的绑定邮箱已被更换", "email.password-body": "{name} 你好，\n\n你在 {site} 的密码刚刚遭到修改。\n\n如果这不是你本人的操作，立刻用下面的地址重置密码：\n\n{link}\n\n此致，\n{site}\n", @@ -356,8 +690,8 @@ "reset.email": "邮箱地址", "reset.error-mismatch": "两次输入的密码不一致。", "reset.help-default": "请联系您的网站管理员。", - "reset.help-title": "邮箱收不到信", - "reset.help-toggle": "邮箱收不到信？", + "reset.help-title": "收不到邮件", + "reset.help-toggle": "收不到邮件？", "reset.login": "登录", "reset.mail-body": "你好，\n\n我们收到了与你邮箱关联的账户的密码重置请求。要开始重置你的账户密码，请点击下面的链接：\n\n{link}\n\n此链接仅能使用一次。如果你需要再次重置密码，请访问 {home} 并重新发起重置请求。\n\n如果你未请求重置密码，请忽略此邮件。\n\n此致，\n{site}\n", "reset.mail-subject": "{site} 的密码重置", diff --git a/internal/module/module.go b/internal/module/module.go index 839d08fb..62fd41a4 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -53,7 +53,7 @@ type Data interface { ArticleVotes(articleID int64) ([]db.ArticleVote, error) ReplaceVote(articleID, userID int64, rate *float64, roleID *int64) (*db.Vote, error) VoteGroupRole(userID *int64) (*int64, error) - AddActionLog(user *db.User, kind, meta string) error + SeenAddress(user *db.User) error ArticleObject(article *db.Article, viewer *db.User) (*perms.Object, error) UserJSON(u *db.User) (wikijson.Object, error) diff --git a/internal/modules/rateapi.go b/internal/modules/rateapi.go index f1fa89f6..375a590a 100644 --- a/internal/modules/rateapi.go +++ b/internal/modules/rateapi.go @@ -129,11 +129,10 @@ func rateVote(env module.Env, params map[string]string) (wikijson.Object, error) if err != nil { return nil, err } - old, err := env.Data.ReplaceVote(article.ID, userID, value, role) - if err != nil { + if _, err := env.Data.ReplaceVote(article.ID, userID, value, role); err != nil { return nil, err } - if err := logVote(env, article, old, value); err != nil { + if err := env.Data.SeenAddress(env.User); err != nil { return nil, err } return rateGetRating(env, params) @@ -162,28 +161,6 @@ func voteValue(env module.Env, raw, mode string) (*float64, error) { return &value, nil } -func logVote(env module.Env, article *db.Article, old *db.Vote, value *float64) error { - var was, now any - if old != nil { - was = old.Rate - } - if value != nil { - now = *value - } - meta, err := wikijson.Marshal(wikijson.Object{ - {Key: "article", Value: article.FullName()}, - {Key: "old_vote", Value: was}, - {Key: "new_vote", Value: now}, - {Key: "is_new", Value: value != nil && old == nil}, - {Key: "is_change", Value: value != nil && old != nil}, - {Key: "is_remove", Value: value == nil && old != nil}, - }) - if err != nil { - return err - } - return env.Data.AddActionLog(env.User, db.ActionVote, meta) -} - func ratedArticle(env module.Env) (*db.Article, error) { if env.Page == nil || env.Page.Article == nil { return nil, &module.Error{Message: env.Text("module-rate-no-page")} diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 3b63e1a1..1286ad71 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -27,8 +27,6 @@ func (m moduleData) HiddenCategories(user *db.User) ([]string, error) { return HiddenCategories(m.repo.ctx, m.repo.db, user) } -// HiddenCategories asks the same question once per category, the way the page -// list does. There is no query for it because permissions are resolved in Go. func HiddenCategories(ctx context.Context, d *db.DB, user *db.User) ([]string, error) { names, err := d.CategoryNames(ctx) if err != nil { @@ -152,8 +150,6 @@ func (m moduleData) RenderUser(u db.User) (string, error) { return m.repo.renderUser(&u, printuser.Options{Avatar: true, Hover: true}) } -// A post with no author is one the site itself made, which is what the system -// chip stands for. func (m moduleData) RenderUserByID(id *int64) (string, error) { if id == nil { return m.repo.users.System(printuser.Options{Hover: true}), nil @@ -297,15 +293,11 @@ func (m moduleData) VoteGroupRole(userID *int64) (*int64, error) { return m.repo.db.VoteGroupRole(m.repo.ctx, userID) } -// The address is the one the entry layer trusted, not whatever the request -// claimed, so a reverse proxy cannot be talked into logging a made-up client. -func (m moduleData) AddActionLog(user *db.User, kind, meta string) error { - var id *int64 - name := "" - if user != nil { - id, name = &user.ID, user.Username +func (m moduleData) SeenAddress(user *db.User) error { + if user == nil { + return nil } - return m.repo.db.AddActionLog(m.repo.ctx, id, name, kind, meta, m.repo.opts.ClientIP, time.Now().UTC()) + return m.repo.db.SeenAddress(m.repo.ctx, user.ID, m.repo.opts.ClientIP, time.Now().UTC()) } func (m moduleData) ArticleObject(article *db.Article, viewer *db.User) (*perms.Object, error) { diff --git a/internal/webapi/create.go b/internal/webapi/create.go index c5df9259..bbb36ab2 100644 --- a/internal/webapi/create.go +++ b/internal/webapi/create.go @@ -160,7 +160,7 @@ func (h *Articles) writeNewArticle(r *http.Request, current *db.Site, name strin if err != nil { return err } - if err := h.logCreate(r, fresh, user); err != nil { + if err := h.seen(r, user); err != nil { return err } if err := h.notifyRevision(r, fresh, rev); err != nil { diff --git a/internal/webapi/delete.go b/internal/webapi/delete.go index 5f42fe21..4a53b076 100644 --- a/internal/webapi/delete.go +++ b/internal/webapi/delete.go @@ -43,14 +43,10 @@ func (h *Articles) remove(r *http.Request, loc *i18n.Localizer, name string) (st return "", 0, errForbidden } - rating, err := h.rating(r, article) - if err != nil { - return "", 0, err - } if err := h.deps.DB.DeleteArticle(ctx, article.ID, article.FullName()); err != nil { return "", 0, err } - if err := h.logDelete(r, article, user, rating); err != nil { + if err := h.seen(r, user); err != nil { return "", 0, err } h.dropMedia(article.MediaName) diff --git a/internal/webapi/notify.go b/internal/webapi/notify.go index 87c907f5..fd363cfa 100644 --- a/internal/webapi/notify.go +++ b/internal/webapi/notify.go @@ -1,21 +1,16 @@ package webapi import ( - "encoding/json" "net/http" - "net/netip" "time" "github.com/WikitTeam/ProjectWikit/internal/auth" "github.com/WikitTeam/ProjectWikit/internal/db" - "github.com/WikitTeam/ProjectWikit/internal/page" "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) -// Every log entry a save writes is announced on its own, so an edit that both -// renames and retitles arrives as two. func (h *Articles) notifyRevision(r *http.Request, article *db.Article, rev db.Revision) error { ctx := r.Context() if rev.EntryID == 0 { @@ -26,7 +21,7 @@ func (h *Articles) notifyRevision(r *http.Request, article *db.Article, rev db.R return err } editor := auth.FromContext(ctx) - if err := h.logEdit(r, article, entry, editor); err != nil { + if err := h.seen(r, editor); err != nil { return err } readers, err := h.revisionReaders(r, article, editor) @@ -94,63 +89,13 @@ func (h *Articles) revisionReaders(r *http.Request, article *db.Article, editor return out, nil } -// The revision that created the page is left out, since the page's own entry -// already says it was created. -func (h *Articles) logEdit(r *http.Request, article *db.Article, entry db.LogEntry, editor *db.User) error { - if entry.Type == db.LogNew { +func (h *Articles) seen(r *http.Request, user *db.User) error { + if user == nil || h.deps.Trust == nil { return nil } - meta, err := decodeMeta(entry.Meta) - if err != nil { - return err - } - body, err := wikijson.Marshal(wikijson.Object{ - {Key: "article", Value: article.FullName()}, - {Key: "comment", Value: entry.Comment}, - {Key: "edit_type", Value: entry.Type}, - {Key: "rev_number", Value: entry.RevNumber}, - {Key: "log_entry_meta", Value: fromJSON(meta)}, - }) - if err != nil { - return err - } - return h.act(r, editor, db.ActionEditArticle, body) -} - -func (h *Articles) logCreate(r *http.Request, article *db.Article, editor *db.User) error { - body, err := json.Marshal(map[string]any{"article": article.FullName()}) - if err != nil { - return err - } - return h.act(r, editor, db.ActionCreateArticle, string(body)) -} - -func (h *Articles) logDelete(r *http.Request, article *db.Article, editor *db.User, rating page.Rating) error { - body, err := json.Marshal(map[string]any{ - "article": article.FullName(), - "rating": rating.Value, - "votes": rating.Votes, - "popularity": rating.Popularity, - }) - if err != nil { - return err - } - return h.act(r, editor, db.ActionRemoveArticle, string(body)) -} - -// The address is the one the entry layer trusted, not whatever the request -// claimed, so a reverse proxy cannot be talked into logging a made-up client. -func (h *Articles) act(r *http.Request, user *db.User, kind, meta string) error { - var id *int64 - name := "" - if user != nil { - id, name = &user.ID, user.Username - } - var ip *netip.Addr - if h.deps.Trust != nil { - if addr, ok := h.deps.Trust.ClientIP(r); ok { - ip = &addr - } + addr, ok := h.deps.Trust.ClientIP(r) + if !ok { + return nil } - return h.deps.DB.AddActionLog(r.Context(), id, name, kind, meta, ip, time.Now().UTC()) + return h.deps.DB.SeenAddress(r.Context(), user.ID, &addr, time.Now().UTC()) } diff --git a/static/wikit-admin.css b/static/wikit-admin.css new file mode 100644 index 00000000..8faf62ca --- /dev/null +++ b/static/wikit-admin.css @@ -0,0 +1,337 @@ +.admin-shell .container { max-width: 1180px; margin: 0 auto; padding: 0 24px; } +.admin-shell .row { display: flex; align-items: flex-start; } +.admin-shell .row > .span3 { width: 232px; flex: none; } +.admin-shell .row > .span9 { flex: 1; min-width: 0; } +.admin-shell .row-fluid { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 0 36px; } +.admin-shell .row-fluid > .span12 { grid-column: 1 / -1; } +.admin-shell .row-fluid > .span6 { min-width: 0; } +.admin-shell .pull-right { margin-left: auto; } +.admin-shell .muted { color: var(--muted); } +.admin-shell .unstyled { list-style: none; margin: 0; padding: 0; } + +body.admin { padding-top: 66px; } +.admin-shell #admin-header { position: fixed; top: 0; left: 0; right: 0; z-index: 100; } +.admin-shell #admin-header .navbar-inner { background: var(--paper); border-bottom: 1px solid var(--rule); } +.admin-shell #admin-header .navbar-inner .container { + display: flex; align-items: center; gap: 14px; + padding-top: 12px; padding-bottom: 12px; +} +.admin-shell #admin-header .brand { + font-size: 15px; font-weight: 500; letter-spacing: -0.01em; + padding-right: 14px; border-right: 1px solid var(--rule); + line-height: 1.2; text-decoration: none; +} +.admin-shell #admin-header .title { font-size: 13px; line-height: 1.35; } +.admin-shell #admin-header .title a { text-decoration: none; } +.admin-shell #admin-header .title a:hover { text-decoration: underline; text-underline-offset: 3px; } +.admin-shell #admin-header .title .admin-panel { + display: block; font-family: var(--font-mono); font-size: 11px; + color: var(--muted); letter-spacing: 0.02em; +} +.admin-shell #admin-login-status { margin-left: auto; display: flex; align-items: center; gap: 12px; } + +.admin-shell #site-manager-menu { + padding: 26px 0 60px; + border-right: 1px solid var(--rule); + align-self: stretch; +} +.admin-shell .menu-box { padding-right: 20px; } +.admin-shell .menu-box .nav-stacked { list-style: none; margin: 0; padding: 0; } +.admin-shell .menu-box .nav-stacked + .nav-stacked { + margin-top: 4px; padding-top: 4px; border-top: 1px solid var(--rule); +} +.admin-shell .menu-box .nav-stacked > li > a { + display: flex; align-items: center; gap: 10px; + padding: 7px 12px; + text-decoration: none; color: var(--muted); font-size: 14px; + border-left: 2px solid transparent; + border-radius: 0 var(--rad-sm) var(--rad-sm) 0; +} +.admin-shell .menu-box .nav-stacked > li > a > i { font-size: 12px; width: 14px; text-align: center; flex: none; } +.admin-shell .menu-box .nav-stacked > li > a:hover { color: var(--ink); background: var(--well); } +.admin-shell .menu-box .nav-stacked > li.selected > a { + color: var(--ink); background: var(--well); + border-left-color: var(--ink); font-weight: 500; +} +.admin-shell .menu-box .first-button::after { + content: "\203A"; margin-left: auto; + font-family: var(--font-mono); color: var(--rule); font-size: 14px; +} +.admin-shell .menu-box .first-button:hover::after { color: var(--muted); } +.admin-shell .menu-box .back { + font-family: var(--font-mono); font-size: 11px; + letter-spacing: 0.06em; text-transform: uppercase; +} +.admin-shell .menu-box .group-name > a { + color: var(--muted); font-size: 11px; font-weight: 500; + text-transform: uppercase; letter-spacing: 0.08em; + cursor: default; padding-bottom: 4px; +} +.admin-shell .menu-box .group-name > a:hover { background: transparent; color: var(--muted); } +.admin-shell .menu-box .count { + margin-left: auto; font-family: var(--font-mono); font-size: 10px; + padding: 1px 6px; border: 1px solid var(--rule); border-radius: 999px; +} +.admin-shell .menu-box .first-button .count { margin-right: 8px; } + +.admin-shell #sm-action-area { padding: 26px 0 96px 32px; } +.admin-shell .page-header { margin-bottom: 26px; } +.admin-shell .page-header h1 { + font-size: 32px; font-weight: 500; margin: 0; + line-height: 1.1; letter-spacing: -0.02em; text-wrap: balance; +} +.admin-shell .page-header h1 small { + font-size: 14px; color: var(--muted); font-weight: 400; + letter-spacing: 0; margin-left: 12px; +} + +.admin-shell .widget-box { margin-bottom: 32px; } +.admin-shell #sm-action-area > * + .widget-box { margin-top: 28px; } +.admin-shell .widget-title { + display: flex; align-items: center; gap: 8px; + padding-bottom: 8px; border-bottom: 1px solid var(--ink); +} +.admin-shell .widget-title > i { color: var(--muted); font-size: 11px; } +.admin-shell .widget-title h5 { + margin: 0; font-size: 11px; font-weight: 500; + text-transform: uppercase; letter-spacing: 0.08em; color: var(--muted); +} +.admin-shell .widget-title .pull-right { font-size: 11px; } +.admin-shell .widget-title .link { color: var(--muted); text-decoration: none; } +.admin-shell .widget-title .link:hover { color: var(--ink); text-decoration: underline; text-underline-offset: 3px; } +.admin-shell .widget-content { padding-top: 2px; } +.admin-shell .widget-content .table a { text-decoration: none; } +.admin-shell .widget-content .table a:hover { text-decoration: underline; text-underline-offset: 3px; } +.admin-shell .table-spec td:first-child { color: var(--muted); width: 40%; } +.admin-shell .table-spec td:first-child a, +.admin-shell .table-spec td:first-child strong { color: var(--ink); } + +.admin-shell .table { width: 100%; border-collapse: collapse; font-size: 14px; } +.admin-shell .table th { + text-align: left; padding: 10px 12px 8px; white-space: nowrap; + font-size: 11px; font-weight: 500; text-transform: uppercase; + letter-spacing: 0.08em; color: var(--muted); + border-bottom: 1px solid var(--rule); +} +.admin-shell .table td { padding: 10px 12px; border-bottom: 1px solid var(--rule); vertical-align: baseline; } +.admin-shell .table th:first-child, .admin-shell .table td:first-child { padding-left: 0; } +.admin-shell .table th:last-child, .admin-shell .table td:last-child { padding-right: 0; } +.admin-shell .table-condensed td { padding: 7px 12px; } +.admin-shell .table-hover tbody tr:hover { background: var(--well); } +.admin-shell .table th.right, .admin-shell .table td.right { text-align: right; } +.admin-shell .table th.pick, .admin-shell .table td.pick { width: 28px; padding-right: 0; } +body.admin .system-content .content .table td.pick input { width: auto; margin: 0; } +.admin-shell .batch-bar { + display: flex; align-items: center; gap: 12px; flex-wrap: wrap; + padding: 14px 0; border-bottom: 1px solid var(--rule); +} +.admin-shell .batch-revert { display: flex; align-items: center; gap: 8px; } +body.admin .system-content .content .batch-revert input { width: 72px; } +.admin-shell .table .num { text-align: right; font-family: var(--font-mono); font-size: 13px; font-variant-numeric: tabular-nums; } +.admin-shell .table .num.zero { color: var(--muted); } +.admin-shell .pre { + margin: 0; padding: 10px 12px; background: var(--well); + border-radius: var(--rad); font-family: var(--font-mono); font-size: 12px; + line-height: 1.6; white-space: pre-wrap; word-break: break-word; + max-height: 320px; overflow: auto; +} +.admin-shell .inline-form { display: flex; align-items: center; gap: 6px; flex-wrap: wrap; } +body.admin .system-content .content .link-out { + width: 100%; max-width: 620px; font-family: var(--font-mono); font-size: 12px; + background: var(--well); +} +.admin-shell p.hint { margin: 12px 0; } +.admin-shell .table-empty { padding: 14px 0; border-bottom: 1px solid var(--rule); color: var(--muted); font-size: 13px; } + +.admin-shell .changes-list td { padding-top: 12px; padding-bottom: 12px; } +.admin-shell .changes-list td.date { + width: 92px; font-family: var(--font-mono); font-size: 11px; + color: var(--muted); line-height: 1.5; white-space: nowrap; + font-variant-numeric: tabular-nums; +} +.admin-shell .changes-list td.date strong { font-weight: 500; color: var(--muted); } +.admin-shell .changes-list .title { font-weight: 500; text-decoration: none; } +.admin-shell .changes-list .title:hover { text-decoration: underline; text-underline-offset: 3px; } +.admin-shell .changes-list .comment { font-size: 12px; color: var(--muted); margin-top: 2px; } +.admin-shell .printuser a { text-decoration: none; } +.admin-shell .printuser a:hover { text-decoration: underline; text-underline-offset: 3px; } +.admin-shell .stamp { font-family: var(--font-mono); font-size: 11px; color: var(--muted); font-variant-numeric: tabular-nums; } + +.admin-shell .alert { + border: 1px solid var(--rule); border-radius: var(--rad); + padding: 11px 14px; font-size: 13px; margin-bottom: 16px; +} +.admin-shell .alert h4 { margin: 0 0 6px; font-size: 14px; font-weight: 500; } +.admin-shell .alert p { margin: 0 0 8px; } +.admin-shell .alert p:last-child { margin-bottom: 0; } +.admin-shell .alert ul { margin: 0 0 10px; padding-left: 18px; color: var(--muted); } +.admin-shell .alert code { font-family: var(--font-mono); font-size: 12px; color: var(--ink); } +.admin-shell .alert-error { border-color: var(--danger); color: var(--danger); } +.admin-shell .alert-error code, .admin-shell .alert-error strong { color: var(--danger); } + +.admin-shell .state { + display: inline-block; font-family: var(--font-mono); + font-size: 10px; letter-spacing: 0.1em; text-transform: uppercase; + padding: 1px 7px; border: 1px solid var(--rule); border-radius: var(--rad-sm); + color: var(--muted); white-space: nowrap; line-height: 16px; +} +.admin-shell .state.on { border-color: var(--ink); color: var(--ink); } +.admin-shell .state.strong { background: var(--ink); color: var(--paper); border-color: var(--ink); } +.admin-shell .state.pending { border-style: dashed; } +.admin-shell .state.bad { border-color: var(--danger); color: var(--danger); } + +body.admin .system-content .content .btn { + display: inline-flex; align-items: center; gap: 6px; + margin: 0; padding: 7px 12px; width: auto; + background: transparent; color: var(--ink); + border: 1px solid var(--rule); border-radius: var(--rad); + font-family: var(--font-mono); font-size: 11px; letter-spacing: 0.1em; + text-transform: uppercase; font-weight: 500; cursor: pointer; + text-decoration: none; white-space: nowrap; +} +body.admin .system-content .content .btn:hover { border-color: var(--ink); } +body.admin .system-content .content .btn-primary { background: var(--ink); color: var(--paper); border-color: var(--ink); } +body.admin .system-content .content .btn-primary:hover { background: #000; } +body.admin .system-content .content .btn-danger { background: transparent; color: var(--danger); border-color: var(--danger); } +body.admin .system-content .content .btn-danger:hover { background: var(--danger); color: var(--paper); } +body.admin .system-content .content .btn-mini { padding: 4px 8px; font-size: 10px; } +body.admin .system-content .content .btn.pull-right { margin-left: auto; } +.admin-shell .btn-group { display: inline-flex; } +.admin-shell .btn-group > .btn { border-radius: 0; margin-left: -1px; } +.admin-shell .btn-group > .btn:first-child { border-radius: var(--rad) 0 0 var(--rad); margin-left: 0; } +.admin-shell .btn-group > .btn:last-child { border-radius: 0 var(--rad) var(--rad) 0; } +.admin-shell .btn-group > .btn:only-child { border-radius: var(--rad); } +.admin-shell .btn-group > .btn:hover { position: relative; z-index: 1; } +.admin-shell .btn-toolbar { display: flex; gap: 10px; flex-wrap: wrap; margin-bottom: 18px; } + +.admin-shell .nav-pills { list-style: none; display: flex; gap: 2px; margin: 0 0 14px; padding: 0; flex-wrap: wrap; } +.admin-shell .nav-pills > li > a { + display: flex; align-items: center; gap: 7px; + padding: 6px 10px; font-size: 13px; color: var(--muted); + text-decoration: none; border-bottom: 2px solid transparent; +} +.admin-shell .nav-pills > li > a:hover { color: var(--ink); } +.admin-shell .nav-pills > li.active > a { color: var(--ink); border-bottom-color: var(--ink); font-weight: 500; } + +.admin-shell .pagination { margin-top: 16px; } +.admin-shell .pagination ul { list-style: none; display: flex; gap: 2px; margin: 0; padding: 0; } +.admin-shell .pagination li > a, .admin-shell .pagination li > span { + display: block; padding: 3px 9px; text-decoration: none; + border: 1px solid var(--rule); border-radius: var(--rad-sm); + font-family: var(--font-mono); font-size: 11px; color: var(--muted); +} +.admin-shell .pagination li > a:hover { border-color: var(--ink); color: var(--ink); } +.admin-shell .pagination li.active > span { background: var(--ink); color: var(--paper); border-color: var(--ink); font-weight: 500; } + +.admin-shell .form-horizontal { margin: 0; } +.admin-shell .widget-box.narrow { max-width: 860px; } +.admin-shell .control-group { + display: grid; grid-template-columns: 148px minmax(0, 1fr); + gap: 0 18px; align-items: baseline; + padding: 11px 0; border-bottom: 1px solid var(--rule); +} +.admin-shell .control-group:first-child { border-top: 1px solid var(--rule); } +body.admin .system-content .content .control-label { + font-size: 11px; font-weight: 500; text-transform: uppercase; + letter-spacing: 0.08em; color: var(--muted); margin: 0; padding-top: 3px; +} +.admin-shell .controls { min-width: 0; } +.admin-shell .hint { display: block; font-size: 12px; color: var(--muted); margin-top: 4px; } +.admin-shell .hint code { font-family: var(--font-mono); } +.admin-shell .form-actions { display: flex; align-items: center; gap: 12px; padding-top: 18px; flex-wrap: wrap; } + +body.admin .system-content .content input[type=text], +body.admin .system-content .content input[type=email], +body.admin .system-content .content input[type=password], +body.admin .system-content .content input[type=number], +body.admin .system-content .content input[type=datetime-local], +body.admin .system-content .content select, +body.admin .system-content .content textarea { + border: 1px solid var(--rule); border-radius: var(--rad); + padding: 6px 9px; background: var(--paper); + font-size: 14px; width: 100%; +} +body.admin .system-content .content input[type=text]:focus, +body.admin .system-content .content input[type=email]:focus, +body.admin .system-content .content input[type=password]:focus, +body.admin .system-content .content input[type=number]:focus, +body.admin .system-content .content input[type=datetime-local]:focus, +body.admin .system-content .content select:focus, +body.admin .system-content .content textarea:focus { outline: none; border-color: var(--ink); } +body.admin .system-content .content textarea { + font-family: var(--font-mono); font-size: 13px; line-height: 1.6; resize: vertical; +} +body.admin .system-content .content input[type=file] { font-size: 13px; color: var(--muted); } +body.admin .system-content .content .checkbox { + display: flex; align-items: center; gap: 8px; + font-size: 14px; font-weight: 400; margin: 0 0 4px; +} +body.admin .system-content .content .checkbox input { width: auto; } +.admin-shell .narrow-2 { max-width: 150px; } +.admin-shell .narrow-3 { max-width: 230px; } +.admin-shell .narrow-4 { max-width: 310px; } +.admin-shell .narrow-5 { max-width: 390px; } +.admin-shell .input-prepend { display: flex; align-items: stretch; } +.admin-shell .input-prepend .add-on { + display: flex; align-items: center; padding: 0 10px; + border: 1px solid var(--rule); border-right: none; + border-radius: var(--rad) 0 0 var(--rad); + background: var(--well); color: var(--muted); font-size: 12px; +} +body.admin .system-content .content .input-prepend input { border-radius: 0 var(--rad) var(--rad) 0; } +.admin-shell .form-search { margin-bottom: 14px; } +.admin-shell .form-search .input-append { display: flex; align-items: stretch; max-width: 460px; } +body.admin .system-content .content .form-search .search-query { border-radius: var(--rad) 0 0 var(--rad); flex: 1; } +body.admin .system-content .content .form-search .btn { border-radius: 0 var(--rad) var(--rad) 0; margin-left: -1px; flex: none; } + +.admin-shell .perm-matrix .perm-code { + display: block; font-family: var(--font-mono); + font-size: 11px; color: var(--muted); margin-top: 1px; +} +.admin-shell .perm-matrix th.opt, .admin-shell .perm-matrix td.opt { width: 76px; text-align: center; } +body.admin .system-content .content .perm-matrix td.opt input { width: auto; margin: 0; } +body.admin .system-content .content input[type=radio], +body.admin .system-content .content input[type=checkbox] { accent-color: var(--ink); } +.admin-shell .perm-matrix .perm-group td { + padding-top: 22px; border-bottom: 1px solid var(--ink); + font-size: 11px; font-weight: 500; text-transform: uppercase; + letter-spacing: 0.08em; color: var(--ink); +} +.admin-shell .perm-matrix tbody tr.perm-group:hover { background: transparent; } + +.admin-shell .sus-users { + position: relative; + height: 70vh; + min-height: 480px; + border: 1px solid var(--rule); + border-radius: var(--rad); + overflow: hidden; +} + +.admin-shell .badge-preview { + display: inline-block; padding: 2px 9px; border-radius: var(--rad-sm); + font-size: 12px; line-height: 18px; +} +.admin-shell .upload-row { display: flex; align-items: center; gap: 12px; flex-wrap: wrap; } +.admin-shell .icon-preview { + width: 32px; height: 32px; object-fit: contain; flex: none; + border: 1px solid var(--rule); border-radius: var(--rad-sm); padding: 3px; background: var(--paper); +} + +.admin-shell a:focus-visible, +body.admin .system-content .content .btn:focus-visible, +body.admin .system-content .content input:focus-visible, +body.admin .system-content .content select:focus-visible, +body.admin .system-content .content textarea:focus-visible { + outline: 2px solid var(--ink); outline-offset: 2px; +} + +@media (max-width: 900px) { + .admin-shell .row { flex-direction: column; } + .admin-shell .row > .span3 { + width: 100%; border-right: none; border-bottom: 1px solid var(--rule); + } + .admin-shell #sm-action-area { padding-left: 0; } + .admin-shell .row-fluid { grid-template-columns: 1fr; } + .admin-shell .control-group { grid-template-columns: 1fr; gap: 4px; } +} From 35448c0f395e00ea33c06b9f966fb84dd6a0aa8b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 16:13:13 +0900 Subject: [PATCH 327/428] add strings for the user activity screen --- internal/i18n/locales/zh-hans.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 87d897f5..3e1347c4 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -10,6 +10,10 @@ "accept.username": "用户名", "admin.activate": "激活账号", "admin.active": "启用", + "admin.activity-edits": "最近编辑", + "admin.activity-of": "{name} 的动态", + "admin.activity-posts": "最近发帖", + "admin.activity-votes": "最近投票", "admin.add": "新增", "admin.addresses-cleared": "已清掉 {n} 条 IP 记录。", "admin.admin-log": "操作记录", @@ -367,6 +371,7 @@ "admin.ticket-status-rejected": "已拒绝", "admin.tickets": "支持工单", "admin.title": "站点管理", + "admin.user-activity": "查看动态", "admin.user-identity": "身分", "admin.user-no-name": "用户名不能为空", "admin.user-state": "状态与限制", From d2420a24397e8ead0cf1b649a2ca268b2f1b3b74 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 16:13:13 +0900 Subject: [PATCH 328/428] add the user activity screen --- internal/admin/templates/user_activity.html | 75 +++++++ internal/admin/useractivity.go | 214 ++++++++++++++++++++ 2 files changed, 289 insertions(+) create mode 100644 internal/admin/templates/user_activity.html create mode 100644 internal/admin/useractivity.go diff --git a/internal/admin/templates/user_activity.html b/internal/admin/templates/user_activity.html new file mode 100644 index 00000000..9aa5dec9 --- /dev/null +++ b/internal/admin/templates/user_activity.html @@ -0,0 +1,75 @@ +{{define "user_activity.html"}} + + +{{if eq .Show "votes"}} + + + {{range .Votes}} + + {{if $.Dated}} + + {{end}} + + + {{else}} + + {{end}} + +
{{if .At}}{{.At.Format "2006-01-02"}}
{{.At.Format "15:04:05"}}{{else}}—{{end}}		 + {{esc .Rate}} + +
{{t "admin.empty"}}
+ +{{else if eq .Show "posts"}} + + + {{range .Posts}} + + + + + {{else}} + + {{end}} + +
{{.CreatedAt.Format "2006-01-02"}}
{{.CreatedAt.Format "15:04:05"}}		 + {{if .Article}}{{esc .Article}}{{end}} + + {{if .Name}}
{{esc .Thread}}
{{end}} +
{{t "admin.empty"}}
+ +{{else}} + + + {{range .Edits}} + + + + + {{else}} + + {{end}} + +
{{.CreatedAt.Format "2006-01-02"}}
{{.CreatedAt.Format "15:04:05"}}		 + {{range .Flags}}{{esc .Desc}}{{end}} + + {{if .Comment}}
{{esc .Comment}}
{{end}} +
{{t "admin.empty"}}
+{{end}} + + + +
+ {{t "admin.back"}} +
+{{end}} diff --git a/internal/admin/useractivity.go b/internal/admin/useractivity.go new file mode 100644 index 00000000..6c1c6786 --- /dev/null +++ b/internal/admin/useractivity.go @@ -0,0 +1,214 @@ +package admin + +import ( + "context" + "errors" + "net/http" + "strconv" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/auth" + "github.com/WikitTeam/ProjectWikit/internal/changelog" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/repo" +) + +const actionActivity = "activity" + +const activityPerPage = 40 + +const ( + showEdits = "edits" + showVotes = "votes" + showPosts = "posts" +) + +var activityTabs = []string{showEdits, showVotes, showPosts} + +type userVoteRow struct { + Title string + Href string + Rate string + At *time.Time +} + +type userPostRow struct { + Name string + Thread string + Article string + Href string + CreatedAt time.Time +} + +func (h *Handler) userActivity(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest string) error { + if r.Method != http.MethodGet && r.Method != http.MethodHead { + w.Header().Set("Allow", "GET, HEAD") + http.Error(w, http.StatusText(http.StatusMethodNotAllowed), http.StatusMethodNotAllowed) + return nil + } + ctx := r.Context() + id, err := strconv.ParseInt(rest, 10, 64) + if err != nil { + notFound(w) + return nil + } + row, err := h.deps.DB.AdminUser(ctx, id) + if errors.Is(err, db.ErrNotFound) { + notFound(w) + return nil + } + if err != nil { + return err + } + + show := r.URL.Query().Get("show") + if !contains(activityTabs, show) { + show = showEdits + } + page := atoi(r.URL.Query().Get("page")) + if page < 1 { + page = 1 + } + offset := (page - 1) * activityPerPage + + data := map[string]any{ + "Show": show, + "Tabs": activityTabs, + "Page": page, + "Action": Prefix + userSlug + "/" + rest + "/" + actionActivity, + "Back": Prefix + userSlug + "/" + rest, + } + var rows int + switch show { + case showVotes: + votes, err := h.userVotes(ctx, id, offset) + if err != nil { + return err + } + data["Votes"] = votes + data["Dated"] = grantsFrom(ctx).Has(perms.ViewVotesTimestamp) + rows = len(votes) + case showPosts: + posts, err := h.userPosts(ctx, id, offset) + if err != nil { + return err + } + data["Posts"] = posts + rows = len(posts) + default: + edits, err := h.userEdits(ctx, loc, id, offset) + if err != nil { + return err + } + data["Edits"] = edits + rows = len(edits) + } + data["More"] = rows == activityPerPage + + return h.page(w, r, loc, loc.T("admin.activity-of", "name", userLabel(row)), "user_activity.html", data) +} + +func userLabel(row db.AdminUserRow) string { + if row.Type == db.UserTypeWikidot && row.WikidotUsername != "" { + return row.WikidotUsername + } + return row.Username +} + +func (h *Handler) userEdits(ctx context.Context, loc *i18n.Localizer, id int64, offset int) ([]changeRow, error) { + hidden, err := repo.HiddenCategories(ctx, h.deps.DB, auth.FromContext(ctx)) + if err != nil { + return nil, err + } + found, err := h.deps.DB.SiteChanges(ctx, db.SiteChangeFilter{ + Hidden: hidden, + HasUser: true, + UserIDs: []int64{id}, + }, offset, activityPerPage) + if err != nil { + return nil, err + } + users := func(want []int64) ([]db.User, error) { return h.deps.DB.UsersByIDs(ctx, want) } + + out := make([]changeRow, 0, len(found)) + for _, c := range found { + article := db.Article{Category: c.ArticleCategory, Name: c.ArticleName, Title: c.ArticleTitle} + row := changeRow{ + Title: article.DisplayName(), + Href: "/" + article.FullName(), + CreatedAt: c.CreatedAt, + } + entry, err := changelog.Of(loc, users, c) + switch { + case errors.Is(err, changelog.ErrUnreadable): + case err != nil: + return nil, err + default: + row.Flags = entry.Flags + row.Comment = entry.Comment + } + out = append(out, row) + } + return out, nil +} + +func (h *Handler) userVotes(ctx context.Context, id int64, offset int) ([]userVoteRow, error) { + found, err := h.deps.DB.RatedBy(ctx, id, offset, activityPerPage) + if err != nil { + return nil, err + } + out := make([]userVoteRow, 0, len(found)) + for i := range found { + one := &found[i] + out = append(out, userVoteRow{ + Title: one.Article.DisplayName(), + Href: "/" + one.Article.FullName(), + Rate: strconv.FormatFloat(one.Rate, 'f', -1, 64), + At: one.VotedAt, + }) + } + return out, nil +} + +func (h *Handler) userPosts(ctx context.Context, id int64, offset int) ([]userPostRow, error) { + categories, err := h.deps.DB.ForumCategories(ctx) + if err != nil { + return nil, err + } + ids := make([]int64, 0, len(categories)) + for _, c := range categories { + ids = append(ids, c.ID) + } + found, err := h.deps.DB.UserPosts(ctx, id, ids, true, offset, activityPerPage) + if err != nil { + return nil, err + } + + out := make([]userPostRow, 0, len(found)) + for _, p := range found { + row := userPostRow{ + Name: p.Name, + Thread: p.ThreadName, + Href: "/forum/t-" + strconv.FormatInt(p.ThreadID, 10) + + "#post-" + strconv.FormatInt(p.ID, 10), + CreatedAt: p.CreatedAt, + } + if p.ArticleTitle != nil || p.ArticleName != nil { + article := db.Article{} + if p.ArticleCategory != nil { + article.Category = *p.ArticleCategory + } + if p.ArticleName != nil { + article.Name = *p.ArticleName + } + if p.ArticleTitle != nil { + article.Title = *p.ArticleTitle + } + row.Article = article.DisplayName() + } + out = append(out, row) + } + return out, nil +} From 9744985d33f608ac244450c2c5f4fc96f434154b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 16:13:14 +0900 Subject: [PATCH 329/428] link the activity screen from the user form --- internal/admin/templates/user_form.html | 1 + internal/admin/user.go | 3 +++ 2 files changed, 4 insertions(+) diff --git a/internal/admin/templates/user_form.html b/internal/admin/templates/user_form.html index aa85dda8..e066f99a 100644 --- a/internal/admin/templates/user_form.html +++ b/internal/admin/templates/user_form.html @@ -63,6 +63,7 @@ {{t "admin.back-to-list"}} {{t "admin.activate"}} + {{t "admin.user-activity"}} {{t "admin.reset-votes"}}
diff --git a/internal/admin/user.go b/internal/admin/user.go index f5d299b3..894ca8c5 100644 --- a/internal/admin/user.go +++ b/internal/admin/user.go @@ -36,6 +36,8 @@ func (h *Handler) users(w http.ResponseWriter, r *http.Request, loc *i18n.Locali return h.resetVotes(w, r, loc, id) case actionActivate: return h.activate(w, r, loc, id) + case actionActivity: + return h.userActivity(w, r, loc, id) } notFound(w) return nil @@ -148,6 +150,7 @@ func (h *Handler) userForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc "Held": row.Roles, "MaySetRoles": h.maySetRoles(mine, granted, row), "ResetVotes": Prefix + userSlug + "/" + rest + "/" + actionResetVote, + "Activity": Prefix + userSlug + "/" + rest + "/" + actionActivity, "Activate": Prefix + userSlug + "/" + rest + "/" + actionActivate, "MaySuper": mine != nil && mine.IsSuperuser, "SeeEmail": granted.Has(perms.ViewSensitiveInfo), From d078798c15457aacdf7e98af9f1e9fc1097490f8 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 16:13:14 +0900 Subject: [PATCH 330/428] test the user activity screen --- internal/admin/admin_test.go | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/internal/admin/admin_test.go b/internal/admin/admin_test.go index 3d03066a..14cedf28 100644 --- a/internal/admin/admin_test.go +++ b/internal/admin/admin_test.go @@ -254,7 +254,8 @@ func TestEveryScreenHasItsTemplates(t *testing.T) { for _, name := range []string{ "dashboard.html", "suspicious.html", "layout.html", "row_text", "pager", "save_row", "theme_list.html", "theme_form.html", "site_form.html", "role_list.html", "role_form.html", "role_category.html", - "user_list.html", "user_form.html", "report_list.html", "report_form.html", + "user_list.html", "user_form.html", "user_activity.html", + "report_list.html", "report_form.html", "forum_section_list.html", "forum_section_form.html", "forum_category_list.html", "forum_category_form.html", "admin_log.html", "tag_list.html", "tag_form.html", "tag_category_list.html", "tag_category_form.html", @@ -343,3 +344,29 @@ func TestEveryScreenLabelIsInTheCatalog(t *testing.T) { } } } + +func TestUserLabelPrefersTheWikidotName(t *testing.T) { + cases := map[string]struct { + row db.AdminUserRow + want string + }{ + "wikidot": {db.AdminUserRow{Type: db.UserTypeWikidot, Username: "u-1", WikidotUsername: "old"}, "old"}, + "claimed": {db.AdminUserRow{Type: db.UserTypeNormal, Username: "new", WikidotUsername: "old"}, "new"}, + "unnamed": {db.AdminUserRow{Type: db.UserTypeWikidot, Username: "u-1"}, "u-1"}, + } + for name, c := range cases { + if got := userLabel(c.row); got != c.want { + t.Errorf("userLabel(%s) = %q, want %q", name, got, c.want) + } + } +} + +func TestEveryActivityTabIsInTheCatalog(t *testing.T) { + loc := testLocalizer(t) + for _, tab := range activityTabs { + id := "admin.activity-" + tab + if loc.T(id) == id { + t.Errorf("T(%q) = %q, want a translation", id, id) + } + } +} From 12077d0c0448d33f87f62455b2ebce05c9ac811c Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:09:15 +0900 Subject: [PATCH 331/428] add the corpus snapshot format --- internal/difftest/corpus_test.go | 14 ------ internal/difftest/snapshot.go | 83 ++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+), 14 deletions(-) create mode 100644 internal/difftest/snapshot.go diff --git a/internal/difftest/corpus_test.go b/internal/difftest/corpus_test.go index 4bde5f5b..5323370e 100644 --- a/internal/difftest/corpus_test.go +++ b/internal/difftest/corpus_test.go @@ -5,7 +5,6 @@ import ( _ "embed" "os" "path/filepath" - "strings" "testing" ) @@ -121,16 +120,3 @@ func writeDump(t *testing.T, dir string, req Request, a, b Response) { } t.Logf("bodies written to %s.a.html and %s.b.html", stem, stem) } - -func dumpName(req Request) string { - name := req.Method + strings.ReplaceAll(req.Target, "/", "_") - return strings.Map(func(r rune) rune { - switch { - case r >= 'a' && r <= 'z', r >= 'A' && r <= 'Z', r >= '0' && r <= '9': - return r - case r == '_' || r == '-' || r == '.': - return r - } - return '-' - }, name) -} diff --git a/internal/difftest/snapshot.go b/internal/difftest/snapshot.go new file mode 100644 index 00000000..7c9ee77b --- /dev/null +++ b/internal/difftest/snapshot.go @@ -0,0 +1,83 @@ +package difftest + +import ( + "bytes" + "crypto/sha256" + "encoding/hex" + "fmt" + "net/http" + "path/filepath" + "slices" + "strconv" + "strings" +) + +const snapshotRoot = "testdata/snapshots" + +func NewSnapshotRunner(base string) (*Runner, error) { return NewRunner(base, base) } + +func SnapshotPath(set string, req Request) string { + return filepath.Join(snapshotRoot, set, dumpName(req)+".golden") +} + +func EncodeSnapshot(resp Response) []byte { + var out bytes.Buffer + fmt.Fprintf(&out, "%d\n", resp.Status) + + names := make([]string, 0, len(resp.Header)) + for name := range resp.Header { + names = append(names, name) + } + slices.Sort(names) + for _, name := range names { + for _, value := range resp.Header.Values(name) { + fmt.Fprintf(&out, "%s: %s\n", name, value) + } + } + + out.WriteString("\n") + out.Write(resp.Body) + return out.Bytes() +} + +func DecodeSnapshot(raw []byte) (Response, error) { + head, body, ok := bytes.Cut(raw, []byte("\n\n")) + if !ok { + return Response{}, fmt.Errorf("snapshot has no blank line before the body") + } + lines := strings.Split(string(head), "\n") + + status, err := strconv.Atoi(lines[0]) + if err != nil { + return Response{}, fmt.Errorf("snapshot status %q: %w", lines[0], err) + } + header := http.Header{} + for _, line := range lines[1:] { + name, value, ok := strings.Cut(line, ": ") + if !ok { + return Response{}, fmt.Errorf("snapshot header line %q has no colon", line) + } + header.Add(name, value) + } + return Response{Status: status, Header: header, Body: body}, nil +} + +// Two targets differing only in case land on one file on a case-insensitive +// filesystem, so the digest of the exact target is part of the name. +func dumpName(req Request) string { + sum := sha256.Sum256([]byte(req.Method + " " + req.Target)) + name := req.Method + strings.ReplaceAll(req.Target, "/", "_") + return readable(name) + "." + hex.EncodeToString(sum[:3]) +} + +func readable(name string) string { + return strings.Map(func(r rune) rune { + switch { + case r >= 'a' && r <= 'z', r >= 'A' && r <= 'Z', r >= '0' && r <= '9': + return r + case r == '_' || r == '-' || r == '.': + return r + } + return '-' + }, name) +} From c08c13c65de6c009d717f3232c418a221051d243 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:09:15 +0900 Subject: [PATCH 332/428] replay the corpus against its snapshots --- internal/difftest/snapshot_test.go | 126 +++++++++++++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100644 internal/difftest/snapshot_test.go diff --git a/internal/difftest/snapshot_test.go b/internal/difftest/snapshot_test.go new file mode 100644 index 00000000..11df8165 --- /dev/null +++ b/internal/difftest/snapshot_test.go @@ -0,0 +1,126 @@ +package difftest + +import ( + "context" + "net/http" + "os" + "path/filepath" + "strings" + "testing" +) + +const ( + EnvSnapshot = "PWIKIT_SNAPSHOT" + EnvSnapshotUpdate = "PWIKIT_SNAPSHOT_UPDATE" +) + +func TestSnapshotRoundTrip(t *testing.T) { + want := Response{ + Status: 200, + Header: http.Header{ + "Content-Type": []string{"text/html; charset=utf-8"}, + "Set-Cookie": []string{"a=1", "b=2"}, + }, + Body: []byte("

one

\n\n

two

\n"), + } + got, err := DecodeSnapshot(EncodeSnapshot(want)) + if err != nil { + t.Fatalf("DecodeSnapshot(EncodeSnapshot(want)) err = %v, want nil", err) + } + if got.Status != want.Status { + t.Errorf("Status = %d, want %d", got.Status, want.Status) + } + if string(got.Body) != string(want.Body) { + t.Errorf("Body = %q, want %q", got.Body, want.Body) + } + if got.Header.Get("Content-Type") != want.Header.Get("Content-Type") { + t.Errorf("Content-Type = %q, want %q", got.Header.Get("Content-Type"), want.Header.Get("Content-Type")) + } + if len(got.Header.Values("Set-Cookie")) != 2 { + t.Errorf("len(Set-Cookie) = %d, want 2", len(got.Header.Values("Set-Cookie"))) + } +} + +func TestDecodeSnapshotRejectsBadInput(t *testing.T) { + cases := map[string]string{ + "no blank line": "200\nContent-Type: text/html\n", + "no status": "hello\n\nbody", + "header without a colon": "200\nContent-Type\n\nbody", + } + for name, raw := range cases { + if _, err := DecodeSnapshot([]byte(raw)); err == nil { + t.Errorf("DecodeSnapshot(%s) err = nil, want an error", name) + } + } +} + +func TestSnapshotPathSeparatesTargetsDifferingOnlyInCase(t *testing.T) { + lower := SnapshotPath("default", Request{Method: http.MethodGet, Target: "/-/users/probe"}) + upper := SnapshotPath("default", Request{Method: http.MethodGet, Target: "/-/users/PROBE"}) + if strings.EqualFold(lower, upper) { + t.Errorf("SnapshotPath of /-/users/probe = %q, want it to differ from %q by more than case", lower, upper) + } + if dir := filepath.Dir(lower); dir != filepath.Join("testdata", "snapshots", "default") { + t.Errorf("filepath.Dir(SnapshotPath) = %q, want %q", dir, filepath.Join("testdata", "snapshots", "default")) + } + if filepath.Ext(lower) != ".golden" { + t.Errorf("filepath.Ext(SnapshotPath) = %q, want %q", filepath.Ext(lower), ".golden") + } +} + +func TestCorpusSnapshot(t *testing.T) { + base := os.Getenv(EnvSnapshot) + if base == "" { + t.Skipf("%s not set, skipping the snapshot run", EnvSnapshot) + } + runner, err := NewSnapshotRunner(base) + if err != nil { + t.Fatalf("NewSnapshotRunner(%q) err = %v, want nil", base, err) + } + runner.Host = os.Getenv(EnvHost) + + corpus, err := ParseCorpus(loadCorpus(t)) + if err != nil { + t.Fatalf("ParseCorpus() err = %v, want nil", err) + } + set := snapshotSet() + update := os.Getenv(EnvSnapshotUpdate) != "" + + for _, req := range corpus { + t.Run(req.String(), func(t *testing.T) { + got, err := runner.fetch(context.Background(), runner.A, req) + if err != nil { + t.Fatalf("fetch(%s) err = %v, want nil", req, err) + } + path := SnapshotPath(set, req) + if update { + if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil { + t.Fatalf("MkdirAll(%q) err = %v, want nil", filepath.Dir(path), err) + } + if err := os.WriteFile(path, EncodeSnapshot(got), 0o644); err != nil { + t.Fatalf("WriteFile(%q) err = %v, want nil", path, err) + } + return + } + raw, err := os.ReadFile(path) + if err != nil { + t.Fatalf("ReadFile(%q) err = %v, want nil; record it with %s=1", path, err, EnvSnapshotUpdate) + } + want, err := DecodeSnapshot(raw) + if err != nil { + t.Fatalf("DecodeSnapshot(%q) err = %v, want nil", path, err) + } + if result := runner.Comparer.Compare(got, want); !result.Same() { + t.Errorf("%s: a = got, b = want:\n%s", req, result) + } + }) + } +} + +func snapshotSet() string { + path := os.Getenv(EnvCorpus) + if path == "" { + return "default" + } + return strings.TrimSuffix(filepath.Base(path), filepath.Ext(path)) +} From 71ffac64a04a1a1d6ee4629ce41b9536353e9176 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:09:16 +0900 Subject: [PATCH 333/428] record the corpus snapshots --- .../articles/GET_component-box.42453e.golden | 155 ++ .../articles/GET_forum-category.7f8026.golden | 155 ++ .../GET_forum-new-thread.1b9873.golden | 155 ++ ...ET_forum-new-thread_c_999999.f01442.golden | 155 ++ .../GET_forum-recent-posts.db2f0b.golden | 948 ++++++++++++ ..._forum-recent-posts_c_999999.071ef0.golden | 948 ++++++++++++ .../GET_forum-recent-posts_p_2.8d9a12.golden | 963 +++++++++++++ .../articles/GET_forum-start.9490eb.golden | 309 ++++ .../articles/GET_forum-thread.0cc2e3.golden | 155 ++ .../articles/GET_forum_c-999999.8c9c2e.golden | 155 ++ ...ET_forum_c-999999_sort_start.c87713.golden | 155 ++ .../GET_forum_start_hidden_show.d459d7.golden | 341 +++++ .../GET_forum_start_s_999999.e4540f.golden | 155 ++ .../articles/GET_forum_t-121.959410.golden | 374 +++++ .../articles/GET_forum_t-999999.f371e5.golden | 155 ++ .../GET_forum_t-999999_p_2.7f509c.golden | 157 ++ .../snapshots/articles/GET_main.e6dfb1.golden | 155 ++ .../articles/GET_nav-side.fa4588.golden | 185 +++ .../articles/GET_nav-top.dade2f.golden | 209 +++ .../articles/GET_no-such-page.8b50b1.golden | 155 ++ .../articles/GET_probe-bare.f1227f.golden | 155 ++ .../GET_probe-bydisplay.1d1b81.golden | 164 +++ .../articles/GET_probe-changes.c1f54f.golden | 1280 +++++++++++++++++ .../GET_probe-changes_p_2.fbe814.golden | 1229 ++++++++++++++++ ...es_perpage_10_category_probe.103b39.golden | 858 +++++++++++ ..._username_-probe_source_true.2e766f.golden | 569 ++++++++ .../GET_probe-described.135ad5.golden | 155 ++ .../articles/GET_probe-full.7a5d50.golden | 191 +++ ...GET_probe-full_nomodule_true.7dbdf0.golden | 161 +++ ...GET_probe-full_offset_2_bare.999f74.golden | 191 +++ .../articles/GET_probe-half.1e2ff1.golden | 155 ++ .../articles/GET_probe-host.199301.golden | 155 ++ .../articles/GET_probe-imaged.47bb26.golden | 156 ++ .../articles/GET_probe-included.10c93f.golden | 155 ++ .../GET_probe-listbyvotes.3d7e5f.golden | 195 +++ .../articles/GET_probe-listed.3c65ea.golden | 195 +++ .../GET_probe-listed_p_2.4da87b.golden | 203 +++ ..._probe-listed_p_2_tag_euclid.9242a5.golden | 203 +++ .../GET_probe-listed_p_9.3dacf1.golden | 201 +++ .../GET_probe-listempty.d0ab89.golden | 162 +++ .../GET_probe-listjoined.c17028.golden | 181 +++ .../GET_probe-listnowrap.9444c2.golden | 155 ++ .../GET_probe-listsections.ea1f2e.golden | 195 +++ .../GET_probe-listsections_p_2.08de21.golden | 203 +++ .../articles/GET_probe-listtags.c430a6.golden | 162 +++ .../articles/GET_probe-listurl.e91b59.golden | 162 +++ ...be-listurl_name_probe-listed.0b8bf9.golden | 162 +++ .../articles/GET_probe-parent.423705.golden | 155 ++ .../articles/GET_probe-redirect.335ce7.golden | 11 + .../articles/GET_probe-tagged.cba9e8.golden | 165 +++ .../GET_probe-taggedplain.d9112e.golden | 171 +++ .../GET_probe-unknownmodule.05ccde.golden | 155 ++ .../GET_probecss-styled.d4c98a.golden | 158 ++ .../GET_probecss-styledhead.30a147.golden | 158 ++ .../GET_probestars-rated.971888.golden | 173 +++ .../GET_probestars-third.22a169.golden | 164 +++ ...w-api_articles__default-main.45e6f6.golden | 10 + ...pw-api_articles_no-such-page.6366af.golden | 11 + ...T_pw-api_articles_probe-bare.52bfc1.golden | 10 + ...T_pw-api_articles_probe-full.882d26.golden | 10 + ...pw-api_articles_probe-parent.4242b5.golden | 10 + ...pw-api_articles_probe-tagged.ecca60.golden | 10 + ..._articles_probestars-unrated.72feb8.golden | 10 + .../articles/GET_scp-173.49f7c9.golden | 160 +++ .../articles/GET_search-site.92e62d.golden | 155 ++ ...2021-01-01_dateto_2021-12-31.bbcbc3.golden | 155 ++ ...paced-20_author_probe-author.4c43e2.golden | 155 ++ .../GET_search-site_q_scp.74fce8.golden | 155 ++ ...GET_this-page-does-not-exist.4e61d9.golden | 155 ++ .../articles/OPTIONS_probe-full.700ef1.golden | 11 + .../articles/POST_probe-full.9f9144.golden | 12 + .../snapshots/default/GET_-.83f4ad.golden | 11 + .../default/GET_-_login.534a5e.golden | 87 ++ .../default/GET_-_profile_edit.88b751.golden | 11 + .../default/GET_-_signup.ec227d.golden | 230 +++ .../default/GET_-_users_1-.20ce64.golden | 11 + .../default/GET_-_users_1.2e00f3.golden | 11 + .../GET_-_users_PROBE-AUTHOR.7e97e2.golden | 355 +++++ .../GET_-_users_nobody-at-all.118cd8.golden | 11 + .../GET_-_users_probe-author.84cda7.golden | 355 +++++ .../GET_-_users_probe-staff.1683de.golden | 119 ++ ...ET_-_users_probe-wd-original.2774a5.golden | 133 ++ .../GET_-_users_probevoter.311a55.golden | 243 ++++ .../snapshots/default/GET_.c76702.golden | 155 ++ .../default/GET_component-box.42453e.golden | 155 ++ ...local--files_nonexistent.png.c9cedd.golden | 9 + ...GET_local--theme_1_style.css.b5763d.golden | 9 + .../snapshots/default/GET_main.e6dfb1.golden | 155 ++ .../GET_main_norender_true.7cb442.golden | 155 ++ .../default/GET_missing-page.f9ea63.golden | 155 ++ .../default/GET_nav-side.fa4588.golden | 185 +++ .../default/GET_nav-top.dade2f.golden | 209 +++ .../default/GET_pw-api_articles.748d4c.golden | 10 + .../GET_pw-api_articles_scp-173.7a9de4.golden | 10 + ...w-api_articles_scp-173_links.b1567a.golden | 11 + ...w-api_articles_scp-173_votes.db6037.golden | 10 + .../default/GET_pw-apidocs.21ef6a.golden | 155 ++ .../default/GET_scp-173.49f7c9.golden | 160 +++ .../GET_scp-173_edit_true.47bfef.golden | 160 +++ ...GET_this-page-does-not-exist.4e61d9.golden | 155 ++ .../HEAD_-_users_probe-author.f02453.golden | 10 + .../snapshots/media/GET_-_login.534a5e.golden | 9 + .../GET_local--code_nope_1.8e8368.golden | 10 + ...GET_local--code_probe-full_1.d2a9b4.golden | 10 + ...robeoff-unratable_1-revNum-0.089f16.golden | 10 + ...obeoff-unratable_1-revNum-99.21cb3a.golden | 10 + ...l--code_probeoff-unratable_1.e361a8.golden | 10 + ...l--code_probeoff-unratable_2.9a6c94.golden | 10 + ...l--code_probeoff-unratable_3.84286d.golden | 10 + ...l--code_probeoff-unratable_x.3581ed.golden | 10 + ...T_local--files_-_probe_a.bin.70287f.golden | Bin 0 -> 699 bytes ...T_local--files_-_probe_a.pdf.f88569.golden | Bin 0 -> 699 bytes ...T_local--files_-_probe_a.txt.bf7b5e.golden | Bin 0 -> 545 bytes ...ocal--files_-_probe_a.txt.gz.7501e5.golden | Bin 0 -> 548 bytes ...T_local--files_-_probe_empty.9fb42e.golden | 14 + ...local--files_nonexistent.png.c9cedd.golden | 10 + ..._local--html_nope_deadbeef-x.104a66.golden | 10 + ...robeoff-unratable_deadbeef-x.088d50.golden | 10 + ...GET_local--theme_1_style.css.b5763d.golden | 10 + ...--theme_probe-full_style.css.21e413.golden | 9 + ...me_probecss-styled_style.css.7a07a4.golden | 11 + ...robecolor-22-3A-22blue-22-7D.d85441.golden | 9 + ...unratable_style.css-revNum-0.96adef.golden | 9 + ...probeoff-unratable_style.css.45547d.golden | 9 + .../snapshots/media/GET_main.e6dfb1.golden | 9 + ...l--code_probeoff-unratable_1.3147a6.golden | 9 + ...D_local--files_-_probe_a.pdf.1d134b.golden | 14 + ...l--code_probeoff-unratable_1.60f2af.golden | 10 + 128 files changed, 20108 insertions(+) create mode 100644 internal/difftest/testdata/snapshots/articles/GET_component-box.42453e.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum-category.7f8026.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum-new-thread.1b9873.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum-new-thread_c_999999.f01442.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts.db2f0b.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts_c_999999.071ef0.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts_p_2.8d9a12.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum-start.9490eb.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum-thread.0cc2e3.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum_c-999999.8c9c2e.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum_c-999999_sort_start.c87713.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum_start_hidden_show.d459d7.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum_start_s_999999.e4540f.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum_t-121.959410.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum_t-999999.f371e5.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_forum_t-999999_p_2.7f509c.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_main.e6dfb1.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_nav-side.fa4588.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_nav-top.dade2f.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_no-such-page.8b50b1.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-bare.f1227f.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-bydisplay.1d1b81.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-changes.c1f54f.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-changes_p_2.fbe814.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-changes_perpage_10_category_probe.103b39.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-changes_username_-probe_source_true.2e766f.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-described.135ad5.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-full.7a5d50.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-full_nomodule_true.7dbdf0.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-full_offset_2_bare.999f74.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-half.1e2ff1.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-host.199301.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-imaged.47bb26.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-included.10c93f.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listbyvotes.3d7e5f.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listed.3c65ea.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_2.4da87b.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_2_tag_euclid.9242a5.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_9.3dacf1.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listempty.d0ab89.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listjoined.c17028.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listnowrap.9444c2.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listsections.ea1f2e.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listsections_p_2.08de21.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listtags.c430a6.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listurl.e91b59.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-listurl_name_probe-listed.0b8bf9.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-parent.423705.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-redirect.335ce7.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-tagged.cba9e8.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-taggedplain.d9112e.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probe-unknownmodule.05ccde.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probecss-styled.d4c98a.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probecss-styledhead.30a147.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probestars-rated.971888.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_probestars-third.22a169.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_pw-api_articles__default-main.45e6f6.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_no-such-page.6366af.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-bare.52bfc1.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-full.882d26.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-parent.4242b5.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-tagged.ecca60.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probestars-unrated.72feb8.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_scp-173.49f7c9.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_search-site.92e62d.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_search-site_datefrom_2021-01-01_dateto_2021-12-31.bbcbc3.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_search-site_q_-20spaced-20_author_probe-author.4c43e2.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_search-site_q_scp.74fce8.golden create mode 100644 internal/difftest/testdata/snapshots/articles/GET_this-page-does-not-exist.4e61d9.golden create mode 100644 internal/difftest/testdata/snapshots/articles/OPTIONS_probe-full.700ef1.golden create mode 100644 internal/difftest/testdata/snapshots/articles/POST_probe-full.9f9144.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-.83f4ad.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_login.534a5e.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_profile_edit.88b751.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_signup.ec227d.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_users_1-.20ce64.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_users_1.2e00f3.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_users_PROBE-AUTHOR.7e97e2.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_users_nobody-at-all.118cd8.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_users_probe-author.84cda7.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_users_probe-staff.1683de.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_users_probe-wd-original.2774a5.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_-_users_probevoter.311a55.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_.c76702.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_component-box.42453e.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_local--files_nonexistent.png.c9cedd.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_local--theme_1_style.css.b5763d.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_main.e6dfb1.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_main_norender_true.7cb442.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_missing-page.f9ea63.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_nav-side.fa4588.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_nav-top.dade2f.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_pw-api_articles.748d4c.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173.7a9de4.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173_links.b1567a.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173_votes.db6037.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_pw-apidocs.21ef6a.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_scp-173.49f7c9.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_scp-173_edit_true.47bfef.golden create mode 100644 internal/difftest/testdata/snapshots/default/GET_this-page-does-not-exist.4e61d9.golden create mode 100644 internal/difftest/testdata/snapshots/default/HEAD_-_users_probe-author.f02453.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_-_login.534a5e.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--code_nope_1.8e8368.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--code_probe-full_1.d2a9b4.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1-revNum-0.089f16.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1-revNum-99.21cb3a.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1.e361a8.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_2.9a6c94.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_3.84286d.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_x.3581ed.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.bin.70287f.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.pdf.f88569.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.txt.bf7b5e.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.txt.gz.7501e5.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_empty.9fb42e.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--files_nonexistent.png.c9cedd.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--html_nope_deadbeef-x.104a66.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--html_probeoff-unratable_deadbeef-x.088d50.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--theme_1_style.css.b5763d.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--theme_probe-full_style.css.21e413.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--theme_probecss-styled_style.css.7a07a4.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--theme_probeoff-unratable_style.css-includeParams--7B-22probecolor-22-3A-22blue-22-7D.d85441.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--theme_probeoff-unratable_style.css-revNum-0.96adef.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_local--theme_probeoff-unratable_style.css.45547d.golden create mode 100644 internal/difftest/testdata/snapshots/media/GET_main.e6dfb1.golden create mode 100644 internal/difftest/testdata/snapshots/media/HEAD_local--code_probeoff-unratable_1.3147a6.golden create mode 100644 internal/difftest/testdata/snapshots/media/HEAD_local--files_-_probe_a.pdf.1d134b.golden create mode 100644 internal/difftest/testdata/snapshots/media/OPTIONS_local--code_probeoff-unratable_1.60f2af.golden diff --git a/internal/difftest/testdata/snapshots/articles/GET_component-box.42453e.golden b/internal/difftest/testdata/snapshots/articles/GET_component-box.42453e.golden new file mode 100644 index 00000000..73615fb1 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_component-box.42453e.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + box - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ box +
+ +
+

这是一个被 include 的组件。参数 a = %%a%%

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月20日, 2026年 15:26
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum-category.7f8026.golden b/internal/difftest/testdata/snapshots/articles/GET_forum-category.7f8026.golden new file mode 100644 index 00000000..9ba179f8 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum-category.7f8026.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛 +
+ +
+

未找到版块 "None"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum-new-thread.1b9873.golden b/internal/difftest/testdata/snapshots/articles/GET_forum-new-thread.1b9873.golden new file mode 100644 index 00000000..149e201e --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum-new-thread.1b9873.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 创建主题 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 创建主题 +
+ +
+

未找到版块 "None"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum-new-thread_c_999999.f01442.golden b/internal/difftest/testdata/snapshots/articles/GET_forum-new-thread_c_999999.f01442.golden new file mode 100644 index 00000000..fc939acd --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum-new-thread_c_999999.f01442.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 创建主题 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 创建主题 +
+ +
+

未找到版块 "999999"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts.db2f0b.golden b/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts.db2f0b.golden new file mode 100644 index 00000000..1f730347 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts.db2f0b.golden @@ -0,0 +1,948 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛最新帖子 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛最新帖子 +
+ +
+
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts_c_999999.071ef0.golden b/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts_c_999999.071ef0.golden new file mode 100644 index 00000000..9cf90ada --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts_c_999999.071ef0.golden @@ -0,0 +1,948 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛最新帖子 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛最新帖子 +
+ +
+
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ Probe Long Thread post 11 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 12:00 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 11

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 10 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:59 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 10

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 9 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:58 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 9

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 8 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:57 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 8

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 7 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:56 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 7

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 6 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:55 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 6

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 5 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:54 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 5

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 4 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:53 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 4

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 3 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:52 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 3

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 2 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:51 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 2

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:50 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 1

+
+
+
+
+ +
+
+
+
+
+ Probe Long Thread post 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:49 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Long Thread + +
+
+

Probe Long Thread body 0

+
+
+
+
+ +
+
+
+
+
+ 跳转到帖子 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply the site itself made

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

a reply to a reply

+
+
+
+
+ +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+ + 来自 + + Probe Open » + Probe Talk » + + Probe Deep Thread + +
+
+

Probe Deep Thread body 0

+
+
+
+
+ +
+
+
+
+
+ probe post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:42 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:41 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Full + +
+
+

probe comment 0

+
+
+
+
+ +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts_p_2.8d9a12.golden b/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts_p_2.8d9a12.golden new file mode 100644 index 00000000..20509e90 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum-recent-posts_p_2.8d9a12.golden @@ -0,0 +1,963 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛最新帖子 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛最新帖子 +
+ +
+
+
+ + + + + + + +
选择版块： + + +
+
+
+
+
+ 第 2 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+
+
+
+
+ probe post 1 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:40 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Rated + +
+
+

probe comment 1

+
+
+
+
+ +
+
+
+
+
+ probe post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:39 +
+ + 来自 + + Probe Open » + Probe Comments » + + Probe Rated + +
+
+

probe comment 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 20 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:38 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 20 + +
+
+

Probe Busy 20 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 19 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:37 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 19 + +
+
+

Probe Busy 19 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 18 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:36 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 18 + +
+
+

Probe Busy 18 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 17 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:35 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 17 + +
+
+

Probe Busy 17 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 16 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:34 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 16 + +
+
+

Probe Busy 16 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 15 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:33 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 15 + +
+
+

Probe Busy 15 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 14 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:32 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 14 + +
+
+

Probe Busy 14 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 13 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:31 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 13 + +
+
+

Probe Busy 13 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 12 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:30 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 12 + +
+
+

Probe Busy 12 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 11 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:29 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 11 + +
+
+

Probe Busy 11 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 10 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:28 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 10 + +
+
+

Probe Busy 10 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 09 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:27 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 09 + +
+
+

Probe Busy 09 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 08 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:26 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 08 + +
+
+

Probe Busy 08 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 07 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:25 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 07 + +
+
+

Probe Busy 07 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 06 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:24 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 06 + +
+
+

Probe Busy 06 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 05 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:23 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 05 + +
+
+

Probe Busy 05 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 04 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:22 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 04 + +
+
+

Probe Busy 04 body 0

+
+
+
+
+ +
+
+
+
+
+ Probe Busy 03 post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:21 +
+ + 来自 + + Probe Open » + Probe Busy » + + Probe Busy 03 + +
+
+

Probe Busy 03 body 0

+
+
+
+
+ +
+ 第 2 页; 共 3 页 + + « 上一页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum-start.9490eb.golden b/internal/difftest/testdata/snapshots/articles/GET_forum-start.9490eb.golden new file mode 100644 index 00000000..092c728c --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum-start.9490eb.golden @@ -0,0 +1,309 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛版块 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛版块 +
+ +
+

论坛新帖

+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		36 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:17 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		424 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:42 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
Probe Busy
+
enough threads for a second page
+ 		2121 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + +
+
Probe Talk
+
threads that carry replies
+ 		218 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 12:00 +
+ 查看 + +
+
+
+ +
+

+ + 显示隐藏版块 + +

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum-thread.0cc2e3.golden b/internal/difftest/testdata/snapshots/articles/GET_forum-thread.0cc2e3.golden new file mode 100644 index 00000000..3f31d871 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum-thread.0cc2e3.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛 +
+ +
+

未找到主题 "None"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum_c-999999.8c9c2e.golden b/internal/difftest/testdata/snapshots/articles/GET_forum_c-999999.8c9c2e.golden new file mode 100644 index 00000000..a3f63c51 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum_c-999999.8c9c2e.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛 +
+ +
+

未找到版块 "999999"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum_c-999999_sort_start.c87713.golden b/internal/difftest/testdata/snapshots/articles/GET_forum_c-999999_sort_start.c87713.golden new file mode 100644 index 00000000..7e3d8e7d --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum_c-999999_sort_start.c87713.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛 +
+ +
+

未找到版块 "999999"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum_start_hidden_show.d459d7.golden b/internal/difftest/testdata/snapshots/articles/GET_forum_start_hidden_show.d459d7.golden new file mode 100644 index 00000000..c560d7d6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum_start_hidden_show.d459d7.golden @@ -0,0 +1,341 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛版块 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛版块 +
+ +
+

论坛新帖

+ +
+ 论坛 + » + Probe Open +
+ + +
+
+
Probe Open
+
an open section
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Chat
+
ordinary threads
+ 		36 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 11:17 +
+ 查看 + +
+
Probe Comments
+
article comments
+ 		424 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:42 +
+ 查看 + +
+
Probe Quiet
+
nobody has posted here
+ 		00 + +
+
Probe Busy
+
enough threads for a second page
+ 		2121 + + 作者： + + Probe Author + + Probe Author + + + + + +
+ 09.10.2023 11:38 +
+ 查看 + +
+
Probe Talk
+
threads that carry replies
+ 		218 + + 作者： + + probevoter + + probevoter + + + + + +
+ 09.10.2023 12:00 +
+ 查看 + +
+
+
+ +
+
+
Probe Hidden
+
hidden from the listing
+
+
+ + + + + + + + + + + + + + + + + +
版块名称主题数帖子数最后回复
+
Probe Hidden Chat
+
inside the hidden section
+ 		00 + +
+
+
+ +
+

+ + 隐藏隐藏版块 + +

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum_start_s_999999.e4540f.golden b/internal/difftest/testdata/snapshots/articles/GET_forum_start_s_999999.e4540f.golden new file mode 100644 index 00000000..5d5ddbc6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum_start_s_999999.e4540f.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛版块 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛版块 +
+ +
+

论坛新帖

未找到版块 "999999"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum_t-121.959410.golden b/internal/difftest/testdata/snapshots/articles/GET_forum_t-121.959410.golden new file mode 100644 index 00000000..c15298a1 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum_t-121.959410.golden @@ -0,0 +1,374 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛 — Probe Deep Thread - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛 — Probe Deep Thread +
+ +
+ +
+
+ 论坛 + + » + Probe Open + » + Probe Talk + + » + Probe Deep Thread +
+
+
+ 创建者： + + Probe Author + + Probe Author + + + + + +
+ 日期：03.04.2021 05:30 +
+ 帖子数：2 +
+ +
+ 简短描述： +
+ Probe Deep Thread description + +
+
+ +
+
+ + +
+
+
+
+
+ Probe Deep Thread post 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:43 +
+
+
+

Probe Deep Thread body 0

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:45 +
+
+
+

reply naming @probe-author and @nobody-at-all

+
+
+
+
+ + +
+
+
+
+
+ Probe Deep reply 0 0 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:46 +
+
+
+

a reply to a reply

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep reply 1 +
+
+ 系统 09.10.2023 11:47 +
+
+
+

a reply the site itself made

+
+
+
+
+ +
+ +
+
+
+
+
+ +
+
+ + + probevoter + + probevoter + + + + + 09.10.2023 11:48 +
+
+
+

a reply whose title is only spaces

+
+
+
+
+ +
+ + +
+ +
+
+
+
+
+ Probe Deep Thread post 1 +
+
+ + + Probe Author + + Probe Author + + + + + 09.10.2023 11:44 +
+
+
+

Probe Deep Thread body 1 edited

+
+
+
+
+ +
+ + +
+
+ +
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum_t-999999.f371e5.golden b/internal/difftest/testdata/snapshots/articles/GET_forum_t-999999.f371e5.golden new file mode 100644 index 00000000..fd01a57b --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum_t-999999.f371e5.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛 +
+ +
+

未找到主题 "999999"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_forum_t-999999_p_2.7f509c.golden b/internal/difftest/testdata/snapshots/articles/GET_forum_t-999999_p_2.7f509c.golden new file mode 100644 index 00000000..71e621ea --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_forum_t-999999_p_2.7f509c.golden @@ -0,0 +1,157 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + 论坛 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ 论坛 +
+ +
+

未找到主题 "999999"

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_main.e6dfb1.golden b/internal/difftest/testdata/snapshots/articles/GET_main.e6dfb1.golden new file mode 100644 index 00000000..c4827bfd --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_main.e6dfb1.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + main - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ main +
+ +
+

恭喜！一切正常！

+
+
+ +
+ +
+ +
+
+ +
页面版本: 1, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_nav-side.fa4588.golden b/internal/difftest/testdata/snapshots/articles/GET_nav-side.fa4588.golden new file mode 100644 index 00000000..bfe25c8c --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_nav-side.fa4588.golden @@ -0,0 +1,185 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + side - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ side +
+ +
+

存在的页面：

+
标题名称
pwikit 新功能演示pwikit-demo
top-implnav:top-impl
startforum:start
threadforum:thread
categoryforum:category
new-threadforum:new-thread
recent-postsforum:recent-posts
sitesearch:site
wiki-syntax-guidewiki-syntax-guide
Page Bprobe-b
Page Aprobe-a
Shared Componentcomponent:probe-var
scp-173scp-173
mainmain
boxcomponent:box
sidenav:side
topnav:top
Probe Parentprobe:parent
Probe Fullprobe:full
Probe Bareprobe:bare
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 1, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_nav-top.dade2f.golden b/internal/difftest/testdata/snapshots/articles/GET_nav-top.dade2f.golden new file mode 100644 index 00000000..b48daf8a --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_nav-top.dade2f.golden @@ -0,0 +1,209 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + top - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ top +
+ +
+

≡

+
+
+ +
+ +
+ +
+
+ +
页面版本: 1, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_no-such-page.8b50b1.golden b/internal/difftest/testdata/snapshots/articles/GET_no-such-page.8b50b1.golden new file mode 100644 index 00000000..1789447a --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_no-such-page.8b50b1.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+ +

您请求的页面 不存在 + +

+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-bare.f1227f.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-bare.f1227f.golden new file mode 100644 index 00000000..042db48d --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-bare.f1227f.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Bare - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Bare +
+ +
+

bare source

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-bydisplay.1d1b81.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-bydisplay.1d1b81.golden new file mode 100644 index 00000000..d881dc70 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-bydisplay.1d1b81.golden @@ -0,0 +1,164 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe By Display Name - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe By Display Name +
+ +
+

+ + wd:Probe WD + + wd:Probe WD + + + + +

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-changes.c1f54f.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-changes.c1f54f.golden new file mode 100644 index 00000000..b450b397 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-changes.c1f54f.golden @@ -0,0 +1,1280 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Changes - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Changes +
+ +
+
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 5 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:30 + + (版本 26) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：probevoter。 移除作者：wd:Probe WD。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:29 + + (版本 25) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 移除作者：wd:Probe WD。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:28 + + (版本 24) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：Probe Author, probevoter。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:27 + + (版本 23) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：Probe Author。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:26 + + (版本 22) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：无（投票数：0，人气：0%） +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:25 + + (版本 21) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：4.2（投票数：4，人气：75%） +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:24 + + (版本 20) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：-3（投票数：9，人气：11%） +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:23 + + (版本 19) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：+3（投票数：5，人气：60%） +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + F + + 11.12.2024 14:22 + + (版本 18) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 文件已从 "cover.png" 重命名为 "banner.png" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + F + + 11.12.2024 14:21 + + (版本 17) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已删除文件："cover.png" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + F + + 11.12.2024 14:20 + + (版本 16) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已上传文件："cover.png" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + M + + 11.12.2024 14:19 + + (版本 15) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + M + + 11.12.2024 14:18 + + (版本 14) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 父页面已从 "probe:parent" 更改为 "probe:full" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + M + + 11.12.2024 14:17 + + (版本 13) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已移除父页面 "probe:parent" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + M + + 11.12.2024 14:16 + + (版本 12) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已设置父页面 "probe:parent" +
+ +
+ +
+ 第 1 页; 共 5 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 31, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-changes_p_2.fbe814.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-changes_p_2.fbe814.golden new file mode 100644 index 00000000..a9f9f1aa --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-changes_p_2.fbe814.golden @@ -0,0 +1,1229 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Changes - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Changes +
+ +
+
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 2 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:15 + + (版本 11) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:14 + + (版本 10) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加标签：alpha, Zeta。 移除标签：lang:en。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:13 + + (版本 9) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 移除标签：lang:en。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + A + + 11.12.2024 14:12 + + (版本 8) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加标签：alpha。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + R + + 11.12.2024 14:11 + + (版本 7) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 页面已从 "probe:was-here" 重命名为 "probe:changes" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + T + + 11.12.2024 14:10 + + (版本 6) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 标题已从 "Probe "Old" <b>" 更改为 "Probe Changes" +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:09 + + (版本 5) + + + + probevoter + + probevoter + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:07 + + (版本 3) + + 系统 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:06 + + (版本 2) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:05 + + (版本 1) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ a source edit +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + N + + 11.12.2024 14:04 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probecss: + + Probe Styled Head + + + N + + 11.12.2024 14:03 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probecss: + + Probe Styled + + + N + + 11.12.2024 14:02 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probestars: + + Probe Third + + + N + + 11.12.2024 14:01 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probeoff: + + Probe Unratable + + + N + + 11.12.2024 14:00 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probestars: + + Probe Quarter + + + N + + 11.12.2024 13:59 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probestars: + + Probe Unrated + + + N + + 11.12.2024 13:58 + + (版本 0) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe List By Votes + + + N + + 11.12.2024 13:57 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe List Url + + + N + + 11.12.2024 13:56 + + (版本 0) + + 系统 +
+ +
+ 创建新页面 +
+ +
+ +
+ 第 2 页; 共 5 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 5 + + + + 下一页 » + +
+
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 31, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-changes_perpage_10_category_probe.103b39.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-changes_perpage_10_category_probe.103b39.golden new file mode 100644 index 00000000..0e9a988b --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-changes_perpage_10_category_probe.103b39.golden @@ -0,0 +1,858 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Changes - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Changes +
+ +
+
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+
+ 第 1 页; 共 6 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 5 + + + + 6 + + + + 下一页 » + +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ? + + 11.12.2024 14:35 + + (版本 31) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #1 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + + + 11.12.2024 14:34 + + (版本 30) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #0 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + W + + 11.12.2024 14:32 + + (版本 28) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ imported from wikidot +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:31 + + (版本 27) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:30 + + (版本 26) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：probevoter。 移除作者：wd:Probe WD。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:29 + + (版本 25) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 移除作者：wd:Probe WD。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:28 + + (版本 24) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：Probe Author, probevoter。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + C + + 11.12.2024 14:27 + + (版本 23) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 添加作者：Probe Author。 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + V + + 11.12.2024 14:26 + + (版本 22) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已重置页面评分：无（投票数：0，人气：0%） +
+ +
+ +
+ 第 1 页; 共 6 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 5 + + + + 6 + + + + 下一页 » + +
+
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 31, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-changes_username_-probe_source_true.2e766f.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-changes_username_-probe_source_true.2e766f.golden new file mode 100644 index 00000000..650133c6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-changes_username_-probe_source_true.2e766f.golden @@ -0,0 +1,569 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Changes - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Changes +
+ +
+
+ +
+ + + + + + + + + + + + + + + + + + + +
编辑类型： + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ + +
+ +
选择分类： + +
按用户名筛选：
使用前缀"~"进行部分
用户名匹配筛选		 + +
每页条目数： + +
+
+ +
+
+
+ + +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + ST + + 11.12.2024 14:33 + + (版本 29) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ 已回退页面至版本 #2 +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:09 + + (版本 5) + + + + probevoter + + probevoter + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:08 + + (版本 4) + + + + wd:Probe WD + + wd:Probe WD + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:06 + + (版本 2) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ +
+ + + + + + + + + + +
+ + + probe: + + Probe Changes + + + S + + 11.12.2024 14:05 + + (版本 1) + + + + Probe Author + + Probe Author + + + + + +
+ +
+ a source edit +
+ +
+ + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 31, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-described.135ad5.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-described.135ad5.golden new file mode 100644 index 00000000..fcdcadf9 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-described.135ad5.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Described - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Described +
+ +
+

visible text

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-full.7a5d50.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-full.7a5d50.golden new file mode 100644 index 00000000..11d1a11f --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-full.7a5d50.golden @@ -0,0 +1,191 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Full - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Full +
+ + + +
+

full source
second line

+
+
+ +
+ +
+ lang: + + + en + + +
+ +
+ 默认: + + + zeta + + + + alpha + + +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-full_nomodule_true.7dbdf0.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-full_nomodule_true.7dbdf0.golden new file mode 100644 index 00000000..3a286713 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-full_nomodule_true.7dbdf0.golden @@ -0,0 +1,161 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Full - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Full +
+ + + +
+

full source
second line

+
+
+ +
+ +
+ lang: + + + en + + +
+ +
+ 默认: + + + zeta + + + + alpha + + +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-full_offset_2_bare.999f74.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-full_offset_2_bare.999f74.golden new file mode 100644 index 00000000..5143366f --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-full_offset_2_bare.999f74.golden @@ -0,0 +1,191 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Full - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Full +
+ + + +
+

full source
second line

+
+
+ +
+ +
+ lang: + + + en + + +
+ +
+ 默认: + + + zeta + + + + alpha + + +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-half.1e2ff1.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-half.1e2ff1.golden new file mode 100644 index 00000000..62b10240 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-half.1e2ff1.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Half - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Half +
+ +
+

half source

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-host.199301.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-host.199301.golden new file mode 100644 index 00000000..306d3477 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-host.199301.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Host - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Host +
+ +
+

host=Probe Host full=probe:host own=%%title%% miss=%%this|nosuchvar%%

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-imaged.47bb26.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-imaged.47bb26.golden new file mode 100644 index 00000000..f60b5c53 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-imaged.47bb26.golden @@ -0,0 +1,156 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + + Probe Imaged - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Imaged +
+ +
+

body text

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-included.10c93f.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-included.10c93f.golden new file mode 100644 index 00000000..fc482c28 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-included.10c93f.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Included Page - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Included Page +
+ +
+

host=Included Page full=probe:included own=%%title%% miss=%%this|nosuchvar%%

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listbyvotes.3d7e5f.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listbyvotes.3d7e5f.golden new file mode 100644 index 00000000..70801613 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listbyvotes.3d7e5f.golden @@ -0,0 +1,195 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List By Votes - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List By Votes +
+ +
+
+

probe:half -6 8 12

probe:full +1 3 67

probestars:third 3.3 3 100

probestars:rated 4.5 2 100

probestars:quarter 0.8 2 0

+
+ 第 1 页; 共 10 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 9 + + + + 10 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listed.3c65ea.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listed.3c65ea.golden new file mode 100644 index 00000000..5841f7ba --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listed.3c65ea.golden @@ -0,0 +1,195 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Listed - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Listed +
+ +
+
+

1/22 Probe Bare +0

2/22 Probe By Display Name +0

3/22 Probe Changes +0

+
+ 第 1 页; 共 8 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_2.4da87b.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_2.4da87b.golden new file mode 100644 index 00000000..ce563c8f --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_2.4da87b.golden @@ -0,0 +1,203 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Listed - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Listed +
+ +
+
+

4/22 Probe Described +0

5/22 Probe Full +1

6/22 Probe Half -6

+
+ 第 2 页; 共 8 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_2_tag_euclid.9242a5.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_2_tag_euclid.9242a5.golden new file mode 100644 index 00000000..c135dbe6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_2_tag_euclid.9242a5.golden @@ -0,0 +1,203 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Listed - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Listed +
+ +
+
+

4/22 Probe Described +0

5/22 Probe Full +1

6/22 Probe Half -6

+
+ 第 2 页; 共 8 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + ... + + + + 7 + + + + 8 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_9.3dacf1.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_9.3dacf1.golden new file mode 100644 index 00000000..1044d1e6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listed_p_9.3dacf1.golden @@ -0,0 +1,201 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Listed - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Listed +
+ +
+
+ +
+ 第 9 页; 共 8 页 + + « 上一页 + + + + 1 + + + + 2 + + + + ... + + + + + + 5 + + + + 6 + + + + 7 + + + + 8 + + + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listempty.d0ab89.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listempty.d0ab89.golden new file mode 100644 index 00000000..df775d95 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listempty.d0ab89.golden @@ -0,0 +1,162 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List Empty - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List Empty +
+ +
+
+ + +
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listjoined.c17028.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listjoined.c17028.golden new file mode 100644 index 00000000..fa55f57f --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listjoined.c17028.golden @@ -0,0 +1,181 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List Joined - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List Joined +
+ +
+
+
page
bare
bydisplay
changes
described
full
half
host
imaged
included
listbyvotes
listed
listempty
listjoined
listnowrap
listsections
listtags
listurl
parent
redirect
tagged

end

+
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listnowrap.9444c2.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listnowrap.9444c2.golden new file mode 100644 index 00000000..b3a71654 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listnowrap.9444c2.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List No Wrapper - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List No Wrapper +
+ +
+

bare

bydisplay

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listsections.ea1f2e.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listsections.ea1f2e.golden new file mode 100644 index 00000000..7efdb624 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listsections.ea1f2e.golden @@ -0,0 +1,195 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List Sections - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List Sections +
+ +
+
+

op

%name%%

%name%%

ottom

+
+ 第 1 页; 共 11 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + ... + + + + 10 + + + + 11 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listsections_p_2.08de21.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listsections_p_2.08de21.golden new file mode 100644 index 00000000..6049fd63 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listsections_p_2.08de21.golden @@ -0,0 +1,203 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List Sections - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List Sections +
+ +
+
+

op

%name%%

%name%%

ottom

+
+ 第 2 页; 共 11 页 + + « 上一页 + + + + 1 + + + + 2 + + + + 3 + + + + + + 4 + + + + ... + + + + 10 + + + + 11 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listtags.c430a6.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listtags.c430a6.golden new file mode 100644 index 00000000..177a0220 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listtags.c430a6.golden @@ -0,0 +1,162 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List Tags - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List Tags +
+ +
+
+ + +
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listurl.e91b59.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listurl.e91b59.golden new file mode 100644 index 00000000..5c8e1b3a --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listurl.e91b59.golden @@ -0,0 +1,162 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List Url - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List Url +
+ +
+
+ + +
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-listurl_name_probe-listed.0b8bf9.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-listurl_name_probe-listed.0b8bf9.golden new file mode 100644 index 00000000..2b6f9b71 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-listurl_name_probe-listed.0b8bf9.golden @@ -0,0 +1,162 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe List Url - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe List Url +
+ +
+
+ + +
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-parent.423705.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-parent.423705.golden new file mode 100644 index 00000000..71a094ad --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-parent.423705.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Parent - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Parent +
+ +
+

parent source

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-redirect.335ce7.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-redirect.335ce7.golden new file mode 100644 index 00000000..4dfd6bb1 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-redirect.335ce7.golden @@ -0,0 +1,11 @@ +302 +Content-Length: 0 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Location: /probe:full +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-tagged.cba9e8.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-tagged.cba9e8.golden new file mode 100644 index 00000000..1974b2c3 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-tagged.cba9e8.golden @@ -0,0 +1,165 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Tagged - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Tagged +
+ +
+ +

标记为 en 的页面列表 来自分类 lang：

+
+ +
+
+ Probe Full +
+
+ +
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-taggedplain.d9112e.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-taggedplain.d9112e.golden new file mode 100644 index 00000000..2cb96102 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-taggedplain.d9112e.golden @@ -0,0 +1,171 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Tagged Plain - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Tagged Plain +
+ +
+ +

标记为 zeta 的页面列表：

+
+ +
+
+ Probe Full +
+
+ +
+
+ Probe Third +
+
+ +
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probe-unknownmodule.05ccde.golden b/internal/difftest/testdata/snapshots/articles/GET_probe-unknownmodule.05ccde.golden new file mode 100644 index 00000000..576a3083 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probe-unknownmodule.05ccde.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Unknown Module - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Unknown Module +
+ +
+

模块 'NoSuchModule' 不存在

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probecss-styled.d4c98a.golden b/internal/difftest/testdata/snapshots/articles/GET_probecss-styled.d4c98a.golden new file mode 100644 index 00000000..d238d037 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probecss-styled.d4c98a.golden @@ -0,0 +1,158 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Styled - Test Wiki + + + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Styled +
+ +
+ +

styled body

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probecss-styledhead.30a147.golden b/internal/difftest/testdata/snapshots/articles/GET_probecss-styledhead.30a147.golden new file mode 100644 index 00000000..a751cfee --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probecss-styledhead.30a147.golden @@ -0,0 +1,158 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Styled Head - Test Wiki + + + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Styled Head +
+ +
+ +

head styled body

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probestars-rated.971888.golden b/internal/difftest/testdata/snapshots/articles/GET_probestars-rated.971888.golden new file mode 100644 index 00000000..c99d8505 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probestars-rated.971888.golden @@ -0,0 +1,173 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Rated - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Rated +
+ +
+

rated source

+
+
+ +
+ +
+ 默认: + + + alpha + + +
+ +
+ Probe Topic: + + + scp + + +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_probestars-third.22a169.golden b/internal/difftest/testdata/snapshots/articles/GET_probestars-third.22a169.golden new file mode 100644 index 00000000..6c0d4961 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_probestars-third.22a169.golden @@ -0,0 +1,164 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Probe Third - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ Probe Third +
+ +
+
评分: 3.3
3/100%
+
+
+ +
+ +
+ 默认: + + + zeta + + +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 7月8日, 2022年 17:10
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles__default-main.45e6f6.golden b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles__default-main.45e6f6.golden new file mode 100644 index 00000000..a338174a --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles__default-main.45e6f6.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"uid": 4, "pageId": "main", "title": "main", "source": "+ \u606d\u559c\uff01\u4e00\u5207\u6b63\u5e38\uff01", "tags": [], "author": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "parent": null, "locked": false} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_no-such-page.6366af.golden b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_no-such-page.6366af.golden new file mode 100644 index 00000000..2a0602fa --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_no-such-page.6366af.golden @@ -0,0 +1,11 @@ +404 +Content-Length: 43 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"error": "\u9875\u9762\u672a\u627e\u5230"} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-bare.52bfc1.golden b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-bare.52bfc1.golden new file mode 100644 index 00000000..f354b835 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-bare.52bfc1.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"uid": 13, "pageId": "probe:bare", "title": "Probe Bare", "source": "bare source", "tags": [], "author": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "parent": null, "locked": false} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-full.882d26.golden b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-full.882d26.golden new file mode 100644 index 00000000..97159f4e --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-full.882d26.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"uid": 12, "pageId": "probe:full", "title": "Probe Full", "source": "full source\nsecond line", "tags": ["alpha", "lang:en", "zeta"], "author": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, {"type": "wikidot", "id": 31, "name": "wd:Probe WD", "username": "576c0df3-8a28-4468-9770-ede851d88c67", "urlName": "probe-wd-original", "isActive": false, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "parent": "probe:parent", "locked": false} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-parent.4242b5.golden b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-parent.4242b5.golden new file mode 100644 index 00000000..22f3d3ba --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-parent.4242b5.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"uid": 11, "pageId": "probe:parent", "title": "Probe Parent", "source": "parent source", "tags": [], "author": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "parent": null, "locked": false} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-tagged.ecca60.golden b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-tagged.ecca60.golden new file mode 100644 index 00000000..68270219 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probe-tagged.ecca60.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"uid": 115, "pageId": "probe:tagged", "title": "Probe Tagged", "source": "[[module PagesByTag tag=\"lang:en\"]]", "tags": [], "author": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "parent": null, "locked": false} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probestars-unrated.72feb8.golden b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probestars-unrated.72feb8.golden new file mode 100644 index 00000000..a3e4ab0d --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_pw-api_articles_probestars-unrated.72feb8.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"uid": 135, "pageId": "probestars:unrated", "title": "Probe Unrated", "source": "unrated source\n[[[probe:no-such-one|first]]] [[[probe:no-such-two]]] [[[wanted:alpha|alpha]]]", "tags": ["_staff", "alpha"], "author": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "parent": null, "locked": false} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/articles/GET_scp-173.49f7c9.golden b/internal/difftest/testdata/snapshots/articles/GET_scp-173.49f7c9.golden new file mode 100644 index 00000000..998cc4a6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_scp-173.49f7c9.golden @@ -0,0 +1,160 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + scp-173 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ scp-173 +
+ +
+

这是一个被 include 的组件。参数 a = %%a%%

项目编号： SCP-173

项目等级： Euclid

描述

一个测试用条目，包含 内链、红链 和一个代码块：

print("hello")
评分: +1+–x
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月20日, 2026年 15:26
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_search-site.92e62d.golden b/internal/difftest/testdata/snapshots/articles/GET_search-site.92e62d.golden new file mode 100644 index 00000000..5522f56b --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_search-site.92e62d.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + site - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ site +
+ +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_search-site_datefrom_2021-01-01_dateto_2021-12-31.bbcbc3.golden b/internal/difftest/testdata/snapshots/articles/GET_search-site_datefrom_2021-01-01_dateto_2021-12-31.bbcbc3.golden new file mode 100644 index 00000000..27d0a537 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_search-site_datefrom_2021-01-01_dateto_2021-12-31.bbcbc3.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + site - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ site +
+ +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_search-site_q_-20spaced-20_author_probe-author.4c43e2.golden b/internal/difftest/testdata/snapshots/articles/GET_search-site_q_-20spaced-20_author_probe-author.4c43e2.golden new file mode 100644 index 00000000..c060cb39 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_search-site_q_-20spaced-20_author_probe-author.4c43e2.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + site - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ site +
+ +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_search-site_q_scp.74fce8.golden b/internal/difftest/testdata/snapshots/articles/GET_search-site_q_scp.74fce8.golden new file mode 100644 index 00000000..86d9ca36 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_search-site_q_scp.74fce8.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:30 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + site - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ site +
+ +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/GET_this-page-does-not-exist.4e61d9.golden b/internal/difftest/testdata/snapshots/articles/GET_this-page-does-not-exist.4e61d9.golden new file mode 100644 index 00000000..9ac744cd --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/GET_this-page-does-not-exist.4e61d9.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+ +

您请求的页面 不存在 + +

+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/articles/OPTIONS_probe-full.700ef1.golden b/internal/difftest/testdata/snapshots/articles/OPTIONS_probe-full.700ef1.golden new file mode 100644 index 00000000..442119f3 --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/OPTIONS_probe-full.700ef1.golden @@ -0,0 +1,11 @@ +200 +Allow: GET, HEAD, OPTIONS +Content-Length: 0 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + diff --git a/internal/difftest/testdata/snapshots/articles/POST_probe-full.9f9144.golden b/internal/difftest/testdata/snapshots/articles/POST_probe-full.9f9144.golden new file mode 100644 index 00000000..104cfcef --- /dev/null +++ b/internal/difftest/testdata/snapshots/articles/POST_probe-full.9f9144.golden @@ -0,0 +1,12 @@ +405 +Allow: GET, HEAD, OPTIONS +Content-Length: 19 +Content-Type: text/plain; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:29 GMT +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +Method Not Allowed diff --git a/internal/difftest/testdata/snapshots/default/GET_-.83f4ad.golden b/internal/difftest/testdata/snapshots/default/GET_-.83f4ad.golden new file mode 100644 index 00000000..496cc863 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-.83f4ad.golden @@ -0,0 +1,11 @@ +302 +Content-Length: 0 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Location: / +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + diff --git a/internal/difftest/testdata/snapshots/default/GET_-_login.534a5e.golden b/internal/difftest/testdata/snapshots/default/GET_-_login.534a5e.golden new file mode 100644 index 00000000..66126505 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_login.534a5e.golden @@ -0,0 +1,87 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Set-Cookie: pwikit_csrftoken=gb575pxrQ0oLHea8ZlfHckobNPgXB8TQ; Path=/; Max-Age=31536000; SameSite=Lax +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + 登录账号 - Test Wiki + + + + + + + + + + + + + + + +
+ +
+ +
+

+
+
+ +
+
+
+ + +
+ ProjectWikit +
+ +
+

登录账号

+
+ + + +
+
+ + +
+
+ + +
+
+ + + +
+ 忘记密码 +
+ 还没有账号 + 注册 +
+
+ +
+
+
+ +
+
+
+
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_-_profile_edit.88b751.golden b/internal/difftest/testdata/snapshots/default/GET_-_profile_edit.88b751.golden new file mode 100644 index 00000000..b340d6e1 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_profile_edit.88b751.golden @@ -0,0 +1,11 @@ +302 +Content-Length: 0 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Location: /-/login?to=%2F-%2Fprofile%2Fedit +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + diff --git a/internal/difftest/testdata/snapshots/default/GET_-_signup.ec227d.golden b/internal/difftest/testdata/snapshots/default/GET_-_signup.ec227d.golden new file mode 100644 index 00000000..cef27de2 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_signup.ec227d.golden @@ -0,0 +1,230 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Set-Cookie: pwikit_csrftoken=LQ7bB1SdKE3pHo7cBodgbZSWwoVS2nv6; Path=/; Max-Age=31536000; SameSite=Lax +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + 用户注册 - Test Wiki + + + + + + + + + + + + + + + +
+ +
+ +
+

+
+
+ +
+
+ +
+ + +
+ ProjectWikit +
+ +
+

创建账号

+
+ + + +
+
+ + +
+ + + +
+ + +
+ +
+ + +
+
+ + +
+
+ + + +
+ 普通注册默认分配「读者」权限 + 已有账号 → 登录 +
+ +
+ +
+
+ + + + + +
+
+
+
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_-_users_1-.20ce64.golden b/internal/difftest/testdata/snapshots/default/GET_-_users_1-.20ce64.golden new file mode 100644 index 00000000..23ccc7a6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_users_1-.20ce64.golden @@ -0,0 +1,11 @@ +404 +Content-Length: 14 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +User not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/default/GET_-_users_1.2e00f3.golden b/internal/difftest/testdata/snapshots/default/GET_-_users_1.2e00f3.golden new file mode 100644 index 00000000..23ccc7a6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_users_1.2e00f3.golden @@ -0,0 +1,11 @@ +404 +Content-Length: 14 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +User not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/default/GET_-_users_PROBE-AUTHOR.7e97e2.golden b/internal/difftest/testdata/snapshots/default/GET_-_users_PROBE-AUTHOR.7e97e2.golden new file mode 100644 index 00000000..4c724132 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_users_PROBE-AUTHOR.7e97e2.golden @@ -0,0 +1,355 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + Probe Author - Test Wiki + + + + + + + + + + + + + + + +
+ +
+ +
+

+
+
+ +
+
+ +
+ + ProjectWikit + ProjectWikit + + + 用户/Probe Author +
+
+ +
+ +
+
个人/用户/30-Probe Author
+

个人资料

+
+ +
+
+ Probe Author +
+
+
+ + Probe Author + +
+ +
+
+ + +
+
+ +
+ + + + +
加入时间
+
+ 2026 年 8 月 24 日 +
+
+ + + + +
+ 编辑履历 + +
    + +
  • + + Probe Changes + ? + + 2024 年 11 月 12 日 + Test Wiki·已回退页面至版本 #1 +
    • + +
  • + + Probe Changes + + + 2024 年 11 月 12 日 + Test Wiki·已回退页面至版本 #0 +
    • + +
  • + + Probe Changes + ST + + 2024 年 11 月 12 日 + Test Wiki·已回退页面至版本 #2 +
    • + +
  • + + Probe Changes + W + + 2024 年 11 月 12 日 + Test Wiki·imported from wikidot +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki·添加作者：probevoter。 移除作者：wd:Probe WD。 +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki·移除作者：wd:Probe WD。 +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki·添加作者：Probe Author, probevoter。 +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki·添加作者：Probe Author。 +
    • + +
  • + + Probe Changes + V + + 2024 年 11 月 12 日 + Test Wiki·已重置页面评分：无（投票数：0，人气：0%） +
    • + +
+
+ 第 1 页; 共 4 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+ +
+ + +
+ 发帖履历 + + +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+ + +
+ +
+
+ +
+
+
+
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_-_users_nobody-at-all.118cd8.golden b/internal/difftest/testdata/snapshots/default/GET_-_users_nobody-at-all.118cd8.golden new file mode 100644 index 00000000..23ccc7a6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_users_nobody-at-all.118cd8.golden @@ -0,0 +1,11 @@ +404 +Content-Length: 14 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +User not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/default/GET_-_users_probe-author.84cda7.golden b/internal/difftest/testdata/snapshots/default/GET_-_users_probe-author.84cda7.golden new file mode 100644 index 00000000..cf734ef9 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_users_probe-author.84cda7.golden @@ -0,0 +1,355 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + Probe Author - Test Wiki + + + + + + + + + + + + + + + +
+ +
+ +
+

+
+
+ +
+
+ +
+ + ProjectWikit + ProjectWikit + + + 用户/Probe Author +
+
+ +
+ +
+
个人/用户/30-Probe Author
+

个人资料

+
+ +
+
+ Probe Author +
+
+
+ + Probe Author + +
+ +
+
+ + +
+
+ +
+ + + + +
加入时间
+
+ 2026 年 8 月 24 日 +
+
+ + + + +
+ 编辑履历 + +
    + +
  • + + Probe Changes + ? + + 2024 年 11 月 12 日 + Test Wiki·已回退页面至版本 #1 +
    • + +
  • + + Probe Changes + + + 2024 年 11 月 12 日 + Test Wiki·已回退页面至版本 #0 +
    • + +
  • + + Probe Changes + ST + + 2024 年 11 月 12 日 + Test Wiki·已回退页面至版本 #2 +
    • + +
  • + + Probe Changes + W + + 2024 年 11 月 12 日 + Test Wiki·imported from wikidot +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki·添加作者：probevoter。 移除作者：wd:Probe WD。 +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki·移除作者：wd:Probe WD。 +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki·添加作者：Probe Author, probevoter。 +
    • + +
  • + + Probe Changes + C + + 2024 年 11 月 12 日 + Test Wiki·添加作者：Probe Author。 +
    • + +
  • + + Probe Changes + V + + 2024 年 11 月 12 日 + Test Wiki·已重置页面评分：无（投票数：0，人气：0%） +
    • + +
+
+ 第 1 页; 共 4 页 + + + + 1 + + + + 2 + + + + 3 + + + + + + + + 4 + + + + 下一页 » + +
+ +
+ + +
+ 发帖履历 + + +
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+ +
+ + +
+ +
+
+ +
+
+
+
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_-_users_probe-staff.1683de.golden b/internal/difftest/testdata/snapshots/default/GET_-_users_probe-staff.1683de.golden new file mode 100644 index 00000000..d418ae03 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_users_probe-staff.1683de.golden @@ -0,0 +1,119 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + Probe Staff - Test Wiki + + + + + + + + + + + + + + + +
+ +
+ +
+

+
+
+ +
+
+ +
+ + ProjectWikit + ProjectWikit + + + 用户/Probe Staff +
+
+ +
+ +
+
个人/用户/188-Probe Staff
+

个人资料

+
+ +
+
+ Probe Staff +
+
+
+ + Probe Staff + +
+ +
+
+ + +
+
+ +
+ + + + +
加入时间
+
+ 2026 年 8 月 30 日 +
+
+ + + + +
+ 编辑履历 + +
还没有编辑过任何页面。
+ +
+ + +
+ 发帖履历 + +
还没有发过任何帖子。
+ +
+ + +
+ +
+
+ +
+
+
+
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_-_users_probe-wd-original.2774a5.golden b/internal/difftest/testdata/snapshots/default/GET_-_users_probe-wd-original.2774a5.golden new file mode 100644 index 00000000..1d7a2bc6 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_users_probe-wd-original.2774a5.golden @@ -0,0 +1,133 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + wd:Probe WD - Test Wiki + + + + + + + + + + + + + + + +
+ +
+ +
+

+
+
+ +
+
+ +
+ + ProjectWikit + ProjectWikit + + + 用户/wd:Probe WD +
+
+ +
+ +
+
个人/用户/31-wd:Probe WD
+

个人资料

+
+ +
+
+ wd:Probe WD +
+
+
+ + wd:Probe WD + +
+
未激活
+
+
+ + +
+
+ +
+ +
账号状态
从 Wikidot 平台迁移而来的非活跃用户
+ + + + +
加入时间
+
+ 2026 年 8 月 24 日 +
+
+ + + + +
+ 编辑履历 + +
    + +
  • + + Probe Changes + S + + 2024 年 11 月 12 日 + Test Wiki +
    • + +
+ + +
+ + +
+ 发帖履历 + +
还没有发过任何帖子。
+ +
+ + +
+ +
+
+ +
+
+
+
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_-_users_probevoter.311a55.golden b/internal/difftest/testdata/snapshots/default/GET_-_users_probevoter.311a55.golden new file mode 100644 index 00000000..5ed4b020 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_-_users_probevoter.311a55.golden @@ -0,0 +1,243 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + probevoter - Test Wiki + + + + + + + + + + + + + + + +
+ +
+ +
+

+
+
+ +
+
+ +
+ + ProjectWikit + ProjectWikit + + + 用户/probevoter +
+
+ +
+ +
+
个人/用户/32-probevoter
+

个人资料

+
+ +
+
+ probevoter +
+
+
+ + probevoter + +
+ +
+
+ + +
+
+ +
+ + + + +
加入时间
+
+ 2026 年 8 月 24 日 +
+
+ + + + +
+ 编辑履历 + +
    + +
  • + + Probe Changes + S + + 2024 年 11 月 12 日 + Test Wiki +
    • + +
+ + +
+ + +
+ 发帖履历 + + +
+ 第 1 页; 共 2 页 + + + + 1 + + + + + + + + 2 + + + + 下一页 » + +
+ +
+ + +
+ +
+
+ +
+
+
+
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_.c76702.golden b/internal/difftest/testdata/snapshots/default/GET_.c76702.golden new file mode 100644 index 00000000..89a6e057 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_.c76702.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:25 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + main - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ main +
+ +
+

恭喜！一切正常！

+
+
+ +
+ +
+ +
+
+ +
页面版本: 1, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_component-box.42453e.golden b/internal/difftest/testdata/snapshots/default/GET_component-box.42453e.golden new file mode 100644 index 00000000..2926c74a --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_component-box.42453e.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:25 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + box - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ box +
+ +
+

这是一个被 include 的组件。参数 a = %%a%%

+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月20日, 2026年 15:26
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_local--files_nonexistent.png.c9cedd.golden b/internal/difftest/testdata/snapshots/default/GET_local--files_nonexistent.png.c9cedd.golden new file mode 100644 index 00000000..96c27290 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_local--files_nonexistent.png.c9cedd.golden @@ -0,0 +1,9 @@ +302 +Content-Length: 0 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Location: //media.localhost/local--files/nonexistent.png +Referrer-Policy: same-origin +Vary: Cookie + diff --git a/internal/difftest/testdata/snapshots/default/GET_local--theme_1_style.css.b5763d.golden b/internal/difftest/testdata/snapshots/default/GET_local--theme_1_style.css.b5763d.golden new file mode 100644 index 00000000..509c7597 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_local--theme_1_style.css.b5763d.golden @@ -0,0 +1,9 @@ +302 +Content-Length: 0 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Location: //media.localhost/local--theme/1/style.css +Referrer-Policy: same-origin +Vary: Cookie + diff --git a/internal/difftest/testdata/snapshots/default/GET_main.e6dfb1.golden b/internal/difftest/testdata/snapshots/default/GET_main.e6dfb1.golden new file mode 100644 index 00000000..89a6e057 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_main.e6dfb1.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:25 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + main - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ main +
+ +
+

恭喜！一切正常！

+
+
+ +
+ +
+ +
+
+ +
页面版本: 1, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_main_norender_true.7cb442.golden b/internal/difftest/testdata/snapshots/default/GET_main_norender_true.7cb442.golden new file mode 100644 index 00000000..4e8bb0c2 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_main_norender_true.7cb442.golden @@ -0,0 +1,155 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:25 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + main - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ main +
+ +
+

恭喜！一切正常！

+
+
+ +
+ +
+ +
+
+ +
页面版本: 1, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_missing-page.f9ea63.golden b/internal/difftest/testdata/snapshots/default/GET_missing-page.f9ea63.golden new file mode 100644 index 00000000..537c68a5 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_missing-page.f9ea63.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+ +

您请求的页面 不存在 + +

+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_nav-side.fa4588.golden b/internal/difftest/testdata/snapshots/default/GET_nav-side.fa4588.golden new file mode 100644 index 00000000..812d7aba --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_nav-side.fa4588.golden @@ -0,0 +1,185 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + side - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ side +
+ +
+

存在的页面：

+
标题名称
pwikit 新功能演示pwikit-demo
top-implnav:top-impl
startforum:start
threadforum:thread
categoryforum:category
new-threadforum:new-thread
recent-postsforum:recent-posts
sitesearch:site
wiki-syntax-guidewiki-syntax-guide
Page Bprobe-b
Page Aprobe-a
Shared Componentcomponent:probe-var
scp-173scp-173
mainmain
boxcomponent:box
sidenav:side
topnav:top
Probe Parentprobe:parent
Probe Fullprobe:full
Probe Bareprobe:bare
+
+ 第 1 页; 共 3 页 + + + + 1 + + + + 2 + + + + + + + + 3 + + + + 下一页 » + +
+
+
+
+ +
+ +
+ +
+
+ +
页面版本: 1, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_nav-top.dade2f.golden b/internal/difftest/testdata/snapshots/default/GET_nav-top.dade2f.golden new file mode 100644 index 00000000..dc194017 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_nav-top.dade2f.golden @@ -0,0 +1,209 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:25 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + top - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ top +
+ +
+

≡

+
+
+ +
+ +
+ +
+
+ +
页面版本: 1, 最后编辑: 8月27日, 2026年 00:12
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_pw-api_articles.748d4c.golden b/internal/difftest/testdata/snapshots/default/GET_pw-api_articles.748d4c.golden new file mode 100644 index 00000000..bbb31529 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_pw-api_articles.748d4c.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +[{"uid": 205, "pageId": "pwikit-demo", "title": "pwikit \u65b0\u529f\u80fd\u6f14\u793a", "canonicalUrl": "//localhost/pwikit-demo", "createdAt": "2026-08-31T10:59:02.384683+00:00", "updatedAt": "2026-08-31T10:59:02.384683+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 125, "pageId": "nav:top-impl", "title": "top-impl", "canonicalUrl": "//localhost/nav:top-impl", "createdAt": "2026-08-26T16:12:44.834388+00:00", "updatedAt": "2026-08-26T16:12:44.840541+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 124, "pageId": "forum:start", "title": "start", "canonicalUrl": "//localhost/forum:start", "createdAt": "2026-08-26T16:12:44.819086+00:00", "updatedAt": "2026-08-26T16:12:44.826374+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 123, "pageId": "forum:thread", "title": "thread", "canonicalUrl": "//localhost/forum:thread", "createdAt": "2026-08-26T16:12:44.806389+00:00", "updatedAt": "2026-08-26T16:12:44.812809+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 122, "pageId": "forum:category", "title": "category", "canonicalUrl": "//localhost/forum:category", "createdAt": "2026-08-26T16:12:44.792185+00:00", "updatedAt": "2026-08-26T16:12:44.79952+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 121, "pageId": "forum:new-thread", "title": "new-thread", "canonicalUrl": "//localhost/forum:new-thread", "createdAt": "2026-08-26T16:12:44.779666+00:00", "updatedAt": "2026-08-26T16:12:44.785956+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 120, "pageId": "forum:recent-posts", "title": "recent-posts", "canonicalUrl": "//localhost/forum:recent-posts", "createdAt": "2026-08-26T16:12:44.766694+00:00", "updatedAt": "2026-08-26T16:12:44.773398+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 119, "pageId": "search:site", "title": "site", "canonicalUrl": "//localhost/search:site", "createdAt": "2026-08-26T16:12:44.750837+00:00", "updatedAt": "2026-08-26T16:12:44.758612+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 118, "pageId": "wiki-syntax-guide", "title": "wiki-syntax-guide", "canonicalUrl": "//localhost/wiki-syntax-guide", "createdAt": "2026-08-26T16:12:44.654543+00:00", "updatedAt": "2026-08-26T16:12:44.741391+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 10, "pageId": "probe-b", "title": "Page B", "canonicalUrl": "//localhost/probe-b", "createdAt": "2026-08-23T08:47:08.356311+00:00", "updatedAt": "2026-08-23T08:47:08.372248+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 9, "pageId": "probe-a", "title": "Page A", "canonicalUrl": "//localhost/probe-a", "createdAt": "2026-08-23T08:47:08.337019+00:00", "updatedAt": "2026-08-23T08:47:08.351223+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 8, "pageId": "component:probe-var", "title": "Shared Component", "canonicalUrl": "//localhost/component:probe-var", "createdAt": "2026-08-23T08:47:08.282178+00:00", "updatedAt": "2026-08-23T08:47:08.332887+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 5, "pageId": "scp-173", "title": "scp-173", "canonicalUrl": "//localhost/scp-173", "createdAt": "2026-08-20T07:26:18.36665+00:00", "updatedAt": "2026-08-20T07:26:18.377982+00:00", "createdBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 1, "votes": 1, "popularity": 100, "mode": "updown"}, "tags": []}, {"uid": 4, "pageId": "main", "title": "main", "canonicalUrl": "//localhost/main", "createdAt": "2026-08-20T07:26:18.351937+00:00", "updatedAt": "2026-08-26T16:12:44.642178+00:00", "createdBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 3, "pageId": "component:box", "title": "box", "canonicalUrl": "//localhost/component:box", "createdAt": "2026-08-20T07:26:18.337302+00:00", "updatedAt": "2026-08-20T07:26:18.347679+00:00", "createdBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 2, "pageId": "nav:side", "title": "side", "canonicalUrl": "//localhost/nav:side", "createdAt": "2026-08-20T07:26:18.322901+00:00", "updatedAt": "2026-08-26T16:12:44.865597+00:00", "createdBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 1, "pageId": "nav:top", "title": "top", "canonicalUrl": "//localhost/nav:top", "createdAt": "2026-08-20T07:26:18.286289+00:00", "updatedAt": "2026-08-26T16:12:44.852216+00:00", "createdBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 11, "pageId": "probe:parent", "title": "Probe Parent", "canonicalUrl": "//localhost/probe:parent", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 12, "pageId": "probe:full", "title": "Probe Full", "canonicalUrl": "//localhost/probe:full", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, {"type": "wikidot", "id": 31, "name": "wd:Probe WD", "username": "576c0df3-8a28-4468-9770-ede851d88c67", "urlName": "probe-wd-original", "isActive": false, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 1, "votes": 3, "popularity": 67, "mode": "updown"}, "tags": ["alpha", "lang:en", "zeta"]}, {"uid": 13, "pageId": "probe:bare", "title": "Probe Bare", "canonicalUrl": "//localhost/probe:bare", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 14, "pageId": "probestars:rated", "title": "Probe Rated", "canonicalUrl": "//localhost/probestars:rated", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 4.5, "votes": 2, "popularity": 100, "mode": "stars"}, "tags": ["alpha", "topic:scp"]}, {"uid": 15, "pageId": "probe:half", "title": "Probe Half", "canonicalUrl": "//localhost/probe:half", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": -6, "votes": 8, "popularity": 12, "mode": "updown"}, "tags": []}, {"uid": 16, "pageId": "probe:included", "title": "Included Page", "canonicalUrl": "//localhost/probe:included", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 17, "pageId": "probe:host", "title": "Probe Host", "canonicalUrl": "//localhost/probe:host", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 112, "pageId": "probe:redirect", "title": "Probe Redirect", "canonicalUrl": "//localhost/probe:redirect", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 113, "pageId": "probe:described", "title": "Probe Described", "canonicalUrl": "//localhost/probe:described", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 114, "pageId": "probe:imaged", "title": "Probe Imaged", "canonicalUrl": "//localhost/probe:imaged", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 115, "pageId": "probe:tagged", "title": "Probe Tagged", "canonicalUrl": "//localhost/probe:tagged", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 116, "pageId": "probe:taggedplain", "title": "Probe Tagged Plain", "canonicalUrl": "//localhost/probe:taggedplain", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 117, "pageId": "probe:unknownmodule", "title": "Probe Unknown Module", "canonicalUrl": "//localhost/probe:unknownmodule", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 126, "pageId": "probe:bydisplay", "title": "Probe By Display Name", "canonicalUrl": "//localhost/probe:bydisplay", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 127, "pageId": "probe:listed", "title": "Probe Listed", "canonicalUrl": "//localhost/probe:listed", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 128, "pageId": "probe:listjoined", "title": "Probe List Joined", "canonicalUrl": "//localhost/probe:listjoined", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 129, "pageId": "probe:listnowrap", "title": "Probe List No Wrapper", "canonicalUrl": "//localhost/probe:listnowrap", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 130, "pageId": "probe:listsections", "title": "Probe List Sections", "canonicalUrl": "//localhost/probe:listsections", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 131, "pageId": "probe:listtags", "title": "Probe List Tags", "canonicalUrl": "//localhost/probe:listtags", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 132, "pageId": "probe:listempty", "title": "Probe List Empty", "canonicalUrl": "//localhost/probe:listempty", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 133, "pageId": "probe:listurl", "title": "Probe List Url", "canonicalUrl": "//localhost/probe:listurl", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 134, "pageId": "probe:listbyvotes", "title": "Probe List By Votes", "canonicalUrl": "//localhost/probe:listbyvotes", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 135, "pageId": "probestars:unrated", "title": "Probe Unrated", "canonicalUrl": "//localhost/probestars:unrated", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0.0, "votes": 0, "popularity": 0, "mode": "stars"}, "tags": ["_staff", "alpha"]}, {"uid": 137, "pageId": "probestars:quarter", "title": "Probe Quarter", "canonicalUrl": "//localhost/probestars:quarter", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0.8, "votes": 2, "popularity": 0, "mode": "stars"}, "tags": ["alpha", "topic:scp"]}, {"uid": 138, "pageId": "probeoff:unratable", "title": "Probe Unratable", "canonicalUrl": "//localhost/probeoff:unratable", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "disabled"}, "tags": ["lang:aaa", "topic:scp"]}, {"uid": 139, "pageId": "probestars:third", "title": "Probe Third", "canonicalUrl": "//localhost/probestars:third", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 3.3, "votes": 3, "popularity": 100, "mode": "stars"}, "tags": ["_staff", "zeta"]}, {"uid": 196, "pageId": "probecss:styled", "title": "Probe Styled", "canonicalUrl": "//localhost/probecss:styled", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 197, "pageId": "probecss:styledhead", "title": "Probe Styled Head", "canonicalUrl": "//localhost/probecss:styledhead", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "updatedBy": {"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}, "authors": [{"type": "system", "id": null, "name": null, "username": null, "urlName": null, "isActive": true, "avatar": null, "showAvatar": false, "admin": false, "staff": false, "editor": false, "roles": null}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}, {"uid": 198, "pageId": "probe:changes", "title": "Probe Changes", "canonicalUrl": "//localhost/probe:changes", "createdAt": "2021-03-04T05:06:07+00:00", "updatedAt": "2022-07-08T09:10:11+00:00", "createdBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "updatedBy": {"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 30, "name": "Probe Author", "username": "probe-author", "urlName": "probe-author", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "rating": {"value": 0, "votes": 0, "popularity": 0, "mode": "updown"}, "tags": []}] \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173.7a9de4.golden b/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173.7a9de4.golden new file mode 100644 index 00000000..a633417f --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173.7a9de4.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"uid": 5, "pageId": "scp-173", "title": "scp-173", "source": "[[include component:box a=173]]\n\n**\u9879\u76ee\u7f16\u53f7\uff1a** SCP-173\n\n**\u9879\u76ee\u7b49\u7ea7\uff1a** Euclid\n\n+ \u63cf\u8ff0\n\n\u4e00\u4e2a\u6d4b\u8bd5\u7528\u6761\u76ee\uff0c\u5305\u542b [[[main | \u5185\u94fe]]]\u3001[[[another-missing | \u7ea2\u94fe]]] \u548c\u4e00\u4e2a\u4ee3\u7801\u5757\uff1a\n\n[[code type=\"python\"]]\nprint(\"hello\")\n[[/code]]\n\n[[module Rate]]", "tags": [], "author": {"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}, "authors": [{"type": "normal", "id": 1, "name": "seeduser", "username": "seeduser", "urlName": "seeduser", "isActive": true, "avatar": null, "showAvatar": true, "admin": false, "staff": false, "editor": false, "roles": []}], "parent": null, "locked": false} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173_links.b1567a.golden b/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173_links.b1567a.golden new file mode 100644 index 00000000..86c4859c --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173_links.b1567a.golden @@ -0,0 +1,11 @@ +200 +Content-Length: 45 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"children": [], "includes": [], "links": []} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173_votes.db6037.golden b/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173_votes.db6037.golden new file mode 100644 index 00000000..9faa2986 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_pw-api_articles_scp-173_votes.db6037.golden @@ -0,0 +1,10 @@ +200 +Content-Type: application/json +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + +{"pageId": "scp-173", "votes": [{"user": {"type": "normal", "id": 67, "name": "Wikit Admin", "username": "wikitadmin", "urlName": "wikitadmin", "isActive": true, "avatar": null, "showAvatar": true, "admin": true, "staff": true, "editor": true, "roles": []}, "value": 1.0, "visualGroup": null, "visualGroupIndex": null}], "rating": 1, "popularity": 100, "mode": "updown"} \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/default/GET_pw-apidocs.21ef6a.golden b/internal/difftest/testdata/snapshots/default/GET_pw-apidocs.21ef6a.golden new file mode 100644 index 00000000..30e064fe --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_pw-apidocs.21ef6a.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+ +

您请求的页面 不存在 + +

+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_scp-173.49f7c9.golden b/internal/difftest/testdata/snapshots/default/GET_scp-173.49f7c9.golden new file mode 100644 index 00000000..fb51dee9 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_scp-173.49f7c9.golden @@ -0,0 +1,160 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:25 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + scp-173 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ scp-173 +
+ +
+

这是一个被 include 的组件。参数 a = %%a%%

项目编号： SCP-173

项目等级： Euclid

描述

一个测试用条目，包含 内链、红链 和一个代码块：

print("hello")
评分: +1+–x
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月20日, 2026年 15:26
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_scp-173_edit_true.47bfef.golden b/internal/difftest/testdata/snapshots/default/GET_scp-173_edit_true.47bfef.golden new file mode 100644 index 00000000..50af716b --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_scp-173_edit_true.47bfef.golden @@ -0,0 +1,160 @@ +200 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:25 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + scp-173 - Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+
+ scp-173 +
+ +
+

这是一个被 include 的组件。参数 a = %%a%%

项目编号： SCP-173

项目等级： Euclid

描述

一个测试用条目，包含 内链、红链 和一个代码块：

print("hello")
评分: +1+–x
+
+
+ +
+ +
+ +
+
+ +
页面版本: 0, 最后编辑: 8月20日, 2026年 15:26
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/GET_this-page-does-not-exist.4e61d9.golden b/internal/difftest/testdata/snapshots/default/GET_this-page-does-not-exist.4e61d9.golden new file mode 100644 index 00000000..d45333f7 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/GET_this-page-does-not-exist.4e61d9.golden @@ -0,0 +1,155 @@ +404 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie, Accept-Encoding +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + + + + + + + + + + + + + + + + + + + + + + + Test Wiki + + + + + + + + + + + + + + + + +
+ +
+
+
+ +
+ +
+
+ + +
+ +

您请求的页面 不存在 + +

+
+ +
+ +
+ +
+
+ +
+
+
+
+ +
+ 除非特别注明，本页内容采用以下授权方式： Creative Commons Attribution-ShareAlike 3.0 License. +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ + diff --git a/internal/difftest/testdata/snapshots/default/HEAD_-_users_probe-author.f02453.golden b/internal/difftest/testdata/snapshots/default/HEAD_-_users_probe-author.f02453.golden new file mode 100644 index 00000000..0a06be40 --- /dev/null +++ b/internal/difftest/testdata/snapshots/default/HEAD_-_users_probe-author.f02453.golden @@ -0,0 +1,10 @@ +200 +Content-Length: 0 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:26 GMT +Referrer-Policy: same-origin +Vary: Cookie +X-Content-Type-Options: nosniff +X-Frame-Options: DENY + diff --git a/internal/difftest/testdata/snapshots/media/GET_-_login.534a5e.golden b/internal/difftest/testdata/snapshots/media/GET_-_login.534a5e.golden new file mode 100644 index 00000000..63655778 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_-_login.534a5e.golden @@ -0,0 +1,9 @@ +302 +Content-Length: 0 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Location: //localhost/-/login +Referrer-Policy: same-origin +Vary: Cookie + diff --git a/internal/difftest/testdata/snapshots/media/GET_local--code_nope_1.8e8368.golden b/internal/difftest/testdata/snapshots/media/GET_local--code_nope_1.8e8368.golden new file mode 100644 index 00000000..180d15f1 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_local--code_nope_1.8e8368.golden @@ -0,0 +1,10 @@ +404 +Access-Control-Allow-Origin: * +Content-Length: 17 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Referrer-Policy: same-origin +Vary: Cookie + +Article not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/media/GET_local--code_probe-full_1.d2a9b4.golden b/internal/difftest/testdata/snapshots/media/GET_local--code_probe-full_1.d2a9b4.golden new file mode 100644 index 00000000..b8024630 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_local--code_probe-full_1.d2a9b4.golden @@ -0,0 +1,10 @@ +404 +Access-Control-Allow-Origin: * +Content-Length: 20 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Referrer-Policy: same-origin +Vary: Cookie + +Code block not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1-revNum-0.089f16.golden b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1-revNum-0.089f16.golden new file mode 100644 index 00000000..b8024630 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1-revNum-0.089f16.golden @@ -0,0 +1,10 @@ +404 +Access-Control-Allow-Origin: * +Content-Length: 20 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Referrer-Policy: same-origin +Vary: Cookie + +Code block not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1-revNum-99.21cb3a.golden b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1-revNum-99.21cb3a.golden new file mode 100644 index 00000000..b8024630 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1-revNum-99.21cb3a.golden @@ -0,0 +1,10 @@ +404 +Access-Control-Allow-Origin: * +Content-Length: 20 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Referrer-Policy: same-origin +Vary: Cookie + +Code block not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1.e361a8.golden b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1.e361a8.golden new file mode 100644 index 00000000..b8024630 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_1.e361a8.golden @@ -0,0 +1,10 @@ +404 +Access-Control-Allow-Origin: * +Content-Length: 20 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Referrer-Policy: same-origin +Vary: Cookie + +Code block not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_2.9a6c94.golden b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_2.9a6c94.golden new file mode 100644 index 00000000..b8024630 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_2.9a6c94.golden @@ -0,0 +1,10 @@ +404 +Access-Control-Allow-Origin: * +Content-Length: 20 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Referrer-Policy: same-origin +Vary: Cookie + +Code block not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_3.84286d.golden b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_3.84286d.golden new file mode 100644 index 00000000..b8024630 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_3.84286d.golden @@ -0,0 +1,10 @@ +404 +Access-Control-Allow-Origin: * +Content-Length: 20 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Referrer-Policy: same-origin +Vary: Cookie + +Code block not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_x.3581ed.golden b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_x.3581ed.golden new file mode 100644 index 00000000..b8024630 --- /dev/null +++ b/internal/difftest/testdata/snapshots/media/GET_local--code_probeoff-unratable_x.3581ed.golden @@ -0,0 +1,10 @@ +404 +Access-Control-Allow-Origin: * +Content-Length: 20 +Content-Type: text/html; charset=utf-8 +Cross-Origin-Opener-Policy: same-origin +Date: Mon, 07 Sep 2026 08:06:33 GMT +Referrer-Policy: same-origin +Vary: Cookie + +Code block not found \ No newline at end of file diff --git a/internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.bin.70287f.golden b/internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.bin.70287f.golden new file mode 100644 index 0000000000000000000000000000000000000000..5da8d2566158346a31485a3ff47094f522c4b843 GIT binary patch literal 699 zcmXpqFynGePEIW-(G5z>OHVDfQb?*SNi7Bo78mO}=jW9a<>%-+=H%p;>-raErf23^ zDQKZfyH*tB7pLlaq$Z}M76HuwX-my3(e+8qOE1aLf%Cz3aKU6VTIwT9hg24%S}ByIR+Q*xl;q}EDTV|?@TbQBEC z6@pU>6pRdv%oGePtPISojExoCeM7i>5{pZ8ee+W?(=t<2tQ3Mvfr^cc6&y>`p^8nd z3{0&|jlhb7Qqxk4ig4H#mRJO|-#I@&J2RDwi-D1enT3^&or9B$n}?T=UqDbuSVUAz zTtZSxT1Hk*UO`bwSw&S%T|-k#TSr$<-@wqw*u>P#+``hz+Q!z--oeqy*~Qh(-NVz% z+sD_>KOitDI3zSIJR&kGIwm$QJ|QtFIVCkMJtH$KJ0~|Uzo4+FxTLhKyrQzIx~8_S zzM-+HxuvzOy`!_MyQjCWf5OB`lc!9bHhsp-S+nQNoi~5M!bOXhEM2yI#mZHy*Q{N) ze#6F1o40J;wtdIWUAy<}-M9b1!9$0S96fgY#K}{q&zwDX{=&sem#&lpTB(l_Wj4tUnF}S0PrdTkN^Mx literal 0 HcmV?d00001 diff --git a/internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.pdf.f88569.golden b/internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.pdf.f88569.golden new file mode 100644 index 0000000000000000000000000000000000000000..5da8d2566158346a31485a3ff47094f522c4b843 GIT binary patch literal 699 zcmXpqFynGePEIW-(G5z>OHVDfQb?*SNi7Bo78mO}=jW9a<>%-+=H%p;>-raErf23^ zDQKZfyH*tB7pLlaq$Z}M76HuwX-my3(e+8qOE1aLf%Cz3aKU6VTIwT9hg24%S}ByIR+Q*xl;q}EDTV|?@TbQBEC z6@pU>6pRdv%oGePtPISojExoCeM7i>5{pZ8ee+W?(=t<2tQ3Mvfr^cc6&y>`p^8nd z3{0&|jlhb7Qqxk4ig4H#mRJO|-#I@&J2RDwi-D1enT3^&or9B$n}?T=UqDbuSVUAz zTtZSxT1Hk*UO`bwSw&S%T|-k#TSr$<-@wqw*u>P#+``hz+Q!z--oeqy*~Qh(-NVz% z+sD_>KOitDI3zSIJR&kGIwm$QJ|QtFIVCkMJtH$KJ0~|Uzo4+FxTLhKyrQzIx~8_S zzM-+HxuvzOy`!_MyQjCWf5OB`lc!9bHhsp-S+nQNoi~5M!bOXhEM2yI#mZHy*Q{N) ze#6F1o40J;wtdIWUAy<}-M9b1!9$0S96fgY#K}{q&zwDX{=&sem#&lpTB(l_Wj4tUnF}S0PrdTkN^Mx literal 0 HcmV?d00001 diff --git a/internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.txt.bf7b5e.golden b/internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.txt.bf7b5e.golden new file mode 100644 index 0000000000000000000000000000000000000000..4d38ffebc34631c3436278082335e574381c96f8 GIT binary patch literal 545 zcmXpqFyL}bPEIW@)^*O$D=Es)(RIwp$uHOSFUm~M%(GI^;sS}M=9TEWWEL0X7iX4a z<^zQ@^KvrtQmqxzGILV%5_3~+l@j$zDoT{#s(n)P(n~U|6pVouz)T3KEJ(FdC`qj- z(J#nJ%*^9*F3Ja546#brzaTX)wMaK0KPNM}(n_HiXsT{L*cDtZi6uadzWI4N3I^s1 z!KnobMg~S^3I-Nd24+^q#tQDfAzVSJX{kj;I1C6&ECL$ooS&banaah*z{teR!pg?Z z!O6wV!^_7nASfg(A}S^>At@y-BP%Dbps1v*qN=8@p{b>IRvK4a#r*>mR3o4;V; zqQy&=E?d50<*LVdJLFTefc7zGLUE-Fx=#+kfETp~FXx9y@;GWe&gn?+js8XyZ_+fqsLF4K70P+<*V0k-oAVP;p3;zU%r0({^RE_lD!T9 Dy6w=* literal 0 HcmV?d00001 diff --git a/internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.txt.gz.7501e5.golden b/internal/difftest/testdata/snapshots/media/GET_local--files_-_probe_a.txt.gz.7501e5.golden new file mode 100644 index 0000000000000000000000000000000000000000..273529d860500f2c6363d1de31d95790486d51a1 GIT binary patch literal 548 zcmXpqFyL}bPEIW@)^*O$D=Es)(RIwp$uHOSFUm~M%(GI^;sS}M=9TEWWEL0X7iX4a z<^zQ@^KvrtQmqxzGILV%5_3~+l@j$zDoXUytCZjxd{Xn$OERn!jDdE*3<;?$NVQTZ zNv$Z+FUU#E%;Rz{$_LsFu}#;%AT=+wNH-uqCo{RyN}(8Nux>usAzUtrB|we7`FT1D z2IdOEsRar~21aHI1{PKZW>&_=3hurkTtTU6sYOLN3tEX>ZXk=_+YG!U> zX=QC=YiIA^=;Z9;>gMj@>E-R?>*pU37!({58WtWA85JE98yBCDn3SB7nwFlCnU$TB zo0nfuSX5k6T2@|BSyf$ATUX!E*woz8+ScCD+11_C+t)u~;-tw_rcRqaW9F>cbLP&Q zzhL2_#Y>hhTfSoDs?}@Ou3Nuh Date: Mon, 7 Sep 2026 17:15:00 +0900 Subject: [PATCH 334/428] fix the migrate help line --- cmd/pwikit/main.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 64b3ab91..f4474106 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -109,7 +109,7 @@ Commands: seed write the pages a new site starts with routes print the static route table render render wikitext read from stdin or a file - migrate inspect the schema migrations + migrate apply or inspect the schema migrations modules print the wikidot module list help show this help `) From 551f9461bc12fbc5fdfe601e471475493e6fec04 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:36:42 +0900 Subject: [PATCH 335/428] answer 404 instead of forwarding --- cmd/pwikit/main.go | 145 +++++++++++++++++++-------------------------- 1 file changed, 62 insertions(+), 83 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index f4474106..28e7cc9c 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -20,7 +20,6 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/compress" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/entry" - "github.com/WikitTeam/ProjectWikit/internal/forward" "github.com/WikitTeam/ProjectWikit/internal/localitem" "github.com/WikitTeam/ProjectWikit/internal/media" "github.com/WikitTeam/ProjectWikit/internal/migrate" @@ -38,7 +37,6 @@ import ( const ( envDatabase = "DATABASE_URL" - envUpstream = "PWIKIT_UPSTREAM" envSecretKey = "SECRET_KEY" envTimeZone = "PWIKIT_TIMEZONE" envGoogleTag = "GOOGLE_TAG_ID" @@ -58,7 +56,6 @@ const ( envTLSListen = "PWIKIT_TLS_LISTEN" envACMEEmail = "PWIKIT_ACME_EMAIL" envACMEDir = "PWIKIT_ACME_DIRECTORY" - defaultUpstream = "http://127.0.0.1:8000" defaultListen = "127.0.0.1:8080" defaultTLSPlain = ":80" defaultTLSAddr = ":443" @@ -118,15 +115,13 @@ Commands: func serve(args []string) error { fs := flag.NewFlagSet("serve", flag.ContinueOnError) listen := fs.String("listen", defaultListen, "listen address") - upstream := fs.String("upstream", envOr(envUpstream, defaultUpstream), "upstream address for requests pwikit does not handle") dataDir := fs.String("data-dir", "", "state directory; defaults to the directory holding the executable") trusted := fs.String("trusted-proxies", "", "trusted reverse proxy addresses or CIDRs, comma separated; empty trusts no X-Forwarded-* header") - staticDir := fs.String("static-dir", "", "directory holding the frontend asset bundle; without it every asset request goes upstream") - database := fs.String("database", os.Getenv(envDatabase), "PostgreSQL connection string; without it every request needing the database goes upstream") + staticDir := fs.String("static-dir", "", "directory holding the frontend asset bundle") + database := fs.String("database", os.Getenv(envDatabase), "PostgreSQL connection string") secret := fs.String("secret-key", os.Getenv(envSecretKey), "key the session cookie is signed with; without it every visitor is anonymous") sidecar := fs.String("sidecar", os.Getenv(envSidecar), "path to the ftml sidecar binary; without it the linked-in ftml is used") timezone := fs.String("timezone", envOr(envTimeZone, "UTC"), "time zone dates are shown in") - bareOrigin := fs.Bool("bare-origin", false, "drop the port from the Origin header before forwarding") noMigrate := fs.Bool("no-migrate", false, "start without applying pending schema migrations") uploadLimit := fs.String("upload-limit", envOr(envUploadLimit, "0"), "size the files still attached to pages may reach, such as 4GB; 0 for no ceiling") storageLimit := fs.String("storage-limit", envOr(envStorageLimit, "0"), "size every file on disk may reach, deleted ones counted; 0 for no ceiling") @@ -143,6 +138,10 @@ func serve(args []string) error { return err } + if *database == "" { + return errors.New("serve needs -database or " + envDatabase) + } + mode, err := entry.ParseMode(*tlsMode) if err != nil { return err @@ -166,43 +165,32 @@ func serve(args []string) error { return err } - proxy, err := forward.New(*upstream, trust, log) - if err != nil { - return err - } - proxy.BareOrigin = *bareOrigin assets, err := assetFS(*staticDir) if err != nil { return err } - var conn *db.DB - if *database != "" { - if !*noMigrate { - result, err := migrate.Run(context.Background(), *database) - if err != nil { - return err - } - if result.Adopted { - log.Info("pwikit adopted the schema", "baseline", migrate.BaselineName) - } - for _, name := range result.Applied { - log.Info("pwikit applied a migration", "name", name) - } - } - conn, err = db.Open(context.Background(), *database) + if !*noMigrate { + result, err := migrate.Run(context.Background(), *database) if err != nil { return err } - defer conn.Close() + if result.Adopted { + log.Info("pwikit adopted the schema", "baseline", migrate.BaselineName) + } + for _, name := range result.Applied { + log.Info("pwikit applied a migration", "name", name) + } } - - var mediaHandler http.Handler = proxy - var resizedHandler http.Handler = proxy - if conn != nil { - mediaHandler = site.NewHostRules(conn, listenPort(*listen), media.New(p.Files(), conn), proxy) - resizedHandler = site.NewHostRules(conn, listenPort(*listen), media.NewResized(p.Files(), conn), proxy) + conn, err := db.Open(context.Background(), *database) + if err != nil { + return err } + defer conn.Close() + + notFound := http.NotFoundHandler() + mediaHandler := site.NewHostRules(conn, listenPort(*listen), media.New(p.Files(), conn), notFound) + resizedHandler := site.NewHostRules(conn, listenPort(*listen), media.NewResized(p.Files(), conn), notFound) soft, err := parseSize(*uploadLimit) if err != nil { @@ -213,55 +201,46 @@ func serve(args []string) error { return fmt.Errorf("parse -storage-limit: %w", err) } - var articles, codeHandler, htmlHandler, themeHandler http.Handler = proxy, proxy, proxy, proxy - var moduleAPI, preview, profile, articleAPI http.Handler = proxy, proxy, proxy, proxy - var profileForm, fileAPI, reactivePages, notifyAPI, favesAPI, ownRowsAPI http.Handler = proxy, proxy, proxy, proxy, proxy, proxy - var allArticles http.Handler = proxy - var subscribeAPI, messageAPI, userAPI, adminAPI http.Handler = proxy, proxy, proxy, proxy - var login, logout, signup, accept, reset, tickets http.Handler = proxy, proxy, proxy, proxy, proxy, proxy - var emailLinks, settings, adminPages http.Handler = proxy, proxy, proxy - if conn != nil { - stack, err := newPageStack(conn, p, assets, proxy, trust, limits{soft: soft, hard: hard}, - *sidecar, *secret, *timezone, log) - if err != nil { - return err - } - defer stack.close() - served := func(h http.Handler) http.Handler { - return compress.New(respheader.VaryCookie(site.NewHostRules(conn, listenPort(*listen), h, proxy))) - } - articles = served(stack.articles) - codeHandler = served(stack.code) - htmlHandler = served(stack.html) - themeHandler = served(stack.theme) - moduleAPI = served(stack.moduleAPI) - preview = served(stack.preview) - profile = served(stack.profile) - profileForm = served(stack.profileForm) - reactivePages = served(stack.reactivePages) - notifyAPI = served(stack.notifyAPI) - subscribeAPI = served(stack.subscribeAPI) - messageAPI = served(stack.messageAPI) - userAPI = served(stack.userAPI) - adminAPI = served(stack.adminAPI) - login = served(stack.login) - logout = served(stack.logout) - signup = served(stack.signup) - accept = served(stack.accept) - reset = served(stack.reset) - tickets = served(stack.tickets) - emailLinks = served(stack.emailLinks) - settings = served(stack.settings) - adminPages = served(stack.adminPages) - favesAPI = served(stack.favesAPI) - ownRowsAPI = served(stack.ownRowsAPI) - articleAPI = served(stack.articleAPI) - allArticles = served(stack.allArticles) - fileAPI = served(stack.fileAPI) + stack, err := newPageStack(conn, p, assets, notFound, trust, limits{soft: soft, hard: hard}, + *sidecar, *secret, *timezone, log) + if err != nil { + return err } + defer stack.close() + served := func(h http.Handler) http.Handler { + return compress.New(respheader.VaryCookie(site.NewHostRules(conn, listenPort(*listen), h, notFound))) + } + articles := served(stack.articles) + codeHandler := served(stack.code) + htmlHandler := served(stack.html) + themeHandler := served(stack.theme) + moduleAPI := served(stack.moduleAPI) + preview := served(stack.preview) + profile := served(stack.profile) + profileForm := served(stack.profileForm) + reactivePages := served(stack.reactivePages) + notifyAPI := served(stack.notifyAPI) + subscribeAPI := served(stack.subscribeAPI) + messageAPI := served(stack.messageAPI) + userAPI := served(stack.userAPI) + adminAPI := served(stack.adminAPI) + login := served(stack.login) + logout := served(stack.logout) + signup := served(stack.signup) + accept := served(stack.accept) + reset := served(stack.reset) + tickets := served(stack.tickets) + emailLinks := served(stack.emailLinks) + settings := served(stack.settings) + adminPages := served(stack.adminPages) + favesAPI := served(stack.favesAPI) + ownRowsAPI := served(stack.ownRowsAPI) + articleAPI := served(stack.articleAPI) + allArticles := served(stack.allArticles) + fileAPI := served(stack.fileAPI) goHandlers := map[string]http.Handler{ - static.Prefix: static.New(assets, proxy), + static.Prefix: static.New(assets, notFound), site.ThemePrefix: respheader.VaryCookie(site.NewThemeFiles(p.Files())), media.Prefix: respheader.VaryCookie(mediaHandler), media.ResizedPrefix: respheader.VaryCookie(resizedHandler), @@ -308,13 +287,13 @@ func serve(args []string) error { "/": articles, } - mux, err := routing.New(routing.Table, proxy, goHandlers) + mux, err := routing.New(routing.Table, notFound, goHandlers) if err != nil { return err } - log.Info("pwikit serve", "listen", *listen, "upstream", proxy.Target(), "root", p.Root(), - "root_source", string(p.Source()), "static_dir", *staticDir, "database", *database != "") + log.Info("pwikit serve", "listen", *listen, "root", p.Root(), + "root_source", string(p.Source()), "static_dir", *staticDir) var hosts entry.Hosts if conn != nil { From 54e303ff78571c7b8b7a3d5c4fdd9360bfcb3e05 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:36:55 +0900 Subject: [PATCH 336/428] delete the forward proxy --- internal/forward/forward.go | 105 ----------- internal/forward/forward_test.go | 314 ------------------------------- 2 files changed, 419 deletions(-) delete mode 100644 internal/forward/forward.go delete mode 100644 internal/forward/forward_test.go diff --git a/internal/forward/forward.go b/internal/forward/forward.go deleted file mode 100644 index e20e8ee3..00000000 --- a/internal/forward/forward.go +++ /dev/null @@ -1,105 +0,0 @@ -package forward - -import ( - "context" - "errors" - "fmt" - "log/slog" - "net/http" - "net/http/httputil" - "net/url" - - "github.com/WikitTeam/ProjectWikit/internal/proxyheader" -) - -const ( - headerFor = "X-Forwarded-For" - headerHost = "X-Forwarded-Host" - headerProto = "X-Forwarded-Proto" - headerOrigin = "Origin" -) - -type Proxy struct { - target *url.URL - trust *proxyheader.Trust - rp *httputil.ReverseProxy - log *slog.Logger - - BareOrigin bool -} - -var _ http.Handler = (*Proxy)(nil) - -func New(target string, trust *proxyheader.Trust, log *slog.Logger) (*Proxy, error) { - u, err := url.Parse(target) - if err != nil { - return nil, fmt.Errorf("parse upstream %q: %w", target, err) - } - if u.Scheme != "http" && u.Scheme != "https" { - return nil, fmt.Errorf("upstream %q scheme = %q, want http or https", target, u.Scheme) - } - if u.Host == "" { - return nil, fmt.Errorf("upstream %q has no host", target) - } - if trust == nil { - trust, err = proxyheader.NewTrust(nil) - if err != nil { - return nil, err - } - } - if log == nil { - log = slog.Default() - } - - p := &Proxy{target: u, trust: trust, log: log} - p.rp = &httputil.ReverseProxy{Rewrite: p.rewrite, ErrorHandler: p.handleError} - return p, nil -} - -func (p *Proxy) Target() string { return p.target.String() } - -func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request) { - p.rp.ServeHTTP(w, r) -} - -func (p *Proxy) rewrite(pr *httputil.ProxyRequest) { - client, ok := p.trust.ClientIP(pr.In) - scheme := p.trust.Scheme(pr.In) - - pr.Out.Header.Del(headerFor) - pr.Out.Header.Del(headerHost) - pr.Out.Header.Del(headerProto) - if ok { - pr.Out.Header.Set(headerFor, client.String()) - } - pr.Out.Header.Set(headerHost, pr.In.Host) - pr.Out.Header.Set(headerProto, scheme) - - if p.BareOrigin { - if origin := bareOrigin(pr.In.Header.Get(headerOrigin)); origin != "" { - pr.Out.Header.Set(headerOrigin, origin) - } - } - - pr.SetURL(p.target) - pr.Out.Host = pr.In.Host -} - -func bareOrigin(origin string) string { - u, err := url.Parse(origin) - if err != nil || u.Scheme == "" || u.Hostname() == "" { - return "" - } - return u.Scheme + "://" + u.Hostname() -} - -func (p *Proxy) handleError(w http.ResponseWriter, r *http.Request, err error) { - if errors.Is(err, context.Canceled) { - return - } - p.log.Error("forward failed", "path", r.URL.Path, "upstream", p.target.String(), "err", err) - // The visitor gets the bare status phrase: the upstream address is - // internal, and prose here would have to go through i18n in a package - // that ships no user-facing text of its own. - http.Error(w, http.StatusText(http.StatusBadGateway), http.StatusBadGateway) -} diff --git a/internal/forward/forward_test.go b/internal/forward/forward_test.go deleted file mode 100644 index 90ce4610..00000000 --- a/internal/forward/forward_test.go +++ /dev/null @@ -1,314 +0,0 @@ -package forward - -import ( - "io" - "log/slog" - "net/http" - "net/http/httptest" - "strings" - "testing" - - "github.com/WikitTeam/ProjectWikit/internal/proxyheader" -) - -func quietLog() *slog.Logger { - return slog.New(slog.NewTextHandler(io.Discard, nil)) -} - -func newProxy(t *testing.T, upstream *httptest.Server) *Proxy { - t.Helper() - p, err := New(upstream.URL, nil, quietLog()) - if err != nil { - t.Fatalf("New(%q) err = %v, want nil", upstream.URL, err) - } - return p -} - -func TestNewRejectsBadTarget(t *testing.T) { - tests := []struct { - name string - target string - }{ - {"empty string", ""}, - {"missing scheme", "127.0.0.1:8000"}, - {"scheme is not http", "ftp://127.0.0.1:8000"}, - {"missing host", "http://"}, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - if _, err := New(tt.target, nil, quietLog()); err == nil { - t.Errorf("New(%q) err = nil, want non-nil", tt.target) - } - }) - } -} - -func TestProxyPreservesHost(t *testing.T) { - var got string - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - got = r.Host - })) - defer up.Close() - - front := httptest.NewServer(newProxy(t, up)) - defer front.Close() - - req, _ := http.NewRequest(http.MethodGet, front.URL+"/scp-173", nil) - req.Host = "scpfoundation.example" - resp, err := front.Client().Do(req) - if err != nil { - t.Fatalf("Do() err = %v, want nil", err) - } - resp.Body.Close() - - if got != "scpfoundation.example" { - t.Errorf("upstream got Host = %q, want %q", got, "scpfoundation.example") - } -} - -func TestProxyDropsClientForwardedHeaders(t *testing.T) { - var xff, proto string - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - xff = r.Header.Get("X-Forwarded-For") - proto = r.Header.Get("X-Forwarded-Proto") - })) - defer up.Close() - - front := httptest.NewServer(newProxy(t, up)) - defer front.Close() - - req, _ := http.NewRequest(http.MethodGet, front.URL+"/", nil) - req.Header.Set("X-Forwarded-For", "1.2.3.4") - req.Header.Set("X-Forwarded-Proto", "https") - resp, err := front.Client().Do(req) - if err != nil { - t.Fatalf("Do() err = %v, want nil", err) - } - resp.Body.Close() - - if strings.Contains(xff, "1.2.3.4") { - t.Errorf("upstream got X-Forwarded-For = %q, want no client-supplied 1.2.3.4", xff) - } - if proto != "http" { - t.Errorf("upstream got X-Forwarded-Proto = %q, want %q", proto, "http") - } -} - -func TestProxyPassesRequestURIThrough(t *testing.T) { - var got string - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - got = r.RequestURI - })) - defer up.Close() - - front := httptest.NewServer(newProxy(t, up)) - defer front.Close() - - resp, err := front.Client().Get(front.URL + "/local--files/a%2Fb.png?size=200") - if err != nil { - t.Fatalf("Get() err = %v, want nil", err) - } - resp.Body.Close() - - if got != "/local--files/a%2Fb.png?size=200" { - t.Errorf("upstream got RequestURI = %q, want %q", got, "/local--files/a%2Fb.png?size=200") - } -} - -func TestProxyPassesStatusAndBody(t *testing.T) { - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("X-Wikit", "1") - w.WriteHeader(http.StatusTeapot) - io.WriteString(w, "内容") - })) - defer up.Close() - - front := httptest.NewServer(newProxy(t, up)) - defer front.Close() - - resp, err := front.Client().Get(front.URL + "/") - if err != nil { - t.Fatalf("Get() err = %v, want nil", err) - } - defer resp.Body.Close() - body, _ := io.ReadAll(resp.Body) - - if resp.StatusCode != http.StatusTeapot { - t.Errorf("StatusCode = %d, want %d", resp.StatusCode, http.StatusTeapot) - } - if resp.Header.Get("X-Wikit") != "1" { - t.Errorf("X-Wikit = %q, want %q", resp.Header.Get("X-Wikit"), "1") - } - if string(body) != "内容" { - t.Errorf("body = %q, want %q", body, "内容") - } -} - -func TestProxyReturns502WhenUpstreamDown(t *testing.T) { - up := httptest.NewServer(http.HandlerFunc(func(http.ResponseWriter, *http.Request) {})) - dead := newProxy(t, up) - upstream := up.URL - up.Close() - - front := httptest.NewServer(dead) - defer front.Close() - - resp, err := front.Client().Get(front.URL + "/") - if err != nil { - t.Fatalf("Get() err = %v, want nil", err) - } - defer resp.Body.Close() - - if resp.StatusCode != http.StatusBadGateway { - t.Errorf("StatusCode = %d, want %d", resp.StatusCode, http.StatusBadGateway) - } - body, err := io.ReadAll(resp.Body) - if err != nil { - t.Fatalf("ReadAll() err = %v, want nil", err) - } - if strings.Contains(string(body), upstream) { - t.Errorf("body = %q, want it to omit %q", body, upstream) - } -} - -func TestProxyHonorsForwardedForFromTrustedPeer(t *testing.T) { - var xff string - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - xff = r.Header.Get("X-Forwarded-For") - })) - defer up.Close() - - trust, err := proxyheader.NewTrust([]string{"127.0.0.0/8", "::1/128"}) - if err != nil { - t.Fatalf("NewTrust() err = %v, want nil", err) - } - p, err := New(up.URL, trust, quietLog()) - if err != nil { - t.Fatalf("New() err = %v, want nil", err) - } - - front := httptest.NewServer(p) - defer front.Close() - - req, _ := http.NewRequest(http.MethodGet, front.URL+"/", nil) - req.Header.Set("X-Forwarded-For", "1.2.3.4") - resp, err := front.Client().Do(req) - if err != nil { - t.Fatalf("Do() err = %v, want nil", err) - } - resp.Body.Close() - - if xff != "1.2.3.4" { - t.Errorf("upstream got X-Forwarded-For = %q, want %q", xff, "1.2.3.4") - } -} - -func TestProxySetsForwardedHostToInboundHost(t *testing.T) { - var got string - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - got = r.Header.Get("X-Forwarded-Host") - })) - defer up.Close() - - front := httptest.NewServer(newProxy(t, up)) - defer front.Close() - - req, _ := http.NewRequest(http.MethodGet, front.URL+"/", nil) - req.Host = "media.example" - resp, err := front.Client().Do(req) - if err != nil { - t.Fatalf("Do() err = %v, want nil", err) - } - resp.Body.Close() - - if got != "media.example" { - t.Errorf("upstream got X-Forwarded-Host = %q, want %q", got, "media.example") - } -} - -func TestProxyKeepsOriginByDefault(t *testing.T) { - var got string - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - got = r.Header.Get("Origin") - })) - defer up.Close() - - front := httptest.NewServer(newProxy(t, up)) - defer front.Close() - - req, _ := http.NewRequest(http.MethodPost, front.URL+"/pw-api/modules", nil) - req.Header.Set("Origin", "http://localhost:8080") - resp, err := front.Client().Do(req) - if err != nil { - t.Fatalf("Do() err = %v, want nil", err) - } - resp.Body.Close() - - if got != "http://localhost:8080" { - t.Errorf("upstream got Origin = %q, want %q", got, "http://localhost:8080") - } -} - -func TestProxyDropsOriginPortWhenAsked(t *testing.T) { - var got string - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - got = r.Header.Get("Origin") - })) - defer up.Close() - - proxy := newProxy(t, up) - proxy.BareOrigin = true - front := httptest.NewServer(proxy) - defer front.Close() - - req, _ := http.NewRequest(http.MethodPost, front.URL+"/pw-api/modules", nil) - req.Header.Set("Origin", "http://localhost:8080") - resp, err := front.Client().Do(req) - if err != nil { - t.Fatalf("Do() err = %v, want nil", err) - } - resp.Body.Close() - - if got != "http://localhost" { - t.Errorf("upstream got Origin = %q, want %q", got, "http://localhost") - } -} - -func TestProxyLeavesAMissingOriginAlone(t *testing.T) { - sent := true - up := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - _, sent = r.Header["Origin"] - })) - defer up.Close() - - proxy := newProxy(t, up) - proxy.BareOrigin = true - front := httptest.NewServer(proxy) - defer front.Close() - - resp, err := front.Client().Post(front.URL+"/pw-api/modules", "application/json", nil) - if err != nil { - t.Fatalf("Post() err = %v, want nil", err) - } - resp.Body.Close() - - if sent { - t.Error("upstream got an Origin header, want none") - } -} - -func TestBareOrigin(t *testing.T) { - cases := []struct{ in, want string }{ - {"http://localhost:8080", "http://localhost"}, - {"http://localhost", "http://localhost"}, - {"https://wiki.example:8443", "https://wiki.example"}, - {"null", ""}, - {"", ""}, - {"://broken", ""}, - } - for _, c := range cases { - if got := bareOrigin(c.in); got != c.want { - t.Errorf("bareOrigin(%q) = %q, want %q", c.in, got, c.want) - } - } -} From 2d8075c2bf1072f56c549c64bb5c8cf78ce915b3 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:40:46 +0900 Subject: [PATCH 337/428] drop the route ownership table --- cmd/pwikit/main.go | 21 +--- internal/routing/routing.go | 175 +++++--------------------- internal/routing/routing_test.go | 203 +++++++++++++------------------ internal/site/site_test.go | 14 --- 4 files changed, 118 insertions(+), 295 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 28e7cc9c..0b231758 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -78,8 +78,6 @@ func run(args []string) error { return serve(args[1:]) case "modules": return printModules() - case "routes": - return printRoutes() case "render": return render(args[1:]) case "migrate": @@ -104,7 +102,6 @@ Commands: serve start the HTTP server createsite create the site this database serves seed write the pages a new site starts with - routes print the static route table render render wikitext read from stdin or a file migrate apply or inspect the schema migrations modules print the wikidot module list @@ -239,7 +236,11 @@ func serve(args []string) error { allArticles := served(stack.allArticles) fileAPI := served(stack.fileAPI) + // A system path nobody claims is a mistyped URL, not a page name, so these + // two answer before the article handler sees them. goHandlers := map[string]http.Handler{ + "/-/": notFound, + "/pw-api/": notFound, static.Prefix: static.New(assets, notFound), site.ThemePrefix: respheader.VaryCookie(site.NewThemeFiles(p.Files())), media.Prefix: respheader.VaryCookie(mediaHandler), @@ -287,7 +288,7 @@ func serve(args []string) error { "/": articles, } - mux, err := routing.New(routing.Table, notFound, goHandlers) + mux, err := routing.New(goHandlers) if err != nil { return err } @@ -539,18 +540,6 @@ func migrateUp(dsn string) error { return nil } -func printRoutes() error { - if err := routing.Validate(routing.Table); err != nil { - return err - } - w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0) - fmt.Fprintln(w, "ROUTE\tOWNER\tLABEL") - for _, r := range routing.Table { - fmt.Fprintf(w, "%s\t%s\t%s\n", r.Prefix, r.Owner, r.Label) - } - return w.Flush() -} - func printModules() error { w := tabwriter.NewWriter(os.Stdout, 0, 0, 2, ' ', 0) fmt.Fprintln(w, "MODULE\tBODY\tSTATUS") diff --git a/internal/routing/routing.go b/internal/routing/routing.go index 2980fb8c..ea23e199 100644 --- a/internal/routing/routing.go +++ b/internal/routing/routing.go @@ -1,175 +1,60 @@ +// Package routing sends a request to the handler that claims the longest +// matching prefix. package routing import ( "fmt" + "maps" "net/http" "slices" "strings" ) -type Owner string - -const ( - OwnerGo Owner = "go" - OwnerUpstream Owner = "upstream" -) - -type Route struct { - Prefix string - Owner Owner - Label string - - Exact bool -} - -func (r Route) matches(path string) bool { - if r.Exact { - return path == r.Prefix - } - return strings.HasPrefix(path, r.Prefix) -} - const root = "/" -var Table = []Route{ - {Prefix: "/", Owner: OwnerGo, Label: "articles"}, - {Prefix: "/-/", Owner: OwnerUpstream, Label: "system pages"}, - {Prefix: "/-/static/", Owner: OwnerGo, Label: "static assets"}, - {Prefix: "/-/theme/", Owner: OwnerGo, Label: "site theme"}, - {Prefix: "/-/users/", Owner: OwnerGo, Label: "user profiles"}, - {Prefix: "/-/login", Owner: OwnerGo, Label: "sign in", Exact: true}, - {Prefix: "/-/logout", Owner: OwnerGo, Label: "sign out", Exact: true}, - {Prefix: "/-/signup", Owner: OwnerGo, Label: "sign up", Exact: true}, - {Prefix: "/-/signup/", Owner: OwnerGo, Label: "sign up"}, - {Prefix: "/-/accept/", Owner: OwnerGo, Label: "invitation"}, - {Prefix: "/-/admin", Owner: OwnerGo, Label: "site administration", Exact: true}, - {Prefix: "/-/admin/", Owner: OwnerGo, Label: "site administration"}, - {Prefix: "/-/password_reset", Owner: OwnerGo, Label: "password reset", Exact: true}, - {Prefix: "/-/password_reset/", Owner: OwnerGo, Label: "password reset"}, - {Prefix: "/-/reset/", Owner: OwnerGo, Label: "password reset"}, - {Prefix: "/-/email/", Owner: OwnerGo, Label: "email links"}, - {Prefix: "/-/profile/", Owner: OwnerGo, Label: "account settings"}, - {Prefix: "/-/tickets/submit", Owner: OwnerGo, Label: "ticket form", Exact: true}, - {Prefix: "/-/membership/password", Owner: OwnerGo, Label: "membership form", Exact: true}, - {Prefix: "/-/profile/edit", Owner: OwnerGo, Label: "profile form", Exact: true}, - {Prefix: "/-/favourites", Owner: OwnerGo, Label: "saved pages", Exact: true}, - {Prefix: "/-/ratings", Owner: OwnerGo, Label: "own ratings", Exact: true}, - {Prefix: "/-/liked-posts", Owner: OwnerGo, Label: "own likes", Exact: true}, - {Prefix: "/-/notifications", Owner: OwnerGo, Label: "notification page", Exact: true}, - {Prefix: "/-/notifications/", Owner: OwnerGo, Label: "notification page"}, - {Prefix: "/-/messages", Owner: OwnerGo, Label: "message page", Exact: true}, - {Prefix: "/-/messages/", Owner: OwnerGo, Label: "message page"}, - {Prefix: "/pw-api/", Owner: OwnerUpstream, Label: "API"}, - {Prefix: "/pw-api/modules", Owner: OwnerGo, Label: "module API", Exact: true}, - {Prefix: "/pw-api/preview", Owner: OwnerGo, Label: "editor preview", Exact: true}, - {Prefix: "/pw-api/articles", Owner: OwnerGo, Label: "article listing", Exact: true}, - {Prefix: "/pw-api/articles/", Owner: OwnerGo, Label: "article API"}, - {Prefix: "/pw-api/files/", Owner: OwnerGo, Label: "file API"}, - {Prefix: "/pw-api/notifications", Owner: OwnerGo, Label: "notification API", Exact: true}, - {Prefix: "/pw-api/notifications/subscribe", Owner: OwnerGo, Label: "subscription API", Exact: true}, - {Prefix: "/pw-api/messages/", Owner: OwnerGo, Label: "message API"}, - {Prefix: "/pw-api/users", Owner: OwnerGo, Label: "user API", Exact: true}, - {Prefix: "/pw-api/users/", Owner: OwnerGo, Label: "user API"}, - {Prefix: "/pw-api/admin/", Owner: OwnerGo, Label: "admin API"}, - {Prefix: "/pw-api/favourites", Owner: OwnerGo, Label: "saved page API", Exact: true}, - {Prefix: "/pw-api/ratings", Owner: OwnerGo, Label: "own rating API", Exact: true}, - {Prefix: "/pw-api/liked-posts", Owner: OwnerGo, Label: "own like API", Exact: true}, - {Prefix: "/local--files/", Owner: OwnerGo, Label: "site files"}, - {Prefix: "/local--resized-images/", Owner: OwnerGo, Label: "scaled images"}, - {Prefix: "/local--code/", Owner: OwnerGo, Label: "code blocks"}, - {Prefix: "/local--html/", Owner: OwnerGo, Label: "embedded HTML"}, - {Prefix: "/local--theme/", Owner: OwnerGo, Label: "page theme"}, -} - -func Validate(table []Route) error { - seen := make(map[string]bool, len(table)) - hasRoot := false - for _, r := range table { - if !strings.HasPrefix(r.Prefix, "/") { - return fmt.Errorf("route prefix %q does not start with /", r.Prefix) - } - if r.Exact && strings.HasSuffix(r.Prefix, "/") { - return fmt.Errorf("exact route %q ends with /", r.Prefix) - } - if !r.Exact && !strings.HasSuffix(r.Prefix, "/") { - return fmt.Errorf("route prefix %q does not end with /", r.Prefix) - } - if seen[r.Prefix] { - return fmt.Errorf("duplicate route prefix %q", r.Prefix) - } - seen[r.Prefix] = true - if r.Owner != OwnerGo && r.Owner != OwnerUpstream { - return fmt.Errorf("route %q owner = %q, want go or upstream", r.Prefix, r.Owner) - } - if r.Prefix == root { - if r.Exact { - return fmt.Errorf("route %q is exact, which leaves the table without a fallback", r.Prefix) - } - hasRoot = true - } - } - if !hasRoot { - return fmt.Errorf("route table has no fallback prefix %q", root) - } - return nil -} - type Mux struct { - routes []Route - fallback Route + prefixes []string handlers map[string]http.Handler } var _ http.Handler = (*Mux)(nil) -func New(table []Route, upstream http.Handler, goHandlers map[string]http.Handler) (*Mux, error) { - if err := Validate(table); err != nil { - return nil, err - } - if upstream == nil { - return nil, fmt.Errorf("upstream handler is nil") +// A key ending in a slash claims everything below it, one without claims that +// path alone. +func New(handlers map[string]http.Handler) (*Mux, error) { + if handlers[root] == nil { + return nil, fmt.Errorf("no handler for %q, which every unclaimed path falls to", root) } - - handlers := make(map[string]http.Handler, len(table)) - var fallback Route - for _, r := range table { - switch r.Owner { - case OwnerUpstream: - if _, ok := goHandlers[r.Prefix]; ok { - return nil, fmt.Errorf("route %q is owned by upstream but a Go handler is registered", r.Prefix) - } - handlers[r.Prefix] = upstream - case OwnerGo: - h, ok := goHandlers[r.Prefix] - if !ok { - return nil, fmt.Errorf("route %q is owned by go but no handler is registered", r.Prefix) - } - handlers[r.Prefix] = h + prefixes := make([]string, 0, len(handlers)) + for prefix, h := range handlers { + if !strings.HasPrefix(prefix, root) { + return nil, fmt.Errorf("route prefix %q does not start with %q", prefix, root) } - if r.Prefix == root { - fallback = r - } - } - for prefix := range goHandlers { - if _, ok := handlers[prefix]; !ok { - return nil, fmt.Errorf("prefix %q has a Go handler but is not in the route table", prefix) + if h == nil { + return nil, fmt.Errorf("route prefix %q has no handler", prefix) } + prefixes = append(prefixes, prefix) } + slices.SortFunc(prefixes, func(a, b string) int { return len(b) - len(a) }) - routes := slices.Clone(table) - slices.SortFunc(routes, func(a, b Route) int { return len(b.Prefix) - len(a.Prefix) }) - return &Mux{routes: routes, fallback: fallback, handlers: handlers}, nil + return &Mux{prefixes: prefixes, handlers: maps.Clone(handlers)}, nil } -func (m *Mux) Route(path string) Route { - for _, r := range m.routes { - if r.matches(path) { - return r +func (m *Mux) Route(path string) string { + for _, prefix := range m.prefixes { + if strings.HasSuffix(prefix, root) { + if strings.HasPrefix(path, prefix) { + return prefix + } + continue + } + if path == prefix { + return prefix } } - return m.fallback + return root } func (m *Mux) ServeHTTP(w http.ResponseWriter, r *http.Request) { - m.handlers[m.Route(r.URL.Path).Prefix].ServeHTTP(w, r) + m.handlers[m.Route(r.URL.Path)].ServeHTTP(w, r) } diff --git a/internal/routing/routing_test.go b/internal/routing/routing_test.go index b4e2ab5b..d0e36f7d 100644 --- a/internal/routing/routing_test.go +++ b/internal/routing/routing_test.go @@ -12,161 +12,124 @@ func stub(body string) http.Handler { }) } -func TestValidateAcceptsTable(t *testing.T) { - if err := Validate(Table); err != nil { - t.Errorf("Validate(Table) err = %v, want nil", err) +func table() map[string]http.Handler { + prefixes := []string{ + "/", "/-/", "/-/admin", "/-/admin/", "/-/login", "/-/signup/", "/-/static/", + "/pw-api/", "/pw-api/modules", "/pw-api/articles/", "/pw-api/notifications", + "/local--files/", "/local--theme/", } -} - -func TestValidateRejectsBadTable(t *testing.T) { - tests := []struct { - name string - table []Route - }{ - {"prefix does not start with slash", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "api/", Owner: OwnerUpstream}}}, - {"prefix does not end with slash", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/api", Owner: OwnerUpstream}}}, - {"duplicate prefix", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/pw-api/", Owner: OwnerUpstream}, {Prefix: "/pw-api/", Owner: OwnerGo}}}, - {"invalid owner", []Route{{Prefix: "/", Owner: "rust"}}}, - {"missing fallback prefix", []Route{{Prefix: "/pw-api/", Owner: OwnerUpstream}}}, - {"exact route ends with slash", []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/pw-api/", Owner: OwnerUpstream, Exact: true}}}, - {"exact fallback", []Route{{Prefix: "/", Owner: OwnerUpstream, Exact: true}}}, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - if err := Validate(tt.table); err == nil { - t.Error("Validate() err = nil, want non-nil") - } - }) - } -} - -// goHandlers supplies a stub for every route the table gives to Go, so this -// file does not have to be edited each time one changes hands. -func goHandlers() map[string]http.Handler { - out := make(map[string]http.Handler) - for _, r := range Table { - if r.Owner == OwnerGo { - out[r.Prefix] = stub("go " + r.Prefix) - } + out := make(map[string]http.Handler, len(prefixes)) + for _, prefix := range prefixes { + out[prefix] = stub(prefix) } return out } -func TestMuxRouteLongestPrefixWins(t *testing.T) { - m, err := New(Table, stub("upstream"), goHandlers()) +func TestRouteLongestPrefixWins(t *testing.T) { + m, err := New(table()) if err != nil { t.Fatalf("New() err = %v, want nil", err) } - - tests := []struct { - path string - want string - }{ - {"/", "/"}, - {"/scp-173", "/"}, - {"/forum:start", "/"}, - {"/-/admin", "/-/admin"}, - {"/-/admin/", "/-/admin/"}, - {"/-/admin/web/user/", "/-/admin/"}, - {"/-/preferences/", "/-/"}, - {"/-/login", "/-/login"}, - {"/-/signup/check-wikidot", "/-/signup/"}, - {"/-/static/app.js", "/-/static/"}, - {"/pw-api/articles/scp-173/votes", "/pw-api/articles/"}, - {"/pw-api/notifications", "/pw-api/notifications"}, - {"/pw-api/notify", "/pw-api/"}, - {"/local--files/a/b.png", "/local--files/"}, - {"/local--theme/12/style.css", "/local--theme/"}, - {"/-", "/"}, - {"/pw-apidocs", "/"}, - } - for _, tt := range tests { - t.Run(tt.path, func(t *testing.T) { - if got := m.Route(tt.path).Prefix; got != tt.want { - t.Errorf("Route(%q).Prefix = %q, want %q", tt.path, got, tt.want) + tests := map[string]string{ + "/": "/", + "/scp-173": "/", + "/forum:start": "/", + "/-": "/", + "/pw-apidocs": "/", + "/-/admin": "/-/admin", + "/-/admin/": "/-/admin/", + "/-/admin/users/7": "/-/admin/", + "/-/preferences/": "/-/", + "/-/login": "/-/login", + "/-/signup/check-wikidot": "/-/signup/", + "/-/static/app.js": "/-/static/", + "/pw-api/articles/scp-173/votes": "/pw-api/articles/", + "/pw-api/notifications": "/pw-api/notifications", + "/pw-api/notify": "/pw-api/", + "/local--files/a/b.png": "/local--files/", + "/local--theme/12/style.css": "/local--theme/", + } + for path, want := range tests { + t.Run(path, func(t *testing.T) { + if got := m.Route(path); got != want { + t.Errorf("Route(%q) = %q, want %q", path, got, want) } }) } } -func TestMuxRouteExactMatchesOnlyTheWholePath(t *testing.T) { - m, err := New(Table, stub("upstream"), goHandlers()) +func TestRouteExactMatchesOnlyTheWholePath(t *testing.T) { + m, err := New(table()) if err != nil { t.Fatalf("New() err = %v, want nil", err) } - - tests := []struct { - path string - want string - }{ - {"/pw-api/modules", "/pw-api/modules"}, - {"/pw-api/modules/", "/pw-api/"}, - {"/pw-api/modules/1", "/pw-api/"}, - {"/pw-api/module", "/pw-api/"}, + tests := map[string]string{ + "/pw-api/modules": "/pw-api/modules", + "/pw-api/modules/": "/pw-api/", + "/pw-api/modules/1": "/pw-api/", + "/pw-api/module": "/pw-api/", } - for _, tt := range tests { - t.Run(tt.path, func(t *testing.T) { - if got := m.Route(tt.path).Prefix; got != tt.want { - t.Errorf("Route(%q).Prefix = %q, want %q", tt.path, got, tt.want) + for path, want := range tests { + t.Run(path, func(t *testing.T) { + if got := m.Route(path); got != want { + t.Errorf("Route(%q) = %q, want %q", path, got, want) } }) } } -func TestNewRejectsNilUpstream(t *testing.T) { - if _, err := New(Table, nil, nil); err == nil { - t.Error("New(upstream=nil) err = nil, want non-nil") - } -} - -func TestNewRejectsGoRouteWithoutHandler(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/pw-api/", Owner: OwnerGo}} - if _, err := New(table, stub("upstream"), nil); err == nil { - t.Error("New() err = nil, want non-nil") +func TestNewRejectsBadHandlers(t *testing.T) { + tests := map[string]map[string]http.Handler{ + "no fallback": {"/pw-api/": stub("api")}, + "prefix without a slash": {"/": stub("root"), "pw-api/": stub("api")}, + "nil handler": {"/": stub("root"), "/pw-api/": nil}, + "nil fallback": {"/": nil}, + "empty": {}, + } + for name, handlers := range tests { + t.Run(name, func(t *testing.T) { + if _, err := New(handlers); err == nil { + t.Error("New() err = nil, want an error") + } + }) } } -func TestNewRejectsUpstreamRouteWithHandler(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerUpstream}, {Prefix: "/pw-api/", Owner: OwnerUpstream}} - handlers := map[string]http.Handler{"/pw-api/": stub("go")} - if _, err := New(table, stub("upstream"), handlers); err == nil { - t.Error("New() err = nil, want non-nil") +func TestNewCopiesTheHandlers(t *testing.T) { + handlers := map[string]http.Handler{"/": stub("root")} + m, err := New(handlers) + if err != nil { + t.Fatalf("New() err = %v, want nil", err) } -} + handlers["/"] = stub("replaced") -func TestNewRejectsHandlerOutsideTable(t *testing.T) { - table := []Route{{Prefix: "/", Owner: OwnerUpstream}} - handlers := map[string]http.Handler{"/forum/": stub("go")} - if _, err := New(table, stub("upstream"), handlers); err == nil { - t.Error("New() err = nil, want non-nil") + rec := httptest.NewRecorder() + m.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/scp-173", nil)) + if got := rec.Body.String(); got != "root" { + t.Errorf("ServeHTTP(/scp-173) = %q, want %q", got, "root") } } -func TestMuxServeHTTPDispatches(t *testing.T) { - table := []Route{ - {Prefix: "/", Owner: OwnerUpstream}, - {Prefix: "/pw-api/", Owner: OwnerUpstream}, - {Prefix: "/pw-api/modules", Owner: OwnerGo, Exact: true}, - } - m, err := New(table, stub("upstream"), map[string]http.Handler{"/pw-api/modules": stub("go")}) +func TestServeHTTPDispatches(t *testing.T) { + m, err := New(map[string]http.Handler{ + "/": stub("articles"), + "/pw-api/": stub("not found"), + "/pw-api/modules": stub("modules"), + }) if err != nil { t.Fatalf("New() err = %v, want nil", err) } - - tests := []struct { - path string - want string - }{ - {"/pw-api/modules", "go"}, - {"/pw-api/articles", "upstream"}, - {"/scp-173", "upstream"}, + tests := map[string]string{ + "/pw-api/modules": "modules", + "/pw-api/articles": "not found", + "/scp-173": "articles", } - for _, tt := range tests { - t.Run(tt.path, func(t *testing.T) { + for path, want := range tests { + t.Run(path, func(t *testing.T) { rec := httptest.NewRecorder() - m.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, tt.path, nil)) - if got := rec.Body.String(); got != tt.want { - t.Errorf("ServeHTTP(%q) = %q, want %q", tt.path, got, tt.want) + m.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, path, nil)) + if got := rec.Body.String(); got != want { + t.Errorf("ServeHTTP(%q) = %q, want %q", path, got, want) } }) } diff --git a/internal/site/site_test.go b/internal/site/site_test.go index 4dc655e9..a9344e54 100644 --- a/internal/site/site_test.go +++ b/internal/site/site_test.go @@ -4,8 +4,6 @@ import ( "net/url" "strings" "testing" - - "github.com/WikitTeam/ProjectWikit/internal/routing" ) var split = Site{Domain: "wiki.example", MediaDomain: "media.example"} @@ -142,18 +140,6 @@ func TestDecideIgnoresPortInHost(t *testing.T) { } } -func TestMediaPrefixesAreInRouteTable(t *testing.T) { - inTable := make(map[string]bool, len(routing.Table)) - for _, r := range routing.Table { - inTable[r.Prefix] = true - } - for _, prefix := range MediaPrefixes { - if !inTable[prefix] { - t.Errorf("routing.Table has no media prefix %q", prefix) - } - } -} - func TestDecideHeaders(t *testing.T) { merged := Site{Domain: "wiki.example", MediaDomain: "wiki.example"} From 79252a40d9c83f9626c8b21faa57636f13402277 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 17:41:57 +0900 Subject: [PATCH 338/428] rename the fallthrough handler --- cmd/pwikit/articles.go | 44 ++++++++++++++++---------------- internal/admin/admin.go | 12 ++++----- internal/webapi/admin.go | 12 ++++----- internal/webapi/allarticles.go | 10 ++++---- internal/webapi/articles.go | 16 ++++++------ internal/webapi/favourites.go | 12 ++++----- internal/webapi/files.go | 8 +++--- internal/webapi/messages.go | 12 ++++----- internal/webapi/mypages.go | 10 ++++---- internal/webapi/notifications.go | 12 ++++----- internal/webapi/subscribe.go | 12 ++++----- internal/webapi/users.go | 12 ++++----- internal/webapi/webapi.go | 14 +++++----- internal/webapi/webapi_test.go | 10 ++++---- 14 files changed, 97 insertions(+), 99 deletions(-) diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go index 779d6d81..36c76dc3 100644 --- a/cmd/pwikit/articles.go +++ b/cmd/pwikit/articles.go @@ -62,7 +62,7 @@ type limits struct { hard int64 } -func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handler, trust *proxyheader.Trust, size limits, sidecar, secret, timezone string, log *slog.Logger) (*pageStack, error) { +func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, next http.Handler, trust *proxyheader.Trust, size limits, sidecar, secret, timezone string, log *slog.Logger) (*pageStack, error) { engine, closeEngine, err := newRenderer(sidecar) if err != nil { return nil, err @@ -104,30 +104,30 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl code: localitem.NewCode(items), html: localitem.NewHTML(items), theme: localitem.NewTheme(items), - moduleAPI: webapi.New(api, upstream), + moduleAPI: webapi.New(api, next), preview: webapi.NewPreview(api), - articleAPI: webapi.NewArticles(api, upstream), - allArticles: webapi.NewAllArticles(api, upstream), - fileAPI: webapi.NewFileItems(api, upstream), + articleAPI: webapi.NewArticles(api, next), + allArticles: webapi.NewAllArticles(api, next), + fileAPI: webapi.NewFileItems(api, next), profile: userpage.New(profiles), profileForm: userpage.NewEdit(profiles), reactivePages: userpage.NewReactive(profiles), - notifyAPI: webapi.NewNotifications(api, upstream), - subscribeAPI: webapi.NewSubscriptions(api, upstream), - messageAPI: webapi.NewMessages(api, upstream), - userAPI: webapi.NewUsers(api, upstream), - adminAPI: webapi.NewAdmin(api, upstream), - login: upstream, - logout: upstream, - signup: upstream, - accept: upstream, - reset: upstream, - tickets: upstream, - emailLinks: upstream, - settings: upstream, - adminPages: upstream, - favesAPI: webapi.NewFavourites(api, upstream), - ownRowsAPI: webapi.NewOwnRows(api, upstream), + notifyAPI: webapi.NewNotifications(api, next), + subscribeAPI: webapi.NewSubscriptions(api, next), + messageAPI: webapi.NewMessages(api, next), + userAPI: webapi.NewUsers(api, next), + adminAPI: webapi.NewAdmin(api, next), + login: next, + logout: next, + signup: next, + accept: next, + reset: next, + tickets: next, + emailLinks: next, + settings: next, + adminPages: next, + favesAPI: webapi.NewFavourites(api, next), + ownRowsAPI: webapi.NewOwnRows(api, next), close: closeEngine, } @@ -156,7 +156,7 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, upstream http.Handl DB: conn, Bundle: bundle, Assets: static.NewAssets(assets), Files: p.Files(), TimeZone: location, Tokens: token.Generator{Secret: secret}, Articles: stack.articleAPI, Mail: mail.New(mailConfig()), Log: log, - }, upstream) + }, next) if err != nil { return nil, err } diff --git a/internal/admin/admin.go b/internal/admin/admin.go index e42bacfd..26b8a6f1 100644 --- a/internal/admin/admin.go +++ b/internal/admin/admin.go @@ -118,18 +118,18 @@ func grantsFrom(ctx context.Context) perms.Set { type Handler struct { deps Deps - upstream http.Handler + next http.Handler templates *template.Template } var _ http.Handler = (*Handler)(nil) -func New(d Deps, upstream http.Handler) (*Handler, error) { +func New(d Deps, next http.Handler) (*Handler, error) { t, err := template.New("admin").Funcs(funcs()).ParseFS(files, "templates/*.html") if err != nil { return nil, err } - return &Handler{deps: d, upstream: upstream, templates: t}, nil + return &Handler{deps: d, next: next, templates: t}, nil } func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { @@ -139,7 +139,7 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { } rest, ok := strings.CutPrefix(r.URL.Path, Prefix) if !ok { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } ctx := r.Context() @@ -181,13 +181,13 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { continue } if !granted.Has(s.need) { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } h.finish(w, r, loc, s.serve(h, w, r, loc)) return } - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) } func siteSignIn(path string) (string, bool) { diff --git a/internal/webapi/admin.go b/internal/webapi/admin.go index b3bf073e..124abde0 100644 --- a/internal/webapi/admin.go +++ b/internal/webapi/admin.go @@ -18,20 +18,20 @@ import ( const AdminPrefix = "/pw-api/admin/" type Admin struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*Admin)(nil) -func NewAdmin(d Deps, upstream http.Handler) *Admin { - return &Admin{deps: d, upstream: upstream} +func NewAdmin(d Deps, next http.Handler) *Admin { + return &Admin{deps: d, next: next} } func (h *Admin) ServeHTTP(w http.ResponseWriter, r *http.Request) { rest, ok := strings.CutPrefix(r.URL.Path, AdminPrefix) if !ok || r.Method != http.MethodGet { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) @@ -42,7 +42,7 @@ func (h *Admin) ServeHTTP(w http.ResponseWriter, r *http.Request) { case head == "reports" && strings.HasSuffix(tail, "/full-conversation"): h.conversation(w, r, loc, strings.TrimSuffix(tail, "/full-conversation")) default: - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) } } diff --git a/internal/webapi/allarticles.go b/internal/webapi/allarticles.go index 01bb4ed8..79de2d9d 100644 --- a/internal/webapi/allarticles.go +++ b/internal/webapi/allarticles.go @@ -19,19 +19,19 @@ import ( const AllArticlesPath = "/pw-api/articles" type AllArticles struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*AllArticles)(nil) -func NewAllArticles(d Deps, upstream http.Handler) *AllArticles { - return &AllArticles{deps: d, upstream: upstream} +func NewAllArticles(d Deps, next http.Handler) *AllArticles { + return &AllArticles{deps: d, next: next} } func (h *AllArticles) ServeHTTP(w http.ResponseWriter, r *http.Request) { if r.URL.Path != AllArticlesPath || r.Method != http.MethodGet { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } ctx := r.Context() diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index 0986779e..5480b8ff 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -32,14 +32,14 @@ const ( ) type Articles struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*Articles)(nil) -func NewArticles(d Deps, upstream http.Handler) *Articles { - return &Articles{deps: d, upstream: upstream} +func NewArticles(d Deps, next http.Handler) *Articles { + return &Articles{deps: d, next: next} } func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { @@ -55,7 +55,7 @@ func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } if name == "" { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } @@ -77,14 +77,14 @@ func (h *Articles) ServeHTTP(w http.ResponseWriter, r *http.Request) { case tail == tailFiles && r.Method == http.MethodPost: h.answer(w, r, loc, name, h.upload) default: - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) } } func (h *Articles) page(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, name string) { switch { case name == "": - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) case r.Method == http.MethodGet: h.answer(w, r, loc, name, h.fetch) case r.Method == http.MethodPut: @@ -92,7 +92,7 @@ func (h *Articles) page(w http.ResponseWriter, r *http.Request, loc *i18n.Locali case r.Method == http.MethodDelete: h.answer(w, r, loc, name, h.remove) default: - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) } } diff --git a/internal/webapi/favourites.go b/internal/webapi/favourites.go index d7a81e24..a91d8eb3 100644 --- a/internal/webapi/favourites.go +++ b/internal/webapi/favourites.go @@ -15,25 +15,25 @@ const FavouritesPath = "/pw-api/favourites" const favouritesPerPage = 20 type Favourites struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*Favourites)(nil) -func NewFavourites(d Deps, upstream http.Handler) *Favourites { - return &Favourites{deps: d, upstream: upstream} +func NewFavourites(d Deps, next http.Handler) *Favourites { + return &Favourites{deps: d, next: next} } // A reader only ever gets their own rows. Nothing in the request names a user, // so there is nothing to authorise beyond being signed in. func (h *Favourites) ServeHTTP(w http.ResponseWriter, r *http.Request) { if r.URL.Path != FavouritesPath { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } if r.Method != http.MethodGet { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) diff --git a/internal/webapi/files.go b/internal/webapi/files.go index cf104443..bf102598 100644 --- a/internal/webapi/files.go +++ b/internal/webapi/files.go @@ -39,8 +39,8 @@ type FileItems struct { var _ http.Handler = (*FileItems)(nil) -func NewFileItems(d Deps, upstream http.Handler) *FileItems { - return &FileItems{articles: NewArticles(d, upstream)} +func NewFileItems(d Deps, next http.Handler) *FileItems { + return &FileItems{articles: NewArticles(d, next)} } func (h *FileItems) ServeHTTP(w http.ResponseWriter, r *http.Request) { @@ -49,7 +49,7 @@ func (h *FileItems) ServeHTTP(w http.ResponseWriter, r *http.Request) { id, err := strconv.ParseInt(strings.TrimPrefix(r.URL.Path, FilesPrefix), 10, 64) if err != nil { - a.upstream.ServeHTTP(w, r) + a.next.ServeHTTP(w, r) return } switch r.Method { @@ -58,7 +58,7 @@ func (h *FileItems) ServeHTTP(w http.ResponseWriter, r *http.Request) { case http.MethodPut: a.answerFile(w, r, loc, id, a.renameFile) default: - a.upstream.ServeHTTP(w, r) + a.next.ServeHTTP(w, r) } } diff --git a/internal/webapi/messages.go b/internal/webapi/messages.go index b1646dbb..7bead590 100644 --- a/internal/webapi/messages.go +++ b/internal/webapi/messages.go @@ -29,20 +29,20 @@ const ( ) type Messages struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*Messages)(nil) -func NewMessages(d Deps, upstream http.Handler) *Messages { - return &Messages{deps: d, upstream: upstream} +func NewMessages(d Deps, next http.Handler) *Messages { + return &Messages{deps: d, next: next} } func (h *Messages) ServeHTTP(w http.ResponseWriter, r *http.Request) { rest, ok := strings.CutPrefix(r.URL.Path, MessagesPrefix) if !ok { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) @@ -61,7 +61,7 @@ func (h *Messages) ServeHTTP(w http.ResponseWriter, r *http.Request) { case head == "report" && tail == "" && r.Method == http.MethodPost: h.guard(w, r, loc, user, true, func() (string, int, error) { return h.report(r, loc, user) }) default: - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) } } diff --git a/internal/webapi/mypages.go b/internal/webapi/mypages.go index 71ee5bbb..2c35bbae 100644 --- a/internal/webapi/mypages.go +++ b/internal/webapi/mypages.go @@ -20,19 +20,19 @@ const ( const ownRowsPerPage = 20 type OwnRows struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*OwnRows)(nil) -func NewOwnRows(d Deps, upstream http.Handler) *OwnRows { - return &OwnRows{deps: d, upstream: upstream} +func NewOwnRows(d Deps, next http.Handler) *OwnRows { + return &OwnRows{deps: d, next: next} } func (h *OwnRows) ServeHTTP(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodGet || (r.URL.Path != RatingsPath && r.URL.Path != LikedPostsPath) { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) diff --git a/internal/webapi/notifications.go b/internal/webapi/notifications.go index 731d53b7..d484d77d 100644 --- a/internal/webapi/notifications.go +++ b/internal/webapi/notifications.go @@ -32,19 +32,19 @@ var notificationKinds = []string{ } type Notifications struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*Notifications)(nil) -func NewNotifications(d Deps, upstream http.Handler) *Notifications { - return &Notifications{deps: d, upstream: upstream} +func NewNotifications(d Deps, next http.Handler) *Notifications { + return &Notifications{deps: d, next: next} } func (h *Notifications) ServeHTTP(w http.ResponseWriter, r *http.Request) { if r.URL.Path != NotificationsPath { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } loc := h.deps.Bundle.Localizer(i18n.DefaultLanguage) @@ -60,7 +60,7 @@ func (h *Notifications) ServeHTTP(w http.ResponseWriter, r *http.Request) { case http.MethodDelete: h.clear(w, r, loc, user) default: - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) } } diff --git a/internal/webapi/subscribe.go b/internal/webapi/subscribe.go index 90e28bc7..c6fc9451 100644 --- a/internal/webapi/subscribe.go +++ b/internal/webapi/subscribe.go @@ -20,14 +20,14 @@ import ( const SubscribePath = "/pw-api/notifications/subscribe" type Subscriptions struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*Subscriptions)(nil) -func NewSubscriptions(d Deps, upstream http.Handler) *Subscriptions { - return &Subscriptions{deps: d, upstream: upstream} +func NewSubscriptions(d Deps, next http.Handler) *Subscriptions { + return &Subscriptions{deps: d, next: next} } type subscribeRequest struct { @@ -37,11 +37,11 @@ type subscribeRequest struct { func (h *Subscriptions) ServeHTTP(w http.ResponseWriter, r *http.Request) { if r.URL.Path != SubscribePath { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } if r.Method != http.MethodPost && r.Method != http.MethodDelete { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } ctx := r.Context() diff --git a/internal/webapi/users.go b/internal/webapi/users.go index 2e75e31c..74c618be 100644 --- a/internal/webapi/users.go +++ b/internal/webapi/users.go @@ -23,14 +23,14 @@ const ( ) type Users struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*Users)(nil) -func NewUsers(d Deps, upstream http.Handler) *Users { - return &Users{deps: d, upstream: upstream} +func NewUsers(d Deps, next http.Handler) *Users { + return &Users{deps: d, next: next} } func (h *Users) ServeHTTP(w http.ResponseWriter, r *http.Request) { @@ -41,7 +41,7 @@ func (h *Users) ServeHTTP(w http.ResponseWriter, r *http.Request) { } rest, ok := strings.CutPrefix(r.URL.Path, UsersPrefix) if !ok { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } head, tail, _ := strings.Cut(rest, "/") @@ -53,7 +53,7 @@ func (h *Users) ServeHTTP(w http.ResponseWriter, r *http.Request) { case tail == "block" && (r.Method == http.MethodPost || r.Method == http.MethodDelete): h.block(w, r, loc, head) default: - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) } } diff --git a/internal/webapi/webapi.go b/internal/webapi/webapi.go index b4e0ee41..5d770521 100644 --- a/internal/webapi/webapi.go +++ b/internal/webapi/webapi.go @@ -55,14 +55,14 @@ type Deps struct { } type Handler struct { - deps Deps - upstream http.Handler + deps Deps + next http.Handler } var _ http.Handler = (*Handler)(nil) -func New(d Deps, upstream http.Handler) *Handler { - return &Handler{deps: d, upstream: upstream} +func New(d Deps, next http.Handler) *Handler { + return &Handler{deps: d, next: next} } func (d Deps) log() *slog.Logger { @@ -83,7 +83,7 @@ type call struct { func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost { - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) return } @@ -135,8 +135,6 @@ func (h *Handler) safe(parsed call) bool { return safe } -// A method the module never registered goes upstream, which is what keeps the -// unported half working. func (h *Handler) answers(parsed call) bool { if parsed.Method == renderMethod { return true @@ -216,7 +214,7 @@ func (h *Handler) forward(w http.ResponseWriter, r *http.Request, raw []byte, re body = io.MultiReader(body, rest) } r.Body = io.NopCloser(body) - h.upstream.ServeHTTP(w, r) + h.next.ServeHTTP(w, r) } func params(raw json.RawMessage) map[string]string { diff --git a/internal/webapi/webapi_test.go b/internal/webapi/webapi_test.go index 6569aec1..5f8ec0d6 100644 --- a/internal/webapi/webapi_test.go +++ b/internal/webapi/webapi_test.go @@ -112,10 +112,10 @@ func TestAnUnregisteredMethodGoesUpstreamWithItsBody(t *testing.T) { New(Deps{}, up).ServeHTTP(httptest.NewRecorder(), post(body)) if !up.called { - t.Fatal("upstream called = false, want true") + t.Fatal("next called = false, want true") } if string(up.body) != body { - t.Errorf("upstream body = %q, want %q", up.body, body) + t.Errorf("next body = %q, want %q", up.body, body) } } @@ -127,7 +127,7 @@ func TestABodyTooLargeToReadGoesUpstreamWhole(t *testing.T) { New(Deps{}, up).ServeHTTP(httptest.NewRecorder(), post(body)) if string(up.body) != body { - t.Errorf("len(upstream body) = %d, want %d", len(up.body), len(body)) + t.Errorf("len(next body) = %d, want %d", len(up.body), len(body)) } } @@ -138,7 +138,7 @@ func TestWhatIsNotAPostGoesUpstream(t *testing.T) { New(Deps{}, up).ServeHTTP(httptest.NewRecorder(), r) if up.method != http.MethodGet { - t.Errorf("upstream method = %q, want %q", up.method, http.MethodGet) + t.Errorf("next method = %q, want %q", up.method, http.MethodGet) } } @@ -147,7 +147,7 @@ func TestABodyThatIsNotACallGoesUpstream(t *testing.T) { up := &recorder{} New(Deps{}, up).ServeHTTP(httptest.NewRecorder(), post(body)) if !up.called { - t.Errorf("upstream called for %q = false, want true", body) + t.Errorf("next called for %q = false, want true", body) } } } From 7e3dee0d7367ecfda93ccb159e9b3fa8a43b5e7e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 18:06:00 +0900 Subject: [PATCH 339/428] record what forum html turns into --- .gitattributes | 1 + internal/htmlsource/testdata/cases.html | 75 ++++++++++ internal/htmlsource/testdata/html.golden | 156 ++++++++++++++++++++ internal/htmlsource/testdata/oracle_html.py | 50 +++++++ 4 files changed, 282 insertions(+) create mode 100644 internal/htmlsource/testdata/cases.html create mode 100644 internal/htmlsource/testdata/html.golden create mode 100644 internal/htmlsource/testdata/oracle_html.py diff --git a/.gitattributes b/.gitattributes index 027367a8..9366ba31 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,3 @@ *.golden -text *.go text eol=lf +internal/htmlsource/testdata/cases.html -text diff --git a/internal/htmlsource/testdata/cases.html b/internal/htmlsource/testdata/cases.html new file mode 100644 index 00000000..733909bc --- /dev/null +++ b/internal/htmlsource/testdata/cases.html @@ -0,0 +1,75 @@ +=== text === +plain text with a +newline in it +=== paragraph === +

one

two

+=== emphasis === +

a b c d e f

+=== superscript === +

up down

+=== line break === +

a
b

+=== iframe === + +=== printuser === +probe-author +=== printuser with avatar === +probe-author +=== inline math === +$x^2$ +=== equation number === +(1) +=== plain span === +red +=== blockquote === +

one

two

+=== div with an allowed class === +
inner
+=== collapsible === +
show me
hide me

inside

+=== tabview === +
  • first
  • second

one

two

+=== code block === +
print(1)
+=== highlighted code block === +
print(2)
+=== footnote === +

text1

Footnotes
1. the note
+=== bibliography === +
Bibliography
1. first item
2. second item
+=== image container === +
a
+=== image container aligned === +
+=== content separator === +
+=== math equation === +
x = 1
+=== wiki note === +

noted

+=== unknown div === +
fallback
+=== anchor === +SCP-173 +=== image === +c +=== horizontal rule === +
+=== lists === +
  • one
  • two
  1. three
+=== headings === +

one

three

+=== teletype === +code +=== table === +
head
cell
+=== script === + +=== definition list === +
term
meaning
other
second
+=== quotes in attributes === +x +=== backslash in attributes === +
x
+=== nested markup === +

bold and italic

diff --git a/internal/htmlsource/testdata/html.golden b/internal/htmlsource/testdata/html.golden new file mode 100644 index 00000000..d0fcedaf --- /dev/null +++ b/internal/htmlsource/testdata/html.golden @@ -0,0 +1,156 @@ +=== text === +plain text with anewline in it +=== paragraph === +one + +two + + +=== emphasis === +//a// **b** **c** __d__ --e-- --f-- + + +=== superscript === +^^up^^ ,,down,, + + +=== line break === +a +b + + +=== iframe === +[[iframe https://example.test/x width="300" class="frame"]] +=== printuser === +[[user probe-author]] +=== printuser with avatar === +[[*user probe-author]] +=== inline math === +[[$ x^2 $]] +=== equation number === + +=== plain span === +[[span style="color: red" class="fancy"]]red[[/span]] +=== blockquote === +> one +> +> two + +=== div with an allowed class === +[[div class="rimg"]] +inner[[/div]] + +=== collapsible === +[[collapsible show="show me" hide="hide me"]] +inside + +[[/collapsible]] + +=== tabview === +[[tabview]] +[[tab title="first"]] +one + +[[/tab]] +[[tab title="second"]] +two + +[[/tab]] +[[/tabview]] + +=== code block === +[[code]] +print(1) +[[/code]] + +=== highlighted code block === +[[code]] +print(2) +[[/code]] + +=== footnote === +text[[footnote]]the note[[/footnote]] + +[[footnoteblock title="Footnotes"]] + +=== bibliography === +[[bibliography title="Bibliography"]] +: cite1 : first item +: cite2 : second item +[[/bibliography]] + +=== image container === +[[f>image /local--files/a.png width="50"]] +=== image container aligned === +[[=image /local--files/b.png]] +=== content separator === +==== + +=== math equation === +[[math]] +x = 1 +[[/math]] + +=== wiki note === +[[note]] +noted + +[[/note]] + +=== unknown div === +[[div class="whatever" id="x"]] +fallback[[/div]] + +=== anchor === +[[a href="/scp-173" class="link"]]SCP-173[[/a]] +=== image === +[[image /local--files/c.png width="20"]] +=== horizontal rule === +---- + +=== lists === +[[ul]] +[[li]] +one[[/li]] +[[li]] +two[[/li]] +[[/ul]] +[[ol]] +[[li]] +three[[/li]] +[[/ol]] + +=== headings === ++ one ++++ three + +=== teletype === +{{code}} +=== table === +[[table class="wiki-content-table"]] +[[row]] +[[hcell]] +head[[/hcell]] +[[/row]] +[[row]] +[[cell]] +cell[[/cell]] +[[/row]] +[[/table]] + +=== script === + +=== definition list === +: term : meaning +: other : second + +=== quotes in attributes === +[[span title="a \"quoted\" word"]]x[[/span]] +=== backslash in attributes === +[[div class="rimg" data-path="a\\b"]] +x[[/div]] + +=== nested markup === +**bold //and italic//** + + diff --git a/internal/htmlsource/testdata/oracle_html.py b/internal/htmlsource/testdata/oracle_html.py new file mode 100644 index 00000000..10c96739 --- /dev/null +++ b/internal/htmlsource/testdata/oracle_html.py @@ -0,0 +1,50 @@ +"""Record what the archive importer turns forum HTML into. + + docker compose cp internal/htmlsource/testdata/cases.html web:/tmp/cases.html + docker compose exec -T -e CASES=/tmp/cases.html web python manage.py shell --no-imports \n < internal/htmlsource/testdata/oracle_html.py \n > internal/htmlsource/testdata/html.golden + +Writes the case headers back with each case replaced by its wikidot source. +""" + +import os +import sys + +from web import threadvars +from web.seeds.wikit_archive import html_to_source + +CASES = os.environ.get('CASES', '/tmp/cases.html') + + +def split(text): + name = None + body = [] + for line in text.split('\n'): + if line.startswith('=== ') and line.endswith(' ==='): + if name is not None: + yield name, '\n'.join(body) + name = line[4:-4] + body = [] + continue + if name is not None: + body.append(line) + if name is not None: + yield name, '\n'.join(body) + + +def main(): + try: + with open(CASES, encoding='utf-8') as f: + raw = f.read() + except FileNotFoundError: + raise SystemExit('cases not found at %s; copy cases.html in and set CASES' % CASES) + + out = [] + with threadvars.context(): + threadvars.put('threadid', 0) + for name, body in split(raw): + out.append('=== %s ===' % name) + out.append(html_to_source(body.strip('\n'))) + sys.stdout.write('\n'.join(out) + '\n') + + +main() From 961f104b1a5fa2122bb98d485a1f6f8a6543b989 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 19:36:21 +0900 Subject: [PATCH 340/428] add the site column to every per-site table --- internal/migrate/migrate_test.go | 8 ++- internal/migrate/sql/0003_site_columns.sql | 72 ++++++++++++++++++++++ 2 files changed, 78 insertions(+), 2 deletions(-) create mode 100644 internal/migrate/sql/0003_site_columns.sql diff --git a/internal/migrate/migrate_test.go b/internal/migrate/migrate_test.go index 7be8ddd5..7a8a3f9e 100644 --- a/internal/migrate/migrate_test.go +++ b/internal/migrate/migrate_test.go @@ -112,8 +112,12 @@ func TestRunAdoptsASchemaBuiltBeforeGoOwnedIt(t *testing.T) { if !result.Adopted { t.Error("Run().Adopted = false, want true") } - if len(result.Applied) != 0 { - t.Errorf("Run().Applied = %v, want [] because the tables are already there", result.Applied) + if slices.Contains(result.Applied, BaselineName) { + t.Errorf("Run().Applied = %v, want it without %s because those tables are already there", + result.Applied, BaselineName) + } + if len(result.Applied) != len(Names())-1 { + t.Errorf("len(Run().Applied) = %d, want %d", len(result.Applied), len(Names())-1) } } diff --git a/internal/migrate/sql/0003_site_columns.sql b/internal/migrate/sql/0003_site_columns.sql new file mode 100644 index 00000000..085bfe5d --- /dev/null +++ b/internal/migrate/sql/0003_site_columns.sql @@ -0,0 +1,72 @@ +ALTER TABLE web_user ADD COLUMN wikidot_user_id bigint; + +-- The archive keys every author and voter by this number while usernames drift, +-- so it is the only stable way to recognise someone across two backups. +CREATE UNIQUE INDEX web_user_wikidot_user_id_key ON web_user (wikidot_user_id); + +ALTER TABLE web_article ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_category ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_tag ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_tagscategory ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_role ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_rolecategory ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_forumsection ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_theme ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_invitelink ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_userreport ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE web_userticket ADD COLUMN site_id bigint REFERENCES web_site (id); +ALTER TABLE pwikit_admin_log ADD COLUMN site_id bigint REFERENCES web_site (id); + +-- A comment thread hangs off an article and a forum thread off a category, so +-- without a column of its own the site takes a two-way branch to answer. +ALTER TABLE web_forumthread ADD COLUMN site_id bigint REFERENCES web_site (id); + +DO $$ +DECLARE + only_site bigint; + one text; +BEGIN + SELECT id INTO only_site FROM web_site ORDER BY id LIMIT 1; + IF only_site IS NULL THEN + RETURN; + END IF; + FOREACH one IN ARRAY ARRAY[ + 'web_article', 'web_category', 'web_tag', 'web_tagscategory', 'web_role', + 'web_rolecategory', 'web_forumsection', 'web_forumthread', 'web_theme', + 'web_invitelink', 'web_userreport', 'web_userticket', 'pwikit_admin_log' + ] LOOP + EXECUTE format('UPDATE %I SET site_id = %s', one, only_site); + END LOOP; +END $$; + +CREATE INDEX web_article_site_idx ON web_article (site_id); +CREATE INDEX web_forumthread_site_idx ON web_forumthread (site_id); + +ALTER TABLE web_article DROP CONSTRAINT web_article_unique; +ALTER TABLE web_article ADD CONSTRAINT web_article_unique UNIQUE (site_id, category, name); + +ALTER TABLE web_category DROP CONSTRAINT web_category_unique; +ALTER TABLE web_category ADD CONSTRAINT web_category_unique UNIQUE (site_id, name); + +ALTER TABLE web_role DROP CONSTRAINT web_role_slug_key; +ALTER TABLE web_role ADD CONSTRAINT web_role_slug_key UNIQUE (site_id, slug); + +ALTER TABLE web_tag DROP CONSTRAINT web_tag_unique; +ALTER TABLE web_tag ADD CONSTRAINT web_tag_unique UNIQUE (site_id, category_id, name); + +-- Two constraints said the same thing about the slug, and only one of them +-- comes back. +ALTER TABLE web_tagscategory DROP CONSTRAINT web_tagscategory_unique; +ALTER TABLE web_tagscategory DROP CONSTRAINT web_tagscategory_slug_key; +ALTER TABLE web_tagscategory ADD CONSTRAINT web_tagscategory_unique UNIQUE (site_id, slug); + +ALTER TABLE web_tagscategory DROP CONSTRAINT web_tagscategory_priority_fd2df012_uniq; +ALTER TABLE web_tagscategory ADD CONSTRAINT web_tagscategory_priority_fd2df012_uniq UNIQUE (site_id, priority); + +ALTER TABLE web_theme DROP CONSTRAINT web_theme_slug_7893de0e_uniq; +ALTER TABLE web_theme ADD CONSTRAINT web_theme_slug_7893de0e_uniq UNIQUE (site_id, slug); + +-- Host routing reads both columns as one namespace. Without this a second site +-- can claim the first site's media domain, which puts uploaded HTML on an +-- origin that is not its own. +ALTER TABLE web_site ADD CONSTRAINT web_site_media_domain_unique UNIQUE (media_domain); From b61d413c210f295bbff444f521e98be7e8dea72b Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 21:25:32 +0900 Subject: [PATCH 341/428] fail when a query forgets the site --- internal/db/site_scope_pending_test.go | 160 +++++++++++++++++++++++++ internal/db/site_scope_test.go | 93 ++++++++++++++ 2 files changed, 253 insertions(+) create mode 100644 internal/db/site_scope_pending_test.go create mode 100644 internal/db/site_scope_test.go diff --git a/internal/db/site_scope_pending_test.go b/internal/db/site_scope_pending_test.go new file mode 100644 index 00000000..b9e65f5b --- /dev/null +++ b/internal/db/site_scope_pending_test.go @@ -0,0 +1,160 @@ +package db + +var siteScopePending = []string{ + "ActivateInviteLink", + "AddUserRoles", + "AdminCategories", + "AdminCategory", + "AdminCategoryOverrides", + "AdminForumCategories", + "AdminForumSection", + "AdminForumSections", + "AdminInviteCount", + "AdminInvites", + "AdminNoteScreens", + "AdminNotes", + "AdminPageCategories", + "AdminPageCount", + "AdminPages", + "AdminReport", + "AdminReportCount", + "AdminReports", + "AdminRole", + "AdminRoles", + "AdminTag", + "AdminTagCategories", + "AdminTagCategory", + "AdminTagCount", + "AdminTags", + "AdminTicket", + "AdminTicketCount", + "AdminTickets", + "AllRoles", + "AllTags", + "ArticleByID", + "ArticleByName", + "ArticleCategories", + "ArticleChildren", + "ArticleFile", + "ArticleLastComment", + "ArticleSources", + "ArticleTagCategories", + "ArticleTagNames", + "ArticleTags", + "ArticleTitles", + "ArticleVotes", + "ArticlesByTag", + "Breadcrumbs", + "CategoryCanCreateTags", + "CategoryExists", + "CategoryIndexed", + "CategoryNames", + "CategoryOverrides", + "CategoryRatingMode", + "CategoryRatingModes", + "ChildCount", + "ClearRoleTickets", + "CommentCount", + "CommentCountsOfArticles", + "CommentInfo", + "CommentThreadFor", + "CreateInviteLink", + "CreateReport", + "CreateTicket", + "DeleteArticle.0", + "DeleteArticle.1", + "DeleteArticle.13", + "DeleteArticle.14", + "DeleteArticle.2", + "DeleteArticle.3", + "DeleteArticle.4", + "DeleteCategory", + "DeleteForumSection", + "DeleteInvite", + "DeleteRole", + "DeleteRoleCategory", + "DeleteTagCat", + "DeleteTagRow", + "DeleteTheme", + "DetachRoleCategory", + "DetachTagCat", + "DropOrphanTagCategories", + "DropOrphanTags", + "FavouritesOf", + "FindTag", + "FindTagCategory", + "ForumCategoryCounts", + "ForumCategoryLastPost", + "ForumCommentCounts", + "ForumCommentLastPost", + "ForumCommentThreadsByReply", + "ForumCommentThreadsByStart", + "ForumSection", + "ForumSections", + "ForumThread", + "ForumThreadsByReply", + "ForumThreadsByStart", + "ForumThreadsInCategories", + "GrantTicketRole", + "InsertArticle", + "InsertCategory", + "InsertForumSection", + "InsertForumThread", + "InsertRole", + "InsertRoleCategory", + "InsertTag", + "InsertTagCat", + "InsertTagCategory", + "InsertTagRow", + "InsertTheme", + "KnownTags", + "LikedPostsOf", + "MoveArticleParent", + "OpenInviteCount", + "OperationIndex", + "RatedBy", + "ReadArticleTags", + "ReadArticleTitle", + "RecentPostCount", + "RecentPosts", + "RenameArticle", + "Report", + "ReportsSince", + "ReviewReport", + "ReviewTicket", + "RoleByRef", + "RoleCategories", + "RoleIDBySlug", + "RoleIDsBySlug", + "RoleIDsForUser", + "RolesByUser", + "RolesByUsers", + "SetArticleLock", + "SetArticleParent", + "SetArticleTitle", + "TagCategoryBySlug", + "TagCloud", + "TagIDsByBareName", + "TagIDsByFullName", + "TagIDsByName", + "TagsCategories", + "TagsOfArticles", + "ThemeByID", + "ThemeRow", + "Themes", + "TouchArticle", + "TouchForumThread", + "UpdateArticleTitle", + "UpdateCategory", + "UpdateForumSection", + "UpdateForumThread", + "UpdateRole", + "UpdateRoleCategory", + "UpdateTag", + "UpdateTagCat", + "UpdateTheme", + "UserPostCount", + "UserPosts", + "VoteGroupRole", + "WriteAdminNote", +} diff --git a/internal/db/site_scope_test.go b/internal/db/site_scope_test.go new file mode 100644 index 00000000..115e80b3 --- /dev/null +++ b/internal/db/site_scope_test.go @@ -0,0 +1,93 @@ +package db + +import ( + "os" + "regexp" + "slices" + "sort" + "strings" + "testing" +) + +var perSiteTables = []string{ + "web_article", + "web_category", + "web_tag", + "web_tagscategory", + "web_role", + "web_rolecategory", + "web_forumsection", + "web_forumthread", + "web_theme", + "web_invitelink", + "web_userreport", + "web_userticket", + "pwikit_admin_log", +} + +func touchedTables(sql string) []string { + var out []string + for _, table := range perSiteTables { + pattern := regexp.MustCompile(`\b` + table + `\b`) + if pattern.MatchString(sql) { + out = append(out, table) + } + } + return out +} + +func TestEveryPerSiteQueryNamesTheSite(t *testing.T) { + pending := map[string]bool{} + for _, name := range siteScopePending { + pending[name] = true + } + + var missing, stale []string + for _, q := range queries { + if len(touchedTables(q.sql)) == 0 { + if pending[q.name] { + stale = append(stale, q.name) + } + continue + } + if strings.Contains(q.sql, "site_id") { + if pending[q.name] { + stale = append(stale, q.name) + } + continue + } + if !pending[q.name] { + missing = append(missing, q.name) + } + } + + for _, name := range missing { + t.Errorf("query %q reads a per-site table without site_id, want the filter or an entry in siteScopePending", name) + } + for _, name := range stale { + t.Errorf("query %q is in siteScopePending but no longer needs to be, want it removed", name) + } + + if os.Getenv("PWIKIT_SITE_SCOPE_LIST") != "" { + var left []string + for _, q := range queries { + if pending[q.name] { + left = append(left, q.name) + } + } + sort.Strings(left) + t.Logf("%d queries still to scope:\n%s", len(left), strings.Join(left, "\n")) + } +} + +func TestSiteScopePendingHasNoUnknownNames(t *testing.T) { + known := make([]string, 0, len(queries)) + for _, q := range queries { + known = append(known, q.name) + } + for _, name := range siteScopePending { + if !slices.Contains(known, name) { + t.Errorf("siteScopePending has %q, want a registered query name", name) + } + } +} From 175264fc70e0560668f9218437b5a64ca9b45658 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 21:51:50 +0900 Subject: [PATCH 342/428] read roles for one site only --- internal/account/account.go | 7 +++++++ internal/account/signup.go | 2 +- internal/admin/admin.go | 9 ++++++++- internal/admin/category.go | 4 ++-- internal/admin/site.go | 2 +- internal/admin/ticket.go | 2 +- internal/admin/user.go | 2 +- internal/admin/useractions.go | 8 ++++---- internal/articlepage/render.go | 2 +- internal/db/account_write.go | 6 +++--- internal/db/member.go | 6 +++--- internal/db/member_test.go | 8 ++++---- internal/db/perms.go | 12 ++++++------ internal/db/role.go | 18 +++++++++--------- internal/db/role_test.go | 2 +- internal/db/site_scope_pending_test.go | 8 -------- internal/db/site_test.go | 9 +++++++++ internal/db/vote.go | 6 +++--- internal/repo/modules.go | 8 ++++---- internal/repo/perms.go | 13 +++++++++++-- internal/repo/repo.go | 9 ++++++++- internal/repo/users.go | 4 ++-- internal/userpage/reactivepage.go | 2 +- internal/userpage/userpage.go | 11 +++++++++-- 24 files changed, 99 insertions(+), 61 deletions(-) diff --git a/internal/account/account.go b/internal/account/account.go index 0b07959e..bccb3226 100644 --- a/internal/account/account.go +++ b/internal/account/account.go @@ -102,3 +102,10 @@ func authIcon(s *db.Site) string { } return "/local--files/" + s.AuthIcon } + +func siteID(ctx context.Context) int64 { + if current := site.FromContext(ctx); current != nil { + return current.ID + } + return 0 +} diff --git a/internal/account/signup.go b/internal/account/signup.go index b79220ee..aac52fb7 100644 --- a/internal/account/signup.go +++ b/internal/account/signup.go @@ -264,7 +264,7 @@ func (h *SignupHandler) grant(ctx context.Context, configured *int64, userID int if configured != nil { return h.deps.DB.GrantRole(ctx, userID, *configured) } - id, err := h.deps.DB.RoleIDBySlug(ctx, defaultRoleRef) + id, err := h.deps.DB.RoleIDBySlug(ctx, siteID(ctx), defaultRoleRef) if errors.Is(err, db.ErrNotFound) { return nil } diff --git a/internal/admin/admin.go b/internal/admin/admin.go index 26b8a6f1..eb4ff0cb 100644 --- a/internal/admin/admin.go +++ b/internal/admin/admin.go @@ -233,7 +233,7 @@ func (h *Handler) access(ctx context.Context) (perms.Set, bool, error) { if user == nil { return perms.Set{}, false, nil } - own, err := h.deps.DB.RolesByUser(ctx, user.ID) + own, err := h.deps.DB.RolesByUser(ctx, siteID(ctx), user.ID) if err != nil { return perms.Set{}, false, err } @@ -359,3 +359,10 @@ func funcs() template.FuncMap { }, } } + +func siteID(ctx context.Context) int64 { + if current := site.FromContext(ctx); current != nil { + return current.ID + } + return 0 +} diff --git a/internal/admin/category.go b/internal/admin/category.go index 6234bc48..b300056a 100644 --- a/internal/admin/category.go +++ b/internal/admin/category.go @@ -58,7 +58,7 @@ func (h *Handler) pageCategoryForm(w http.ResponseWriter, r *http.Request, loc * row.Settings = db.SiteSettings{RatingMode: "default", CreateTags: "default"} } } - roleList, err := h.deps.DB.AllRoles(ctx) + roleList, err := h.deps.DB.AllRoles(ctx, siteID(ctx)) if err != nil { return err } @@ -165,7 +165,7 @@ func (h *Handler) savePageCategory(w http.ResponseWriter, r *http.Request, loc * } } } - roleList, err := h.deps.DB.AllRoles(ctx) + roleList, err := h.deps.DB.AllRoles(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/site.go b/internal/admin/site.go index b45b01f6..0ab34bc0 100644 --- a/internal/admin/site.go +++ b/internal/admin/site.go @@ -42,7 +42,7 @@ func (h *Handler) siteForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if err != nil { return err } - roleList, err := h.deps.DB.AllRoles(ctx) + roleList, err := h.deps.DB.AllRoles(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/ticket.go b/internal/admin/ticket.go index f1267112..e647ee8d 100644 --- a/internal/admin/ticket.go +++ b/internal/admin/ticket.go @@ -136,7 +136,7 @@ func (h *Handler) ticketForm(w http.ResponseWriter, r *http.Request, loc *i18n.L } mayGrant := grants && granted.Has(perms.ManagePermissions) if mayGrant { - roleList, err = h.deps.DB.AllRoles(ctx) + roleList, err = h.deps.DB.AllRoles(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/user.go b/internal/admin/user.go index 894ca8c5..03495a89 100644 --- a/internal/admin/user.go +++ b/internal/admin/user.go @@ -128,7 +128,7 @@ func (h *Handler) userForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc return nil } - roleList, err := h.deps.DB.AllRoles(ctx) + roleList, err := h.deps.DB.AllRoles(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/useractions.go b/internal/admin/useractions.go index 78778db3..2318e6cd 100644 --- a/internal/admin/useractions.go +++ b/internal/admin/useractions.go @@ -57,7 +57,7 @@ func (h *Handler) userAction(w http.ResponseWriter, r *http.Request, loc *i18n.L } func (h *Handler) newUser(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, problem string) error { - roleList, err := h.deps.DB.AllRoles(r.Context()) + roleList, err := h.deps.DB.AllRoles(r.Context(), siteID(r.Context())) if err != nil { return err } @@ -140,7 +140,7 @@ func (h *Handler) saveBot(w http.ResponseWriter, r *http.Request, loc *i18n.Loca } func (h *Handler) inviteLink(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, problem, made string) error { - roleList, err := h.deps.DB.AllRoles(r.Context()) + roleList, err := h.deps.DB.AllRoles(r.Context(), siteID(r.Context())) if err != nil { return err } @@ -187,7 +187,7 @@ func (h *Handler) claimLink(w http.ResponseWriter, r *http.Request, loc *i18n.Lo if err != nil { return err } - roleList, err := h.deps.DB.AllRoles(ctx) + roleList, err := h.deps.DB.AllRoles(ctx, siteID(ctx)) if err != nil { return err } @@ -320,7 +320,7 @@ func scheme(r *http.Request) string { func (h *Handler) mailInvite(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, target *db.AdminUserRow, problem, done string) error { - roleList, err := h.deps.DB.AllRoles(r.Context()) + roleList, err := h.deps.DB.AllRoles(r.Context(), siteID(r.Context())) if err != nil { return err } diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index 773f8c0b..c3df68c5 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -533,7 +533,7 @@ func (h *Handler) tagBlock(req *request) ([]shell.TagCategory, error) { func (h *Handler) loginStatus(req *request) (string, error) { status := pageconfig.LoginStatus{User: req.user} if req.user != nil { - userRoles, err := h.deps.DB.RolesByUser(req.ctx, req.user.ID) + userRoles, err := h.deps.DB.RolesByUser(req.ctx, req.site.ID, req.user.ID) if err != nil { return "", err } diff --git a/internal/db/account_write.go b/internal/db/account_write.go index 6fe7da33..6b0e6250 100644 --- a/internal/db/account_write.go +++ b/internal/db/account_write.go @@ -124,11 +124,11 @@ func (d *DB) SetEmail(ctx context.Context, id int64, email string) error { return nil } -var qRoleIDBySlug = register("RoleIDBySlug", `SELECT id FROM web_role WHERE slug = $1`) +var qRoleIDBySlug = register("RoleIDBySlug", `SELECT id FROM web_role WHERE site_id = $1 AND slug = $2`) -func (d *DB) RoleIDBySlug(ctx context.Context, slug string) (int64, error) { +func (d *DB) RoleIDBySlug(ctx context.Context, siteID int64, slug string) (int64, error) { var id int64 - err := d.pool.QueryRow(ctx, qRoleIDBySlug, slug).Scan(&id) + err := d.pool.QueryRow(ctx, qRoleIDBySlug, siteID, slug).Scan(&id) if errors.Is(err, pgx.ErrNoRows) { return 0, ErrNotFound } diff --git a/internal/db/member.go b/internal/db/member.go index 5a034232..a53af94a 100644 --- a/internal/db/member.go +++ b/internal/db/member.go @@ -68,13 +68,13 @@ SELECT r.id, r.slug, r.name, r.short_name, r.category_id, r.index, r.is_staff, r.group_votes, r.inline_visual_mode, r.profile_visual_mode, r.color, r.icon, r.badge_text, r.badge_bg, r.badge_text_color, r.badge_show_border FROM web_role r -WHERE lower(r.slug) = lower($1) OR r.id::text = $1 +WHERE r.site_id = $1 AND (lower(r.slug) = lower($2) OR r.id::text = $2) ORDER BY r.index, r.id LIMIT 1`) -func (d *DB) RoleByRef(ctx context.Context, ref string) (*roles.Role, error) { +func (d *DB) RoleByRef(ctx context.Context, siteID int64, ref string) (*roles.Role, error) { var role roles.Role - err := d.pool.QueryRow(ctx, qRoleByRef, ref).Scan( + err := d.pool.QueryRow(ctx, qRoleByRef, siteID, ref).Scan( &role.ID, &role.Slug, &role.Name, &role.ShortName, &role.CategoryID, &role.Index, &role.IsStaff, &role.GroupVotes, &role.InlineVisualMode, &role.ProfileVisualMode, &role.Color, &role.Icon, &role.BadgeText, &role.BadgeBg, &role.BadgeTextColor, diff --git a/internal/db/member_test.go b/internal/db/member_test.go index f0694da6..6832cc2d 100644 --- a/internal/db/member_test.go +++ b/internal/db/member_test.go @@ -71,7 +71,7 @@ func TestMembersFilteredByRole(t *testing.T) { d := newTestDB(t) ctx := context.Background() - role, err := d.RoleByRef(ctx, "everyone") + role, err := d.RoleByRef(ctx, seedSiteID(t, d), "everyone") if err != nil { t.Fatalf("RoleByRef(\"everyone\") err = %v, want nil", err) } @@ -92,11 +92,11 @@ func TestRoleByRefMatchesTheNumber(t *testing.T) { d := newTestDB(t) ctx := context.Background() - bySlug, err := d.RoleByRef(ctx, "everyone") + bySlug, err := d.RoleByRef(ctx, seedSiteID(t, d), "everyone") if err != nil { t.Fatalf("RoleByRef(\"everyone\") err = %v, want nil", err) } - byID, err := d.RoleByRef(ctx, itoa(bySlug.ID)) + byID, err := d.RoleByRef(ctx, seedSiteID(t, d), itoa(bySlug.ID)) if err != nil { t.Fatalf("RoleByRef(%q) err = %v, want nil", itoa(bySlug.ID), err) } @@ -108,7 +108,7 @@ func TestRoleByRefMatchesTheNumber(t *testing.T) { func TestRoleByRefUnknown(t *testing.T) { d := newTestDB(t) - _, err := d.RoleByRef(context.Background(), "no-such-role") + _, err := d.RoleByRef(context.Background(), seedSiteID(t, d), "no-such-role") if !errors.Is(err, ErrNotFound) { t.Errorf("RoleByRef(\"no-such-role\") err = %v, want ErrNotFound", err) } diff --git a/internal/db/perms.go b/internal/db/perms.go index 0a7b12dc..8835bf4a 100644 --- a/internal/db/perms.go +++ b/internal/db/perms.go @@ -10,7 +10,7 @@ import ( var qRoleIDsBySlug = register("RoleIDsBySlug", ` SELECT slug, id FROM web_role -WHERE slug = ANY($1)`) +WHERE site_id = $1 AND slug = ANY($2)`) // Nothing downstream depends on the order. Each role's permissions are settled // on their own and then merged. @@ -18,7 +18,7 @@ var qRoleIDsForUser = register("RoleIDsForUser", ` SELECT ur.role_id FROM web_user_roles ur JOIN web_role r ON r.id = ur.role_id -WHERE ur.user_id = $1 +WHERE ur.user_id = $1 AND r.site_id = $2 ORDER BY r.index DESC, r.id`) var qRolePermissions = register("RolePermissions", ` @@ -58,8 +58,8 @@ SELECT EXISTS ( // A slug with no row is left out rather than created, because a read path must // not write. -func (d *DB) RoleIDsBySlug(ctx context.Context, slugs []string) (map[string]int64, error) { - rows, err := d.pool.Query(ctx, qRoleIDsBySlug, slugs) +func (d *DB) RoleIDsBySlug(ctx context.Context, siteID int64, slugs []string) (map[string]int64, error) { + rows, err := d.pool.Query(ctx, qRoleIDsBySlug, siteID, slugs) if err != nil { return nil, fmt.Errorf("look up roles %v: %w", slugs, err) } @@ -80,8 +80,8 @@ func (d *DB) RoleIDsBySlug(ctx context.Context, slugs []string) (map[string]int6 return out, nil } -func (d *DB) RoleIDsForUser(ctx context.Context, userID int64) ([]int64, error) { - rows, err := d.pool.Query(ctx, qRoleIDsForUser, userID) +func (d *DB) RoleIDsForUser(ctx context.Context, siteID, userID int64) ([]int64, error) { + rows, err := d.pool.Query(ctx, qRoleIDsForUser, userID, siteID) if err != nil { return nil, fmt.Errorf("list role ids of user %d: %w", userID, err) } diff --git a/internal/db/role.go b/internal/db/role.go index 4cedff09..622bfc2d 100644 --- a/internal/db/role.go +++ b/internal/db/role.go @@ -13,13 +13,13 @@ SELECT r.id, r.slug, r.name, r.short_name, r.category_id, r.index, r.color, r.icon, r.badge_text, r.badge_bg, r.badge_text_color, r.badge_show_border FROM web_role r JOIN web_user_roles ur ON ur.role_id = r.id -WHERE ur.user_id = $1 +WHERE ur.user_id = $1 AND r.site_id = $2 ORDER BY r.index, r.id`) // Ordered the way the name tail and showcase queries both consume it. The tie- // break on id covers the rows whose index is not unique. -func (d *DB) RolesByUser(ctx context.Context, userID int64) ([]roles.Role, error) { - rows, err := d.pool.Query(ctx, qRolesByUser, userID) +func (d *DB) RolesByUser(ctx context.Context, siteID, userID int64) ([]roles.Role, error) { + rows, err := d.pool.Query(ctx, qRolesByUser, userID, siteID) if err != nil { return nil, fmt.Errorf("list roles of user %d: %w", userID, err) } @@ -50,15 +50,15 @@ SELECT ur.user_id, r.id, r.slug, r.name, r.short_name, r.category_id, r.index, r.color, r.icon, r.badge_text, r.badge_bg, r.badge_text_color, r.badge_show_border FROM web_role r JOIN web_user_roles ur ON ur.role_id = r.id -WHERE ur.user_id = ANY($1) +WHERE ur.user_id = ANY($1) AND r.site_id = $2 ORDER BY ur.user_id, r.index, r.id`) -func (d *DB) RolesByUsers(ctx context.Context, userIDs []int64) (map[int64][]roles.Role, error) { +func (d *DB) RolesByUsers(ctx context.Context, siteID int64, userIDs []int64) (map[int64][]roles.Role, error) { out := map[int64][]roles.Role{} if len(userIDs) == 0 { return out, nil } - rows, err := d.pool.Query(ctx, qRolesByUsers, userIDs) + rows, err := d.pool.Query(ctx, qRolesByUsers, userIDs, siteID) if err != nil { return nil, fmt.Errorf("list roles of %d users: %w", len(userIDs), err) } @@ -85,7 +85,7 @@ func (d *DB) RolesByUsers(ctx context.Context, userIDs []int64) (map[int64][]rol } var qAllRoles = register("AllRoles", ` -SELECT id, slug, name FROM web_role ORDER BY index, id`) +SELECT id, slug, name FROM web_role WHERE site_id = $1 ORDER BY index, id`) type RoleChoice struct { ID int64 @@ -93,8 +93,8 @@ type RoleChoice struct { Name string } -func (d *DB) AllRoles(ctx context.Context) ([]RoleChoice, error) { - rows, err := d.pool.Query(ctx, qAllRoles) +func (d *DB) AllRoles(ctx context.Context, siteID int64) ([]RoleChoice, error) { + rows, err := d.pool.Query(ctx, qAllRoles, siteID) if err != nil { return nil, fmt.Errorf("list roles: %w", err) } diff --git a/internal/db/role_test.go b/internal/db/role_test.go index 46ca14b9..dcb94b40 100644 --- a/internal/db/role_test.go +++ b/internal/db/role_test.go @@ -9,7 +9,7 @@ import ( func TestRolesByUserWithoutRoles(t *testing.T) { d := newTestDB(t) - got, err := d.RolesByUser(context.Background(), 1) + got, err := d.RolesByUser(context.Background(), seedSiteID(t, d), 1) if err != nil { t.Fatalf("RolesByUser(1) err = %v, want nil", err) } diff --git a/internal/db/site_scope_pending_test.go b/internal/db/site_scope_pending_test.go index b9e65f5b..07142336 100644 --- a/internal/db/site_scope_pending_test.go +++ b/internal/db/site_scope_pending_test.go @@ -29,7 +29,6 @@ var siteScopePending = []string{ "AdminTicket", "AdminTicketCount", "AdminTickets", - "AllRoles", "AllTags", "ArticleByID", "ArticleByName", @@ -122,13 +121,7 @@ var siteScopePending = []string{ "ReportsSince", "ReviewReport", "ReviewTicket", - "RoleByRef", "RoleCategories", - "RoleIDBySlug", - "RoleIDsBySlug", - "RoleIDsForUser", - "RolesByUser", - "RolesByUsers", "SetArticleLock", "SetArticleParent", "SetArticleTitle", @@ -155,6 +148,5 @@ var siteScopePending = []string{ "UpdateTheme", "UserPostCount", "UserPosts", - "VoteGroupRole", "WriteAdminNote", } diff --git a/internal/db/site_test.go b/internal/db/site_test.go index 9c9c1bad..c9992d39 100644 --- a/internal/db/site_test.go +++ b/internal/db/site_test.go @@ -82,3 +82,12 @@ func TestSiteHostExistsAcceptsBothDomainsAndRejectsStrangers(t *testing.T) { t.Error("SiteHostExists(\"someone-elses-domain.example\") = true, want false") } } + +func seedSiteID(t *testing.T, d *DB) int64 { + t.Helper() + found, err := d.SiteByHosts(context.Background(), []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) + } + return found.ID +} diff --git a/internal/db/vote.go b/internal/db/vote.go index a659fa96..808daa60 100644 --- a/internal/db/vote.go +++ b/internal/db/vote.go @@ -120,13 +120,13 @@ var qVoteGroupRole = register("VoteGroupRole", ` SELECT r.id FROM web_role r LEFT JOIN web_user_roles link ON link.role_id = r.id AND link.user_id = $1 -WHERE r.group_votes AND (r.slug = ANY($2) OR link.user_id IS NOT NULL) +WHERE r.site_id = $3 AND r.group_votes AND (r.slug = ANY($2) OR link.user_id IS NOT NULL) ORDER BY CASE r.slug WHEN 'registered' THEN 0 WHEN 'everyone' THEN 1 ELSE 2 END, r.index LIMIT 1`) // VoteGroupRole answers which role a vote is filed under. The two built-in // roles outrank the user's own, and for an anonymous reader only everyone can. -func (d *DB) VoteGroupRole(ctx context.Context, userID *int64) (*int64, error) { +func (d *DB) VoteGroupRole(ctx context.Context, siteID int64, userID *int64) (*int64, error) { slugs := []string{"everyone"} var of int64 if userID != nil { @@ -135,7 +135,7 @@ func (d *DB) VoteGroupRole(ctx context.Context, userID *int64) (*int64, error) { } var id int64 - err := d.pool.QueryRow(ctx, qVoteGroupRole, of, slugs).Scan(&id) + err := d.pool.QueryRow(ctx, qVoteGroupRole, of, slugs, siteID).Scan(&id) if errors.Is(err, pgx.ErrNoRows) { return nil, nil } diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 1286ad71..b66ba2d8 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -270,7 +270,7 @@ func (m moduleData) ArticleHasAuthor(articleID, userID int64) (bool, error) { } func (m moduleData) RolesByUser(id int64) ([]roles.Role, error) { - return m.repo.db.RolesByUser(m.repo.ctx, id) + return m.repo.db.RolesByUser(m.repo.ctx, m.repo.siteID(), id) } func (m moduleData) ForumThreadObject(t *db.ForumThread, u *db.User) (*perms.Object, error) { @@ -290,7 +290,7 @@ func (m moduleData) ReplaceVote(articleID, userID int64, rate *float64, roleID * } func (m moduleData) VoteGroupRole(userID *int64) (*int64, error) { - return m.repo.db.VoteGroupRole(m.repo.ctx, userID) + return m.repo.db.VoteGroupRole(m.repo.ctx, m.repo.siteID(), userID) } func (m moduleData) SeenAddress(user *db.User) error { @@ -312,7 +312,7 @@ func UserJSON(ctx context.Context, d *db.DB, u *db.User) (wikijson.Object, error if u == nil { return pageconfig.SystemUserJSON().Object(), nil } - userRoles, err := d.RolesByUser(ctx, u.ID) + userRoles, err := d.RolesByUser(ctx, ctxSiteID(ctx), u.ID) if err != nil { return nil, err } @@ -385,7 +385,7 @@ func (m moduleData) MemberCount(roleID *int64) (int, error) { } func (m moduleData) RoleByRef(ref string) (*roles.Role, error) { - return m.repo.db.RoleByRef(m.repo.ctx, ref) + return m.repo.db.RoleByRef(m.repo.ctx, m.repo.siteID(), ref) } func (m moduleData) ForumPostVersions(postID int64) ([]db.ForumPostVersion, error) { diff --git a/internal/repo/perms.go b/internal/repo/perms.go index 2beb7b30..0f4198e6 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -31,7 +31,7 @@ func (p *Perms) Subject(u *db.User, now time.Time) (perms.Subject, error) { if u != nil { slugs = append(slugs, slugRegistered) } - bySlug, err := p.db.RoleIDsBySlug(p.ctx, slugs) + bySlug, err := p.db.RoleIDsBySlug(p.ctx, ctxSiteID(p.ctx), slugs) if err != nil { return perms.Subject{}, err } @@ -44,7 +44,7 @@ func (p *Perms) Subject(u *db.User, now time.Time) (perms.Subject, error) { if id, ok := bySlug[slugRegistered]; ok { ids = append(ids, id) } - own, err := p.db.RoleIDsForUser(p.ctx, u.ID) + own, err := p.db.RoleIDsForUser(p.ctx, ctxSiteID(p.ctx), u.ID) if err != nil { return perms.Subject{}, err } @@ -135,3 +135,12 @@ func (p *Perms) ForumPost(post *db.ForumThreadPost, thread *perms.Object, u *db. } return object } + +// A request that carries no site resolves no roles, which leaves a caller that +// forgot one with nothing rather than with another site's rows. +func ctxSiteID(ctx context.Context) int64 { + if current := site.FromContext(ctx); current != nil { + return current.ID + } + return 0 +} diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 2f3d898f..149e16a3 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -171,7 +171,7 @@ func (r *Repository) RenderUser(username string, avatar bool) (string, error) { } func (r *Repository) renderUser(user *db.User, opts printuser.Options) (string, error) { - roleList, err := r.db.RolesByUser(r.ctx, user.ID) + roleList, err := r.db.RolesByUser(r.ctx, r.siteID(), user.ID) if err != nil { return "", err } @@ -192,3 +192,10 @@ func cutPrefixFold(s, prefix string) (string, bool) { } return s[len(prefix):], true } + +func (r *Repository) siteID() int64 { + if r.opts.Site == nil { + return 0 + } + return r.opts.Site.ID +} diff --git a/internal/repo/users.go b/internal/repo/users.go index f81986ba..9bbd1956 100644 --- a/internal/repo/users.go +++ b/internal/repo/users.go @@ -16,11 +16,11 @@ func UsersJSON(ctx context.Context, d *db.DB, users []db.User, now time.Time) (w for i := range users { ids = append(ids, users[i].ID) } - byUser, err := d.RolesByUsers(ctx, ids) + byUser, err := d.RolesByUsers(ctx, ctxSiteID(ctx), ids) if err != nil { return nil, err } - bySlug, err := d.RoleIDsBySlug(ctx, []string{slugEveryone, slugRegistered}) + bySlug, err := d.RoleIDsBySlug(ctx, ctxSiteID(ctx), []string{slugEveryone, slugRegistered}) if err != nil { return nil, err } diff --git a/internal/userpage/reactivepage.go b/internal/userpage/reactivepage.go index 139ca560..460f8327 100644 --- a/internal/userpage/reactivepage.go +++ b/internal/userpage/reactivepage.go @@ -114,7 +114,7 @@ func (h *ReactiveHandler) page(r *http.Request, current *db.Site, viewer *db.Use func (h *ReactiveHandler) config(r *http.Request, viewer *db.User) (string, error) { ctx := r.Context() - userRoles, err := h.deps.DB.RolesByUser(ctx, viewer.ID) + userRoles, err := h.deps.DB.RolesByUser(ctx, siteID(ctx), viewer.ID) if err != nil { return "", err } diff --git a/internal/userpage/userpage.go b/internal/userpage/userpage.go index 47182d29..84cc4ab4 100644 --- a/internal/userpage/userpage.go +++ b/internal/userpage/userpage.go @@ -343,7 +343,7 @@ func (h *Handler) posts(r *http.Request, loc *i18n.Localizer, site *db.Site, } func (h *Handler) roles(ctx context.Context, site *db.Site, profile *db.Profile) ([]shell.ProfileRoles, error) { - rs, err := h.deps.DB.RolesByUser(ctx, profile.ID) + rs, err := h.deps.DB.RolesByUser(ctx, site.ID, profile.ID) if err != nil { return nil, err } @@ -412,7 +412,7 @@ func (h *Handler) titles(ctx context.Context, loc *i18n.Localizer, profile *db.P case profile.Type == printuser.TypeBot: return []string{loc.T("user-bot-title")}, nil } - rs, err := h.deps.DB.RolesByUser(ctx, profile.ID) + rs, err := h.deps.DB.RolesByUser(ctx, siteID(ctx), profile.ID) if err != nil { return nil, err } @@ -475,3 +475,10 @@ func notFound(w http.ResponseWriter, body string) { w.WriteHeader(http.StatusNotFound) _, _ = w.Write([]byte(body)) } + +func siteID(ctx context.Context) int64 { + if current := site.FromContext(ctx); current != nil { + return current.ID + } + return 0 +} From 3abae173a3db2aa1a3c615e36c19ee9b2d5e90ed Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 22:58:12 +0900 Subject: [PATCH 343/428] give a new site its built-in roles --- internal/db/site.go | 12 ------------ internal/db/site_test.go | 12 ------------ internal/db/site_write.go | 41 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+), 24 deletions(-) diff --git a/internal/db/site.go b/internal/db/site.go index ace4a377..c4bad54e 100644 --- a/internal/db/site.go +++ b/internal/db/site.go @@ -70,18 +70,6 @@ func (d *DB) SiteByHosts(ctx context.Context, hosts []string) (*Site, error) { return nil, ErrNotFound } -var qAnySite = register("AnySite", `SELECT EXISTS(SELECT 1 FROM web_site)`) - -// AnySite separates "this domain is not configured" from "nothing is set up -// yet"; the two lead to different responses. -func (d *DB) AnySite(ctx context.Context) (bool, error) { - var exists bool - if err := d.pool.QueryRow(ctx, qAnySite).Scan(&exists); err != nil { - return false, fmt.Errorf("check any site exists: %w", err) - } - return exists, nil -} - var qSiteHostExists = register("SiteHostExists", ` SELECT EXISTS(SELECT 1 FROM web_site WHERE lower(domain) = $1 OR lower(media_domain) = $1)`) diff --git a/internal/db/site_test.go b/internal/db/site_test.go index c9992d39..78e3d534 100644 --- a/internal/db/site_test.go +++ b/internal/db/site_test.go @@ -48,18 +48,6 @@ func TestSiteByHostsUnknownHost(t *testing.T) { } } -func TestAnySite(t *testing.T) { - d := newTestDB(t) - - got, err := d.AnySite(context.Background()) - if err != nil { - t.Fatalf("AnySite() err = %v, want nil", err) - } - if !got { - t.Error("AnySite() = false, want true") - } -} - func TestSiteHostExistsAcceptsBothDomainsAndRejectsStrangers(t *testing.T) { d := newTestDB(t) ctx := context.Background() diff --git a/internal/db/site_write.go b/internal/db/site_write.go index c532c74f..e713c932 100644 --- a/internal/db/site_write.go +++ b/internal/db/site_write.go @@ -3,6 +3,8 @@ package db import ( "context" "fmt" + + "github.com/WikitTeam/ProjectWikit/internal/perms" ) type NewSite struct { @@ -24,6 +26,32 @@ var qInsertSiteSettings = register("InsertSiteSettings", ` INSERT INTO web_settings (site_id, category_id, rating_mode, can_user_create_tags) VALUES ($1, NULL, 'default', 'default')`) +var qInsertBuiltInRole = register("InsertBuiltInRole", ` +INSERT INTO web_role (site_id, slug, index, name, short_name, is_staff, group_votes, + votes_title, inline_visual_mode, profile_visual_mode, color, + icon, badge_text, badge_bg, badge_text_color, badge_show_border) +VALUES ($1, $2, $3, '', '', false, false, '', 'hidden', 'hidden', '#000000', + '', '', '#808080', '#ffffff', false) +RETURNING id`) + +// The permission resolver looks both of these up by slug, so a site without +// them answers every question with no rights at all. +var builtInRoles = []struct { + slug string + index int + permissions []string +}{ + {slug: "registered", index: 1}, + {slug: "everyone", index: 2, permissions: []string{ + perms.ViewArticles, + perms.ViewArticleComments, + perms.ViewForumSections, + perms.ViewForumCategories, + perms.ViewForumThreads, + perms.ViewForumPosts, + }}, +} + func (d *DB) CreateSite(ctx context.Context, s NewSite) (int64, error) { tx, err := d.pool.Begin(ctx) if err != nil { @@ -39,6 +67,19 @@ func (d *DB) CreateSite(ctx context.Context, s NewSite) (int64, error) { if _, err := tx.Exec(ctx, qInsertSiteSettings, id); err != nil { return 0, fmt.Errorf("create settings for site %q: %w", s.Slug, err) } + for _, built := range builtInRoles { + var roleID int64 + err := tx.QueryRow(ctx, qInsertBuiltInRole, id, built.slug, built.index).Scan(&roleID) + if err != nil { + return 0, fmt.Errorf("create role %q for site %q: %w", built.slug, s.Slug, err) + } + if len(built.permissions) == 0 { + continue + } + if _, err := tx.Exec(ctx, qGrantRolePermission, roleID, built.permissions); err != nil { + return 0, fmt.Errorf("grant %q on site %q: %w", built.slug, s.Slug, err) + } + } if err := tx.Commit(ctx); err != nil { return 0, fmt.Errorf("commit site %q: %w", s.Slug, err) } From 0ffc210d66c8ce3072f492c92b13ddd37e4a0f35 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 22:58:12 +0900 Subject: [PATCH 344/428] let one database hold more than one site --- cmd/pwikit/main.go | 8 -------- 1 file changed, 8 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 0b231758..2c81ff74 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -454,14 +454,6 @@ func createSite(args []string) error { } defer conn.Close() - taken, err := conn.AnySite(ctx) - if err != nil { - return err - } - if taken { - return errors.New("this database already holds a site, and one database serves one site") - } - id, err := conn.CreateSite(ctx, db.NewSite{ Slug: *slug, Title: *title, Headline: *headline, Domain: *domain, MediaDomain: *mediaDomain, From 559b097b3d7c26e2fd44c04a0310729ddf472a3c Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 7 Sep 2026 23:50:22 +0900 Subject: [PATCH 345/428] look pages up inside one site --- cmd/pwikit/main.go | 29 ++++++++++++- cmd/pwikit/render.go | 16 ++++---- internal/articlepage/build.go | 2 +- internal/articlepage/render.go | 6 +-- internal/db/article.go | 12 +++--- internal/db/article_row.go | 6 +-- internal/db/article_row_test.go | 6 +-- internal/db/article_test.go | 10 ++--- internal/db/article_write.go | 8 ++-- internal/db/article_write_test.go | 32 +++++++-------- internal/db/chrome_test.go | 2 +- internal/db/site.go | 56 +++++++++++++++++++++++--- internal/db/site_scope_pending_test.go | 4 -- internal/db/tag_write_test.go | 2 +- internal/listpages/params_db_test.go | 2 +- internal/listpages/sitehelp_test.go | 22 ++++++++++ internal/localitem/localitem.go | 2 +- internal/modules/rate_db_test.go | 2 +- internal/modules/sitehelp_test.go | 22 ++++++++++ internal/page/corpus_test.go | 2 +- internal/page/sitehelp_test.go | 22 ++++++++++ internal/repo/countpages_test.go | 2 +- internal/repo/form.go | 2 +- internal/repo/forumcategory_test.go | 2 +- internal/repo/forumnewthread_test.go | 2 +- internal/repo/forumstart_test.go | 2 +- internal/repo/forumthread_test.go | 4 +- internal/repo/listusers_test.go | 2 +- internal/repo/modules.go | 2 +- internal/repo/nested_modules_test.go | 2 +- internal/repo/recentposts_test.go | 2 +- internal/repo/repo.go | 4 +- internal/repo/sitechanges_test.go | 2 +- internal/repo/sitehelp_test.go | 22 ++++++++++ internal/repo/tagcloud_test.go | 2 +- internal/repo/wantedpages_test.go | 2 +- internal/seed/seed.go | 14 +++---- internal/seed/seed_test.go | 8 ++-- internal/webapi/articles.go | 4 +- internal/webapi/create.go | 6 +-- internal/webapi/preview.go | 4 +- internal/webapi/subscribe.go | 2 +- internal/webapi/update.go | 6 +-- internal/webapi/webapi.go | 10 ++++- 44 files changed, 268 insertions(+), 105 deletions(-) create mode 100644 internal/listpages/sitehelp_test.go create mode 100644 internal/modules/sitehelp_test.go create mode 100644 internal/page/sitehelp_test.go create mode 100644 internal/repo/sitehelp_test.go diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 2c81ff74..9ec9bb04 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -388,6 +388,7 @@ func envOr(key, fallback string) string { func seedPages(args []string) error { fs := flag.NewFlagSet("seed", flag.ContinueOnError) database := fs.String("database", os.Getenv(envDatabase), "PostgreSQL connection string") + slug := fs.String("site", "", "slug of the site to write into; needed once a database holds more than one") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -405,7 +406,12 @@ func seedPages(args []string) error { } defer conn.Close() - written, err := seed.Run(ctx, conn) + current, err := resolveSite(ctx, conn, *slug) + if err != nil { + return err + } + + written, err := seed.Run(ctx, conn, current.ID) for _, name := range written { fmt.Println("wrote " + name) } @@ -547,3 +553,24 @@ func printModules() error { } return w.Flush() } + +func resolveSite(ctx context.Context, conn *db.DB, slug string) (*db.Site, error) { + if slug != "" { + found, err := conn.SiteBySlug(ctx, slug) + if errors.Is(err, db.ErrNotFound) { + return nil, fmt.Errorf("no site with slug %q", slug) + } + return found, err + } + slugs, err := conn.SiteSlugs(ctx) + if err != nil { + return nil, err + } + switch len(slugs) { + case 0: + return nil, errors.New("this database holds no site, make one with createsite") + case 1: + return conn.SiteBySlug(ctx, slugs[0]) + } + return nil, fmt.Errorf("this database holds %d sites, name one with -site", len(slugs)) +} diff --git a/cmd/pwikit/render.go b/cmd/pwikit/render.go index 76efe434..9ae19f58 100644 --- a/cmd/pwikit/render.go +++ b/cmd/pwikit/render.go @@ -85,7 +85,11 @@ func render(args []string) error { } users := printuser.New(bundle.Localizer(i18n.DefaultLanguage), roles.FileIcons(p.Files())) store.data = repo.New(ctx, conn, users, repo.Options{Loc: bundle.Localizer(i18n.DefaultLanguage)}) - vars, article, err = cliPageVars(ctx, conn, bundle.Localizer(i18n.DefaultLanguage), *category, *pageName, *domain) + current, err := resolveSite(ctx, conn, *siteSlug) + if err != nil { + return err + } + vars, article, err = cliPageVars(ctx, conn, bundle.Localizer(i18n.DefaultLanguage), current, *category, *pageName) if err != nil { return err } @@ -114,23 +118,19 @@ func render(args []string) error { // cliPageVars resolves the page being rendered to a real row when there is one, // so %%this|x%% answers with that page rather than staying put. -func cliPageVars(ctx context.Context, conn *db.DB, loc *i18n.Localizer, category, name, domain string) (*page.Vars, *db.Article, error) { +func cliPageVars(ctx context.Context, conn *db.DB, loc *i18n.Localizer, current *db.Site, category, name string) (*page.Vars, *db.Article, error) { ref := name if category != db.DefaultCategory { ref = category + ":" + name } - article, err := conn.ArticleByName(ctx, ref) + article, err := conn.ArticleByName(ctx, current.ID, ref) if errors.Is(err, db.ErrNotFound) { return nil, nil, nil } if err != nil { return nil, nil, err } - site, err := conn.SiteByHosts(ctx, []string{domain}) - if err != nil { - site = nil - } - return page.NewVars(article, nil, repo.NewVarSource(ctx, conn, site), loc), article, nil + return page.NewVars(article, nil, repo.NewVarSource(ctx, conn, current), loc), article, nil } func readSource(file string) (string, error) { diff --git a/internal/articlepage/build.go b/internal/articlepage/build.go index 4d2e8d40..fb9e5c44 100644 --- a/internal/articlepage/build.go +++ b/internal/articlepage/build.go @@ -85,7 +85,7 @@ func (h *Handler) build(r *http.Request) (*result, error) { // A page the visitor may not see is dropped here, which is what leaves every // layer below working on nothing at all. func (h *Handler) load(req *request) error { - found, err := h.deps.DB.ArticleByName(req.ctx, req.name) + found, err := h.deps.DB.ArticleByName(req.ctx, req.site.ID, req.name) if err != nil && !errors.Is(err, db.ErrNotFound) { return err } diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index c3df68c5..cc1210c0 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -158,7 +158,7 @@ func (h *Handler) source(req *request) (string, error) { if req.article.Name == templateName { return "%%content%%", nil } - found, err := h.deps.DB.ArticleByName(req.ctx, req.article.Category+":"+templateName) + found, err := h.deps.DB.ArticleByName(req.ctx, req.site.ID, req.article.Category+":"+templateName) if errors.Is(err, db.ErrNotFound) { return "%%content%%", nil } @@ -219,7 +219,7 @@ func (h *Handler) notFoundPage(req *request) (*body, error) { } for _, name := range notFoundNames(req.name) { - found, err := h.deps.DB.ArticleByName(req.ctx, name) + found, err := h.deps.DB.ArticleByName(req.ctx, req.site.ID, name) if errors.Is(err, db.ErrNotFound) { continue } @@ -309,7 +309,7 @@ func missingName(fullName string) func(string) (string, bool) { // nav renders one of the two navigation pages. It gets its own callbacks and // its own PageInfo, since the page it decorates is a different row. func (h *Handler) nav(req *request, name string) (string, string, error) { - found, err := h.deps.DB.ArticleByName(req.ctx, name) + found, err := h.deps.DB.ArticleByName(req.ctx, req.site.ID, name) if errors.Is(err, db.ErrNotFound) { return "", "", nil } diff --git a/internal/db/article.go b/internal/db/article.go index ec6736f9..9c6e791e 100644 --- a/internal/db/article.go +++ b/internal/db/article.go @@ -27,17 +27,17 @@ func dumbNames(refs []string) []string { var qArticleTitles = register("ArticleTitles", ` SELECT complete_full_name, title FROM web_article -WHERE complete_full_name = ANY($1)`) +WHERE site_id = $1 AND complete_full_name = ANY($2)`) // ArticleTitles keys its result by the caller's own ref strings. Refs with no // article are absent from the map rather than present-and-empty: fetch_internal_links // drops missing pages instead of reporting them as non-existent. -func (d *DB) ArticleTitles(ctx context.Context, refs []string) (map[string]string, error) { +func (d *DB) ArticleTitles(ctx context.Context, siteID int64, refs []string) (map[string]string, error) { if len(refs) == 0 { return map[string]string{}, nil } - rows, err := d.pool.Query(ctx, qArticleTitles, dumbNames(refs)) + rows, err := d.pool.Query(ctx, qArticleTitles, siteID, dumbNames(refs)) if err != nil { return nil, fmt.Errorf("query article titles: %w", err) } @@ -68,17 +68,17 @@ var qArticleSources = register("ArticleSources", ` SELECT DISTINCT ON (a.id) a.complete_full_name, v.source FROM web_articleversion v JOIN web_article a ON a.id = v.article_id -WHERE a.complete_full_name = ANY($1) +WHERE a.site_id = $1 AND a.complete_full_name = ANY($2) ORDER BY a.id, v.created_at DESC`) // ArticleSources returns the newest version's source per article, keyed by the // caller's own ref strings. -func (d *DB) ArticleSources(ctx context.Context, refs []string) (map[string]string, error) { +func (d *DB) ArticleSources(ctx context.Context, siteID int64, refs []string) (map[string]string, error) { if len(refs) == 0 { return map[string]string{}, nil } - rows, err := d.pool.Query(ctx, qArticleSources, dumbNames(refs)) + rows, err := d.pool.Query(ctx, qArticleSources, siteID, dumbNames(refs)) if err != nil { return nil, fmt.Errorf("query article sources: %w", err) } diff --git a/internal/db/article_row.go b/internal/db/article_row.go index 873377d9..1b0448e6 100644 --- a/internal/db/article_row.go +++ b/internal/db/article_row.go @@ -49,13 +49,13 @@ const prefixedArticleColumns = `a.id, a.category, a.name, a.title, a.parent_id, var qArticleByName = register("ArticleByName", ` SELECT `+articleColumns+` FROM web_article -WHERE complete_full_name = $1`) +WHERE site_id = $1 AND complete_full_name = $2`) // ArticleByName takes a page reference the way a URL spells it; dumbName puts // the implicit category back so the generated column can match. -func (d *DB) ArticleByName(ctx context.Context, ref string) (*Article, error) { +func (d *DB) ArticleByName(ctx context.Context, siteID int64, ref string) (*Article, error) { var a Article - err := d.pool.QueryRow(ctx, qArticleByName, dumbName(ref)).Scan( + err := d.pool.QueryRow(ctx, qArticleByName, siteID, dumbName(ref)).Scan( &a.ID, &a.Category, &a.Name, &a.Title, &a.ParentID, &a.Locked, &a.CreatedAt, &a.UpdatedAt, &a.MediaName) if errors.Is(err, pgx.ErrNoRows) { diff --git a/internal/db/article_row_test.go b/internal/db/article_row_test.go index dc6be380..1e53b018 100644 --- a/internal/db/article_row_test.go +++ b/internal/db/article_row_test.go @@ -42,7 +42,7 @@ func TestArticleDisplayName(t *testing.T) { func TestArticleByName(t *testing.T) { d := newTestDB(t) - got, err := d.ArticleByName(context.Background(), "main") + got, err := d.ArticleByName(context.Background(), seedSiteID(t, d), "main") if err != nil { t.Fatalf("ArticleByName(%q) err = %v, want nil", "main", err) } @@ -60,7 +60,7 @@ func TestArticleByName(t *testing.T) { func TestArticleByNameIsCaseInsensitive(t *testing.T) { d := newTestDB(t) - got, err := d.ArticleByName(context.Background(), "NAV:Top") + got, err := d.ArticleByName(context.Background(), seedSiteID(t, d), "NAV:Top") if err != nil { t.Fatalf("ArticleByName(%q) err = %v, want nil", "NAV:Top", err) } @@ -72,7 +72,7 @@ func TestArticleByNameIsCaseInsensitive(t *testing.T) { func TestArticleByNameMissing(t *testing.T) { d := newTestDB(t) - _, err := d.ArticleByName(context.Background(), "no-such-page") + _, err := d.ArticleByName(context.Background(), seedSiteID(t, d), "no-such-page") if !errors.Is(err, ErrNotFound) { t.Errorf("ArticleByName(%q) err = %v, want ErrNotFound", "no-such-page", err) } diff --git a/internal/db/article_test.go b/internal/db/article_test.go index 8b038553..e5a2d4c4 100644 --- a/internal/db/article_test.go +++ b/internal/db/article_test.go @@ -25,7 +25,7 @@ func TestDumbName(t *testing.T) { func TestArticleTitlesKeysByCallerRef(t *testing.T) { d := newTestDB(t) - got, err := d.ArticleTitles(context.Background(), []string{"main", "NAV:Top", "no-such-page"}) + got, err := d.ArticleTitles(context.Background(), seedSiteID(t, d), []string{"main", "NAV:Top", "no-such-page"}) if err != nil { t.Fatalf("ArticleTitles() err = %v, want nil", err) } @@ -46,7 +46,7 @@ func TestArticleTitlesKeysByCallerRef(t *testing.T) { func TestArticleTitlesEmptyRefs(t *testing.T) { d := newTestDB(t) - got, err := d.ArticleTitles(context.Background(), nil) + got, err := d.ArticleTitles(context.Background(), seedSiteID(t, d), nil) if err != nil { t.Fatalf("ArticleTitles(nil) err = %v, want nil", err) } @@ -58,7 +58,7 @@ func TestArticleTitlesEmptyRefs(t *testing.T) { func TestArticleSourcesReturnsSource(t *testing.T) { d := newTestDB(t) - got, err := d.ArticleSources(context.Background(), []string{"main", "nav:top"}) + got, err := d.ArticleSources(context.Background(), seedSiteID(t, d), []string{"main", "nav:top"}) if err != nil { t.Fatalf("ArticleSources() err = %v, want nil", err) } @@ -74,7 +74,7 @@ func TestSourceAtRevisionMatchesLatestOnTheOnlyRevision(t *testing.T) { ctx := context.Background() d := newTestDB(t) - article, err := d.ArticleByName(ctx, "probeoff:unratable") + article, err := d.ArticleByName(ctx, seedSiteID(t, d), "probeoff:unratable") if err != nil { t.Fatalf("ArticleByName(probeoff:unratable) err = %v, want nil", err) } @@ -95,7 +95,7 @@ func TestSourceAtRevisionOfRevisionThatIsNotThere(t *testing.T) { ctx := context.Background() d := newTestDB(t) - article, err := d.ArticleByName(ctx, "probeoff:unratable") + article, err := d.ArticleByName(ctx, seedSiteID(t, d), "probeoff:unratable") if err != nil { t.Fatalf("ArticleByName(probeoff:unratable) err = %v, want nil", err) } diff --git a/internal/db/article_write.go b/internal/db/article_write.go index d26a1ca6..d3fbceee 100644 --- a/internal/db/article_write.go +++ b/internal/db/article_write.go @@ -142,8 +142,8 @@ func (d *DB) ReplaceArticleLinks(ctx context.Context, from string, links []Artic var ( qInsertArticle = register("InsertArticle", ` -INSERT INTO web_article (category, name, title, locked, created_at, updated_at, media_name) -VALUES ($1, $2, $3, false, $4, $4, $5) +INSERT INTO web_article (site_id, category, name, title, locked, created_at, updated_at, media_name) +VALUES ($1, $2, $3, $4, false, $5, $5, $6) RETURNING id`) qInsertArticleAuthor = register("InsertArticleAuthor", ` @@ -152,7 +152,7 @@ VALUES ($1, $2) ON CONFLICT DO NOTHING`) ) -func (d *DB) CreateArticle(ctx context.Context, category, name, title string, authorID *int64, at time.Time) (int64, error) { +func (d *DB) CreateArticle(ctx context.Context, siteID int64, category, name, title string, authorID *int64, at time.Time) (int64, error) { media, err := mediaName() if err != nil { return 0, err @@ -165,7 +165,7 @@ func (d *DB) CreateArticle(ctx context.Context, category, name, title string, au defer tx.Rollback(ctx) var id int64 - if err := tx.QueryRow(ctx, qInsertArticle, category, name, title, at, media).Scan(&id); err != nil { + if err := tx.QueryRow(ctx, qInsertArticle, siteID, category, name, title, at, media).Scan(&id); err != nil { return 0, fmt.Errorf("write article %q: %w", name, err) } if authorID != nil { diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go index a0a3d77f..f1a89dc6 100644 --- a/internal/db/article_write_test.go +++ b/internal/db/article_write_test.go @@ -321,7 +321,7 @@ func TestCreateArticleCreditsTheAuthor(t *testing.T) { } name := "probe-new-" + time.Now().Format("20060102150405.000000") - id, err := d.CreateArticle(ctx, "_default", name, "Probe", &author, time.Now().UTC()) + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", name, "Probe", &author, time.Now().UTC()) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) } @@ -343,7 +343,7 @@ func TestCreateArticleWithoutAnAuthor(t *testing.T) { ctx := context.Background() name := "probe-new-" + time.Now().Format("20060102150405.000000") - id, err := d.CreateArticle(ctx, "_default", name, "Probe", nil, time.Now().UTC()) + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", name, "Probe", nil, time.Now().UTC()) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) } @@ -366,12 +366,12 @@ func TestCreateArticleNamesTheMediaDirectoryApart(t *testing.T) { ctx := context.Background() stamp := time.Now().Format("20060102150405.000000") - first, err := d.CreateArticle(ctx, "_default", "probe-media-a-"+stamp, "A", nil, time.Now().UTC()) + first, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-media-a-"+stamp, "A", nil, time.Now().UTC()) if err != nil { t.Fatalf("CreateArticle(a) err = %v, want nil", err) } dropArticle(t, d, first) - second, err := d.CreateArticle(ctx, "_default", "probe-media-b-"+stamp, "B", nil, time.Now().UTC()) + second, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-media-b-"+stamp, "B", nil, time.Now().UTC()) if err != nil { t.Fatalf("CreateArticle(b) err = %v, want nil", err) } @@ -398,12 +398,12 @@ func TestSetArticleParentRecordsTheMove(t *testing.T) { at := time.Now().UTC().Truncate(time.Second) stamp := time.Now().Format("20060102150405.000000") - parent, err := d.CreateArticle(ctx, "_default", "probe-parent-"+stamp, "Parent", nil, at) + parent, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-parent-"+stamp, "Parent", nil, at) if err != nil { t.Fatalf("CreateArticle(parent) err = %v, want nil", err) } dropArticle(t, d, parent) - child, err := d.CreateArticle(ctx, "_default", "probe-child-"+stamp, "Child", nil, at) + child, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-child-"+stamp, "Child", nil, at) if err != nil { t.Fatalf("CreateArticle(child) err = %v, want nil", err) } @@ -445,7 +445,7 @@ func TestSubscribeToArticleOnlyOnce(t *testing.T) { if err := d.pool.QueryRow(ctx, `SELECT id FROM web_user ORDER BY id LIMIT 1`).Scan(&user); err != nil { t.Fatalf("read a user err = %v, want nil", err) } - id, err := d.CreateArticle(ctx, "_default", + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-sub-"+time.Now().Format("20060102150405.000000"), "Probe", nil, time.Now().UTC()) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) @@ -480,7 +480,7 @@ func TestUpdateArticleTitleRecordsWhatItWas(t *testing.T) { ctx := context.Background() at := time.Now().UTC().Truncate(time.Second) - id, err := d.CreateArticle(ctx, "_default", + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-title-"+time.Now().Format("20060102150405.000000"), "Before", nil, at) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) @@ -529,7 +529,7 @@ func TestSetArticleLockLeavesNoRevision(t *testing.T) { d := writeTestDB(t) ctx := context.Background() - id, err := d.CreateArticle(ctx, "_default", + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-lock-"+time.Now().Format("20060102150405.000000"), "Probe", nil, time.Now().UTC()) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) @@ -605,7 +605,7 @@ func TestSetArticleAuthorsReplacesTheCredit(t *testing.T) { first, second := twoUsers(t, d) at := time.Now().UTC().Truncate(time.Second) - id, err := d.CreateArticle(ctx, "_default", + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-authors-"+time.Now().Format("20060102150405.000000"), "Probe", &first, at) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) @@ -651,7 +651,7 @@ func TestSetArticleAuthorsKeepsQuietWhenNothingMoves(t *testing.T) { first, _ := twoUsers(t, d) at := time.Now().UTC().Truncate(time.Second) - id, err := d.CreateArticle(ctx, "_default", + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-samecredit-"+time.Now().Format("20060102150405.000000"), "Probe", &first, at) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) @@ -673,7 +673,7 @@ func TestSetArticleAuthorsIgnoresAnEmptyList(t *testing.T) { first, _ := twoUsers(t, d) at := time.Now().UTC().Truncate(time.Second) - id, err := d.CreateArticle(ctx, "_default", + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-nocredit-"+time.Now().Format("20060102150405.000000"), "Probe", &first, at) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) @@ -696,7 +696,7 @@ func TestRenameArticleTakesItsLinksAlong(t *testing.T) { from := "probe-from-" + stamp to := "probe-to-" + stamp - id, err := d.CreateArticle(ctx, "_default", from, "Probe", nil, at) + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", from, "Probe", nil, at) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) } @@ -763,7 +763,7 @@ func TestRenameArticleClearsWhatSatUnderTheNewName(t *testing.T) { from := "probe-old-" + stamp to := "probe-new-" + stamp - id, err := d.CreateArticle(ctx, "_default", from, "Probe", nil, at) + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", from, "Probe", nil, at) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) } @@ -807,7 +807,7 @@ func TestDeleteArticleTakesEverythingThatPointsAtIt(t *testing.T) { if err := d.pool.QueryRow(ctx, `SELECT id FROM web_user ORDER BY id LIMIT 1`).Scan(&author); err != nil { t.Fatalf("read a user err = %v, want nil", err) } - id, err := d.CreateArticle(ctx, "_default", name, "Probe", &author, at) + id, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", name, "Probe", &author, at) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) } @@ -823,7 +823,7 @@ func TestDeleteArticleTakesEverythingThatPointsAtIt(t *testing.T) { t.Fatalf("ReplaceArticleLinks() err = %v, want nil", err) } - child, err := d.CreateArticle(ctx, "_default", "probe-orphan-"+stamp, "Child", nil, at) + child, err := d.CreateArticle(ctx, seedSiteID(t, d), "_default", "probe-orphan-"+stamp, "Child", nil, at) if err != nil { t.Fatalf("CreateArticle(child) err = %v, want nil", err) } diff --git a/internal/db/chrome_test.go b/internal/db/chrome_test.go index 06c81090..e69d729a 100644 --- a/internal/db/chrome_test.go +++ b/internal/db/chrome_test.go @@ -7,7 +7,7 @@ import ( func articleID(t *testing.T, d *DB, ref string) int64 { t.Helper() - a, err := d.ArticleByName(context.Background(), ref) + a, err := d.ArticleByName(context.Background(), seedSiteID(t, d), ref) if err != nil { t.Fatalf("ArticleByName(%q) err = %v, want nil", ref, err) } diff --git a/internal/db/site.go b/internal/db/site.go index c4bad54e..9df058bf 100644 --- a/internal/db/site.go +++ b/internal/db/site.go @@ -47,18 +47,62 @@ WHERE domain = $1 OR media_domain = $1 ORDER BY id LIMIT 1`) +func scanSite(row pgx.Row, s *Site) error { + return row.Scan( + &s.ID, &s.Slug, &s.Title, &s.Headline, &s.Domain, &s.MediaDomain, &s.HomePage, + &s.Icon, &s.ThemeID, &s.SystemThemeID, + &s.AuthIcon, &s.FooterLicense, &s.SignupNotice, &s.PasswordHelp, + &s.MembershipPasswordEnabled, &s.MembershipPassword, &s.MembershipPasswordRoleID, + &s.DefaultRoleID, &s.VerifiedRoleID, &s.EmailPolicy) +} + +var qSiteBySlug = register("SiteBySlug", ` +SELECT id, slug, title, headline, domain, media_domain, home_page, COALESCE(icon, ''), active_theme_id, + system_theme_id, COALESCE(auth_icon, ''), footer_license, signup_notice, password_help, + membership_password_enabled, membership_password, membership_password_role_id, + default_role_id, verified_role_id, email_policy +FROM web_site +WHERE slug = $1`) + +var qSiteSlugs = register("SiteSlugs", `SELECT slug FROM web_site ORDER BY id`) + +func (d *DB) SiteBySlug(ctx context.Context, slug string) (*Site, error) { + var s Site + err := scanSite(d.pool.QueryRow(ctx, qSiteBySlug, slug), &s) + if errors.Is(err, pgx.ErrNoRows) { + return nil, ErrNotFound + } + if err != nil { + return nil, fmt.Errorf("look up site %q: %w", slug, err) + } + return &s, nil +} + +func (d *DB) SiteSlugs(ctx context.Context) ([]string, error) { + rows, err := d.pool.Query(ctx, qSiteSlugs) + if err != nil { + return nil, fmt.Errorf("list sites: %w", err) + } + defer rows.Close() + + var out []string + for rows.Next() { + var slug string + if err := rows.Scan(&slug); err != nil { + return nil, err + } + out = append(out, slug) + } + return out, rows.Err() +} + // SiteByHosts tries each host in turn and returns the first that matches. // Callers pass site.LookupHosts, whose ordering carries the host:port round // that has to run before the bare-host one. func (d *DB) SiteByHosts(ctx context.Context, hosts []string) (*Site, error) { for _, host := range hosts { var s Site - err := d.pool.QueryRow(ctx, qSiteByHost, host).Scan( - &s.ID, &s.Slug, &s.Title, &s.Headline, &s.Domain, &s.MediaDomain, &s.HomePage, - &s.Icon, &s.ThemeID, &s.SystemThemeID, - &s.AuthIcon, &s.FooterLicense, &s.SignupNotice, &s.PasswordHelp, - &s.MembershipPasswordEnabled, &s.MembershipPassword, &s.MembershipPasswordRoleID, - &s.DefaultRoleID, &s.VerifiedRoleID, &s.EmailPolicy) + err := scanSite(d.pool.QueryRow(ctx, qSiteByHost, host), &s) if errors.Is(err, pgx.ErrNoRows) { continue } diff --git a/internal/db/site_scope_pending_test.go b/internal/db/site_scope_pending_test.go index 07142336..1d63e794 100644 --- a/internal/db/site_scope_pending_test.go +++ b/internal/db/site_scope_pending_test.go @@ -31,16 +31,13 @@ var siteScopePending = []string{ "AdminTickets", "AllTags", "ArticleByID", - "ArticleByName", "ArticleCategories", "ArticleChildren", "ArticleFile", "ArticleLastComment", - "ArticleSources", "ArticleTagCategories", "ArticleTagNames", "ArticleTags", - "ArticleTitles", "ArticleVotes", "ArticlesByTag", "Breadcrumbs", @@ -95,7 +92,6 @@ var siteScopePending = []string{ "ForumThreadsByStart", "ForumThreadsInCategories", "GrantTicketRole", - "InsertArticle", "InsertCategory", "InsertForumSection", "InsertForumThread", diff --git a/internal/db/tag_write_test.go b/internal/db/tag_write_test.go index 0308076e..91f455cb 100644 --- a/internal/db/tag_write_test.go +++ b/internal/db/tag_write_test.go @@ -34,7 +34,7 @@ ORDER BY c.slug, t.name`, articleID) func scratchTagged(t *testing.T, d *DB) int64 { t.Helper() - id, err := d.CreateArticle(context.Background(), "_default", + id, err := d.CreateArticle(context.Background(), seedSiteID(t, d), "_default", "probe-tags-"+time.Now().Format("20060102150405.000000"), "Probe", nil, time.Now().UTC()) if err != nil { t.Fatalf("CreateArticle() err = %v, want nil", err) diff --git a/internal/listpages/params_db_test.go b/internal/listpages/params_db_test.go index a92b087f..e8dcf092 100644 --- a/internal/listpages/params_db_test.go +++ b/internal/listpages/params_db_test.go @@ -136,7 +136,7 @@ func (s dbSource) ArticleTagIDs(articleID int64) ([]int64, error) { } func (s dbSource) ArticleByRef(ref string) (*db.Article, error) { - return s.d.ArticleByName(s.ctx, ref) + return s.d.ArticleByName(s.ctx, onlySiteID(s.ctx, s.d), ref) } func (s dbSource) UserByUsername(name string) (*db.User, error) { diff --git a/internal/listpages/sitehelp_test.go b/internal/listpages/sitehelp_test.go new file mode 100644 index 00000000..b4abbede --- /dev/null +++ b/internal/listpages/sitehelp_test.go @@ -0,0 +1,22 @@ +package listpages + +import ( + "context" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func onlySiteID(ctx context.Context, d *db.DB) int64 { + slugs, err := d.SiteSlugs(ctx) + if err != nil { + panic(err) + } + if len(slugs) == 0 { + panic("the test database holds no site") + } + found, err := d.SiteBySlug(ctx, slugs[0]) + if err != nil { + panic(err) + } + return found.ID +} diff --git a/internal/localitem/localitem.go b/internal/localitem/localitem.go index b0f02451..4315d19e 100644 --- a/internal/localitem/localitem.go +++ b/internal/localitem/localitem.go @@ -198,7 +198,7 @@ func (h *handler) load(r *http.Request, name string) (*request, item, error) { } user := auth.FromContext(ctx) - article, err := h.deps.DB.ArticleByName(ctx, name) + article, err := h.deps.DB.ArticleByName(ctx, current.ID, name) if errors.Is(err, db.ErrNotFound) { return nil, missing(noArticle), nil } diff --git a/internal/modules/rate_db_test.go b/internal/modules/rate_db_test.go index e5fad8c5..5f03b2df 100644 --- a/internal/modules/rate_db_test.go +++ b/internal/modules/rate_db_test.go @@ -106,7 +106,7 @@ func TestRenderRateMatchesGolden(t *testing.T) { var b strings.Builder for _, c := range cases { - article, err := src.d.ArticleByName(src.ctx, c.Page) + article, err := src.d.ArticleByName(src.ctx, onlySiteID(src.ctx, src.d), c.Page) if err != nil { t.Fatalf("ArticleByName(%q) err = %v, want nil", c.Page, err) } diff --git a/internal/modules/sitehelp_test.go b/internal/modules/sitehelp_test.go new file mode 100644 index 00000000..0ba62855 --- /dev/null +++ b/internal/modules/sitehelp_test.go @@ -0,0 +1,22 @@ +package modules + +import ( + "context" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func onlySiteID(ctx context.Context, d *db.DB) int64 { + slugs, err := d.SiteSlugs(ctx) + if err != nil { + panic(err) + } + if len(slugs) == 0 { + panic("the test database holds no site") + } + found, err := d.SiteBySlug(ctx, slugs[0]) + if err != nil { + panic(err) + } + return found.ID +} diff --git a/internal/page/corpus_test.go b/internal/page/corpus_test.go index 7421591b..1e91c49d 100644 --- a/internal/page/corpus_test.go +++ b/internal/page/corpus_test.go @@ -98,7 +98,7 @@ func TestVarsMatchOracle(t *testing.T) { var b strings.Builder for _, entry := range corpus.Articles { - article, err := conn.ArticleByName(ctx, entry.Name) + article, err := conn.ArticleByName(ctx, site.ID, entry.Name) if err != nil { t.Fatalf("ArticleByName(%q) = %v, want nil; run testdata/oracle_seed.py", entry.Name, err) } diff --git a/internal/page/sitehelp_test.go b/internal/page/sitehelp_test.go new file mode 100644 index 00000000..fac6df89 --- /dev/null +++ b/internal/page/sitehelp_test.go @@ -0,0 +1,22 @@ +package page_test + +import ( + "context" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func onlySiteID(ctx context.Context, d *db.DB) int64 { + slugs, err := d.SiteSlugs(ctx) + if err != nil { + panic(err) + } + if len(slugs) == 0 { + panic("the test database holds no site") + } + found, err := d.SiteBySlug(ctx, slugs[0]) + if err != nil { + panic(err) + } + return found.ID +} diff --git a/internal/repo/countpages_test.go b/internal/repo/countpages_test.go index 9a780d5e..96995f69 100644 --- a/internal/repo/countpages_test.go +++ b/internal/repo/countpages_test.go @@ -81,7 +81,7 @@ func TestCountPagesMatchesGolden(t *testing.T) { if name == "" { name = "main" } - article, err := d.ArticleByName(ctx, name) + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), name) if err != nil { t.Fatalf("ArticleByName(%q) err = %v, want nil", name, err) } diff --git a/internal/repo/form.go b/internal/repo/form.go index f1ec19d7..b649b168 100644 --- a/internal/repo/form.go +++ b/internal/repo/form.go @@ -37,7 +37,7 @@ func (l *formLoader) CategoryForm(category string) (*form.Definition, error) { } func (l *formLoader) load(category string) (*form.Definition, error) { - article, err := l.db.ArticleByName(l.ctx, category+":"+templateName) + article, err := l.db.ArticleByName(l.ctx, ctxSiteID(l.ctx), category+":"+templateName) if errors.Is(err, db.ErrNotFound) { return nil, nil } diff --git a/internal/repo/forumcategory_test.go b/internal/repo/forumcategory_test.go index e6b010a5..5b3a33d1 100644 --- a/internal/repo/forumcategory_test.go +++ b/internal/repo/forumcategory_test.go @@ -51,7 +51,7 @@ func TestForumCategoryMatchesGolden(t *testing.T) { users, loc := testUsers(t) cases := forumCategoryCases() - article, err := d.ArticleByName(ctx, "forum:category") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "forum:category") if err != nil { t.Fatalf("ArticleByName(forum:category) err = %v, want nil", err) } diff --git a/internal/repo/forumnewthread_test.go b/internal/repo/forumnewthread_test.go index cea12f8a..5686320e 100644 --- a/internal/repo/forumnewthread_test.go +++ b/internal/repo/forumnewthread_test.go @@ -47,7 +47,7 @@ func TestForumNewThreadMatchesGolden(t *testing.T) { users, loc := testUsers(t) cases := forumNewThreadCases() - article, err := d.ArticleByName(ctx, "forum:new-thread") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "forum:new-thread") if err != nil { t.Fatalf("ArticleByName(forum:new-thread) err = %v, want nil", err) } diff --git a/internal/repo/forumstart_test.go b/internal/repo/forumstart_test.go index 07bdc5da..b116cd2e 100644 --- a/internal/repo/forumstart_test.go +++ b/internal/repo/forumstart_test.go @@ -56,7 +56,7 @@ func TestForumStartMatchesGolden(t *testing.T) { users, loc := testUsers(t) cases := forumStartCases() - article, err := d.ArticleByName(ctx, "forum:start") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "forum:start") if err != nil { t.Fatalf("ArticleByName(forum:start) err = %v, want nil", err) } diff --git a/internal/repo/forumthread_test.go b/internal/repo/forumthread_test.go index 7c05db97..fa87a95b 100644 --- a/internal/repo/forumthread_test.go +++ b/internal/repo/forumthread_test.go @@ -79,7 +79,7 @@ func TestForumThreadMatchesGolden(t *testing.T) { if err != nil { t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) } - article, err := d.ArticleByName(ctx, "forum:thread") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "forum:thread") if err != nil { t.Fatalf("ArticleByName(forum:thread) err = %v, want nil", err) } @@ -137,7 +137,7 @@ func forumThreadPath(t *testing.T, ctx context.Context, d *db.DB, c forumThreadC case c.Thread != "": path = path.Put(page.PathParam{Key: "t", Value: fmt.Sprint(threadIDByName(t, ctx, d, c.Thread))}) case c.Article != "": - found, err := d.ArticleByName(ctx, c.Article) + found, err := d.ArticleByName(ctx, onlySiteID(ctx, d), c.Article) if err != nil { t.Fatalf("ArticleByName(%q) err = %v, want nil", c.Article, err) } diff --git a/internal/repo/listusers_test.go b/internal/repo/listusers_test.go index fc8a3fbe..d1ad41f5 100644 --- a/internal/repo/listusers_test.go +++ b/internal/repo/listusers_test.go @@ -80,7 +80,7 @@ func TestListUsersMatchesGolden(t *testing.T) { if name == "" { name = "main" } - article, err := d.ArticleByName(ctx, name) + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), name) if err != nil { t.Fatalf("ArticleByName(%q) err = %v, want nil", name, err) } diff --git a/internal/repo/modules.go b/internal/repo/modules.go index b66ba2d8..eb57d175 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -60,7 +60,7 @@ func (m moduleData) ArticleTagIDs(articleID int64) ([]int64, error) { } func (m moduleData) ArticleByRef(ref string) (*db.Article, error) { - return m.repo.db.ArticleByName(m.repo.ctx, ref) + return m.repo.db.ArticleByName(m.repo.ctx, m.repo.siteID(), ref) } func (m moduleData) ForumThreadsInCategories(categoryIDs []int64, offset, limit int) ([]db.ForumThread, error) { diff --git a/internal/repo/nested_modules_test.go b/internal/repo/nested_modules_test.go index 69b98394..e1c3d573 100644 --- a/internal/repo/nested_modules_test.go +++ b/internal/repo/nested_modules_test.go @@ -29,7 +29,7 @@ func TestListPagesRendersAListUsersInItsBody(t *testing.T) { if err != nil { t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) } - article, err := d.ArticleByName(ctx, "main") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "main") if err != nil { t.Fatalf("ArticleByName(main) err = %v, want nil", err) } diff --git a/internal/repo/recentposts_test.go b/internal/repo/recentposts_test.go index f143189d..f3cecd20 100644 --- a/internal/repo/recentposts_test.go +++ b/internal/repo/recentposts_test.go @@ -66,7 +66,7 @@ func TestRecentPostsMatchesGolden(t *testing.T) { if err != nil { t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) } - article, err := d.ArticleByName(ctx, "forum:recent-posts") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "forum:recent-posts") if err != nil { t.Fatalf("ArticleByName(forum:recent-posts) err = %v, want nil", err) } diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 149e16a3..8899c53c 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -59,7 +59,7 @@ func New(ctx context.Context, d *db.DB, users *printuser.Renderer, opts Options) } func (r *Repository) PageInfo(refs []string) ([]renderer.PartialPageInfo, error) { - titles, err := r.db.ArticleTitles(r.ctx, refs) + titles, err := r.db.ArticleTitles(r.ctx, r.siteID(), refs) if err != nil { return nil, err } @@ -81,7 +81,7 @@ func (r *Repository) IncludeSources(refs []renderer.IncludeRef) ([]renderer.Fetc for i, ref := range refs { names[i] = ref.FullName } - sources, err := r.db.ArticleSources(r.ctx, names) + sources, err := r.db.ArticleSources(r.ctx, r.siteID(), names) if err != nil { return nil, err } diff --git a/internal/repo/sitechanges_test.go b/internal/repo/sitechanges_test.go index 31550743..4c913a86 100644 --- a/internal/repo/sitechanges_test.go +++ b/internal/repo/sitechanges_test.go @@ -82,7 +82,7 @@ func TestSiteChangesMatchesGolden(t *testing.T) { if err != nil { t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) } - article, err := d.ArticleByName(ctx, "probe:changes") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "probe:changes") if err != nil { t.Fatalf("ArticleByName(probe:changes) err = %v, want nil", err) } diff --git a/internal/repo/sitehelp_test.go b/internal/repo/sitehelp_test.go new file mode 100644 index 00000000..2c70f809 --- /dev/null +++ b/internal/repo/sitehelp_test.go @@ -0,0 +1,22 @@ +package repo + +import ( + "context" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func onlySiteID(ctx context.Context, d *db.DB) int64 { + slugs, err := d.SiteSlugs(ctx) + if err != nil { + panic(err) + } + if len(slugs) == 0 { + panic("the test database holds no site") + } + found, err := d.SiteBySlug(ctx, slugs[0]) + if err != nil { + panic(err) + } + return found.ID +} diff --git a/internal/repo/tagcloud_test.go b/internal/repo/tagcloud_test.go index 426bcec9..dab8bcbc 100644 --- a/internal/repo/tagcloud_test.go +++ b/internal/repo/tagcloud_test.go @@ -65,7 +65,7 @@ func TestTagCloudMatchesGolden(t *testing.T) { users, loc := testUsers(t) cases := tagCloudCases() - article, err := d.ArticleByName(ctx, "main") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "main") if err != nil { t.Fatalf("ArticleByName(main) err = %v, want nil", err) } diff --git a/internal/repo/wantedpages_test.go b/internal/repo/wantedpages_test.go index 8512b6b7..ecad9c19 100644 --- a/internal/repo/wantedpages_test.go +++ b/internal/repo/wantedpages_test.go @@ -55,7 +55,7 @@ func TestWantedPagesMatchesGolden(t *testing.T) { users, loc := testUsers(t) cases := wantedPagesCases() - article, err := d.ArticleByName(ctx, "main") + article, err := d.ArticleByName(ctx, onlySiteID(ctx, d), "main") if err != nil { t.Fatalf("ArticleByName(main) err = %v, want nil", err) } diff --git a/internal/seed/seed.go b/internal/seed/seed.go index 8baca6fb..09debd14 100644 --- a/internal/seed/seed.go +++ b/internal/seed/seed.go @@ -23,8 +23,8 @@ const ( ) type Store interface { - ArticleByName(ctx context.Context, ref string) (*db.Article, error) - CreateArticle(ctx context.Context, category, name, title string, authorID *int64, at time.Time) (int64, error) + ArticleByName(ctx context.Context, siteID int64, ref string) (*db.Article, error) + CreateArticle(ctx context.Context, siteID int64, category, name, title string, authorID *int64, at time.Time) (int64, error) CreateArticleVersion(ctx context.Context, w db.VersionWrite) (db.Revision, error) } @@ -45,7 +45,7 @@ func pageName(p string) string { return strings.ReplaceAll(rel, "/", ":") } -func Run(ctx context.Context, store Store) ([]string, error) { +func Run(ctx context.Context, store Store, siteID int64) ([]string, error) { var written []string err := fs.WalkDir(pages, dir, func(p string, d fs.DirEntry, err error) error { if err != nil || d.IsDir() || !strings.HasSuffix(p, suffix) { @@ -59,7 +59,7 @@ func Run(ctx context.Context, store Store) ([]string, error) { return nil } name := pageName(p) - added, err := write(ctx, store, name, string(source)) + added, err := write(ctx, store, siteID, name, string(source)) if err != nil { return err } @@ -71,8 +71,8 @@ func Run(ctx context.Context, store Store) ([]string, error) { return written, err } -func write(ctx context.Context, store Store, full, source string) (bool, error) { - if _, err := store.ArticleByName(ctx, full); err == nil { +func write(ctx context.Context, store Store, siteID int64, full, source string) (bool, error) { + if _, err := store.ArticleByName(ctx, siteID, full); err == nil { return false, nil } else if !errors.Is(err, db.ErrNotFound) { return false, err @@ -80,7 +80,7 @@ func write(ctx context.Context, store Store, full, source string) (bool, error) category, name := split(full) - id, err := store.CreateArticle(ctx, category, name, "", nil, time.Now()) + id, err := store.CreateArticle(ctx, siteID, category, name, "", nil, time.Now()) if err != nil { return false, err } diff --git a/internal/seed/seed_test.go b/internal/seed/seed_test.go index 3c34a582..dec753c2 100644 --- a/internal/seed/seed_test.go +++ b/internal/seed/seed_test.go @@ -16,14 +16,14 @@ type fakeStore struct { nextID int64 } -func (f *fakeStore) ArticleByName(_ context.Context, ref string) (*db.Article, error) { +func (f *fakeStore) ArticleByName(_ context.Context, _ int64, ref string) (*db.Article, error) { if f.existing[ref] { return &db.Article{}, nil } return nil, db.ErrNotFound } -func (f *fakeStore) CreateArticle(_ context.Context, category, name, _ string, _ *int64, _ time.Time) (int64, error) { +func (f *fakeStore) CreateArticle(_ context.Context, _ int64, category, name, _ string, _ *int64, _ time.Time) (int64, error) { f.nextID++ f.created = append(f.created, category+":"+name) return f.nextID, nil @@ -53,7 +53,7 @@ func TestNamesTurnDirectoriesIntoCategories(t *testing.T) { func TestRunWritesEveryPageOnce(t *testing.T) { store := &fakeStore{existing: map[string]bool{}} - written, err := Run(context.Background(), store) + written, err := Run(context.Background(), store, 1) if err != nil { t.Fatalf("Run() err = %v, want nil", err) } @@ -69,7 +69,7 @@ func TestRunWritesEveryPageOnce(t *testing.T) { func TestRunSkipsPagesThatAreAlreadyThere(t *testing.T) { store := &fakeStore{existing: map[string]bool{"main": true, "nav:top": true}} - written, err := Run(context.Background(), store) + written, err := Run(context.Background(), store, 1) if err != nil { t.Fatalf("Run() err = %v, want nil", err) } diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index 5480b8ff..4b9247ba 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -151,7 +151,7 @@ func (h *Articles) viewable(r *http.Request, name string) error { } func (h *Articles) article(r *http.Request, name string) (*db.Article, error) { - found, err := h.deps.DB.ArticleByName(r.Context(), name) + found, err := h.deps.DB.ArticleByName(r.Context(), siteID(r.Context()), name) if errors.Is(err, db.ErrNotFound) { return nil, errNotFound } @@ -182,7 +182,7 @@ func (h *Articles) links(r *http.Request, _ *i18n.Localizer, name string) (strin for _, link := range links { refs = append(refs, strings.ToLower(link.From)) } - titles, err := h.deps.DB.ArticleTitles(ctx, refs) + titles, err := h.deps.DB.ArticleTitles(ctx, siteID(ctx), refs) if err != nil { return "", 0, err } diff --git a/internal/webapi/create.go b/internal/webapi/create.go index bbb36ab2..8baf7a12 100644 --- a/internal/webapi/create.go +++ b/internal/webapi/create.go @@ -72,7 +72,7 @@ func (h *Articles) createArticle(r *http.Request, loc *i18n.Localizer) (string, if bad := h.mayCreate(r, name, user); bad != nil { return field("error", loc.T(bad.key)), bad.status, nil } - if _, err := h.deps.DB.ArticleByName(ctx, name); err == nil { + if _, err := h.deps.DB.ArticleByName(ctx, siteID(ctx), name); err == nil { return field("error", loc.T("api-page-exists")), http.StatusConflict, nil } else if !errors.Is(err, db.ErrNotFound) { return "", 0, err @@ -141,7 +141,7 @@ func (h *Articles) writeNewArticle(r *http.Request, current *db.Site, name strin userID = &user.ID } - id, err := h.deps.DB.CreateArticle(ctx, category, bare, *input.Title, userID, at) + id, err := h.deps.DB.CreateArticle(ctx, siteID(ctx), category, bare, *input.Title, userID, at) if err != nil { return err } @@ -213,7 +213,7 @@ func (h *Articles) setParent(r *http.Request, current *db.Site, id int64, } ctx := r.Context() wanted := wikidot.Normalize(*input.Parent) - parent, err := h.deps.DB.ArticleByName(ctx, wanted) + parent, err := h.deps.DB.ArticleByName(ctx, siteID(ctx), wanted) if errors.Is(err, db.ErrNotFound) { parent = nil } else if err != nil { diff --git a/internal/webapi/preview.go b/internal/webapi/preview.go index 4c625ad9..62d9accd 100644 --- a/internal/webapi/preview.go +++ b/internal/webapi/preview.go @@ -91,7 +91,7 @@ func (h *Preview) render(r *http.Request, loc *i18n.Localizer, current *db.Site, user := auth.FromContext(ctx) params := page.ParsePathParams(string(parsed.PathParams)) - found, err := h.deps.DB.ArticleByName(ctx, parsed.PageID) + found, err := h.deps.DB.ArticleByName(ctx, siteID(ctx), parsed.PageID) if err != nil && !errors.Is(err, db.ErrNotFound) { return "", "", err } @@ -131,7 +131,7 @@ func (h *Preview) template(ctx context.Context, found *db.Article) (string, erro if found == nil || found.Name == templateName { return "%%content%%", nil } - template, err := h.deps.DB.ArticleByName(ctx, found.Category+":"+templateName) + template, err := h.deps.DB.ArticleByName(ctx, siteID(ctx), found.Category+":"+templateName) if errors.Is(err, db.ErrNotFound) { return "%%content%%", nil } diff --git a/internal/webapi/subscribe.go b/internal/webapi/subscribe.go index c6fc9451..0dd0f9d5 100644 --- a/internal/webapi/subscribe.go +++ b/internal/webapi/subscribe.go @@ -107,7 +107,7 @@ func (h *Subscriptions) apply(r *http.Request, user *db.User, input subscribeReq ctx := r.Context() switch { case input.PageID != "": - article, err := h.deps.DB.ArticleByName(ctx, input.PageID) + article, err := h.deps.DB.ArticleByName(ctx, siteID(ctx), input.PageID) if errors.Is(err, db.ErrNotFound) { return 0, errNotFound } diff --git a/internal/webapi/update.go b/internal/webapi/update.go index ada2a224..07e40576 100644 --- a/internal/webapi/update.go +++ b/internal/webapi/update.go @@ -189,7 +189,7 @@ func (e *editor) rename() (*refusal, error) { } forced, _ := e.body.flag("forcePageId") - taken, err := e.handler.deps.DB.ArticleByName(e.req.Context(), wanted) + taken, err := e.handler.deps.DB.ArticleByName(e.req.Context(), siteID(e.req.Context()), wanted) if err != nil && !errors.Is(err, db.ErrNotFound) { return nil, err } @@ -218,7 +218,7 @@ func (e *editor) free(wanted string) (string, error) { if i > 1 { candidate = wanted + "-" + strconv.Itoa(i) } - found, err := e.handler.deps.DB.ArticleByName(e.req.Context(), candidate) + found, err := e.handler.deps.DB.ArticleByName(e.req.Context(), siteID(e.req.Context()), candidate) if errors.Is(err, db.ErrNotFound) { return candidate, nil } @@ -326,7 +326,7 @@ func (e *editor) reparent() (*refusal, error) { wanted, _ := e.body.text("parent") var parentID *int64 if wanted != "" { - parent, err := e.handler.deps.DB.ArticleByName(ctx, wikidot.Normalize(wanted)) + parent, err := e.handler.deps.DB.ArticleByName(ctx, siteID(ctx), wikidot.Normalize(wanted)) if err != nil && !errors.Is(err, db.ErrNotFound) { return nil, err } diff --git a/internal/webapi/webapi.go b/internal/webapi/webapi.go index 5d770521..7a71ef6a 100644 --- a/internal/webapi/webapi.go +++ b/internal/webapi/webapi.go @@ -3,6 +3,7 @@ package webapi import ( "bytes" + "context" "encoding/json" "errors" "io" @@ -153,7 +154,7 @@ func (h *Handler) answer(r *http.Request, loc *i18n.Localizer, parsed call) (str var article *db.Article if parsed.PageID != "" { - found, err := h.deps.DB.ArticleByName(ctx, parsed.PageID) + found, err := h.deps.DB.ArticleByName(ctx, siteID(ctx), parsed.PageID) if errors.Is(err, db.ErrNotFound) { return field("error", loc.T("api-page-not-found")), http.StatusNotFound, nil } @@ -264,3 +265,10 @@ func writeJSON(w http.ResponseWriter, status int, body string) { w.WriteHeader(status) _, _ = io.WriteString(w, body) } + +func siteID(ctx context.Context) int64 { + if current := site.FromContext(ctx); current != nil { + return current.ID + } + return 0 +} From aa9c1384fbc52da72d20de652e09c10a1108a97f Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 00:17:28 +0900 Subject: [PATCH 346/428] read categories and tags inside one site --- internal/articlepage/build.go | 8 ++--- internal/articlepage/render.go | 4 +-- internal/db/chrome.go | 12 +++---- internal/db/chrome_test.go | 6 ++-- internal/db/file.go | 6 ++-- internal/db/options.go | 20 +++++------ internal/db/perms.go | 6 ++-- internal/db/rating.go | 6 ++-- internal/db/search.go | 7 ++-- internal/db/site_scope_pending_test.go | 48 +++++++++++--------------- internal/db/site_scope_test.go | 36 +++++++++++++------ internal/listpages/params_db_test.go | 2 +- internal/media/media.go | 12 +++++-- internal/media/media_test.go | 2 +- internal/media/resized.go | 2 +- internal/modules/rate_db_test.go | 2 +- internal/repo/modules.go | 4 +-- internal/repo/perms.go | 6 ++-- internal/repo/vars.go | 9 ++++- internal/webapi/allarticles.go | 2 +- internal/webapi/articles.go | 2 +- internal/webapi/update.go | 2 +- 22 files changed, 114 insertions(+), 90 deletions(-) diff --git a/internal/articlepage/build.go b/internal/articlepage/build.go index fb9e5c44..596a09d5 100644 --- a/internal/articlepage/build.go +++ b/internal/articlepage/build.go @@ -115,7 +115,7 @@ func (h *Handler) permsObject(req *request, perm *repo.Perms) (*perms.Object, bo return object, true, err } category, _ := wikidot.Split(req.name) - exists, err := h.deps.DB.CategoryExists(req.ctx, category) + exists, err := h.deps.DB.CategoryExists(req.ctx, req.site.ID, category) if err != nil { return nil, false, err } @@ -126,10 +126,10 @@ func (h *Handler) permsObject(req *request, perm *repo.Perms) (*perms.Object, bo return object, true, err } -// This only reads, so a page nobody has commented on gets no thread written for -// it. +// Asking for the discussion is what opens the thread, so the link always lands +// on one even for a page nobody has commented on. func (h *Handler) commentsRedirect(req *request) (string, error) { - id, err := h.deps.DB.CommentThreadFor(req.ctx, req.article.ID) + id, err := h.deps.DB.CommentThreadFor(req.ctx, req.site.ID, req.article.ID) if err != nil { return "", err } diff --git a/internal/articlepage/render.go b/internal/articlepage/render.go index cc1210c0..127cea10 100644 --- a/internal/articlepage/render.go +++ b/internal/articlepage/render.go @@ -493,7 +493,7 @@ func (h *Handler) themeURL(req *request) (string, error) { func (h *Handler) indexed(req *request) (bool, error) { category, _ := wikidot.Split(req.name) - return h.deps.DB.CategoryIndexed(req.ctx, category) + return h.deps.DB.CategoryIndexed(req.ctx, req.site.ID, category) } func (h *Handler) breadcrumbs(req *request) ([]shell.Breadcrumb, error) { @@ -620,7 +620,7 @@ func (h *Handler) rating(req *request) (page.Rating, error) { if err != nil && !errors.Is(err, db.ErrNotFound) { return page.Rating{}, err } - categoryMode, err := h.deps.DB.CategoryRatingMode(req.ctx, req.article.Category) + categoryMode, err := h.deps.DB.CategoryRatingMode(req.ctx, req.site.ID, req.article.Category) if err != nil && !errors.Is(err, db.ErrNotFound) { return page.Rating{}, err } diff --git a/internal/db/chrome.go b/internal/db/chrome.go index dd7c5e0c..90f5e4e3 100644 --- a/internal/db/chrome.go +++ b/internal/db/chrome.go @@ -126,13 +126,13 @@ func (d *DB) LatestRevNumber(ctx context.Context, articleID int64) (int, error) } var qCategoryExists = register("CategoryExists", ` -SELECT EXISTS(SELECT 1 FROM web_category WHERE name = $1)`) +SELECT EXISTS(SELECT 1 FROM web_category WHERE site_id = $1 AND name = $2)`) // The page skips the permission check entirely when neither it nor its category // has a row, which is how a 404 wins over a 403 there. -func (d *DB) CategoryExists(ctx context.Context, name string) (bool, error) { +func (d *DB) CategoryExists(ctx context.Context, siteID int64, name string) (bool, error) { var exists bool - if err := d.pool.QueryRow(ctx, qCategoryExists, name).Scan(&exists); err != nil { + if err := d.pool.QueryRow(ctx, qCategoryExists, siteID, name).Scan(&exists); err != nil { return false, fmt.Errorf("check category %q: %w", name, err) } return exists, nil @@ -141,11 +141,11 @@ func (d *DB) CategoryExists(ctx context.Context, name string) (bool, error) { var qCategoryIndexed = register("CategoryIndexed", ` SELECT is_indexed FROM web_category -WHERE name = $1`) +WHERE site_id = $1 AND name = $2`) -func (d *DB) CategoryIndexed(ctx context.Context, name string) (bool, error) { +func (d *DB) CategoryIndexed(ctx context.Context, siteID int64, name string) (bool, error) { var indexed bool - err := d.pool.QueryRow(ctx, qCategoryIndexed, name).Scan(&indexed) + err := d.pool.QueryRow(ctx, qCategoryIndexed, siteID, name).Scan(&indexed) if errors.Is(err, pgx.ErrNoRows) { return true, nil } diff --git a/internal/db/chrome_test.go b/internal/db/chrome_test.go index e69d729a..6949e912 100644 --- a/internal/db/chrome_test.go +++ b/internal/db/chrome_test.go @@ -122,7 +122,7 @@ func TestLatestRevNumber(t *testing.T) { func TestCategoryIndexedOfUnknownCategory(t *testing.T) { d := newTestDB(t) - got, err := d.CategoryIndexed(context.Background(), "no-such-category") + got, err := d.CategoryIndexed(context.Background(), seedSiteID(t, d), "no-such-category") if err != nil { t.Fatalf("CategoryIndexed() err = %v, want nil", err) } @@ -185,7 +185,7 @@ func TestArticleTagNamesOfUntaggedPage(t *testing.T) { func TestCategoryExists(t *testing.T) { d := newTestDB(t) - got, err := d.CategoryExists(context.Background(), "probestars") + got, err := d.CategoryExists(context.Background(), seedSiteID(t, d), "probestars") if err != nil { t.Fatalf("CategoryExists() err = %v, want nil", err) } @@ -197,7 +197,7 @@ func TestCategoryExists(t *testing.T) { func TestCategoryExistsOfUnknownCategory(t *testing.T) { d := newTestDB(t) - got, err := d.CategoryExists(context.Background(), "no-such-category") + got, err := d.CategoryExists(context.Background(), seedSiteID(t, d), "no-such-category") if err != nil { t.Fatalf("CategoryExists() err = %v, want nil", err) } diff --git a/internal/db/file.go b/internal/db/file.go index e01a31f4..f071400a 100644 --- a/internal/db/file.go +++ b/internal/db/file.go @@ -21,15 +21,15 @@ var qArticleFile = register("ArticleFile", ` SELECT a.media_name, f.media_name, f.mime_type, f.size FROM web_file f JOIN web_article a ON a.id = f.article_id -WHERE a.complete_full_name = $1 AND f.name = $2 AND f.deleted_at IS NULL +WHERE a.site_id = $1 AND a.complete_full_name = $2 AND f.name = $3 AND f.deleted_at IS NULL ORDER BY f.id LIMIT 1`) // ArticleFile resolves an attachment's on-disk names. ORDER BY id only makes // an already-unique row deterministic. -func (d *DB) ArticleFile(ctx context.Context, articleRef, fileName string) (*ArticleFile, error) { +func (d *DB) ArticleFile(ctx context.Context, siteID int64, articleRef, fileName string) (*ArticleFile, error) { var f ArticleFile - err := d.pool.QueryRow(ctx, qArticleFile, dumbName(articleRef), fileName).Scan( + err := d.pool.QueryRow(ctx, qArticleFile, siteID, dumbName(articleRef), fileName).Scan( &f.ArticleMediaName, &f.MediaName, &f.MimeType, &f.Size) if errors.Is(err, pgx.ErrNoRows) { return nil, ErrNotFound diff --git a/internal/db/options.go b/internal/db/options.go index 25c1c04e..0c850619 100644 --- a/internal/db/options.go +++ b/internal/db/options.go @@ -37,13 +37,13 @@ var qCategoryCanCreateTags = register("CategoryCanCreateTags", ` SELECT s.can_user_create_tags FROM web_settings s JOIN web_category c ON c.id = s.category_id -WHERE c.name = $1`) +WHERE c.site_id = $1 AND c.name = $2`) // A category with no row of its own reads the same as one left on default. Both // hand the question back to the site. -func (d *DB) CategoryCanCreateTags(ctx context.Context, category string) (string, error) { +func (d *DB) CategoryCanCreateTags(ctx context.Context, siteID int64, category string) (string, error) { var mode string - err := d.pool.QueryRow(ctx, qCategoryCanCreateTags, category).Scan(&mode) + err := d.pool.QueryRow(ctx, qCategoryCanCreateTags, siteID, category).Scan(&mode) if errors.Is(err, pgx.ErrNoRows) { return "", ErrNotFound } @@ -150,10 +150,10 @@ func (d *DB) TagCategoryBySlug(ctx context.Context, slug string) (TagCategory, e return c, nil } -var qCategoryNames = register("CategoryNames", `SELECT name FROM web_category`) +var qCategoryNames = register("CategoryNames", `SELECT name FROM web_category WHERE site_id = $1`) -func (d *DB) CategoryNames(ctx context.Context) ([]string, error) { - rows, err := d.pool.Query(ctx, qCategoryNames) +func (d *DB) CategoryNames(ctx context.Context, siteID int64) ([]string, error) { + rows, err := d.pool.Query(ctx, qCategoryNames, siteID) if err != nil { return nil, fmt.Errorf("list categories: %w", err) } @@ -213,8 +213,8 @@ var qCommentThreadFor = register("CommentThreadFor", ` WITH existing AS ( SELECT id FROM web_forumthread WHERE article_id = $1 ), created AS ( - INSERT INTO web_forumthread (name, description, article_id, is_pinned, is_locked, created_at, updated_at) - SELECT '', '', $1, false, false, now(), now() + INSERT INTO web_forumthread (site_id, name, description, article_id, is_pinned, is_locked, created_at, updated_at) + SELECT $2, '', '', $1, false, false, now(), now() WHERE NOT EXISTS (SELECT 1 FROM existing) RETURNING id ) @@ -222,9 +222,9 @@ SELECT id FROM existing UNION ALL SELECT id FROM created`) // A page gets its comment thread the first time a reader asks for the // discussion, so reading the page never writes and the link still lands. -func (d *DB) CommentThreadFor(ctx context.Context, articleID int64) (int64, error) { +func (d *DB) CommentThreadFor(ctx context.Context, siteID, articleID int64) (int64, error) { var id int64 - if err := d.pool.QueryRow(ctx, qCommentThreadFor, articleID).Scan(&id); err != nil { + if err := d.pool.QueryRow(ctx, qCommentThreadFor, articleID, siteID).Scan(&id); err != nil { return 0, fmt.Errorf("open comment thread of article %d: %w", articleID, err) } return id, nil diff --git a/internal/db/perms.go b/internal/db/perms.go index 8835bf4a..06b9e0db 100644 --- a/internal/db/perms.go +++ b/internal/db/perms.go @@ -48,7 +48,7 @@ LEFT JOIN ( FROM web_rolepermissionsoverride_restrictions x JOIN auth_permission p ON p.id = x.permission_id ) op ON op.override_id = o.id -WHERE c.name = $1 +WHERE c.site_id = $1 AND c.name = $2 ORDER BY o.id`) var qArticleHasAuthor = register("ArticleHasAuthor", ` @@ -140,8 +140,8 @@ func (d *DB) RolePermissions(ctx context.Context, ids []int64) ([]perms.Role, er return out, nil } -func (d *DB) CategoryOverrides(ctx context.Context, category string) ([]perms.Override, error) { - rows, err := d.pool.Query(ctx, qCategoryOverrides, category) +func (d *DB) CategoryOverrides(ctx context.Context, siteID int64, category string) ([]perms.Override, error) { + rows, err := d.pool.Query(ctx, qCategoryOverrides, siteID, category) if err != nil { return nil, fmt.Errorf("list permission overrides of category %q: %w", category, err) } diff --git a/internal/db/rating.go b/internal/db/rating.go index b591d96e..9ec35f52 100644 --- a/internal/db/rating.go +++ b/internal/db/rating.go @@ -29,14 +29,14 @@ var qCategoryRatingMode = register("CategoryRatingMode", ` SELECT s.rating_mode FROM web_settings s JOIN web_category c ON c.id = s.category_id -WHERE c.name = $1`) +WHERE c.site_id = $1 AND c.name = $2`) // CategoryRatingMode reports ErrNotFound for a category that has no row of its // own as well as for one that exists without settings; both fall back to the // site. -func (d *DB) CategoryRatingMode(ctx context.Context, category string) (string, error) { +func (d *DB) CategoryRatingMode(ctx context.Context, siteID int64, category string) (string, error) { var mode string - err := d.pool.QueryRow(ctx, qCategoryRatingMode, category).Scan(&mode) + err := d.pool.QueryRow(ctx, qCategoryRatingMode, siteID, category).Scan(&mode) if errors.Is(err, pgx.ErrNoRows) { return "", ErrNotFound } diff --git a/internal/db/search.go b/internal/db/search.go index f29d356a..55c7a546 100644 --- a/internal/db/search.go +++ b/internal/db/search.go @@ -306,10 +306,11 @@ func (d *DB) LatestEditorsOfArticles(ctx context.Context, ids []int64) (map[int6 var qCategoryRatingModes = register("CategoryRatingModes", ` SELECT c.name, s.rating_mode FROM web_settings s -JOIN web_category c ON c.id = s.category_id`) +JOIN web_category c ON c.id = s.category_id +WHERE c.site_id = $1`) -func (d *DB) CategoryRatingModes(ctx context.Context) (map[string]string, error) { - rows, err := d.pool.Query(ctx, qCategoryRatingModes) +func (d *DB) CategoryRatingModes(ctx context.Context, siteID int64) (map[string]string, error) { + rows, err := d.pool.Query(ctx, qCategoryRatingModes, siteID) if err != nil { return nil, fmt.Errorf("query category rating modes: %w", err) } diff --git a/internal/db/site_scope_pending_test.go b/internal/db/site_scope_pending_test.go index 1d63e794..7911de38 100644 --- a/internal/db/site_scope_pending_test.go +++ b/internal/db/site_scope_pending_test.go @@ -30,40 +30,16 @@ var siteScopePending = []string{ "AdminTicketCount", "AdminTickets", "AllTags", - "ArticleByID", "ArticleCategories", "ArticleChildren", - "ArticleFile", - "ArticleLastComment", - "ArticleTagCategories", - "ArticleTagNames", - "ArticleTags", - "ArticleVotes", "ArticlesByTag", "Breadcrumbs", - "CategoryCanCreateTags", - "CategoryExists", - "CategoryIndexed", - "CategoryNames", - "CategoryOverrides", - "CategoryRatingMode", - "CategoryRatingModes", - "ChildCount", "ClearRoleTickets", - "CommentCount", - "CommentCountsOfArticles", - "CommentInfo", - "CommentThreadFor", "CreateInviteLink", "CreateReport", "CreateTicket", - "DeleteArticle.0", - "DeleteArticle.1", "DeleteArticle.13", "DeleteArticle.14", - "DeleteArticle.2", - "DeleteArticle.3", - "DeleteArticle.4", "DeleteCategory", "DeleteForumSection", "DeleteInvite", @@ -108,7 +84,6 @@ var siteScopePending = []string{ "OpenInviteCount", "OperationIndex", "RatedBy", - "ReadArticleTags", "ReadArticleTitle", "RecentPostCount", "RecentPosts", @@ -127,7 +102,6 @@ var siteScopePending = []string{ "TagIDsByFullName", "TagIDsByName", "TagsCategories", - "TagsOfArticles", "ThemeByID", "ThemeRow", "Themes", @@ -136,7 +110,6 @@ var siteScopePending = []string{ "UpdateArticleTitle", "UpdateCategory", "UpdateForumSection", - "UpdateForumThread", "UpdateRole", "UpdateRoleCategory", "UpdateTag", @@ -146,3 +119,24 @@ var siteScopePending = []string{ "UserPosts", "WriteAdminNote", } + +var siteScopeByKey = []string{ + "ArticleByID", + "ChildCount", + "CommentCount", + "ArticleLastComment", + "CommentInfo", + "ArticleTags", + "ArticleTagCategories", + "ArticleTagNames", + "ReadArticleTags", + "TagsOfArticles", + "CommentCountsOfArticles", + "ArticleVotes", + "UpdateForumThread", + "DeleteArticle.0", + "DeleteArticle.1", + "DeleteArticle.2", + "DeleteArticle.3", + "DeleteArticle.4", +} diff --git a/internal/db/site_scope_test.go b/internal/db/site_scope_test.go index 115e80b3..d4245c09 100644 --- a/internal/db/site_scope_test.go +++ b/internal/db/site_scope_test.go @@ -42,15 +42,20 @@ func TestEveryPerSiteQueryNamesTheSite(t *testing.T) { pending[name] = true } - var missing, stale []string + byKey := map[string]bool{} + for _, name := range siteScopeByKey { + byKey[name] = true + } + + var missing, stale, both []string for _, q := range queries { - if len(touchedTables(q.sql)) == 0 { - if pending[q.name] { - stale = append(stale, q.name) - } - continue + if pending[q.name] && byKey[q.name] { + both = append(both, q.name) } - if strings.Contains(q.sql, "site_id") { + settled := len(touchedTables(q.sql)) == 0 || + strings.Contains(q.sql, "site_id") || + byKey[q.name] + if settled { if pending[q.name] { stale = append(stale, q.name) } @@ -61,6 +66,10 @@ func TestEveryPerSiteQueryNamesTheSite(t *testing.T) { } } + for _, name := range both { + t.Errorf("query %q is in both siteScopeByKey and siteScopePending, want one", name) + } + for _, name := range missing { t.Errorf("query %q reads a per-site table without site_id, want the filter or an entry in siteScopePending", name) } @@ -80,14 +89,19 @@ func TestEveryPerSiteQueryNamesTheSite(t *testing.T) { } } -func TestSiteScopePendingHasNoUnknownNames(t *testing.T) { +func TestSiteScopeListsHoldOnlyKnownNames(t *testing.T) { known := make([]string, 0, len(queries)) for _, q := range queries { known = append(known, q.name) } - for _, name := range siteScopePending { - if !slices.Contains(known, name) { - t.Errorf("siteScopePending has %q, want a registered query name", name) + for list, names := range map[string][]string{ + "siteScopePending": siteScopePending, + "siteScopeByKey": siteScopeByKey, + } { + for _, name := range names { + if !slices.Contains(known, name) { + t.Errorf("%s has %q, want a registered query name", list, name) + } } } } diff --git a/internal/listpages/params_db_test.go b/internal/listpages/params_db_test.go index e8dcf092..d020c4fb 100644 --- a/internal/listpages/params_db_test.go +++ b/internal/listpages/params_db_test.go @@ -152,7 +152,7 @@ func (s dbSource) SiteRatingMode() (string, error) { } func (s dbSource) CategoryRatingMode(category string) (string, error) { - return s.d.CategoryRatingMode(s.ctx, category) + return s.d.CategoryRatingMode(s.ctx, onlySiteID(s.ctx, s.d), category) } func (s dbSource) VoteStats(articleID int64) (db.VoteStats, error) { diff --git a/internal/media/media.go b/internal/media/media.go index 44525c17..71a36363 100644 --- a/internal/media/media.go +++ b/internal/media/media.go @@ -16,6 +16,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/escape" "github.com/WikitTeam/ProjectWikit/internal/paths" + "github.com/WikitTeam/ProjectWikit/internal/site" ) const ( @@ -27,7 +28,7 @@ const ( // Attachments resolves an article attachment's on-disk names. type Attachments interface { - ArticleFile(ctx context.Context, articleRef, fileName string) (*db.ArticleFile, error) + ArticleFile(ctx context.Context, siteID int64, articleRef, fileName string) (*db.ArticleFile, error) } type Handler struct { @@ -145,7 +146,7 @@ func (h *Handler) locate(ctx context.Context, rest string) (full, mimeType strin // Uploads live under a pair of UUIDs, so a two-segment path that // resolves to nothing is read as article and attachment names. if len(segments) == 2 && !exists(filepath.Join(root, rest)) { - if f, err := h.files.ArticleFile(ctx, segments[0], segments[1]); err == nil { + if f, err := h.files.ArticleFile(ctx, siteID(ctx), segments[0], segments[1]); err == nil { segments = []string{f.ArticleMediaName, f.MediaName} mimeType, size = f.MimeType, f.Size } else if !errors.Is(err, db.ErrNotFound) { @@ -258,3 +259,10 @@ func notFound(w http.ResponseWriter) { w.WriteHeader(http.StatusNotFound) _, _ = w.Write([]byte(notFoundBody)) } + +func siteID(ctx context.Context) int64 { + if current := site.FromContext(ctx); current != nil { + return current.ID + } + return 0 +} diff --git a/internal/media/media_test.go b/internal/media/media_test.go index 70232ac9..53918539 100644 --- a/internal/media/media_test.go +++ b/internal/media/media_test.go @@ -14,7 +14,7 @@ import ( type fakeFiles map[string]*db.ArticleFile -func (f fakeFiles) ArticleFile(_ context.Context, articleRef, fileName string) (*db.ArticleFile, error) { +func (f fakeFiles) ArticleFile(_ context.Context, _ int64, articleRef, fileName string) (*db.ArticleFile, error) { if af, ok := f[articleRef+"/"+fileName]; ok { return af, nil } diff --git a/internal/media/resized.go b/internal/media/resized.go index e63e4985..774eff17 100644 --- a/internal/media/resized.go +++ b/internal/media/resized.go @@ -69,7 +69,7 @@ func (h *ResizedHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { } func (h *ResizedHandler) image(ctx context.Context, articleRef, fileName string, size thumb.Size) ([]byte, error) { - file, err := h.files.ArticleFile(ctx, articleRef, fileName) + file, err := h.files.ArticleFile(ctx, siteID(ctx), articleRef, fileName) if err != nil { return nil, err } diff --git a/internal/modules/rate_db_test.go b/internal/modules/rate_db_test.go index 5f03b2df..0bda49a4 100644 --- a/internal/modules/rate_db_test.go +++ b/internal/modules/rate_db_test.go @@ -69,7 +69,7 @@ func (r rateData) SiteRatingMode() (string, error) { } func (r rateData) CategoryRatingMode(category string) (string, error) { - return r.d.CategoryRatingMode(r.ctx, category) + return r.d.CategoryRatingMode(r.ctx, onlySiteID(r.ctx, r.d), category) } func (r rateData) VoteStats(articleID int64) (db.VoteStats, error) { diff --git a/internal/repo/modules.go b/internal/repo/modules.go index eb57d175..643d94ba 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -28,7 +28,7 @@ func (m moduleData) HiddenCategories(user *db.User) ([]string, error) { } func HiddenCategories(ctx context.Context, d *db.DB, user *db.User) ([]string, error) { - names, err := d.CategoryNames(ctx) + names, err := d.CategoryNames(ctx, ctxSiteID(ctx)) if err != nil { return nil, err } @@ -99,7 +99,7 @@ func (m moduleData) SiteRatingMode() (string, error) { } func (m moduleData) CategoryRatingMode(category string) (string, error) { - return m.repo.db.CategoryRatingMode(m.repo.ctx, category) + return m.repo.db.CategoryRatingMode(m.repo.ctx, m.repo.siteID(), category) } func (m moduleData) VoteStats(articleID int64) (db.VoteStats, error) { diff --git a/internal/repo/perms.go b/internal/repo/perms.go index 0f4198e6..ffd1aa52 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -76,7 +76,7 @@ func unverified(current *db.Site, u *db.User) bool { // Article is the object side for a page that exists. Its category is the only // step taken before the page's own overrides. func (p *Perms) Article(a *db.Article, u *db.User) (*perms.Object, error) { - overrides, err := p.db.CategoryOverrides(p.ctx, a.Category) + overrides, err := p.db.CategoryOverrides(p.ctx, ctxSiteID(p.ctx), a.Category) if err != nil { return nil, err } @@ -94,7 +94,7 @@ func (p *Perms) Article(a *db.Article, u *db.User) (*perms.Object, error) { // Category is the object side for a page that does not exist. A category with // no row of its own answers the same as no object at all. func (p *Perms) Category(name string) (*perms.Object, error) { - overrides, err := p.db.CategoryOverrides(p.ctx, name) + overrides, err := p.db.CategoryOverrides(p.ctx, ctxSiteID(p.ctx), name) if err != nil { return nil, err } @@ -116,7 +116,7 @@ func (p *Perms) ForumThread(t *db.ForumThread, u *db.User) (*perms.Object, error if err != nil { return nil, err } - overrides, err := p.db.CategoryOverrides(p.ctx, article.Category) + overrides, err := p.db.CategoryOverrides(p.ctx, ctxSiteID(p.ctx), article.Category) if err != nil { return nil, err } diff --git a/internal/repo/vars.go b/internal/repo/vars.go index d480dc4e..f8423a21 100644 --- a/internal/repo/vars.go +++ b/internal/repo/vars.go @@ -61,7 +61,7 @@ func (s *VarSource) SiteName() string { } func (s *VarSource) CategoryRatingMode(category string) (string, error) { - return s.db.CategoryRatingMode(s.ctx, category) + return s.db.CategoryRatingMode(s.ctx, s.siteID(), category) } func (s *VarSource) HasVoted(articleID int64, userID *int64) (bool, error) { @@ -116,3 +116,10 @@ func (s *VarSource) SiteDomain() string { func (s *VarSource) CategoryForm(category string) (*form.Definition, error) { return s.forms.CategoryForm(category) } + +func (s *VarSource) siteID() int64 { + if s.site == nil { + return 0 + } + return s.site.ID +} diff --git a/internal/webapi/allarticles.go b/internal/webapi/allarticles.go index 79de2d9d..b8501bbe 100644 --- a/internal/webapi/allarticles.go +++ b/internal/webapi/allarticles.go @@ -91,7 +91,7 @@ func (h *AllArticles) listing(ctx context.Context, current *db.Site, viewer *db. if err != nil { return "", err } - categoryModes, err := h.deps.DB.CategoryRatingModes(ctx) + categoryModes, err := h.deps.DB.CategoryRatingModes(ctx, siteID(ctx)) if err != nil { return "", err } diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index 4b9247ba..3b67b48f 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -391,7 +391,7 @@ func (h *Articles) rating(r *http.Request, article *db.Article) (page.Rating, er if err != nil && !errors.Is(err, db.ErrNotFound) { return page.Rating{}, err } - categoryMode, err := h.deps.DB.CategoryRatingMode(ctx, article.Category) + categoryMode, err := h.deps.DB.CategoryRatingMode(ctx, siteID(ctx), article.Category) if err != nil && !errors.Is(err, db.ErrNotFound) { return page.Rating{}, err } diff --git a/internal/webapi/update.go b/internal/webapi/update.go index 07e40576..390d1644 100644 --- a/internal/webapi/update.go +++ b/internal/webapi/update.go @@ -307,7 +307,7 @@ func (e *editor) mayCreateTags() (bool, error) { if err != nil && !errors.Is(err, db.ErrNotFound) { return false, err } - own, err := e.handler.deps.DB.CategoryCanCreateTags(ctx, e.article.Category) + own, err := e.handler.deps.DB.CategoryCanCreateTags(ctx, siteID(ctx), e.article.Category) if err != nil && !errors.Is(err, db.ErrNotFound) { return false, err } From 26a21d0056c31d385455cde64c810f765c3a9bf0 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 00:27:22 +0900 Subject: [PATCH 347/428] list forum sections and comment threads per site --- internal/admin/forumposts.go | 2 +- internal/admin/useractivity.go | 2 +- internal/db/forum.go | 45 ++++++++++++++------------ internal/db/forum_test.go | 12 +++---- internal/db/site_scope_pending_test.go | 38 +++++++++++----------- internal/db/site_scope_test.go | 1 + internal/modules/frontforum_db_test.go | 2 +- internal/repo/forumcategory_test.go | 2 +- internal/repo/forumnewthread_test.go | 2 +- internal/repo/forumstart_test.go | 2 +- internal/repo/forumthread_test.go | 2 +- internal/repo/modules.go | 10 +++--- internal/repo/recentposts_test.go | 2 +- internal/userpage/userpage.go | 2 +- 14 files changed, 64 insertions(+), 60 deletions(-) diff --git a/internal/admin/forumposts.go b/internal/admin/forumposts.go index af5ed8ed..4fa0ddfc 100644 --- a/internal/admin/forumposts.go +++ b/internal/admin/forumposts.go @@ -55,7 +55,7 @@ func (h *Handler) forumPosts(w http.ResponseWriter, r *http.Request, loc *i18n.L } func (h *Handler) recentPosts(ctx context.Context, comments bool, offset, limit int) ([]recentPostRow, error) { - categories, err := h.deps.DB.ForumCategories(ctx) + categories, err := h.deps.DB.ForumCategories(ctx, siteID(ctx)) if err != nil { return nil, err } diff --git a/internal/admin/useractivity.go b/internal/admin/useractivity.go index 6c1c6786..176ce5a3 100644 --- a/internal/admin/useractivity.go +++ b/internal/admin/useractivity.go @@ -173,7 +173,7 @@ func (h *Handler) userVotes(ctx context.Context, id int64, offset int) ([]userVo } func (h *Handler) userPosts(ctx context.Context, id int64, offset int) ([]userPostRow, error) { - categories, err := h.deps.DB.ForumCategories(ctx) + categories, err := h.deps.DB.ForumCategories(ctx, siteID(ctx)) if err != nil { return nil, err } diff --git a/internal/db/forum.go b/internal/db/forum.go index d66b9ebc..450db032 100644 --- a/internal/db/forum.go +++ b/internal/db/forum.go @@ -47,10 +47,11 @@ const forumSectionColumns = `id, name, description, is_hidden, is_hidden_for_use var qForumSections = register("ForumSections", ` SELECT `+forumSectionColumns+` FROM web_forumsection +WHERE site_id = $1 ORDER BY "order", id`) -func (d *DB) ForumSections(ctx context.Context) ([]ForumSection, error) { - rows, err := d.pool.Query(ctx, qForumSections) +func (d *DB) ForumSections(ctx context.Context, siteID int64) ([]ForumSection, error) { + rows, err := d.pool.Query(ctx, qForumSections, siteID) if err != nil { return nil, fmt.Errorf("query forum sections: %w", err) } @@ -86,12 +87,14 @@ func (d *DB) ForumSection(ctx context.Context, id int64) (*ForumSection, error) } var qForumCategories = register("ForumCategories", ` -SELECT id, section_id, name, description, is_for_comments -FROM web_forumcategory -ORDER BY "order", id`) - -func (d *DB) ForumCategories(ctx context.Context) ([]ForumCategory, error) { - rows, err := d.pool.Query(ctx, qForumCategories) +SELECT c.id, c.section_id, c.name, c.description, c.is_for_comments +FROM web_forumcategory c +JOIN web_forumsection s ON s.id = c.section_id +WHERE s.site_id = $1 +ORDER BY c."order", c.id`) + +func (d *DB) ForumCategories(ctx context.Context, siteID int64) ([]ForumCategory, error) { + rows, err := d.pool.Query(ctx, qForumCategories, siteID) if err != nil { return nil, fmt.Errorf("query forum categories: %w", err) } @@ -125,14 +128,14 @@ func (d *DB) ForumCategoryCounts(ctx context.Context, categoryID int64) (ForumCo // A category marked for comments counts every article's thread, whichever // category the reader is looking at. var qForumCommentCounts = register("ForumCommentCounts", ` -SELECT (SELECT count(*) FROM web_forumthread WHERE article_id IS NOT NULL), +SELECT (SELECT count(*) FROM web_forumthread WHERE site_id = $1 AND article_id IS NOT NULL), (SELECT count(*) FROM web_forumpost p JOIN web_forumthread t ON t.id = p.thread_id - WHERE t.article_id IS NOT NULL)`) + WHERE t.site_id = $1 AND t.article_id IS NOT NULL)`) -func (d *DB) ForumCommentCounts(ctx context.Context) (ForumCounts, error) { +func (d *DB) ForumCommentCounts(ctx context.Context, siteID int64) (ForumCounts, error) { var c ForumCounts - if err := d.pool.QueryRow(ctx, qForumCommentCounts).Scan(&c.Threads, &c.Posts); err != nil { + if err := d.pool.QueryRow(ctx, qForumCommentCounts, siteID).Scan(&c.Threads, &c.Posts); err != nil { return ForumCounts{}, fmt.Errorf("count forum comments: %w", err) } return c, nil @@ -156,12 +159,12 @@ var qForumCommentLastPost = register("ForumCommentLastPost", ` SELECT `+forumLastPostColumns+` FROM web_forumpost p JOIN web_forumthread t ON t.id = p.thread_id -WHERE t.article_id IS NOT NULL +WHERE t.site_id = $1 AND t.article_id IS NOT NULL ORDER BY p.created_at DESC LIMIT 1`) -func (d *DB) ForumCommentLastPost(ctx context.Context) (*ForumLastPost, error) { - return d.scanLastPost(ctx, qForumCommentLastPost) +func (d *DB) ForumCommentLastPost(ctx context.Context, siteID int64) (*ForumLastPost, error) { + return d.scanLastPost(ctx, qForumCommentLastPost, siteID) } func (d *DB) scanLastPost(ctx context.Context, sql string, args ...any) (*ForumLastPost, error) { @@ -215,16 +218,16 @@ OFFSET $2 LIMIT $3`) var qForumCommentThreadsByReply = register("ForumCommentThreadsByReply", ` SELECT `+forumThreadColumns+` FROM web_forumthread -WHERE article_id IS NOT NULL +WHERE site_id = $1 AND article_id IS NOT NULL ORDER BY is_pinned DESC, updated_at DESC -OFFSET $1 LIMIT $2`) +OFFSET $2 LIMIT $3`) var qForumCommentThreadsByStart = register("ForumCommentThreadsByStart", ` SELECT `+forumThreadColumns+` FROM web_forumthread -WHERE article_id IS NOT NULL +WHERE site_id = $1 AND article_id IS NOT NULL ORDER BY is_pinned DESC, created_at DESC -OFFSET $1 LIMIT $2`) +OFFSET $2 LIMIT $3`) func (d *DB) ForumThreads(ctx context.Context, categoryID int64, sort ForumThreadSort, offset, limit int) ([]ForumThread, error) { sql, args := qForumThreadsByReply, []any{categoryID, offset, limit} @@ -234,12 +237,12 @@ func (d *DB) ForumThreads(ctx context.Context, categoryID int64, sort ForumThrea return d.scanThreads(ctx, sql, args...) } -func (d *DB) ForumCommentThreads(ctx context.Context, sort ForumThreadSort, offset, limit int) ([]ForumThread, error) { +func (d *DB) ForumCommentThreads(ctx context.Context, siteID int64, sort ForumThreadSort, offset, limit int) ([]ForumThread, error) { sql := qForumCommentThreadsByReply if sort == ForumThreadsByStart { sql = qForumCommentThreadsByStart } - return d.scanThreads(ctx, sql, offset, limit) + return d.scanThreads(ctx, sql, siteID, offset, limit) } func (d *DB) scanThreads(ctx context.Context, sql string, args ...any) ([]ForumThread, error) { diff --git a/internal/db/forum_test.go b/internal/db/forum_test.go index b3161647..e969cd68 100644 --- a/internal/db/forum_test.go +++ b/internal/db/forum_test.go @@ -25,7 +25,7 @@ func forumDB(t *testing.T) (*DB, context.Context) { func TestForumSectionsComeBackInOrder(t *testing.T) { d, ctx := forumDB(t) - sections, err := d.ForumSections(ctx) + sections, err := d.ForumSections(ctx, seedSiteID(t, d)) if err != nil { t.Fatalf("ForumSections() err = %v, want nil", err) } @@ -57,7 +57,7 @@ func TestForumSectionsComeBackInOrder(t *testing.T) { func TestForumSectionByID(t *testing.T) { d, ctx := forumDB(t) - sections, err := d.ForumSections(ctx) + sections, err := d.ForumSections(ctx, seedSiteID(t, d)) if err != nil { t.Fatalf("ForumSections() err = %v, want nil", err) } @@ -79,7 +79,7 @@ func TestForumSectionOfAnUnknownID(t *testing.T) { func TestForumCategoriesComeBackInOrder(t *testing.T) { d, ctx := forumDB(t) - categories, err := d.ForumCategories(ctx) + categories, err := d.ForumCategories(ctx, seedSiteID(t, d)) if err != nil { t.Fatalf("ForumCategories() err = %v, want nil", err) } @@ -97,7 +97,7 @@ func TestForumCategoriesComeBackInOrder(t *testing.T) { func categoryNamed(t *testing.T, d *DB, ctx context.Context, name string) ForumCategory { t.Helper() - categories, err := d.ForumCategories(ctx) + categories, err := d.ForumCategories(ctx, seedSiteID(t, d)) if err != nil { t.Fatalf("ForumCategories() err = %v, want nil", err) } @@ -178,7 +178,7 @@ func TestForumCommentCountsReachEveryArticle(t *testing.T) { t.Errorf("ForumCategoryCounts(comments) = %+v, want zeroes", byCategory) } - got, err := d.ForumCommentCounts(ctx) + got, err := d.ForumCommentCounts(ctx, seedSiteID(t, d)) if err != nil { t.Fatalf("ForumCommentCounts() err = %v, want nil", err) } @@ -192,7 +192,7 @@ func TestForumCommentCountsReachEveryArticle(t *testing.T) { func TestForumCommentLastPostComesFromAnArticleThread(t *testing.T) { d, ctx := forumDB(t) - got, err := d.ForumCommentLastPost(ctx) + got, err := d.ForumCommentLastPost(ctx, seedSiteID(t, d)) if err != nil { t.Fatalf("ForumCommentLastPost() err = %v, want nil", err) } diff --git a/internal/db/site_scope_pending_test.go b/internal/db/site_scope_pending_test.go index 7911de38..e5715ffe 100644 --- a/internal/db/site_scope_pending_test.go +++ b/internal/db/site_scope_pending_test.go @@ -7,7 +7,6 @@ var siteScopePending = []string{ "AdminCategory", "AdminCategoryOverrides", "AdminForumCategories", - "AdminForumSection", "AdminForumSections", "AdminInviteCount", "AdminInvites", @@ -41,7 +40,6 @@ var siteScopePending = []string{ "DeleteArticle.13", "DeleteArticle.14", "DeleteCategory", - "DeleteForumSection", "DeleteInvite", "DeleteRole", "DeleteRoleCategory", @@ -55,18 +53,6 @@ var siteScopePending = []string{ "FavouritesOf", "FindTag", "FindTagCategory", - "ForumCategoryCounts", - "ForumCategoryLastPost", - "ForumCommentCounts", - "ForumCommentLastPost", - "ForumCommentThreadsByReply", - "ForumCommentThreadsByStart", - "ForumSection", - "ForumSections", - "ForumThread", - "ForumThreadsByReply", - "ForumThreadsByStart", - "ForumThreadsInCategories", "GrantTicketRole", "InsertCategory", "InsertForumSection", @@ -85,8 +71,6 @@ var siteScopePending = []string{ "OperationIndex", "RatedBy", "ReadArticleTitle", - "RecentPostCount", - "RecentPosts", "RenameArticle", "Report", "ReportsSince", @@ -109,18 +93,34 @@ var siteScopePending = []string{ "TouchForumThread", "UpdateArticleTitle", "UpdateCategory", - "UpdateForumSection", "UpdateRole", "UpdateRoleCategory", "UpdateTag", "UpdateTagCat", "UpdateTheme", - "UserPostCount", - "UserPosts", "WriteAdminNote", } var siteScopeByKey = []string{ + "ForumCategory", + "AdminForumCategory", + "InsertForumCategory", + "UpdateForumCategory", + "DeleteForumCategory", + "ForumSection", + "AdminForumSection", + "UpdateForumSection", + "DeleteForumSection", + "ForumThread", + "ForumThreadsByStart", + "ForumThreadsByReply", + "ForumThreadsInCategories", + "ForumCategoryCounts", + "ForumCategoryLastPost", + "RecentPosts", + "RecentPostCount", + "UserPosts", + "UserPostCount", "ArticleByID", "ChildCount", "CommentCount", diff --git a/internal/db/site_scope_test.go b/internal/db/site_scope_test.go index d4245c09..cea7df3a 100644 --- a/internal/db/site_scope_test.go +++ b/internal/db/site_scope_test.go @@ -17,6 +17,7 @@ var perSiteTables = []string{ "web_role", "web_rolecategory", "web_forumsection", + "web_forumcategory", "web_forumthread", "web_theme", "web_invitelink", diff --git a/internal/modules/frontforum_db_test.go b/internal/modules/frontforum_db_test.go index 352b80a6..43bb98f0 100644 --- a/internal/modules/frontforum_db_test.go +++ b/internal/modules/frontforum_db_test.go @@ -26,7 +26,7 @@ func (l forumLiveData) Subject(*db.User) (perms.Subject, error) { } func (l forumLiveData) ForumCategories() ([]db.ForumCategory, error) { - return l.d.ForumCategories(l.ctx) + return l.d.ForumCategories(l.ctx, onlySiteID(l.ctx, l.d)) } func (l forumLiveData) ForumThreadsInCategories(ids []int64, offset, limit int) ([]db.ForumThread, error) { diff --git a/internal/repo/forumcategory_test.go b/internal/repo/forumcategory_test.go index 5b3a33d1..6e8bf4a2 100644 --- a/internal/repo/forumcategory_test.go +++ b/internal/repo/forumcategory_test.go @@ -55,7 +55,7 @@ func TestForumCategoryMatchesGolden(t *testing.T) { if err != nil { t.Fatalf("ArticleByName(forum:category) err = %v, want nil", err) } - categories, err := d.ForumCategories(ctx) + categories, err := d.ForumCategories(ctx, onlySiteID(ctx, d)) if err != nil { t.Fatalf("ForumCategories() err = %v, want nil", err) } diff --git a/internal/repo/forumnewthread_test.go b/internal/repo/forumnewthread_test.go index 5686320e..728821f9 100644 --- a/internal/repo/forumnewthread_test.go +++ b/internal/repo/forumnewthread_test.go @@ -51,7 +51,7 @@ func TestForumNewThreadMatchesGolden(t *testing.T) { if err != nil { t.Fatalf("ArticleByName(forum:new-thread) err = %v, want nil", err) } - categories, err := d.ForumCategories(ctx) + categories, err := d.ForumCategories(ctx, onlySiteID(ctx, d)) if err != nil { t.Fatalf("ForumCategories() err = %v, want nil", err) } diff --git a/internal/repo/forumstart_test.go b/internal/repo/forumstart_test.go index b116cd2e..c0c7426c 100644 --- a/internal/repo/forumstart_test.go +++ b/internal/repo/forumstart_test.go @@ -60,7 +60,7 @@ func TestForumStartMatchesGolden(t *testing.T) { if err != nil { t.Fatalf("ArticleByName(forum:start) err = %v, want nil", err) } - sections, err := d.ForumSections(ctx) + sections, err := d.ForumSections(ctx, onlySiteID(ctx, d)) if err != nil { t.Fatalf("ForumSections() err = %v, want nil", err) } diff --git a/internal/repo/forumthread_test.go b/internal/repo/forumthread_test.go index fa87a95b..c853441b 100644 --- a/internal/repo/forumthread_test.go +++ b/internal/repo/forumthread_test.go @@ -160,7 +160,7 @@ func forumThreadPath(t *testing.T, ctx context.Context, d *db.DB, c forumThreadC func threadIDByName(t *testing.T, ctx context.Context, d *db.DB, name string) int64 { t.Helper() - categories, err := d.ForumCategories(ctx) + categories, err := d.ForumCategories(ctx, onlySiteID(ctx, d)) if err != nil { t.Fatalf("ForumCategories() err = %v, want nil", err) } diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 643d94ba..663244f4 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -162,7 +162,7 @@ func (m moduleData) RenderUserByID(id *int64) (string, error) { } func (m moduleData) ForumSections() ([]db.ForumSection, error) { - return m.repo.db.ForumSections(m.repo.ctx) + return m.repo.db.ForumSections(m.repo.ctx, m.repo.siteID()) } func (m moduleData) ForumSection(id int64) (*db.ForumSection, error) { @@ -170,7 +170,7 @@ func (m moduleData) ForumSection(id int64) (*db.ForumSection, error) { } func (m moduleData) ForumCategories() ([]db.ForumCategory, error) { - return m.repo.db.ForumCategories(m.repo.ctx) + return m.repo.db.ForumCategories(m.repo.ctx, m.repo.siteID()) } func (m moduleData) ForumCategoryCounts(categoryID int64) (db.ForumCounts, error) { @@ -178,7 +178,7 @@ func (m moduleData) ForumCategoryCounts(categoryID int64) (db.ForumCounts, error } func (m moduleData) ForumCommentCounts() (db.ForumCounts, error) { - return m.repo.db.ForumCommentCounts(m.repo.ctx) + return m.repo.db.ForumCommentCounts(m.repo.ctx, m.repo.siteID()) } func (m moduleData) ForumCategoryLastPost(categoryID int64) (*db.ForumLastPost, error) { @@ -186,7 +186,7 @@ func (m moduleData) ForumCategoryLastPost(categoryID int64) (*db.ForumLastPost, } func (m moduleData) ForumCommentLastPost() (*db.ForumLastPost, error) { - return m.repo.db.ForumCommentLastPost(m.repo.ctx) + return m.repo.db.ForumCommentLastPost(m.repo.ctx, m.repo.siteID()) } func (m moduleData) Subject(user *db.User) (perms.Subject, error) { @@ -206,7 +206,7 @@ func (m moduleData) ForumThreads(categoryID int64, sort db.ForumThreadSort, offs } func (m moduleData) ForumCommentThreads(sort db.ForumThreadSort, offset, limit int) ([]db.ForumThread, error) { - return m.repo.db.ForumCommentThreads(m.repo.ctx, sort, offset, limit) + return m.repo.db.ForumCommentThreads(m.repo.ctx, m.repo.siteID(), sort, offset, limit) } func (m moduleData) ForumThreadPostCount(threadID int64) (int, error) { diff --git a/internal/repo/recentposts_test.go b/internal/repo/recentposts_test.go index f3cecd20..35dbbd4e 100644 --- a/internal/repo/recentposts_test.go +++ b/internal/repo/recentposts_test.go @@ -70,7 +70,7 @@ func TestRecentPostsMatchesGolden(t *testing.T) { if err != nil { t.Fatalf("ArticleByName(forum:recent-posts) err = %v, want nil", err) } - categories, err := d.ForumCategories(ctx) + categories, err := d.ForumCategories(ctx, onlySiteID(ctx, d)) if err != nil { t.Fatalf("ForumCategories() err = %v, want nil", err) } diff --git a/internal/userpage/userpage.go b/internal/userpage/userpage.go index 84cc4ab4..32bd3354 100644 --- a/internal/userpage/userpage.go +++ b/internal/userpage/userpage.go @@ -306,7 +306,7 @@ func (h *Handler) posts(r *http.Request, loc *i18n.Localizer, site *db.Site, var ids []int64 var comments bool if perms.Resolve(subject, nil).Has(perms.ViewForumCategories) { - categories, err := h.deps.DB.ForumCategories(ctx) + categories, err := h.deps.DB.ForumCategories(ctx, siteID(ctx)) if err != nil { return shell.ProfileFeed{}, err } From 5bf6a745f802e11f2f6bdeb30cb953ac88b1addf Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 00:49:05 +0900 Subject: [PATCH 348/428] scope the remaining queries to a site --- internal/account/tickets.go | 2 +- internal/admin/adminlog.go | 4 +- internal/admin/category.go | 6 +-- internal/admin/dashboard.go | 12 +++--- internal/admin/forum.go | 8 ++-- internal/admin/pages.go | 4 +- internal/admin/report.go | 2 +- internal/admin/role.go | 12 +++--- internal/admin/site.go | 2 +- internal/admin/tag.go | 10 ++--- internal/admin/theme.go | 4 +- internal/admin/ticket.go | 4 +- internal/admin/user.go | 8 ++-- internal/admin/useractions.go | 8 ++-- internal/admin/useractivity.go | 5 ++- internal/db/account_write.go | 16 +++---- internal/db/account_write_test.go | 2 +- internal/db/address.go | 19 ++++---- internal/db/category_admin.go | 14 +++--- internal/db/favourite_write.go | 6 +-- internal/db/favourite_write_test.go | 4 +- internal/db/forum_admin.go | 19 ++++---- internal/db/forum_write.go | 8 ++-- internal/db/listpages.go | 3 ++ internal/db/message.go | 6 +-- internal/db/message_write.go | 8 ++-- internal/db/message_write_test.go | 4 +- internal/db/mypages.go | 12 +++--- internal/db/options.go | 12 +++--- internal/db/page_admin.go | 17 ++++---- internal/db/report_admin.go | 10 ++--- internal/db/role_write.go | 32 +++++++------- internal/db/search.go | 9 ++-- internal/db/site_scope_pending_test.go | 60 ++------------------------ internal/db/site_scope_test.go | 16 +++++++ internal/db/sitechanges.go | 9 ++-- internal/db/tag.go | 29 +++++++------ internal/db/tag_admin.go | 28 ++++++------ internal/db/tag_test.go | 8 ++-- internal/db/tag_write.go | 33 +++++++------- internal/db/tag_write_test.go | 18 ++++---- internal/db/theme_write.go | 14 +++--- internal/db/ticket_admin.go | 26 +++++------ internal/db/user_admin.go | 10 ++--- internal/listpages/params_db_test.go | 2 +- internal/repo/modules.go | 26 +++++++---- internal/userpage/userpage.go | 1 + internal/webapi/allarticles.go | 2 +- internal/webapi/favourites.go | 2 +- internal/webapi/invite.go | 2 +- internal/webapi/mypages.go | 4 +- internal/webapi/reports.go | 4 +- internal/webapi/update.go | 2 +- 53 files changed, 286 insertions(+), 302 deletions(-) diff --git a/internal/account/tickets.go b/internal/account/tickets.go index c6bb3584..d7d27d76 100644 --- a/internal/account/tickets.go +++ b/internal/account/tickets.go @@ -77,7 +77,7 @@ func (h *TicketHandler) submit(w http.ResponseWriter, r *http.Request) { subject := clip(strings.TrimSpace(r.PostFormValue("subject")), maxTicketSubject) page := strings.TrimSpace(r.PostFormValue("page")) - if _, err := h.deps.DB.CreateTicket(ctx, kind, subject, body, page, user.ID, time.Now()); err != nil { + if _, err := h.deps.DB.CreateTicket(ctx, siteID(ctx), kind, subject, body, page, user.ID, time.Now()); err != nil { h.deps.logger().Error("submit ticket", "user", user.ID, "err", err) back(w, r, "applied", "failed") return diff --git a/internal/admin/adminlog.go b/internal/admin/adminlog.go index 8b781cb8..087a940b 100644 --- a/internal/admin/adminlog.go +++ b/internal/admin/adminlog.go @@ -52,7 +52,7 @@ func (h *Handler) adminLog(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if page < 1 { page = 1 } - found, err := h.deps.DB.AdminNotes(ctx, screen, adminLogPerPage+1, (page-1)*adminLogPerPage) + found, err := h.deps.DB.AdminNotes(ctx, siteID(ctx), screen, adminLogPerPage+1, (page-1)*adminLogPerPage) if err != nil { return err } @@ -60,7 +60,7 @@ func (h *Handler) adminLog(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if more { found = found[:adminLogPerPage] } - screens, err := h.deps.DB.AdminNoteScreens(ctx) + screens, err := h.deps.DB.AdminNoteScreens(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/category.go b/internal/admin/category.go index b300056a..0ec932eb 100644 --- a/internal/admin/category.go +++ b/internal/admin/category.go @@ -24,7 +24,7 @@ func (h *Handler) pageCategories(w http.ResponseWriter, r *http.Request, loc *i1 return h.savePageCategory(w, r, loc, rest) } if rest == "" { - found, err := h.deps.DB.AdminCategories(r.Context()) + found, err := h.deps.DB.AdminCategories(r.Context(), siteID(r.Context())) if err != nil { return err } @@ -142,7 +142,7 @@ func (h *Handler) savePageCategory(w http.ResponseWriter, r *http.Request, loc * if row.ID == 0 { did = db.AdminCreated } - if err := h.deps.DB.SaveCategory(ctx, row); err != nil { + if err := h.deps.DB.SaveCategory(ctx, siteID(ctx), row); err != nil { return err } @@ -155,7 +155,7 @@ func (h *Handler) savePageCategory(w http.ResponseWriter, r *http.Request, loc * return nil } if row.ID == 0 { - found, err := h.deps.DB.AdminCategories(ctx) + found, err := h.deps.DB.AdminCategories(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/dashboard.go b/internal/admin/dashboard.go index 528f09bb..9647a8b2 100644 --- a/internal/admin/dashboard.go +++ b/internal/admin/dashboard.go @@ -77,28 +77,28 @@ func (h *Handler) index(w http.ResponseWriter, r *http.Request, loc *i18n.Locali func (h *Handler) queue(ctx context.Context, loc *i18n.Localizer, granted perms.Set) ([]queueItem, error) { var out []queueItem if granted.Has(perms.ViewUserReports) { - _, total, err := h.deps.DB.AdminReports(ctx, db.ReportPending, 1, 0) + _, total, err := h.deps.DB.AdminReports(ctx, siteID(ctx), db.ReportPending, 1, 0) if err != nil { return nil, err } out = append(out, queueItem{Prefix + reportSlug + "/?status=" + db.ReportPending, loc.T("admin.reports"), total}) } if granted.Has(perms.ViewUserTickets) { - _, total, err := h.deps.DB.AdminTickets(ctx, db.TicketKind, db.TicketPending, 1, 0) + _, total, err := h.deps.DB.AdminTickets(ctx, siteID(ctx), db.TicketKind, db.TicketPending, 1, 0) if err != nil { return nil, err } out = append(out, queueItem{Prefix + ticketSlug + "/?status=" + db.TicketPending, loc.T("admin.tickets"), total}) } if granted.Has(perms.ReviewMembershipApplications) { - _, total, err := h.deps.DB.AdminTickets(ctx, db.MembershipApplyKind, db.TicketPending, 1, 0) + _, total, err := h.deps.DB.AdminTickets(ctx, siteID(ctx), db.MembershipApplyKind, db.TicketPending, 1, 0) if err != nil { return nil, err } out = append(out, queueItem{Prefix + membershipSlug + "/?status=" + db.TicketPending, loc.T("admin.membership"), total}) } if granted.Has(perms.ManageUsers) { - total, err := h.deps.DB.OpenInviteCount(ctx) + total, err := h.deps.DB.OpenInviteCount(ctx, siteID(ctx)) if err != nil { return nil, err } @@ -108,7 +108,7 @@ func (h *Handler) queue(ctx context.Context, loc *i18n.Localizer, granted perms. } func (h *Handler) recentChanges(ctx context.Context, loc *i18n.Localizer) ([]changeRow, error) { - found, err := h.deps.DB.SiteChanges(ctx, db.SiteChangeFilter{}, 0, dashboardRows) + found, err := h.deps.DB.SiteChanges(ctx, db.SiteChangeFilter{SiteID: siteID(ctx)}, 0, dashboardRows) if err != nil { return nil, err } @@ -155,7 +155,7 @@ func (h *Handler) recentChanges(ctx context.Context, loc *i18n.Localizer) ([]cha } func (h *Handler) recentActions(ctx context.Context) ([]actionRow, error) { - found, err := h.deps.DB.AdminNotes(ctx, "", dashboardRows, 0) + found, err := h.deps.DB.AdminNotes(ctx, siteID(ctx), "", dashboardRows, 0) if err != nil { return nil, err } diff --git a/internal/admin/forum.go b/internal/admin/forum.go index c2367f10..35ea088e 100644 --- a/internal/admin/forum.go +++ b/internal/admin/forum.go @@ -61,7 +61,7 @@ func (h *Handler) forumSections(w http.ResponseWriter, r *http.Request, loc *i18 if row.ID == 0 { did = db.AdminCreated } - if err := h.deps.DB.SaveForumSection(ctx, row); err != nil { + if err := h.deps.DB.SaveForumSection(ctx, siteID(ctx), row); err != nil { return err } h.noteID(r, did, sectionSlug, row.ID, row.Name) @@ -70,7 +70,7 @@ func (h *Handler) forumSections(w http.ResponseWriter, r *http.Request, loc *i18 } if rest == "" { - found, err := h.deps.DB.AdminForumSections(ctx) + found, err := h.deps.DB.AdminForumSections(ctx, siteID(ctx)) if err != nil { return err } @@ -162,7 +162,7 @@ func (h *Handler) forumCategories(w http.ResponseWriter, r *http.Request, loc *i } if rest == "" { - found, err := h.deps.DB.AdminForumCategories(ctx) + found, err := h.deps.DB.AdminForumCategories(ctx, siteID(ctx)) if err != nil { return err } @@ -193,7 +193,7 @@ func (h *Handler) forumCategoryForm(w http.ResponseWriter, r *http.Request, loc return err } } - sections, err := h.deps.DB.AdminForumSections(ctx) + sections, err := h.deps.DB.AdminForumSections(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/pages.go b/internal/admin/pages.go index 29e93cd9..3c0b4315 100644 --- a/internal/admin/pages.go +++ b/internal/admin/pages.go @@ -54,11 +54,11 @@ func (h *Handler) pageList(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if page < 1 { page = 1 } - found, total, err := h.deps.DB.AdminPages(ctx, query, category, perPage, (page-1)*perPage) + found, total, err := h.deps.DB.AdminPages(ctx, siteID(ctx), query, category, perPage, (page-1)*perPage) if err != nil { return err } - categories, err := h.deps.DB.AdminPageCategories(ctx) + categories, err := h.deps.DB.AdminPageCategories(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/report.go b/internal/admin/report.go index 32581940..ab870ff1 100644 --- a/internal/admin/report.go +++ b/internal/admin/report.go @@ -43,7 +43,7 @@ func (h *Handler) reportList(w http.ResponseWriter, r *http.Request, loc *i18n.L if page < 1 { page = 1 } - found, total, err := h.deps.DB.AdminReports(r.Context(), status, perPage, (page-1)*perPage) + found, total, err := h.deps.DB.AdminReports(r.Context(), siteID(r.Context()), status, perPage, (page-1)*perPage) if err != nil { return err } diff --git a/internal/admin/role.go b/internal/admin/role.go index 1737d5ca..47090d5c 100644 --- a/internal/admin/role.go +++ b/internal/admin/role.go @@ -38,7 +38,7 @@ func (h *Handler) roles(w http.ResponseWriter, r *http.Request, loc *i18n.Locali return h.saveRole(w, r, loc, rest) } if rest == "" { - found, err := h.deps.DB.AdminRoles(r.Context()) + found, err := h.deps.DB.AdminRoles(r.Context(), siteID(r.Context())) if err != nil { return err } @@ -82,7 +82,7 @@ func (h *Handler) roleForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if err != nil { return err } - categories, err := h.deps.DB.RoleCategories(ctx) + categories, err := h.deps.DB.RoleCategories(ctx, siteID(ctx)) if err != nil { return err } @@ -208,7 +208,7 @@ func (h *Handler) saveRole(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if next.ID == 0 { did = db.AdminCreated } - if _, err := h.deps.DB.SaveRole(ctx, next, mayGrant); err != nil { + if _, err := h.deps.DB.SaveRole(ctx, siteID(ctx), next, mayGrant); err != nil { return err } h.noteID(r, did, roleSlug, next.ID, next.Slug) @@ -227,7 +227,7 @@ func (h *Handler) outranked(ctx context.Context, row db.RoleRow) (bool, error) { if user.IsSuperuser { return false, nil } - mine, err := h.deps.DB.OperationIndex(ctx, user.ID) + mine, err := h.deps.DB.OperationIndex(ctx, siteID(ctx), user.ID) if err != nil { return false, err } @@ -277,7 +277,7 @@ func (h *Handler) roleCategories(w http.ResponseWriter, r *http.Request, loc *i1 if row.ID == 0 { did = db.AdminCreated } - if err := h.deps.DB.SaveRoleCategory(ctx, row); err != nil { + if err := h.deps.DB.SaveRoleCategory(ctx, siteID(ctx), row); err != nil { return err } h.noteID(r, did, roleCategorySlug, row.ID, row.Name) @@ -288,7 +288,7 @@ func (h *Handler) roleCategories(w http.ResponseWriter, r *http.Request, loc *i1 } func (h *Handler) roleCategoryList(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, problem string) error { - found, err := h.deps.DB.RoleCategories(r.Context()) + found, err := h.deps.DB.RoleCategories(r.Context(), siteID(r.Context())) if err != nil { return err } diff --git a/internal/admin/site.go b/internal/admin/site.go index 0ab34bc0..17a2d0e0 100644 --- a/internal/admin/site.go +++ b/internal/admin/site.go @@ -38,7 +38,7 @@ func (h *Handler) siteForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if err != nil { return err } - themes, err := h.deps.DB.Themes(ctx) + themes, err := h.deps.DB.Themes(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/tag.go b/internal/admin/tag.go index 20ad4902..74e7e64f 100644 --- a/internal/admin/tag.go +++ b/internal/admin/tag.go @@ -57,7 +57,7 @@ func (h *Handler) tags(w http.ResponseWriter, r *http.Request, loc *i18n.Localiz if row.ID == 0 { did = db.AdminCreated } - if err := h.deps.DB.SaveTag(ctx, row); err != nil { + if err := h.deps.DB.SaveTag(ctx, siteID(ctx), row); err != nil { return err } h.noteID(r, did, tagSlug, row.ID, row.Name) @@ -71,7 +71,7 @@ func (h *Handler) tags(w http.ResponseWriter, r *http.Request, loc *i18n.Localiz if page < 1 { page = 1 } - found, total, err := h.deps.DB.AdminTags(ctx, query, perPage, (page-1)*perPage) + found, total, err := h.deps.DB.AdminTags(ctx, siteID(ctx), query, perPage, (page-1)*perPage) if err != nil { return err } @@ -107,7 +107,7 @@ func (h *Handler) tagForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loca return err } } - categories, err := h.deps.DB.AdminTagCategories(ctx) + categories, err := h.deps.DB.AdminTagCategories(ctx, siteID(ctx)) if err != nil { return err } @@ -161,7 +161,7 @@ func (h *Handler) tagCategories(w http.ResponseWriter, r *http.Request, loc *i18 if row.ID == 0 { did = db.AdminCreated } - if err := h.deps.DB.SaveTagCategory(ctx, row); err != nil { + if err := h.deps.DB.SaveTagCategory(ctx, siteID(ctx), row); err != nil { return err } h.noteID(r, did, tagCategorySlug, row.ID, row.Name) @@ -170,7 +170,7 @@ func (h *Handler) tagCategories(w http.ResponseWriter, r *http.Request, loc *i18 } if rest == "" { - found, err := h.deps.DB.AdminTagCategories(ctx) + found, err := h.deps.DB.AdminTagCategories(ctx, siteID(ctx)) if err != nil { return err } diff --git a/internal/admin/theme.go b/internal/admin/theme.go index 0c101529..c36e0fd6 100644 --- a/internal/admin/theme.go +++ b/internal/admin/theme.go @@ -36,7 +36,7 @@ func (h *Handler) themes(w http.ResponseWriter, r *http.Request, loc *i18n.Local } func (h *Handler) themeList(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer) error { - found, err := h.deps.DB.Themes(r.Context()) + found, err := h.deps.DB.Themes(r.Context(), siteID(r.Context())) if err != nil { return err } @@ -116,7 +116,7 @@ func (h *Handler) saveThemeForm(w http.ResponseWriter, r *http.Request, loc *i18 if row.ID == 0 { did = db.AdminCreated } - id, err := h.deps.DB.SaveTheme(r.Context(), row) + id, err := h.deps.DB.SaveTheme(r.Context(), siteID(r.Context()), row) if err != nil { return err } diff --git a/internal/admin/ticket.go b/internal/admin/ticket.go index e647ee8d..46558b48 100644 --- a/internal/admin/ticket.go +++ b/internal/admin/ticket.go @@ -96,7 +96,7 @@ func (h *Handler) ticketScreen(w http.ResponseWriter, r *http.Request, loc *i18n if page < 1 { page = 1 } - found, total, err := h.deps.DB.AdminTickets(ctx, kind, status, perPage, (page-1)*perPage) + found, total, err := h.deps.DB.AdminTickets(ctx, siteID(ctx), kind, status, perPage, (page-1)*perPage) if err != nil { return err } @@ -172,7 +172,7 @@ func (h *Handler) invites(w http.ResponseWriter, r *http.Request, loc *i18n.Loca if page < 1 { page = 1 } - found, total, err := h.deps.DB.AdminInvites(ctx, perPage, (page-1)*perPage) + found, total, err := h.deps.DB.AdminInvites(ctx, siteID(ctx), perPage, (page-1)*perPage) if err != nil { return err } diff --git a/internal/admin/user.go b/internal/admin/user.go index 03495a89..a4de35ae 100644 --- a/internal/admin/user.go +++ b/internal/admin/user.go @@ -111,7 +111,7 @@ func (h *Handler) userForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc notFound(w) return nil } - row, err := h.deps.DB.AdminUser(ctx, id) + row, err := h.deps.DB.AdminUser(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -177,7 +177,7 @@ func (h *Handler) saveUser(w http.ResponseWriter, r *http.Request, loc *i18n.Loc notFound(w) return nil } - stored, err := h.deps.DB.AdminUser(ctx, id) + stored, err := h.deps.DB.AdminUser(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -230,7 +230,7 @@ func (h *Handler) saveUser(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if next.Username == "" { return h.userForm(w, r, loc, rest, loc.T("admin.user-no-name")) } - err = h.deps.DB.SaveAdminUser(ctx, next, builtinRoles, maySetRoles, maySuper) + err = h.deps.DB.SaveAdminUser(ctx, siteID(ctx), next, builtinRoles, maySetRoles, maySuper) if err != nil { return err } @@ -247,7 +247,7 @@ func (h *Handler) mayEdit(ctx context.Context, target db.AdminUserRow) (bool, er if mine.IsSuperuser { return true, nil } - rank, err := h.deps.DB.OperationIndex(ctx, mine.ID) + rank, err := h.deps.DB.OperationIndex(ctx, siteID(ctx), mine.ID) if err != nil { return false, err } diff --git a/internal/admin/useractions.go b/internal/admin/useractions.go index 2318e6cd..027ac50b 100644 --- a/internal/admin/useractions.go +++ b/internal/admin/useractions.go @@ -208,7 +208,7 @@ func (h *Handler) saveClaimLink(w http.ResponseWriter, r *http.Request, loc *i18 if err != nil { return h.claimLink(w, r, loc, loc.T("admin.claim-no-user"), "") } - row, err := h.deps.DB.AdminUser(ctx, id) + row, err := h.deps.DB.AdminUser(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) || row.Type != db.UserTypeWikidot || row.IsActive { return h.claimLink(w, r, loc, loc.T("admin.claim-no-user"), "") } @@ -240,7 +240,7 @@ func (h *Handler) mintLinkAs(w http.ResponseWriter, r *http.Request, kind, deliv if by := auth.FromContext(ctx); by != nil { owner = &by.ID } - if _, err := h.deps.DB.CreateInviteLink(ctx, kind, delivery, email, wikidotName, + if _, err := h.deps.DB.CreateInviteLink(ctx, siteID(ctx), kind, delivery, email, wikidotName, minted, uid, owner, id, now); err != nil { return "", err } @@ -254,7 +254,7 @@ func (h *Handler) resetVotes(w http.ResponseWriter, r *http.Request, loc *i18n.L notFound(w) return nil } - row, err := h.deps.DB.AdminUser(ctx, id) + row, err := h.deps.DB.AdminUser(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -406,7 +406,7 @@ func (h *Handler) activate(w http.ResponseWriter, r *http.Request, loc *i18n.Loc notFound(w) return nil } - row, err := h.deps.DB.AdminUser(r.Context(), id) + row, err := h.deps.DB.AdminUser(r.Context(), siteID(r.Context()), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil diff --git a/internal/admin/useractivity.go b/internal/admin/useractivity.go index 176ce5a3..4a2b73da 100644 --- a/internal/admin/useractivity.go +++ b/internal/admin/useractivity.go @@ -54,7 +54,7 @@ func (h *Handler) userActivity(w http.ResponseWriter, r *http.Request, loc *i18n notFound(w) return nil } - row, err := h.deps.DB.AdminUser(ctx, id) + row, err := h.deps.DB.AdminUser(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -123,6 +123,7 @@ func (h *Handler) userEdits(ctx context.Context, loc *i18n.Localizer, id int64, return nil, err } found, err := h.deps.DB.SiteChanges(ctx, db.SiteChangeFilter{ + SiteID: siteID(ctx), Hidden: hidden, HasUser: true, UserIDs: []int64{id}, @@ -155,7 +156,7 @@ func (h *Handler) userEdits(ctx context.Context, loc *i18n.Localizer, id int64, } func (h *Handler) userVotes(ctx context.Context, id int64, offset int) ([]userVoteRow, error) { - found, err := h.deps.DB.RatedBy(ctx, id, offset, activityPerPage) + found, err := h.deps.DB.RatedBy(ctx, siteID(ctx), id, offset, activityPerPage) if err != nil { return nil, err } diff --git a/internal/db/account_write.go b/internal/db/account_write.go index 6b0e6250..544f4764 100644 --- a/internal/db/account_write.go +++ b/internal/db/account_write.go @@ -239,16 +239,16 @@ func (d *DB) ActivateInviteLink(ctx context.Context, token, username string, at var qCreateInviteLink = register("CreateInviteLink", ` INSERT INTO web_invitelink (kind, delivery, email, wikidot_username, token, uidb64, - created_at, activated_username, created_by_id, target_id) -VALUES ($1, $2, $3, $4, $5, $6, $7, '', $8, $9) + created_at, activated_username, created_by_id, target_id, site_id) +VALUES ($1, $2, $3, $4, $5, $6, $7, '', $8, $9, $10) RETURNING id`) -func (d *DB) CreateInviteLink(ctx context.Context, kind, delivery, email, wikidotName, +func (d *DB) CreateInviteLink(ctx context.Context, siteID int64, kind, delivery, email, wikidotName, token, uid string, createdBy *int64, target int64, at time.Time) (int64, error) { var id int64 err := d.pool.QueryRow(ctx, qCreateInviteLink, kind, delivery, email, wikidotName, - token, uid, at, createdBy, target).Scan(&id) + token, uid, at, createdBy, target, siteID).Scan(&id) if err != nil { return 0, fmt.Errorf("write invite link: %w", err) } @@ -263,13 +263,13 @@ const ( ) var qCreateTicket = register("CreateTicket", ` -INSERT INTO web_userticket (kind, subject, body, source_page, status, admin_notes, created_at, author_id) -VALUES ($1, $2, $3, $4, $5, '', $6, $7) +INSERT INTO web_userticket (kind, subject, body, source_page, status, admin_notes, created_at, author_id, site_id) +VALUES ($1, $2, $3, $4, $5, '', $6, $7, $8) RETURNING id`) -func (d *DB) CreateTicket(ctx context.Context, kind, subject, body, page string, authorID int64, at time.Time) (int64, error) { +func (d *DB) CreateTicket(ctx context.Context, siteID int64, kind, subject, body, page string, authorID int64, at time.Time) (int64, error) { var id int64 - err := d.pool.QueryRow(ctx, qCreateTicket, kind, subject, body, page, TicketPending, at, authorID).Scan(&id) + err := d.pool.QueryRow(ctx, qCreateTicket, kind, subject, body, page, TicketPending, at, authorID, siteID).Scan(&id) if err != nil { return 0, fmt.Errorf("write ticket by %d: %w", authorID, err) } diff --git a/internal/db/account_write_test.go b/internal/db/account_write_test.go index a5ee68c7..f4824d0b 100644 --- a/internal/db/account_write_test.go +++ b/internal/db/account_write_test.go @@ -245,7 +245,7 @@ func TestCreateTicket(t *testing.T) { ctx := context.Background() author := scratchUser(t, d, "probe-ticket") - id, err := d.CreateTicket(ctx, TicketKind, "subject", "body", "main", author, time.Now().UTC()) + id, err := d.CreateTicket(ctx, seedSiteID(t, d), TicketKind, "subject", "body", "main", author, time.Now().UTC()) if err != nil { t.Fatalf("CreateTicket() err = %v, want nil", err) } diff --git a/internal/db/address.go b/internal/db/address.go index d24d10b3..0f4397fd 100644 --- a/internal/db/address.go +++ b/internal/db/address.go @@ -42,16 +42,17 @@ type AdminNote struct { Screen string Target string Label string + SiteID int64 At time.Time } var qWriteAdminNote = register("WriteAdminNote", ` -INSERT INTO pwikit_admin_log (user_id, stale_name, action, screen, target, label, created_at) -VALUES ($1, $2, $3, $4, $5, $6, $7)`) +INSERT INTO pwikit_admin_log (user_id, stale_name, action, screen, target, label, created_at, site_id) +VALUES ($1, $2, $3, $4, $5, $6, $7, $8)`) func (d *DB) WriteAdminNote(ctx context.Context, n AdminNote) error { _, err := d.pool.Exec(ctx, qWriteAdminNote, - n.UserID, n.Name, n.Action, n.Screen, n.Target, n.Label, n.At) + n.UserID, n.Name, n.Action, n.Screen, n.Target, n.Label, n.At, n.SiteID) if err != nil { return fmt.Errorf("record admin action %q on %q: %w", n.Action, n.Screen, err) } @@ -73,15 +74,15 @@ var qAdminNotes = register("AdminNotes", ` SELECT l.id, coalesce(u.username, ''), l.stale_name, l.action, l.screen, l.target, l.label, l.created_at FROM pwikit_admin_log l LEFT JOIN web_user u ON u.id = l.user_id -WHERE $1 = '' OR l.screen = $1 +WHERE ($1 = '' OR l.screen = $1) AND l.site_id = $4 ORDER BY l.created_at DESC, l.id DESC LIMIT $2 OFFSET $3`) var qAdminNoteScreens = register("AdminNoteScreens", ` -SELECT DISTINCT screen FROM pwikit_admin_log ORDER BY 1`) +SELECT DISTINCT screen FROM pwikit_admin_log WHERE site_id = $1 ORDER BY 1`) -func (d *DB) AdminNotes(ctx context.Context, screen string, limit, offset int) ([]AdminNoteRow, error) { - rows, err := d.pool.Query(ctx, qAdminNotes, screen, limit, offset) +func (d *DB) AdminNotes(ctx context.Context, siteID int64, screen string, limit, offset int) ([]AdminNoteRow, error) { + rows, err := d.pool.Query(ctx, qAdminNotes, screen, limit, offset, siteID) if err != nil { return nil, fmt.Errorf("list admin actions: %w", err) } @@ -99,8 +100,8 @@ func (d *DB) AdminNotes(ctx context.Context, screen string, limit, offset int) ( return out, rows.Err() } -func (d *DB) AdminNoteScreens(ctx context.Context) ([]string, error) { - rows, err := d.pool.Query(ctx, qAdminNoteScreens) +func (d *DB) AdminNoteScreens(ctx context.Context, siteID int64) ([]string, error) { + rows, err := d.pool.Query(ctx, qAdminNoteScreens, siteID) if err != nil { return nil, fmt.Errorf("list admin action screens: %w", err) } diff --git a/internal/db/category_admin.go b/internal/db/category_admin.go index e10d8382..f17330b9 100644 --- a/internal/db/category_admin.go +++ b/internal/db/category_admin.go @@ -27,11 +27,11 @@ type CategoryOverride struct { var qAdminCategories = register("AdminCategories", ` SELECT c.id, c.name, c.is_indexed, - (SELECT count(*) FROM web_article a WHERE a.category = c.name) -FROM web_category c ORDER BY c.name, c.id`) + (SELECT count(*) FROM web_article a WHERE a.category = c.name AND a.site_id = c.site_id) +FROM web_category c WHERE c.site_id = $1 ORDER BY c.name, c.id`) -func (d *DB) AdminCategories(ctx context.Context) ([]CategoryRow, error) { - rows, err := d.pool.Query(ctx, qAdminCategories) +func (d *DB) AdminCategories(ctx context.Context, siteID int64) ([]CategoryRow, error) { + rows, err := d.pool.Query(ctx, qAdminCategories, siteID) if err != nil { return nil, fmt.Errorf("list categories: %w", err) } @@ -136,7 +136,7 @@ func (d *DB) AdminCategory(ctx context.Context, id int64) (CategoryRow, error) { } var ( - qInsertCategory = register("InsertCategory", `INSERT INTO web_category (name, is_indexed) VALUES ($1,$2) RETURNING id`) + qInsertCategory = register("InsertCategory", `INSERT INTO web_category (name, is_indexed, site_id) VALUES ($1,$2,$3) RETURNING id`) qUpdateCategory = register("UpdateCategory", `UPDATE web_category SET name=$2, is_indexed=$3 WHERE id=$1`) qUpsertCategorySettings = register("UpsertCategorySettings", ` INSERT INTO web_settings (category_id, site_id, rating_mode, can_user_create_tags) @@ -145,7 +145,7 @@ ON CONFLICT (category_id) DO UPDATE SET rating_mode = EXCLUDED.rating_mode, can_user_create_tags = EXCLUDED.can_user_create_tags`) ) -func (d *DB) SaveCategory(ctx context.Context, c CategoryRow) error { +func (d *DB) SaveCategory(ctx context.Context, siteID int64, c CategoryRow) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin saving category %q: %w", c.Name, err) @@ -153,7 +153,7 @@ func (d *DB) SaveCategory(ctx context.Context, c CategoryRow) error { defer tx.Rollback(context.WithoutCancel(ctx)) if c.ID == 0 { - if err := tx.QueryRow(ctx, qInsertCategory, c.Name, c.IsIndexed).Scan(&c.ID); err != nil { + if err := tx.QueryRow(ctx, qInsertCategory, c.Name, c.IsIndexed, siteID).Scan(&c.ID); err != nil { return fmt.Errorf("create category %q: %w", c.Name, err) } } else if _, err := tx.Exec(ctx, qUpdateCategory, c.ID, c.Name, c.IsIndexed); err != nil { diff --git a/internal/db/favourite_write.go b/internal/db/favourite_write.go index 511ecb8c..8b8604f4 100644 --- a/internal/db/favourite_write.go +++ b/internal/db/favourite_write.go @@ -59,14 +59,14 @@ var qFavouritesOf = register("FavouritesOf", ` SELECT `+prefixedArticleColumns+`, f.created_at FROM web_articlefavourite f JOIN web_article a ON a.id = f.article_id -WHERE f.user_id = $1 +WHERE f.user_id = $1 AND a.site_id = $4 ORDER BY f.created_at DESC, f.id DESC OFFSET $2 LIMIT $3`) // Only the owner ever reads this, so no permission filter runs here. Whoever // calls it has already established that the rows belong to the reader. -func (d *DB) FavouritesOf(ctx context.Context, userID int64, offset, limit int) ([]Favourite, error) { - rows, err := d.pool.Query(ctx, qFavouritesOf, userID, offset, limit) +func (d *DB) FavouritesOf(ctx context.Context, siteID, userID int64, offset, limit int) ([]Favourite, error) { + rows, err := d.pool.Query(ctx, qFavouritesOf, userID, offset, limit, siteID) if err != nil { return nil, fmt.Errorf("list favourites of user %d: %w", userID, err) } diff --git a/internal/db/favourite_write_test.go b/internal/db/favourite_write_test.go index 0ada0dfc..aa32d1ad 100644 --- a/internal/db/favourite_write_test.go +++ b/internal/db/favourite_write_test.go @@ -96,7 +96,7 @@ func TestFavouritesOfComeBackNewestFirstInAWindow(t *testing.T) { t.Errorf("FavouriteCountOf() = %d, want 3", total) } - first, err := d.FavouritesOf(ctx, user, 0, 2) + first, err := d.FavouritesOf(ctx, seedSiteID(t, d), user, 0, 2) if err != nil { t.Fatalf("FavouritesOf() err = %v, want nil", err) } @@ -107,7 +107,7 @@ func TestFavouritesOfComeBackNewestFirstInAWindow(t *testing.T) { t.Errorf("FavouritesOf()[0].ID = %d, want %d", first[0].Article.ID, ids[2]) } - second, err := d.FavouritesOf(ctx, user, 2, 2) + second, err := d.FavouritesOf(ctx, seedSiteID(t, d), user, 2, 2) if err != nil { t.Fatalf("FavouritesOf() err = %v, want nil", err) } diff --git a/internal/db/forum_admin.go b/internal/db/forum_admin.go index ed32137c..298acd84 100644 --- a/internal/db/forum_admin.go +++ b/internal/db/forum_admin.go @@ -21,10 +21,10 @@ type ForumSectionRow struct { var qAdminForumSections = register("AdminForumSections", ` SELECT s.id, s.name, s.description, s."order", s.is_hidden, s.is_hidden_for_users, (SELECT count(*) FROM web_forumcategory c WHERE c.section_id = s.id) -FROM web_forumsection s ORDER BY s."order", s.id`) +FROM web_forumsection s WHERE s.site_id = $1 ORDER BY s."order", s.id`) -func (d *DB) AdminForumSections(ctx context.Context) ([]ForumSectionRow, error) { - rows, err := d.pool.Query(ctx, qAdminForumSections) +func (d *DB) AdminForumSections(ctx context.Context, siteID int64) ([]ForumSectionRow, error) { + rows, err := d.pool.Query(ctx, qAdminForumSections, siteID) if err != nil { return nil, fmt.Errorf("list forum sections: %w", err) } @@ -60,8 +60,8 @@ func (d *DB) AdminForumSection(ctx context.Context, id int64) (ForumSectionRow, var ( qInsertForumSection = register("InsertForumSection", ` -INSERT INTO web_forumsection (name, description, "order", is_hidden, is_hidden_for_users) -VALUES ($1, $2, $3, $4, $5) RETURNING id`) +INSERT INTO web_forumsection (name, description, "order", is_hidden, is_hidden_for_users, site_id) +VALUES ($1, $2, $3, $4, $5, $6) RETURNING id`) qUpdateForumSection = register("UpdateForumSection", ` UPDATE web_forumsection SET name=$2, description=$3, "order"=$4, is_hidden=$5, is_hidden_for_users=$6 @@ -70,10 +70,10 @@ WHERE id=$1`) qDeleteForumSection = register("DeleteForumSection", `DELETE FROM web_forumsection WHERE id = $1`) ) -func (d *DB) SaveForumSection(ctx context.Context, s ForumSectionRow) error { +func (d *DB) SaveForumSection(ctx context.Context, siteID int64, s ForumSectionRow) error { if s.ID == 0 { var id int64 - err := d.pool.QueryRow(ctx, qInsertForumSection, s.Name, s.Description, s.Order, s.IsHidden, s.IsHiddenForUser).Scan(&id) + err := d.pool.QueryRow(ctx, qInsertForumSection, s.Name, s.Description, s.Order, s.IsHidden, s.IsHiddenForUser, siteID).Scan(&id) if err != nil { return fmt.Errorf("create forum section %q: %w", s.Name, err) } @@ -108,10 +108,11 @@ var qAdminForumCategories = register("AdminForumCategories", ` SELECT c.id, c.name, c.description, c."order", c.is_for_comments, c.section_id, s.name, (SELECT count(*) FROM web_forumthread t WHERE t.category_id = c.id) FROM web_forumcategory c JOIN web_forumsection s ON s.id = c.section_id +WHERE s.site_id = $1 ORDER BY s."order", c."order", c.id`) -func (d *DB) AdminForumCategories(ctx context.Context) ([]ForumCategoryRow, error) { - rows, err := d.pool.Query(ctx, qAdminForumCategories) +func (d *DB) AdminForumCategories(ctx context.Context, siteID int64) ([]ForumCategoryRow, error) { + rows, err := d.pool.Query(ctx, qAdminForumCategories, siteID) if err != nil { return nil, fmt.Errorf("list forum categories: %w", err) } diff --git a/internal/db/forum_write.go b/internal/db/forum_write.go index b9bdee5d..57b97856 100644 --- a/internal/db/forum_write.go +++ b/internal/db/forum_write.go @@ -188,13 +188,13 @@ type ForumThreadWrite struct { } var qInsertForumThread = register("InsertForumThread", ` -INSERT INTO web_forumthread (category_id, name, description, author_id, created_at, updated_at, is_pinned, is_locked) -VALUES ($1, $2, $3, $4, $5, $5, false, false) +INSERT INTO web_forumthread (category_id, name, description, author_id, created_at, updated_at, is_pinned, is_locked, site_id) +VALUES ($1, $2, $3, $4, $5, $5, false, false, $6) RETURNING id`) // The thread and its first post go in together, so a thread that fails halfway // does not show up empty in the category listing. -func (d *DB) CreateForumThread(ctx context.Context, w ForumThreadWrite, source string) (int64, int64, error) { +func (d *DB) CreateForumThread(ctx context.Context, siteID int64, w ForumThreadWrite, source string) (int64, int64, error) { tx, err := d.pool.Begin(ctx) if err != nil { return 0, 0, fmt.Errorf("begin thread: %w", err) @@ -203,7 +203,7 @@ func (d *DB) CreateForumThread(ctx context.Context, w ForumThreadWrite, source s var threadID int64 if err := tx.QueryRow(ctx, qInsertForumThread, w.CategoryID, w.Name, w.Description, - w.AuthorID, w.At).Scan(&threadID); err != nil { + w.AuthorID, w.At, siteID).Scan(&threadID); err != nil { return 0, 0, fmt.Errorf("write thread in category %d: %w", w.CategoryID, err) } var postID int64 diff --git a/internal/db/listpages.go b/internal/db/listpages.go index cc7b9f2c..1a0ace01 100644 --- a/internal/db/listpages.go +++ b/internal/db/listpages.go @@ -61,6 +61,8 @@ type Sort struct { } type ListFilter struct { + SiteID int64 + Hidden []string PageType string @@ -170,6 +172,7 @@ LEFT JOIN ( ) au ON au.article_id = a.id` func (f ListFilter) build(b *listBuilder) string { + b.where = append(b.where, "a.site_id = "+b.arg(f.SiteID)) if len(f.Hidden) > 0 { b.where = append(b.where, "NOT (a.category = ANY("+b.arg(f.Hidden)+"))") } diff --git a/internal/db/message.go b/internal/db/message.go index d56055f8..9286f44e 100644 --- a/internal/db/message.go +++ b/internal/db/message.go @@ -201,11 +201,11 @@ func (d *DB) Report(ctx context.Context, id int64) (*Report, error) { var qReportsSince = register("ReportsSince", ` SELECT count(*) FROM web_userreport -WHERE reporter_id = $1 AND reported_id = $2 AND created_at >= $3`) +WHERE reporter_id = $1 AND reported_id = $2 AND created_at >= $3 AND site_id = $4`) -func (d *DB) ReportsSince(ctx context.Context, reporterID, reportedID int64, since time.Time) (int, error) { +func (d *DB) ReportsSince(ctx context.Context, siteID, reporterID, reportedID int64, since time.Time) (int, error) { var count int - if err := d.pool.QueryRow(ctx, qReportsSince, reporterID, reportedID, since).Scan(&count); err != nil { + if err := d.pool.QueryRow(ctx, qReportsSince, reporterID, reportedID, since, siteID).Scan(&count); err != nil { return 0, fmt.Errorf("count reports by %d against %d: %w", reporterID, reportedID, err) } return count, nil diff --git a/internal/db/message_write.go b/internal/db/message_write.go index 64f384d6..b8e49d70 100644 --- a/internal/db/message_write.go +++ b/internal/db/message_write.go @@ -86,13 +86,13 @@ func (d *DB) UnblockUser(ctx context.Context, blockerID, blockedID int64) (bool, } var qCreateReport = register("CreateReport", ` -INSERT INTO web_userreport (reporter_id, reported_id, reason, reported_messages, status, admin_notes, created_at) -VALUES ($1, $2, $3, $4, $5, '', $6) +INSERT INTO web_userreport (reporter_id, reported_id, reason, reported_messages, status, admin_notes, created_at, site_id) +VALUES ($1, $2, $3, $4, $5, '', $6, $7) RETURNING id`) -func (d *DB) CreateReport(ctx context.Context, reporterID, reportedID int64, reason, snapshot string, at time.Time) (int64, error) { +func (d *DB) CreateReport(ctx context.Context, siteID, reporterID, reportedID int64, reason, snapshot string, at time.Time) (int64, error) { var id int64 - err := d.pool.QueryRow(ctx, qCreateReport, reporterID, reportedID, reason, snapshot, ReportPending, at).Scan(&id) + err := d.pool.QueryRow(ctx, qCreateReport, reporterID, reportedID, reason, snapshot, ReportPending, at, siteID).Scan(&id) if err != nil { return 0, fmt.Errorf("write report by %d against %d: %w", reporterID, reportedID, err) } diff --git a/internal/db/message_write_test.go b/internal/db/message_write_test.go index ce47e277..190d237f 100644 --- a/internal/db/message_write_test.go +++ b/internal/db/message_write_test.go @@ -178,7 +178,7 @@ func TestCreateReport(t *testing.T) { reporter := scratchUser(t, d, "probe-report-a") reported := scratchUser(t, d, "probe-report-b") - id, err := d.CreateReport(ctx, reporter, reported, "spam", `[{"id":1}]`, time.Now().UTC()) + id, err := d.CreateReport(ctx, seedSiteID(t, d), reporter, reported, "spam", `[{"id":1}]`, time.Now().UTC()) if err != nil { t.Fatalf("CreateReport() err = %v, want nil", err) } @@ -193,7 +193,7 @@ func TestCreateReport(t *testing.T) { t.Errorf("Report().Status = %q, want %q", got.Status, ReportPending) } - count, err := d.ReportsSince(ctx, reporter, reported, time.Now().Add(-time.Hour)) + count, err := d.ReportsSince(ctx, seedSiteID(t, d), reporter, reported, time.Now().Add(-time.Hour)) if err != nil { t.Fatalf("ReportsSince() err = %v, want nil", err) } diff --git a/internal/db/mypages.go b/internal/db/mypages.go index 9b28db24..d6c95ec0 100644 --- a/internal/db/mypages.go +++ b/internal/db/mypages.go @@ -27,12 +27,12 @@ var qRatedBy = register("RatedBy", ` SELECT `+prefixedArticleColumns+`, v.rate, v.date FROM web_vote v JOIN web_article a ON a.id = v.article_id -WHERE v.user_id = $1 +WHERE v.user_id = $1 AND a.site_id = $4 ORDER BY v.date DESC NULLS LAST, v.id DESC OFFSET $2 LIMIT $3`) -func (d *DB) RatedBy(ctx context.Context, userID int64, offset, limit int) ([]RatedArticle, error) { - rows, err := d.pool.Query(ctx, qRatedBy, userID, offset, limit) +func (d *DB) RatedBy(ctx context.Context, siteID, userID int64, offset, limit int) ([]RatedArticle, error) { + rows, err := d.pool.Query(ctx, qRatedBy, userID, offset, limit, siteID) if err != nil { return nil, fmt.Errorf("list votes of user %d: %w", userID, err) } @@ -77,12 +77,12 @@ SELECT p.id, p.thread_id, p.name, p.created_at, p.updated_at, p.author_id, p.rep FROM web_forumpostlike l JOIN web_forumpost p ON p.id = l.post_id JOIN web_forumthread t ON t.id = p.thread_id -WHERE l.user_id = $1 +WHERE l.user_id = $1 AND t.site_id = $4 ORDER BY l.created_at DESC, l.id DESC OFFSET $2 LIMIT $3`) -func (d *DB) LikedPostsOf(ctx context.Context, userID int64, offset, limit int) ([]LikedPost, error) { - rows, err := d.pool.Query(ctx, qLikedPostsOf, userID, offset, limit) +func (d *DB) LikedPostsOf(ctx context.Context, siteID, userID int64, offset, limit int) ([]LikedPost, error) { + rows, err := d.pool.Query(ctx, qLikedPostsOf, userID, offset, limit, siteID) if err != nil { return nil, fmt.Errorf("list likes of user %d: %w", userID, err) } diff --git a/internal/db/options.go b/internal/db/options.go index 0c850619..56fd4682 100644 --- a/internal/db/options.go +++ b/internal/db/options.go @@ -136,11 +136,11 @@ func (d *DB) UserPreference(ctx context.Context, userID int64, section, name str var qTagCategoryBySlug = register("TagCategoryBySlug", ` SELECT id, name, priority FROM web_tagscategory -WHERE slug = $1`) +WHERE slug = $1 AND site_id = $2`) -func (d *DB) TagCategoryBySlug(ctx context.Context, slug string) (TagCategory, error) { +func (d *DB) TagCategoryBySlug(ctx context.Context, siteID int64, slug string) (TagCategory, error) { var c TagCategory - err := d.pool.QueryRow(ctx, qTagCategoryBySlug, slug).Scan(&c.ID, &c.Name, &c.Priority) + err := d.pool.QueryRow(ctx, qTagCategoryBySlug, slug, siteID).Scan(&c.ID, &c.Name, &c.Priority) if errors.Is(err, pgx.ErrNoRows) { return TagCategory{}, ErrNotFound } @@ -179,16 +179,16 @@ FROM web_article a JOIN web_article_tags link ON link.article_id = a.id JOIN web_tag t ON t.id = link.tag_id JOIN web_tagscategory c ON c.id = t.category_id -WHERE c.slug = $1 AND t.name = $2 AND NOT (a.category = ANY($3)) +WHERE c.slug = $1 AND t.name = $2 AND NOT (a.category = ANY($3)) AND a.site_id = $4 ORDER BY a.title`) // ArticlesByTag leaves out the categories the visitor cannot see, which the // caller resolves because permissions are not a database question. -func (d *DB) ArticlesByTag(ctx context.Context, categorySlug, name string, hidden []string) ([]Article, error) { +func (d *DB) ArticlesByTag(ctx context.Context, siteID int64, categorySlug, name string, hidden []string) ([]Article, error) { if hidden == nil { hidden = []string{} } - rows, err := d.pool.Query(ctx, qArticlesByTag, categorySlug, name, hidden) + rows, err := d.pool.Query(ctx, qArticlesByTag, categorySlug, name, hidden, siteID) if err != nil { return nil, fmt.Errorf("query articles tagged %q: %w", name, err) } diff --git a/internal/db/page_admin.go b/internal/db/page_admin.go index 88bfb6ce..e324fd96 100644 --- a/internal/db/page_admin.go +++ b/internal/db/page_admin.go @@ -24,24 +24,25 @@ func (p *AdminPageRow) FullName() string { const adminPageWhere = ` WHERE ($1 = '' OR a.name ILIKE '%' || $1 || '%' OR a.title ILIKE '%' || $1 || '%') - AND ($2 = '' OR a.category = $2)` + AND ($2 = '' OR a.category = $2) + AND a.site_id = $3` var qAdminPages = register("AdminPages", ` SELECT a.id, a.category, a.name, coalesce(a.title, ''), a.updated_at, (SELECT count(*) FROM web_articlelogentry l WHERE l.article_id = a.id) FROM web_article a`+adminPageWhere+` ORDER BY a.updated_at DESC, a.id DESC -LIMIT $3 OFFSET $4`) +LIMIT $4 OFFSET $5`) var qAdminPageCount = register("AdminPageCount", ` SELECT count(*) FROM web_article a`+adminPageWhere) -func (d *DB) AdminPages(ctx context.Context, query, category string, limit, offset int) ([]AdminPageRow, int, error) { +func (d *DB) AdminPages(ctx context.Context, siteID int64, query, category string, limit, offset int) ([]AdminPageRow, int, error) { var total int - if err := d.pool.QueryRow(ctx, qAdminPageCount, query, category).Scan(&total); err != nil { + if err := d.pool.QueryRow(ctx, qAdminPageCount, query, category, siteID).Scan(&total); err != nil { return nil, 0, fmt.Errorf("count pages: %w", err) } - rows, err := d.pool.Query(ctx, qAdminPages, query, category, limit, offset) + rows, err := d.pool.Query(ctx, qAdminPages, query, category, siteID, limit, offset) if err != nil { return nil, 0, fmt.Errorf("list pages: %w", err) } @@ -59,15 +60,15 @@ func (d *DB) AdminPages(ctx context.Context, query, category string, limit, offs } var qAdminPageCategories = register("AdminPageCategories", ` -SELECT category, count(*) FROM web_article GROUP BY category ORDER BY category`) +SELECT category, count(*) FROM web_article WHERE site_id = $1 GROUP BY category ORDER BY category`) type PageCategoryCount struct { Category string Pages int } -func (d *DB) AdminPageCategories(ctx context.Context) ([]PageCategoryCount, error) { - rows, err := d.pool.Query(ctx, qAdminPageCategories) +func (d *DB) AdminPageCategories(ctx context.Context, siteID int64) ([]PageCategoryCount, error) { + rows, err := d.pool.Query(ctx, qAdminPageCategories, siteID) if err != nil { return nil, fmt.Errorf("list page categories: %w", err) } diff --git a/internal/db/report_admin.go b/internal/db/report_admin.go index c4bf77da..3e024a19 100644 --- a/internal/db/report_admin.go +++ b/internal/db/report_admin.go @@ -39,24 +39,24 @@ LEFT JOIN web_user rev ON rev.id = r.reviewed_by_id` var qAdminReports = register("AdminReports", ` SELECT `+reportColumns+reportJoins+` -WHERE $1 = '' OR r.status = $1 +WHERE ($1 = '' OR r.status = $1) AND r.site_id = $4 ORDER BY r.created_at DESC, r.id DESC LIMIT $2 OFFSET $3`) var qAdminReportCount = register("AdminReportCount", ` -SELECT count(*) FROM web_userreport r WHERE $1 = '' OR r.status = $1`) +SELECT count(*) FROM web_userreport r WHERE ($1 = '' OR r.status = $1) AND r.site_id = $2`) func scanReport(row pgx.Row, r *ReportRow) error { return row.Scan(&r.ID, &r.Reporter, &r.Reported, &r.Reason, &r.Messages, &r.Status, &r.AdminNotes, &r.CreatedAt, &r.ReviewedAt, &r.ReviewedBy) } -func (d *DB) AdminReports(ctx context.Context, status string, limit, offset int) ([]ReportRow, int, error) { +func (d *DB) AdminReports(ctx context.Context, siteID int64, status string, limit, offset int) ([]ReportRow, int, error) { var total int - if err := d.pool.QueryRow(ctx, qAdminReportCount, status).Scan(&total); err != nil { + if err := d.pool.QueryRow(ctx, qAdminReportCount, status, siteID).Scan(&total); err != nil { return nil, 0, fmt.Errorf("count reports: %w", err) } - rows, err := d.pool.Query(ctx, qAdminReports, status, limit, offset) + rows, err := d.pool.Query(ctx, qAdminReports, status, limit, offset, siteID) if err != nil { return nil, 0, fmt.Errorf("list reports: %w", err) } diff --git a/internal/db/role_write.go b/internal/db/role_write.go index 156a473b..29a28098 100644 --- a/internal/db/role_write.go +++ b/internal/db/role_write.go @@ -45,10 +45,10 @@ func scanRole(row pgx.Row, r *RoleRow) error { var qAdminRoles = register("AdminRoles", ` SELECT `+roleColumns+`, (SELECT count(*) FROM web_user_roles ur WHERE ur.role_id = web_role.id) -FROM web_role ORDER BY index, id`) +FROM web_role WHERE site_id = $1 ORDER BY index, id`) -func (d *DB) AdminRoles(ctx context.Context) ([]RoleRow, error) { - rows, err := d.pool.Query(ctx, qAdminRoles) +func (d *DB) AdminRoles(ctx context.Context, siteID int64) ([]RoleRow, error) { + rows, err := d.pool.Query(ctx, qAdminRoles, siteID) if err != nil { return nil, fmt.Errorf("list roles: %w", err) } @@ -135,8 +135,8 @@ var ( qInsertRole = register("InsertRole", ` INSERT INTO web_role (slug, name, short_name, category_id, index, is_staff, group_votes, votes_title, inline_visual_mode, profile_visual_mode, color, icon, badge_text, badge_bg, - badge_text_color, badge_show_border) -VALUES ($1,$2,$3,$4,$5,$6,$7,$8,$9,$10,$11,$12,$13,$14,$15,$16) RETURNING id`) + badge_text_color, badge_show_border, site_id) +VALUES ($1,$2,$3,$4,$5,$6,$7,$8,$9,$10,$11,$12,$13,$14,$15,$16,$17) RETURNING id`) qUpdateRole = register("UpdateRole", ` UPDATE web_role SET slug=$2, name=$3, short_name=$4, category_id=$5, index=$6, is_staff=$7, @@ -160,7 +160,7 @@ JOIN django_content_type c ON c.id = p.content_type_id WHERE c.app_label = 'web' AND c.model = 'roles' AND p.codename = ANY($2)`) ) -func (d *DB) SaveRole(ctx context.Context, r RoleRow, withGrants bool) (int64, error) { +func (d *DB) SaveRole(ctx context.Context, siteID int64, r RoleRow, withGrants bool) (int64, error) { tx, err := d.pool.Begin(ctx) if err != nil { return 0, fmt.Errorf("begin saving role %q: %w", r.Slug, err) @@ -171,7 +171,7 @@ func (d *DB) SaveRole(ctx context.Context, r RoleRow, withGrants bool) (int64, e r.VotesTitle, r.InlineVisualMode, r.ProfileVisualMode, r.Color, r.Icon, r.BadgeText, r.BadgeBg, r.BadgeTextColor, r.BadgeShowBorder} if r.ID == 0 { - if err := tx.QueryRow(ctx, qInsertRole, args...).Scan(&r.ID); err != nil { + if err := tx.QueryRow(ctx, qInsertRole, append(args, siteID)...).Scan(&r.ID); err != nil { return 0, fmt.Errorf("create role %q: %w", r.Slug, err) } } else if _, err := tx.Exec(ctx, qUpdateRole, append([]any{r.ID}, args...)...); err != nil { @@ -235,11 +235,11 @@ func (d *DB) DeleteRole(ctx context.Context, id int64) error { var qOperationIndex = register("OperationIndex", ` SELECT coalesce(min(r.index), 2147483647) FROM web_role r -JOIN web_user_roles ur ON ur.role_id = r.id WHERE ur.user_id = $1`) +JOIN web_user_roles ur ON ur.role_id = r.id WHERE ur.user_id = $1 AND r.site_id = $2`) -func (d *DB) OperationIndex(ctx context.Context, userID int64) (int, error) { +func (d *DB) OperationIndex(ctx context.Context, siteID, userID int64) (int, error) { var index int - if err := d.pool.QueryRow(ctx, qOperationIndex, userID).Scan(&index); err != nil { + if err := d.pool.QueryRow(ctx, qOperationIndex, userID, siteID).Scan(&index); err != nil { return 0, fmt.Errorf("read the rank of user %d: %w", userID, err) } return index, nil @@ -253,10 +253,10 @@ type RoleCategoryRow struct { var qRoleCategories = register("RoleCategories", ` SELECT c.id, c.name, (SELECT count(*) FROM web_role r WHERE r.category_id = c.id) -FROM web_rolecategory c ORDER BY c.name, c.id`) +FROM web_rolecategory c WHERE c.site_id = $1 ORDER BY c.name, c.id`) -func (d *DB) RoleCategories(ctx context.Context) ([]RoleCategoryRow, error) { - rows, err := d.pool.Query(ctx, qRoleCategories) +func (d *DB) RoleCategories(ctx context.Context, siteID int64) ([]RoleCategoryRow, error) { + rows, err := d.pool.Query(ctx, qRoleCategories, siteID) if err != nil { return nil, fmt.Errorf("list role categories: %w", err) } @@ -274,15 +274,15 @@ func (d *DB) RoleCategories(ctx context.Context) ([]RoleCategoryRow, error) { } var ( - qInsertRoleCategory = register("InsertRoleCategory", `INSERT INTO web_rolecategory (name) VALUES ($1) RETURNING id`) + qInsertRoleCategory = register("InsertRoleCategory", `INSERT INTO web_rolecategory (name, site_id) VALUES ($1,$2) RETURNING id`) qUpdateRoleCategory = register("UpdateRoleCategory", `UPDATE web_rolecategory SET name = $2 WHERE id = $1`) qDeleteRoleCategory = register("DeleteRoleCategory", `DELETE FROM web_rolecategory WHERE id = $1`) ) -func (d *DB) SaveRoleCategory(ctx context.Context, c RoleCategoryRow) error { +func (d *DB) SaveRoleCategory(ctx context.Context, siteID int64, c RoleCategoryRow) error { if c.ID == 0 { var id int64 - if err := d.pool.QueryRow(ctx, qInsertRoleCategory, c.Name).Scan(&id); err != nil { + if err := d.pool.QueryRow(ctx, qInsertRoleCategory, c.Name, siteID).Scan(&id); err != nil { return fmt.Errorf("create role category %q: %w", c.Name, err) } return nil diff --git a/internal/db/search.go b/internal/db/search.go index 55c7a546..a77e2d0d 100644 --- a/internal/db/search.go +++ b/internal/db/search.go @@ -16,10 +16,11 @@ type SearchFilter struct { From *time.Time To *time.Time Hidden []string + SiteID int64 } func (f SearchFilter) where(b *listBuilder) string { - parts := []string{"si.article_id IS NOT NULL"} + parts := []string{"si.article_id IS NOT NULL", "a.site_id = " + b.arg(f.SiteID)} if len(f.Hidden) > 0 { parts = append(parts, "NOT (a.category = ANY("+b.arg(f.Hidden)+"))") } @@ -114,12 +115,12 @@ var qTagIDsByFullName = register("TagIDsByFullName", ` SELECT t.id FROM web_tag t JOIN web_tagscategory c ON c.id = t.category_id -WHERE t.name = $1 AND ($2 = '' OR c.slug = $2)`) +WHERE t.name = $1 AND ($2 = '' OR c.slug = $2) AND t.site_id = $3`) // A name without a category matches that tag in every category, which is what // makes one name able to name several tags. -func (d *DB) TagIDsByFullName(ctx context.Context, category, name string) ([]int64, error) { - rows, err := d.pool.Query(ctx, qTagIDsByFullName, name, category) +func (d *DB) TagIDsByFullName(ctx context.Context, siteID int64, category, name string) ([]int64, error) { + rows, err := d.pool.Query(ctx, qTagIDsByFullName, name, category, siteID) if err != nil { return nil, fmt.Errorf("query tag %q: %w", name, err) } diff --git a/internal/db/site_scope_pending_test.go b/internal/db/site_scope_pending_test.go index e5715ffe..098fd1b3 100644 --- a/internal/db/site_scope_pending_test.go +++ b/internal/db/site_scope_pending_test.go @@ -1,42 +1,19 @@ package db -var siteScopePending = []string{ +var siteScopePending = []string{} + +var siteScopeByKey = []string{ "ActivateInviteLink", - "AddUserRoles", - "AdminCategories", "AdminCategory", "AdminCategoryOverrides", - "AdminForumCategories", - "AdminForumSections", - "AdminInviteCount", - "AdminInvites", - "AdminNoteScreens", - "AdminNotes", - "AdminPageCategories", - "AdminPageCount", - "AdminPages", "AdminReport", - "AdminReportCount", - "AdminReports", "AdminRole", - "AdminRoles", "AdminTag", - "AdminTagCategories", "AdminTagCategory", - "AdminTagCount", - "AdminTags", "AdminTicket", - "AdminTicketCount", - "AdminTickets", - "AllTags", - "ArticleCategories", "ArticleChildren", - "ArticlesByTag", "Breadcrumbs", "ClearRoleTickets", - "CreateInviteLink", - "CreateReport", - "CreateTicket", "DeleteArticle.13", "DeleteArticle.14", "DeleteCategory", @@ -48,47 +25,20 @@ var siteScopePending = []string{ "DeleteTheme", "DetachRoleCategory", "DetachTagCat", - "DropOrphanTagCategories", - "DropOrphanTags", - "FavouritesOf", "FindTag", - "FindTagCategory", "GrantTicketRole", - "InsertCategory", - "InsertForumSection", - "InsertForumThread", - "InsertRole", - "InsertRoleCategory", - "InsertTag", - "InsertTagCat", - "InsertTagCategory", - "InsertTagRow", - "InsertTheme", "KnownTags", - "LikedPostsOf", "MoveArticleParent", - "OpenInviteCount", - "OperationIndex", - "RatedBy", "ReadArticleTitle", "RenameArticle", "Report", - "ReportsSince", "ReviewReport", "ReviewTicket", - "RoleCategories", "SetArticleLock", "SetArticleParent", "SetArticleTitle", - "TagCategoryBySlug", - "TagCloud", - "TagIDsByBareName", - "TagIDsByFullName", - "TagIDsByName", - "TagsCategories", "ThemeByID", "ThemeRow", - "Themes", "TouchArticle", "TouchForumThread", "UpdateArticleTitle", @@ -98,10 +48,6 @@ var siteScopePending = []string{ "UpdateTag", "UpdateTagCat", "UpdateTheme", - "WriteAdminNote", -} - -var siteScopeByKey = []string{ "ForumCategory", "AdminForumCategory", "InsertForumCategory", diff --git a/internal/db/site_scope_test.go b/internal/db/site_scope_test.go index cea7df3a..596a3223 100644 --- a/internal/db/site_scope_test.go +++ b/internal/db/site_scope_test.go @@ -106,3 +106,19 @@ func TestSiteScopeListsHoldOnlyKnownNames(t *testing.T) { } } } + +func TestBuiltFiltersNameTheSite(t *testing.T) { + list, _ := ListFilter{SiteID: 7}.SelectSQL(0, nil) + if !strings.Contains(list, "a.site_id") { + t.Errorf("ListFilter.SelectSQL() = %q, want it to name a.site_id", list) + } + changes, _ := SiteChangeFilter{SiteID: 7}.SelectSQL(0, 10) + if !strings.Contains(changes, "a.site_id") { + t.Errorf("SiteChangeFilter.SelectSQL() = %q, want it to name a.site_id", changes) + } + b := &listBuilder{} + search := SearchFilter{SiteID: 7}.where(b) + if !strings.Contains(search, "a.site_id") { + t.Errorf("SearchFilter.where() = %q, want it to name a.site_id", search) + } +} diff --git a/internal/db/sitechanges.go b/internal/db/sitechanges.go index 5bf83b76..f6564afd 100644 --- a/internal/db/sitechanges.go +++ b/internal/db/sitechanges.go @@ -9,6 +9,8 @@ import ( ) type SiteChangeFilter struct { + SiteID int64 + Hidden []string Types []string @@ -37,6 +39,7 @@ type SiteChange struct { // A revert carries the types it undid in meta rather than in the type column, // so asking for one type has to reach both places. func (f SiteChangeFilter) build(b *listBuilder) string { + b.where = append(b.where, "a.site_id = "+b.arg(f.SiteID)) if len(f.Hidden) > 0 { b.where = append(b.where, "NOT (a.category = ANY("+b.arg(f.Hidden)+"))") } @@ -119,13 +122,13 @@ func (d *DB) SiteChangeCount(ctx context.Context, f SiteChangeFilter) (int, erro var qArticleCategories = register("ArticleCategories", ` SELECT DISTINCT category FROM web_article -WHERE NOT (category = ANY($1))`) +WHERE NOT (category = ANY($1)) AND site_id = $2`) -func (d *DB) ArticleCategories(ctx context.Context, hidden []string) ([]string, error) { +func (d *DB) ArticleCategories(ctx context.Context, siteID int64, hidden []string) ([]string, error) { if hidden == nil { hidden = []string{} } - rows, err := d.pool.Query(ctx, qArticleCategories, hidden) + rows, err := d.pool.Query(ctx, qArticleCategories, hidden, siteID) if err != nil { return nil, fmt.Errorf("query article categories: %w", err) } diff --git a/internal/db/tag.go b/internal/db/tag.go index 97ae8ae8..0c03b765 100644 --- a/internal/db/tag.go +++ b/internal/db/tag.go @@ -9,19 +9,19 @@ var qTagIDsByName = register("TagIDsByName", ` SELECT t.id FROM web_tag t JOIN web_tagscategory c ON c.id = t.category_id -WHERE c.slug = $1 AND t.name = $2 +WHERE t.site_id = $1 AND c.slug = $2 AND t.name = $3 ORDER BY t.id`) var qTagIDsByBareName = register("TagIDsByBareName", ` SELECT id FROM web_tag -WHERE name = $1 +WHERE site_id = $1 AND name = $2 ORDER BY id`) -func (d *DB) TagIDsByName(ctx context.Context, categorySlug, name string) ([]int64, error) { - sql, args := qTagIDsByBareName, []any{name} +func (d *DB) TagIDsByName(ctx context.Context, siteID int64, categorySlug, name string) ([]int64, error) { + sql, args := qTagIDsByBareName, []any{siteID, name} if categorySlug != "" { - sql, args = qTagIDsByName, []any{categorySlug, name} + sql, args = qTagIDsByName, []any{siteID, categorySlug, name} } rows, err := d.pool.Query(ctx, sql, args...) if err != nil { @@ -89,17 +89,17 @@ SELECT t.name, FROM web_tag t JOIN web_tagscategory c ON c.id = t.category_id LEFT JOIN web_article_tags link ON link.tag_id = t.id -WHERE t.name NOT LIKE '\_%' +WHERE t.site_id = $1 AND t.name NOT LIKE '\_%' GROUP BY t.id, t.name, c.id, c.name, c.slug, c.description, c.priority ORDER BY count(link.article_id) DESC`) // The limit lands after the busiest tags come first, so it decides which tags // are in the cloud and not just how many. -func (d *DB) TagCloud(ctx context.Context, limit *int) ([]CloudTag, error) { +func (d *DB) TagCloud(ctx context.Context, siteID int64, limit *int) ([]CloudTag, error) { sql := qTagCloud - args := []any{} + args := []any{siteID} if limit != nil { - sql += "\nLIMIT $1" + sql += "\nLIMIT $2" args = append(args, *limit) } rows, err := d.pool.Query(ctx, sql, args...) @@ -133,10 +133,11 @@ type TagsCategory struct { var qTagsCategories = register("TagsCategories", ` SELECT id, name, description, slug FROM web_tagscategory +WHERE site_id = $1 ORDER BY priority, id`) -func (d *DB) TagsCategories(ctx context.Context) ([]TagsCategory, error) { - rows, err := d.pool.Query(ctx, qTagsCategories) +func (d *DB) TagsCategories(ctx context.Context, siteID int64) ([]TagsCategory, error) { + rows, err := d.pool.Query(ctx, qTagsCategories, siteID) if err != nil { return nil, fmt.Errorf("list tag categories: %w", err) } @@ -161,10 +162,10 @@ type NamedTag struct { Name string } -var qAllTags = register("AllTags", `SELECT category_id, name FROM web_tag ORDER BY id`) +var qAllTags = register("AllTags", `SELECT category_id, name FROM web_tag WHERE site_id = $1 ORDER BY id`) -func (d *DB) AllTags(ctx context.Context) ([]NamedTag, error) { - rows, err := d.pool.Query(ctx, qAllTags) +func (d *DB) AllTags(ctx context.Context, siteID int64) ([]NamedTag, error) { + rows, err := d.pool.Query(ctx, qAllTags, siteID) if err != nil { return nil, fmt.Errorf("list tags: %w", err) } diff --git a/internal/db/tag_admin.go b/internal/db/tag_admin.go index 91966dae..9c529658 100644 --- a/internal/db/tag_admin.go +++ b/internal/db/tag_admin.go @@ -20,10 +20,10 @@ type TagCategoryRow struct { var qAdminTagCategories = register("AdminTagCategories", ` SELECT c.id, c.name, c.slug, c.description, c.priority, (SELECT count(*) FROM web_tag t WHERE t.category_id = c.id) -FROM web_tagscategory c ORDER BY c.priority DESC, c.name, c.id`) +FROM web_tagscategory c WHERE c.site_id = $1 ORDER BY c.priority DESC, c.name, c.id`) -func (d *DB) AdminTagCategories(ctx context.Context) ([]TagCategoryRow, error) { - rows, err := d.pool.Query(ctx, qAdminTagCategories) +func (d *DB) AdminTagCategories(ctx context.Context, siteID int64) ([]TagCategoryRow, error) { + rows, err := d.pool.Query(ctx, qAdminTagCategories, siteID) if err != nil { return nil, fmt.Errorf("list tag categories: %w", err) } @@ -58,17 +58,17 @@ func (d *DB) AdminTagCategory(ctx context.Context, id int64) (TagCategoryRow, er var ( qInsertTagCat = register("InsertTagCat", ` -INSERT INTO web_tagscategory (name, slug, description, priority) VALUES ($1,$2,$3,$4) RETURNING id`) +INSERT INTO web_tagscategory (name, slug, description, priority, site_id) VALUES ($1,$2,$3,$4,$5) RETURNING id`) qUpdateTagCat = register("UpdateTagCat", ` UPDATE web_tagscategory SET name=$2, slug=$3, description=$4, priority=$5 WHERE id=$1`) qDetachTagCat = register("DetachTagCat", `UPDATE web_tag SET category_id = NULL WHERE category_id = $1`) qDeleteTagCat = register("DeleteTagCat", `DELETE FROM web_tagscategory WHERE id = $1`) ) -func (d *DB) SaveTagCategory(ctx context.Context, c TagCategoryRow) error { +func (d *DB) SaveTagCategory(ctx context.Context, siteID int64, c TagCategoryRow) error { if c.ID == 0 { var id int64 - err := d.pool.QueryRow(ctx, qInsertTagCat, c.Name, c.Slug, c.Description, c.Priority).Scan(&id) + err := d.pool.QueryRow(ctx, qInsertTagCat, c.Name, c.Slug, c.Description, c.Priority, siteID).Scan(&id) if err != nil { return fmt.Errorf("create tag category %q: %w", c.Slug, err) } @@ -109,19 +109,19 @@ var qAdminTags = register("AdminTags", ` SELECT t.id, t.name, t.category_id, coalesce(c.name, ''), (SELECT count(*) FROM web_article_tags at WHERE at.tag_id = t.id) FROM web_tag t LEFT JOIN web_tagscategory c ON c.id = t.category_id -WHERE $1 = '' OR t.name ILIKE '%' || $1 || '%' +WHERE ($1 = '' OR t.name ILIKE '%' || $1 || '%') AND t.site_id = $4 ORDER BY c.name NULLS FIRST, t.name LIMIT $2 OFFSET $3`) var qAdminTagCount = register("AdminTagCount", ` -SELECT count(*) FROM web_tag t WHERE $1 = '' OR t.name ILIKE '%' || $1 || '%'`) +SELECT count(*) FROM web_tag t WHERE ($1 = '' OR t.name ILIKE '%' || $1 || '%') AND t.site_id = $2`) -func (d *DB) AdminTags(ctx context.Context, query string, limit, offset int) ([]TagRow, int, error) { +func (d *DB) AdminTags(ctx context.Context, siteID int64, query string, limit, offset int) ([]TagRow, int, error) { var total int - if err := d.pool.QueryRow(ctx, qAdminTagCount, query).Scan(&total); err != nil { + if err := d.pool.QueryRow(ctx, qAdminTagCount, query, siteID).Scan(&total); err != nil { return nil, 0, fmt.Errorf("count tags: %w", err) } - rows, err := d.pool.Query(ctx, qAdminTags, query, limit, offset) + rows, err := d.pool.Query(ctx, qAdminTags, query, limit, offset, siteID) if err != nil { return nil, 0, fmt.Errorf("list tags: %w", err) } @@ -153,16 +153,16 @@ func (d *DB) AdminTag(ctx context.Context, id int64) (TagRow, error) { } var ( - qInsertTagRow = register("InsertTagRow", `INSERT INTO web_tag (name, category_id) VALUES ($1,$2) RETURNING id`) + qInsertTagRow = register("InsertTagRow", `INSERT INTO web_tag (name, category_id, site_id) VALUES ($1,$2,$3) RETURNING id`) qUpdateTag = register("UpdateTag", `UPDATE web_tag SET name=$2, category_id=$3 WHERE id=$1`) qDetachTag = register("DetachTag", `DELETE FROM web_article_tags WHERE tag_id = $1`) qDeleteTagRow = register("DeleteTagRow", `DELETE FROM web_tag WHERE id = $1`) ) -func (d *DB) SaveTag(ctx context.Context, t TagRow) error { +func (d *DB) SaveTag(ctx context.Context, siteID int64, t TagRow) error { if t.ID == 0 { var id int64 - if err := d.pool.QueryRow(ctx, qInsertTagRow, t.Name, t.CategoryID).Scan(&id); err != nil { + if err := d.pool.QueryRow(ctx, qInsertTagRow, t.Name, t.CategoryID, siteID).Scan(&id); err != nil { return fmt.Errorf("create tag %q: %w", t.Name, err) } return nil diff --git a/internal/db/tag_test.go b/internal/db/tag_test.go index 388c2ee2..4c874342 100644 --- a/internal/db/tag_test.go +++ b/internal/db/tag_test.go @@ -10,11 +10,11 @@ func TestTagCloudSQLMatchesSchema(t *testing.T) { ctx := context.Background() limit := 2 - all, err := d.TagCloud(ctx, nil) + all, err := d.TagCloud(ctx, seedSiteID(t, d), nil) if err != nil { t.Fatalf("TagCloud(nil) err = %v, want nil", err) } - limited, err := d.TagCloud(ctx, &limit) + limited, err := d.TagCloud(ctx, seedSiteID(t, d), &limit) if err != nil { t.Fatalf("TagCloud(2) err = %v, want nil", err) } @@ -29,7 +29,7 @@ func TestTagCloudSQLMatchesSchema(t *testing.T) { func TestTagCloudSkipsUnderscoreNames(t *testing.T) { d := newTestDB(t) - tags, err := d.TagCloud(context.Background(), nil) + tags, err := d.TagCloud(context.Background(), seedSiteID(t, d), nil) if err != nil { t.Fatalf("TagCloud(nil) err = %v, want nil", err) } @@ -43,7 +43,7 @@ func TestTagCloudSkipsUnderscoreNames(t *testing.T) { func TestTagCloudOrdersByArticleCount(t *testing.T) { d := newTestDB(t) - tags, err := d.TagCloud(context.Background(), nil) + tags, err := d.TagCloud(context.Background(), seedSiteID(t, d), nil) if err != nil { t.Fatalf("TagCloud(nil) err = %v, want nil", err) } diff --git a/internal/db/tag_write.go b/internal/db/tag_write.go index 24281ee1..563bc6a7 100644 --- a/internal/db/tag_write.go +++ b/internal/db/tag_write.go @@ -23,18 +23,18 @@ type taggedName struct { var ( qFindTagCategory = register("FindTagCategory", ` -SELECT id FROM web_tagscategory WHERE slug = $1`) +SELECT id FROM web_tagscategory WHERE slug = $1 AND site_id = $2`) qInsertTagCategory = register("InsertTagCategory", ` -INSERT INTO web_tagscategory (name, description, slug) -VALUES ($1, '', $1) +INSERT INTO web_tagscategory (name, description, slug, site_id) +VALUES ($1, '', $1, $2) RETURNING id`) qFindTag = register("FindTag", ` SELECT id FROM web_tag WHERE category_id = $1 AND name = $2`) qInsertTag = register("InsertTag", ` -INSERT INTO web_tag (category_id, name) VALUES ($1, $2) RETURNING id`) +INSERT INTO web_tag (category_id, name, site_id) VALUES ($1, $2, $3) RETURNING id`) qReadArticleTags = register("ReadArticleTags", ` SELECT t.id, c.slug, t.name @@ -52,19 +52,20 @@ INSERT INTO web_article_tags (article_id, tag_id) VALUES ($1, $2)`) qDropOrphanTags = register("DropOrphanTags", ` DELETE FROM web_tag -WHERE NOT EXISTS (SELECT 1 FROM web_article_tags at WHERE at.tag_id = web_tag.id)`) +WHERE site_id = $1 + AND NOT EXISTS (SELECT 1 FROM web_article_tags at WHERE at.tag_id = web_tag.id)`) // Only a category whose name was never set apart from its slug is swept up, // which is how one somebody typed out survives losing its last tag. qDropOrphanTagCategories = register("DropOrphanTagCategories", ` DELETE FROM web_tagscategory -WHERE slug = name +WHERE site_id = $1 AND slug = name AND NOT EXISTS (SELECT 1 FROM web_tag t WHERE t.category_id = web_tagscategory.id)`) ) // A name with a space in it is dropped rather than refused, so one bad entry // does not cost the page the rest of its tags. -func (d *DB) SetArticleTags(ctx context.Context, articleID int64, tags []string, +func (d *DB) SetArticleTags(ctx context.Context, siteID, articleID int64, tags []string, allowCreate bool, userID *int64, at time.Time) (Revision, bool, error) { tx, err := d.pool.Begin(ctx) @@ -73,7 +74,7 @@ func (d *DB) SetArticleTags(ctx context.Context, articleID int64, tags []string, } defer tx.Rollback(ctx) - wanted, err := resolveTags(ctx, tx, tags, allowCreate) + wanted, err := resolveTags(ctx, tx, siteID, tags, allowCreate) if err != nil { return Revision{}, false, fmt.Errorf("resolve tags of %d: %w", articleID, err) } @@ -101,10 +102,10 @@ func (d *DB) SetArticleTags(ctx context.Context, articleID int64, tags []string, } } if allowCreate { - if _, err := tx.Exec(ctx, qDropOrphanTags); err != nil { + if _, err := tx.Exec(ctx, qDropOrphanTags, siteID); err != nil { return Revision{}, false, fmt.Errorf("sweep tags: %w", err) } - if _, err := tx.Exec(ctx, qDropOrphanTagCategories); err != nil { + if _, err := tx.Exec(ctx, qDropOrphanTagCategories, siteID); err != nil { return Revision{}, false, fmt.Errorf("sweep tag categories: %w", err) } } @@ -129,14 +130,14 @@ func (d *DB) SetArticleTags(ctx context.Context, articleID int64, tags []string, return rev, true, nil } -func resolveTags(ctx context.Context, tx pgx.Tx, tags []string, allowCreate bool) ([]taggedName, error) { +func resolveTags(ctx context.Context, tx pgx.Tx, siteID int64, tags []string, allowCreate bool) ([]taggedName, error) { var out []taggedName for _, raw := range tags { if strings.Contains(raw, " ") { continue } category, name := splitTagName(strings.ToLower(raw)) - id, err := tagID(ctx, tx, category, name, allowCreate) + id, err := tagID(ctx, tx, siteID, category, name, allowCreate) if err != nil { return nil, err } @@ -151,14 +152,14 @@ func resolveTags(ctx context.Context, tx pgx.Tx, tags []string, allowCreate bool return out, nil } -func tagID(ctx context.Context, tx pgx.Tx, category, name string, allowCreate bool) (int64, error) { +func tagID(ctx context.Context, tx pgx.Tx, siteID int64, category, name string, allowCreate bool) (int64, error) { var categoryID int64 - err := tx.QueryRow(ctx, qFindTagCategory, category).Scan(&categoryID) + err := tx.QueryRow(ctx, qFindTagCategory, category, siteID).Scan(&categoryID) if errors.Is(err, pgx.ErrNoRows) { if !allowCreate { return 0, nil } - if err := tx.QueryRow(ctx, qInsertTagCategory, category).Scan(&categoryID); err != nil { + if err := tx.QueryRow(ctx, qInsertTagCategory, category, siteID).Scan(&categoryID); err != nil { return 0, err } } else if err != nil { @@ -171,7 +172,7 @@ func tagID(ctx context.Context, tx pgx.Tx, category, name string, allowCreate bo if !allowCreate { return 0, nil } - if err := tx.QueryRow(ctx, qInsertTag, categoryID, name).Scan(&id); err != nil { + if err := tx.QueryRow(ctx, qInsertTag, categoryID, name, siteID).Scan(&id); err != nil { return 0, err } } else if err != nil { diff --git a/internal/db/tag_write_test.go b/internal/db/tag_write_test.go index 91f455cb..41b13bc4 100644 --- a/internal/db/tag_write_test.go +++ b/internal/db/tag_write_test.go @@ -61,7 +61,7 @@ func TestSetArticleTagsCreatesWhatItIsAllowedTo(t *testing.T) { id := scratchTagged(t, d) stamp := time.Now().Format("150405.000000") - _, wrote, err := d.SetArticleTags(ctx, id, + _, wrote, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"probe" + stamp, "probecat" + stamp + ":one"}, true, nil, time.Now().UTC()) if err != nil { t.Fatalf("SetArticleTags() err = %v, want nil", err) @@ -87,7 +87,7 @@ func TestSetArticleTagsSkipsWhatItMayNotCreate(t *testing.T) { ctx := context.Background() id := scratchTagged(t, d) - _, wrote, err := d.SetArticleTags(ctx, id, + _, wrote, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"probe-never-seen-" + time.Now().Format("150405.000000")}, false, nil, time.Now().UTC()) if err != nil { t.Fatalf("SetArticleTags() err = %v, want nil", err) @@ -106,7 +106,7 @@ func TestSetArticleTagsDropsANameWithASpace(t *testing.T) { id := scratchTagged(t, d) stamp := time.Now().Format("150405.000000") - if _, _, err := d.SetArticleTags(ctx, id, + if _, _, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"two words", "probe" + stamp}, true, nil, time.Now().UTC()); err != nil { t.Fatalf("SetArticleTags() err = %v, want nil", err) } @@ -123,10 +123,10 @@ func TestSetArticleTagsRecordsWhatMoved(t *testing.T) { stamp := time.Now().Format("150405.000000") at := time.Now().UTC() - if _, _, err := d.SetArticleTags(ctx, id, []string{"probeold" + stamp}, true, nil, at); err != nil { + if _, _, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"probeold" + stamp}, true, nil, at); err != nil { t.Fatalf("SetArticleTags(first) err = %v, want nil", err) } - if _, _, err := d.SetArticleTags(ctx, id, []string{"probenew" + stamp}, true, nil, at.Add(time.Second)); err != nil { + if _, _, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"probenew" + stamp}, true, nil, at.Add(time.Second)); err != nil { t.Fatalf("SetArticleTags(second) err = %v, want nil", err) } @@ -154,10 +154,10 @@ func TestSetArticleTagsKeepsQuietWhenNothingMoves(t *testing.T) { stamp := time.Now().Format("150405.000000") at := time.Now().UTC() - if _, _, err := d.SetArticleTags(ctx, id, []string{"probe" + stamp}, true, nil, at); err != nil { + if _, _, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"probe" + stamp}, true, nil, at); err != nil { t.Fatalf("SetArticleTags(first) err = %v, want nil", err) } - _, wrote, err := d.SetArticleTags(ctx, id, []string{"probe" + stamp}, true, nil, at.Add(time.Second)) + _, wrote, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"probe" + stamp}, true, nil, at.Add(time.Second)) if err != nil { t.Fatalf("SetArticleTags(second) err = %v, want nil", err) } @@ -173,10 +173,10 @@ func TestSetArticleTagsSweepsATagNothingCarries(t *testing.T) { stamp := time.Now().Format("150405.000000") at := time.Now().UTC() - if _, _, err := d.SetArticleTags(ctx, id, []string{"probegone" + stamp}, true, nil, at); err != nil { + if _, _, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"probegone" + stamp}, true, nil, at); err != nil { t.Fatalf("SetArticleTags(first) err = %v, want nil", err) } - if _, _, err := d.SetArticleTags(ctx, id, []string{"probekept" + stamp}, true, nil, at.Add(time.Second)); err != nil { + if _, _, err := d.SetArticleTags(ctx, seedSiteID(t, d), id, []string{"probekept" + stamp}, true, nil, at.Add(time.Second)); err != nil { t.Fatalf("SetArticleTags(second) err = %v, want nil", err) } diff --git a/internal/db/theme_write.go b/internal/db/theme_write.go index ed775ee3..ac77ff1b 100644 --- a/internal/db/theme_write.go +++ b/internal/db/theme_write.go @@ -21,10 +21,10 @@ type ThemeRow struct { var qThemes = register("Themes", ` SELECT id, name, slug, mode, css, external_url, updated_at -FROM web_theme ORDER BY name, id`) +FROM web_theme WHERE site_id = $1 ORDER BY name, id`) -func (d *DB) Themes(ctx context.Context) ([]ThemeRow, error) { - rows, err := d.pool.Query(ctx, qThemes) +func (d *DB) Themes(ctx context.Context, siteID int64) ([]ThemeRow, error) { + rows, err := d.pool.Query(ctx, qThemes, siteID) if err != nil { return nil, fmt.Errorf("list themes: %w", err) } @@ -59,18 +59,18 @@ func (d *DB) Theme(ctx context.Context, id int64) (ThemeRow, error) { } var qInsertTheme = register("InsertTheme", ` -INSERT INTO web_theme (name, slug, mode, css, external_url, updated_at) -VALUES ($1, $2, $3, $4, $5, $6) RETURNING id`) +INSERT INTO web_theme (name, slug, mode, css, external_url, updated_at, site_id) +VALUES ($1, $2, $3, $4, $5, $6, $7) RETURNING id`) var qUpdateTheme = register("UpdateTheme", ` UPDATE web_theme SET name = $2, slug = $3, mode = $4, css = $5, external_url = $6, updated_at = $7 WHERE id = $1`) -func (d *DB) SaveTheme(ctx context.Context, t ThemeRow) (int64, error) { +func (d *DB) SaveTheme(ctx context.Context, siteID int64, t ThemeRow) (int64, error) { at := time.Now() if t.ID == 0 { var id int64 - err := d.pool.QueryRow(ctx, qInsertTheme, t.Name, t.Slug, t.Mode, t.CSS, t.ExternalURL, at).Scan(&id) + err := d.pool.QueryRow(ctx, qInsertTheme, t.Name, t.Slug, t.Mode, t.CSS, t.ExternalURL, at, siteID).Scan(&id) if err != nil { return 0, fmt.Errorf("create theme %q: %w", t.Slug, err) } diff --git a/internal/db/ticket_admin.go b/internal/db/ticket_admin.go index af04bd6d..03758683 100644 --- a/internal/db/ticket_admin.go +++ b/internal/db/ticket_admin.go @@ -40,24 +40,24 @@ LEFT JOIN web_user rev ON rev.id = t.reviewed_by_id` var qAdminTickets = register("AdminTickets", ` SELECT `+ticketColumns+ticketJoins+` -WHERE t.kind = $1 AND ($2 = '' OR t.status = $2) +WHERE t.kind = $1 AND ($2 = '' OR t.status = $2) AND t.site_id = $5 ORDER BY t.created_at DESC, t.id DESC LIMIT $3 OFFSET $4`) var qAdminTicketCount = register("AdminTicketCount", ` -SELECT count(*) FROM web_userticket t WHERE t.kind = $1 AND ($2 = '' OR t.status = $2)`) +SELECT count(*) FROM web_userticket t WHERE t.kind = $1 AND ($2 = '' OR t.status = $2) AND t.site_id = $3`) func scanTicket(row pgx.Row, t *TicketRow) error { return row.Scan(&t.ID, &t.Kind, &t.Author, &t.Subject, &t.Body, &t.SourcePage, &t.Status, &t.AdminNotes, &t.CreatedAt, &t.ReviewedAt, &t.ReviewedBy, &t.GrantedID) } -func (d *DB) AdminTickets(ctx context.Context, kind, status string, limit, offset int) ([]TicketRow, int, error) { +func (d *DB) AdminTickets(ctx context.Context, siteID int64, kind, status string, limit, offset int) ([]TicketRow, int, error) { var total int - if err := d.pool.QueryRow(ctx, qAdminTicketCount, kind, status).Scan(&total); err != nil { + if err := d.pool.QueryRow(ctx, qAdminTicketCount, kind, status, siteID).Scan(&total); err != nil { return nil, 0, fmt.Errorf("count tickets: %w", err) } - rows, err := d.pool.Query(ctx, qAdminTickets, kind, status, limit, offset) + rows, err := d.pool.Query(ctx, qAdminTickets, kind, status, limit, offset, siteID) if err != nil { return nil, 0, fmt.Errorf("list tickets: %w", err) } @@ -136,27 +136,27 @@ type InviteRow struct { var qAdminInvites = register("AdminInvites", ` SELECT id, kind, delivery, email, wikidot_username, token, uidb64, created_at, activated_at, activated_username -FROM web_invitelink ORDER BY created_at DESC, id DESC LIMIT $1 OFFSET $2`) +FROM web_invitelink WHERE site_id = $3 ORDER BY created_at DESC, id DESC LIMIT $1 OFFSET $2`) -var qAdminInviteCount = register("AdminInviteCount", `SELECT count(*) FROM web_invitelink`) +var qAdminInviteCount = register("AdminInviteCount", `SELECT count(*) FROM web_invitelink WHERE site_id = $1`) var qOpenInviteCount = register("OpenInviteCount", ` -SELECT count(*) FROM web_invitelink WHERE activated_at IS NULL`) +SELECT count(*) FROM web_invitelink WHERE activated_at IS NULL AND site_id = $1`) -func (d *DB) OpenInviteCount(ctx context.Context) (int, error) { +func (d *DB) OpenInviteCount(ctx context.Context, siteID int64) (int, error) { var total int - if err := d.pool.QueryRow(ctx, qOpenInviteCount).Scan(&total); err != nil { + if err := d.pool.QueryRow(ctx, qOpenInviteCount, siteID).Scan(&total); err != nil { return 0, fmt.Errorf("count open invite links: %w", err) } return total, nil } -func (d *DB) AdminInvites(ctx context.Context, limit, offset int) ([]InviteRow, int, error) { +func (d *DB) AdminInvites(ctx context.Context, siteID int64, limit, offset int) ([]InviteRow, int, error) { var total int - if err := d.pool.QueryRow(ctx, qAdminInviteCount).Scan(&total); err != nil { + if err := d.pool.QueryRow(ctx, qAdminInviteCount, siteID).Scan(&total); err != nil { return nil, 0, fmt.Errorf("count invite links: %w", err) } - rows, err := d.pool.Query(ctx, qAdminInvites, limit, offset) + rows, err := d.pool.Query(ctx, qAdminInvites, limit, offset, siteID) if err != nil { return nil, 0, fmt.Errorf("list invite links: %w", err) } diff --git a/internal/db/user_admin.go b/internal/db/user_admin.go index 88d4ecfd..1ec8f679 100644 --- a/internal/db/user_admin.go +++ b/internal/db/user_admin.go @@ -82,7 +82,7 @@ var qAdminUser = register("AdminUser", `SELECT `+adminUserColumns+` FROM web_use var qAdminUserRoles = register("AdminUserRoles", `SELECT role_id FROM web_user_roles WHERE user_id = $1`) -func (d *DB) AdminUser(ctx context.Context, id int64) (AdminUserRow, error) { +func (d *DB) AdminUser(ctx context.Context, siteID, id int64) (AdminUserRow, error) { var u AdminUserRow err := scanAdminUser(d.pool.QueryRow(ctx, qAdminUser, id), &u) if errors.Is(err, pgx.ErrNoRows) { @@ -107,7 +107,7 @@ func (d *DB) AdminUser(ctx context.Context, id int64) (AdminUserRow, error) { if err := rows.Err(); err != nil { return AdminUserRow{}, err } - u.OperationIndex, err = d.OperationIndex(ctx, id) + u.OperationIndex, err = d.OperationIndex(ctx, siteID, id) return u, err } @@ -122,10 +122,10 @@ WHERE id=$1`) qClearUserRole = register("ClearUserRoles", `DELETE FROM web_user_roles WHERE user_id = $1`) qAddUserRole = register("AddUserRoles", ` INSERT INTO web_user_roles (user_id, role_id) -SELECT $1, r.id FROM web_role r WHERE r.id = ANY($2) AND r.slug <> ALL($3)`) +SELECT $1, r.id FROM web_role r WHERE r.id = ANY($2) AND r.slug <> ALL($3) AND r.site_id = $4`) ) -func (d *DB) SaveAdminUser(ctx context.Context, u AdminUserRow, builtin []string, withRoles, withSuperuser bool) error { +func (d *DB) SaveAdminUser(ctx context.Context, siteID int64, u AdminUserRow, builtin []string, withRoles, withSuperuser bool) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin saving user %d: %w", u.ID, err) @@ -148,7 +148,7 @@ func (d *DB) SaveAdminUser(ctx context.Context, u AdminUserRow, builtin []string return err } if len(u.Roles) > 0 { - if _, err := tx.Exec(ctx, qAddUserRole, u.ID, u.Roles, builtin); err != nil { + if _, err := tx.Exec(ctx, qAddUserRole, u.ID, u.Roles, builtin, siteID); err != nil { return fmt.Errorf("give roles to user %d: %w", u.ID, err) } } diff --git a/internal/listpages/params_db_test.go b/internal/listpages/params_db_test.go index d020c4fb..b32fb8ed 100644 --- a/internal/listpages/params_db_test.go +++ b/internal/listpages/params_db_test.go @@ -128,7 +128,7 @@ func (s dbSource) CategoryForm(category string) (*form.Definition, error) { } func (s dbSource) TagIDsByName(categorySlug, name string) ([]int64, error) { - return s.d.TagIDsByName(s.ctx, categorySlug, name) + return s.d.TagIDsByName(s.ctx, onlySiteID(s.ctx, s.d), categorySlug, name) } func (s dbSource) ArticleTagIDs(articleID int64) ([]int64, error) { diff --git a/internal/repo/modules.go b/internal/repo/modules.go index 663244f4..b08bb203 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -16,11 +16,11 @@ import ( type moduleData struct{ repo *Repository } func (m moduleData) TagCategory(slug string) (db.TagCategory, error) { - return m.repo.db.TagCategoryBySlug(m.repo.ctx, slug) + return m.repo.db.TagCategoryBySlug(m.repo.ctx, m.repo.siteID(), slug) } func (m moduleData) TagArticles(categorySlug, name string, hidden []string) ([]db.Article, error) { - return m.repo.db.ArticlesByTag(m.repo.ctx, categorySlug, name, hidden) + return m.repo.db.ArticlesByTag(m.repo.ctx, m.repo.siteID(), categorySlug, name, hidden) } func (m moduleData) HiddenCategories(user *db.User) ([]string, error) { @@ -52,7 +52,7 @@ func HiddenCategories(ctx context.Context, d *db.DB, user *db.User) ([]string, e } func (m moduleData) TagIDsByName(categorySlug, name string) ([]int64, error) { - return m.repo.db.TagIDsByName(m.repo.ctx, categorySlug, name) + return m.repo.db.TagIDsByName(m.repo.ctx, m.repo.siteID(), categorySlug, name) } func (m moduleData) ArticleTagIDs(articleID int64) ([]int64, error) { @@ -110,11 +110,15 @@ func (m moduleData) HasVoted(articleID int64, userID *int64) (bool, error) { return m.repo.db.HasVoted(m.repo.ctx, articleID, userID) } +// The filter is stamped here rather than where a module builds it, so no +// module can ask for another site's pages by leaving the field alone. func (m moduleData) ListArticles(f db.ListFilter, offset int, limit *int) ([]db.Article, error) { + f.SiteID = m.repo.siteID() return m.repo.db.ListArticles(m.repo.ctx, f, offset, limit) } func (m moduleData) CountArticles(f db.ListFilter, offset int, limit *int) (int, error) { + f.SiteID = m.repo.siteID() return m.repo.db.CountArticles(m.repo.ctx, f, offset, limit) } @@ -135,7 +139,7 @@ func (m moduleData) CommentInfo(articleID int64) (db.CommentInfo, error) { } func (m moduleData) TagCloud(limit *int) ([]db.CloudTag, error) { - return m.repo.db.TagCloud(m.repo.ctx, limit) + return m.repo.db.TagCloud(m.repo.ctx, m.repo.siteID(), limit) } func (m moduleData) WantedLinks(f db.WantedFilter, offset, limit int) ([]db.WantedLink, error) { @@ -325,15 +329,17 @@ func UserJSON(ctx context.Context, d *db.DB, u *db.User) (wikijson.Object, error } func (m moduleData) SearchArticles(f db.SearchFilter, offset, limit int) ([]db.SearchHit, error) { + f.SiteID = m.repo.siteID() return m.repo.db.SearchArticles(m.repo.ctx, f, offset, limit) } func (m moduleData) SearchCount(f db.SearchFilter) (int, error) { + f.SiteID = m.repo.siteID() return m.repo.db.SearchCount(m.repo.ctx, f) } func (m moduleData) TagIDsByFullName(category, name string) ([]int64, error) { - return m.repo.db.TagIDsByFullName(m.repo.ctx, category, name) + return m.repo.db.TagIDsByFullName(m.repo.ctx, m.repo.siteID(), category, name) } func (m moduleData) AuthorsOfArticles(ids []int64) (map[int64][]db.User, error) { @@ -357,15 +363,17 @@ func (m moduleData) UserByDisplayName(name string) (*db.User, error) { } func (m moduleData) SiteChanges(f db.SiteChangeFilter, offset, limit int) ([]db.SiteChange, error) { + f.SiteID = m.repo.siteID() return m.repo.db.SiteChanges(m.repo.ctx, f, offset, limit) } func (m moduleData) SiteChangeCount(f db.SiteChangeFilter) (int, error) { + f.SiteID = m.repo.siteID() return m.repo.db.SiteChangeCount(m.repo.ctx, f) } func (m moduleData) ArticleCategories(hidden []string) ([]string, error) { - return m.repo.db.ArticleCategories(m.repo.ctx, hidden) + return m.repo.db.ArticleCategories(m.repo.ctx, m.repo.siteID(), hidden) } func (m moduleData) UserIDsByName(name string, partial bool) ([]int64, error) { @@ -401,7 +409,7 @@ func (m moduleData) CreateForumPost(w db.ForumPostWrite) (int64, error) { } func (m moduleData) CreateForumThread(w db.ForumThreadWrite, source string) (int64, int64, error) { - return m.repo.db.CreateForumThread(m.repo.ctx, w, source) + return m.repo.db.CreateForumThread(m.repo.ctx, m.repo.siteID(), w, source) } func (m moduleData) UpdateForumPost(postID int64, name, source, previous string, authorID *int64) error { @@ -433,11 +441,11 @@ func (m moduleData) ActiveUsersByNames(names []string) ([]db.User, error) { } func (m moduleData) TagsCategories() ([]db.TagsCategory, error) { - return m.repo.db.TagsCategories(m.repo.ctx) + return m.repo.db.TagsCategories(m.repo.ctx, m.repo.siteID()) } func (m moduleData) AllTags() ([]db.NamedTag, error) { - return m.repo.db.AllTags(m.repo.ctx) + return m.repo.db.AllTags(m.repo.ctx, m.repo.siteID()) } func (m moduleData) PostLikeCounts(postIDs []int64) (map[int64]int, error) { diff --git a/internal/userpage/userpage.go b/internal/userpage/userpage.go index 32bd3354..9218ca99 100644 --- a/internal/userpage/userpage.go +++ b/internal/userpage/userpage.go @@ -248,6 +248,7 @@ func (h *Handler) edits(r *http.Request, loc *i18n.Localizer, site *db.Site, return shell.ProfileFeed{}, err } filter := db.SiteChangeFilter{ + SiteID: siteID(ctx), Hidden: hidden, HasUser: true, UserIDs: []int64{profile.ID}, diff --git a/internal/webapi/allarticles.go b/internal/webapi/allarticles.go index b8501bbe..8cfa7530 100644 --- a/internal/webapi/allarticles.go +++ b/internal/webapi/allarticles.go @@ -57,7 +57,7 @@ func (h *AllArticles) listing(ctx context.Context, current *db.Site, viewer *db. if err != nil { return "", err } - articles, err := h.deps.DB.ListArticles(ctx, db.ListFilter{}, 0, nil) + articles, err := h.deps.DB.ListArticles(ctx, db.ListFilter{SiteID: siteID(ctx)}, 0, nil) if err != nil { return "", err } diff --git a/internal/webapi/favourites.go b/internal/webapi/favourites.go index a91d8eb3..fc7449bb 100644 --- a/internal/webapi/favourites.go +++ b/internal/webapi/favourites.go @@ -62,7 +62,7 @@ func (h *Favourites) ServeHTTP(w http.ResponseWriter, r *http.Request) { page = pages } - found, err := h.deps.DB.FavouritesOf(ctx, user.ID, (page-1)*favouritesPerPage, favouritesPerPage) + found, err := h.deps.DB.FavouritesOf(ctx, siteID(ctx), user.ID, (page-1)*favouritesPerPage, favouritesPerPage) if err != nil { h.deps.log().Error("list favourites", "err", err) writeJSON(w, http.StatusInternalServerError, field("error", loc.T("api-internal-error"))) diff --git a/internal/webapi/invite.go b/internal/webapi/invite.go index 781fc51f..ff245bdc 100644 --- a/internal/webapi/invite.go +++ b/internal/webapi/invite.go @@ -110,7 +110,7 @@ func (h *Users) mintInvite(r *http.Request, current *db.Site, by *db.User, email link := scheme(r) + "://" + current.Domain + acceptPrefix + uid + "/" + minted owner := by.ID - if _, err := h.deps.DB.CreateInviteLink(ctx, inviteKindRegister, inviteByLink, + if _, err := h.deps.DB.CreateInviteLink(ctx, siteID(ctx), inviteKindRegister, inviteByLink, email, "", minted, uid, &owner, id, now); err != nil { return "", err } diff --git a/internal/webapi/mypages.go b/internal/webapi/mypages.go index 2c35bbae..96e63ee7 100644 --- a/internal/webapi/mypages.go +++ b/internal/webapi/mypages.go @@ -58,7 +58,7 @@ func (h *OwnRows) ratings(w http.ResponseWriter, r *http.Request, loc *i18n.Loca } page, pages := pageOf(r, total) - found, err := h.deps.DB.RatedBy(ctx, user.ID, (page-1)*ownRowsPerPage, ownRowsPerPage) + found, err := h.deps.DB.RatedBy(ctx, siteID(ctx), user.ID, (page-1)*ownRowsPerPage, ownRowsPerPage) if err != nil { h.deps.log().Error("list ratings", "err", err) writeJSON(w, http.StatusInternalServerError, field("error", loc.T("api-internal-error"))) @@ -95,7 +95,7 @@ func (h *OwnRows) likedPosts(w http.ResponseWriter, r *http.Request, loc *i18n.L } page, pages := pageOf(r, total) - found, err := h.deps.DB.LikedPostsOf(ctx, user.ID, (page-1)*ownRowsPerPage, ownRowsPerPage) + found, err := h.deps.DB.LikedPostsOf(ctx, siteID(ctx), user.ID, (page-1)*ownRowsPerPage, ownRowsPerPage) if err != nil { h.deps.log().Error("list liked posts", "err", err) writeJSON(w, http.StatusInternalServerError, field("error", loc.T("api-internal-error"))) diff --git a/internal/webapi/reports.go b/internal/webapi/reports.go index 95996062..568f1255 100644 --- a/internal/webapi/reports.go +++ b/internal/webapi/reports.go @@ -60,7 +60,7 @@ func (h *Messages) report(r *http.Request, loc *i18n.Localizer, user *db.User) ( return "", 0, err } - recent, err := h.deps.DB.ReportsSince(ctx, user.ID, reported.ID, time.Now().Add(-reportRateLimitScope)) + recent, err := h.deps.DB.ReportsSince(ctx, siteID(ctx), user.ID, reported.ID, time.Now().Add(-reportRateLimitScope)) if err != nil { return "", 0, err } @@ -80,7 +80,7 @@ func (h *Messages) report(r *http.Request, loc *i18n.Localizer, user *db.User) ( if err != nil { return "", 0, err } - id, err := h.deps.DB.CreateReport(ctx, user.ID, reported.ID, reason, snapshot, time.Now()) + id, err := h.deps.DB.CreateReport(ctx, siteID(ctx), user.ID, reported.ID, reason, snapshot, time.Now()) if err != nil { return "", 0, err } diff --git a/internal/webapi/update.go b/internal/webapi/update.go index 390d1644..8187622c 100644 --- a/internal/webapi/update.go +++ b/internal/webapi/update.go @@ -294,7 +294,7 @@ func (e *editor) retag() (*refusal, error) { if err != nil { return nil, err } - rev, _, err := e.handler.deps.DB.SetArticleTags(e.req.Context(), e.article.ID, tags, allow, e.userID, e.at) + rev, _, err := e.handler.deps.DB.SetArticleTags(e.req.Context(), siteID(e.req.Context()), e.article.ID, tags, allow, e.userID, e.at) if err != nil { return nil, err } From 702cf8c9a2c70c06f9840114c8e01eaa8836dbe5 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 13:22:34 +0900 Subject: [PATCH 349/428] include a page from another site --- internal/callbacks/callbacks.go | 21 ++++---- internal/callbacks/callbacks_test.go | 29 +++++++++-- internal/db/article_write.go | 30 ++++++----- internal/db/article_write_test.go | 24 ++++----- internal/db/links.go | 6 +-- internal/db/listpages.go | 3 +- internal/db/site_scope_test.go | 1 + internal/i18n/locales/zh-hans.json | 2 +- internal/migrate/sql/0004_link_sites.sql | 19 +++++++ internal/pagerender/pagerender.go | 34 ++++++++++++- internal/repo/perms.go | 32 ++++++++---- internal/repo/repo.go | 64 ++++++++++++++++++++++-- internal/webapi/articles.go | 2 +- internal/webapi/create.go | 2 +- internal/webapi/update.go | 2 +- internal/wikidot/name.go | 15 ++++++ 16 files changed, 222 insertions(+), 64 deletions(-) create mode 100644 internal/migrate/sql/0004_link_sites.sql diff --git a/internal/callbacks/callbacks.go b/internal/callbacks/callbacks.go index 85d7932f..2662120c 100644 --- a/internal/callbacks/callbacks.go +++ b/internal/callbacks/callbacks.go @@ -163,10 +163,7 @@ func (c *Callbacks) IncludePages(refs []renderer.IncludeRef) ([]renderer.Fetched local := make([]renderer.IncludeRef, 0, len(refs)) asked := make([]string, 0, len(refs)) for _, ref := range refs { - name, ok := c.localName(ref.FullName) - if !ok { - continue - } + name, _ := c.localName(ref.FullName) asked = append(asked, ref.FullName) ref.FullName = name local = append(local, ref) @@ -195,19 +192,21 @@ func (c *Callbacks) IncludePages(refs []renderer.IncludeRef) ([]renderer.Fetched } // A ref naming this very wiki means the same as one naming no wiki. One naming -// another is turned away, since looking it up here reads the site as a category. +// another keeps its prefix, because only the repository can say whether that +// wiki exists and whether the reader may read there. func (c *Callbacks) localName(fullName string) (string, bool) { - rest, prefixed := strings.CutPrefix(fullName, ":") - if !prefixed { + slug, name := wikidot.SplitSiteRef(fullName) + if slug == "" { return fullName, true } - slug, name, found := strings.Cut(rest, ":") - if !found || c.site == "" || !strings.EqualFold(slug, c.site) { - return "", false + if c.site != "" && strings.EqualFold(slug, c.site) { + return name, true } - return name, true + return fullName, false } +// A ref that named another wiki gets one answer for every way it can fail, so +// the block cannot be used to tell a missing page from an unreadable one. func (c *Callbacks) NoSuchInclude(fullName string) (string, error) { name, ok := c.localName(fullName) if !ok { diff --git a/internal/callbacks/callbacks_test.go b/internal/callbacks/callbacks_test.go index 86a50e10..05658546 100644 --- a/internal/callbacks/callbacks_test.go +++ b/internal/callbacks/callbacks_test.go @@ -427,7 +427,7 @@ func TestNoSuchIncludeTakesARefNamingThisWikiAsLocal(t *testing.T) { } } -func TestIncludePagesDoesNotLookUpAnOffSiteRef(t *testing.T) { +func TestIncludePagesHandsAnOffSiteRefToTheRepository(t *testing.T) { repo := &fakeRepo{} c := newCallbacks(t, repo) @@ -438,15 +438,34 @@ func TestIncludePagesDoesNotLookUpAnOffSiteRef(t *testing.T) { if err != nil { t.Fatalf("IncludePages() err = %v, want nil", err) } + if len(repo.includeSeen) != 2 { + t.Fatalf("len(refs reaching the repository) = %d, want 2", len(repo.includeSeen)) + } + if repo.includeSeen[0].FullName != ":other:component:box" { + t.Errorf("ref reaching the repository = %q, want %q", repo.includeSeen[0].FullName, ":other:component:box") + } + if repo.includeSeen[1].FullName != "component:box" { + t.Errorf("ref reaching the repository = %q, want %q", repo.includeSeen[1].FullName, "component:box") + } + if len(got) != 2 { + t.Errorf("len(IncludePages()) = %d, want 2", len(got)) + } +} + +func TestIncludePagesStripsThisSiteFromARef(t *testing.T) { + repo := &fakeRepo{} + c := newCallbacks(t, repo) + c.SetSite("wikit") + + if _, err := c.IncludePages([]renderer.IncludeRef{{FullName: ":wikit:component:box"}}); err != nil { + t.Fatalf("IncludePages() err = %v, want nil", err) + } if len(repo.includeSeen) != 1 { t.Fatalf("len(refs reaching the repository) = %d, want 1", len(repo.includeSeen)) } if repo.includeSeen[0].FullName != "component:box" { t.Errorf("ref reaching the repository = %q, want %q", repo.includeSeen[0].FullName, "component:box") } - if len(got) != 1 { - t.Errorf("len(IncludePages()) = %d, want 1", len(got)) - } } func TestNoSuchIncludeReportsAnOffSiteRef(t *testing.T) { @@ -456,7 +475,7 @@ func TestNoSuchIncludeReportsAnOffSiteRef(t *testing.T) { if err != nil { t.Fatalf("NoSuchInclude() err = %v, want nil", err) } - want := `[[div class="error-block"]]插入的页面 ":other:component:box" 在别的站点上，暂不支持跨站插入[[/div]]` + want := `[[div class="error-block"]]取不到插入的页面 ":other:component:box"，可能是站点缩写写错了，也可能是你在那个站点上看不到它[[/div]]` if got != want { t.Errorf("NoSuchInclude() = %q, want %q", got, want) } diff --git a/internal/db/article_write.go b/internal/db/article_write.go index d3fbceee..488a19c2 100644 --- a/internal/db/article_write.go +++ b/internal/db/article_write.go @@ -98,39 +98,45 @@ func versionMeta(versionID int64, w VersionWrite) (string, error) { type ArticleLink struct { To string Kind string + + // ToSiteID is nil for a target on the same site, which is every link that + // does not name one. + ToSiteID *int64 } var ( qDropArticleLinks = register("DropArticleLinks", ` -DELETE FROM web_externallink WHERE link_from = $1`) +DELETE FROM web_externallink WHERE link_from = $1 AND from_site_id = $2`) qInsertArticleLinks = register("InsertArticleLinks", ` -INSERT INTO web_externallink (link_from, link_type, link_to) -SELECT $1, kind, target -FROM unnest($2::text[], $3::text[]) AS t(kind, target) +INSERT INTO web_externallink (link_from, link_type, link_to, from_site_id, to_site_id) +SELECT $1, kind, target, $4, coalesce(site, $4) +FROM unnest($2::text[], $3::text[], $5::bigint[]) AS t(kind, target, site) ON CONFLICT DO NOTHING`) ) // The whole set is replaced under one transaction, so nobody reads a page as // having no links at all while it is being saved. -func (d *DB) ReplaceArticleLinks(ctx context.Context, from string, links []ArticleLink) error { +func (d *DB) ReplaceArticleLinks(ctx context.Context, siteID int64, from string, links []ArticleLink) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin links of %q: %w", from, err) } defer tx.Rollback(ctx) - if _, err := tx.Exec(ctx, qDropArticleLinks, from); err != nil { + if _, err := tx.Exec(ctx, qDropArticleLinks, from, siteID); err != nil { return fmt.Errorf("drop links of %q: %w", from, err) } if len(links) > 0 { kinds := make([]string, 0, len(links)) targets := make([]string, 0, len(links)) + sites := make([]*int64, 0, len(links)) for _, link := range links { kinds = append(kinds, link.Kind) targets = append(targets, link.To) + sites = append(sites, link.ToSiteID) } - if _, err := tx.Exec(ctx, qInsertArticleLinks, from, kinds, targets); err != nil { + if _, err := tx.Exec(ctx, qInsertArticleLinks, from, kinds, targets, siteID, sites); err != nil { return fmt.Errorf("write links of %q: %w", from, err) } } @@ -402,15 +408,15 @@ var ( UPDATE web_article SET category = $2, name = $3 WHERE id = $1`) qDropLinksFrom = register("DropLinksFrom", ` -DELETE FROM web_externallink WHERE link_from = $1`) +DELETE FROM web_externallink WHERE link_from = $1 AND from_site_id = $2`) qMoveLinksFrom = register("MoveLinksFrom", ` -UPDATE web_externallink SET link_from = $2 WHERE link_from = $1`) +UPDATE web_externallink SET link_from = $2 WHERE link_from = $1 AND from_site_id = $3`) ) // What a page points at moves with it, but what points at the page does not. // Everyone who linked to the old name keeps linking to the old name. -func (d *DB) RenameArticle(ctx context.Context, articleID int64, category, name, from string, +func (d *DB) RenameArticle(ctx context.Context, siteID, articleID int64, category, name, from string, userID *int64, at time.Time) (Revision, error) { to := (&Article{Category: category, Name: name}).FullName() @@ -424,10 +430,10 @@ func (d *DB) RenameArticle(ctx context.Context, articleID int64, category, name, if _, err := tx.Exec(ctx, qRenameArticle, articleID, category, name); err != nil { return Revision{}, fmt.Errorf("rename article %d: %w", articleID, err) } - if _, err := tx.Exec(ctx, qDropLinksFrom, to); err != nil { + if _, err := tx.Exec(ctx, qDropLinksFrom, to, siteID); err != nil { return Revision{}, fmt.Errorf("drop links of %q: %w", to, err) } - if _, err := tx.Exec(ctx, qMoveLinksFrom, from, to); err != nil { + if _, err := tx.Exec(ctx, qMoveLinksFrom, from, to, siteID); err != nil { return Revision{}, fmt.Errorf("move links of %q: %w", from, err) } diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go index f1a89dc6..1d746438 100644 --- a/internal/db/article_write_test.go +++ b/internal/db/article_write_test.go @@ -221,7 +221,7 @@ func TestReplaceArticleLinksWritesBothKinds(t *testing.T) { d := writeTestDB(t) from := scratchLinkOwner(t, d) - err := d.ReplaceArticleLinks(context.Background(), from, []ArticleLink{ + err := d.ReplaceArticleLinks(context.Background(), seedSiteID(t, d), from, []ArticleLink{ {To: "component:box", Kind: LinkInclude}, {To: "scp-173", Kind: LinkPlain}, }) @@ -245,10 +245,10 @@ func TestReplaceArticleLinksDropsWhatIsGone(t *testing.T) { ctx := context.Background() from := scratchLinkOwner(t, d) - if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "old", Kind: LinkPlain}}); err != nil { + if err := d.ReplaceArticleLinks(ctx, seedSiteID(t, d), from, []ArticleLink{{To: "old", Kind: LinkPlain}}); err != nil { t.Fatalf("ReplaceArticleLinks(first) err = %v, want nil", err) } - if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "new", Kind: LinkPlain}}); err != nil { + if err := d.ReplaceArticleLinks(ctx, seedSiteID(t, d), from, []ArticleLink{{To: "new", Kind: LinkPlain}}); err != nil { t.Fatalf("ReplaceArticleLinks(second) err = %v, want nil", err) } @@ -265,7 +265,7 @@ func TestReplaceArticleLinksCollapsesRepeats(t *testing.T) { d := writeTestDB(t) from := scratchLinkOwner(t, d) - err := d.ReplaceArticleLinks(context.Background(), from, []ArticleLink{ + err := d.ReplaceArticleLinks(context.Background(), seedSiteID(t, d), from, []ArticleLink{ {To: "component:box", Kind: LinkInclude}, {To: "component:box", Kind: LinkInclude}, {To: "component:box", Kind: LinkPlain}, @@ -283,10 +283,10 @@ func TestReplaceArticleLinksEmptiesTheSet(t *testing.T) { ctx := context.Background() from := scratchLinkOwner(t, d) - if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "old", Kind: LinkPlain}}); err != nil { + if err := d.ReplaceArticleLinks(ctx, seedSiteID(t, d), from, []ArticleLink{{To: "old", Kind: LinkPlain}}); err != nil { t.Fatalf("ReplaceArticleLinks(first) err = %v, want nil", err) } - if err := d.ReplaceArticleLinks(ctx, from, nil); err != nil { + if err := d.ReplaceArticleLinks(ctx, seedSiteID(t, d), from, nil); err != nil { t.Fatalf("ReplaceArticleLinks(none) err = %v, want nil", err) } if got := linkSet(t, d, from); len(got) != 0 { @@ -710,11 +710,11 @@ func TestRenameArticleTakesItsLinksAlong(t *testing.T) { } }) - if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "main", Kind: LinkPlain}}); err != nil { + if err := d.ReplaceArticleLinks(ctx, seedSiteID(t, d), from, []ArticleLink{{To: "main", Kind: LinkPlain}}); err != nil { t.Fatalf("ReplaceArticleLinks() err = %v, want nil", err) } - rev, err := d.RenameArticle(ctx, id, "_default", to, from, nil, at) + rev, err := d.RenameArticle(ctx, seedSiteID(t, d), id, "_default", to, from, nil, at) if err != nil { t.Fatalf("RenameArticle() err = %v, want nil", err) } @@ -777,14 +777,14 @@ func TestRenameArticleClearsWhatSatUnderTheNewName(t *testing.T) { } }) - if err := d.ReplaceArticleLinks(ctx, from, []ArticleLink{{To: "kept", Kind: LinkPlain}}); err != nil { + if err := d.ReplaceArticleLinks(ctx, seedSiteID(t, d), from, []ArticleLink{{To: "kept", Kind: LinkPlain}}); err != nil { t.Fatalf("ReplaceArticleLinks(from) err = %v, want nil", err) } - if err := d.ReplaceArticleLinks(ctx, to, []ArticleLink{{To: "stale", Kind: LinkPlain}}); err != nil { + if err := d.ReplaceArticleLinks(ctx, seedSiteID(t, d), to, []ArticleLink{{To: "stale", Kind: LinkPlain}}); err != nil { t.Fatalf("ReplaceArticleLinks(to) err = %v, want nil", err) } - if _, err := d.RenameArticle(ctx, id, "_default", to, from, nil, at); err != nil { + if _, err := d.RenameArticle(ctx, seedSiteID(t, d), id, "_default", to, from, nil, at); err != nil { t.Fatalf("RenameArticle() err = %v, want nil", err) } got := linkSet(t, d, to) @@ -819,7 +819,7 @@ func TestDeleteArticleTakesEverythingThatPointsAtIt(t *testing.T) { if err := d.SubscribeToArticle(ctx, author, id); err != nil { t.Fatalf("SubscribeToArticle() err = %v, want nil", err) } - if err := d.ReplaceArticleLinks(ctx, name, []ArticleLink{{To: "main", Kind: LinkPlain}}); err != nil { + if err := d.ReplaceArticleLinks(ctx, seedSiteID(t, d), name, []ArticleLink{{To: "main", Kind: LinkPlain}}); err != nil { t.Fatalf("ReplaceArticleLinks() err = %v, want nil", err) } diff --git a/internal/db/links.go b/internal/db/links.go index a4448839..734ecb6a 100644 --- a/internal/db/links.go +++ b/internal/db/links.go @@ -18,10 +18,10 @@ type ExternalLink struct { var qLinksTo = register("LinksTo", ` SELECT link_from, link_type FROM web_externallink -WHERE link_to = $1`) +WHERE link_to = $1 AND to_site_id = $2`) -func (d *DB) LinksTo(ctx context.Context, fullName string) ([]ExternalLink, error) { - rows, err := d.pool.Query(ctx, qLinksTo, fullName) +func (d *DB) LinksTo(ctx context.Context, siteID int64, fullName string) ([]ExternalLink, error) { + rows, err := d.pool.Query(ctx, qLinksTo, fullName, siteID) if err != nil { return nil, fmt.Errorf("query links to %q: %w", fullName, err) } diff --git a/internal/db/listpages.go b/internal/db/listpages.go index 1a0ace01..7445eb9a 100644 --- a/internal/db/listpages.go +++ b/internal/db/listpages.go @@ -218,7 +218,8 @@ func (f ListFilter) build(b *listBuilder) string { } if f.HasLinkTo { b.where = append(b.where, "EXISTS (SELECT 1 FROM web_externallink l"+ - " WHERE l.link_type = 'link'"+ + " WHERE l.link_type = 'link' AND l.from_site_id = "+b.arg(f.SiteID)+ + " AND l.to_site_id = "+b.arg(f.SiteID)+ " AND lower("+completeFrom+") = lower(a.complete_full_name)"+ " AND lower("+completeTo+") = "+b.arg(dumbName(f.LinkTo))+")") } diff --git a/internal/db/site_scope_test.go b/internal/db/site_scope_test.go index 596a3223..fa8ca03e 100644 --- a/internal/db/site_scope_test.go +++ b/internal/db/site_scope_test.go @@ -24,6 +24,7 @@ var perSiteTables = []string{ "web_userreport", "web_userticket", "pwikit_admin_log", + "web_externallink", } func touchedTables(sql string) []string { diff --git a/internal/i18n/locales/zh-hans.json b/internal/i18n/locales/zh-hans.json index 3e1347c4..08afc39c 100644 --- a/internal/i18n/locales/zh-hans.json +++ b/internal/i18n/locales/zh-hans.json @@ -468,7 +468,7 @@ "include-create": "立刻创建", "include-loop": "插入的页面 \"{name}\" 导致了无限包含循环", "include-missing": "插入的页面 \"{name}\" 不存在", - "include-off-site": "插入的页面 \"{name}\" 在别的站点上，暂不支持跨站插入", + "include-off-site": "取不到插入的页面 \"{name}\"，可能是站点缩写写错了，也可能是你在那个站点上看不到它", "login.error-credentials": "用户名或密码错误。请重试。", "login.forgot": "忘记密码", "login.no-account": "还没有账号", diff --git a/internal/migrate/sql/0004_link_sites.sql b/internal/migrate/sql/0004_link_sites.sql new file mode 100644 index 00000000..373990df --- /dev/null +++ b/internal/migrate/sql/0004_link_sites.sql @@ -0,0 +1,19 @@ +ALTER TABLE web_externallink ADD COLUMN from_site_id bigint REFERENCES web_site (id); + +-- An include may name a page on another site, so the two ends of a reference do +-- not have to agree on the site. +ALTER TABLE web_externallink ADD COLUMN to_site_id bigint REFERENCES web_site (id); + +DO $$ +DECLARE + only_site bigint; +BEGIN + SELECT id INTO only_site FROM web_site ORDER BY id LIMIT 1; + IF only_site IS NULL THEN + RETURN; + END IF; + UPDATE web_externallink SET from_site_id = only_site, to_site_id = only_site; +END $$; + +CREATE INDEX web_externallink_to_idx ON web_externallink (to_site_id, link_to); +CREATE INDEX web_externallink_from_idx ON web_externallink (from_site_id, link_from); diff --git a/internal/pagerender/pagerender.go b/internal/pagerender/pagerender.go index 2a279d8d..83f2732a 100644 --- a/internal/pagerender/pagerender.go +++ b/internal/pagerender/pagerender.go @@ -4,6 +4,7 @@ package pagerender import ( "context" + "errors" "net/http" "net/netip" "strings" @@ -17,6 +18,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/roles" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" "github.com/WikitTeam/ProjectWikit/internal/wikijson" ) @@ -68,10 +70,18 @@ func (e *Env) Backlinks(source string, info renderer.PageInfo, cb *callbacks.Cal } links := make([]db.ArticleLink, 0, len(result.IncludedPages)+len(result.LinkedPages)) for _, name := range result.IncludedPages { - links = append(links, db.ArticleLink{To: strings.ToLower(name), Kind: db.LinkInclude}) + link, err := e.link(name, db.LinkInclude) + if err != nil { + return nil, err + } + links = append(links, link) } for _, name := range result.LinkedPages { - links = append(links, db.ArticleLink{To: strings.ToLower(name), Kind: db.LinkPlain}) + link, err := e.link(name, db.LinkPlain) + if err != nil { + return nil, err + } + links = append(links, link) } return links, nil } @@ -174,3 +184,23 @@ func (e *Env) messageText(source string) (string, error) { } return text.Body, nil } + +// A reference naming another wiki is filed against that wiki, so renaming a page +// there still reaches the pages here that pull it in. +func (e *Env) link(name, kind string) (db.ArticleLink, error) { + slug, bare := wikidot.SplitSiteRef(name) + link := db.ArticleLink{To: strings.ToLower(name), Kind: kind} + if slug == "" { + return link, nil + } + other, err := e.deps.DB.SiteBySlug(e.ctx, slug) + if errors.Is(err, db.ErrNotFound) { + return link, nil + } + if err != nil { + return db.ArticleLink{}, err + } + link.To = strings.ToLower(bare) + link.ToSiteID = &other.ID + return link, nil +} diff --git a/internal/repo/perms.go b/internal/repo/perms.go index ffd1aa52..8997c2c1 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -16,12 +16,26 @@ const ( // Perms assembles what internal/perms needs out of the database. type Perms struct { - ctx context.Context - db *db.DB + ctx context.Context + db *db.DB + site *db.Site } func NewPerms(ctx context.Context, d *db.DB) *Perms { - return &Perms{ctx: ctx, db: d} + return &Perms{ctx: ctx, db: d, site: site.FromContext(ctx)} +} + +// NewPermsOn answers for a site the request is not on, which is what an include +// naming another wiki has to ask before it may read there. +func NewPermsOn(ctx context.Context, d *db.DB, s *db.Site) *Perms { + return &Perms{ctx: ctx, db: d, site: s} +} + +func (p *Perms) siteID() int64 { + if p.site == nil { + return 0 + } + return p.site.ID } // Subject collects the roles one visitor carries. A nil user is the anonymous @@ -31,7 +45,7 @@ func (p *Perms) Subject(u *db.User, now time.Time) (perms.Subject, error) { if u != nil { slugs = append(slugs, slugRegistered) } - bySlug, err := p.db.RoleIDsBySlug(p.ctx, ctxSiteID(p.ctx), slugs) + bySlug, err := p.db.RoleIDsBySlug(p.ctx, p.siteID(), slugs) if err != nil { return perms.Subject{}, err } @@ -44,7 +58,7 @@ func (p *Perms) Subject(u *db.User, now time.Time) (perms.Subject, error) { if id, ok := bySlug[slugRegistered]; ok { ids = append(ids, id) } - own, err := p.db.RoleIDsForUser(p.ctx, ctxSiteID(p.ctx), u.ID) + own, err := p.db.RoleIDsForUser(p.ctx, p.siteID(), u.ID) if err != nil { return perms.Subject{}, err } @@ -61,7 +75,7 @@ func (p *Perms) Subject(u *db.User, now time.Time) (perms.Subject, error) { subject.Active = u.ActiveAt(now) subject.ForumActive = u.ForumActiveAt(now) subject.Superuser = u.IsSuperuser - subject.Unverified = unverified(site.FromContext(p.ctx), u) + subject.Unverified = unverified(p.site, u) } return subject, nil } @@ -76,7 +90,7 @@ func unverified(current *db.Site, u *db.User) bool { // Article is the object side for a page that exists. Its category is the only // step taken before the page's own overrides. func (p *Perms) Article(a *db.Article, u *db.User) (*perms.Object, error) { - overrides, err := p.db.CategoryOverrides(p.ctx, ctxSiteID(p.ctx), a.Category) + overrides, err := p.db.CategoryOverrides(p.ctx, p.siteID(), a.Category) if err != nil { return nil, err } @@ -94,7 +108,7 @@ func (p *Perms) Article(a *db.Article, u *db.User) (*perms.Object, error) { // Category is the object side for a page that does not exist. A category with // no row of its own answers the same as no object at all. func (p *Perms) Category(name string) (*perms.Object, error) { - overrides, err := p.db.CategoryOverrides(p.ctx, ctxSiteID(p.ctx), name) + overrides, err := p.db.CategoryOverrides(p.ctx, p.siteID(), name) if err != nil { return nil, err } @@ -116,7 +130,7 @@ func (p *Perms) ForumThread(t *db.ForumThread, u *db.User) (*perms.Object, error if err != nil { return nil, err } - overrides, err := p.db.CategoryOverrides(p.ctx, ctxSiteID(p.ctx), article.Category) + overrides, err := p.db.CategoryOverrides(p.ctx, p.siteID(), article.Category) if err != nil { return nil, err } diff --git a/internal/repo/repo.go b/internal/repo/repo.go index 8899c53c..7b7ce90f 100644 --- a/internal/repo/repo.go +++ b/internal/repo/repo.go @@ -18,6 +18,7 @@ import ( // [[module]] and every page carrying one draws an error block instead. _ "github.com/WikitTeam/ProjectWikit/internal/modules" "github.com/WikitTeam/ProjectWikit/internal/page" + "github.com/WikitTeam/ProjectWikit/internal/perms" "github.com/WikitTeam/ProjectWikit/internal/printuser" "github.com/WikitTeam/ProjectWikit/internal/renderer" "github.com/WikitTeam/ProjectWikit/internal/wikidot" @@ -77,9 +78,11 @@ func (r *Repository) PageInfo(refs []string) ([]renderer.PartialPageInfo, error) } func (r *Repository) IncludeSources(refs []renderer.IncludeRef) ([]renderer.FetchedPage, error) { - names := make([]string, len(refs)) - for i, ref := range refs { - names[i] = ref.FullName + names := make([]string, 0, len(refs)) + for _, ref := range refs { + if slug, _ := wikidot.SplitSiteRef(ref.FullName); slug == "" { + names = append(names, ref.FullName) + } } sources, err := r.db.ArticleSources(r.ctx, r.siteID(), names) if err != nil { @@ -88,14 +91,65 @@ func (r *Repository) IncludeSources(refs []renderer.IncludeRef) ([]renderer.Fetc out := make([]renderer.FetchedPage, 0, len(refs)) for _, ref := range refs { page := renderer.FetchedPage{FullName: ref.FullName} - if source, ok := sources[ref.FullName]; ok { - page.Content = &source + slug, name := wikidot.SplitSiteRef(ref.FullName) + if slug == "" { + if source, ok := sources[ref.FullName]; ok { + page.Content = &source + } + out = append(out, page) + continue + } + source, err := r.offSiteSource(slug, name) + if err != nil { + return nil, err } + page.Content = source out = append(out, page) } return out, nil } +// Reading another wiki goes through that wiki's own roles, so a reader who is +// nobody there sees only what its anonymous visitor sees. +func (r *Repository) offSiteSource(slug, name string) (*string, error) { + other, err := r.db.SiteBySlug(r.ctx, slug) + if errors.Is(err, db.ErrNotFound) { + return nil, nil + } + if err != nil { + return nil, err + } + article, err := r.db.ArticleByName(r.ctx, other.ID, name) + if errors.Is(err, db.ErrNotFound) { + return nil, nil + } + if err != nil { + return nil, err + } + + resolver := NewPermsOn(r.ctx, r.db, other) + subject, err := resolver.Subject(r.opts.User, time.Now()) + if err != nil { + return nil, err + } + object, err := resolver.Article(article, r.opts.User) + if err != nil { + return nil, err + } + if !perms.Resolve(subject, object).Has(perms.ViewArticles) { + return nil, nil + } + + sources, err := r.db.ArticleSources(r.ctx, other.ID, []string{name}) + if err != nil { + return nil, err + } + if source, ok := sources[name]; ok { + return &source, nil + } + return nil, nil +} + func (r *Repository) moduleEnv(pc *page.Context) module.Env { return module.Env{ Page: pc, diff --git a/internal/webapi/articles.go b/internal/webapi/articles.go index 3b67b48f..2dbc46b3 100644 --- a/internal/webapi/articles.go +++ b/internal/webapi/articles.go @@ -174,7 +174,7 @@ func (h *Articles) links(r *http.Request, _ *i18n.Localizer, name string) (strin kids = append(kids, linkRecord(children[i].FullName(), children[i].Title, true)) } - links, err := h.deps.DB.LinksTo(ctx, name) + links, err := h.deps.DB.LinksTo(ctx, siteID(ctx), name) if err != nil { return "", 0, err } diff --git a/internal/webapi/create.go b/internal/webapi/create.go index 8baf7a12..062e8f83 100644 --- a/internal/webapi/create.go +++ b/internal/webapi/create.go @@ -196,7 +196,7 @@ func (h *Articles) refreshLinks(r *http.Request, current *db.Site, id int64, sou if err != nil { return err } - return h.deps.DB.ReplaceArticleLinks(ctx, strings.ToLower(article.FullName()), links) + return h.deps.DB.ReplaceArticleLinks(ctx, siteID(ctx), strings.ToLower(article.FullName()), links) } func (h *Articles) env(r *http.Request, current *db.Site, viewer *db.User) *pagerender.Env { diff --git a/internal/webapi/update.go b/internal/webapi/update.go index 8187622c..9d52bdfb 100644 --- a/internal/webapi/update.go +++ b/internal/webapi/update.go @@ -202,7 +202,7 @@ func (e *editor) rename() (*refusal, error) { } newCategory, newName := wikidot.Split(free) - rev, err := e.handler.deps.DB.RenameArticle(e.req.Context(), e.article.ID, + rev, err := e.handler.deps.DB.RenameArticle(e.req.Context(), siteID(e.req.Context()), e.article.ID, newCategory, newName, from, e.userID, e.at) if err != nil { return nil, err diff --git a/internal/wikidot/name.go b/internal/wikidot/name.go index 52e773f7..eba57e92 100644 --- a/internal/wikidot/name.go +++ b/internal/wikidot/name.go @@ -126,3 +126,18 @@ func allowed(r rune) bool { } return r == '-' || r == '_' || r == ':' } + +// SplitSiteRef reads the ":slug:category:page" form an include may use to name +// another wiki. A ref without the leading colon names no site and comes back +// whole. +func SplitSiteRef(fullName string) (slug, name string) { + rest, prefixed := strings.CutPrefix(fullName, ":") + if !prefixed { + return "", fullName + } + slug, name, found := strings.Cut(rest, ":") + if !found || slug == "" { + return "", fullName + } + return slug, name +} From c68eea5ee2d343cfe81846d3cbfb876e494eeed4 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 13:29:54 +0900 Subject: [PATCH 350/428] check a site owns the admin row it is asked for --- internal/admin/category.go | 4 ++-- internal/admin/forum.go | 8 +++---- internal/admin/report.go | 4 ++-- internal/admin/role.go | 8 +++---- internal/admin/tag.go | 8 +++---- internal/admin/theme.go | 4 ++-- internal/admin/ticket.go | 6 ++--- internal/db/category_admin.go | 16 ++++++------- internal/db/forum_admin.go | 37 ++++++++++++++++++------------- internal/db/message.go | 6 ++--- internal/db/message_write_test.go | 2 +- internal/db/report_admin.go | 8 +++---- internal/db/role_test.go | 30 +++++++++++++++++++++++++ internal/db/role_write.go | 26 +++++++++++----------- internal/db/tag_admin.go | 32 +++++++++++++------------- internal/db/theme_write.go | 16 ++++++------- internal/db/ticket_admin.go | 14 ++++++------ internal/pageconfig/user.go | 2 ++ internal/webapi/admin.go | 2 +- 19 files changed, 135 insertions(+), 98 deletions(-) diff --git a/internal/admin/category.go b/internal/admin/category.go index 0ec932eb..626ec908 100644 --- a/internal/admin/category.go +++ b/internal/admin/category.go @@ -46,7 +46,7 @@ func (h *Handler) pageCategoryForm(w http.ResponseWriter, r *http.Request, loc * notFound(w) return nil } - row, err = h.deps.DB.AdminCategory(ctx, id) + row, err = h.deps.DB.AdminCategory(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -126,7 +126,7 @@ func (h *Handler) savePageCategory(w http.ResponseWriter, r *http.Request, loc * } if r.PostFormValue("delete") != "" && row.ID != 0 { h.noteID(r, db.AdminDeleted, pageCategorySlug, row.ID, row.Name) - if err := h.deps.DB.DeleteCategory(ctx, row.ID); err != nil { + if err := h.deps.DB.DeleteCategory(ctx, siteID(ctx), row.ID); err != nil { return err } redirect(w, Prefix+pageCategorySlug+"/") diff --git a/internal/admin/forum.go b/internal/admin/forum.go index 35ea088e..8da35823 100644 --- a/internal/admin/forum.go +++ b/internal/admin/forum.go @@ -47,7 +47,7 @@ func (h *Handler) forumSections(w http.ResponseWriter, r *http.Request, loc *i18 row.ID = id } if r.PostFormValue("delete") != "" && row.ID != 0 { - if err := h.deps.DB.DeleteForumSection(ctx, row.ID); err != nil { + if err := h.deps.DB.DeleteForumSection(ctx, siteID(ctx), row.ID); err != nil { return err } h.noteID(r, db.AdminDeleted, sectionSlug, row.ID, row.Name) @@ -91,7 +91,7 @@ func (h *Handler) forumSectionForm(w http.ResponseWriter, r *http.Request, loc * notFound(w) return nil } - row, err = h.deps.DB.AdminForumSection(r.Context(), id) + row, err = h.deps.DB.AdminForumSection(r.Context(), siteID(r.Context()), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -136,7 +136,7 @@ func (h *Handler) forumCategories(w http.ResponseWriter, r *http.Request, loc *i row.ID = id } if r.PostFormValue("delete") != "" && row.ID != 0 { - if err := h.deps.DB.DeleteForumCategory(ctx, row.ID); err != nil { + if err := h.deps.DB.DeleteForumCategory(ctx, siteID(ctx), row.ID); err != nil { return err } h.noteID(r, db.AdminDeleted, categorySlug, row.ID, row.Name) @@ -184,7 +184,7 @@ func (h *Handler) forumCategoryForm(w http.ResponseWriter, r *http.Request, loc notFound(w) return nil } - row, err = h.deps.DB.AdminForumCategory(ctx, id) + row, err = h.deps.DB.AdminForumCategory(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil diff --git a/internal/admin/report.go b/internal/admin/report.go index ab870ff1..e9cd3d24 100644 --- a/internal/admin/report.go +++ b/internal/admin/report.go @@ -65,7 +65,7 @@ func (h *Handler) reportForm(w http.ResponseWriter, r *http.Request, loc *i18n.L notFound(w) return nil } - row, err := h.deps.DB.AdminReport(r.Context(), id) + row, err := h.deps.DB.AdminReport(r.Context(), siteID(r.Context()), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -104,7 +104,7 @@ func (h *Handler) saveReport(w http.ResponseWriter, r *http.Request, loc *i18n.L notFound(w) return nil } - if _, err := h.deps.DB.AdminReport(ctx, id); errors.Is(err, db.ErrNotFound) { + if _, err := h.deps.DB.AdminReport(ctx, siteID(ctx), id); errors.Is(err, db.ErrNotFound) { notFound(w) return nil } else if err != nil { diff --git a/internal/admin/role.go b/internal/admin/role.go index 47090d5c..4fa001ff 100644 --- a/internal/admin/role.go +++ b/internal/admin/role.go @@ -60,7 +60,7 @@ func (h *Handler) roleForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loc notFound(w) return nil } - row, err = h.deps.DB.AdminRole(ctx, id) + row, err = h.deps.DB.AdminRole(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -125,7 +125,7 @@ func (h *Handler) saveRole(w http.ResponseWriter, r *http.Request, loc *i18n.Loc notFound(w) return nil } - stored, err = h.deps.DB.AdminRole(ctx, id) + stored, err = h.deps.DB.AdminRole(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -148,7 +148,7 @@ func (h *Handler) saveRole(w http.ResponseWriter, r *http.Request, loc *i18n.Loc if builtin { return h.roleForm(w, r, loc, rest, loc.T("admin.role-builtin")) } - if err := h.deps.DB.DeleteRole(ctx, stored.ID); err != nil { + if err := h.deps.DB.DeleteRole(ctx, siteID(ctx), stored.ID); err != nil { return err } h.noteID(r, db.AdminDeleted, roleSlug, stored.ID, stored.Slug) @@ -258,7 +258,7 @@ func (h *Handler) roleCategories(w http.ResponseWriter, r *http.Request, loc *i1 } id := optionalID(r.PostFormValue("id")) if r.PostFormValue("delete") != "" && id != nil { - if err := h.deps.DB.DeleteRoleCategory(ctx, *id); err != nil { + if err := h.deps.DB.DeleteRoleCategory(ctx, siteID(ctx), *id); err != nil { return err } h.noteID(r, db.AdminDeleted, roleCategorySlug, *id, "") diff --git a/internal/admin/tag.go b/internal/admin/tag.go index 74e7e64f..1b2f47f9 100644 --- a/internal/admin/tag.go +++ b/internal/admin/tag.go @@ -43,7 +43,7 @@ func (h *Handler) tags(w http.ResponseWriter, r *http.Request, loc *i18n.Localiz row.ID = id } if r.PostFormValue("delete") != "" && row.ID != 0 { - if err := h.deps.DB.DeleteTag(ctx, row.ID); err != nil { + if err := h.deps.DB.DeleteTag(ctx, siteID(ctx), row.ID); err != nil { return err } h.noteID(r, db.AdminDeleted, tagSlug, row.ID, row.Name) @@ -98,7 +98,7 @@ func (h *Handler) tagForm(w http.ResponseWriter, r *http.Request, loc *i18n.Loca notFound(w) return nil } - row, err = h.deps.DB.AdminTag(ctx, id) + row, err = h.deps.DB.AdminTag(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -144,7 +144,7 @@ func (h *Handler) tagCategories(w http.ResponseWriter, r *http.Request, loc *i18 row.ID = id } if r.PostFormValue("delete") != "" && row.ID != 0 { - if err := h.deps.DB.DeleteTagCategory(ctx, row.ID); err != nil { + if err := h.deps.DB.DeleteTagCategory(ctx, siteID(ctx), row.ID); err != nil { return err } h.noteID(r, db.AdminDeleted, tagCategorySlug, row.ID, row.Name) @@ -203,7 +203,7 @@ func (h *Handler) tagCategoryForm(w http.ResponseWriter, r *http.Request, loc *i notFound(w) return nil } - row, err = h.deps.DB.AdminTagCategory(r.Context(), id) + row, err = h.deps.DB.AdminTagCategory(r.Context(), siteID(r.Context()), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil diff --git a/internal/admin/theme.go b/internal/admin/theme.go index c36e0fd6..82073e9d 100644 --- a/internal/admin/theme.go +++ b/internal/admin/theme.go @@ -55,7 +55,7 @@ func (h *Handler) themeForm(w http.ResponseWriter, r *http.Request, loc *i18n.Lo notFound(w) return nil } - row, err = h.deps.DB.Theme(r.Context(), id) + row, err = h.deps.DB.Theme(r.Context(), siteID(r.Context()), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -101,7 +101,7 @@ func (h *Handler) saveThemeForm(w http.ResponseWriter, r *http.Request, loc *i18 row.ID = id } if r.PostFormValue("delete") != "" && row.ID != 0 { - if err := h.deps.DB.DeleteTheme(r.Context(), row.ID); err != nil { + if err := h.deps.DB.DeleteTheme(r.Context(), siteID(r.Context()), row.ID); err != nil { return err } h.noteID(r, db.AdminDeleted, themeSlug, row.ID, row.Name) diff --git a/internal/admin/ticket.go b/internal/admin/ticket.go index 46558b48..e774c865 100644 --- a/internal/admin/ticket.go +++ b/internal/admin/ticket.go @@ -49,7 +49,7 @@ func (h *Handler) ticketScreen(w http.ResponseWriter, r *http.Request, loc *i18n notFound(w) return nil } - stored, err := h.deps.DB.AdminTicket(ctx, id) + stored, err := h.deps.DB.AdminTicket(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) || (err == nil && stored.Kind != kind) { notFound(w) return nil @@ -121,7 +121,7 @@ func (h *Handler) ticketForm(w http.ResponseWriter, r *http.Request, loc *i18n.L notFound(w) return nil } - row, err := h.deps.DB.AdminTicket(ctx, id) + row, err := h.deps.DB.AdminTicket(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) || (err == nil && row.Kind != kind) { notFound(w) return nil @@ -160,7 +160,7 @@ func (h *Handler) invites(w http.ResponseWriter, r *http.Request, loc *i18n.Loca return nil } if id := optionalID(r.PostFormValue("id")); id != nil && r.PostFormValue("delete") != "" { - if err := h.deps.DB.DeleteInvite(ctx, *id); err != nil { + if err := h.deps.DB.DeleteInvite(ctx, siteID(ctx), *id); err != nil { return err } h.noteID(r, db.AdminDeleted, inviteSlug, *id, "") diff --git a/internal/db/category_admin.go b/internal/db/category_admin.go index f17330b9..6a5a6868 100644 --- a/internal/db/category_admin.go +++ b/internal/db/category_admin.go @@ -49,7 +49,7 @@ func (d *DB) AdminCategories(ctx context.Context, siteID int64) ([]CategoryRow, } var qAdminCategory = register("AdminCategory", ` -SELECT id, name, is_indexed FROM web_category WHERE id = $1`) +SELECT id, name, is_indexed FROM web_category WHERE id = $1 AND site_id = $2`) var qCategorySettings = register("CategorySettings", ` SELECT rating_mode, can_user_create_tags FROM web_settings WHERE category_id = $1`) @@ -70,9 +70,9 @@ LEFT JOIN auth_permission p ON p.id = x.permission_id WHERE cpo.category_id = $1 ORDER BY r.index, o.role_id`) -func (d *DB) AdminCategory(ctx context.Context, id int64) (CategoryRow, error) { +func (d *DB) AdminCategory(ctx context.Context, siteID, id int64) (CategoryRow, error) { var c CategoryRow - err := d.pool.QueryRow(ctx, qAdminCategory, id).Scan(&c.ID, &c.Name, &c.IsIndexed) + err := d.pool.QueryRow(ctx, qAdminCategory, id, siteID).Scan(&c.ID, &c.Name, &c.IsIndexed) if errors.Is(err, pgx.ErrNoRows) { return CategoryRow{}, ErrNotFound } @@ -137,7 +137,7 @@ func (d *DB) AdminCategory(ctx context.Context, id int64) (CategoryRow, error) { var ( qInsertCategory = register("InsertCategory", `INSERT INTO web_category (name, is_indexed, site_id) VALUES ($1,$2,$3) RETURNING id`) - qUpdateCategory = register("UpdateCategory", `UPDATE web_category SET name=$2, is_indexed=$3 WHERE id=$1`) + qUpdateCategory = register("UpdateCategory", `UPDATE web_category SET name=$2, is_indexed=$3 WHERE id=$1 AND site_id=$4`) qUpsertCategorySettings = register("UpsertCategorySettings", ` INSERT INTO web_settings (category_id, site_id, rating_mode, can_user_create_tags) VALUES ($1, NULL, $2, $3) @@ -156,7 +156,7 @@ func (d *DB) SaveCategory(ctx context.Context, siteID int64, c CategoryRow) erro if err := tx.QueryRow(ctx, qInsertCategory, c.Name, c.IsIndexed, siteID).Scan(&c.ID); err != nil { return fmt.Errorf("create category %q: %w", c.Name, err) } - } else if _, err := tx.Exec(ctx, qUpdateCategory, c.ID, c.Name, c.IsIndexed); err != nil { + } else if _, err := tx.Exec(ctx, qUpdateCategory, c.ID, c.Name, c.IsIndexed, siteID); err != nil { return fmt.Errorf("update category %d: %w", c.ID, err) } if _, err := tx.Exec(ctx, qUpsertCategorySettings, c.ID, c.Settings.RatingMode, c.Settings.CreateTags); err != nil { @@ -245,10 +245,10 @@ func (d *DB) SaveCategoryOverrides(ctx context.Context, categoryID int64, list [ var ( qDropCategorySettings = register("DropCategorySettings", `DELETE FROM web_settings WHERE category_id = $1`) - qDeleteCategory = register("DeleteCategory", `DELETE FROM web_category WHERE id = $1`) + qDeleteCategory = register("DeleteCategory", `DELETE FROM web_category WHERE id = $1 AND site_id = $2`) ) -func (d *DB) DeleteCategory(ctx context.Context, id int64) error { +func (d *DB) DeleteCategory(ctx context.Context, siteID, id int64) error { if err := d.SaveCategoryOverrides(ctx, id, nil); err != nil { return err } @@ -261,7 +261,7 @@ func (d *DB) DeleteCategory(ctx context.Context, id int64) error { if _, err := tx.Exec(ctx, qDropCategorySettings, id); err != nil { return fmt.Errorf("drop the settings of category %d: %w", id, err) } - if _, err := tx.Exec(ctx, qDeleteCategory, id); err != nil { + if _, err := tx.Exec(ctx, qDeleteCategory, id, siteID); err != nil { return fmt.Errorf("delete category %d: %w", id, err) } return tx.Commit(ctx) diff --git a/internal/db/forum_admin.go b/internal/db/forum_admin.go index 298acd84..b5afec4e 100644 --- a/internal/db/forum_admin.go +++ b/internal/db/forum_admin.go @@ -43,11 +43,11 @@ func (d *DB) AdminForumSections(ctx context.Context, siteID int64) ([]ForumSecti var qAdminForumSection = register("AdminForumSection", ` SELECT id, name, description, "order", is_hidden, is_hidden_for_users -FROM web_forumsection WHERE id = $1`) +FROM web_forumsection WHERE id = $1 AND site_id = $2`) -func (d *DB) AdminForumSection(ctx context.Context, id int64) (ForumSectionRow, error) { +func (d *DB) AdminForumSection(ctx context.Context, siteID, id int64) (ForumSectionRow, error) { var s ForumSectionRow - err := d.pool.QueryRow(ctx, qAdminForumSection, id). + err := d.pool.QueryRow(ctx, qAdminForumSection, id, siteID). Scan(&s.ID, &s.Name, &s.Description, &s.Order, &s.IsHidden, &s.IsHiddenForUser) if errors.Is(err, pgx.ErrNoRows) { return ForumSectionRow{}, ErrNotFound @@ -65,9 +65,9 @@ VALUES ($1, $2, $3, $4, $5, $6) RETURNING id`) qUpdateForumSection = register("UpdateForumSection", ` UPDATE web_forumsection SET name=$2, description=$3, "order"=$4, is_hidden=$5, is_hidden_for_users=$6 -WHERE id=$1`) +WHERE id=$1 AND site_id=$7`) - qDeleteForumSection = register("DeleteForumSection", `DELETE FROM web_forumsection WHERE id = $1`) + qDeleteForumSection = register("DeleteForumSection", `DELETE FROM web_forumsection WHERE id = $1 AND site_id = $2`) ) func (d *DB) SaveForumSection(ctx context.Context, siteID int64, s ForumSectionRow) error { @@ -79,15 +79,15 @@ func (d *DB) SaveForumSection(ctx context.Context, siteID int64, s ForumSectionR } return nil } - _, err := d.pool.Exec(ctx, qUpdateForumSection, s.ID, s.Name, s.Description, s.Order, s.IsHidden, s.IsHiddenForUser) + _, err := d.pool.Exec(ctx, qUpdateForumSection, s.ID, s.Name, s.Description, s.Order, s.IsHidden, s.IsHiddenForUser, siteID) if err != nil { return fmt.Errorf("update forum section %d: %w", s.ID, err) } return nil } -func (d *DB) DeleteForumSection(ctx context.Context, id int64) error { - if _, err := d.pool.Exec(ctx, qDeleteForumSection, id); err != nil { +func (d *DB) DeleteForumSection(ctx context.Context, siteID, id int64) error { + if _, err := d.pool.Exec(ctx, qDeleteForumSection, id, siteID); err != nil { return fmt.Errorf("delete forum section %d: %w", id, err) } return nil @@ -131,11 +131,12 @@ func (d *DB) AdminForumCategories(ctx context.Context, siteID int64) ([]ForumCat var qAdminForumCategory = register("AdminForumCategory", ` SELECT id, name, description, "order", is_for_comments, section_id -FROM web_forumcategory WHERE id = $1`) +FROM web_forumcategory WHERE id = $1 +AND section_id IN (SELECT id FROM web_forumsection WHERE site_id = $2)`) -func (d *DB) AdminForumCategory(ctx context.Context, id int64) (ForumCategoryRow, error) { +func (d *DB) AdminForumCategory(ctx context.Context, siteID, id int64) (ForumCategoryRow, error) { var c ForumCategoryRow - err := d.pool.QueryRow(ctx, qAdminForumCategory, id). + err := d.pool.QueryRow(ctx, qAdminForumCategory, id, siteID). Scan(&c.ID, &c.Name, &c.Description, &c.Order, &c.IsForComments, &c.SectionID) if errors.Is(err, pgx.ErrNoRows) { return ForumCategoryRow{}, ErrNotFound @@ -149,13 +150,17 @@ func (d *DB) AdminForumCategory(ctx context.Context, id int64) (ForumCategoryRow var ( qInsertForumCategory = register("InsertForumCategory", ` INSERT INTO web_forumcategory (name, description, "order", is_for_comments, section_id) -VALUES ($1, $2, $3, $4, $5) RETURNING id`) +SELECT $1, $2, $3, $4, $5 +WHERE EXISTS (SELECT 1 FROM web_forumsection WHERE id = $5 AND site_id = $6) +RETURNING id`) qUpdateForumCategory = register("UpdateForumCategory", ` UPDATE web_forumcategory SET name=$2, description=$3, "order"=$4, is_for_comments=$5, section_id=$6 -WHERE id=$1`) +WHERE id=$1 +AND section_id IN (SELECT id FROM web_forumsection WHERE site_id = $7)`) - qDeleteForumCategory = register("DeleteForumCategory", `DELETE FROM web_forumcategory WHERE id = $1`) + qDeleteForumCategory = register("DeleteForumCategory", `DELETE FROM web_forumcategory WHERE id = $1 +AND section_id IN (SELECT id FROM web_forumsection WHERE site_id = $2)`) ) func (d *DB) SaveForumCategory(ctx context.Context, c ForumCategoryRow) error { @@ -174,8 +179,8 @@ func (d *DB) SaveForumCategory(ctx context.Context, c ForumCategoryRow) error { return nil } -func (d *DB) DeleteForumCategory(ctx context.Context, id int64) error { - if _, err := d.pool.Exec(ctx, qDeleteForumCategory, id); err != nil { +func (d *DB) DeleteForumCategory(ctx context.Context, siteID, id int64) error { + if _, err := d.pool.Exec(ctx, qDeleteForumCategory, id, siteID); err != nil { return fmt.Errorf("delete forum category %d: %w", id, err) } return nil diff --git a/internal/db/message.go b/internal/db/message.go index 9286f44e..ca430302 100644 --- a/internal/db/message.go +++ b/internal/db/message.go @@ -183,11 +183,11 @@ type Report struct { var qReport = register("Report", ` SELECT id, reporter_id, reported_id, reason, reported_messages, status, created_at FROM web_userreport -WHERE id = $1`) +WHERE id = $1 AND site_id = $2`) -func (d *DB) Report(ctx context.Context, id int64) (*Report, error) { +func (d *DB) Report(ctx context.Context, siteID, id int64) (*Report, error) { var r Report - err := d.pool.QueryRow(ctx, qReport, id).Scan(&r.ID, &r.ReporterID, &r.ReportedID, + err := d.pool.QueryRow(ctx, qReport, id, siteID).Scan(&r.ID, &r.ReporterID, &r.ReportedID, &r.Reason, &r.Messages, &r.Status, &r.CreatedAt) if errors.Is(err, pgx.ErrNoRows) { return nil, ErrNotFound diff --git a/internal/db/message_write_test.go b/internal/db/message_write_test.go index 190d237f..2ff27017 100644 --- a/internal/db/message_write_test.go +++ b/internal/db/message_write_test.go @@ -182,7 +182,7 @@ func TestCreateReport(t *testing.T) { if err != nil { t.Fatalf("CreateReport() err = %v, want nil", err) } - got, err := d.Report(ctx, id) + got, err := d.Report(ctx, seedSiteID(t, d), id) if err != nil { t.Fatalf("Report() err = %v, want nil", err) } diff --git a/internal/db/report_admin.go b/internal/db/report_admin.go index 3e024a19..68a5a39b 100644 --- a/internal/db/report_admin.go +++ b/internal/db/report_admin.go @@ -73,11 +73,11 @@ func (d *DB) AdminReports(ctx context.Context, siteID int64, status string, limi return out, total, rows.Err() } -var qAdminReport = register("AdminReport", `SELECT `+reportColumns+reportJoins+` WHERE r.id = $1`) +var qAdminReport = register("AdminReport", `SELECT `+reportColumns+reportJoins+` WHERE r.id = $1 AND r.site_id = $2`) -func (d *DB) AdminReport(ctx context.Context, id int64) (ReportRow, error) { +func (d *DB) AdminReport(ctx context.Context, siteID, id int64) (ReportRow, error) { var r ReportRow - err := scanReport(d.pool.QueryRow(ctx, qAdminReport, id), &r) + err := scanReport(d.pool.QueryRow(ctx, qAdminReport, id, siteID), &r) if errors.Is(err, pgx.ErrNoRows) { return ReportRow{}, ErrNotFound } @@ -89,7 +89,7 @@ func (d *DB) AdminReport(ctx context.Context, id int64) (ReportRow, error) { var qReviewReport = register("ReviewReport", ` UPDATE web_userreport SET status = $2, admin_notes = $3, reviewed_at = $4, reviewed_by_id = $5 -WHERE id = $1`) +WHERE id = $1 AND site_id = $6`) func (d *DB) ReviewReport(ctx context.Context, id int64, status, notes string, by int64, at time.Time) error { var reviewedAt *time.Time diff --git a/internal/db/role_test.go b/internal/db/role_test.go index dcb94b40..0c87d01b 100644 --- a/internal/db/role_test.go +++ b/internal/db/role_test.go @@ -41,3 +41,33 @@ func TestActiveAt(t *testing.T) { }) } } + +func TestRolesByUserSkipsAnotherSite(t *testing.T) { + d := newTestDB(t) + ctx := context.Background() + here := seedSiteID(t, d) + + roleList, err := d.AllRoles(ctx, here) + if err != nil { + t.Fatalf("AllRoles() err = %v, want nil", err) + } + if len(roleList) == 0 { + t.Skip("the seed site has no roles to ask about") + } + + elsewhere, err := d.AllRoles(ctx, here+1000) + if err != nil { + t.Fatalf("AllRoles(unknown site) err = %v, want nil", err) + } + if len(elsewhere) != 0 { + t.Errorf("len(AllRoles(unknown site)) = %d, want 0", len(elsewhere)) + } + + bySlug, err := d.RoleIDsBySlug(ctx, here+1000, []string{"everyone", "registered"}) + if err != nil { + t.Fatalf("RoleIDsBySlug(unknown site) err = %v, want nil", err) + } + if len(bySlug) != 0 { + t.Errorf("len(RoleIDsBySlug(unknown site)) = %d, want 0", len(bySlug)) + } +} diff --git a/internal/db/role_write.go b/internal/db/role_write.go index 29a28098..186447ad 100644 --- a/internal/db/role_write.go +++ b/internal/db/role_write.go @@ -68,7 +68,7 @@ func (d *DB) AdminRoles(ctx context.Context, siteID int64) ([]RoleRow, error) { return out, rows.Err() } -var qAdminRole = register("AdminRole", `SELECT `+roleColumns+` FROM web_role WHERE id = $1`) +var qAdminRole = register("AdminRole", `SELECT `+roleColumns+` FROM web_role WHERE id = $1 AND site_id = $2`) var qRoleGrants = register("RoleGrants", ` SELECT p.codename, false FROM web_role_permissions rp @@ -77,9 +77,9 @@ UNION ALL SELECT p.codename, true FROM web_role_restrictions rr JOIN auth_permission p ON p.id = rr.permission_id WHERE rr.role_id = $1`) -func (d *DB) AdminRole(ctx context.Context, id int64) (RoleRow, error) { +func (d *DB) AdminRole(ctx context.Context, siteID, id int64) (RoleRow, error) { var r RoleRow - err := scanRole(d.pool.QueryRow(ctx, qAdminRole, id), &r) + err := scanRole(d.pool.QueryRow(ctx, qAdminRole, id, siteID), &r) if errors.Is(err, pgx.ErrNoRows) { return RoleRow{}, ErrNotFound } @@ -142,7 +142,7 @@ VALUES ($1,$2,$3,$4,$5,$6,$7,$8,$9,$10,$11,$12,$13,$14,$15,$16,$17) RETURNING id UPDATE web_role SET slug=$2, name=$3, short_name=$4, category_id=$5, index=$6, is_staff=$7, group_votes=$8, votes_title=$9, inline_visual_mode=$10, profile_visual_mode=$11, color=$12, icon=$13, badge_text=$14, badge_bg=$15, badge_text_color=$16, badge_show_border=$17 -WHERE id=$1`) +WHERE id=$1 AND site_id=$18`) qClearRolePermissions = register("ClearRolePermissions", `DELETE FROM web_role_permissions WHERE role_id = $1`) qClearRoleRestrictions = register("ClearRoleRestrictions", `DELETE FROM web_role_restrictions WHERE role_id = $1`) @@ -174,7 +174,7 @@ func (d *DB) SaveRole(ctx context.Context, siteID int64, r RoleRow, withGrants b if err := tx.QueryRow(ctx, qInsertRole, append(args, siteID)...).Scan(&r.ID); err != nil { return 0, fmt.Errorf("create role %q: %w", r.Slug, err) } - } else if _, err := tx.Exec(ctx, qUpdateRole, append([]any{r.ID}, args...)...); err != nil { + } else if _, err := tx.Exec(ctx, qUpdateRole, append(append([]any{r.ID}, args...), siteID)...); err != nil { return 0, fmt.Errorf("update role %d: %w", r.ID, err) } @@ -199,7 +199,7 @@ func (d *DB) SaveRole(ctx context.Context, siteID int64, r RoleRow, withGrants b return r.ID, tx.Commit(ctx) } -var qDeleteRole = register("DeleteRole", `DELETE FROM web_role WHERE id = $1`) +var qDeleteRole = register("DeleteRole", `DELETE FROM web_role WHERE id = $1 AND site_id = $2`) var roleDependents = []string{ register("DropRoleGrants", `DELETE FROM web_role_permissions WHERE role_id = $1`), @@ -215,7 +215,7 @@ var roleDependents = []string{ THEN NULL ELSE membership_password_role_id END`), } -func (d *DB) DeleteRole(ctx context.Context, id int64) error { +func (d *DB) DeleteRole(ctx context.Context, siteID, id int64) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin deleting role %d: %w", id, err) @@ -227,7 +227,7 @@ func (d *DB) DeleteRole(ctx context.Context, id int64) error { return fmt.Errorf("detach role %d: %w", id, err) } } - if _, err := tx.Exec(ctx, qDeleteRole, id); err != nil { + if _, err := tx.Exec(ctx, qDeleteRole, id, siteID); err != nil { return fmt.Errorf("delete role %d: %w", id, err) } return tx.Commit(ctx) @@ -275,8 +275,8 @@ func (d *DB) RoleCategories(ctx context.Context, siteID int64) ([]RoleCategoryRo var ( qInsertRoleCategory = register("InsertRoleCategory", `INSERT INTO web_rolecategory (name, site_id) VALUES ($1,$2) RETURNING id`) - qUpdateRoleCategory = register("UpdateRoleCategory", `UPDATE web_rolecategory SET name = $2 WHERE id = $1`) - qDeleteRoleCategory = register("DeleteRoleCategory", `DELETE FROM web_rolecategory WHERE id = $1`) + qUpdateRoleCategory = register("UpdateRoleCategory", `UPDATE web_rolecategory SET name = $2 WHERE id = $1 AND site_id = $3`) + qDeleteRoleCategory = register("DeleteRoleCategory", `DELETE FROM web_rolecategory WHERE id = $1 AND site_id = $2`) ) func (d *DB) SaveRoleCategory(ctx context.Context, siteID int64, c RoleCategoryRow) error { @@ -287,7 +287,7 @@ func (d *DB) SaveRoleCategory(ctx context.Context, siteID int64, c RoleCategoryR } return nil } - if _, err := d.pool.Exec(ctx, qUpdateRoleCategory, c.ID, c.Name); err != nil { + if _, err := d.pool.Exec(ctx, qUpdateRoleCategory, c.ID, c.Name, siteID); err != nil { return fmt.Errorf("update role category %d: %w", c.ID, err) } return nil @@ -295,7 +295,7 @@ func (d *DB) SaveRoleCategory(ctx context.Context, siteID int64, c RoleCategoryR var qDetachRoleCategory = register("DetachRoleCategory", `UPDATE web_role SET category_id = NULL WHERE category_id = $1`) -func (d *DB) DeleteRoleCategory(ctx context.Context, id int64) error { +func (d *DB) DeleteRoleCategory(ctx context.Context, siteID, id int64) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin deleting role category %d: %w", id, err) @@ -305,7 +305,7 @@ func (d *DB) DeleteRoleCategory(ctx context.Context, id int64) error { if _, err := tx.Exec(ctx, qDetachRoleCategory, id); err != nil { return fmt.Errorf("detach role category %d: %w", id, err) } - if _, err := tx.Exec(ctx, qDeleteRoleCategory, id); err != nil { + if _, err := tx.Exec(ctx, qDeleteRoleCategory, id, siteID); err != nil { return fmt.Errorf("delete role category %d: %w", id, err) } return tx.Commit(ctx) diff --git a/internal/db/tag_admin.go b/internal/db/tag_admin.go index 9c529658..797f55a2 100644 --- a/internal/db/tag_admin.go +++ b/internal/db/tag_admin.go @@ -41,11 +41,11 @@ func (d *DB) AdminTagCategories(ctx context.Context, siteID int64) ([]TagCategor } var qAdminTagCategory = register("AdminTagCategory", ` -SELECT id, name, slug, description, priority FROM web_tagscategory WHERE id = $1`) +SELECT id, name, slug, description, priority FROM web_tagscategory WHERE id = $1 AND site_id = $2`) -func (d *DB) AdminTagCategory(ctx context.Context, id int64) (TagCategoryRow, error) { +func (d *DB) AdminTagCategory(ctx context.Context, siteID, id int64) (TagCategoryRow, error) { var c TagCategoryRow - err := d.pool.QueryRow(ctx, qAdminTagCategory, id). + err := d.pool.QueryRow(ctx, qAdminTagCategory, id, siteID). Scan(&c.ID, &c.Name, &c.Slug, &c.Description, &c.Priority) if errors.Is(err, pgx.ErrNoRows) { return TagCategoryRow{}, ErrNotFound @@ -60,9 +60,9 @@ var ( qInsertTagCat = register("InsertTagCat", ` INSERT INTO web_tagscategory (name, slug, description, priority, site_id) VALUES ($1,$2,$3,$4,$5) RETURNING id`) qUpdateTagCat = register("UpdateTagCat", ` -UPDATE web_tagscategory SET name=$2, slug=$3, description=$4, priority=$5 WHERE id=$1`) +UPDATE web_tagscategory SET name=$2, slug=$3, description=$4, priority=$5 WHERE id=$1 AND site_id=$6`) qDetachTagCat = register("DetachTagCat", `UPDATE web_tag SET category_id = NULL WHERE category_id = $1`) - qDeleteTagCat = register("DeleteTagCat", `DELETE FROM web_tagscategory WHERE id = $1`) + qDeleteTagCat = register("DeleteTagCat", `DELETE FROM web_tagscategory WHERE id = $1 AND site_id = $2`) ) func (d *DB) SaveTagCategory(ctx context.Context, siteID int64, c TagCategoryRow) error { @@ -74,14 +74,14 @@ func (d *DB) SaveTagCategory(ctx context.Context, siteID int64, c TagCategoryRow } return nil } - _, err := d.pool.Exec(ctx, qUpdateTagCat, c.ID, c.Name, c.Slug, c.Description, c.Priority) + _, err := d.pool.Exec(ctx, qUpdateTagCat, c.ID, c.Name, c.Slug, c.Description, c.Priority, siteID) if err != nil { return fmt.Errorf("update tag category %d: %w", c.ID, err) } return nil } -func (d *DB) DeleteTagCategory(ctx context.Context, id int64) error { +func (d *DB) DeleteTagCategory(ctx context.Context, siteID, id int64) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin deleting tag category %d: %w", id, err) @@ -91,7 +91,7 @@ func (d *DB) DeleteTagCategory(ctx context.Context, id int64) error { if _, err := tx.Exec(ctx, qDetachTagCat, id); err != nil { return fmt.Errorf("detach tag category %d: %w", id, err) } - if _, err := tx.Exec(ctx, qDeleteTagCat, id); err != nil { + if _, err := tx.Exec(ctx, qDeleteTagCat, id, siteID); err != nil { return fmt.Errorf("delete tag category %d: %w", id, err) } return tx.Commit(ctx) @@ -138,11 +138,11 @@ func (d *DB) AdminTags(ctx context.Context, siteID int64, query string, limit, o return out, total, rows.Err() } -var qAdminTag = register("AdminTag", `SELECT id, name, category_id FROM web_tag WHERE id = $1`) +var qAdminTag = register("AdminTag", `SELECT id, name, category_id FROM web_tag WHERE id = $1 AND site_id = $2`) -func (d *DB) AdminTag(ctx context.Context, id int64) (TagRow, error) { +func (d *DB) AdminTag(ctx context.Context, siteID, id int64) (TagRow, error) { var t TagRow - err := d.pool.QueryRow(ctx, qAdminTag, id).Scan(&t.ID, &t.Name, &t.CategoryID) + err := d.pool.QueryRow(ctx, qAdminTag, id, siteID).Scan(&t.ID, &t.Name, &t.CategoryID) if errors.Is(err, pgx.ErrNoRows) { return TagRow{}, ErrNotFound } @@ -154,9 +154,9 @@ func (d *DB) AdminTag(ctx context.Context, id int64) (TagRow, error) { var ( qInsertTagRow = register("InsertTagRow", `INSERT INTO web_tag (name, category_id, site_id) VALUES ($1,$2,$3) RETURNING id`) - qUpdateTag = register("UpdateTag", `UPDATE web_tag SET name=$2, category_id=$3 WHERE id=$1`) + qUpdateTag = register("UpdateTag", `UPDATE web_tag SET name=$2, category_id=$3 WHERE id=$1 AND site_id=$4`) qDetachTag = register("DetachTag", `DELETE FROM web_article_tags WHERE tag_id = $1`) - qDeleteTagRow = register("DeleteTagRow", `DELETE FROM web_tag WHERE id = $1`) + qDeleteTagRow = register("DeleteTagRow", `DELETE FROM web_tag WHERE id = $1 AND site_id = $2`) ) func (d *DB) SaveTag(ctx context.Context, siteID int64, t TagRow) error { @@ -167,13 +167,13 @@ func (d *DB) SaveTag(ctx context.Context, siteID int64, t TagRow) error { } return nil } - if _, err := d.pool.Exec(ctx, qUpdateTag, t.ID, t.Name, t.CategoryID); err != nil { + if _, err := d.pool.Exec(ctx, qUpdateTag, t.ID, t.Name, t.CategoryID, siteID); err != nil { return fmt.Errorf("update tag %d: %w", t.ID, err) } return nil } -func (d *DB) DeleteTag(ctx context.Context, id int64) error { +func (d *DB) DeleteTag(ctx context.Context, siteID, id int64) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin deleting tag %d: %w", id, err) @@ -183,7 +183,7 @@ func (d *DB) DeleteTag(ctx context.Context, id int64) error { if _, err := tx.Exec(ctx, qDetachTag, id); err != nil { return fmt.Errorf("detach tag %d: %w", id, err) } - if _, err := tx.Exec(ctx, qDeleteTagRow, id); err != nil { + if _, err := tx.Exec(ctx, qDeleteTagRow, id, siteID); err != nil { return fmt.Errorf("delete tag %d: %w", id, err) } return tx.Commit(ctx) diff --git a/internal/db/theme_write.go b/internal/db/theme_write.go index ac77ff1b..5eda78f5 100644 --- a/internal/db/theme_write.go +++ b/internal/db/theme_write.go @@ -43,11 +43,11 @@ func (d *DB) Themes(ctx context.Context, siteID int64) ([]ThemeRow, error) { var qThemeRow = register("ThemeRow", ` SELECT id, name, slug, mode, css, external_url, updated_at -FROM web_theme WHERE id = $1`) +FROM web_theme WHERE id = $1 AND site_id = $2`) -func (d *DB) Theme(ctx context.Context, id int64) (ThemeRow, error) { +func (d *DB) Theme(ctx context.Context, siteID, id int64) (ThemeRow, error) { var t ThemeRow - err := d.pool.QueryRow(ctx, qThemeRow, id). + err := d.pool.QueryRow(ctx, qThemeRow, id, siteID). Scan(&t.ID, &t.Name, &t.Slug, &t.Mode, &t.CSS, &t.ExternalURL, &t.UpdatedAt) if errors.Is(err, pgx.ErrNoRows) { return ThemeRow{}, ErrNotFound @@ -64,7 +64,7 @@ VALUES ($1, $2, $3, $4, $5, $6, $7) RETURNING id`) var qUpdateTheme = register("UpdateTheme", ` UPDATE web_theme SET name = $2, slug = $3, mode = $4, css = $5, external_url = $6, updated_at = $7 -WHERE id = $1`) +WHERE id = $1 AND site_id = $8`) func (d *DB) SaveTheme(ctx context.Context, siteID int64, t ThemeRow) (int64, error) { at := time.Now() @@ -76,19 +76,19 @@ func (d *DB) SaveTheme(ctx context.Context, siteID int64, t ThemeRow) (int64, er } return id, nil } - if _, err := d.pool.Exec(ctx, qUpdateTheme, t.ID, t.Name, t.Slug, t.Mode, t.CSS, t.ExternalURL, at); err != nil { + if _, err := d.pool.Exec(ctx, qUpdateTheme, t.ID, t.Name, t.Slug, t.Mode, t.CSS, t.ExternalURL, at, siteID); err != nil { return 0, fmt.Errorf("update theme %d: %w", t.ID, err) } return t.ID, nil } -var qDeleteTheme = register("DeleteTheme", `DELETE FROM web_theme WHERE id = $1`) +var qDeleteTheme = register("DeleteTheme", `DELETE FROM web_theme WHERE id = $1 AND site_id = $2`) var qDetachTheme = register("DetachTheme", `UPDATE web_site SET active_theme_id = CASE WHEN active_theme_id = $1 THEN NULL ELSE active_theme_id END, system_theme_id = CASE WHEN system_theme_id = $1 THEN NULL ELSE system_theme_id END`) -func (d *DB) DeleteTheme(ctx context.Context, id int64) error { +func (d *DB) DeleteTheme(ctx context.Context, siteID, id int64) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin deleting theme %d: %w", id, err) @@ -98,7 +98,7 @@ func (d *DB) DeleteTheme(ctx context.Context, id int64) error { if _, err := tx.Exec(ctx, qDetachTheme, id); err != nil { return fmt.Errorf("detach theme %d: %w", id, err) } - if _, err := tx.Exec(ctx, qDeleteTheme, id); err != nil { + if _, err := tx.Exec(ctx, qDeleteTheme, id, siteID); err != nil { return fmt.Errorf("delete theme %d: %w", id, err) } return tx.Commit(ctx) diff --git a/internal/db/ticket_admin.go b/internal/db/ticket_admin.go index 03758683..7bb91fb1 100644 --- a/internal/db/ticket_admin.go +++ b/internal/db/ticket_admin.go @@ -74,11 +74,11 @@ func (d *DB) AdminTickets(ctx context.Context, siteID int64, kind, status string return out, total, rows.Err() } -var qAdminTicket = register("AdminTicket", `SELECT `+ticketColumns+ticketJoins+` WHERE t.id = $1`) +var qAdminTicket = register("AdminTicket", `SELECT `+ticketColumns+ticketJoins+` WHERE t.id = $1 AND t.site_id = $2`) -func (d *DB) AdminTicket(ctx context.Context, id int64) (TicketRow, error) { +func (d *DB) AdminTicket(ctx context.Context, siteID, id int64) (TicketRow, error) { var t TicketRow - err := scanTicket(d.pool.QueryRow(ctx, qAdminTicket, id), &t) + err := scanTicket(d.pool.QueryRow(ctx, qAdminTicket, id, siteID), &t) if errors.Is(err, pgx.ErrNoRows) { return TicketRow{}, ErrNotFound } @@ -90,7 +90,7 @@ func (d *DB) AdminTicket(ctx context.Context, id int64) (TicketRow, error) { var qReviewTicket = register("ReviewTicket", ` UPDATE web_userticket SET status=$2, admin_notes=$3, reviewed_at=$4, reviewed_by_id=$5, granted_role_id=$6 -WHERE id=$1`) +WHERE id=$1 AND site_id=$7`) var qGrantTicketRole = register("GrantTicketRole", ` INSERT INTO web_user_roles (user_id, role_id) @@ -175,10 +175,10 @@ func (d *DB) AdminInvites(ctx context.Context, siteID int64, limit, offset int) return out, total, rows.Err() } -var qDeleteInvite = register("DeleteInvite", `DELETE FROM web_invitelink WHERE id = $1 AND activated_at IS NULL`) +var qDeleteInvite = register("DeleteInvite", `DELETE FROM web_invitelink WHERE id = $1 AND activated_at IS NULL AND site_id = $2`) -func (d *DB) DeleteInvite(ctx context.Context, id int64) error { - if _, err := d.pool.Exec(ctx, qDeleteInvite, id); err != nil { +func (d *DB) DeleteInvite(ctx context.Context, siteID, id int64) error { + if _, err := d.pool.Exec(ctx, qDeleteInvite, id, siteID); err != nil { return fmt.Errorf("delete invite link %d: %w", id, err) } return nil diff --git a/internal/pageconfig/user.go b/internal/pageconfig/user.go index a0489a9d..0ebdd4f3 100644 --- a/internal/pageconfig/user.go +++ b/internal/pageconfig/user.go @@ -80,6 +80,8 @@ func SignedInUserJSON(u *db.User, userRoles []roles.Role, showAvatar, editor boo return out } +// The superuser flag is deliberately not per-site. It belongs to whoever runs +// the server, and every other way into the admin comes from a role, which is. func IsStaff(u *db.User, userRoles []roles.Role) bool { if u.IsSuperuser { return true diff --git a/internal/webapi/admin.go b/internal/webapi/admin.go index 124abde0..4e71fad6 100644 --- a/internal/webapi/admin.go +++ b/internal/webapi/admin.go @@ -89,7 +89,7 @@ func (h *Admin) conversation(w http.ResponseWriter, r *http.Request, loc *i18n.L writeJSON(w, http.StatusNotFound, field("error", loc.T("api-report-not-found"))) return } - report, err := h.deps.DB.Report(ctx, id) + report, err := h.deps.DB.Report(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { writeJSON(w, http.StatusNotFound, field("error", loc.T("api-report-not-found"))) return From d02897cb2be6fa81a541a681cf0ce2ef1259e9a1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 13:34:11 +0900 Subject: [PATCH 351/428] give each site its own theme directory --- cmd/pwikit/main.go | 2 +- internal/admin/theme.go | 6 +++--- internal/site/theme.go | 9 ++++++++- internal/site/theme_test.go | 27 ++++++++++++++++++++++++--- 4 files changed, 36 insertions(+), 8 deletions(-) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 9ec9bb04..fefcc6bb 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -242,7 +242,7 @@ func serve(args []string) error { "/-/": notFound, "/pw-api/": notFound, static.Prefix: static.New(assets, notFound), - site.ThemePrefix: respheader.VaryCookie(site.NewThemeFiles(p.Files())), + site.ThemePrefix: respheader.VaryCookie(site.NewHostRules(conn, listenPort(*listen), site.NewThemeFiles(p.Files()), notFound)), media.Prefix: respheader.VaryCookie(mediaHandler), media.ResizedPrefix: respheader.VaryCookie(resizedHandler), localitem.CodePrefix: codeHandler, diff --git a/internal/admin/theme.go b/internal/admin/theme.go index 82073e9d..dd37078f 100644 --- a/internal/admin/theme.go +++ b/internal/admin/theme.go @@ -121,7 +121,7 @@ func (h *Handler) saveThemeForm(w http.ResponseWriter, r *http.Request, loc *i18 return err } row.ID = id - if err := h.writeThemeCSS(row); err != nil { + if err := h.writeThemeCSS(site.FromContext(r.Context()).Slug, row); err != nil { return err } h.noteID(r, did, themeSlug, row.ID, row.Name) @@ -143,11 +143,11 @@ func (h *Handler) checkTheme(loc *i18n.Localizer, row db.ThemeRow) string { return "" } -func (h *Handler) writeThemeCSS(row db.ThemeRow) error { +func (h *Handler) writeThemeCSS(siteSlug string, row db.ThemeRow) error { if row.Mode != db.ThemeInline || row.Slug == "" { return nil } - dir := filepath.Join(h.deps.Files, "theme") + dir := filepath.Join(h.deps.Files, "theme", siteSlug) if err := os.MkdirAll(dir, 0o755); err != nil { return err } diff --git a/internal/site/theme.go b/internal/site/theme.go index 0744b85c..452dd650 100644 --- a/internal/site/theme.go +++ b/internal/site/theme.go @@ -76,7 +76,14 @@ func (h *ThemeFiles) ServeHTTP(w http.ResponseWriter, r *http.Request) { return } - full, err := paths.Resolve(h.dir, slug+themeSuffix) + current := FromContext(r.Context()) + if current == nil { + themeMissing(w) + return + } + // One slug can name a theme on every site, so the site owns a directory + // rather than the themes sharing one. + full, err := paths.Resolve(h.dir, current.Slug+"/"+slug+themeSuffix) if err != nil { themeMissing(w) return diff --git a/internal/site/theme_test.go b/internal/site/theme_test.go index 7f134555..758d574e 100644 --- a/internal/site/theme_test.go +++ b/internal/site/theme_test.go @@ -43,17 +43,19 @@ func TestThemeURLOfExternalThemeWithoutURL(t *testing.T) { func themeRequest(t *testing.T, dir, target string) *httptest.ResponseRecorder { t.Helper() rec := httptest.NewRecorder() - NewThemeFiles(dir).ServeHTTP(rec, httptest.NewRequest(http.MethodGet, target, nil)) + req := httptest.NewRequest(http.MethodGet, target, nil) + req = req.WithContext(WithSite(req.Context(), &db.Site{Slug: "wikit"})) + NewThemeFiles(dir).ServeHTTP(rec, req) return rec } func themeDir(t *testing.T) string { t.Helper() root := t.TempDir() - if err := os.MkdirAll(filepath.Join(root, "theme"), 0o755); err != nil { + if err := os.MkdirAll(filepath.Join(root, "theme", "wikit"), 0o755); err != nil { t.Fatalf("MkdirAll() err = %v, want nil", err) } - if err := os.WriteFile(filepath.Join(root, "theme", "night.css"), []byte("body{color:#fff}"), 0o644); err != nil { + if err := os.WriteFile(filepath.Join(root, "theme", "wikit", "night.css"), []byte("body{color:#fff}"), 0o644); err != nil { t.Fatalf("WriteFile() err = %v, want nil", err) } return root @@ -106,3 +108,22 @@ func TestThemeSlugDropsWhatItCannotName(t *testing.T) { } } } + +func TestThemeFilesKeepsSitesApart(t *testing.T) { + root := themeDir(t) + if err := os.MkdirAll(filepath.Join(root, "theme", "other"), 0o755); err != nil { + t.Fatalf("MkdirAll() err = %v, want nil", err) + } + if err := os.WriteFile(filepath.Join(root, "theme", "other", "night.css"), []byte("body{color:#000}"), 0o644); err != nil { + t.Fatalf("WriteFile() err = %v, want nil", err) + } + + rec := httptest.NewRecorder() + req := httptest.NewRequest(http.MethodGet, "/-/theme/night.css", nil) + req = req.WithContext(WithSite(req.Context(), &db.Site{Slug: "other"})) + NewThemeFiles(root).ServeHTTP(rec, req) + + if got := rec.Body.String(); got != "body{color:#000}" { + t.Errorf("GET night.css on other = %q, want %q", got, "body{color:#000}") + } +} From f4f545d6feff9f3c2633a49f927d268ac2ce3c2d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 13:41:38 +0900 Subject: [PATCH 352/428] check the site owns an id that came from a url --- internal/account/signup.go | 4 ++-- internal/account/tickets.go | 2 +- internal/admin/pages.go | 6 ++--- internal/admin/ticket.go | 2 +- internal/admin/useractions.go | 2 +- internal/db/account_write.go | 7 +++--- internal/db/article_meta.go | 6 ++--- internal/db/article_write_test.go | 12 +++++----- internal/db/site_scope_pending_test.go | 32 -------------------------- internal/db/ticket_admin.go | 10 ++++---- internal/repo/modules.go | 2 +- internal/repo/perms.go | 2 +- internal/repo/vars.go | 2 +- internal/webapi/create.go | 6 ++--- internal/webapi/files.go | 2 +- internal/webapi/invite.go | 2 +- internal/webapi/revert_apply.go | 2 +- internal/webapi/update.go | 6 ++--- 18 files changed, 39 insertions(+), 68 deletions(-) diff --git a/internal/account/signup.go b/internal/account/signup.go index aac52fb7..743666df 100644 --- a/internal/account/signup.go +++ b/internal/account/signup.go @@ -262,7 +262,7 @@ func (h *SignupHandler) claim(w http.ResponseWriter, r *http.Request, loc *i18n. func (h *SignupHandler) grant(ctx context.Context, configured *int64, userID int64) error { if configured != nil { - return h.deps.DB.GrantRole(ctx, userID, *configured) + return h.deps.DB.GrantRole(ctx, siteID(ctx), userID, *configured) } id, err := h.deps.DB.RoleIDBySlug(ctx, siteID(ctx), defaultRoleRef) if errors.Is(err, db.ErrNotFound) { @@ -271,7 +271,7 @@ func (h *SignupHandler) grant(ctx context.Context, configured *int64, userID int if err != nil { return err } - return h.deps.DB.GrantRole(ctx, userID, id) + return h.deps.DB.GrantRole(ctx, siteID(ctx), userID, id) } const fallbackAttempts = 1000 diff --git a/internal/account/tickets.go b/internal/account/tickets.go index d7d27d76..774212e6 100644 --- a/internal/account/tickets.go +++ b/internal/account/tickets.go @@ -98,7 +98,7 @@ func (h *TicketHandler) membership(w http.ResponseWriter, r *http.Request, curre back(w, r, "membership", "failed") return } - if err := h.deps.DB.GrantRole(ctx, user.ID, *current.MembershipPasswordRoleID); err != nil { + if err := h.deps.DB.GrantRole(ctx, siteID(ctx), user.ID, *current.MembershipPasswordRoleID); err != nil { h.deps.logger().Error("grant membership", "user", user.ID, "err", err) back(w, r, "membership", "failed") return diff --git a/internal/admin/pages.go b/internal/admin/pages.go index 3c0b4315..b426b0a4 100644 --- a/internal/admin/pages.go +++ b/internal/admin/pages.go @@ -79,7 +79,7 @@ func (h *Handler) pageList(w http.ResponseWriter, r *http.Request, loc *i18n.Loc func (h *Handler) pageForm(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, id int64, problem string) error { ctx := r.Context() - article, err := h.deps.DB.ArticleByID(ctx, id) + article, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -117,7 +117,7 @@ func (h *Handler) savePage(w http.ResponseWriter, r *http.Request, loc *i18n.Loc return nil } ctx := r.Context() - article, err := h.deps.DB.ArticleByID(ctx, id) + article, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { notFound(w) return nil @@ -176,7 +176,7 @@ func (h *Handler) pageBatch(w http.ResponseWriter, r *http.Request, loc *i18n.Lo if err != nil { continue } - article, err := h.deps.DB.ArticleByID(ctx, id) + article, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), id) if errors.Is(err, db.ErrNotFound) { continue } diff --git a/internal/admin/ticket.go b/internal/admin/ticket.go index e774c865..8c8fc83f 100644 --- a/internal/admin/ticket.go +++ b/internal/admin/ticket.go @@ -78,7 +78,7 @@ func (h *Handler) ticketScreen(w http.ResponseWriter, r *http.Request, loc *i18n http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden) return nil } - err = h.deps.DB.ReviewTicket(ctx, id, status, r.PostFormValue("admin_notes"), mine.ID, role, time.Now()) + err = h.deps.DB.ReviewTicket(ctx, siteID(ctx), id, status, r.PostFormValue("admin_notes"), mine.ID, role, time.Now()) if err != nil { return err } diff --git a/internal/admin/useractions.go b/internal/admin/useractions.go index 027ac50b..ed22eda7 100644 --- a/internal/admin/useractions.go +++ b/internal/admin/useractions.go @@ -303,7 +303,7 @@ func (h *Handler) grantPicked(r *http.Request, userID int64) error { if err != nil { continue } - if err := h.deps.DB.GrantRole(r.Context(), userID, role); err != nil { + if err := h.deps.DB.GrantRole(r.Context(), siteID(r.Context()), userID, role); err != nil { return err } } diff --git a/internal/db/account_write.go b/internal/db/account_write.go index 544f4764..0c5cafe7 100644 --- a/internal/db/account_write.go +++ b/internal/db/account_write.go @@ -94,11 +94,12 @@ func (d *DB) ActivateUser(ctx context.Context, id int64, username string, displa var qGrantRole = register("GrantRole", ` INSERT INTO web_user_roles (user_id, role_id) SELECT $1, $2 -WHERE NOT EXISTS ( +WHERE EXISTS (SELECT 1 FROM web_role WHERE id = $2 AND site_id = $3) + AND NOT EXISTS ( SELECT 1 FROM web_user_roles WHERE user_id = $1 AND role_id = $2)`) -func (d *DB) GrantRole(ctx context.Context, userID, roleID int64) error { - if _, err := d.pool.Exec(ctx, qGrantRole, userID, roleID); err != nil { +func (d *DB) GrantRole(ctx context.Context, siteID, userID, roleID int64) error { + if _, err := d.pool.Exec(ctx, qGrantRole, userID, roleID, siteID); err != nil { return fmt.Errorf("grant role %d to user %d: %w", roleID, userID, err) } return nil diff --git a/internal/db/article_meta.go b/internal/db/article_meta.go index 9ac49a02..1d4740a6 100644 --- a/internal/db/article_meta.go +++ b/internal/db/article_meta.go @@ -11,11 +11,11 @@ import ( var qArticleByID = register("ArticleByID", ` SELECT `+articleColumns+` FROM web_article -WHERE id = $1`) +WHERE id = $1 AND site_id = $2`) -func (d *DB) ArticleByID(ctx context.Context, id int64) (*Article, error) { +func (d *DB) ArticleByID(ctx context.Context, siteID, id int64) (*Article, error) { var a Article - err := d.pool.QueryRow(ctx, qArticleByID, id).Scan( + err := d.pool.QueryRow(ctx, qArticleByID, id, siteID).Scan( &a.ID, &a.Category, &a.Name, &a.Title, &a.ParentID, &a.Locked, &a.CreatedAt, &a.UpdatedAt, &a.MediaName) if errors.Is(err, pgx.ErrNoRows) { diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go index 1d746438..d2ee158f 100644 --- a/internal/db/article_write_test.go +++ b/internal/db/article_write_test.go @@ -349,7 +349,7 @@ func TestCreateArticleWithoutAnAuthor(t *testing.T) { } dropArticle(t, d, id) - article, err := d.ArticleByID(ctx, id) + article, err := d.ArticleByID(ctx, seedSiteID(t, d), id) if err != nil { t.Fatalf("ArticleByID() err = %v, want nil", err) } @@ -418,7 +418,7 @@ func TestSetArticleParentRecordsTheMove(t *testing.T) { t.Errorf("SetArticleParent().RevNumber = %d, want 0", rev.RevNumber) } - article, err := d.ArticleByID(ctx, child) + article, err := d.ArticleByID(ctx, seedSiteID(t, d), child) if err != nil { t.Fatalf("ArticleByID() err = %v, want nil", err) } @@ -495,7 +495,7 @@ func TestUpdateArticleTitleRecordsWhatItWas(t *testing.T) { t.Errorf("UpdateArticleTitle().RevNumber = %d, want 0", rev.RevNumber) } - article, err := d.ArticleByID(ctx, id) + article, err := d.ArticleByID(ctx, seedSiteID(t, d), id) if err != nil { t.Fatalf("ArticleByID() err = %v, want nil", err) } @@ -539,7 +539,7 @@ func TestSetArticleLockLeavesNoRevision(t *testing.T) { if err := d.SetArticleLock(ctx, id, true); err != nil { t.Fatalf("SetArticleLock() err = %v, want nil", err) } - article, err := d.ArticleByID(ctx, id) + article, err := d.ArticleByID(ctx, seedSiteID(t, d), id) if err != nil { t.Fatalf("ArticleByID() err = %v, want nil", err) } @@ -722,7 +722,7 @@ func TestRenameArticleTakesItsLinksAlong(t *testing.T) { t.Errorf("RenameArticle().RevNumber = %d, want 0", rev.RevNumber) } - article, err := d.ArticleByID(ctx, id) + article, err := d.ArticleByID(ctx, seedSiteID(t, d), id) if err != nil { t.Fatalf("ArticleByID() err = %v, want nil", err) } @@ -859,7 +859,7 @@ func TestDeleteArticleTakesEverythingThatPointsAtIt(t *testing.T) { t.Errorf("links of %q after deleting = %v, want none", name, got) } - orphan, err := d.ArticleByID(ctx, child) + orphan, err := d.ArticleByID(ctx, seedSiteID(t, d), child) if err != nil { t.Fatalf("ArticleByID(child) err = %v, want nil", err) } diff --git a/internal/db/site_scope_pending_test.go b/internal/db/site_scope_pending_test.go index 098fd1b3..7ae5e90b 100644 --- a/internal/db/site_scope_pending_test.go +++ b/internal/db/site_scope_pending_test.go @@ -4,59 +4,28 @@ var siteScopePending = []string{} var siteScopeByKey = []string{ "ActivateInviteLink", - "AdminCategory", "AdminCategoryOverrides", - "AdminReport", - "AdminRole", - "AdminTag", - "AdminTagCategory", - "AdminTicket", "ArticleChildren", "Breadcrumbs", "ClearRoleTickets", "DeleteArticle.13", "DeleteArticle.14", - "DeleteCategory", - "DeleteInvite", - "DeleteRole", - "DeleteRoleCategory", - "DeleteTagCat", - "DeleteTagRow", - "DeleteTheme", "DetachRoleCategory", "DetachTagCat", "FindTag", - "GrantTicketRole", "KnownTags", "MoveArticleParent", "ReadArticleTitle", "RenameArticle", - "Report", - "ReviewReport", - "ReviewTicket", "SetArticleLock", "SetArticleParent", "SetArticleTitle", "ThemeByID", - "ThemeRow", "TouchArticle", "TouchForumThread", "UpdateArticleTitle", - "UpdateCategory", - "UpdateRole", - "UpdateRoleCategory", - "UpdateTag", - "UpdateTagCat", - "UpdateTheme", "ForumCategory", - "AdminForumCategory", - "InsertForumCategory", - "UpdateForumCategory", - "DeleteForumCategory", "ForumSection", - "AdminForumSection", - "UpdateForumSection", - "DeleteForumSection", "ForumThread", "ForumThreadsByStart", "ForumThreadsByReply", @@ -67,7 +36,6 @@ var siteScopeByKey = []string{ "RecentPostCount", "UserPosts", "UserPostCount", - "ArticleByID", "ChildCount", "CommentCount", "ArticleLastComment", diff --git a/internal/db/ticket_admin.go b/internal/db/ticket_admin.go index 7bb91fb1..308613ba 100644 --- a/internal/db/ticket_admin.go +++ b/internal/db/ticket_admin.go @@ -94,10 +94,12 @@ WHERE id=$1 AND site_id=$7`) var qGrantTicketRole = register("GrantTicketRole", ` INSERT INTO web_user_roles (user_id, role_id) -SELECT t.author_id, $2 FROM web_userticket t WHERE t.id = $1 AND t.author_id IS NOT NULL +SELECT t.author_id, $2 FROM web_userticket t +WHERE t.id = $1 AND t.author_id IS NOT NULL + AND EXISTS (SELECT 1 FROM web_role WHERE id = $2 AND site_id = $3) ON CONFLICT DO NOTHING`) -func (d *DB) ReviewTicket(ctx context.Context, id int64, status, notes string, by int64, role *int64, at time.Time) error { +func (d *DB) ReviewTicket(ctx context.Context, siteID, id int64, status, notes string, by int64, role *int64, at time.Time) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin reviewing ticket %d: %w", id, err) @@ -109,11 +111,11 @@ func (d *DB) ReviewTicket(ctx context.Context, id int64, status, notes string, b if status != TicketPending { reviewedAt, reviewer = &at, &by } - if _, err := tx.Exec(ctx, qReviewTicket, id, status, notes, reviewedAt, reviewer, role); err != nil { + if _, err := tx.Exec(ctx, qReviewTicket, id, status, notes, reviewedAt, reviewer, role, siteID); err != nil { return fmt.Errorf("review ticket %d: %w", id, err) } if status == TicketApproved && role != nil { - if _, err := tx.Exec(ctx, qGrantTicketRole, id, *role); err != nil { + if _, err := tx.Exec(ctx, qGrantTicketRole, id, *role, siteID); err != nil { return fmt.Errorf("grant the role of ticket %d: %w", id, err) } } diff --git a/internal/repo/modules.go b/internal/repo/modules.go index b08bb203..efa5b024 100644 --- a/internal/repo/modules.go +++ b/internal/repo/modules.go @@ -123,7 +123,7 @@ func (m moduleData) CountArticles(f db.ListFilter, offset int, limit *int) (int, } func (m moduleData) ArticleByID(id int64) (*db.Article, error) { - return m.repo.db.ArticleByID(m.repo.ctx, id) + return m.repo.db.ArticleByID(m.repo.ctx, m.repo.siteID(), id) } func (m moduleData) ArticleAuthors(articleID int64) ([]db.User, error) { diff --git a/internal/repo/perms.go b/internal/repo/perms.go index 8997c2c1..0e02eebf 100644 --- a/internal/repo/perms.go +++ b/internal/repo/perms.go @@ -126,7 +126,7 @@ func (p *Perms) ForumSection(s *db.ForumSection) *perms.Object { func (p *Perms) ForumThread(t *db.ForumThread, u *db.User) (*perms.Object, error) { object := &perms.Object{Kind: perms.KindForumThread, Locked: t.IsLocked} if t.ArticleID != nil { - article, err := p.db.ArticleByID(p.ctx, *t.ArticleID) + article, err := p.db.ArticleByID(p.ctx, p.siteID(), *t.ArticleID) if err != nil { return nil, err } diff --git a/internal/repo/vars.go b/internal/repo/vars.go index f8423a21..a135b0a9 100644 --- a/internal/repo/vars.go +++ b/internal/repo/vars.go @@ -69,7 +69,7 @@ func (s *VarSource) HasVoted(articleID int64, userID *int64) (bool, error) { } func (s *VarSource) ArticleByID(id int64) (*db.Article, error) { - return s.db.ArticleByID(s.ctx, id) + return s.db.ArticleByID(s.ctx, s.siteID(), id) } func (s *VarSource) ChildCount(articleID int64) (int, error) { diff --git a/internal/webapi/create.go b/internal/webapi/create.go index 062e8f83..a74bd08f 100644 --- a/internal/webapi/create.go +++ b/internal/webapi/create.go @@ -156,7 +156,7 @@ func (h *Articles) writeNewArticle(r *http.Request, current *db.Site, name strin if err != nil { return err } - fresh, err := h.deps.DB.ArticleByID(ctx, id) + fresh, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), id) if err != nil { return err } @@ -181,7 +181,7 @@ func (h *Articles) writeNewArticle(r *http.Request, current *db.Site, name strin // The pass runs as nobody, so a page's links are the same set whoever saved it. func (h *Articles) refreshLinks(r *http.Request, current *db.Site, id int64, source string) error { ctx := r.Context() - article, err := h.deps.DB.ArticleByID(ctx, id) + article, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), id) if err != nil { return err } @@ -232,7 +232,7 @@ func (h *Articles) setParent(r *http.Request, current *db.Site, id int64, if err != nil { return err } - child, err := h.deps.DB.ArticleByID(ctx, id) + child, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), id) if err != nil { return err } diff --git a/internal/webapi/files.go b/internal/webapi/files.go index bf102598..02c4b928 100644 --- a/internal/webapi/files.go +++ b/internal/webapi/files.go @@ -105,7 +105,7 @@ func (h *Articles) fileAndArticle(r *http.Request, id int64) (*db.FileRow, *db.A if err != nil { return nil, nil, err } - article, err := h.deps.DB.ArticleByID(ctx, file.ArticleID) + article, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), file.ArticleID) if errors.Is(err, db.ErrNotFound) { return nil, nil, errNotFound } diff --git a/internal/webapi/invite.go b/internal/webapi/invite.go index ff245bdc..c1ab0fed 100644 --- a/internal/webapi/invite.go +++ b/internal/webapi/invite.go @@ -101,7 +101,7 @@ func (h *Users) mintInvite(r *http.Request, current *db.Site, by *db.User, email return "", err } for _, role := range roles { - if err := h.deps.DB.GrantRole(ctx, id, role); err != nil { + if err := h.deps.DB.GrantRole(ctx, siteID(ctx), id, role); err != nil { return "", err } } diff --git a/internal/webapi/revert_apply.go b/internal/webapi/revert_apply.go index 8a28a0e8..1ac37cc9 100644 --- a/internal/webapi/revert_apply.go +++ b/internal/webapi/revert_apply.go @@ -390,7 +390,7 @@ func (rev *reverter) authors() error { func (rev *reverter) reindex() error { ctx := rev.req.Context() - article, err := rev.handler.deps.DB.ArticleByID(ctx, rev.article.ID) + article, err := rev.handler.deps.DB.ArticleByID(ctx, siteID(ctx), rev.article.ID) if err != nil { return err } diff --git a/internal/webapi/update.go b/internal/webapi/update.go index 9d52bdfb..1d3dca93 100644 --- a/internal/webapi/update.go +++ b/internal/webapi/update.go @@ -368,7 +368,7 @@ func (h *Articles) parentName(ctx context.Context, id *int64) (string, error) { if id == nil { return "", nil } - parent, err := h.deps.DB.ArticleByID(ctx, *id) + parent, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), *id) if errors.Is(err, db.ErrNotFound) { return "", nil } @@ -421,7 +421,7 @@ func (e *editor) announce(rev db.Revision) error { func (e *editor) answer() (string, int, error) { ctx := e.req.Context() - article, err := e.handler.deps.DB.ArticleByID(ctx, e.article.ID) + article, err := e.handler.deps.DB.ArticleByID(ctx, siteID(ctx), e.article.ID) if err != nil { return "", 0, err } @@ -516,7 +516,7 @@ func (h *Articles) articleJSON(r *http.Request, article *db.Article, source *str parent := "" if article.ParentID != nil { - if found, err := h.deps.DB.ArticleByID(ctx, *article.ParentID); err == nil { + if found, err := h.deps.DB.ArticleByID(ctx, siteID(ctx), *article.ParentID); err == nil { parent = found.FullName() } else if !errors.Is(err, db.ErrNotFound) { return "", err From 6073e8b3e3e8d97f022731e826306537ba01f225 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 14:15:19 +0900 Subject: [PATCH 353/428] drop only this site's links when a page goes --- internal/db/article_delete.go | 4 ++-- internal/webapi/delete.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/db/article_delete.go b/internal/db/article_delete.go index 16207a2e..eee11065 100644 --- a/internal/db/article_delete.go +++ b/internal/db/article_delete.go @@ -35,14 +35,14 @@ var qDeleteArticle = registerAll("DeleteArticle", articleChildren) // The files on disk are left to the caller, which is the only layer that knows // where the state directory is. -func (d *DB) DeleteArticle(ctx context.Context, articleID int64, fullName string) error { +func (d *DB) DeleteArticle(ctx context.Context, siteID, articleID int64, fullName string) error { tx, err := d.pool.Begin(ctx) if err != nil { return fmt.Errorf("begin delete of %d: %w", articleID, err) } defer tx.Rollback(ctx) - if _, err := tx.Exec(ctx, qDropLinksFrom, fullName); err != nil { + if _, err := tx.Exec(ctx, qDropLinksFrom, fullName, siteID); err != nil { return fmt.Errorf("drop links of %q: %w", fullName, err) } for _, sql := range qDeleteArticle { diff --git a/internal/webapi/delete.go b/internal/webapi/delete.go index 4a53b076..bcec651c 100644 --- a/internal/webapi/delete.go +++ b/internal/webapi/delete.go @@ -43,7 +43,7 @@ func (h *Articles) remove(r *http.Request, loc *i18n.Localizer, name string) (st return "", 0, errForbidden } - if err := h.deps.DB.DeleteArticle(ctx, article.ID, article.FullName()); err != nil { + if err := h.deps.DB.DeleteArticle(ctx, siteID(ctx), article.ID, article.FullName()); err != nil { return "", 0, err } if err := h.seen(r, user); err != nil { From e4508efb17ad7c27636f09dc5f5ecf3d0e3ec258 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 14:15:19 +0900 Subject: [PATCH 354/428] test that a cross-site reference is filed against that site --- internal/db/article_write_test.go | 44 +++++++++++++++-- internal/db/tag_write_test.go | 4 +- internal/pagerender/link_test.go | 81 +++++++++++++++++++++++++++++++ 3 files changed, 123 insertions(+), 6 deletions(-) create mode 100644 internal/pagerender/link_test.go diff --git a/internal/db/article_write_test.go b/internal/db/article_write_test.go index d2ee158f..ccb872ee 100644 --- a/internal/db/article_write_test.go +++ b/internal/db/article_write_test.go @@ -28,9 +28,9 @@ func scratchArticle(t *testing.T, d *DB) int64 { name := "probe-write-" + time.Now().Format("20060102150405.000000") var id int64 err := d.pool.QueryRow(ctx, ` -INSERT INTO web_article (category, name, title, locked, created_at, updated_at, media_name) -VALUES ('_default', $1, 'Probe', false, now(), now(), $2) -RETURNING id`, name, name).Scan(&id) +INSERT INTO web_article (site_id, category, name, title, locked, created_at, updated_at, media_name) +VALUES ($3, '_default', $1, 'Probe', false, now(), now(), $2) +RETURNING id`, name, name, seedSiteID(t, d)).Scan(&id) if err != nil { t.Fatalf("insert scratch article err = %v, want nil", err) } @@ -833,7 +833,7 @@ func TestDeleteArticleTakesEverythingThatPointsAtIt(t *testing.T) { t.Fatalf("SetArticleParent() err = %v, want nil", err) } - if err := d.DeleteArticle(ctx, id, name); err != nil { + if err := d.DeleteArticle(ctx, seedSiteID(t, d), id, name); err != nil { t.Fatalf("DeleteArticle() err = %v, want nil", err) } @@ -867,3 +867,39 @@ func TestDeleteArticleTakesEverythingThatPointsAtIt(t *testing.T) { t.Errorf("child ParentID after deleting the parent = %v, want nil", orphan.ParentID) } } + +func TestArticleLinksAreReadBackPerSite(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + here := seedSiteID(t, d) + from := "probe-links-" + time.Now().Format("20060102150405.000000") + to := from + "-target" + + if err := d.ReplaceArticleLinks(ctx, here, from, []ArticleLink{ + {To: to, Kind: LinkInclude, ToSiteID: &here}, + }); err != nil { + t.Fatalf("ReplaceArticleLinks() err = %v, want nil", err) + } + t.Cleanup(func() { + d.pool.Exec(context.Background(), `DELETE FROM web_externallink WHERE link_from = $1`, from) + }) + + found, err := d.LinksTo(ctx, here, to) + if err != nil { + t.Fatalf("LinksTo(here) err = %v, want nil", err) + } + if len(found) != 1 { + t.Fatalf("len(LinksTo(here, %q)) = %d, want 1", to, len(found)) + } + if found[0].From != from { + t.Errorf("LinksTo(here, %q)[0].From = %q, want %q", to, found[0].From, from) + } + + elsewhere, err := d.LinksTo(ctx, here+1000, to) + if err != nil { + t.Fatalf("LinksTo(other) err = %v, want nil", err) + } + if len(elsewhere) != 0 { + t.Errorf("len(LinksTo(other site, %q)) = %d, want 0", to, len(elsewhere)) + } +} diff --git a/internal/db/tag_write_test.go b/internal/db/tag_write_test.go index 41b13bc4..e2598ae5 100644 --- a/internal/db/tag_write_test.go +++ b/internal/db/tag_write_test.go @@ -45,10 +45,10 @@ func scratchTagged(t *testing.T, d *DB) int64 { if _, err := d.pool.Exec(clean, `DELETE FROM web_article_tags WHERE article_id = $1`, id); err != nil { t.Errorf("clean up tags err = %v, want nil", err) } - if _, err := d.pool.Exec(clean, qDropOrphanTags); err != nil { + if _, err := d.pool.Exec(clean, qDropOrphanTags, seedSiteID(t, d)); err != nil { t.Errorf("sweep tags err = %v, want nil", err) } - if _, err := d.pool.Exec(clean, qDropOrphanTagCategories); err != nil { + if _, err := d.pool.Exec(clean, qDropOrphanTagCategories, seedSiteID(t, d)); err != nil { t.Errorf("sweep tag categories err = %v, want nil", err) } }) diff --git a/internal/pagerender/link_test.go b/internal/pagerender/link_test.go new file mode 100644 index 00000000..fb7cd1b9 --- /dev/null +++ b/internal/pagerender/link_test.go @@ -0,0 +1,81 @@ +package pagerender + +import ( + "context" + "os" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func linkEnv(t *testing.T) (*Env, *db.Site) { + t.Helper() + dsn := os.Getenv(db.EnvDSN) + if dsn == "" { + t.Skipf("%s not set, skipping the database test", db.EnvDSN) + } + ctx := context.Background() + conn, err := db.Open(ctx, dsn) + if err != nil { + t.Fatalf("Open() err = %v, want nil", err) + } + t.Cleanup(conn.Close) + + slugs, err := conn.SiteSlugs(ctx) + if err != nil { + t.Fatalf("SiteSlugs() err = %v, want nil", err) + } + if len(slugs) == 0 { + t.Skip("the test database holds no site") + } + current, err := conn.SiteBySlug(ctx, slugs[0]) + if err != nil { + t.Fatalf("SiteBySlug(%q) err = %v, want nil", slugs[0], err) + } + return Deps{DB: conn}.Env(ctx, nil, current, nil), current +} + +func TestLinkFilesANamedSiteAgainstThatSite(t *testing.T) { + env, current := linkEnv(t) + + got, err := env.link(":"+current.Slug+":Main", db.LinkInclude) + if err != nil { + t.Fatalf("link() err = %v, want nil", err) + } + if got.To != "main" { + t.Errorf("link(:%s:Main).To = %q, want %q", current.Slug, got.To, "main") + } + if got.ToSiteID == nil || *got.ToSiteID != current.ID { + t.Errorf("link(:%s:Main).ToSiteID = %v, want %d", current.Slug, got.ToSiteID, current.ID) + } +} + +func TestLinkLeavesAnUnknownSiteWhole(t *testing.T) { + env, _ := linkEnv(t) + + got, err := env.link(":nosuchsite:main", db.LinkPlain) + if err != nil { + t.Fatalf("link() err = %v, want nil", err) + } + if got.To != ":nosuchsite:main" { + t.Errorf("link(:nosuchsite:main).To = %q, want %q", got.To, ":nosuchsite:main") + } + if got.ToSiteID != nil { + t.Errorf("link(:nosuchsite:main).ToSiteID = %v, want nil", got.ToSiteID) + } +} + +func TestLinkWithoutASiteStaysLocal(t *testing.T) { + env, _ := linkEnv(t) + + got, err := env.link("Component:Box", db.LinkPlain) + if err != nil { + t.Fatalf("link() err = %v, want nil", err) + } + if got.To != "component:box" { + t.Errorf("link(Component:Box).To = %q, want %q", got.To, "component:box") + } + if got.ToSiteID != nil { + t.Errorf("link(Component:Box).ToSiteID = %v, want nil", got.ToSiteID) + } +} From 8c1227ea626e32a0fd453e0d4d82854d9f698f21 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 14:15:19 +0900 Subject: [PATCH 355/428] give the repository tests a site --- internal/repo/forumcategory_test.go | 3 ++- internal/repo/forumnewthread_test.go | 3 ++- internal/repo/forumstart_test.go | 3 ++- internal/repo/repo_test.go | 3 ++- internal/repo/sitehelp_test.go | 18 ++++++++++++++++++ internal/repo/tagcloud_test.go | 3 ++- internal/repo/wantedpages_test.go | 3 ++- 7 files changed, 30 insertions(+), 6 deletions(-) diff --git a/internal/repo/forumcategory_test.go b/internal/repo/forumcategory_test.go index 6e8bf4a2..ecbdadd4 100644 --- a/internal/repo/forumcategory_test.go +++ b/internal/repo/forumcategory_test.go @@ -48,6 +48,7 @@ func forumCategoryCases() []forumCategoryCase { func TestForumCategoryMatchesGolden(t *testing.T) { ctx := context.Background() d := testDB(t) + ctx, current := onSite(t, ctx, d) users, loc := testUsers(t) cases := forumCategoryCases() @@ -72,7 +73,7 @@ func TestForumCategoryMatchesGolden(t *testing.T) { path := forumCategoryPath(t, c, categories) pc := page.NewContext(article, article, path, viewer) - r := New(ctx, d, users, Options{Loc: loc, User: viewer}) + r := New(ctx, d, users, Options{Loc: loc, User: viewer, Site: current}) body, err := r.RenderModule(pc, "ForumCategory", nil, "") var moduleErr *callbacks.ModuleError diff --git a/internal/repo/forumnewthread_test.go b/internal/repo/forumnewthread_test.go index 728821f9..349d01fb 100644 --- a/internal/repo/forumnewthread_test.go +++ b/internal/repo/forumnewthread_test.go @@ -44,6 +44,7 @@ func forumNewThreadCases() []forumNewThreadCase { func TestForumNewThreadMatchesGolden(t *testing.T) { ctx := context.Background() d := testDB(t) + ctx, current := onSite(t, ctx, d) users, loc := testUsers(t) cases := forumNewThreadCases() @@ -68,7 +69,7 @@ func TestForumNewThreadMatchesGolden(t *testing.T) { path := forumNewThreadPath(t, c, categories) pc := page.NewContext(article, article, path, viewer) - r := New(ctx, d, users, Options{Loc: loc, User: viewer}) + r := New(ctx, d, users, Options{Loc: loc, User: viewer, Site: current}) body, err := r.RenderModule(pc, "ForumNewThread", nil, "") var moduleErr *callbacks.ModuleError diff --git a/internal/repo/forumstart_test.go b/internal/repo/forumstart_test.go index c0c7426c..9a0aa93d 100644 --- a/internal/repo/forumstart_test.go +++ b/internal/repo/forumstart_test.go @@ -53,6 +53,7 @@ func forumStartCases() []forumStartCase { func TestForumStartMatchesGolden(t *testing.T) { ctx := context.Background() d := testDB(t) + ctx, current := onSite(t, ctx, d) users, loc := testUsers(t) cases := forumStartCases() @@ -77,7 +78,7 @@ func TestForumStartMatchesGolden(t *testing.T) { path := forumStartPath(t, c, sections) pc := page.NewContext(article, article, path, viewer) - r := New(ctx, d, users, Options{Loc: loc, User: viewer}) + r := New(ctx, d, users, Options{Loc: loc, User: viewer, Site: current}) body, err := r.RenderModule(pc, "ForumStart", nil, "") var moduleErr *callbacks.ModuleError diff --git a/internal/repo/repo_test.go b/internal/repo/repo_test.go index bbf8d1ff..b43e2540 100644 --- a/internal/repo/repo_test.go +++ b/internal/repo/repo_test.go @@ -43,7 +43,8 @@ func newTestRepo(t *testing.T) *Repository { t.Helper() d := testDB(t) users, _ := testUsers(t) - return New(context.Background(), d, users, Options{}) + ctx, current := onSite(t, context.Background(), d) + return New(ctx, d, users, Options{Site: current}) } func TestPageInfoDropsMissingPages(t *testing.T) { diff --git a/internal/repo/sitehelp_test.go b/internal/repo/sitehelp_test.go index 2c70f809..e8838a7f 100644 --- a/internal/repo/sitehelp_test.go +++ b/internal/repo/sitehelp_test.go @@ -2,8 +2,10 @@ package repo import ( "context" + "testing" "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/site" ) func onlySiteID(ctx context.Context, d *db.DB) int64 { @@ -20,3 +22,19 @@ func onlySiteID(ctx context.Context, d *db.DB) int64 { } return found.ID } + +func onSite(t *testing.T, ctx context.Context, d *db.DB) (context.Context, *db.Site) { + t.Helper() + slugs, err := d.SiteSlugs(ctx) + if err != nil { + t.Fatalf("SiteSlugs() err = %v, want nil", err) + } + if len(slugs) == 0 { + t.Skip("the test database holds no site") + } + found, err := d.SiteBySlug(ctx, slugs[0]) + if err != nil { + t.Fatalf("SiteBySlug(%q) err = %v, want nil", slugs[0], err) + } + return site.WithSite(ctx, found), found +} diff --git a/internal/repo/tagcloud_test.go b/internal/repo/tagcloud_test.go index dab8bcbc..38c59b45 100644 --- a/internal/repo/tagcloud_test.go +++ b/internal/repo/tagcloud_test.go @@ -62,6 +62,7 @@ func tagCloudCases() []tagCloudCase { func TestTagCloudMatchesGolden(t *testing.T) { ctx := context.Background() d := testDB(t) + ctx, current := onSite(t, ctx, d) users, loc := testUsers(t) cases := tagCloudCases() @@ -73,7 +74,7 @@ func TestTagCloudMatchesGolden(t *testing.T) { var b strings.Builder for _, c := range cases { pc := page.NewContext(article, article, nil, nil) - r := New(ctx, d, users, Options{Loc: loc}) + r := New(ctx, d, users, Options{Loc: loc, Site: current}) body, err := r.RenderModule(pc, "TagCloud", copyParams(c.Params), "") var moduleErr *callbacks.ModuleError diff --git a/internal/repo/wantedpages_test.go b/internal/repo/wantedpages_test.go index ecad9c19..6d5ca1c5 100644 --- a/internal/repo/wantedpages_test.go +++ b/internal/repo/wantedpages_test.go @@ -52,6 +52,7 @@ func wantedPagesCases() []wantedPagesCase { func TestWantedPagesMatchesGolden(t *testing.T) { ctx := context.Background() d := testDB(t) + ctx, current := onSite(t, ctx, d) users, loc := testUsers(t) cases := wantedPagesCases() @@ -63,7 +64,7 @@ func TestWantedPagesMatchesGolden(t *testing.T) { var b strings.Builder for _, c := range cases { pc := page.NewContext(article, article, sortedPath(c.Path), nil) - r := New(ctx, d, users, Options{Loc: loc}) + r := New(ctx, d, users, Options{Loc: loc, Site: current}) body, err := r.RenderModule(pc, "WantedPages", copyParams(c.Params), "") var moduleErr *callbacks.ModuleError From 9fee5ddfc6f32dfc72e3afd4963f74c478860628 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 14:34:36 +0900 Subject: [PATCH 356/428] import the pages of a wikitcli backup --- .gitignore | 2 +- cmd/pwikit/main.go | 45 ++++ go.mod | 13 +- go.sum | 35 +++- internal/archive/archive.go | 387 +++++++++++++++++++++++++++++++++++ internal/archive/import.go | 186 +++++++++++++++++ internal/archive/source.go | 58 ++++++ internal/db/archive_write.go | 294 ++++++++++++++++++++++++++ 8 files changed, 1016 insertions(+), 4 deletions(-) create mode 100644 internal/archive/archive.go create mode 100644 internal/archive/import.go create mode 100644 internal/archive/source.go create mode 100644 internal/db/archive_write.go diff --git a/.gitignore b/.gitignore index d305cfda..b16ff226 100644 --- a/.gitignore +++ b/.gitignore @@ -10,7 +10,7 @@ node_modules *.log .env postgresql -archive +/archive *.env venv .DS_Store diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index fefcc6bb..fe125555 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -11,12 +11,14 @@ import ( "net/http" "os" "regexp" + "slices" "strconv" "strings" "text/tabwriter" "github.com/WikitTeam/ProjectWikit/internal/account" "github.com/WikitTeam/ProjectWikit/internal/admin" + "github.com/WikitTeam/ProjectWikit/internal/archive" "github.com/WikitTeam/ProjectWikit/internal/compress" "github.com/WikitTeam/ProjectWikit/internal/db" "github.com/WikitTeam/ProjectWikit/internal/entry" @@ -389,6 +391,10 @@ func seedPages(args []string) error { fs := flag.NewFlagSet("seed", flag.ContinueOnError) database := fs.String("database", os.Getenv(envDatabase), "PostgreSQL connection string") slug := fs.String("site", "", "slug of the site to write into; needed once a database holds more than one") + archivePath := fs.String("archive", "", "wikitCLI backup to import instead of the starter pages") + from := fs.String("from", "", "slug of the site inside the archive; needed when it holds more than one") + forceTags := fs.Bool("force-tags", false, "create tags this site would otherwise refuse") + noVotes := fs.Bool("no-votes", false, "leave the ratings behind") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -411,6 +417,10 @@ func seedPages(args []string) error { return err } + if *archivePath != "" { + return importArchive(ctx, conn, current, *archivePath, *from, *forceTags, !*noVotes) + } + written, err := seed.Run(ctx, conn, current.ID) for _, name := range written { fmt.Println("wrote " + name) @@ -574,3 +584,38 @@ func resolveSite(ctx context.Context, conn *db.DB, slug string) (*db.Site, error } return nil, fmt.Errorf("this database holds %d sites, name one with -site", len(slugs)) } + +func importArchive(ctx context.Context, conn *db.DB, current *db.Site, path, from string, + forceTags, votes bool) error { + + found, err := archive.Open(path) + if err != nil { + return err + } + defer found.Close() + + slugs, err := found.Sites() + if err != nil { + return err + } + switch { + case len(slugs) == 0: + return fmt.Errorf("no site in the archive at %q", path) + case from == "" && len(slugs) > 1: + return fmt.Errorf("the archive holds %d sites, name one with -from", len(slugs)) + case from == "": + from = slugs[0] + case !slices.Contains(slugs, from): + return fmt.Errorf("the archive has no site %q", from) + } + + fmt.Printf("importing %s into %s\n", from, current.Slug) + result, err := archive.ImportPages(ctx, conn, current.ID, found, from, archive.Options{ + ForceTags: forceTags, + Votes: votes, + Report: func(line string) { fmt.Println(line) }, + }) + fmt.Printf("%d pages written, %d already there, %d revisions, %d parents, %d accounts\n", + result.Pages, result.Skipped, result.Revisions, result.Parents, result.Users) + return err +} diff --git a/go.mod b/go.mod index f4ffeb1f..8246a276 100644 --- a/go.mod +++ b/go.mod @@ -3,6 +3,7 @@ module github.com/WikitTeam/ProjectWikit go 1.26 require ( + github.com/bodgit/sevenzip v1.6.5 github.com/jackc/pgx/v5 v5.10.0 github.com/tdewolff/minify/v2 v2.24.17 golang.org/x/crypto v0.46.0 @@ -11,12 +12,22 @@ require ( ) require ( + github.com/andybalholm/brotli v1.2.2 // indirect + github.com/bodgit/plumbing v1.3.0 // indirect + github.com/bodgit/windows v1.0.1 // indirect + github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect github.com/jackc/pgpassfile v1.0.0 // indirect github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect github.com/jackc/puddle/v2 v2.2.2 // indirect + github.com/klauspost/compress v1.19.0 // indirect github.com/kr/text v0.2.0 // indirect + github.com/pierrec/lz4/v4 v4.1.27 // indirect github.com/rogpeppe/go-internal v1.16.0 // indirect + github.com/spf13/afero v1.15.0 // indirect + github.com/stangelandcl/ppmd v0.1.1 // indirect github.com/tdewolff/parse/v2 v2.8.16 // indirect - golang.org/x/net v0.47.0 // indirect + github.com/ulikunitz/xz v0.5.15 // indirect + go4.org v0.0.0-20260112195520-a5071408f32f // indirect + golang.org/x/net v0.48.0 // indirect golang.org/x/sync v0.22.0 // indirect ) diff --git a/go.sum b/go.sum index d92f359f..67b3e73f 100644 --- a/go.sum +++ b/go.sum @@ -1,7 +1,17 @@ +github.com/andybalholm/brotli v1.2.2 h1:HzTuoo2ErYQqf5qvcJInB8uvqSVxRttzkFexPWtnceM= +github.com/andybalholm/brotli v1.2.2/go.mod h1:rzTDkvFWvIrjDXZHkuS16NPggd91W3kUSvPlQ1pLaKY= +github.com/bodgit/plumbing v1.3.0 h1:pf9Itz1JOQgn7vEOE7v7nlEfBykYqvUYioC61TwWCFU= +github.com/bodgit/plumbing v1.3.0/go.mod h1:JOTb4XiRu5xfnmdnDJo6GmSbSbtSyufrsyZFByMtKEs= +github.com/bodgit/sevenzip v1.6.5 h1:7H7BxgmeX0j6UX42lH+KXQ92WgMQJ49DoocFdfHbCng= +github.com/bodgit/sevenzip v1.6.5/go.mod h1:GhuB6Lq1xCpP1sps+horjZ8lgiKPJcy2zUX3prla9wc= +github.com/bodgit/windows v1.0.1 h1:tF7K6KOluPYygXa3Z2594zxlkbKPAOvqr97etrGNIz4= +github.com/bodgit/windows v1.0.1/go.mod h1:a6JLwrB4KrTR5hBpp8FI9/9W9jJfeQ2h4XDXU74ZCdM= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k= +github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM= github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM= github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg= github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo= @@ -10,17 +20,32 @@ github.com/jackc/pgx/v5 v5.10.0 h1:VhSvgU2jSli8o3AqIEOTJr7rZwAEUVo4E4XhR94Zfr0= github.com/jackc/pgx/v5 v5.10.0/go.mod h1:mal1tBGAFfLHvZzaYh77YS/eC6IX9OWbRV1QIIM0Jn4= github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo= github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4= +github.com/klauspost/compress v1.19.0 h1:sXLILfc9jV2QYWkzFOPWStmcUVH2RHEB1JCdY2oVvCQ= +github.com/klauspost/compress v1.19.0/go.mod h1:cwPg85FWrGar70rWktvGQj8/hthj3wpl0PGDogxkrSQ= github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0= github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/pierrec/lz4/v4 v4.1.27 h1:+PhzhWDrjRj89TH2sw43nE3+4+W8lSxIuQadEHZyjUk= +github.com/pierrec/lz4/v4 v4.1.27/go.mod h1:EoQMVJgeeEOMsCqCzqFm2O0cJvljX2nGZjcRIPL34O4= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/rogpeppe/go-internal v1.16.0 h1:O9DK+vNMDVGLr2BeZqmpLeMjiMNkuXfcqntWbZV6S5g= github.com/rogpeppe/go-internal v1.16.0/go.mod h1:DrUVZyrJU+txYW5/1kwtXQSMFio52ZOxX7yM1VHvnxs= +github.com/spf13/afero v1.15.0 h1:b/YBCLWAJdFWJTN9cLhiXXcD7mzKn9Dm86dNnfyQw1I= +github.com/spf13/afero v1.15.0/go.mod h1:NC2ByUVxtQs4b3sIUphxK0NioZnmxgyCrfzeuq8lxMg= +github.com/stangelandcl/ppmd v0.1.1 h1:c25QazhlWUn5nmR1QOzafKhQxBicAr7GGCKER2aJ8H8= +github.com/stangelandcl/ppmd v0.1.1/go.mod h1:Rrv7M+/2P5jYr/GMLhBl7Ug3uJ1bUiVzr5LbbaV6xgY= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/tdewolff/minify/v2 v2.24.17 h1:6AbitfVyq0M7aW6i+XL7+49DeTQZwloOMs9O574arBg= @@ -29,10 +54,16 @@ github.com/tdewolff/parse/v2 v2.8.16 h1:bLk5svUOQRkW/Y2SJ+DeENSIkZBcTIkq+Atyv5D8 github.com/tdewolff/parse/v2 v2.8.16/go.mod h1:XdsoSFThlVIRIajAuqz1evNY7bagZS8LBOPA3aVopwQ= github.com/tdewolff/test v1.0.12 h1:7F21DqIajswxuche0geHdrUZRCWE4oko4b7bcmkkrxk= github.com/tdewolff/test v1.0.12/go.mod h1:XPuWBzvdUzhCuxWO1ojpXsyzsA5bFoS3tO/Q3kFuTG8= +github.com/ulikunitz/xz v0.5.15 h1:9DNdB5s+SgV3bQ2ApL10xRc35ck0DuIX/isZvIk+ubY= +github.com/ulikunitz/xz v0.5.15/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14= +github.com/xyproto/randomstring v1.0.5 h1:YtlWPoRdgMu3NZtP45drfy1GKoojuR7hmRcnhZqKjWU= +github.com/xyproto/randomstring v1.0.5/go.mod h1:rgmS5DeNXLivK7YprL0pY+lTuhNQW3iGxZ18UQApw/E= +go4.org v0.0.0-20260112195520-a5071408f32f h1:ziUVAjmTPwQMBmYR1tbdRFJPtTcQUI12fH9QQjfb0Sw= +go4.org v0.0.0-20260112195520-a5071408f32f/go.mod h1:ZRJnO5ZI4zAwMFp+dS1+V6J6MSyAowhRqAE+DPa1Xp0= golang.org/x/crypto v0.46.0 h1:cKRW/pmt1pKAfetfu+RCEvjvZkA9RimPbh7bhFjGVBU= golang.org/x/crypto v0.46.0/go.mod h1:Evb/oLKmMraqjZ2iQTwDwvCtJkczlDuTmdJXoZVzqU0= -golang.org/x/net v0.47.0 h1:Mx+4dIFzqraBXUugkia1OOvlD6LemFo1ALMHjrXDOhY= -golang.org/x/net v0.47.0/go.mod h1:/jNxtkgq5yWUGYkaZGqo27cfGZ1c5Nen03aYrrKpVRU= +golang.org/x/net v0.48.0 h1:zyQRTTrjc33Lhh0fBgT/H3oZq9WuvRR5gPC70xpDiQU= +golang.org/x/net v0.48.0/go.mod h1:+ndRgGjkh8FGtu1w1FGbEC31if4VrNVMuKTgcAAnQRY= golang.org/x/sync v0.22.0 h1:SZjpbeLmrCk4xhRSZFNZW5gFUeCeFgjekvI/+gfScek= golang.org/x/sync v0.22.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0= golang.org/x/text v0.41.0 h1:vz/seA0lnX87Othu2f/0L24RcgrXD9/YFTSuGjj3rH8= diff --git a/internal/archive/archive.go b/internal/archive/archive.go new file mode 100644 index 00000000..aa6463ef --- /dev/null +++ b/internal/archive/archive.go @@ -0,0 +1,387 @@ +// Package archive reads the backup a wikitCLI run leaves behind. +package archive + +import ( + "archive/tar" + "compress/gzip" + "encoding/json" + "fmt" + "io" + "os" + "path/filepath" + "sort" + "strings" +) + +const ( + metaDir = "meta" + pagesDir = "pages" + filesDir = "files" + usersDir = "_users" + siteFile = "site.json" + pageSufix = ".json" + sourceExt = ".7z" +) + +type Archive struct { + roots []string + extracted string +} + +type SiteMeta struct { + Slug string `json:"slug"` + Domain string `json:"domain"` + HomePage string `json:"home_page"` + Language string `json:"language"` + SiteID int64 `json:"site_id"` +} + +type User struct { + ID int64 `json:"user_id"` + Username string `json:"username"` + FullName string `json:"full_name"` + FetchedAt int64 `json:"fetched_at"` +} + +type Revision struct { + Number int `json:"revision"` + Author int64 `json:"author"` + Stamp int64 `json:"stamp"` + Flags string `json:"flags"` + Comment string `json:"commentary"` +} + +// HasSource reports whether the 7z holds the wikitext of this revision. Wikidot +// records a revision for a tag or a rename too, and those carry no text. +func (r Revision) HasSource() bool { + return strings.ContainsAny(r.Flags, "SN") +} + +func (r Revision) IsNew() bool { return strings.Contains(r.Flags, "N") } + +type File struct { + ID int64 `json:"file_id"` + Name string `json:"name"` + Mime string `json:"mime"` + Size int64 `json:"size_bytes"` + Author int64 `json:"author"` + Stamp int64 `json:"stamp"` +} + +type Vote struct { + UserID int64 + Value float64 +} + +// UnmarshalJSON reads the [user, value] pair the backup writes. A boolean is the +// up and down scale, a number is the star one. +func (v *Vote) UnmarshalJSON(data []byte) error { + var raw []json.RawMessage + if err := json.Unmarshal(data, &raw); err != nil { + return err + } + if len(raw) < 2 { + return fmt.Errorf("vote %s has %d fields, want 2", data, len(raw)) + } + if err := json.Unmarshal(raw[0], &v.UserID); err != nil { + return err + } + var flag bool + if err := json.Unmarshal(raw[1], &flag); err == nil { + v.Value = 1 + if !flag { + v.Value = -1 + } + return nil + } + return json.Unmarshal(raw[1], &v.Value) +} + +type Page struct { + // Stem is the name the meta and the source archive share, which is not the + // page name and is the only way back to the 7z. + Stem string `json:"-"` + + Name string `json:"name"` + Title string `json:"title"` + Parent string `json:"parent"` + Tags []string `json:"tags"` + Rating float64 `json:"rating"` + Locked bool `json:"is_locked"` + PageID int64 `json:"page_id"` + Revisions []Revision `json:"revisions"` + Votings []Vote `json:"votings"` + Files []File `json:"files"` +} + +// Open reads a .tar.gz, or a directory holding unpacked sites, tarballs, or +// both. A backup that arrives as several tarballs is read by putting them in one +// directory. The archive owns the temporary directory it unpacks into, so +// callers must Close it. +func Open(path string) (*Archive, error) { + info, err := os.Stat(path) + if err != nil { + return nil, err + } + a := &Archive{} + tarballs := []string{path} + if info.IsDir() { + a.roots = append(a.roots, path) + tarballs, err = tarballsIn(path) + if err != nil { + return nil, err + } + } + if len(tarballs) == 0 { + return a, nil + } + + dir, err := os.MkdirTemp("", "pwikit-archive-") + if err != nil { + return nil, err + } + for _, ball := range tarballs { + if err := untar(ball, dir); err != nil { + os.RemoveAll(dir) + return nil, err + } + } + a.roots = append(a.roots, dir) + a.extracted = dir + return a, nil +} + +func tarballsIn(dir string) ([]string, error) { + entries, err := os.ReadDir(dir) + if err != nil { + return nil, err + } + var out []string + for _, e := range entries { + name := strings.ToLower(e.Name()) + if e.IsDir() || !(strings.HasSuffix(name, ".tar.gz") || strings.HasSuffix(name, ".tgz")) { + continue + } + out = append(out, filepath.Join(dir, e.Name())) + } + sort.Strings(out) + return out, nil +} + +// find answers where a path lives, searching the roots in the order they were +// added so an unpacked directory wins over a tarball of the same site. +func (a *Archive) find(parts ...string) (string, bool) { + for _, root := range a.roots { + full := filepath.Join(append([]string{root}, parts...)...) + if _, err := os.Stat(full); err == nil { + return full, true + } + } + return "", false +} + +func (a *Archive) Close() error { + if a.extracted == "" { + return nil + } + return os.RemoveAll(a.extracted) +} + +// Sites lists the slugs the archive carries. A backup of one site holds one. +func (a *Archive) Sites() ([]string, error) { + seen := map[string]bool{} + var out []string + for _, root := range a.roots { + entries, err := os.ReadDir(root) + if err != nil { + return nil, err + } + for _, e := range entries { + if !e.IsDir() || e.Name() == usersDir || seen[e.Name()] { + continue + } + if _, err := os.Stat(filepath.Join(root, e.Name(), metaDir, siteFile)); err != nil { + continue + } + seen[e.Name()] = true + out = append(out, e.Name()) + } + } + sort.Strings(out) + return out, nil +} + +func (a *Archive) Site(slug string) (SiteMeta, error) { + var s SiteMeta + path, ok := a.find(slug, metaDir, siteFile) + if !ok { + return s, fmt.Errorf("no site %q in the archive", slug) + } + body, err := os.ReadFile(path) + if err != nil { + return s, err + } + if err := json.Unmarshal(body, &s); err != nil { + return s, fmt.Errorf("read the site meta of %q: %w", slug, err) + } + return s, nil +} + +// Users merges every _users directory the archive carries, the shared one and +// the one a site brought along. Where two disagree the newer fetch wins. +func (a *Archive) Users() (map[int64]User, error) { + slugs, err := a.Sites() + if err != nil { + return nil, err + } + var dirs []string + for _, root := range a.roots { + dirs = append(dirs, filepath.Join(root, usersDir)) + for _, slug := range slugs { + dirs = append(dirs, filepath.Join(root, slug, usersDir)) + } + } + + out := map[int64]User{} + for _, dir := range dirs { + entries, err := os.ReadDir(dir) + if os.IsNotExist(err) { + continue + } + if err != nil { + return nil, err + } + for _, e := range entries { + if e.IsDir() || !strings.HasSuffix(e.Name(), pageSufix) || e.Name() == "pending.json" { + continue + } + body, err := os.ReadFile(filepath.Join(dir, e.Name())) + if err != nil { + return nil, err + } + var bucket map[string]User + if err := json.Unmarshal(body, &bucket); err != nil { + return nil, fmt.Errorf("read users from %q: %w", e.Name(), err) + } + for _, u := range bucket { + if u.ID == 0 { + continue + } + if held, ok := out[u.ID]; ok && held.FetchedAt >= u.FetchedAt { + continue + } + out[u.ID] = u + } + } + } + return out, nil +} + +func (a *Archive) Pages(slug string) ([]Page, error) { + dir, ok := a.find(slug, metaDir, pagesDir) + if !ok { + return nil, fmt.Errorf("no pages for %q in the archive", slug) + } + entries, err := os.ReadDir(dir) + if err != nil { + return nil, err + } + out := make([]Page, 0, len(entries)) + for _, e := range entries { + if e.IsDir() || !strings.HasSuffix(e.Name(), pageSufix) { + continue + } + body, err := os.ReadFile(filepath.Join(dir, e.Name())) + if err != nil { + return nil, err + } + var p Page + if err := json.Unmarshal(body, &p); err != nil { + return nil, fmt.Errorf("read the page meta %q: %w", e.Name(), err) + } + p.Stem = strings.TrimSuffix(e.Name(), pageSufix) + if p.Name == "" || len(p.Revisions) == 0 { + continue + } + out = append(out, p) + } + sort.Slice(out, func(i, j int) bool { return out[i].Name < out[j].Name }) + return out, nil +} + +func (a *Archive) sourcePath(slug, stem string) string { + path, _ := a.find(slug, pagesDir, stem+sourceExt) + return path +} + +// FilePath is where an attachment sits. Wikidot quotes the page name into the +// directory, so a colon arrives as %3A. +func (a *Archive) FilePath(slug, pageName string, fileID int64) string { + path, _ := a.find(slug, filesDir, quotePage(pageName), fmt.Sprint(fileID)) + return path +} + +func quotePage(name string) string { + return strings.ReplaceAll(name, ":", "%3A") +} + +func untar(from, into string) error { + f, err := os.Open(from) + if err != nil { + return err + } + defer f.Close() + + gz, err := gzip.NewReader(f) + if err != nil { + return fmt.Errorf("read %q as gzip: %w", from, err) + } + defer gz.Close() + + reader := tar.NewReader(gz) + for { + head, err := reader.Next() + if err == io.EOF { + return nil + } + if err != nil { + return err + } + target, err := safeJoin(into, head.Name) + if err != nil { + return err + } + switch head.Typeflag { + case tar.TypeDir: + if err := os.MkdirAll(target, 0o755); err != nil { + return err + } + case tar.TypeReg: + if err := os.MkdirAll(filepath.Dir(target), 0o755); err != nil { + return err + } + out, err := os.Create(target) + if err != nil { + return err + } + if _, err := io.Copy(out, reader); err != nil { + out.Close() + return err + } + if err := out.Close(); err != nil { + return err + } + } + } +} + +// An entry naming its way out of the directory is refused rather than cleaned, +// because a backup that carries one is not a backup this reader understands. +func safeJoin(root, name string) (string, error) { + target := filepath.Join(root, filepath.FromSlash(name)) + rel, err := filepath.Rel(root, target) + if err != nil || rel == ".." || strings.HasPrefix(rel, ".."+string(filepath.Separator)) { + return "", fmt.Errorf("archive entry %q leaves the directory", name) + } + return target, nil +} diff --git a/internal/archive/import.go b/internal/archive/import.go new file mode 100644 index 00000000..d080ca19 --- /dev/null +++ b/internal/archive/import.go @@ -0,0 +1,186 @@ +package archive + +import ( + "context" + "errors" + "fmt" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/wikidot" +) + +type Options struct { + // ForceTags creates tags the site would otherwise refuse, which is what an + // import of somebody else's wiki almost always needs. + ForceTags bool + + // Votes is off when only the text is wanted, since ratings are the part an + // owner most often means to start over. + Votes bool + + // Report is called with a line worth showing while a long import runs. + Report func(string) +} + +type Result struct { + Users int + Pages int + Skipped int + Revisions int + Parents int +} + +// ImportPages writes the pages of one site in the archive, skipping any page the +// database already has. Nothing already here is edited. +func ImportPages(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug string, opts Options) (Result, error) { + var out Result + + pages, err := a.Pages(slug) + if err != nil { + return out, err + } + byWikidot, err := importUsers(ctx, d, a) + if err != nil { + return out, err + } + out.Users = len(byWikidot) + report(opts, fmt.Sprintf("%d accounts, %d pages", out.Users, len(pages))) + + local := make(map[string]int64, len(pages)) + for _, page := range pages { + existing, err := d.ArticleByName(ctx, siteID, page.Name) + if err == nil { + out.Skipped++ + local[wikidot.Normalize(page.Name)] = existing.ID + continue + } + if !errors.Is(err, db.ErrNotFound) { + return out, err + } + + id, revisions, err := importPage(ctx, d, siteID, a, slug, page, byWikidot, opts) + if err != nil { + return out, err + } + local[wikidot.Normalize(page.Name)] = id + out.Pages++ + out.Revisions += revisions + if out.Pages%200 == 0 { + report(opts, fmt.Sprintf("%d of %d pages", out.Pages, len(pages))) + } + } + + for _, page := range pages { + if page.Parent == "" { + continue + } + child, ok := local[wikidot.Normalize(page.Name)] + if !ok { + continue + } + parent, ok := local[wikidot.Normalize(page.Parent)] + if !ok { + continue + } + if err := d.SetImportedParent(ctx, siteID, child, parent); err != nil { + return out, err + } + out.Parents++ + } + return out, nil +} + +func importUsers(ctx context.Context, d *db.DB, a *Archive) (map[int64]int64, error) { + found, err := a.Users() + if err != nil { + return nil, err + } + list := make([]db.ImportUser, 0, len(found)) + for _, u := range found { + list = append(list, db.ImportUser{ + WikidotID: u.ID, + Username: u.Username, + DisplayName: u.FullName, + }) + } + return d.EnsureWikidotUsers(ctx, list, time.Now().UTC()) +} + +func importPage(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug string, + page Page, byWikidot map[int64]int64, opts Options) (int64, int, error) { + + sources, err := a.Sources(slug, page) + if err != nil { + return 0, 0, err + } + + category, name := wikidot.Split(wikidot.Normalize(page.Name)) + oldest := page.Revisions[len(page.Revisions)-1] + newest := page.Revisions[0] + + write := db.ImportArticle{ + Category: category, + Name: name, + Title: page.Title, + Locked: page.Locked, + CreatedAt: time.Unix(oldest.Stamp, 0).UTC(), + UpdatedAt: time.Unix(newest.Stamp, 0).UTC(), + AuthorID: localUser(byWikidot, oldest.Author), + } + + // The archive lists the newest revision first and the history reads the + // other way round. + for i := len(page.Revisions) - 1; i >= 0; i-- { + rev := page.Revisions[i] + one := db.ImportRevision{ + Number: rev.Number, + UserID: localUser(byWikidot, rev.Author), + Comment: rev.Comment, + At: time.Unix(rev.Stamp, 0).UTC(), + IsNew: rev.IsNew(), + } + if source, ok := sources[rev.Number]; ok { + one.Source = &source + } + write.Revisions = append(write.Revisions, one) + } + + if opts.Votes { + for _, vote := range page.Votings { + user := localUser(byWikidot, vote.UserID) + if user == nil { + continue + } + write.Votes = append(write.Votes, db.ImportVote{UserID: *user, Rate: vote.Value}) + } + } + if len(page.Tags) > 0 { + ids, err := d.EnsureTags(ctx, siteID, page.Tags, opts.ForceTags) + if err != nil { + return 0, 0, err + } + write.TagIDs = ids + } + + id, err := d.ImportArticle(ctx, siteID, write) + if err != nil { + return 0, 0, err + } + return id, len(write.Revisions), nil +} + +// An author the archive never described is left off rather than invented, which +// shows the revision as the system's own. +func localUser(byWikidot map[int64]int64, wikidotID int64) *int64 { + if id, ok := byWikidot[wikidotID]; ok { + return &id + } + return nil +} + +func report(opts Options, line string) { + if opts.Report != nil { + opts.Report(line) + } +} diff --git a/internal/archive/source.go b/internal/archive/source.go new file mode 100644 index 00000000..2a203e3f --- /dev/null +++ b/internal/archive/source.go @@ -0,0 +1,58 @@ +package archive + +import ( + "fmt" + "io" + "strconv" + "strings" + + "github.com/bodgit/sevenzip" +) + +// Sources reads the wikitext of every revision that carries one, keyed by +// revision number. A page whose archive is missing comes back empty rather than +// failing, which is what the backup does when a page was never fetched. +func (a *Archive) Sources(slug string, page Page) (map[int]string, error) { + wanted := map[string]int{} + for _, rev := range page.Revisions { + if rev.HasSource() { + wanted[strconv.Itoa(rev.Number)+".txt"] = rev.Number + } + } + out := make(map[int]string, len(wanted)) + if len(wanted) == 0 { + return out, nil + } + + reader, err := sevenzip.OpenReader(a.sourcePath(slug, page.Stem)) + if err != nil { + return out, nil + } + defer reader.Close() + + for _, entry := range reader.File { + number, ok := wanted[strings.ToLower(entry.Name)] + if !ok { + continue + } + body, err := readEntry(entry) + if err != nil { + return nil, fmt.Errorf("read revision %d of %q: %w", number, page.Name, err) + } + out[number] = body + } + return out, nil +} + +func readEntry(entry *sevenzip.File) (string, error) { + rc, err := entry.Open() + if err != nil { + return "", err + } + defer rc.Close() + body, err := io.ReadAll(rc) + if err != nil { + return "", err + } + return string(body), nil +} diff --git a/internal/db/archive_write.go b/internal/db/archive_write.go new file mode 100644 index 00000000..93a1a2ef --- /dev/null +++ b/internal/db/archive_write.go @@ -0,0 +1,294 @@ +package db + +import ( + "context" + "encoding/json" + "fmt" + "strings" + "time" +) + +// LogWikidot marks a revision an import carried over whose kind this engine has +// no word for, such as a rename Wikidot recorded without keeping the source. +const LogWikidot = "wikidot" + +type ImportUser struct { + WikidotID int64 + Username string + DisplayName string +} + +var ( + qUsersByWikidotID = register("UsersByWikidotID", ` +SELECT wikidot_user_id, id FROM web_user WHERE wikidot_user_id = ANY($1)`) + + qUsersByWikidotName = register("UsersByWikidotName", ` +SELECT wikidot_username, id FROM web_user WHERE wikidot_username = ANY($1)`) + + qAdoptWikidotID = register("AdoptWikidotID", ` +UPDATE web_user SET wikidot_user_id = $2 WHERE id = $1 AND wikidot_user_id IS NULL`) + + qInsertWikidotUser = register("InsertWikidotUser", ` +INSERT INTO web_user (password, is_superuser, first_name, last_name, email, date_joined, + username, wikidot_username, wikidot_user_id, display_name, type, bio, + is_forum_active, is_active, can_send_direct_messages, pending_email, previous_email) +VALUES ('!', false, '', '', '', $4, $5, $1, $2, $3, 'wikidot', '', true, false, true, '', '') +RETURNING id`) +) + +// EnsureWikidotUsers answers the local id of every account the archive names, +// creating the ones this database has never seen. Nothing already here is +// changed, so importing a second archive that overlaps adds rows and edits none. +func (d *DB) EnsureWikidotUsers(ctx context.Context, users []ImportUser, at time.Time) (map[int64]int64, error) { + out := make(map[int64]int64, len(users)) + if len(users) == 0 { + return out, nil + } + + ids := make([]int64, 0, len(users)) + names := make([]string, 0, len(users)) + for _, u := range users { + ids = append(ids, u.WikidotID) + if u.Username != "" { + names = append(names, u.Username) + } + } + + rows, err := d.pool.Query(ctx, qUsersByWikidotID, ids) + if err != nil { + return nil, fmt.Errorf("look up imported users by id: %w", err) + } + for rows.Next() { + var wikidotID, local int64 + if err := rows.Scan(&wikidotID, &local); err != nil { + rows.Close() + return nil, err + } + out[wikidotID] = local + } + rows.Close() + if err := rows.Err(); err != nil { + return nil, err + } + + // An account the previous importer created carries the name but not the + // number, so the number is written onto it rather than a second row. + byName := map[string]int64{} + if len(names) > 0 { + rows, err := d.pool.Query(ctx, qUsersByWikidotName, names) + if err != nil { + return nil, fmt.Errorf("look up imported users by name: %w", err) + } + for rows.Next() { + var name string + var local int64 + if err := rows.Scan(&name, &local); err != nil { + rows.Close() + return nil, err + } + byName[lowered(name)] = local + } + rows.Close() + if err := rows.Err(); err != nil { + return nil, err + } + } + + for _, u := range users { + if _, ok := out[u.WikidotID]; ok { + continue + } + if local, ok := byName[lowered(u.Username)]; ok { + if _, err := d.pool.Exec(ctx, qAdoptWikidotID, local, u.WikidotID); err != nil { + return nil, fmt.Errorf("adopt wikidot id %d: %w", u.WikidotID, err) + } + out[u.WikidotID] = local + continue + } + name := u.Username + if name == "" { + name = fmt.Sprintf("deleted-%d", u.WikidotID) + } + local, err := d.insertWikidotUser(ctx, u.WikidotID, name, u.DisplayName, at) + if err != nil { + return nil, err + } + out[u.WikidotID] = local + byName[lowered(name)] = local + } + return out, nil +} + +func (d *DB) insertWikidotUser(ctx context.Context, wikidotID int64, name, display string, at time.Time) (int64, error) { + local, err := mediaName() + if err != nil { + return 0, err + } + var id int64 + err = d.pool.QueryRow(ctx, qInsertWikidotUser, name, wikidotID, display, at, local).Scan(&id) + if err != nil { + return 0, fmt.Errorf("create the imported account %q: %w", name, err) + } + return id, nil +} + +type ImportRevision struct { + Number int + UserID *int64 + Comment string + At time.Time + + // Source is nil for a revision Wikidot recorded without keeping the text, + // which is most of them once a page has been renamed or retagged. + Source *string + IsNew bool +} + +type ImportVote struct { + UserID int64 + Rate float64 +} + +type ImportArticle struct { + Category string + Name string + Title string + Locked bool + CreatedAt time.Time + UpdatedAt time.Time + AuthorID *int64 + + Revisions []ImportRevision + Votes []ImportVote + TagIDs []int64 +} + +var ( + qImportArticle = register("ImportArticle", ` +INSERT INTO web_article (site_id, category, name, title, locked, created_at, updated_at, media_name) +VALUES ($1, $2, $3, $4, $5, $6, $7, $8) +RETURNING id`) + + qImportLogEntry = register("ImportLogEntry", ` +INSERT INTO web_articlelogentry (article_id, user_id, type, meta, comment, created_at, rev_number) +VALUES ($1, $2, $3, $4, $5, $6, $7)`) + + qImportVote = register("ImportVote", ` +INSERT INTO web_vote (article_id, user_id, rate, date) +VALUES ($1, $2, $3, NULL) +ON CONFLICT DO NOTHING`) + + qImportArticleTag = register("ImportArticleTag", ` +INSERT INTO web_article_tags (article_id, tag_id) +VALUES ($1, $2) +ON CONFLICT DO NOTHING`) +) + +// ImportArticle writes one page and its whole history as the archive recorded +// it. It goes around the ordinary save path on purpose, since that one renumbers +// revisions, rebuilds links and tells subscribers about every one of them. +func (d *DB) ImportArticle(ctx context.Context, siteID int64, a ImportArticle) (int64, error) { + media, err := mediaName() + if err != nil { + return 0, err + } + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin importing %q: %w", a.Name, err) + } + defer tx.Rollback(context.WithoutCancel(ctx)) + + var id int64 + err = tx.QueryRow(ctx, qImportArticle, siteID, a.Category, a.Name, a.Title, a.Locked, + a.CreatedAt, a.UpdatedAt, media).Scan(&id) + if err != nil { + return 0, fmt.Errorf("import article %q: %w", a.Name, err) + } + if a.AuthorID != nil { + if _, err := tx.Exec(ctx, qInsertArticleAuthor, id, *a.AuthorID); err != nil { + return 0, fmt.Errorf("credit the author of %q: %w", a.Name, err) + } + } + + for _, rev := range a.Revisions { + kind := LogWikidot + meta := map[string]any{} + if rev.Source != nil { + var versionID int64 + err := tx.QueryRow(ctx, qInsertArticleVersion, id, *rev.Source, rev.At).Scan(&versionID) + if err != nil { + return 0, fmt.Errorf("import a version of %q: %w", a.Name, err) + } + kind = LogSource + meta["version_id"] = versionID + if rev.IsNew { + kind = LogNew + meta["title"] = a.Title + } + } + encoded, err := json.Marshal(meta) + if err != nil { + return 0, err + } + _, err = tx.Exec(ctx, qImportLogEntry, id, rev.UserID, kind, encoded, rev.Comment, rev.At, rev.Number) + if err != nil { + return 0, fmt.Errorf("import a revision of %q: %w", a.Name, err) + } + } + + for _, vote := range a.Votes { + if _, err := tx.Exec(ctx, qImportVote, id, vote.UserID, vote.Rate); err != nil { + return 0, fmt.Errorf("import a vote on %q: %w", a.Name, err) + } + } + for _, tagID := range a.TagIDs { + if _, err := tx.Exec(ctx, qImportArticleTag, id, tagID); err != nil { + return 0, fmt.Errorf("tag %q: %w", a.Name, err) + } + } + + if err := tx.Commit(ctx); err != nil { + return 0, fmt.Errorf("commit %q: %w", a.Name, err) + } + return id, nil +} + +var qImportParent = register("ImportParent", ` +UPDATE web_article SET parent_id = $2 WHERE id = $1 AND site_id = $3`) + +func (d *DB) SetImportedParent(ctx context.Context, siteID, articleID, parentID int64) error { + if _, err := d.pool.Exec(ctx, qImportParent, articleID, parentID, siteID); err != nil { + return fmt.Errorf("set the parent of %d: %w", articleID, err) + } + return nil +} + +func lowered(s string) string { return strings.ToLower(s) } + +// EnsureTags resolves the tag names an archive carries, creating the ones this +// site has never had. It is the import's way in to the same resolution the +// editor uses, so a tag written here is the tag the editor would have made. +func (d *DB) EnsureTags(ctx context.Context, siteID int64, names []string, allowCreate bool) ([]int64, error) { + if len(names) == 0 { + return nil, nil + } + tx, err := d.pool.Begin(ctx) + if err != nil { + return nil, fmt.Errorf("begin resolving tags: %w", err) + } + defer tx.Rollback(context.WithoutCancel(ctx)) + + tags, err := resolveTags(ctx, tx, siteID, names, allowCreate) + if err != nil { + return nil, err + } + out := make([]int64, 0, len(tags)) + for _, tag := range tags { + out = append(out, tag.ID) + } + if err := tx.Commit(ctx); err != nil { + return nil, fmt.Errorf("commit tags: %w", err) + } + return out, nil +} From d587354ca2135b6d87b9d16e55e501571d3fa2f8 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 15:50:03 +0900 Subject: [PATCH 357/428] pass the site when a forum category is saved --- internal/admin/forum.go | 2 +- internal/db/forum_admin.go | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/internal/admin/forum.go b/internal/admin/forum.go index 8da35823..c6c5c777 100644 --- a/internal/admin/forum.go +++ b/internal/admin/forum.go @@ -153,7 +153,7 @@ func (h *Handler) forumCategories(w http.ResponseWriter, r *http.Request, loc *i if row.ID == 0 { did = db.AdminCreated } - if err := h.deps.DB.SaveForumCategory(ctx, row); err != nil { + if err := h.deps.DB.SaveForumCategory(ctx, siteID(ctx), row); err != nil { return err } h.noteID(r, did, categorySlug, row.ID, row.Name) diff --git a/internal/db/forum_admin.go b/internal/db/forum_admin.go index b5afec4e..978adae7 100644 --- a/internal/db/forum_admin.go +++ b/internal/db/forum_admin.go @@ -163,16 +163,16 @@ AND section_id IN (SELECT id FROM web_forumsection WHERE site_id = $7)`) AND section_id IN (SELECT id FROM web_forumsection WHERE site_id = $2)`) ) -func (d *DB) SaveForumCategory(ctx context.Context, c ForumCategoryRow) error { +func (d *DB) SaveForumCategory(ctx context.Context, siteID int64, c ForumCategoryRow) error { if c.ID == 0 { var id int64 - err := d.pool.QueryRow(ctx, qInsertForumCategory, c.Name, c.Description, c.Order, c.IsForComments, c.SectionID).Scan(&id) + err := d.pool.QueryRow(ctx, qInsertForumCategory, c.Name, c.Description, c.Order, c.IsForComments, c.SectionID, siteID).Scan(&id) if err != nil { return fmt.Errorf("create forum category %q: %w", c.Name, err) } return nil } - _, err := d.pool.Exec(ctx, qUpdateForumCategory, c.ID, c.Name, c.Description, c.Order, c.IsForComments, c.SectionID) + _, err := d.pool.Exec(ctx, qUpdateForumCategory, c.ID, c.Name, c.Description, c.Order, c.IsForComments, c.SectionID, siteID) if err != nil { return fmt.Errorf("update forum category %d: %w", c.ID, err) } From af0352549ba2b5fd61375c97e4140c1de6472458 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 15:50:03 +0900 Subject: [PATCH 358/428] turn the forum html of a backup back into wikitext --- go.mod | 2 +- internal/htmlsource/htmlsource.go | 262 +++++++++++++++++++++++++ internal/htmlsource/htmlsource_test.go | 69 +++++++ internal/htmlsource/nodes.go | 160 +++++++++++++++ 4 files changed, 492 insertions(+), 1 deletion(-) create mode 100644 internal/htmlsource/htmlsource.go create mode 100644 internal/htmlsource/htmlsource_test.go create mode 100644 internal/htmlsource/nodes.go diff --git a/go.mod b/go.mod index 8246a276..a838af8d 100644 --- a/go.mod +++ b/go.mod @@ -7,6 +7,7 @@ require ( github.com/jackc/pgx/v5 v5.10.0 github.com/tdewolff/minify/v2 v2.24.17 golang.org/x/crypto v0.46.0 + golang.org/x/net v0.48.0 golang.org/x/text v0.41.0 gopkg.in/yaml.v3 v3.0.1 ) @@ -28,6 +29,5 @@ require ( github.com/tdewolff/parse/v2 v2.8.16 // indirect github.com/ulikunitz/xz v0.5.15 // indirect go4.org v0.0.0-20260112195520-a5071408f32f // indirect - golang.org/x/net v0.48.0 // indirect golang.org/x/sync v0.22.0 // indirect ) diff --git a/internal/htmlsource/htmlsource.go b/internal/htmlsource/htmlsource.go new file mode 100644 index 00000000..db2f0c73 --- /dev/null +++ b/internal/htmlsource/htmlsource.go @@ -0,0 +1,262 @@ +// Package htmlsource turns the forum HTML a backup carries back into wikitext. +package htmlsource + +import ( + "strings" + + "golang.org/x/net/html" + "golang.org/x/net/html/atom" +) + +// Convert reads a fragment, not a document, because a forum post is a piece of +// a page and never carries its own html element. +func Convert(source string) string { + body := &html.Node{Type: html.ElementNode, Data: "body", DataAtom: atom.Body} + nodes, err := html.ParseFragment(strings.NewReader(source), body) + if err != nil { + return "" + } + c := &converter{} + for _, n := range nodes { + c.footnotesFrom(n) + } + var b strings.Builder + for _, n := range nodes { + b.WriteString(c.node(n)) + } + return b.String() +} + +type converter struct { + footnotes map[string]string +} + +func (c *converter) children(n *html.Node) string { + var b strings.Builder + for child := n.FirstChild; child != nil; child = child.NextSibling { + b.WriteString(c.node(child)) + } + return b.String() +} + +func (c *converter) node(n *html.Node) string { + switch n.Type { + case html.TextNode: + // A newline inside the HTML is layout, and wikitext reads it as a break. + return strings.ReplaceAll(n.Data, "\n", "") + case html.ElementNode: + default: + return "" + } + + switch n.Data { + case "p": + return c.children(n) + "\n\n" + case "em": + return "//" + c.children(n) + "//" + case "strong", "b": + return "**" + c.children(n) + "**" + case "u": + return "__" + c.children(n) + "__" + case "strike", "s": + return "--" + c.children(n) + "--" + case "sup": + return c.superscript(n) + case "sub": + return ",," + c.children(n) + ",," + case "br": + return "\n" + case "iframe": + return "[[iframe " + attr(n, "src") + attrs(n, "src") + "]]" + case "span": + return c.span(n) + case "blockquote": + lines := strings.Split(strings.TrimSpace(c.children(n)), "\n") + return "> " + strings.Join(lines, "\n> ") + "\n" + case "div": + return c.div(n) + case "a": + return "[[a" + attrs(n) + "]]" + c.children(n) + "[[/a]]" + case "img": + return "[[image " + attr(n, "src") + attrs(n, "src", "alt") + "]]" + case "hr": + return "----\n" + case "ul", "li", "ol": + return "[[" + n.Data + "]]\n" + c.children(n) + "[[/" + n.Data + "]]\n" + case "h1", "h2", "h3", "h4", "h5", "h6", "h7": + return strings.Repeat("+", int(n.Data[1]-'0')) + " " + oneLine(text(n)) + "\n" + case "tt": + return "{{" + c.children(n) + "}}" + case "table": + return "[[table" + attrs(n) + "]]\n" + c.children(n) + "[[/table]]\n" + case "tbody": + return c.children(n) + case "tr": + return "[[row" + attrs(n) + "]]\n" + c.children(n) + "[[/row]]\n" + case "td": + return "[[cell" + attrs(n) + "]]\n" + c.children(n) + "[[/cell]]\n" + case "th": + return "[[hcell" + attrs(n) + "]]\n" + c.children(n) + "[[/hcell]]\n" + case "script": + return "" + case "dl": + return definitions(n) + } + return c.children(n) +} + +func (c *converter) superscript(n *html.Node) string { + if !hasClass(n, "footnoteref") { + return "^^" + c.children(n) + "^^" + } + return "[[footnote]]" + c.footnotes[strings.TrimSpace(text(n))] + "[[/footnote]]" +} + +func (c *converter) span(n *html.Node) string { + switch { + case hasClass(n, "printuser"): + star := "" + if hasClass(n, "avatarhover") { + star = "*" + } + return "[[" + star + "user " + userName(n) + "]]" + case hasClass(n, "math-inline"): + return "[[$ " + strings.TrimSpace(strings.Trim(text(n), "$")) + " $]]" + case hasClass(n, "equation-number"): + return "" + } + return "[[span" + attrs(n) + "]]" + c.children(n) + "[[/span]]" +} + +var plainDivClasses = []string{ + "rimg", "limg", "cimg", "blockquote", "сimg", "scpnet-progress-bar", + "scpnet-progress-bar__tick", "block-error", "collapsible-block-unfolded-link", +} + +func (c *converter) div(n *html.Node) string { + switch { + case !hasAnyClass(n) || hasClass(n, plainDivClasses...): + return c.plainDiv(n) + case hasClass(n, "collapsible-block"): + return c.collapsible(n) + case hasClass(n, "yui-navset"): + return c.tabview(n) + case hasClass(n, "code"): + return c.code(n) + case hasClass(n, "footnotes-footer"): + return "[[footnoteblock title=\"" + escapeValue(oneLine(text(find(n, "div", "title")))) + "\"]]\n" + case hasClass(n, "bibitems"): + return c.bibliography(n) + case hasClass(n, "image-container"): + return c.image(n) + case hasClass(n, "content-separator"): + return "====\n" + case hasClass(n, "math-equation"): + return "[[math]]\n" + strings.TrimSpace(text(n)) + "\n[[/math]]\n" + case hasClass(n, "wiki-note"): + return "[[note]]\n" + c.children(n) + "[[/note]]\n" + } + return c.plainDiv(n) +} + +func (c *converter) plainDiv(n *html.Node) string { + return "[[div" + attrs(n) + "]]\n" + c.children(n) + "[[/div]]\n" +} + +func (c *converter) collapsible(n *html.Node) string { + show := oneLine(text(find(find(n, "div", "collapsible-block-folded"), "a", "collapsible-block-link"))) + hide := oneLine(text(find(find(find(n, "div", "collapsible-block-unfolded"), + "div", "collapsible-block-unfolded-link"), "a", "collapsible-block-link"))) + return "[[collapsible show=\"" + escapeValue(show) + "\" hide=\"" + escapeValue(hide) + "\"]]\n" + + c.children(find(n, "div", "collapsible-block-content")) + "[[/collapsible]]\n" +} + +func (c *converter) tabview(n *html.Node) string { + var titles []string + for _, li := range findAll(find(n, "ul", "yui-nav"), "li", "") { + titles = append(titles, oneLine(text(li))) + } + var b strings.Builder + b.WriteString("[[tabview]]\n") + for i, tab := range findAll(find(n, "div", "yui-content"), "div", "") { + title := "" + if i < len(titles) { + title = titles[i] + } + b.WriteString("[[tab title=\"" + escapeValue(title) + "\"]]\n") + b.WriteString(c.children(tab)) + b.WriteString("[[/tab]]\n") + } + b.WriteString("[[/tabview]]\n") + return b.String() +} + +func (c *converter) code(n *html.Node) string { + if pre := find(n, "pre", ""); pre != nil { + if code := find(pre, "code", ""); code != nil { + return "[[code]]\n" + text(code) + "\n[[/code]]\n" + } + } + if main := find(n, "div", "hl-main"); main != nil { + if pre := find(main, "pre", ""); pre != nil { + return "[[code]]\n" + text(pre) + "\n[[/code]]\n" + } + } + return c.plainDiv(n) +} + +func (c *converter) bibliography(n *html.Node) string { + var b strings.Builder + b.WriteString("[[bibliography title=\"" + escapeValue(oneLine(text(find(n, "div", "title")))) + "\"]]\n") + for i, item := range findAll(n, "div", "bibitem") { + b.WriteString(": cite" + itoa(i+1) + " : " + strings.TrimSpace(cutLabel(c.children(item))) + "\n") + } + b.WriteString("[[/bibliography]]\n") + return b.String() +} + +var imagePrefixes = [][2]string{ + {"floatleft", "f<"}, {"floatright", "f>"}, + {"alignleft", "<"}, {"alignright", ">"}, {"aligncenter", "="}, +} + +func (c *converter) image(n *html.Node) string { + prefix := "" + for _, pair := range imagePrefixes { + if hasClass(n, pair[0]) { + prefix = pair[1] + } + } + img := find(n, "img", "") + if img == nil { + return c.plainDiv(n) + } + return "[[" + prefix + "image " + attr(img, "src") + attrs(img, "src", "alt") + "]]" +} + +func definitions(n *html.Node) string { + var b strings.Builder + for child := n.FirstChild; child != nil; child = child.NextSibling { + if child.Type != html.ElementNode || child.Data != "dt" { + continue + } + value := "" + for after := child.NextSibling; after != nil; after = after.NextSibling { + if after.Type == html.ElementNode && after.Data == "dd" { + value = text(after) + break + } + } + b.WriteString(": " + spaced(text(child)) + " : " + spaced(value) + "\n") + } + return b.String() +} + +// The number a bibliography item opens with belongs to the list rather than to +// the text, so the first two characters go. +func cutLabel(s string) string { + if len(s) > 2 { + return s[2:] + } + return s +} diff --git a/internal/htmlsource/htmlsource_test.go b/internal/htmlsource/htmlsource_test.go new file mode 100644 index 00000000..080f7f6e --- /dev/null +++ b/internal/htmlsource/htmlsource_test.go @@ -0,0 +1,69 @@ +package htmlsource + +import ( + "os" + "strings" + "testing" +) + +func split(body string) []struct{ Name, Text string } { + var out []struct{ Name, Text string } + name := "" + var lines []string + flush := func() { + if name == "" { + return + } + out = append(out, struct{ Name, Text string }{name, strings.Join(lines, "\n")}) + } + for _, line := range strings.Split(strings.ReplaceAll(body, "\r\n", "\n"), "\n") { + if strings.HasPrefix(line, "=== ") && strings.HasSuffix(line, " ===") { + flush() + name = strings.TrimSuffix(strings.TrimPrefix(line, "=== "), " ===") + lines = nil + continue + } + if name != "" { + lines = append(lines, line) + } + } + flush() + return out +} + +func TestConvertMatchesGolden(t *testing.T) { + cases, err := os.ReadFile("testdata/cases.html") + if err != nil { + t.Fatalf("ReadFile(cases) err = %v, want nil", err) + } + golden, err := os.ReadFile("testdata/html.golden") + if err != nil { + t.Fatalf("ReadFile(golden) err = %v, want nil", err) + } + + want := map[string]string{} + for _, one := range split(string(golden)) { + want[one.Name] = one.Text + } + for _, one := range split(string(cases)) { + expected, ok := want[one.Name] + if !ok { + t.Errorf("golden has no case %q, want one", one.Name) + continue + } + got := Convert(strings.Trim(one.Text, "\n")) + if strings.TrimRight(got, "\n") != strings.TrimRight(expected, "\n") { + t.Errorf("Convert(%s) = %q, want %q", one.Name, got, expected) + } + } +} + +func TestGoldenCoversEveryCase(t *testing.T) { + cases, err := os.ReadFile("testdata/cases.html") + if err != nil { + t.Fatalf("ReadFile(cases) err = %v, want nil", err) + } + if got := len(split(string(cases))); got < 30 { + t.Errorf("len(cases) = %d, want at least 30", got) + } +} diff --git a/internal/htmlsource/nodes.go b/internal/htmlsource/nodes.go new file mode 100644 index 00000000..b7f48828 --- /dev/null +++ b/internal/htmlsource/nodes.go @@ -0,0 +1,160 @@ +package htmlsource + +import ( + "strconv" + "strings" + + "golang.org/x/net/html" +) + +func attr(n *html.Node, name string) string { + if n == nil { + return "" + } + for _, a := range n.Attr { + if a.Key == name { + return a.Val + } + } + return "" +} + +// attrs writes every attribute back in the order it was parsed, which is the +// order it was written, so a round trip does not reshuffle a tag. +func attrs(n *html.Node, skip ...string) string { + var b strings.Builder + for _, a := range n.Attr { + if contains(skip, a.Key) { + continue + } + b.WriteString(" " + a.Key + `="` + escapeValue(a.Val) + `"`) + } + return b.String() +} + +func escapeValue(v string) string { + v = strings.ReplaceAll(v, `\`, `\\`) + return strings.ReplaceAll(v, `"`, `\"`) +} + +func classes(n *html.Node) []string { + if n == nil { + return nil + } + return strings.Fields(attr(n, "class")) +} + +func hasAnyClass(n *html.Node) bool { return len(classes(n)) > 0 } + +func hasClass(n *html.Node, want ...string) bool { + held := classes(n) + for _, one := range want { + if contains(held, one) { + return true + } + } + return false +} + +func contains(list []string, want string) bool { + for _, one := range list { + if one == want { + return true + } + } + return false +} + +func find(n *html.Node, tag, class string) *html.Node { + if n == nil { + return nil + } + for child := n.FirstChild; child != nil; child = child.NextSibling { + if matches(child, tag, class) { + return child + } + if found := find(child, tag, class); found != nil { + return found + } + } + return nil +} + +func findAll(n *html.Node, tag, class string) []*html.Node { + if n == nil { + return nil + } + var out []*html.Node + for child := n.FirstChild; child != nil; child = child.NextSibling { + if matches(child, tag, class) { + out = append(out, child) + continue + } + out = append(out, findAll(child, tag, class)...) + } + return out +} + +func matches(n *html.Node, tag, class string) bool { + if n.Type != html.ElementNode || n.Data != tag { + return false + } + return class == "" || hasClass(n, class) +} + +func text(n *html.Node) string { + if n == nil { + return "" + } + var b strings.Builder + var walk func(*html.Node) + walk = func(node *html.Node) { + if node.Type == html.TextNode { + b.WriteString(node.Data) + } + for child := node.FirstChild; child != nil; child = child.NextSibling { + walk(child) + } + } + walk(n) + return b.String() +} + +func oneLine(s string) string { + return strings.TrimSpace(strings.ReplaceAll(s, "\n", " ")) +} + +func spaced(s string) string { return strings.ReplaceAll(s, "\n", " ") } + +func itoa(n int) string { return strconv.Itoa(n) } + +func userName(n *html.Node) string { + href := attr(find(n, "a", ""), "href") + if cut := strings.LastIndex(href, "/"); cut >= 0 { + return href[cut+1:] + } + return href +} + +// Every reference in the document reaches for the same block at the end of it, +// so the bodies are collected once. +func (c *converter) footnotesFrom(root *html.Node) { + block := root + if !matches(root, "div", "footnotes-footer") { + block = find(root, "div", "footnotes-footer") + } + if block == nil { + return + } + if c.footnotes == nil { + c.footnotes = map[string]string{} + } + for _, note := range findAll(block, "div", "footnote-footer") { + link := find(note, "a", "") + number := strings.TrimSpace(text(link)) + if link != nil && link.Parent != nil { + link.Parent.RemoveChild(link) + } + c.footnotes[number] = strings.TrimSpace(cutLabel(c.children(note))) + } +} From 01b877dd4a24d6bcb4ec00a9ae141216a44fb547 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 15:50:03 +0900 Subject: [PATCH 359/428] import the attachments and the forum of a backup --- cmd/pwikit/main.go | 24 +++- internal/archive/archive.go | 1 + internal/archive/files.go | 81 ++++++++++++++ internal/archive/forum.go | 134 ++++++++++++++++++++++ internal/archive/forum_import.go | 153 +++++++++++++++++++++++++ internal/archive/forum_import_test.go | 93 ++++++++++++++++ internal/archive/import.go | 75 +++++++++---- internal/db/archive_write.go | 154 ++++++++++++++++++++++++-- 8 files changed, 679 insertions(+), 36 deletions(-) create mode 100644 internal/archive/files.go create mode 100644 internal/archive/forum.go create mode 100644 internal/archive/forum_import.go create mode 100644 internal/archive/forum_import_test.go diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index fe125555..6ac8b4f6 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -395,6 +395,8 @@ func seedPages(args []string) error { from := fs.String("from", "", "slug of the site inside the archive; needed when it holds more than one") forceTags := fs.Bool("force-tags", false, "create tags this site would otherwise refuse") noVotes := fs.Bool("no-votes", false, "leave the ratings behind") + noFiles := fs.Bool("no-files", false, "leave the attachments behind") + dataDir := fs.String("data-dir", "", "state directory attachments are copied into; defaults to the directory holding the executable") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -418,7 +420,18 @@ func seedPages(args []string) error { } if *archivePath != "" { - return importArchive(ctx, conn, current, *archivePath, *from, *forceTags, !*noVotes) + files := "" + if !*noFiles { + p, err := paths.New(*dataDir) + if err != nil { + return err + } + if err := p.EnsureBase(); err != nil { + return err + } + files = p.Files() + } + return importArchive(ctx, conn, current, *archivePath, *from, *forceTags, !*noVotes, files) } written, err := seed.Run(ctx, conn, current.ID) @@ -586,7 +599,7 @@ func resolveSite(ctx context.Context, conn *db.DB, slug string) (*db.Site, error } func importArchive(ctx context.Context, conn *db.DB, current *db.Site, path, from string, - forceTags, votes bool) error { + forceTags, votes bool, files string) error { found, err := archive.Open(path) if err != nil { @@ -613,9 +626,12 @@ func importArchive(ctx context.Context, conn *db.DB, current *db.Site, path, fro result, err := archive.ImportPages(ctx, conn, current.ID, found, from, archive.Options{ ForceTags: forceTags, Votes: votes, + Files: files, Report: func(line string) { fmt.Println(line) }, }) - fmt.Printf("%d pages written, %d already there, %d revisions, %d parents, %d accounts\n", - result.Pages, result.Skipped, result.Revisions, result.Parents, result.Users) + fmt.Printf("%d pages, %d already there, %d revisions, %d parents, %d files, %d accounts\n", + result.Pages, result.Skipped, result.Revisions, result.Parents, result.Files, result.Users) + fmt.Printf("%d forum categories, %d threads, %d posts\n", + result.Categories, result.Threads, result.Posts) return err } diff --git a/internal/archive/archive.go b/internal/archive/archive.go index aa6463ef..60ba0025 100644 --- a/internal/archive/archive.go +++ b/internal/archive/archive.go @@ -109,6 +109,7 @@ type Page struct { Rating float64 `json:"rating"` Locked bool `json:"is_locked"` PageID int64 `json:"page_id"` + ThreadID int64 `json:"forum_thread"` Revisions []Revision `json:"revisions"` Votings []Vote `json:"votings"` Files []File `json:"files"` diff --git a/internal/archive/files.go b/internal/archive/files.go new file mode 100644 index 00000000..98cca81e --- /dev/null +++ b/internal/archive/files.go @@ -0,0 +1,81 @@ +package archive + +import ( + "context" + "fmt" + "io" + "os" + "path/filepath" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/media" +) + +func (im *importer) importFiles(ctx context.Context, page Page, articleID int64, articleMedia string) (int, error) { + if im.opts.Files == "" || len(page.Files) == 0 { + return 0, nil + } + written := 0 + for _, file := range page.Files { + from := im.archive.FilePath(im.slug, page.Name, file.ID) + if from == "" { + report(im.opts, fmt.Sprintf("missing attachment %s/%s", page.Name, file.Name)) + continue + } + stored, err := storedName(file.Name) + if err != nil { + return written, err + } + to := filepath.Join(im.opts.Files, "media", + media.QuoteName(articleMedia), media.QuoteName(stored)) + if err := copyFile(from, to); err != nil { + return written, err + } + _, err = im.db.AddArticleFile(ctx, db.FileWrite{ + ArticleID: articleID, + Name: file.Name, + MediaName: stored, + MimeType: file.Mime, + Size: file.Size, + AuthorID: localUser(im.users, file.Author), + At: time.Unix(file.Stamp, 0).UTC(), + }) + if err != nil { + return written, err + } + written++ + } + return written, nil +} + +// The stored name keeps the extension and nothing else, because the name a +// visitor typed is answered from the database rather than from the disk. +func storedName(name string) (string, error) { + unique, err := db.MediaName() + if err != nil { + return "", err + } + return unique + filepath.Ext(name), nil +} + +func copyFile(from, to string) error { + if err := os.MkdirAll(filepath.Dir(to), 0o755); err != nil { + return err + } + in, err := os.Open(from) + if err != nil { + return err + } + defer in.Close() + + out, err := os.Create(to) + if err != nil { + return err + } + if _, err := io.Copy(out, in); err != nil { + out.Close() + return err + } + return out.Close() +} diff --git a/internal/archive/forum.go b/internal/archive/forum.go new file mode 100644 index 00000000..dded1c5f --- /dev/null +++ b/internal/archive/forum.go @@ -0,0 +1,134 @@ +package archive + +import ( + "encoding/json" + "fmt" + "os" + "path/filepath" + "sort" + "strconv" + "strings" + + "github.com/bodgit/sevenzip" +) + +const ( + forumDir = "forum" + categoryDir = "category" + postBodyFile = "latest.html" +) + +type Category struct { + ID int64 `json:"id"` + Title string `json:"title"` + Description string `json:"description"` +} + +type Thread struct { + ID int64 `json:"id"` + CategoryID int64 `json:"-"` + Title string `json:"title"` + Description string `json:"description"` + Started int64 `json:"started"` + StartedUser *int64 `json:"startedUser"` + Last int64 `json:"last"` + Sticky bool `json:"sticky"` + Locked bool `json:"isLocked"` + Posts []Post `json:"posts"` +} + +type Post struct { + ID int64 `json:"id"` + Title string `json:"title"` + Poster int64 `json:"poster"` + Stamp int64 `json:"stamp"` + Revisions []PostRevision `json:"revisions"` + Children []Post `json:"children"` +} + +type PostRevision struct { + ID int64 `json:"id"` + Title string `json:"title"` + Author int64 `json:"author"` + Stamp int64 `json:"stamp"` +} + +func (a *Archive) Categories(slug string) ([]Category, error) { + dir, ok := a.find(slug, metaDir, forumDir, categoryDir) + if !ok { + return nil, nil + } + entries, err := os.ReadDir(dir) + if err != nil { + return nil, err + } + var out []Category + for _, e := range entries { + if e.IsDir() || !strings.HasSuffix(e.Name(), pageSufix) { + continue + } + body, err := os.ReadFile(filepath.Join(dir, e.Name())) + if err != nil { + return nil, err + } + var c Category + if err := json.Unmarshal(body, &c); err != nil { + return nil, fmt.Errorf("read the forum category %q: %w", e.Name(), err) + } + out = append(out, c) + } + sort.Slice(out, func(i, j int) bool { return out[i].ID < out[j].ID }) + return out, nil +} + +func (a *Archive) Threads(slug string, categoryID int64) ([]Thread, error) { + dir, ok := a.find(slug, metaDir, forumDir, strconv.FormatInt(categoryID, 10)) + if !ok { + return nil, nil + } + entries, err := os.ReadDir(dir) + if err != nil { + return nil, err + } + var out []Thread + for _, e := range entries { + if e.IsDir() || !strings.HasSuffix(e.Name(), pageSufix) { + continue + } + body, err := os.ReadFile(filepath.Join(dir, e.Name())) + if err != nil { + return nil, err + } + var t Thread + if err := json.Unmarshal(body, &t); err != nil { + return nil, fmt.Errorf("read the forum thread %q: %w", e.Name(), err) + } + t.CategoryID = categoryID + out = append(out, t) + } + sort.Slice(out, func(i, j int) bool { return out[i].Started < out[j].Started }) + return out, nil +} + +func (a *Archive) PostBodies(slug string, thread Thread) (map[string]string, error) { + out := map[string]string{} + path, ok := a.find(slug, forumDir, strconv.FormatInt(thread.CategoryID, 10), + strconv.FormatInt(thread.ID, 10)+sourceExt) + if !ok { + return out, nil + } + reader, err := sevenzip.OpenReader(path) + if err != nil { + return out, nil + } + defer reader.Close() + + for _, entry := range reader.File { + body, err := readEntry(entry) + if err != nil { + return nil, fmt.Errorf("read %s of thread %d: %w", entry.Name, thread.ID, err) + } + out[filepath.ToSlash(entry.Name)] = body + } + return out, nil +} diff --git a/internal/archive/forum_import.go b/internal/archive/forum_import.go new file mode 100644 index 00000000..75263312 --- /dev/null +++ b/internal/archive/forum_import.go @@ -0,0 +1,153 @@ +package archive + +import ( + "context" + "fmt" + "sort" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/htmlsource" +) + +const importedSection = "Imported" + +// A thread carries no name a second run could recognise, so a site that already +// has a section is left alone rather than doubled. +func (im *importer) importForum(ctx context.Context, byArchiveThread map[int64]int64, out *Result) error { + categories, err := im.archive.Categories(im.slug) + if err != nil || len(categories) == 0 { + return err + } + sections, err := im.db.AdminForumSections(ctx, im.siteID) + if err != nil { + return err + } + if len(sections) > 0 { + report(im.opts, "the site already has a forum, leaving it alone") + return nil + } + + threads := make(map[int64][]Thread, len(categories)) + for _, category := range categories { + found, err := im.archive.Threads(im.slug, category.ID) + if err != nil { + return err + } + threads[category.ID] = found + } + + sectionID, err := im.db.ImportForumSection(ctx, im.siteID, importedSection, "") + if err != nil { + return err + } + + for order, category := range categories { + comments := 0 + for _, thread := range threads[category.ID] { + if _, ok := byArchiveThread[thread.ID]; ok { + comments++ + } + } + localCategory, err := im.db.ImportForumCategory(ctx, im.siteID, sectionID, + category.Title, category.Description, order, comments*2 > len(threads[category.ID])) + if err != nil { + return err + } + out.Categories++ + + for _, thread := range threads[category.ID] { + posts, err := im.importThread(ctx, thread, localCategory, byArchiveThread) + if err != nil { + return err + } + out.Threads++ + out.Posts += posts + if out.Threads%100 == 0 { + report(im.opts, fmt.Sprintf("%d threads, %d posts", out.Threads, out.Posts)) + } + } + } + return nil +} + +func (im *importer) importThread(ctx context.Context, thread Thread, categoryID int64, + byArchiveThread map[int64]int64) (int, error) { + + bodies, err := im.archive.PostBodies(im.slug, thread) + if err != nil { + return 0, err + } + posts, parents := im.flatten(thread.Posts, -1, nil, nil, bodies) + + write := db.ImportThread{ + CategoryID: &categoryID, + Name: thread.Title, + Description: thread.Description, + AuthorID: localUser(im.users, started(thread)), + CreatedAt: time.Unix(thread.Started, 0).UTC(), + UpdatedAt: time.Unix(thread.Last, 0).UTC(), + Pinned: thread.Sticky, + Locked: thread.Locked, + } + if article, ok := byArchiveThread[thread.ID]; ok { + write.CategoryID = nil + write.ArticleID = &article + } + return im.db.ImportForumThread(ctx, im.siteID, write, posts, parents) +} + +func (im *importer) flatten(tree []Post, parent int, posts []db.ImportPost, parents []int, + bodies map[string]string) ([]db.ImportPost, []int) { + + for _, post := range tree { + posts = append(posts, db.ImportPost{ + Name: post.Title, + AuthorID: localUser(im.users, post.Poster), + CreatedAt: time.Unix(post.Stamp, 0).UTC(), + Versions: im.versions(post, bodies), + }) + parents = append(parents, parent) + posts, parents = im.flatten(post.Children, len(posts)-1, posts, parents, bodies) + } + return posts, parents +} + +func (im *importer) versions(post Post, bodies map[string]string) []db.ImportPostVersion { + if len(post.Revisions) == 0 { + return []db.ImportPostVersion{{ + Source: body(bodies, fmt.Sprintf("%d/%s", post.ID, postBodyFile)), + AuthorID: localUser(im.users, post.Poster), + At: time.Unix(post.Stamp, 0).UTC(), + }} + } + revisions := append([]PostRevision(nil), post.Revisions...) + sort.SliceStable(revisions, func(i, j int) bool { return revisions[i].Stamp < revisions[j].Stamp }) + + out := make([]db.ImportPostVersion, 0, len(revisions)) + for _, revision := range revisions { + out = append(out, db.ImportPostVersion{ + Source: body(bodies, fmt.Sprintf("%d/%d.html", post.ID, revision.ID)), + AuthorID: localUser(im.users, revision.Author), + At: time.Unix(revision.Stamp, 0).UTC(), + }) + } + return out +} + +// The archive pads a post with the layout whitespace it was served inside, and +// wikitext reads leading whitespace as markup. +func body(bodies map[string]string, key string) string { + return strings.TrimSpace(htmlsource.Convert(bodies[key])) +} + +func started(thread Thread) int64 { + if thread.StartedUser != nil { + return *thread.StartedUser + } + if len(thread.Posts) > 0 { + return thread.Posts[0].Poster + } + return 0 +} diff --git a/internal/archive/forum_import_test.go b/internal/archive/forum_import_test.go new file mode 100644 index 00000000..058dc15c --- /dev/null +++ b/internal/archive/forum_import_test.go @@ -0,0 +1,93 @@ +package archive + +import ( + "testing" +) + +func TestFlattenNamesEveryParentAheadOfItsChildren(t *testing.T) { + tree := []Post{ + {ID: 1, Title: "a", Children: []Post{ + {ID: 2, Title: "b", Children: []Post{{ID: 3, Title: "c"}}}, + {ID: 4, Title: "d"}, + }}, + {ID: 5, Title: "e"}, + } + im := &importer{} + posts, parents := im.flatten(tree, -1, nil, nil, map[string]string{}) + + wantNames := []string{"a", "b", "c", "d", "e"} + if len(posts) != len(wantNames) { + t.Fatalf("len(flatten) = %d, want %d", len(posts), len(wantNames)) + } + for i, want := range wantNames { + if posts[i].Name != want { + t.Errorf("flatten()[%d].Name = %q, want %q", i, posts[i].Name, want) + } + } + wantParents := []int{-1, 0, 1, 0, -1} + for i, want := range wantParents { + if parents[i] != want { + t.Errorf("flatten() parent of %q = %d, want %d", posts[i].Name, parents[i], want) + } + if parents[i] >= i { + t.Errorf("flatten() parent of %q = %d, want less than %d", posts[i].Name, parents[i], i) + } + } +} + +func TestVersionsReadOldestFirst(t *testing.T) { + post := Post{ + ID: 7, + Stamp: 100, + Revisions: []PostRevision{ + {ID: 30, Stamp: 300}, + {ID: 20, Stamp: 200}, + {ID: 10, Stamp: 100}, + }, + } + bodies := map[string]string{ + "7/10.html": "

one

", + "7/20.html": "

two

", + "7/30.html": "

three

", + "7/latest.html": "

three

", + } + im := &importer{} + got := im.versions(post, bodies) + + want := []string{"one", "two", "three"} + if len(got) != len(want) { + t.Fatalf("len(versions) = %d, want %d", len(got), len(want)) + } + for i, text := range want { + if got[i].Source != text { + t.Errorf("versions()[%d].Source = %q, want %q", i, got[i].Source, text) + } + if got[i].At.Unix() != int64(100*(i+1)) { + t.Errorf("versions()[%d].At = %d, want %d", i, got[i].At.Unix(), 100*(i+1)) + } + } +} + +func TestVersionsFallsBackToTheLatestBody(t *testing.T) { + im := &importer{} + got := im.versions(Post{ID: 7, Stamp: 100}, map[string]string{"7/latest.html": "\n\t

only

\n"}) + if len(got) != 1 { + t.Fatalf("len(versions) = %d, want 1", len(got)) + } + if got[0].Source != "only" { + t.Errorf("versions()[0].Source = %q, want %q", got[0].Source, "only") + } +} + +func TestStartedFallsBackToTheFirstPoster(t *testing.T) { + author := int64(11) + if got := started(Thread{StartedUser: &author}); got != 11 { + t.Errorf("started(with startedUser) = %d, want 11", got) + } + if got := started(Thread{Posts: []Post{{Poster: 22}}}); got != 22 { + t.Errorf("started(without startedUser) = %d, want 22", got) + } + if got := started(Thread{}); got != 0 { + t.Errorf("started(empty) = %d, want 0", got) + } +} diff --git a/internal/archive/import.go b/internal/archive/import.go index d080ca19..e3c8c33a 100644 --- a/internal/archive/import.go +++ b/internal/archive/import.go @@ -19,6 +19,10 @@ type Options struct { // owner most often means to start over. Votes bool + // Files is the state directory attachments are copied into. Empty leaves + // them behind. + Files string + // Report is called with a line worth showing while a long import runs. Report func(string) } @@ -29,43 +33,68 @@ type Result struct { Skipped int Revisions int Parents int + Files int + + Categories int + Threads int + Posts int +} + +type importer struct { + db *db.DB + archive *Archive + slug string + siteID int64 + opts Options + users map[int64]int64 } // ImportPages writes the pages of one site in the archive, skipping any page the // database already has. Nothing already here is edited. func ImportPages(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug string, opts Options) (Result, error) { var out Result + im := &importer{db: d, archive: a, slug: slug, siteID: siteID, opts: opts} pages, err := a.Pages(slug) if err != nil { return out, err } - byWikidot, err := importUsers(ctx, d, a) + im.users, err = im.importUsers(ctx) if err != nil { return out, err } - out.Users = len(byWikidot) + out.Users = len(im.users) report(opts, fmt.Sprintf("%d accounts, %d pages", out.Users, len(pages))) local := make(map[string]int64, len(pages)) + byThread := map[int64]int64{} for _, page := range pages { existing, err := d.ArticleByName(ctx, siteID, page.Name) if err == nil { out.Skipped++ local[wikidot.Normalize(page.Name)] = existing.ID + byThread[page.ThreadID] = existing.ID continue } if !errors.Is(err, db.ErrNotFound) { return out, err } - id, revisions, err := importPage(ctx, d, siteID, a, slug, page, byWikidot, opts) + id, media, revisions, err := im.importPage(ctx, page) if err != nil { return out, err } local[wikidot.Normalize(page.Name)] = id + byThread[page.ThreadID] = id out.Pages++ out.Revisions += revisions + + files, err := im.importFiles(ctx, page, id, media) + if err != nil { + return out, err + } + out.Files += files + if out.Pages%200 == 0 { report(opts, fmt.Sprintf("%d of %d pages", out.Pages, len(pages))) } @@ -88,11 +117,16 @@ func ImportPages(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug s } out.Parents++ } + + delete(byThread, 0) + if err := im.importForum(ctx, byThread, &out); err != nil { + return out, err + } return out, nil } -func importUsers(ctx context.Context, d *db.DB, a *Archive) (map[int64]int64, error) { - found, err := a.Users() +func (im *importer) importUsers(ctx context.Context) (map[int64]int64, error) { + found, err := im.archive.Users() if err != nil { return nil, err } @@ -104,15 +138,13 @@ func importUsers(ctx context.Context, d *db.DB, a *Archive) (map[int64]int64, er DisplayName: u.FullName, }) } - return d.EnsureWikidotUsers(ctx, list, time.Now().UTC()) + return im.db.EnsureWikidotUsers(ctx, list, time.Now().UTC()) } -func importPage(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug string, - page Page, byWikidot map[int64]int64, opts Options) (int64, int, error) { - - sources, err := a.Sources(slug, page) +func (im *importer) importPage(ctx context.Context, page Page) (int64, string, int, error) { + sources, err := im.archive.Sources(im.slug, page) if err != nil { - return 0, 0, err + return 0, "", 0, err } category, name := wikidot.Split(wikidot.Normalize(page.Name)) @@ -126,7 +158,7 @@ func importPage(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug st Locked: page.Locked, CreatedAt: time.Unix(oldest.Stamp, 0).UTC(), UpdatedAt: time.Unix(newest.Stamp, 0).UTC(), - AuthorID: localUser(byWikidot, oldest.Author), + AuthorID: localUser(im.users, oldest.Author), } // The archive lists the newest revision first and the history reads the @@ -135,7 +167,7 @@ func importPage(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug st rev := page.Revisions[i] one := db.ImportRevision{ Number: rev.Number, - UserID: localUser(byWikidot, rev.Author), + UserID: localUser(im.users, rev.Author), Comment: rev.Comment, At: time.Unix(rev.Stamp, 0).UTC(), IsNew: rev.IsNew(), @@ -144,11 +176,14 @@ func importPage(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug st one.Source = &source } write.Revisions = append(write.Revisions, one) + if one.Source != nil { + write.Indexed = *one.Source + } } - if opts.Votes { + if im.opts.Votes { for _, vote := range page.Votings { - user := localUser(byWikidot, vote.UserID) + user := localUser(im.users, vote.UserID) if user == nil { continue } @@ -156,18 +191,18 @@ func importPage(ctx context.Context, d *db.DB, siteID int64, a *Archive, slug st } } if len(page.Tags) > 0 { - ids, err := d.EnsureTags(ctx, siteID, page.Tags, opts.ForceTags) + ids, err := im.db.EnsureTags(ctx, im.siteID, page.Tags, im.opts.ForceTags) if err != nil { - return 0, 0, err + return 0, "", 0, err } write.TagIDs = ids } - id, err := d.ImportArticle(ctx, siteID, write) + id, media, err := im.db.ImportArticle(ctx, im.siteID, write) if err != nil { - return 0, 0, err + return 0, "", 0, err } - return id, len(write.Revisions), nil + return id, media, len(write.Revisions), nil } // An author the archive never described is left off rather than invented, which diff --git a/internal/db/archive_write.go b/internal/db/archive_write.go index 93a1a2ef..cfb807f2 100644 --- a/internal/db/archive_write.go +++ b/internal/db/archive_write.go @@ -158,6 +158,10 @@ type ImportArticle struct { UpdatedAt time.Time AuthorID *int64 + // Indexed is the newest source. The import has no renderer, so the raw text + // stands in for the rendering until the page is next edited. + Indexed string + Revisions []ImportRevision Votes []ImportVote TagIDs []int64 @@ -187,15 +191,15 @@ ON CONFLICT DO NOTHING`) // ImportArticle writes one page and its whole history as the archive recorded // it. It goes around the ordinary save path on purpose, since that one renumbers // revisions, rebuilds links and tells subscribers about every one of them. -func (d *DB) ImportArticle(ctx context.Context, siteID int64, a ImportArticle) (int64, error) { +func (d *DB) ImportArticle(ctx context.Context, siteID int64, a ImportArticle) (int64, string, error) { media, err := mediaName() if err != nil { - return 0, err + return 0, "", err } tx, err := d.pool.Begin(ctx) if err != nil { - return 0, fmt.Errorf("begin importing %q: %w", a.Name, err) + return 0, "", fmt.Errorf("begin importing %q: %w", a.Name, err) } defer tx.Rollback(context.WithoutCancel(ctx)) @@ -203,11 +207,11 @@ func (d *DB) ImportArticle(ctx context.Context, siteID int64, a ImportArticle) ( err = tx.QueryRow(ctx, qImportArticle, siteID, a.Category, a.Name, a.Title, a.Locked, a.CreatedAt, a.UpdatedAt, media).Scan(&id) if err != nil { - return 0, fmt.Errorf("import article %q: %w", a.Name, err) + return 0, "", fmt.Errorf("import article %q: %w", a.Name, err) } if a.AuthorID != nil { if _, err := tx.Exec(ctx, qInsertArticleAuthor, id, *a.AuthorID); err != nil { - return 0, fmt.Errorf("credit the author of %q: %w", a.Name, err) + return 0, "", fmt.Errorf("credit the author of %q: %w", a.Name, err) } } @@ -218,7 +222,7 @@ func (d *DB) ImportArticle(ctx context.Context, siteID int64, a ImportArticle) ( var versionID int64 err := tx.QueryRow(ctx, qInsertArticleVersion, id, *rev.Source, rev.At).Scan(&versionID) if err != nil { - return 0, fmt.Errorf("import a version of %q: %w", a.Name, err) + return 0, "", fmt.Errorf("import a version of %q: %w", a.Name, err) } kind = LogSource meta["version_id"] = versionID @@ -229,29 +233,36 @@ func (d *DB) ImportArticle(ctx context.Context, siteID int64, a ImportArticle) ( } encoded, err := json.Marshal(meta) if err != nil { - return 0, err + return 0, "", err } _, err = tx.Exec(ctx, qImportLogEntry, id, rev.UserID, kind, encoded, rev.Comment, rev.At, rev.Number) if err != nil { - return 0, fmt.Errorf("import a revision of %q: %w", a.Name, err) + return 0, "", fmt.Errorf("import a revision of %q: %w", a.Name, err) + } + } + + if a.Indexed != "" { + text := a.Title + "\n\n" + a.Indexed + if _, err := tx.Exec(ctx, qInsertSearchIndex, id, text, text); err != nil { + return 0, "", fmt.Errorf("index %q: %w", a.Name, err) } } for _, vote := range a.Votes { if _, err := tx.Exec(ctx, qImportVote, id, vote.UserID, vote.Rate); err != nil { - return 0, fmt.Errorf("import a vote on %q: %w", a.Name, err) + return 0, "", fmt.Errorf("import a vote on %q: %w", a.Name, err) } } for _, tagID := range a.TagIDs { if _, err := tx.Exec(ctx, qImportArticleTag, id, tagID); err != nil { - return 0, fmt.Errorf("tag %q: %w", a.Name, err) + return 0, "", fmt.Errorf("tag %q: %w", a.Name, err) } } if err := tx.Commit(ctx); err != nil { - return 0, fmt.Errorf("commit %q: %w", a.Name, err) + return 0, "", fmt.Errorf("commit %q: %w", a.Name, err) } - return id, nil + return id, media, nil } var qImportParent = register("ImportParent", ` @@ -292,3 +303,122 @@ func (d *DB) EnsureTags(ctx context.Context, siteID int64, names []string, allow } return out, nil } + +// MediaName picks the name a file is stored under, which an importer needs +// before it copies the bytes into place. +func MediaName() (string, error) { return mediaName() } + +type ImportThread struct { + CategoryID *int64 + ArticleID *int64 + Name string + Description string + AuthorID *int64 + CreatedAt time.Time + UpdatedAt time.Time + Pinned bool + Locked bool +} + +type ImportPost struct { + Name string + AuthorID *int64 + ReplyTo *int64 + CreatedAt time.Time + Versions []ImportPostVersion +} + +type ImportPostVersion struct { + Source string + AuthorID *int64 + At time.Time +} + +var ( + qImportThread = register("ImportThread", ` +INSERT INTO web_forumthread (site_id, category_id, article_id, name, description, author_id, + created_at, updated_at, is_pinned, is_locked) +VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10) +RETURNING id`) + + qImportPost = register("ImportPost", ` +INSERT INTO web_forumpost (thread_id, name, author_id, reply_to_id, created_at, updated_at) +VALUES ($1, $2, $3, $4, $5, $6) +RETURNING id`) + + qImportPostVersion = register("ImportPostVersion", ` +INSERT INTO web_forumpostversion (post_id, source, author_id, created_at) +VALUES ($1, $2, $3, $4)`) +) + +func (d *DB) ImportForumSection(ctx context.Context, siteID int64, name, description string) (int64, error) { + var id int64 + err := d.pool.QueryRow(ctx, qInsertForumSection, name, description, 0, false, false, siteID).Scan(&id) + if err != nil { + return 0, fmt.Errorf("create the imported forum section: %w", err) + } + return id, nil +} + +func (d *DB) ImportForumCategory(ctx context.Context, siteID, sectionID int64, name, description string, + order int, forComments bool) (int64, error) { + + var id int64 + err := d.pool.QueryRow(ctx, qInsertForumCategory, name, description, order, forComments, sectionID, siteID).Scan(&id) + if err != nil { + return 0, fmt.Errorf("create the imported forum category %q: %w", name, err) + } + return id, nil +} + +// ImportForumThread writes a thread and its posts together. A reply names its +// parent by the position the parent holds in posts, so the caller flattens the +// tree with every parent ahead of its children. +func (d *DB) ImportForumThread(ctx context.Context, siteID int64, t ImportThread, posts []ImportPost, + parents []int) (int, error) { + + tx, err := d.pool.Begin(ctx) + if err != nil { + return 0, fmt.Errorf("begin importing a thread: %w", err) + } + defer tx.Rollback(context.WithoutCancel(ctx)) + + var threadID int64 + err = tx.QueryRow(ctx, qImportThread, siteID, t.CategoryID, t.ArticleID, t.Name, t.Description, + t.AuthorID, t.CreatedAt, t.UpdatedAt, t.Pinned, t.Locked).Scan(&threadID) + if err != nil { + return 0, fmt.Errorf("import the thread %q: %w", t.Name, err) + } + + ids := make([]int64, len(posts)) + written := 0 + for i, post := range posts { + var replyTo *int64 + if parents[i] >= 0 { + replyTo = &ids[parents[i]] + } + updated := post.CreatedAt + if n := len(post.Versions); n > 0 { + updated = post.Versions[n-1].At + } + var postID int64 + err := tx.QueryRow(ctx, qImportPost, threadID, post.Name, post.AuthorID, replyTo, + post.CreatedAt, updated).Scan(&postID) + if err != nil { + return written, fmt.Errorf("import a post of %q: %w", t.Name, err) + } + ids[i] = postID + for _, version := range post.Versions { + _, err := tx.Exec(ctx, qImportPostVersion, postID, version.Source, version.AuthorID, version.At) + if err != nil { + return written, fmt.Errorf("import a post version of %q: %w", t.Name, err) + } + } + written++ + } + + if err := tx.Commit(ctx); err != nil { + return written, fmt.Errorf("commit the thread %q: %w", t.Name, err) + } + return written, nil +} From 027a95b064450d8ceadfa877a381dc6b453312cc Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 16:01:06 +0900 Subject: [PATCH 360/428] move the frontend sources to frontend/ --- Dockerfile | 4 ++-- README.md | 2 +- {web/js => frontend}/.prettierrc | 0 {web/js => frontend}/api/articles.ts | 0 {web/js => frontend}/api/favourites.ts | 0 {web/js => frontend}/api/files.ts | 0 {web/js => frontend}/api/forum.ts | 0 {web/js => frontend}/api/likes.ts | 0 {web/js => frontend}/api/messages.ts | 0 {web/js => frontend}/api/modules.ts | 0 {web/js => frontend}/api/notifications.ts | 0 {web/js => frontend}/api/own-lists.ts | 0 {web/js => frontend}/api/preview.ts | 0 {web/js => frontend}/api/rate.ts | 0 {web/js => frontend}/api/search-module.ts | 0 {web/js => frontend}/api/tags.ts | 0 {web/js => frontend}/api/user.ts | 0 {web/js => frontend}/articles/article-authorship.tsx | 0 {web/js => frontend}/articles/article-backlinks.tsx | 0 {web/js => frontend}/articles/article-child.tsx | 0 {web/js => frontend}/articles/article-delete.tsx | 0 {web/js => frontend}/articles/article-diff.tsx | 0 {web/js => frontend}/articles/article-editor.tsx | 0 {web/js => frontend}/articles/article-favourite.tsx | 0 {web/js => frontend}/articles/article-files.tsx | 0 {web/js => frontend}/articles/article-history.tsx | 0 {web/js => frontend}/articles/article-lock.tsx | 0 {web/js => frontend}/articles/article-parent.tsx | 0 {web/js => frontend}/articles/article-rating.tsx | 0 {web/js => frontend}/articles/article-rename.tsx | 0 {web/js => frontend}/articles/article-source.tsx | 0 {web/js => frontend}/articles/article-tags.tsx | 0 {web/js => frontend}/articles/auto-resize-iframe.ts | 0 {web/js => frontend}/articles/buttons.ts | 0 {web/js => frontend}/articles/codeblock.tsx | 0 {web/js => frontend}/articles/collapsible.ts | 0 {web/js => frontend}/articles/date.ts | 0 {web/js => frontend}/articles/footnote.ts | 0 {web/js => frontend}/articles/interwiki.ts | 0 {web/js => frontend}/articles/lightbox.ts | 0 {web/js => frontend}/articles/list-pages.tsx | 0 {web/js => frontend}/articles/newpage.ts | 0 {web/js => frontend}/articles/rate-stars.ts | 0 {web/js => frontend}/articles/rate-updown.ts | 0 {web/js => frontend}/articles/ref-form.tsx | 0 {web/js => frontend}/articles/site-changes.tsx | 0 {web/js => frontend}/articles/tabview.ts | 0 {web/js => frontend}/articles/toc.ts | 0 {web/js => frontend}/articles/top-bar.ts | 0 {web/js => frontend}/articles/wanted-pages.tsx | 0 {web/js => frontend}/build.ts | 6 +++--- {web/js => frontend}/components/authorship-editor.tsx | 0 {web/js => frontend}/components/tag-editor.tsx | 0 {web/js => frontend}/entrypoints/admin-sus-users.tsx | 0 {web/js => frontend}/entrypoints/forum-new-post.tsx | 0 {web/js => frontend}/entrypoints/forum-new-thread.tsx | 0 {web/js => frontend}/entrypoints/forum-post-options.tsx | 0 {web/js => frontend}/entrypoints/forum-thread-options.tsx | 0 {web/js => frontend}/entrypoints/messages-api-interface.ts | 0 {web/js => frontend}/entrypoints/page-404.tsx | 0 {web/js => frontend}/entrypoints/page-login-status.tsx | 0 {web/js => frontend}/entrypoints/page-options.tsx | 0 {web/js => frontend}/entrypoints/search.tsx | 0 {web/js => frontend}/entrypoints/user-actions.tsx | 0 {web/js => frontend}/forum/forum-post-editor.tsx | 0 {web/js => frontend}/forum/forum-post-preview.tsx | 0 {web/js => frontend}/forum/post-likes.tsx | 0 {web/js => frontend}/forum/recent-posts-pagination.tsx | 0 {web/js => frontend}/forum/thread-pagination.tsx | 0 {web/js => frontend}/index.tsx | 0 {web/js => frontend}/locales/zh-hans.json | 0 {web/js => frontend}/package.json | 0 .../reactive/config/ConfigContext.context.ts | 0 {web/js => frontend}/reactive/config/ConfigContext.hooks.ts | 0 .../reactive/config/ConfigContext.provider.tsx | 0 {web/js => frontend}/reactive/config/ConfigContext.types.ts | 0 {web/js => frontend}/reactive/config/index.ts | 0 .../reactive/containers/page/Header.styles.ts | 0 {web/js => frontend}/reactive/containers/page/Header.tsx | 0 .../reactive/containers/page/Navigation.styles.ts | 0 .../js => frontend}/reactive/containers/page/Navigation.tsx | 0 .../js => frontend}/reactive/containers/page/Page.styles.ts | 0 {web/js => frontend}/reactive/containers/page/Page.tsx | 0 .../reactive/containers/page/ProfilePage.tsx | 0 {web/js => frontend}/reactive/containers/page/index.ts | 0 .../reactive/pages/favourites/Favourites.tsx | 0 {web/js => frontend}/reactive/pages/favourites/index.ts | 0 .../reactive/pages/liked-posts/LikedPosts.tsx | 0 {web/js => frontend}/reactive/pages/liked-posts/index.ts | 0 .../reactive/pages/messages/ConversationList.tsx | 0 .../reactive/pages/messages/ConversationView.tsx | 0 .../reactive/pages/messages/Messages.styles.ts | 0 {web/js => frontend}/reactive/pages/messages/Messages.tsx | 0 {web/js => frontend}/reactive/pages/messages/index.ts | 0 .../reactive/pages/notifications/Notification.styles.ts | 0 .../reactive/pages/notifications/Notification.tsx | 0 .../reactive/pages/notifications/Notifications.styles.ts | 0 .../reactive/pages/notifications/Notifications.tsx | 0 .../pages/notifications/NotificationsInfiniteScroll.tsx | 0 {web/js => frontend}/reactive/pages/notifications/index.ts | 0 .../reactive/pages/own-lists/OwnList.styles.ts | 0 {web/js => frontend}/reactive/pages/own-lists/Pager.tsx | 0 {web/js => frontend}/reactive/pages/ratings/Ratings.tsx | 0 {web/js => frontend}/reactive/pages/ratings/index.ts | 0 {web/js => frontend}/reactive/paths.ts | 0 {web/js => frontend}/reactive/router.tsx | 0 {web/js => frontend}/reactive/theme/Theme.consts.ts | 0 {web/js => frontend}/reactive/theme/Theme.d.ts | 0 {web/js => frontend}/reactive/theme/Theme.types.ts | 0 {web/js => frontend}/tsconfig.json | 0 {web/js => frontend}/util/async-sleep.ts | 0 {web/js => frontend}/util/const-callback.ts | 0 {web/js => frontend}/util/cookie-util.ts | 0 {web/js => frontend}/util/date-format.ts | 0 {web/js => frontend}/util/fetch-util.ts | 0 {web/js => frontend}/util/highlight-words.tsx | 0 {web/js => frontend}/util/hovertip.ts | 0 {web/js => frontend}/util/i18n.ts | 0 {web/js => frontend}/util/loader.tsx | 0 {web/js => frontend}/util/pagination.tsx | 0 {web/js => frontend}/util/password.ts | 0 {web/js => frontend}/util/react-render-into.ts | 0 {web/js => frontend}/util/trans.tsx | 0 {web/js => frontend}/util/user-view.tsx | 0 {web/js => frontend}/util/validate-article-name.ts | 0 {web/js => frontend}/util/wikidot-message.tsx | 0 {web/js => frontend}/util/wikidot-modal.tsx | 0 {web/js => frontend}/yarn.lock | 0 128 files changed, 6 insertions(+), 6 deletions(-) rename {web/js => frontend}/.prettierrc (100%) rename {web/js => frontend}/api/articles.ts (100%) rename {web/js => frontend}/api/favourites.ts (100%) rename {web/js => frontend}/api/files.ts (100%) rename {web/js => frontend}/api/forum.ts (100%) rename {web/js => frontend}/api/likes.ts (100%) rename {web/js => frontend}/api/messages.ts (100%) rename {web/js => frontend}/api/modules.ts (100%) rename {web/js => frontend}/api/notifications.ts (100%) rename {web/js => frontend}/api/own-lists.ts (100%) rename {web/js => frontend}/api/preview.ts (100%) rename {web/js => frontend}/api/rate.ts (100%) rename {web/js => frontend}/api/search-module.ts (100%) rename {web/js => frontend}/api/tags.ts (100%) rename {web/js => frontend}/api/user.ts (100%) rename {web/js => frontend}/articles/article-authorship.tsx (100%) rename {web/js => frontend}/articles/article-backlinks.tsx (100%) rename {web/js => frontend}/articles/article-child.tsx (100%) rename {web/js => frontend}/articles/article-delete.tsx (100%) rename {web/js => frontend}/articles/article-diff.tsx (100%) rename {web/js => frontend}/articles/article-editor.tsx (100%) rename {web/js => frontend}/articles/article-favourite.tsx (100%) rename {web/js => frontend}/articles/article-files.tsx (100%) rename {web/js => frontend}/articles/article-history.tsx (100%) rename {web/js => frontend}/articles/article-lock.tsx (100%) rename {web/js => frontend}/articles/article-parent.tsx (100%) rename {web/js => frontend}/articles/article-rating.tsx (100%) rename {web/js => frontend}/articles/article-rename.tsx (100%) rename {web/js => frontend}/articles/article-source.tsx (100%) rename {web/js => frontend}/articles/article-tags.tsx (100%) rename {web/js => frontend}/articles/auto-resize-iframe.ts (100%) rename {web/js => frontend}/articles/buttons.ts (100%) rename {web/js => frontend}/articles/codeblock.tsx (100%) rename {web/js => frontend}/articles/collapsible.ts (100%) rename {web/js => frontend}/articles/date.ts (100%) rename {web/js => frontend}/articles/footnote.ts (100%) rename {web/js => frontend}/articles/interwiki.ts (100%) rename {web/js => frontend}/articles/lightbox.ts (100%) rename {web/js => frontend}/articles/list-pages.tsx (100%) rename {web/js => frontend}/articles/newpage.ts (100%) rename {web/js => frontend}/articles/rate-stars.ts (100%) rename {web/js => frontend}/articles/rate-updown.ts (100%) rename {web/js => frontend}/articles/ref-form.tsx (100%) rename {web/js => frontend}/articles/site-changes.tsx (100%) rename {web/js => frontend}/articles/tabview.ts (100%) rename {web/js => frontend}/articles/toc.ts (100%) rename {web/js => frontend}/articles/top-bar.ts (100%) rename {web/js => frontend}/articles/wanted-pages.tsx (100%) rename {web/js => frontend}/build.ts (97%) rename {web/js => frontend}/components/authorship-editor.tsx (100%) rename {web/js => frontend}/components/tag-editor.tsx (100%) rename {web/js => frontend}/entrypoints/admin-sus-users.tsx (100%) rename {web/js => frontend}/entrypoints/forum-new-post.tsx (100%) rename {web/js => frontend}/entrypoints/forum-new-thread.tsx (100%) rename {web/js => frontend}/entrypoints/forum-post-options.tsx (100%) rename {web/js => frontend}/entrypoints/forum-thread-options.tsx (100%) rename {web/js => frontend}/entrypoints/messages-api-interface.ts (100%) rename {web/js => frontend}/entrypoints/page-404.tsx (100%) rename {web/js => frontend}/entrypoints/page-login-status.tsx (100%) rename {web/js => frontend}/entrypoints/page-options.tsx (100%) rename {web/js => frontend}/entrypoints/search.tsx (100%) rename {web/js => frontend}/entrypoints/user-actions.tsx (100%) rename {web/js => frontend}/forum/forum-post-editor.tsx (100%) rename {web/js => frontend}/forum/forum-post-preview.tsx (100%) rename {web/js => frontend}/forum/post-likes.tsx (100%) rename {web/js => frontend}/forum/recent-posts-pagination.tsx (100%) rename {web/js => frontend}/forum/thread-pagination.tsx (100%) rename {web/js => frontend}/index.tsx (100%) rename {web/js => frontend}/locales/zh-hans.json (100%) rename {web/js => frontend}/package.json (100%) rename {web/js => frontend}/reactive/config/ConfigContext.context.ts (100%) rename {web/js => frontend}/reactive/config/ConfigContext.hooks.ts (100%) rename {web/js => frontend}/reactive/config/ConfigContext.provider.tsx (100%) rename {web/js => frontend}/reactive/config/ConfigContext.types.ts (100%) rename {web/js => frontend}/reactive/config/index.ts (100%) rename {web/js => frontend}/reactive/containers/page/Header.styles.ts (100%) rename {web/js => frontend}/reactive/containers/page/Header.tsx (100%) rename {web/js => frontend}/reactive/containers/page/Navigation.styles.ts (100%) rename {web/js => frontend}/reactive/containers/page/Navigation.tsx (100%) rename {web/js => frontend}/reactive/containers/page/Page.styles.ts (100%) rename {web/js => frontend}/reactive/containers/page/Page.tsx (100%) rename {web/js => frontend}/reactive/containers/page/ProfilePage.tsx (100%) rename {web/js => frontend}/reactive/containers/page/index.ts (100%) rename {web/js => frontend}/reactive/pages/favourites/Favourites.tsx (100%) rename {web/js => frontend}/reactive/pages/favourites/index.ts (100%) rename {web/js => frontend}/reactive/pages/liked-posts/LikedPosts.tsx (100%) rename {web/js => frontend}/reactive/pages/liked-posts/index.ts (100%) rename {web/js => frontend}/reactive/pages/messages/ConversationList.tsx (100%) rename {web/js => frontend}/reactive/pages/messages/ConversationView.tsx (100%) rename {web/js => frontend}/reactive/pages/messages/Messages.styles.ts (100%) rename {web/js => frontend}/reactive/pages/messages/Messages.tsx (100%) rename {web/js => frontend}/reactive/pages/messages/index.ts (100%) rename {web/js => frontend}/reactive/pages/notifications/Notification.styles.ts (100%) rename {web/js => frontend}/reactive/pages/notifications/Notification.tsx (100%) rename {web/js => frontend}/reactive/pages/notifications/Notifications.styles.ts (100%) rename {web/js => frontend}/reactive/pages/notifications/Notifications.tsx (100%) rename {web/js => frontend}/reactive/pages/notifications/NotificationsInfiniteScroll.tsx (100%) rename {web/js => frontend}/reactive/pages/notifications/index.ts (100%) rename {web/js => frontend}/reactive/pages/own-lists/OwnList.styles.ts (100%) rename {web/js => frontend}/reactive/pages/own-lists/Pager.tsx (100%) rename {web/js => frontend}/reactive/pages/ratings/Ratings.tsx (100%) rename {web/js => frontend}/reactive/pages/ratings/index.ts (100%) rename {web/js => frontend}/reactive/paths.ts (100%) rename {web/js => frontend}/reactive/router.tsx (100%) rename {web/js => frontend}/reactive/theme/Theme.consts.ts (100%) rename {web/js => frontend}/reactive/theme/Theme.d.ts (100%) rename {web/js => frontend}/reactive/theme/Theme.types.ts (100%) rename {web/js => frontend}/tsconfig.json (100%) rename {web/js => frontend}/util/async-sleep.ts (100%) rename {web/js => frontend}/util/const-callback.ts (100%) rename {web/js => frontend}/util/cookie-util.ts (100%) rename {web/js => frontend}/util/date-format.ts (100%) rename {web/js => frontend}/util/fetch-util.ts (100%) rename {web/js => frontend}/util/highlight-words.tsx (100%) rename {web/js => frontend}/util/hovertip.ts (100%) rename {web/js => frontend}/util/i18n.ts (100%) rename {web/js => frontend}/util/loader.tsx (100%) rename {web/js => frontend}/util/pagination.tsx (100%) rename {web/js => frontend}/util/password.ts (100%) rename {web/js => frontend}/util/react-render-into.ts (100%) rename {web/js => frontend}/util/trans.tsx (100%) rename {web/js => frontend}/util/user-view.tsx (100%) rename {web/js => frontend}/util/validate-article-name.ts (100%) rename {web/js => frontend}/util/wikidot-message.tsx (100%) rename {web/js => frontend}/util/wikidot-modal.tsx (100%) rename {web/js => frontend}/yarn.lock (100%) diff --git a/Dockerfile b/Dockerfile index 77039d75..7716fd5a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -20,8 +20,8 @@ FROM node:24-slim AS js_build RUN mkdir -p /build/static -WORKDIR /build/web/js -COPY web/js . +WORKDIR /build/frontend +COPY frontend . RUN --mount=type=cache,target=/build/.yarn YARN_CACHE_FOLDER=/build/.yarn yarn install && yarn run build FROM python:3.13.2 AS python_build diff --git a/README.md b/README.md index 0ac0d3d7..3d4ac018 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ DEBUG=false ### 2.Python 部署 - **【STEP1】** 安装配置环境 - - 定位到 `web/js` 目录，执行 `yarn install` + - 定位到 `frontend` 目录，执行 `yarn install` - 在项目根目录下，运行 `pip install -r requirements.txt` - **【STEP2】** 启动配置 diff --git a/web/js/.prettierrc b/frontend/.prettierrc similarity index 100% rename from web/js/.prettierrc rename to frontend/.prettierrc diff --git a/web/js/api/articles.ts b/frontend/api/articles.ts similarity index 100% rename from web/js/api/articles.ts rename to frontend/api/articles.ts diff --git a/web/js/api/favourites.ts b/frontend/api/favourites.ts similarity index 100% rename from web/js/api/favourites.ts rename to frontend/api/favourites.ts diff --git a/web/js/api/files.ts b/frontend/api/files.ts similarity index 100% rename from web/js/api/files.ts rename to frontend/api/files.ts diff --git a/web/js/api/forum.ts b/frontend/api/forum.ts similarity index 100% rename from web/js/api/forum.ts rename to frontend/api/forum.ts diff --git a/web/js/api/likes.ts b/frontend/api/likes.ts similarity index 100% rename from web/js/api/likes.ts rename to frontend/api/likes.ts diff --git a/web/js/api/messages.ts b/frontend/api/messages.ts similarity index 100% rename from web/js/api/messages.ts rename to frontend/api/messages.ts diff --git a/web/js/api/modules.ts b/frontend/api/modules.ts similarity index 100% rename from web/js/api/modules.ts rename to frontend/api/modules.ts diff --git a/web/js/api/notifications.ts b/frontend/api/notifications.ts similarity index 100% rename from web/js/api/notifications.ts rename to frontend/api/notifications.ts diff --git a/web/js/api/own-lists.ts b/frontend/api/own-lists.ts similarity index 100% rename from web/js/api/own-lists.ts rename to frontend/api/own-lists.ts diff --git a/web/js/api/preview.ts b/frontend/api/preview.ts similarity index 100% rename from web/js/api/preview.ts rename to frontend/api/preview.ts diff --git a/web/js/api/rate.ts b/frontend/api/rate.ts similarity index 100% rename from web/js/api/rate.ts rename to frontend/api/rate.ts diff --git a/web/js/api/search-module.ts b/frontend/api/search-module.ts similarity index 100% rename from web/js/api/search-module.ts rename to frontend/api/search-module.ts diff --git a/web/js/api/tags.ts b/frontend/api/tags.ts similarity index 100% rename from web/js/api/tags.ts rename to frontend/api/tags.ts diff --git a/web/js/api/user.ts b/frontend/api/user.ts similarity index 100% rename from web/js/api/user.ts rename to frontend/api/user.ts diff --git a/web/js/articles/article-authorship.tsx b/frontend/articles/article-authorship.tsx similarity index 100% rename from web/js/articles/article-authorship.tsx rename to frontend/articles/article-authorship.tsx diff --git a/web/js/articles/article-backlinks.tsx b/frontend/articles/article-backlinks.tsx similarity index 100% rename from web/js/articles/article-backlinks.tsx rename to frontend/articles/article-backlinks.tsx diff --git a/web/js/articles/article-child.tsx b/frontend/articles/article-child.tsx similarity index 100% rename from web/js/articles/article-child.tsx rename to frontend/articles/article-child.tsx diff --git a/web/js/articles/article-delete.tsx b/frontend/articles/article-delete.tsx similarity index 100% rename from web/js/articles/article-delete.tsx rename to frontend/articles/article-delete.tsx diff --git a/web/js/articles/article-diff.tsx b/frontend/articles/article-diff.tsx similarity index 100% rename from web/js/articles/article-diff.tsx rename to frontend/articles/article-diff.tsx diff --git a/web/js/articles/article-editor.tsx b/frontend/articles/article-editor.tsx similarity index 100% rename from web/js/articles/article-editor.tsx rename to frontend/articles/article-editor.tsx diff --git a/web/js/articles/article-favourite.tsx b/frontend/articles/article-favourite.tsx similarity index 100% rename from web/js/articles/article-favourite.tsx rename to frontend/articles/article-favourite.tsx diff --git a/web/js/articles/article-files.tsx b/frontend/articles/article-files.tsx similarity index 100% rename from web/js/articles/article-files.tsx rename to frontend/articles/article-files.tsx diff --git a/web/js/articles/article-history.tsx b/frontend/articles/article-history.tsx similarity index 100% rename from web/js/articles/article-history.tsx rename to frontend/articles/article-history.tsx diff --git a/web/js/articles/article-lock.tsx b/frontend/articles/article-lock.tsx similarity index 100% rename from web/js/articles/article-lock.tsx rename to frontend/articles/article-lock.tsx diff --git a/web/js/articles/article-parent.tsx b/frontend/articles/article-parent.tsx similarity index 100% rename from web/js/articles/article-parent.tsx rename to frontend/articles/article-parent.tsx diff --git a/web/js/articles/article-rating.tsx b/frontend/articles/article-rating.tsx similarity index 100% rename from web/js/articles/article-rating.tsx rename to frontend/articles/article-rating.tsx diff --git a/web/js/articles/article-rename.tsx b/frontend/articles/article-rename.tsx similarity index 100% rename from web/js/articles/article-rename.tsx rename to frontend/articles/article-rename.tsx diff --git a/web/js/articles/article-source.tsx b/frontend/articles/article-source.tsx similarity index 100% rename from web/js/articles/article-source.tsx rename to frontend/articles/article-source.tsx diff --git a/web/js/articles/article-tags.tsx b/frontend/articles/article-tags.tsx similarity index 100% rename from web/js/articles/article-tags.tsx rename to frontend/articles/article-tags.tsx diff --git a/web/js/articles/auto-resize-iframe.ts b/frontend/articles/auto-resize-iframe.ts similarity index 100% rename from web/js/articles/auto-resize-iframe.ts rename to frontend/articles/auto-resize-iframe.ts diff --git a/web/js/articles/buttons.ts b/frontend/articles/buttons.ts similarity index 100% rename from web/js/articles/buttons.ts rename to frontend/articles/buttons.ts diff --git a/web/js/articles/codeblock.tsx b/frontend/articles/codeblock.tsx similarity index 100% rename from web/js/articles/codeblock.tsx rename to frontend/articles/codeblock.tsx diff --git a/web/js/articles/collapsible.ts b/frontend/articles/collapsible.ts similarity index 100% rename from web/js/articles/collapsible.ts rename to frontend/articles/collapsible.ts diff --git a/web/js/articles/date.ts b/frontend/articles/date.ts similarity index 100% rename from web/js/articles/date.ts rename to frontend/articles/date.ts diff --git a/web/js/articles/footnote.ts b/frontend/articles/footnote.ts similarity index 100% rename from web/js/articles/footnote.ts rename to frontend/articles/footnote.ts diff --git a/web/js/articles/interwiki.ts b/frontend/articles/interwiki.ts similarity index 100% rename from web/js/articles/interwiki.ts rename to frontend/articles/interwiki.ts diff --git a/web/js/articles/lightbox.ts b/frontend/articles/lightbox.ts similarity index 100% rename from web/js/articles/lightbox.ts rename to frontend/articles/lightbox.ts diff --git a/web/js/articles/list-pages.tsx b/frontend/articles/list-pages.tsx similarity index 100% rename from web/js/articles/list-pages.tsx rename to frontend/articles/list-pages.tsx diff --git a/web/js/articles/newpage.ts b/frontend/articles/newpage.ts similarity index 100% rename from web/js/articles/newpage.ts rename to frontend/articles/newpage.ts diff --git a/web/js/articles/rate-stars.ts b/frontend/articles/rate-stars.ts similarity index 100% rename from web/js/articles/rate-stars.ts rename to frontend/articles/rate-stars.ts diff --git a/web/js/articles/rate-updown.ts b/frontend/articles/rate-updown.ts similarity index 100% rename from web/js/articles/rate-updown.ts rename to frontend/articles/rate-updown.ts diff --git a/web/js/articles/ref-form.tsx b/frontend/articles/ref-form.tsx similarity index 100% rename from web/js/articles/ref-form.tsx rename to frontend/articles/ref-form.tsx diff --git a/web/js/articles/site-changes.tsx b/frontend/articles/site-changes.tsx similarity index 100% rename from web/js/articles/site-changes.tsx rename to frontend/articles/site-changes.tsx diff --git a/web/js/articles/tabview.ts b/frontend/articles/tabview.ts similarity index 100% rename from web/js/articles/tabview.ts rename to frontend/articles/tabview.ts diff --git a/web/js/articles/toc.ts b/frontend/articles/toc.ts similarity index 100% rename from web/js/articles/toc.ts rename to frontend/articles/toc.ts diff --git a/web/js/articles/top-bar.ts b/frontend/articles/top-bar.ts similarity index 100% rename from web/js/articles/top-bar.ts rename to frontend/articles/top-bar.ts diff --git a/web/js/articles/wanted-pages.tsx b/frontend/articles/wanted-pages.tsx similarity index 100% rename from web/js/articles/wanted-pages.tsx rename to frontend/articles/wanted-pages.tsx diff --git a/web/js/build.ts b/frontend/build.ts similarity index 97% rename from web/js/build.ts rename to frontend/build.ts index ae8cac90..f64d652a 100644 --- a/web/js/build.ts +++ b/frontend/build.ts @@ -40,7 +40,7 @@ function findHardcodedText(dir: string, found: string[] = []) { } async function build() { - const hardcoded = [...findHardcodedText('.'), ...findHardcodedText('../../static')] + const hardcoded = [...findHardcodedText('.'), ...findHardcodedText('../static')] if (hardcoded.length) { console.error('Hardcoded text outside locales/:') hardcoded.forEach(line => console.error(' ' + line)) @@ -69,7 +69,7 @@ async function build() { const baseConfigJS = { entryPoints: ['index.tsx'], - outfile: '../../static/app.js', + outfile: '../static/app.js', bundle: true, minify: true, sourcemap: true, @@ -94,6 +94,6 @@ async function build() { } } -fs.copyFileSync('./node_modules/highlight.js/styles/github.css', '../../static/highlight.js.css'); +fs.copyFileSync('./node_modules/highlight.js/styles/github.css', '../static/highlight.js.css'); build() diff --git a/web/js/components/authorship-editor.tsx b/frontend/components/authorship-editor.tsx similarity index 100% rename from web/js/components/authorship-editor.tsx rename to frontend/components/authorship-editor.tsx diff --git a/web/js/components/tag-editor.tsx b/frontend/components/tag-editor.tsx similarity index 100% rename from web/js/components/tag-editor.tsx rename to frontend/components/tag-editor.tsx diff --git a/web/js/entrypoints/admin-sus-users.tsx b/frontend/entrypoints/admin-sus-users.tsx similarity index 100% rename from web/js/entrypoints/admin-sus-users.tsx rename to frontend/entrypoints/admin-sus-users.tsx diff --git a/web/js/entrypoints/forum-new-post.tsx b/frontend/entrypoints/forum-new-post.tsx similarity index 100% rename from web/js/entrypoints/forum-new-post.tsx rename to frontend/entrypoints/forum-new-post.tsx diff --git a/web/js/entrypoints/forum-new-thread.tsx b/frontend/entrypoints/forum-new-thread.tsx similarity index 100% rename from web/js/entrypoints/forum-new-thread.tsx rename to frontend/entrypoints/forum-new-thread.tsx diff --git a/web/js/entrypoints/forum-post-options.tsx b/frontend/entrypoints/forum-post-options.tsx similarity index 100% rename from web/js/entrypoints/forum-post-options.tsx rename to frontend/entrypoints/forum-post-options.tsx diff --git a/web/js/entrypoints/forum-thread-options.tsx b/frontend/entrypoints/forum-thread-options.tsx similarity index 100% rename from web/js/entrypoints/forum-thread-options.tsx rename to frontend/entrypoints/forum-thread-options.tsx diff --git a/web/js/entrypoints/messages-api-interface.ts b/frontend/entrypoints/messages-api-interface.ts similarity index 100% rename from web/js/entrypoints/messages-api-interface.ts rename to frontend/entrypoints/messages-api-interface.ts diff --git a/web/js/entrypoints/page-404.tsx b/frontend/entrypoints/page-404.tsx similarity index 100% rename from web/js/entrypoints/page-404.tsx rename to frontend/entrypoints/page-404.tsx diff --git a/web/js/entrypoints/page-login-status.tsx b/frontend/entrypoints/page-login-status.tsx similarity index 100% rename from web/js/entrypoints/page-login-status.tsx rename to frontend/entrypoints/page-login-status.tsx diff --git a/web/js/entrypoints/page-options.tsx b/frontend/entrypoints/page-options.tsx similarity index 100% rename from web/js/entrypoints/page-options.tsx rename to frontend/entrypoints/page-options.tsx diff --git a/web/js/entrypoints/search.tsx b/frontend/entrypoints/search.tsx similarity index 100% rename from web/js/entrypoints/search.tsx rename to frontend/entrypoints/search.tsx diff --git a/web/js/entrypoints/user-actions.tsx b/frontend/entrypoints/user-actions.tsx similarity index 100% rename from web/js/entrypoints/user-actions.tsx rename to frontend/entrypoints/user-actions.tsx diff --git a/web/js/forum/forum-post-editor.tsx b/frontend/forum/forum-post-editor.tsx similarity index 100% rename from web/js/forum/forum-post-editor.tsx rename to frontend/forum/forum-post-editor.tsx diff --git a/web/js/forum/forum-post-preview.tsx b/frontend/forum/forum-post-preview.tsx similarity index 100% rename from web/js/forum/forum-post-preview.tsx rename to frontend/forum/forum-post-preview.tsx diff --git a/web/js/forum/post-likes.tsx b/frontend/forum/post-likes.tsx similarity index 100% rename from web/js/forum/post-likes.tsx rename to frontend/forum/post-likes.tsx diff --git a/web/js/forum/recent-posts-pagination.tsx b/frontend/forum/recent-posts-pagination.tsx similarity index 100% rename from web/js/forum/recent-posts-pagination.tsx rename to frontend/forum/recent-posts-pagination.tsx diff --git a/web/js/forum/thread-pagination.tsx b/frontend/forum/thread-pagination.tsx similarity index 100% rename from web/js/forum/thread-pagination.tsx rename to frontend/forum/thread-pagination.tsx diff --git a/web/js/index.tsx b/frontend/index.tsx similarity index 100% rename from web/js/index.tsx rename to frontend/index.tsx diff --git a/web/js/locales/zh-hans.json b/frontend/locales/zh-hans.json similarity index 100% rename from web/js/locales/zh-hans.json rename to frontend/locales/zh-hans.json diff --git a/web/js/package.json b/frontend/package.json similarity index 100% rename from web/js/package.json rename to frontend/package.json diff --git a/web/js/reactive/config/ConfigContext.context.ts b/frontend/reactive/config/ConfigContext.context.ts similarity index 100% rename from web/js/reactive/config/ConfigContext.context.ts rename to frontend/reactive/config/ConfigContext.context.ts diff --git a/web/js/reactive/config/ConfigContext.hooks.ts b/frontend/reactive/config/ConfigContext.hooks.ts similarity index 100% rename from web/js/reactive/config/ConfigContext.hooks.ts rename to frontend/reactive/config/ConfigContext.hooks.ts diff --git a/web/js/reactive/config/ConfigContext.provider.tsx b/frontend/reactive/config/ConfigContext.provider.tsx similarity index 100% rename from web/js/reactive/config/ConfigContext.provider.tsx rename to frontend/reactive/config/ConfigContext.provider.tsx diff --git a/web/js/reactive/config/ConfigContext.types.ts b/frontend/reactive/config/ConfigContext.types.ts similarity index 100% rename from web/js/reactive/config/ConfigContext.types.ts rename to frontend/reactive/config/ConfigContext.types.ts diff --git a/web/js/reactive/config/index.ts b/frontend/reactive/config/index.ts similarity index 100% rename from web/js/reactive/config/index.ts rename to frontend/reactive/config/index.ts diff --git a/web/js/reactive/containers/page/Header.styles.ts b/frontend/reactive/containers/page/Header.styles.ts similarity index 100% rename from web/js/reactive/containers/page/Header.styles.ts rename to frontend/reactive/containers/page/Header.styles.ts diff --git a/web/js/reactive/containers/page/Header.tsx b/frontend/reactive/containers/page/Header.tsx similarity index 100% rename from web/js/reactive/containers/page/Header.tsx rename to frontend/reactive/containers/page/Header.tsx diff --git a/web/js/reactive/containers/page/Navigation.styles.ts b/frontend/reactive/containers/page/Navigation.styles.ts similarity index 100% rename from web/js/reactive/containers/page/Navigation.styles.ts rename to frontend/reactive/containers/page/Navigation.styles.ts diff --git a/web/js/reactive/containers/page/Navigation.tsx b/frontend/reactive/containers/page/Navigation.tsx similarity index 100% rename from web/js/reactive/containers/page/Navigation.tsx rename to frontend/reactive/containers/page/Navigation.tsx diff --git a/web/js/reactive/containers/page/Page.styles.ts b/frontend/reactive/containers/page/Page.styles.ts similarity index 100% rename from web/js/reactive/containers/page/Page.styles.ts rename to frontend/reactive/containers/page/Page.styles.ts diff --git a/web/js/reactive/containers/page/Page.tsx b/frontend/reactive/containers/page/Page.tsx similarity index 100% rename from web/js/reactive/containers/page/Page.tsx rename to frontend/reactive/containers/page/Page.tsx diff --git a/web/js/reactive/containers/page/ProfilePage.tsx b/frontend/reactive/containers/page/ProfilePage.tsx similarity index 100% rename from web/js/reactive/containers/page/ProfilePage.tsx rename to frontend/reactive/containers/page/ProfilePage.tsx diff --git a/web/js/reactive/containers/page/index.ts b/frontend/reactive/containers/page/index.ts similarity index 100% rename from web/js/reactive/containers/page/index.ts rename to frontend/reactive/containers/page/index.ts diff --git a/web/js/reactive/pages/favourites/Favourites.tsx b/frontend/reactive/pages/favourites/Favourites.tsx similarity index 100% rename from web/js/reactive/pages/favourites/Favourites.tsx rename to frontend/reactive/pages/favourites/Favourites.tsx diff --git a/web/js/reactive/pages/favourites/index.ts b/frontend/reactive/pages/favourites/index.ts similarity index 100% rename from web/js/reactive/pages/favourites/index.ts rename to frontend/reactive/pages/favourites/index.ts diff --git a/web/js/reactive/pages/liked-posts/LikedPosts.tsx b/frontend/reactive/pages/liked-posts/LikedPosts.tsx similarity index 100% rename from web/js/reactive/pages/liked-posts/LikedPosts.tsx rename to frontend/reactive/pages/liked-posts/LikedPosts.tsx diff --git a/web/js/reactive/pages/liked-posts/index.ts b/frontend/reactive/pages/liked-posts/index.ts similarity index 100% rename from web/js/reactive/pages/liked-posts/index.ts rename to frontend/reactive/pages/liked-posts/index.ts diff --git a/web/js/reactive/pages/messages/ConversationList.tsx b/frontend/reactive/pages/messages/ConversationList.tsx similarity index 100% rename from web/js/reactive/pages/messages/ConversationList.tsx rename to frontend/reactive/pages/messages/ConversationList.tsx diff --git a/web/js/reactive/pages/messages/ConversationView.tsx b/frontend/reactive/pages/messages/ConversationView.tsx similarity index 100% rename from web/js/reactive/pages/messages/ConversationView.tsx rename to frontend/reactive/pages/messages/ConversationView.tsx diff --git a/web/js/reactive/pages/messages/Messages.styles.ts b/frontend/reactive/pages/messages/Messages.styles.ts similarity index 100% rename from web/js/reactive/pages/messages/Messages.styles.ts rename to frontend/reactive/pages/messages/Messages.styles.ts diff --git a/web/js/reactive/pages/messages/Messages.tsx b/frontend/reactive/pages/messages/Messages.tsx similarity index 100% rename from web/js/reactive/pages/messages/Messages.tsx rename to frontend/reactive/pages/messages/Messages.tsx diff --git a/web/js/reactive/pages/messages/index.ts b/frontend/reactive/pages/messages/index.ts similarity index 100% rename from web/js/reactive/pages/messages/index.ts rename to frontend/reactive/pages/messages/index.ts diff --git a/web/js/reactive/pages/notifications/Notification.styles.ts b/frontend/reactive/pages/notifications/Notification.styles.ts similarity index 100% rename from web/js/reactive/pages/notifications/Notification.styles.ts rename to frontend/reactive/pages/notifications/Notification.styles.ts diff --git a/web/js/reactive/pages/notifications/Notification.tsx b/frontend/reactive/pages/notifications/Notification.tsx similarity index 100% rename from web/js/reactive/pages/notifications/Notification.tsx rename to frontend/reactive/pages/notifications/Notification.tsx diff --git a/web/js/reactive/pages/notifications/Notifications.styles.ts b/frontend/reactive/pages/notifications/Notifications.styles.ts similarity index 100% rename from web/js/reactive/pages/notifications/Notifications.styles.ts rename to frontend/reactive/pages/notifications/Notifications.styles.ts diff --git a/web/js/reactive/pages/notifications/Notifications.tsx b/frontend/reactive/pages/notifications/Notifications.tsx similarity index 100% rename from web/js/reactive/pages/notifications/Notifications.tsx rename to frontend/reactive/pages/notifications/Notifications.tsx diff --git a/web/js/reactive/pages/notifications/NotificationsInfiniteScroll.tsx b/frontend/reactive/pages/notifications/NotificationsInfiniteScroll.tsx similarity index 100% rename from web/js/reactive/pages/notifications/NotificationsInfiniteScroll.tsx rename to frontend/reactive/pages/notifications/NotificationsInfiniteScroll.tsx diff --git a/web/js/reactive/pages/notifications/index.ts b/frontend/reactive/pages/notifications/index.ts similarity index 100% rename from web/js/reactive/pages/notifications/index.ts rename to frontend/reactive/pages/notifications/index.ts diff --git a/web/js/reactive/pages/own-lists/OwnList.styles.ts b/frontend/reactive/pages/own-lists/OwnList.styles.ts similarity index 100% rename from web/js/reactive/pages/own-lists/OwnList.styles.ts rename to frontend/reactive/pages/own-lists/OwnList.styles.ts diff --git a/web/js/reactive/pages/own-lists/Pager.tsx b/frontend/reactive/pages/own-lists/Pager.tsx similarity index 100% rename from web/js/reactive/pages/own-lists/Pager.tsx rename to frontend/reactive/pages/own-lists/Pager.tsx diff --git a/web/js/reactive/pages/ratings/Ratings.tsx b/frontend/reactive/pages/ratings/Ratings.tsx similarity index 100% rename from web/js/reactive/pages/ratings/Ratings.tsx rename to frontend/reactive/pages/ratings/Ratings.tsx diff --git a/web/js/reactive/pages/ratings/index.ts b/frontend/reactive/pages/ratings/index.ts similarity index 100% rename from web/js/reactive/pages/ratings/index.ts rename to frontend/reactive/pages/ratings/index.ts diff --git a/web/js/reactive/paths.ts b/frontend/reactive/paths.ts similarity index 100% rename from web/js/reactive/paths.ts rename to frontend/reactive/paths.ts diff --git a/web/js/reactive/router.tsx b/frontend/reactive/router.tsx similarity index 100% rename from web/js/reactive/router.tsx rename to frontend/reactive/router.tsx diff --git a/web/js/reactive/theme/Theme.consts.ts b/frontend/reactive/theme/Theme.consts.ts similarity index 100% rename from web/js/reactive/theme/Theme.consts.ts rename to frontend/reactive/theme/Theme.consts.ts diff --git a/web/js/reactive/theme/Theme.d.ts b/frontend/reactive/theme/Theme.d.ts similarity index 100% rename from web/js/reactive/theme/Theme.d.ts rename to frontend/reactive/theme/Theme.d.ts diff --git a/web/js/reactive/theme/Theme.types.ts b/frontend/reactive/theme/Theme.types.ts similarity index 100% rename from web/js/reactive/theme/Theme.types.ts rename to frontend/reactive/theme/Theme.types.ts diff --git a/web/js/tsconfig.json b/frontend/tsconfig.json similarity index 100% rename from web/js/tsconfig.json rename to frontend/tsconfig.json diff --git a/web/js/util/async-sleep.ts b/frontend/util/async-sleep.ts similarity index 100% rename from web/js/util/async-sleep.ts rename to frontend/util/async-sleep.ts diff --git a/web/js/util/const-callback.ts b/frontend/util/const-callback.ts similarity index 100% rename from web/js/util/const-callback.ts rename to frontend/util/const-callback.ts diff --git a/web/js/util/cookie-util.ts b/frontend/util/cookie-util.ts similarity index 100% rename from web/js/util/cookie-util.ts rename to frontend/util/cookie-util.ts diff --git a/web/js/util/date-format.ts b/frontend/util/date-format.ts similarity index 100% rename from web/js/util/date-format.ts rename to frontend/util/date-format.ts diff --git a/web/js/util/fetch-util.ts b/frontend/util/fetch-util.ts similarity index 100% rename from web/js/util/fetch-util.ts rename to frontend/util/fetch-util.ts diff --git a/web/js/util/highlight-words.tsx b/frontend/util/highlight-words.tsx similarity index 100% rename from web/js/util/highlight-words.tsx rename to frontend/util/highlight-words.tsx diff --git a/web/js/util/hovertip.ts b/frontend/util/hovertip.ts similarity index 100% rename from web/js/util/hovertip.ts rename to frontend/util/hovertip.ts diff --git a/web/js/util/i18n.ts b/frontend/util/i18n.ts similarity index 100% rename from web/js/util/i18n.ts rename to frontend/util/i18n.ts diff --git a/web/js/util/loader.tsx b/frontend/util/loader.tsx similarity index 100% rename from web/js/util/loader.tsx rename to frontend/util/loader.tsx diff --git a/web/js/util/pagination.tsx b/frontend/util/pagination.tsx similarity index 100% rename from web/js/util/pagination.tsx rename to frontend/util/pagination.tsx diff --git a/web/js/util/password.ts b/frontend/util/password.ts similarity index 100% rename from web/js/util/password.ts rename to frontend/util/password.ts diff --git a/web/js/util/react-render-into.ts b/frontend/util/react-render-into.ts similarity index 100% rename from web/js/util/react-render-into.ts rename to frontend/util/react-render-into.ts diff --git a/web/js/util/trans.tsx b/frontend/util/trans.tsx similarity index 100% rename from web/js/util/trans.tsx rename to frontend/util/trans.tsx diff --git a/web/js/util/user-view.tsx b/frontend/util/user-view.tsx similarity index 100% rename from web/js/util/user-view.tsx rename to frontend/util/user-view.tsx diff --git a/web/js/util/validate-article-name.ts b/frontend/util/validate-article-name.ts similarity index 100% rename from web/js/util/validate-article-name.ts rename to frontend/util/validate-article-name.ts diff --git a/web/js/util/wikidot-message.tsx b/frontend/util/wikidot-message.tsx similarity index 100% rename from web/js/util/wikidot-message.tsx rename to frontend/util/wikidot-message.tsx diff --git a/web/js/util/wikidot-modal.tsx b/frontend/util/wikidot-modal.tsx similarity index 100% rename from web/js/util/wikidot-modal.tsx rename to frontend/util/wikidot-modal.tsx diff --git a/web/js/yarn.lock b/frontend/yarn.lock similarity index 100% rename from web/js/yarn.lock rename to frontend/yarn.lock From 4ffc724994371eb521be3c975669d3d74197b003 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Tue, 8 Sep 2026 16:05:26 +0900 Subject: [PATCH 361/428] remove the django app, project and manage.py --- manage.py | 24 - web/__init__.py | 0 web/admin.py | 821 ----------- web/apps.py | 6 - web/context_processors.py | 13 - web/controllers/__init__.py | 0 web/controllers/articles.py | 1283 ----------------- web/controllers/logging.py | 128 -- web/controllers/media.py | 83 -- web/controllers/messages.py | 158 -- web/controllers/notifications.py | 88 -- web/controllers/search.py | 163 --- web/dynamic_preferences_registry.py | 12 - web/events/__init__.py | 76 - web/events/actions_logging.py | 99 -- web/events/notifications.py | 207 --- web/fields/__init__.py | 3 - web/fields/fields.py | 63 - web/fields/models.py | 48 - web/fields/widgets.py | 138 -- web/forms.py | 85 -- web/management/__init__.py | 0 web/management/commands/__init__.py | 0 web/management/commands/createsite.py | 35 - web/management/commands/initsearch.py | 28 - web/management/commands/migrate.py | 13 - web/management/commands/runserver.py | 207 --- web/management/commands/seed.py | 37 - web/middleware.py | 189 --- web/migrations/0001_initial.py | 301 ---- ...name_type_settings_rating_mode_and_more.py | 37 - ...er_settings_rating_mode_alter_vote_rate.py | 23 - .../0004_alter_settings_rating_mode.py | 18 - ...nk_externallink_web_externallink_unique.py | 33 - web/migrations/0006_articleversion_ast.py | 18 - .../0007_alter_articleversion_ast.py | 18 - ...options_alter_category_options_and_more.py | 50 - .../0009_assign_author_to_articles.py | 14 - web/migrations/0010_update_rimg_syntax.py | 55 - ...ory_options_article_media_name_and_more.py | 38 - .../0012_assign_uuid_to_articles.py | 27 - web/migrations/0013_rename_media_folders.py | 54 - web/migrations/0014_rename_external_links.py | 51 - web/migrations/0015_delete_external_links.py | 41 - web/migrations/0016_lower_article_ids.py | 15 - web/migrations/0017_update_rimg_syntax_2.py | 54 - ...s_alter_articleversion_article_and_more.py | 35 - ...rumpost_alter_category_options_and_more.py | 117 -- ...s_can_comment_forumpost_thread_and_more.py | 55 - web/migrations/0020_forumthread_is_pinned.py | 18 - ...ated_at_forumthread_deleted_at_and_more.py | 35 - ...22_remove_forumpost_deleted_at_and_more.py | 26 - .../0023_forumpostversion_created_at.py | 20 - .../0024_forumpostversion_author.py | 21 - web/migrations/0025_merge_20220906_1945.py | 14 - ..._at_alter_articlelogentry_type_and_more.py | 33 - ...gory_remove_tag_web_tag_unique_and_more.py | 67 - ..._alter_articlelogentry_options_and_more.py | 379 ----- web/migrations/0029_add_default_category.py | 36 - ...0030_update_updated_at_to_last_revision.py | 30 - .../0031_update_tags_in_log_entries.py | 68 - .../0032_settings_can_user_create_tags.py | 18 - web/migrations/0033_vote_date.py | 18 - ...4_category_readers_can_comment_and_more.py | 73 - .../0035_current_users_are_editors.py | 14 - ...web_externa_link_fr_92155a_idx_and_more.py | 21 - web/migrations/0037_vote_visual_group.py | 20 - .../0038_alter_articlelogentry_type.py | 18 - ...9_alter_externallink_link_from_and_more.py | 23 - ...0_alter_externallink_link_from_and_more.py | 24 - ...te_options_alter_site_managers_and_more.py | 144 -- ...042_alter_articlelogentry_type_and_more.py | 34 - web/migrations/0043_migrate_system_to_web.py | 36 - web/migrations/0044_alter_tag_category.py | 21 - web/migrations/0045_actionlogentry.py | 47 - ...ation_usernotificationtemplate_and_more.py | 97 -- web/migrations/0047_subscribe_users.py | 55 - ...elete_usernotificationtemplate_and_more.py | 21 - web/migrations/0049_category_is_indexed.py | 18 - web/migrations/0050_rename_media_folders.py | 31 - ...badge_visualusergroup_badge_bg_and_more.py | 34 - .../0052_visualusergroup_badge_show_border.py | 18 - web/migrations/0053_articlesearchindex.py | 41 - ...ter_articlesearchindex_options_and_more.py | 39 - ...ter_articlesearchindex_options_and_more.py | 53 - web/migrations/0056_create_roles_and_more.py | 154 -- ...e_built_in_roles_and_migrate_categories.py | 151 -- ...group_remove_vote_visual_group_and_more.py | 80 - ...emove_forum_post_edit_delete_event_logs.py | 20 - ...le_category_alter_article_name_and_more.py | 38 - ...web_article_categor_006394_idx_and_more.py | 36 - web/migrations/0062_article_authors.py | 19 - web/migrations/0063_author_to_authors.py | 29 - web/migrations/0064_remove_article_author.py | 17 - .../0065_alter_articlelogentry_type.py | 18 - .../0066_actionlogentry_user_origin_ip_idx.py | 17 - ...e_usernotification_referred_to_and_more.py | 22 - .../0068_user_user_email_ci_uniqueness.py | 19 - ...ssage_and_user_can_send_direct_messages.py | 76 - .../0070_alter_usernotification_type.py | 16 - .../0071_assign_send_dm_permission.py | 47 - web/migrations/0072_userreport.py | 48 - ...073_assign_view_user_reports_permission.py | 59 - web/migrations/0074_user_display_name.py | 17 - web/migrations/0075_canonicalize_usernames.py | 67 - .../0076_assign_manage_updates_permission.py | 53 - web/migrations/0077_theme_and_site_options.py | 68 - web/migrations/0078_systemupdate_proxy.py | 23 - web/migrations/0079_theme_slug.py | 60 - ...ser_tickets_and_site_membership_options.py | 140 -- .../0081_assign_ticket_permissions.py | 72 - web/migrations/0082_invite_links.py | 59 - web/migrations/0083_site_system_theme.py | 25 - .../0084_forum_post_like_article_favourite.py | 68 - web/migrations/0085_site_password_help.py | 22 - web/migrations/0086_email_verification.py | 64 - .../0087_align_models_and_schema.py | 170 --- web/migrations/__init__.py | 0 web/models/__init__.py | 14 - web/models/articles.py | 302 ---- web/models/files.py | 60 - web/models/forum.py | 138 -- web/models/invites.py | 72 - web/models/logs.py | 40 - web/models/messages.py | 49 - web/models/notifications.py | 53 - web/models/reports.py | 51 - web/models/roles.py | 406 ------ web/models/search.py | 39 - web/models/settings.py | 52 - web/models/site.py | 212 --- web/models/tickets.py | 91 -- web/models/users.py | 222 --- web/permissions/__init__.py | 133 -- web/permissions/admin.py | 100 -- web/permissions/articles.py | 95 -- web/permissions/backends.py | 58 - web/permissions/forum.py | 96 -- web/permissions/messages.py | 12 - web/permissions/reports.py | 22 - web/permissions/tickets.py | 22 - web/seeds/__init__.py | 0 web/seeds/wikit_archive.py | 910 ------------ web/signals.py | 4 - web/templates/admin/updates.html | 139 -- .../admin/web/actionlogentry/change_list.html | 34 - .../admin/web/category/change_form.html | 14 - web/templates/admin/web/role/change_form.html | 14 - web/templates/admin/web/role/change_list.html | 9 - .../admin/web/role/change_list_results.html | 70 - web/templates/admin/web/user/change_list.html | 9 - web/templates/admin/web/user/submit_line.html | 12 - web/templates/admin/web/user/sus.html | 16 - web/templates/admin/web/user/user_action.html | 33 - .../fields/permissions_override_widget.html | 149 -- web/templates/fields/permissions_widget.html | 98 -- web/templates/login/login.html | 54 - web/templates/login/password_reset.html | 16 - .../login/password_reset_complete.html | 10 - .../login/password_reset_confirm.html | 26 - web/templates/login/password_reset_done.html | 10 - web/templates/mails/invite_email.txt | 13 - web/templates/mails/password_reset_email.txt | 15 - web/templates/no_site.html | 12 - web/templates/page.html | 153 -- web/templates/page_403.html | 1 - web/templates/page_404.html | 5 - web/templates/profile/change.html | 13 - web/templates/profile/user.html | 82 -- web/templates/signup/accept.html | 40 - web/templates/signup/register.html | 178 --- web/templates/system_base.html | 41 - web/templatetags/__init__.py | 0 web/templatetags/admin_side_menu.py | 98 -- web/templatetags/days.py | 36 - web/templatetags/filters.py | 9 - web/templatetags/md5url.py | 48 - web/threadvars.py | 69 - web/types.py | 25 - web/urls.py | 132 -- web/util/__init__.py | 32 - web/util/css.py | 23 - web/util/http.py | 10 - web/util/json.py | 35 - web/util/lazy_dict.py | 30 - web/util/pydantic.py | 36 - web/util/updates.py | 87 -- web/views/__init__.py | 0 web/views/api/__init__.py | 95 -- web/views/api/articles.py | 330 ----- web/views/api/files.py | 122 -- web/views/api/messages.py | 126 -- web/views/api/module.py | 44 - web/views/api/notifications.py | 91 -- web/views/api/preview.py | 59 - web/views/api/reports.py | 126 -- web/views/api/users.py | 91 -- web/views/article.py | 280 ---- web/views/bot.py | 42 - web/views/invite.py | 205 --- web/views/local_items.py | 146 -- web/views/login.py | 51 - web/views/media.py | 130 -- web/views/profile.py | 79 - web/views/reactive.py | 43 - web/views/reset_votes.py | 64 - web/views/signup.py | 327 ----- web/views/sus_users.py | 11 - web/views/theme.py | 22 - web/views/tickets.py | 60 - web/views/updates.py | 49 - wikitgo/__init__.py | 0 wikitgo/asgi.py | 16 - wikitgo/settings.py | 330 ----- wikitgo/urls.py | 39 - wikitgo/wsgi.py | 56 - 216 files changed, 16723 deletions(-) delete mode 100644 manage.py delete mode 100644 web/__init__.py delete mode 100644 web/admin.py delete mode 100644 web/apps.py delete mode 100644 web/context_processors.py delete mode 100644 web/controllers/__init__.py delete mode 100644 web/controllers/articles.py delete mode 100644 web/controllers/logging.py delete mode 100644 web/controllers/media.py delete mode 100644 web/controllers/messages.py delete mode 100644 web/controllers/notifications.py delete mode 100644 web/controllers/search.py delete mode 100644 web/dynamic_preferences_registry.py delete mode 100644 web/events/__init__.py delete mode 100644 web/events/actions_logging.py delete mode 100644 web/events/notifications.py delete mode 100644 web/fields/__init__.py delete mode 100644 web/fields/fields.py delete mode 100644 web/fields/models.py delete mode 100644 web/fields/widgets.py delete mode 100644 web/forms.py delete mode 100644 web/management/__init__.py delete mode 100644 web/management/commands/__init__.py delete mode 100644 web/management/commands/createsite.py delete mode 100644 web/management/commands/initsearch.py delete mode 100644 web/management/commands/migrate.py delete mode 100644 web/management/commands/runserver.py delete mode 100644 web/management/commands/seed.py delete mode 100644 web/middleware.py delete mode 100644 web/migrations/0001_initial.py delete mode 100644 web/migrations/0002_rename_type_settings_rating_mode_and_more.py delete mode 100644 web/migrations/0003_alter_settings_rating_mode_alter_vote_rate.py delete mode 100644 web/migrations/0004_alter_settings_rating_mode.py delete mode 100644 web/migrations/0005_externallink_externallink_web_externallink_unique.py delete mode 100644 web/migrations/0006_articleversion_ast.py delete mode 100644 web/migrations/0007_alter_articleversion_ast.py delete mode 100644 web/migrations/0008_alter_article_options_alter_category_options_and_more.py delete mode 100644 web/migrations/0009_assign_author_to_articles.py delete mode 100644 web/migrations/0010_update_rimg_syntax.py delete mode 100644 web/migrations/0011_alter_category_options_article_media_name_and_more.py delete mode 100644 web/migrations/0012_assign_uuid_to_articles.py delete mode 100644 web/migrations/0013_rename_media_folders.py delete mode 100644 web/migrations/0014_rename_external_links.py delete mode 100644 web/migrations/0015_delete_external_links.py delete mode 100644 web/migrations/0016_lower_article_ids.py delete mode 100644 web/migrations/0017_update_rimg_syntax_2.py delete mode 100644 web/migrations/0018_alter_category_options_alter_articleversion_article_and_more.py delete mode 100644 web/migrations/0018_forumcategory_forumpost_alter_category_options_and_more.py delete mode 100644 web/migrations/0019_category_users_can_comment_forumpost_thread_and_more.py delete mode 100644 web/migrations/0020_forumthread_is_pinned.py delete mode 100644 web/migrations/0021_forumthread_created_at_forumthread_deleted_at_and_more.py delete mode 100644 web/migrations/0022_remove_forumpost_deleted_at_and_more.py delete mode 100644 web/migrations/0023_forumpostversion_created_at.py delete mode 100644 web/migrations/0024_forumpostversion_author.py delete mode 100644 web/migrations/0025_merge_20220906_1945.py delete mode 100644 web/migrations/0026_alter_article_updated_at_alter_articlelogentry_type_and_more.py delete mode 100644 web/migrations/0027_tagscategory_remove_tag_web_tag_unique_and_more.py delete mode 100644 web/migrations/0028_alter_article_options_alter_articlelogentry_options_and_more.py delete mode 100644 web/migrations/0029_add_default_category.py delete mode 100644 web/migrations/0030_update_updated_at_to_last_revision.py delete mode 100644 web/migrations/0031_update_tags_in_log_entries.py delete mode 100644 web/migrations/0032_settings_can_user_create_tags.py delete mode 100644 web/migrations/0033_vote_date.py delete mode 100644 web/migrations/0034_category_readers_can_comment_and_more.py delete mode 100644 web/migrations/0035_current_users_are_editors.py delete mode 100644 web/migrations/0036_externallink_web_externa_link_fr_92155a_idx_and_more.py delete mode 100644 web/migrations/0037_vote_visual_group.py delete mode 100644 web/migrations/0038_alter_articlelogentry_type.py delete mode 100644 web/migrations/0039_alter_externallink_link_from_and_more.py delete mode 100644 web/migrations/0040_alter_externallink_link_from_and_more.py delete mode 100644 web/migrations/0041_alter_site_options_alter_site_managers_and_more.py delete mode 100644 web/migrations/0042_alter_articlelogentry_type_and_more.py delete mode 100644 web/migrations/0043_migrate_system_to_web.py delete mode 100644 web/migrations/0044_alter_tag_category.py delete mode 100644 web/migrations/0045_actionlogentry.py delete mode 100644 web/migrations/0046_usernotification_usernotificationtemplate_and_more.py delete mode 100644 web/migrations/0047_subscribe_users.py delete mode 100644 web/migrations/0048_delete_usernotificationtemplate_and_more.py delete mode 100644 web/migrations/0049_category_is_indexed.py delete mode 100644 web/migrations/0050_rename_media_folders.py delete mode 100644 web/migrations/0051_visualusergroup_badge_visualusergroup_badge_bg_and_more.py delete mode 100644 web/migrations/0052_visualusergroup_badge_show_border.py delete mode 100644 web/migrations/0053_articlesearchindex.py delete mode 100644 web/migrations/0054_alter_articlesearchindex_options_and_more.py delete mode 100644 web/migrations/0055_alter_articlesearchindex_options_and_more.py delete mode 100644 web/migrations/0056_create_roles_and_more.py delete mode 100644 web/migrations/0057_create_built_in_roles_and_migrate_categories.py delete mode 100644 web/migrations/0058_remove_user_visual_group_remove_vote_visual_group_and_more.py delete mode 100644 web/migrations/0059_remove_forum_post_edit_delete_event_logs.py delete mode 100644 web/migrations/0060_alter_article_category_alter_article_name_and_more.py delete mode 100644 web/migrations/0061_remove_article_web_article_categor_006394_idx_and_more.py delete mode 100644 web/migrations/0062_article_authors.py delete mode 100644 web/migrations/0063_author_to_authors.py delete mode 100644 web/migrations/0064_remove_article_author.py delete mode 100644 web/migrations/0065_alter_articlelogentry_type.py delete mode 100644 web/migrations/0066_actionlogentry_user_origin_ip_idx.py delete mode 100644 web/migrations/0067_remove_usernotification_referred_to_and_more.py delete mode 100644 web/migrations/0068_user_user_email_ci_uniqueness.py delete mode 100644 web/migrations/0069_directmessage_and_user_can_send_direct_messages.py delete mode 100644 web/migrations/0070_alter_usernotification_type.py delete mode 100644 web/migrations/0071_assign_send_dm_permission.py delete mode 100644 web/migrations/0072_userreport.py delete mode 100644 web/migrations/0073_assign_view_user_reports_permission.py delete mode 100644 web/migrations/0074_user_display_name.py delete mode 100644 web/migrations/0075_canonicalize_usernames.py delete mode 100644 web/migrations/0076_assign_manage_updates_permission.py delete mode 100644 web/migrations/0077_theme_and_site_options.py delete mode 100644 web/migrations/0078_systemupdate_proxy.py delete mode 100644 web/migrations/0079_theme_slug.py delete mode 100644 web/migrations/0080_user_tickets_and_site_membership_options.py delete mode 100644 web/migrations/0081_assign_ticket_permissions.py delete mode 100644 web/migrations/0082_invite_links.py delete mode 100644 web/migrations/0083_site_system_theme.py delete mode 100644 web/migrations/0084_forum_post_like_article_favourite.py delete mode 100644 web/migrations/0085_site_password_help.py delete mode 100644 web/migrations/0086_email_verification.py delete mode 100644 web/migrations/0087_align_models_and_schema.py delete mode 100644 web/migrations/__init__.py delete mode 100644 web/models/__init__.py delete mode 100644 web/models/articles.py delete mode 100644 web/models/files.py delete mode 100644 web/models/forum.py delete mode 100644 web/models/invites.py delete mode 100644 web/models/logs.py delete mode 100644 web/models/messages.py delete mode 100644 web/models/notifications.py delete mode 100644 web/models/reports.py delete mode 100644 web/models/roles.py delete mode 100644 web/models/search.py delete mode 100644 web/models/settings.py delete mode 100644 web/models/site.py delete mode 100644 web/models/tickets.py delete mode 100644 web/models/users.py delete mode 100644 web/permissions/__init__.py delete mode 100644 web/permissions/admin.py delete mode 100644 web/permissions/articles.py delete mode 100644 web/permissions/backends.py delete mode 100644 web/permissions/forum.py delete mode 100644 web/permissions/messages.py delete mode 100644 web/permissions/reports.py delete mode 100644 web/permissions/tickets.py delete mode 100644 web/seeds/__init__.py delete mode 100644 web/seeds/wikit_archive.py delete mode 100644 web/signals.py delete mode 100644 web/templates/admin/updates.html delete mode 100644 web/templates/admin/web/actionlogentry/change_list.html delete mode 100644 web/templates/admin/web/category/change_form.html delete mode 100644 web/templates/admin/web/role/change_form.html delete mode 100644 web/templates/admin/web/role/change_list.html delete mode 100644 web/templates/admin/web/role/change_list_results.html delete mode 100644 web/templates/admin/web/user/change_list.html delete mode 100644 web/templates/admin/web/user/submit_line.html delete mode 100644 web/templates/admin/web/user/sus.html delete mode 100644 web/templates/admin/web/user/user_action.html delete mode 100644 web/templates/fields/permissions_override_widget.html delete mode 100644 web/templates/fields/permissions_widget.html delete mode 100644 web/templates/login/login.html delete mode 100644 web/templates/login/password_reset.html delete mode 100644 web/templates/login/password_reset_complete.html delete mode 100644 web/templates/login/password_reset_confirm.html delete mode 100644 web/templates/login/password_reset_done.html delete mode 100644 web/templates/mails/invite_email.txt delete mode 100644 web/templates/mails/password_reset_email.txt delete mode 100644 web/templates/no_site.html delete mode 100644 web/templates/page.html delete mode 100644 web/templates/page_403.html delete mode 100644 web/templates/page_404.html delete mode 100644 web/templates/profile/change.html delete mode 100644 web/templates/profile/user.html delete mode 100644 web/templates/signup/accept.html delete mode 100644 web/templates/signup/register.html delete mode 100644 web/templates/system_base.html delete mode 100644 web/templatetags/__init__.py delete mode 100644 web/templatetags/admin_side_menu.py delete mode 100644 web/templatetags/days.py delete mode 100644 web/templatetags/filters.py delete mode 100644 web/templatetags/md5url.py delete mode 100644 web/threadvars.py delete mode 100644 web/types.py delete mode 100644 web/urls.py delete mode 100644 web/util/__init__.py delete mode 100644 web/util/css.py delete mode 100644 web/util/http.py delete mode 100644 web/util/json.py delete mode 100644 web/util/lazy_dict.py delete mode 100644 web/util/pydantic.py delete mode 100644 web/util/updates.py delete mode 100644 web/views/__init__.py delete mode 100644 web/views/api/__init__.py delete mode 100644 web/views/api/articles.py delete mode 100644 web/views/api/files.py delete mode 100644 web/views/api/messages.py delete mode 100644 web/views/api/module.py delete mode 100644 web/views/api/notifications.py delete mode 100644 web/views/api/preview.py delete mode 100644 web/views/api/reports.py delete mode 100644 web/views/api/users.py delete mode 100644 web/views/article.py delete mode 100644 web/views/bot.py delete mode 100644 web/views/invite.py delete mode 100644 web/views/local_items.py delete mode 100644 web/views/login.py delete mode 100644 web/views/media.py delete mode 100644 web/views/profile.py delete mode 100644 web/views/reactive.py delete mode 100644 web/views/reset_votes.py delete mode 100644 web/views/signup.py delete mode 100644 web/views/sus_users.py delete mode 100644 web/views/theme.py delete mode 100644 web/views/tickets.py delete mode 100644 web/views/updates.py delete mode 100644 wikitgo/__init__.py delete mode 100644 wikitgo/asgi.py delete mode 100644 wikitgo/settings.py delete mode 100644 wikitgo/urls.py delete mode 100644 wikitgo/wsgi.py diff --git a/manage.py b/manage.py deleted file mode 100644 index 63beec81..00000000 --- a/manage.py +++ /dev/null @@ -1,24 +0,0 @@ -#!/usr/bin/env python -"""Django's command-line utility for administrative tasks.""" -import os -import sys -from dotenv import load_dotenv - - -def main(): - """Run administrative tasks.""" - load_dotenv() - os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'wikitgo.settings') - try: - from django.core.management import execute_from_command_line - except ImportError as exc: - raise ImportError( - "Couldn't import Django. Are you sure it's installed and " - "available on your PYTHONPATH environment variable? Did you " - "forget to activate a virtual environment?" - ) from exc - execute_from_command_line(sys.argv) - - -if __name__ == '__main__': - main() diff --git a/web/__init__.py b/web/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/web/admin.py b/web/admin.py deleted file mode 100644 index 1844b560..00000000 --- a/web/admin.py +++ /dev/null @@ -1,821 +0,0 @@ -from solo.admin import SingletonModelAdmin -from adminsortable2.admin import SortableAdminMixin - -from django.db.models.query import QuerySet -from django.db.models import ExpressionWrapper, F, Case, When, BooleanField -from django.contrib.admin import SimpleListFilter -from django.contrib.auth.models import Permission -from django.contrib.auth.admin import UserAdmin -from django.contrib.auth.forms import UserChangeForm -from django.contrib import admin -from django.urls import path, resolve -from django.utils import timezone -from django.utils.html import format_html, format_html_join -from django import forms - -import web.fields -from web.views.sus_users import AdminSusActivityView - -from .models import * -from .fields import CITextField -from .views.invite import InviteView -from .views.invite import GenerateClaimLinkView -from .views.invite import GenerateInviteLinkView -from .views.invite import invite_url -from .views.bot import CreateBotView -from .views.reset_votes import ResetUserVotesView -from .controllers import logging -from .permissions import get_role_permissions_content_type - - -class TagsCategoryForm(forms.ModelForm): - class Meta: - model = TagsCategory - widgets = { - 'name': forms.TextInput, - 'slug': forms.TextInput, - } - fields = ('name', 'slug', 'description', 'priority') - - -@admin.register(TagsCategory) -class TagsCategoryAdmin(admin.ModelAdmin): - form = TagsCategoryForm - search_fields = ['name', 'slug', 'description'] - list_display = ['name', 'description', 'priority', 'slug'] - - -class TagForm(forms.ModelForm): - class Meta: - model = Tag - widgets = { - 'name': forms.TextInput - } - fields = '__all__' - - -@admin.register(Tag) -class TagAdmin(admin.ModelAdmin): - form = TagForm - search_fields = ['name', 'category__name'] - list_filter = ['category'] - list_display = ['name', 'category'] - - -class SettingsForm(forms.ModelForm): - class Meta: - model = Settings - widgets = { - 'rating_mode': forms.Select - } - fields = '__all__' - exclude = ['site', 'category'] - - -class SettingsAdmin(admin.StackedInline): - form = SettingsForm - model = Settings - can_delete = False - max_num = 1 - - -class CategoryForm(forms.ModelForm): - class Meta: - model = Category - widgets = { - 'name': forms.TextInput, - } - exclude = ['permissions_override'] - - _add_override_roles_ = forms.ModelMultipleChoiceField(label='添加要覆盖的角色', queryset=QuerySet(Role), required=False) - _remove_override_roles_ = forms.ModelMultipleChoiceField(label='移除要覆盖的角色', queryset=QuerySet(Role), required=False) - _perms_override_ = web.fields.PermissionsOverrideField(exclude_admin=True) - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - - instance = kwargs.get('instance') - if instance: - self.fields['_perms_override_'].widget.instance = instance - - overrided_roles = Role.objects.filter(rolepermissionsoverride__in=instance.permissions_override.all()) - self.fields['_add_override_roles_'].queryset = Role.objects.exclude(id__in=overrided_roles) - self.fields['_remove_override_roles_'].queryset = overrided_roles - else: - self.fields['_perms_override_'].widget.instance = None - self.fields['_add_override_roles_'].queryset = Role.objects.all() - self.fields['_remove_override_roles_'].disabled = True - - - def save(self, commit=True): - instance = super().save(commit=False) - - instance.save() - - roles_data = self.cleaned_data.get('_perms_override_', {}) - if roles_data: - content_type = get_role_permissions_content_type() - overrides = [] - - instance.permissions_override.all().delete() - - for role_id, perms_data in roles_data.items(): - perms_override = RolePermissionsOverride.objects.create(role_id=role_id) - - if perms_data['allow']: - perms = Permission.objects.filter(codename__in=perms_data['allow'], content_type=content_type) - perms_override.permissions.set(perms) - - if perms_data['deny']: - restrictions = Permission.objects.filter(codename__in=perms_data['deny'], content_type=content_type) - perms_override.restrictions.set(restrictions) - - overrides.append(perms_override) - - instance.permissions_override.add(*overrides) - - roles_to_override = self.cleaned_data.get('_add_override_roles_', {}) - if roles_to_override: - overrides = [] - for role in roles_to_override: - overrides.append(RolePermissionsOverride.objects.create(role=role)) - - instance.permissions_override.add(*overrides) - - roles_to_cancel_override = self.cleaned_data.get('_remove_override_roles_', {}) - if roles_to_cancel_override: - instance.permissions_override.all().filter(role__in=roles_to_cancel_override).delete() - - if commit: - instance.save() - - return instance - - -@admin.register(Category) -class CategoryAdmin(admin.ModelAdmin): - form = CategoryForm - fieldsets = ( - (None, { - 'fields': ('name', 'is_indexed') - }), - ('权限覆盖', { - 'fields': ('_add_override_roles_', '_remove_override_roles_', '_perms_override_') - }) - ) - inlines = [SettingsAdmin] - - -class ThemeForm(forms.ModelForm): - class Meta: - model = Theme - widgets = { - 'name': forms.TextInput, - 'slug': forms.TextInput, - 'external_url': forms.TextInput, - 'css': forms.Textarea(attrs={'rows': 24, 'style': 'font-family:monospace;width:100%'}), - } - fields = '__all__' - - -@admin.register(Theme) -class ThemeAdmin(admin.ModelAdmin): - form = ThemeForm - list_display = ['name', 'slug', 'mode', 'updated_at'] - fields = ['name', 'slug', 'mode', 'css', 'external_url'] - - -class SiteForm(forms.ModelForm): - class Meta: - model = Site - widgets = { - 'slug': forms.TextInput, - 'title': forms.TextInput, - 'headline': forms.TextInput, - 'domain': forms.TextInput, - 'media_domain': forms.TextInput, - 'home_page': forms.TextInput, - } - - fields = '__all__' - - -@admin.register(Site) -class SiteAdmin(SingletonModelAdmin): - form = SiteForm - inlines = [SettingsAdmin] - fieldsets = ( - (None, { - 'fields': ('slug', 'title', 'headline', 'domain', 'media_domain', 'home_page', - 'active_theme', 'system_theme') - }), - ('外观', { - 'fields': ('icon', 'auth_icon', 'footer_license') - }), - ('注册与入组', { - 'fields': ('signup_notice', 'password_help', 'email_policy', 'default_role', 'verified_role', - 'membership_password_enabled', 'membership_password', 'membership_password_role') - }), - ) - - def get_readonly_fields(self, request, obj=None): - readonly_fields = super().get_readonly_fields(request, obj) - # 这几项决定谁能自动拿到哪个角色，等同于发权限，所以跟着权限表那道门走。 - if not request.user.has_perm('roles.manage_permissions'): - readonly_fields = list(readonly_fields) + [ - 'default_role', 'verified_role', - 'membership_password_enabled', 'membership_password', 'membership_password_role', - ] - return readonly_fields - - def save_model(self, request, obj, form, change): - super().save_model(request, obj, form, change) - - -@admin.register(SystemUpdate) -class SystemUpdateAdmin(admin.ModelAdmin): - def has_add_permission(self, request): - return False - - def has_delete_permission(self, request, obj=None): - return False - - def has_change_permission(self, request, obj=None): - return False - - def has_view_permission(self, request, obj=None): - return request.user.has_perm('roles.manage_updates') - - def has_module_permission(self, request): - return request.user.has_perm('roles.manage_updates') - - def changelist_view(self, request, extra_context=None): - from django.shortcuts import redirect - return redirect('wu_update') - - -class ForumSectionForm(forms.ModelForm): - class Meta: - model = ForumSection - widgets = { - 'name': forms.TextInput, - } - fields = '__all__' - - -@admin.register(ForumSection) -class ForumSectionAdmin(admin.ModelAdmin): - form = ForumSectionForm - search_fields = ['name', 'description'] - - -class ForumCategoryForm(forms.ModelForm): - class Meta: - model = ForumCategory - widgets = { - 'name': forms.TextInput, - } - fields = '__all__' - - -@admin.register(ForumCategory) -class ForumCategoryAdmin(admin.ModelAdmin): - form = ForumCategoryForm - search_fields = ['name', 'description'] - list_filter = ['section'] - list_display = ['name', 'section'] - - -class AdvancedUserChangeForm(UserChangeForm): - class Meta: - # 修复用户名和wikidot用户名字段类型 - widgets = { - 'username': forms.TextInput(attrs={'class': 'vTextField'}), - 'wikidot_username': forms.TextInput(attrs={'class': 'vTextField'}) - } - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - if 'roles' in self.fields: - self.fields['roles'].queryset = Role.objects.exclude(slug__in=['everyone', 'registered']) - - -@admin.register(User) -class AdvancedUserAdmin(ProtectSensitiveAdmin, UserAdmin): - form = AdvancedUserChangeForm - - list_filter = ['is_superuser', 'is_active', 'roles'] - list_display = ['username_or_wd', 'email', 'is_active'] - search_fields = ['username', 'wikidot_username', 'display_name', 'email'] - readonly_fields = ['api_key', '_op_index'] - sensitive_fields = ['email'] - - fieldsets = UserAdmin.fieldsets - fieldsets[0][1]['fields'] = ('username', 'wikidot_username', 'display_name', 'type', 'password', 'api_key', '_op_index') - fieldsets[1][1]['fields'] += ('bio', 'avatar') - fieldsets[2][1]['fields'] = ('is_active', 'inactive_until', 'is_forum_active', 'forum_inactive_until', 'can_send_direct_messages', 'roles', 'is_superuser') - - @admin.display(ordering='username_or_wd') - def username_or_wd(self, obj): - return obj.__str__() - - @admin.display(description='权限级别') - def _op_index(self, obj): - return obj.operation_index - - def get_urls(self): - urls = super().get_urls() - new_urls = [ - path('invite/', InviteView.as_view()), - path('generate-link/', GenerateInviteLinkView.as_view()), - path('claim-link/', GenerateClaimLinkView.as_view()), - path('newbot/', CreateBotView.as_view()), - path('/activate/', InviteView.as_view()), - path('/reset_votes/', ResetUserVotesView.as_view()), - ] - return new_urls + urls - - def get_form(self, request, *args, **kwargs): - form = super().get_form(request, *args, **kwargs) - not_required = ['inactive_until', 'forum_inactive_until', 'wikidot_username'] - for not_required_field in not_required: - if not_required_field in form.base_fields: - form.base_fields[not_required_field].required = False - return form - - def get_readonly_fields(self, request, obj=None): - readonly_fields = super().get_readonly_fields(request, obj) - if not request.user.is_superuser: - readonly_fields += ['is_superuser'] - return readonly_fields - - def get_queryset(self, request): - qs = super(AdvancedUserAdmin, self).get_queryset(request) - return qs.annotate( - username_or_wd=ExpressionWrapper( - Case( - When(type=User.UserType.Wikidot, then=F('wikidot_username')), - default=F('username'), - output_field=CITextField() - ), - output_field=CITextField() - ) - ).order_by('username_or_wd') - - def formfield_for_manytomany(self, db_field, request, **kwargs): - if db_field.name == 'roles' and not self._may_set_roles(request, self._editing(request)): - kwargs['disabled'] = True - return super().formfield_for_manytomany(db_field, request, **kwargs) - - # 发角色就是发权限，所以这道门是「访问权限表」而不是「管理用户」—— - # 否则一个只被勾了「管理用户」的人可以给自己加任意角色。 - def _may_set_roles(self, request, obj=None): - if request.user.is_superuser: - return True - if obj is not None and obj.is_superuser: - return False - return request.user.has_perm('roles.manage_permissions') - - # formfield_for_manytomany 拿不到正在编辑的对象，只能从 URL 里认。 - def _editing(self, request): - object_id = resolve(request.path_info).kwargs.get('object_id') - if not object_id: - return None - return self.get_object(request, object_id) - - def has_change_permission(self, request, obj=None): - if obj and not request.user.is_superuser and obj.operation_index <= request.user.operation_index: - return False - return super().has_change_permission(request, obj) - - def save_model(self, request, obj, form, change): - if obj.pk: - target = User.objects.get(id=obj.id) - if change: - if not request.user.is_superuser: - obj.is_superuser = target.is_superuser - if not self._may_set_roles(request, target): - obj.roles.set(target.roles.all()) - super().save_model(request, obj, form, change) - - -class ActionsLogForm(forms.ModelForm): - class Meta: - model = ActionLogEntry - exclude = ['meta'] - - -@admin.register(ActionLogEntry) -class ActionsLogAdmin(ProtectSensitiveAdmin, admin.ModelAdmin): - form = ActionsLogForm - list_filter = ['user', 'type', 'created_at', 'origin_ip'] - list_display = ['user_or_name', 'type', 'info', 'created_at', 'origin_ip'] - search_fields = ['meta'] - sensitive_fields = ['origin_ip'] - - @admin.display(description=User.Meta.verbose_name) - def user_or_name(self, obj): - if obj.user == None: - return f'{obj.stale_username} (已删除)' - return obj.user - - @admin.display(description='详细信息') - def info(self, obj): - return logging.get_action_log_entry_description(obj) - - def has_add_permission(self, request): - return False - - def has_delete_permission(self, request, obj=None): - return False - - def has_change_permission(self, request, obj=None): - return False - - def get_urls(self): - urls = super().get_urls() - new_urls = [ - path('sus', AdminSusActivityView.as_view()) - ] - return new_urls + urls - - -class RoleCategoryForm(forms.ModelForm): - class Meta: - model = RoleCategory - fields = '__all__' - - -@admin.register(RoleCategory) -class RoleCategoryAdmin(admin.ModelAdmin): - form = RoleCategoryForm - - -class RoleForm(forms.ModelForm): - class Meta: - model = Role - exclude = ['permissions', 'restrictions'] - - _perms_ = web.fields.PermissionsField() - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - - instance = kwargs.get('instance') - self.fields['_perms_'].widget.instance = instance - - def save(self, commit=True): - instance = super().save(commit=False) - - instance.save() - - perms_data = self.cleaned_data.get('_perms_', {}) - if perms_data: - content_type = get_role_permissions_content_type() - - instance.permissions.clear() - instance.restrictions.clear() - - if perms_data['allow']: - perms = Permission.objects.filter(codename__in=perms_data['allow'], content_type=content_type) - instance.permissions.set(perms) - - if perms_data['deny']: - restrictions = Permission.objects.filter(codename__in=perms_data['deny'], content_type=content_type) - instance.restrictions.set(restrictions) - - if commit: - instance.save() - - return instance - - -class IsVisualRoleFilter(SimpleListFilter): - title = '视觉角色' - parameter_name = 'is_visual_role' - - def lookups(self, request, model_admin): - return [ - (True, '是'), - (False, '否') - ] - - def queryset(self, request, queryset): - if self.value(): - return queryset.annotate(is_visual_role=ExpressionWrapper( - F('group_votes') or \ - F('inline_visual_mode') != Role.InlineVisualMode.Hidden or \ - F('profile_visual_mode') != Role.ProfileVisualMode.Hidden, - output_field=BooleanField() - )).filter(is_visual_role=self.value()) - else: - return queryset - -@admin.register(Role) -class RoleAdmin(SortableAdminMixin, admin.ModelAdmin): - form = RoleForm - list_filter = ['category', 'is_staff', IsVisualRoleFilter] - list_display = ['__str__', '_users_number', '_idx'] - fieldsets = ( - (None, { - 'fields': ('slug', 'name', 'short_name', 'category', 'is_staff') - }), - ('视觉', { - 'fields': ('group_votes', 'votes_title', 'inline_visual_mode', 'profile_visual_mode', 'color', 'icon', 'badge_text', 'badge_bg', 'badge_text_color', 'badge_show_border') - }), - ('访问权限', { - 'fields': ('_perms_',) - }) - ) - - @admin.display(description='索引') - def _idx(self, obj): - return obj.index - - @admin.display(description='用户数') - def _users_number(self, obj): - if obj.slug in ['everyone', 'registered']: - return User.objects.all().count() - return obj.users.all().count() - - @property - def change_list_template(self): - return 'admin/%s/%s/change_list.html' % (self.opts.app_label, self.opts.model_name) - - @property - def change_list_results_template(self): - return 'admin/%s/%s/change_list_results.html' % (self.opts.app_label, self.opts.model_name) - - def has_delete_permission(self, request, obj=None): - if obj and obj.slug in ['everyone', 'registered']: - return False - return super().has_delete_permission(request, obj) - - def has_change_permission(self, request, obj=None): - if obj and not request.user.is_superuser and obj.index < request.user.operation_index: - return False - return super().has_change_permission(request, obj) - - def get_readonly_fields(self, request, obj=None): - readonly_fields = self.readonly_fields - if obj and obj.slug in ['everyone', 'registered']: - readonly_fields = readonly_fields + ("slug",) - if not request.user.is_superuser and not request.user.has_perm('roles.manage_permissions'): - readonly_fields = readonly_fields + ("_perms_",) - return readonly_fields - - -class UserReportForm(forms.ModelForm): - class Meta: - model = UserReport - fields = ['status', 'admin_notes'] - - -@admin.register(UserReport) -class UserReportAdmin(admin.ModelAdmin): - form = UserReportForm - list_display = ['id', 'reporter_display', 'reported_display', 'status', 'message_count', 'created_at'] - list_filter = ['status', 'created_at'] - search_fields = ['reason', 'reporter__username', 'reported__username', 'admin_notes'] - readonly_fields = [ - 'reporter_display', 'reported_display', 'reason', 'reported_messages_preview', - 'created_at', 'reviewed_at', 'reviewed_by', 'full_conversation_link', - ] - fieldsets = ( - ('检举信息', { - 'fields': ('reporter_display', 'reported_display', 'created_at', 'reason', 'reported_messages_preview'), - }), - ('管理员操作', { - 'fields': ('status', 'admin_notes', 'reviewed_at', 'reviewed_by', 'full_conversation_link'), - }), - ) - @admin.display(description='举报人') - def reporter_display(self, obj): - if obj.reporter is None: - return '(已删除)' - return obj.reporter - - @admin.display(description='被举报人') - def reported_display(self, obj): - if obj.reported is None: - return '(已删除)' - return obj.reported - - @admin.display(description='涉及消息数', ordering=None) - def message_count(self, obj): - return len(obj.reported_messages or []) - - @admin.display(description='被举报的消息') - def reported_messages_preview(self, obj): - rows = [] - for msg in obj.reported_messages or []: - rows.append((msg.get('sender_name', ''), msg.get('created_at', ''), msg.get('body', ''))) - if not rows: - return '(无)' - return format_html( - '
{}
', - format_html_join( - '', - '
' - '
{} · {}
' - '
{}
' - '
', - rows, - ), - ) - - @admin.display(description='查看完整会话') - def full_conversation_link(self, obj): - if not obj or not obj.pk: - return '' - return format_html( - '' - '打开完整会话 JSON（需要"查看被检举会话全部记录"权限）', - obj.pk, - ) - - def has_add_permission(self, request): - return False - - def has_delete_permission(self, request, obj=None): - return False - - def has_view_permission(self, request, obj=None): - if request.user.is_superuser: - return True - return request.user.has_perm('roles.view_user_reports') - - def has_change_permission(self, request, obj=None): - if request.user.is_superuser: - return True - return request.user.has_perm('roles.view_user_reports') - - def save_model(self, request, obj, form, change): - if change and 'status' in form.changed_data: - obj.reviewed_at = timezone.now() - obj.reviewed_by = request.user - super().save_model(request, obj, form, change) - - -class UserTicketAdmin(admin.ModelAdmin): - kind = None - review_permission = None - - list_display = ['id', 'author_display', 'subject_display', 'status', 'source_page', 'created_at'] - list_filter = ['status', 'created_at'] - search_fields = ['subject', 'body', 'author__username', 'admin_notes'] - readonly_fields = ['author_display', 'subject_display', 'body_preview', 'source_page', 'created_at', 'reviewed_at', 'reviewed_by'] - - @admin.display(description='提交人') - def author_display(self, obj): - if obj.author is None: - return '(已删除)' - return obj.author - - # 表单可以关掉标题栏，所以列表要有个不空的东西可显示。 - @admin.display(description='标题', ordering='subject') - def subject_display(self, obj): - if obj.subject: - return obj.subject - body = (obj.body or '').strip().splitlines() - first = body[0] if body else '' - return (first[:40] + '…') if len(first) > 40 else (first or '(无标题)') - - @admin.display(description='正文') - def body_preview(self, obj): - return format_html( - '
{}
', - obj.body, - ) - - def get_queryset(self, request): - return super().get_queryset(request).filter(kind=self.kind) - - def has_add_permission(self, request): - return False - - def has_delete_permission(self, request, obj=None): - return False - - def has_view_permission(self, request, obj=None): - if request.user.is_superuser: - return True - return request.user.has_perm('roles.view_user_tickets') - - def has_change_permission(self, request, obj=None): - if request.user.is_superuser: - return True - return request.user.has_perm(self.review_permission) - - def save_model(self, request, obj, form, change): - if change and 'status' in form.changed_data: - obj.reviewed_at = timezone.now() - obj.reviewed_by = request.user - super().save_model(request, obj, form, change) - - -class SupportTicketForm(forms.ModelForm): - class Meta: - model = SupportTicket - fields = ['status', 'admin_notes'] - - -@admin.register(SupportTicket) -class SupportTicketAdmin(UserTicketAdmin): - form = SupportTicketForm - kind = UserTicket.Kind.Ticket - review_permission = 'roles.view_user_tickets' - fieldsets = ( - ('工单内容', { - 'fields': ('author_display', 'subject_display', 'created_at', 'source_page', 'body_preview'), - }), - ('管理员操作', { - 'fields': ('status', 'admin_notes', 'reviewed_at', 'reviewed_by'), - }), - ) - - -class MembershipApplicationForm(forms.ModelForm): - class Meta: - model = MembershipApplication - fields = ['status', 'granted_role', 'admin_notes'] - - -@admin.register(MembershipApplication) -class MembershipApplicationAdmin(UserTicketAdmin): - form = MembershipApplicationForm - kind = UserTicket.Kind.MembershipApply - review_permission = 'roles.review_membership_applications' - list_display = ['id', 'author_display', 'subject_display', 'status', 'granted_role', 'created_at'] - list_filter = ['status', 'granted_role', 'created_at'] - fieldsets = ( - ('申请内容', { - 'fields': ('author_display', 'subject_display', 'created_at', 'source_page', 'body_preview'), - }), - ('管理员操作', { - 'fields': ('status', 'granted_role', 'admin_notes', 'reviewed_at', 'reviewed_by'), - }), - ) - - def save_model(self, request, obj, form, change): - super().save_model(request, obj, form, change) - # 通过就当场把角色发下去，否则管理员还得再去用户页点一次，两处状态就会对不上。 - if obj.status == UserTicket.Status.Approved and obj.granted_role and obj.author: - obj.author.roles.add(obj.granted_role) - - -@admin.register(InviteLink) -class InviteLinkAdmin(admin.ModelAdmin): - list_display = ['id', 'kind', 'delivery', 'recipient', 'state', 'activated_username', 'created_by', 'created_at', 'activated_at'] - list_filter = ['kind', 'delivery', 'created_at'] - search_fields = ['email', 'wikidot_username', 'activated_username', 'token'] - readonly_fields = [ - 'kind', 'delivery', 'recipient', 'state', 'link', 'target', - 'created_by', 'created_at', 'activated_username', 'activated_at', - ] - fieldsets = ( - ('链接', { - 'fields': ('kind', 'delivery', 'recipient', 'link'), - }), - ('状态', { - 'fields': ('state', 'activated_username', 'activated_at'), - }), - ('来源', { - 'fields': ('target', 'created_by', 'created_at'), - }), - ) - - @admin.display(description='发给谁') - def recipient(self, obj): - return obj.email or obj.wikidot_username or obj.target or '(已删除)' - - @admin.display(description='是否激活', boolean=True, ordering='activated_at') - def state(self, obj): - return obj.is_activated - - # 链接只有完整可复制才有用，所以这里给出带域名的那一份而不是路径。 - @admin.display(description='链接') - def link(self, obj): - url = invite_url(self.request, obj) if getattr(self, 'request', None) else obj.path - return format_html('', url) - - def get_queryset(self, request): - self.request = request - return super().get_queryset(request) - - def has_add_permission(self, request): - return False - - def has_view_permission(self, request, obj=None): - if request.user.is_superuser: - return True - return request.user.has_perm('roles.manage_users') - - def has_change_permission(self, request, obj=None): - return False - - def has_delete_permission(self, request, obj=None): - if request.user.is_superuser: - return True - return request.user.has_perm('roles.manage_users') diff --git a/web/apps.py b/web/apps.py deleted file mode 100644 index 682e9238..00000000 --- a/web/apps.py +++ /dev/null @@ -1,6 +0,0 @@ -from django.apps import AppConfig - - -class WebConfig(AppConfig): - default_auto_field = 'django.db.models.BigAutoField' - name = 'web' diff --git a/web/context_processors.py b/web/context_processors.py deleted file mode 100644 index d96cde35..00000000 --- a/web/context_processors.py +++ /dev/null @@ -1,13 +0,0 @@ -from web.models.site import get_current_site, get_site_system_theme_url - - -def site_branding(request): - site = get_current_site() - if site is None: - return {} - return { - 'site_auth_icon': '/local--files/%s' % site.auth_icon if site.auth_icon else '', - 'site_icon': '/local--files/%s' % site.icon if site.icon else '', - 'site_signup_notice': site.signup_notice, - 'site_system_theme_url': get_site_system_theme_url(), - } diff --git a/web/controllers/__init__.py b/web/controllers/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/web/controllers/articles.py b/web/controllers/articles.py deleted file mode 100644 index 1a18df2c..00000000 --- a/web/controllers/articles.py +++ /dev/null @@ -1,1283 +0,0 @@ -from multiprocessing import Value -import unicodedata -import shutil -import datetime -import re -import os.path - -from pathlib import Path -from typing import Optional, Union, Sequence, Tuple, Dict - -from django.conf import settings -from django.contrib.auth.models import AnonymousUser -from django.db import transaction -from django.db.models import QuerySet, Sum, Avg, Count, Max, IntegerField, Q, F -from django.db.models.functions import Coalesce - -import renderer -from web.events import EventBase -from web.controllers import notifications, media -from web.models.articles import Article, ArticleLogEntry, ArticleVersion, Category, ExternalLink, Tag, TagsCategory, Vote -from web.models.files import File -from web.models.settings import Settings -from web.models.site import get_current_site -from web.models.users import User -from web.models.forum import ForumThread, ForumPost -from web.models.roles import Role -from web.util import lock_table -from web.types import _UserType, _FullNameOrArticle, _FullNameOrCategory, _FullNameOrTag, _UserIdOrUser - - -class AbstractArticleEvent(EventBase, is_abstract=True): - user: _UserType - full_name_or_article: _FullNameOrArticle - - @property - def fullname(self): - if isinstance(self.full_name_or_article, Article): - return self.full_name_or_article.full_name - return self.full_name_or_article - - @property - def article(self): - if isinstance(self.full_name_or_article, str): - self.full_name_or_article = get_article(self.full_name_or_article) - return self.full_name_or_article - - -class OnVote(AbstractArticleEvent): - old_vote: Optional[Vote] - new_vote: Optional[Vote] - - @property - def is_new(self): - return self.new_vote != None and self.old_vote == None - - @property - def is_change(self): - return self.new_vote != None and self.old_vote != None - - @property - def is_remove(self): - return self.new_vote == None and self.old_vote != None - - -class OnCreateArticle(AbstractArticleEvent): - pass - - -class OnDeleteArticle(AbstractArticleEvent): - pass - - -class OnEditArticle(AbstractArticleEvent): - log_entry: ArticleLogEntry - - @property - def is_new(self): - return self.log_entry.type == ArticleLogEntry.LogEntryType.New - - -# Returns (category, name) from a full name -def get_name(full_name: str) -> Tuple[str, str]: - split = full_name.split(':', 1) - if len(split) == 2: - return split[0], split[1] - return '_default', split[0] - - -def strip_accents(s): - return ''.join(c for c in unicodedata.normalize('NFD', s) if unicodedata.category(c) != 'Mn') - - -def normalize_article_name(full_name: str) -> str: - full_name = strip_accents(full_name.lower()) - translit_map = { - 'а': 'a', 'б': 'b', 'в': 'v', 'г': 'g', 'д': 'd', 'е': 'e', 'ж': 'z', - 'з': 'z', 'и': 'i', 'й': 'i', 'к': 'k', 'л': 'l', 'м': 'm', 'н': 'n', 'о': 'o', - 'п': 'p', 'р': 'r', 'с': 's', 'т': 't', 'у': 'u', 'ф': 'f', 'х': 'h', 'ц': 'c', - 'ч': 'c', 'ы': 'i', 'э': 'e', 'ю': 'u', 'я': 'a', 'і': 'i', 'ї': 'i', 'є': 'e', - 'ь': '', 'ъ': '' - } - full_name = ''.join(translit_map.get(c, c) for c in full_name) - n = re.sub(r'[^A-Za-z0-9\-_:]+', '-', full_name).strip('-') - n = re.sub(r':+', ':', n).lower().strip(':') - category, name = get_name(n) - if category == '_default': - return name - return '%s:%s' % (category, name) - - -def denormalize_article_name(full_name: str): - if ':' not in full_name: - return f'_default:{full_name}' - return full_name - - -def get_article(full_name_or_article: _FullNameOrArticle) -> Optional[Article]: - if full_name_or_article is None: - return None - if type(full_name_or_article) == str: - full_name_or_article = full_name_or_article.lower() - category, name = get_name(full_name_or_article) - return Article.objects.filter(category=category, name=name).first() - if not isinstance(full_name_or_article, Article): - raise ValueError('Expected str or Article') - return full_name_or_article - - -def get_full_name(full_name_or_article: _FullNameOrArticle) -> str: - if full_name_or_article is None: - return '' - if isinstance(full_name_or_article, str): - return full_name_or_article - return full_name_or_article.full_name - - -def deduplicate_name(full_name: str, allowed_article: Optional[Article] = None) -> str: - i = 0 - while True: - i += 1 - name_to_try = '%s-%d' % (full_name, i) if i > 1 else full_name - article2 = get_article(name_to_try) - if not article2 or (allowed_article and article2.pk == allowed_article.pk): - return name_to_try - - -# Creates article with specified id. Does not add versions -def create_article(full_name: str, user: _UserType=None) -> Article: - category, name = get_name(full_name) - article = Article( - category=category, - name=name, - created_at=datetime.datetime.now(), - title=name, - ) - article.save() - if user: - article.authors.add(user) - OnCreateArticle(user, article).emit() - return article - - -# Adds log entry to article -def add_log_entry(full_name_or_article: _FullNameOrArticle, log_entry: ArticleLogEntry): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - - with transaction.atomic(): - with lock_table(ArticleLogEntry): - # this black magic forces lock of ArticleLogEntry table on this article id, - # so that two concurrent log entries wait for each other and are not violating unique constraint on rev_number. - current_log = ArticleLogEntry.objects.select_related('article')\ - .select_for_update()\ - .filter(article=article) - max_rev_number = current_log.aggregate(max=Max('rev_number')).get('max') - if max_rev_number is None: - max_rev_number = -1 - log_entry.rev_number = max_rev_number + 1 - log_entry.save() - - OnEditArticle(log_entry.user, article, log_entry).emit() - - article.updated_at = log_entry.created_at - article.save() - - -# Gets all log entries of article, sorted -def get_log_entries(full_name_or_article: _FullNameOrArticle) -> QuerySet[ArticleLogEntry]: - article = get_article(full_name_or_article) - return ArticleLogEntry.objects.filter(article=article).order_by('-rev_number') - - -# Gets latest log entry of article -def get_latest_log_entry(full_name_or_article: _FullNameOrArticle) -> Optional[ArticleLogEntry]: - return get_log_entries(full_name_or_article).first() - - -# Gets list of log entries from article, sorted, with specified bounds -def get_log_entries_paged(full_name_or_article: _FullNameOrArticle, c_from: int, c_to: int, get_all: bool = False) -> Tuple[QuerySet[ArticleLogEntry], int]: - log_entries = get_log_entries(full_name_or_article) - total_count = len(log_entries) - if not get_all: - log_entries = log_entries[c_from:c_to] - return log_entries, total_count - - -# Revert all revisions to specific revision -def revert_article_version(full_name_or_article: _FullNameOrArticle, rev_number: int, user: _UserType=None): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - - pref_full_name = get_full_name(full_name_or_article) - - new_props = {} - - for entry in get_log_entries(article): - if entry.rev_number <= rev_number: - break - - if entry.type == ArticleLogEntry.LogEntryType.Source: - new_props['source'] = get_previous_version(entry.meta['version_id']).source - elif entry.type == ArticleLogEntry.LogEntryType.Title: - new_props['title'] = entry.meta['prev_title'] - elif entry.type == ArticleLogEntry.LogEntryType.Name: - new_props['name'] = entry.meta['prev_name'] - elif entry.type == ArticleLogEntry.LogEntryType.Tags: - if 'added_tags' not in new_props: - new_props['added_tags'] = [] - if 'removed_tags' not in new_props: - new_props['removed_tags'] = [] - # logic: tags that were removed are now added - # tags that were added are now removed - for tag in entry.meta['added_tags']: - try: - new_props['added_tags'].remove(tag['id']) - except ValueError: - pass - new_props['removed_tags'].append(tag['id']) - for tag in entry.meta['removed_tags']: - try: - new_props['removed_tags'].remove(tag['id']) - except ValueError: - pass - new_props['added_tags'].append(tag['id']) - elif entry.type == ArticleLogEntry.LogEntryType.New: - # 'new' cannot be reverted. moreover, we should not reach this point at all. - # but if we did, just stop - break - elif entry.type == ArticleLogEntry.LogEntryType.Parent: - new_props['parent'] = entry.meta['prev_parent_id'] - elif entry.type == ArticleLogEntry.LogEntryType.FileAdded and 'id' in entry.meta: - if 'files_deleted' not in new_props: - new_props['files_deleted'] = {} - if 'files_restored' not in new_props: - new_props['files_restored'] = {} - new_props['files_deleted'][entry.meta['id']] = True - new_props['files_restored'][entry.meta['id']] = False - elif entry.type == ArticleLogEntry.LogEntryType.FileDeleted and 'id' in entry.meta: - if 'files_restored' not in new_props: - new_props['files_restored'] = {} - if 'files_deleted' not in new_props: - new_props['files_deleted'] = {} - new_props['files_restored'][entry.meta['id']] = True - new_props['files_deleted'][entry.meta['id']] = False - elif entry.type == ArticleLogEntry.LogEntryType.FileRenamed and 'id' in entry.meta: - if 'files_renamed' not in new_props: - new_props['files_renamed'] = {} - new_props['files_renamed'][entry.meta['id']] = entry.meta['prev_name'] - elif entry.type == ArticleLogEntry.LogEntryType.Wikidot: - # this is a fake revision type. - pass - elif entry.type == ArticleLogEntry.LogEntryType.VotesDeleted: - new_props['votes'] = entry.meta - elif entry.type == ArticleLogEntry.LogEntryType.Authorship: - if 'added_authors' not in new_props: - new_props['added_authors'] = [] - if 'removed_authors' not in new_props: - new_props['removed_authors'] = [] - # logic: authors that were removed are now added - # authors that were added are now removed - for author in entry.meta['added_authors']: - try: - new_props['added_authors'].remove(author) - except ValueError: - pass - new_props['removed_authors'].append(author) - for author in entry.meta['removed_authors']: - try: - new_props['removed_authors'].remove(author) - except ValueError: - pass - new_props['added_authors'].append(author) - elif entry.type == ArticleLogEntry.LogEntryType.Revert: - if 'source' in entry.meta: - new_props['source'] = get_previous_version(entry.meta['source']['version_id']).source - if 'title' in entry.meta: - new_props['title'] = entry.meta['title']['prev_title'] - if 'name' in entry.meta: - new_props['name'] = entry.meta['name']['prev_name'] - if 'parent' in entry.meta: - new_props['parent'] = entry.meta['parent']['prev_parent_id'] - if 'tags' in entry.meta: - if 'added_tags' not in new_props: - new_props['added_tags'] = [] - if 'removed_tags' not in new_props: - new_props['removed_tags'] = [] - # logic: tags that were removed are now added - # tags that were added are now removed - for tag in entry.meta['tags']['added']: - try: - new_props['added_tags'].remove(tag) - except ValueError: - pass - new_props['removed_tags'].append(tag) - for tag in entry.meta['tags']['removed']: - try: - new_props['removed_tags'].remove(tag) - except ValueError: - pass - new_props['added_tags'].append(tag) - if 'files' in entry.meta: - if 'files_restored' not in new_props: - new_props['files_restored'] = {} - if 'files_deleted' not in new_props: - new_props['files_deleted'] = {} - if 'files_renamed' not in new_props: - new_props['files_renamed'] = {} - for f in entry.meta['files']['added']: - new_props['files_deleted'][f['id']] = True - new_props['files_restored'][f['id']] = False - for f in entry.meta['files']['deleted']: - new_props['files_restored'][f['id']] = True - new_props['files_deleted'][f['id']] = False - for f in entry.meta['files']['renamed']: - new_props['files_renamed'][f['id']] = f['prev_name'] - if 'votes' in entry.meta: - new_props['votes'] = entry.meta['votes'] - if 'authorship' in entry.meta: - if 'added_authors' not in new_props: - new_props['added_authors'] = [] - if 'removed_authors' not in new_props: - new_props['removed_authors'] = [] - # logic: authors that were removed are now added - # authors that were added are now removed - for author in entry.meta['authorship']['added']: - try: - new_props['added_authors'].remove(author) - except ValueError: - pass - new_props['removed_authors'].append(author) - for author in entry.meta['authorship']['removed']: - try: - new_props['removed_authors'].remove(author) - except ValueError: - pass - new_props['added_authors'].append(author) - - subtypes = [] - - meta = {} - - files_added_meta = [] - files_deleted_meta = [] - files_renamed_meta = [] - - for f_id, new_name in new_props.get('files_renamed', {}).items(): - try: - file = File.objects.get(id=f_id) - files_renamed_meta.append({'id': f_id, 'name': new_name, 'prev_name': file.name}) - file.name = new_name - file.save() - except File.DoesNotExist: - continue - - for f_id, deleted in new_props.get('files_deleted', {}).items(): - if not deleted: - continue - try: - file = File.objects.get(id=f_id) - if not file.deleted_at: - files_deleted_meta.append({'id': f_id, 'name': file.name}) - file.deleted_at = datetime.datetime.now() - file.deleted_by = user - file.save() - except File.DoesNotExist: - continue - - for f_id, restored in new_props.get('files_restored', {}).items(): - if not restored: - continue - try: - file = File.objects.get(id=f_id) - if file.deleted_at: - files_added_meta.append({'id': f_id, 'name': file.name}) - file.deleted_at = None - file.deleted_by = None - file.save() - except File.DoesNotExist: - continue - - if files_added_meta or files_deleted_meta or files_renamed_meta: - if files_added_meta: - subtypes.append(ArticleLogEntry.LogEntryType.FileAdded) - if files_deleted_meta: - subtypes.append(ArticleLogEntry.LogEntryType.FileDeleted) - if files_renamed_meta: - subtypes.append(ArticleLogEntry.LogEntryType.FileRenamed) - meta['files'] = { - 'added': files_added_meta, - 'deleted': files_deleted_meta, - 'renamed': files_renamed_meta - } - - tags_added_meta = [] - tags_removed_meta = [] - - tags = [x.pk for x in get_tags_internal(article)] - for tag in new_props.get('removed_tags', []): - # safety: some outdated revisions have string tags here - if not isinstance(tag, int): - continue - try: - tags.remove(tag) - tags_removed_meta.append(tag) - except ValueError: - pass - for tag in new_props.get('added_tags', []): - # safety: some outdated revisions have string tags here - if not isinstance(tag, int): - continue - tags.append(tag) - tags_added_meta.append(tag) - new_tags = list(Tag.objects.filter(id__in=tags)) - set_tags_internal(article, new_tags, user, False) - - if tags_added_meta or tags_removed_meta: - subtypes.append(ArticleLogEntry.LogEntryType.Tags) - meta['tags'] = { - 'added': tags_added_meta, - 'removed': tags_removed_meta - } - - if 'source' in new_props: - subtypes.append(ArticleLogEntry.LogEntryType.Source) - version = ArticleVersion( - article=article, - source=new_props['source'], - rendered=None - ) - version.save() - meta['source'] = {'version_id': version.pk} - - if 'title' in new_props: - subtypes.append(ArticleLogEntry.LogEntryType.Title) - meta['title'] = {'prev_title': article.title, 'title': new_props['title']} - article.title = new_props['title'] - article.save() - - if 'name' in new_props: - subtypes.append(ArticleLogEntry.LogEntryType.Name) - meta['name'] = {'prev_name': article.name, 'name': new_props['name']} - update_full_name(article, new_props['name'], user, False) - - if 'parent' in new_props: - subtypes.append(ArticleLogEntry.LogEntryType.Parent) - try: - parent = Article.objects.get(id=new_props['parent']) - except Article.DoesNotExist: - parent = None - meta['parent'] = { - 'parent': get_full_name(parent), - 'parent_id': new_props['parent'], - 'prev_parent': get_full_name(article.parent), - 'prev_parent_id': article.parent.id if article.parent else None - } - article.parent = parent - article.save() - - if 'votes' in new_props: - subtypes.append(ArticleLogEntry.LogEntryType.VotesDeleted) - votes_meta = _get_article_votes_meta(article) - meta['votes'] = votes_meta - with transaction.atomic(): - Vote.objects.filter(article=article).delete() - for vote in new_props['votes']['votes']: - try: - vote_role = Role.objects.get(id=vote['role_id']) - except Role.DoesNotExist: - vote_role = None - try: - vote_user = User.objects.get(id=vote['user_id']) - except User.DoesNotExist: - # missing user id means we skip this vote and can't restore it. - continue - vote_date = datetime.datetime.fromisoformat(vote['date']) if vote['date'] else None - new_vote = Vote(article=article, user=vote_user, date=vote_date, rate=vote['vote'], role=vote_role) - new_vote.save() - new_vote.date = vote_date - new_vote.save() - - authors_added_meta = [] - authors_removed_meta = [] - - authors = [x.id for x in get_authors(article)] - for author in new_props.get('removed_authors', []): - try: - authors.remove(author) - authors_removed_meta.append(author) - except ValueError: - pass - for author in new_props.get('added_authors', []): - authors.append(author) - authors_added_meta.append(author) - new_authors: list[_UserIdOrUser] = list(User.objects.filter(id__in=authors)) - set_authors(article, new_authors, user) - - if authors_added_meta or authors_removed_meta: - subtypes.append(ArticleLogEntry.LogEntryType.Authorship) - meta['authorship'] = { - 'added': tags_added_meta, - 'removed': tags_removed_meta - } - - meta['rev_number'] = rev_number - meta['subtypes'] = subtypes - - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.Revert, - meta=meta, - comment='' - ) - - add_log_entry(article, log) - media.symlinks_article_update(article, pref_full_name) - - -# Creates new article version for specified article -def create_article_version(full_name_or_article: _FullNameOrArticle, source: str, user: _UserType = None, comment: str='') -> ArticleVersion: - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - is_new = get_latest_version(article) is None - version = ArticleVersion( - article=article, - source=source, - rendered=None - ) - version.save() - # either NEW or SOURCE - if is_new: - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.New, - meta={'version_id': version.pk, 'title': article.title}, - comment=comment - ) - else: - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.Source, - meta={'version_id': version.pk}, - comment=comment - ) - add_log_entry(article, log) - return version - - -# Refreshes links based on article version. -def refresh_article_links(article_version: ArticleVersion): - article = article_version.article - article_name = get_full_name(article) - # drop all links known before - ExternalLink.objects.filter(link_from=article_name).delete() - # parse current source - already_added = [] - rc = renderer.RenderContext(article=article_version.article, source_article=article_version.article, path_params={}, user=None) - linked_pages, included_pages = renderer.single_pass_fetch_backlinks(article_version.source, rc) - for linked_page in linked_pages: - kt = '%s:include:%s' % (article_name.lower(), linked_page.lower()) - if kt in already_added: - continue - already_added.append(kt) - new_link = ExternalLink(link_from=article_name.lower(), link_type=ExternalLink.Type.Include, link_to=linked_page.lower()) - new_link.save() - # find links - for included_page in included_pages: - kt = '%s:link:%s' % (article_name.lower(), included_page.lower()) - if kt in already_added: - continue - already_added.append(kt) - new_link = ExternalLink(link_from=article_name.lower(), link_type=ExternalLink.Type.Link, link_to=included_page.lower()) - new_link.save() - - -# Updates name of article -def update_full_name(full_name_or_article: _FullNameOrArticle, new_full_name: str, user: _UserType = None, log: bool = True): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - - prev_full_name = get_full_name(full_name_or_article) - - category, name = get_name(new_full_name) - article.category = category - article.name = name - article.save() - - # update links - ExternalLink.objects.filter(link_from=new_full_name).delete() # this should not happen, but just to be sure - ExternalLink.objects.filter(link_from=prev_full_name).update(link_from=new_full_name) - - if log: - log_entry = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.Name, - meta={'name': new_full_name, 'prev_name': prev_full_name} - ) - add_log_entry(article, log_entry) - - media.symlinks_article_update(article, prev_full_name) - - -def _get_article_votes_meta(full_name_or_article: _FullNameOrArticle): - article = get_article(full_name_or_article) - - # for revision logs, we store: - # - rating mode - # - rating - # - vote count - # - popularity - # - individual votes from each user, expressed as internal DB values - # (user id + username + vote value) - - rating, rating_votes, popularity, rating_mode = get_rating(article) - votes = list(Vote.objects.filter(article=article)) - votes_meta = { - 'rating_mode': str(rating_mode), - 'rating': rating, - 'votes_count': rating_votes, - 'popularity': popularity, - 'votes': [] - } - for vote in votes: - votes_meta['votes'].append({ - 'user_id': vote.user_id, # type: ignore - 'vote': vote.rate, - 'role_id': vote.role_id, # type: ignore - 'date': vote.date.isoformat() if vote.date else None - }) - return votes_meta - -def delete_article_votes(full_name_or_article: _FullNameOrArticle, user: _UserType = None, log: bool = True): - article = get_article(full_name_or_article) - - # fetch existing votes - votes_meta = _get_article_votes_meta(article) - Vote.objects.filter(article=article).delete() - - if log: - log_entry = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.VotesDeleted, - meta=votes_meta - ) - add_log_entry(article, log_entry) - - -# Updates title of article -def update_title(full_name_or_article: _FullNameOrArticle, new_title: str, user: _UserType = None): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - prev_title = article.title - article.title = new_title - article.save() - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.Title, - meta={'title': new_title, 'prev_title': prev_title} - ) - add_log_entry(article, log) - - -def delete_article(full_name_or_article: _FullNameOrArticle): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - ExternalLink.objects.filter(link_from=get_full_name(full_name_or_article)).delete() - media.symlinks_article_delete(article) - article.delete() - file_storage = Path(settings.MEDIA_ROOT) / 'media' / article.media_name - # this may have race conditions with file upload, because filesystem does not know about database transactions - for _ in range(3): - try: - if os.path.exists(file_storage): - shutil.rmtree(file_storage) - break - except IOError: # expected: "directory is not empty" in case someone uploads while we are deleting - pass - - -# Get specific entry of article -def get_log_entry(full_name_or_article: _FullNameOrArticle, rev_number: int) -> Optional[ArticleLogEntry]: - try: - article = get_article(full_name_or_article) - return ArticleLogEntry.objects.get(article=article, rev_number=rev_number) - except ArticleLogEntry.DoesNotExist: - pass - - -# Get specific version of article -def get_version(version_id: int) -> Optional[ArticleVersion]: - try: - return ArticleVersion.objects.get(id=version_id) - except ArticleVersion.DoesNotExist: - pass - - -# Get previous version of article relative to specified -def get_previous_version(version_id: int) -> Optional[ArticleVersion]: - try: - version = ArticleVersion.objects.get(id=version_id) - prev_version = ArticleVersion.objects.filter(article_id=version.article_id, created_at__lt=version.created_at).order_by('-created_at')[:1] # type: ignore - if not prev_version: - return None - return prev_version[0] - except ArticleVersion.DoesNotExist: - pass - - -# Get latest version of article -def get_latest_version(full_name_or_article: _FullNameOrArticle) -> Optional[ArticleVersion]: - article = get_article(full_name_or_article) - if article is None: - return None - latest_version = ArticleVersion.objects.filter(article=article).order_by('-created_at')[:1] - if latest_version: - return latest_version[0] - - -# Get latest source of article -def get_latest_source(full_name_or_article: _FullNameOrArticle) -> Optional[str]: - ver = get_latest_version(full_name_or_article) - if ver is not None: - return ver.source - return None - - -# Get source of article at specific revision number -def get_source_at_rev_num(full_name_or_article: _FullNameOrArticle, rev_num: int) -> Optional[str]: - article = get_article(full_name_or_article) - entry = get_log_entry(article, rev_num) - if not entry: - return None - - def get_version_from_meta(meta): - if 'source' in meta: - return get_version(meta['source']['version_id']) - elif "version_id" in meta: - return get_version(meta["version_id"]) - else: - return None - - version = get_version_from_meta(entry.meta) - if not version: - log_entries = list(get_log_entries(article)) - for old_entry in log_entries[log_entries.index(entry):]: - version = get_version_from_meta(old_entry.meta) - if version: - break - - if not version: - return None - - return version.source - - -# Get parent of article -def get_parent(full_name_or_article: _FullNameOrArticle) -> Optional[str]: - article = get_article(full_name_or_article) - if article is not None and article.parent: - return article.parent.full_name - - -# Set parent of article -def set_parent(full_name_or_article: _FullNameOrArticle, full_name_of_parent: _FullNameOrArticle, user: _UserType = None): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - parent = get_article(full_name_of_parent) if full_name_of_parent else None - prev_parent = get_full_name(article.parent) if article.parent else None - if article.parent == parent: - return - parent_id = parent.pk if parent else None - prev_parent_id = article.parent.id if article.parent else None - article.parent = parent - article.save() - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.Parent, - meta={'parent': full_name_of_parent, 'prev_parent': prev_parent, 'parent_id': parent_id, 'prev_parent_id': prev_parent_id} - ) - add_log_entry(article, log) - - -# Gets all parents -def get_breadcrumbs(full_name_or_article: _FullNameOrArticle) -> Sequence[Article]: - article = get_article(full_name_or_article) - output = [] - breadcrumb_ids = [] - while article and article.pk not in breadcrumb_ids: - output.append(article) - breadcrumb_ids.append(article.pk) - article = article.parent - return list(reversed(output)) - - -# Get page category -def get_category(full_name_or_category: _FullNameOrCategory) -> Optional[Category]: - if isinstance(full_name_or_category, str): - try: - return Category.objects.get(name=full_name_or_category) - except Category.DoesNotExist: - return - return full_name_or_category - - -def get_article_category(full_name_or_article: _FullNameOrArticle) -> Optional[Category]: - if isinstance(full_name_or_article, str): - category, _ = get_name(full_name_or_article) - else: - article = get_article(full_name_or_article) - if not article: - return None - category = article.category - return get_category(category) - - -# Tag name validation -def is_tag_name_allowed(name: str) -> bool: - return ' ' not in name - - -def get_tag(full_name_or_tag: _FullNameOrTag, create: bool = False) -> Optional[Tag]: - if full_name_or_tag is None: - return None - if type(full_name_or_tag) == str: - full_name_or_tag = full_name_or_tag.lower() - category_name, name = get_name(full_name_or_tag) - if create: - category, _ = TagsCategory.objects.get_or_create(slug=category_name) - tag, _ = Tag.objects.get_or_create(category=category, name=name) - return tag - try: - category = TagsCategory.objects.get(slug=category_name) - return Tag.objects.get(category=category, name=name) - except (Tag.DoesNotExist, TagsCategory.DoesNotExist): - return None - if not isinstance(full_name_or_tag, Tag): - raise ValueError('Expected str or Tag') - return full_name_or_tag - - -# Get tags from article -def get_tags(full_name_or_article: _FullNameOrArticle) -> Sequence[str]: - return list(sorted([x.full_name.lower() for x in get_tags_internal(full_name_or_article)])) - - -def get_tags_internal(full_name_or_article: _FullNameOrArticle) -> QuerySet[Tag]: - article = get_article(full_name_or_article) - if article: - return article.tags.select_related('category') - return Tag.objects.none() - - -def get_tags_categories(full_name_or_article: _FullNameOrArticle) -> Dict[TagsCategory, Sequence[Tag]]: - article = get_article(full_name_or_article) - if article: - tags = article.tags.select_related('category').exclude(name__startswith="_") - return dict(sorted({category: list(tags.filter(category=category)) for category in set(TagsCategory.objects.prefetch_related("tag_set").filter(tag__in=tags))}.items(), key=lambda x: x[0].priority if x[0].priority is not None else tags.count())) - return {} - - -# Set tags for article -def set_tags(full_name_or_article: _FullNameOrArticle, tags: Sequence[Union[str, Tag]], user: _UserType = None, log: bool = True): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - - allow_creating = article.settings.creating_tags_allowed - tag_objs = [ - t for t in (get_tag(t, create=allow_creating) for t in tags if isinstance(t, Tag) or is_tag_name_allowed(t)) - if t is not None - ] - - return set_tags_internal(article, tag_objs, user=user, log=log) - - -def set_tags_internal(full_name_or_article: _FullNameOrArticle, tags: Sequence[Tag], user: _UserType = None, log: bool = True): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - article_tags = article.tags.all() - - removed_tags = [] - added_tags = [] - - for tag in article_tags: - if tag not in tags: - article.tags.remove(tag) - removed_tags.append({'id': tag.pk, 'name': tag.full_name}) - - for tag in tags: - if tag not in article_tags: - # possibly create the tag here - article.tags.add(tag) - added_tags.append({'id': tag.pk, 'name': tag.full_name}) - - if article.settings.creating_tags_allowed: - # garbage collect tags if anything was removed - Tag.objects.annotate(num_articles=Count('articles')).filter(num_articles=0).delete() - TagsCategory.objects.annotate(num_tags=Count('tag')).filter(num_tags=0, slug=F('name')).delete() - - if (removed_tags or added_tags) and log: - log_entry = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.Tags, - meta={'added_tags': added_tags, 'removed_tags': removed_tags} - ) - add_log_entry(article, log_entry) - - -# Get article comment info -# This may actually create a thread if it does not exist yet -def get_comment_info(full_name_or_article: _FullNameOrArticle) -> tuple[int, int]: - article = get_article(full_name_or_article) - if not article: - return 0, 0 - with transaction.atomic(): - thread, created = ForumThread.objects.get_or_create(article=article) - if created: - for author in article.authors.all(): - notifications.subscribe_to_notifications(subscriber=author, forum_thread=thread) - post_count = ForumPost.objects.filter(thread=thread).count() - return thread.pk, post_count - - -# Get article rating -def get_rating(full_name_or_article: _FullNameOrArticle) -> tuple[int | float, int, int, Settings.RatingMode | str]: - article = get_article(full_name_or_article) - if not article: - return 0, 0, 0, Settings.RatingMode.Disabled - obj_settings = article.settings - if obj_settings.rating_mode == Settings.RatingMode.UpDown: - data = article.votes.aggregate(sum=Coalesce(Sum('rate'), 0, output_field=IntegerField()), count=Count('rate'), good=Count('rate', filter=Q(rate=1))) - return data['sum'] or 0, data['count'] or 0, round((data['good'] or 0) / (data['count'] or 1) * 100), obj_settings.rating_mode - elif obj_settings.rating_mode == Settings.RatingMode.Stars: - data = article.votes.aggregate(avg=Coalesce(Avg('rate'), 0.0), count=Count('rate'), good=Count('rate', filter=Q(rate__gte=3))) - return round(data['avg'], 1) or 0.0, data['count'] or 0, round((data['good'] or 0) / (data['count'] or 1) * 100), obj_settings.rating_mode - elif obj_settings.rating_mode == Settings.RatingMode.Disabled: - return 0, 0, 0, obj_settings.rating_mode - else: - raise ValueError('Unsupported rate type "%s"' % obj_settings.rating_mode) - - -# Returns dict {article_id: (rating, votes_count, popularity, mode)} -def get_all_ratings(articles_qs): - category_names = list( - articles_qs.values_list("category", flat=True).distinct() - ) - categories_map = { - c.name: c for c in Category.objects.filter(name__in=category_names).select_related("_settings") - } - - current_site = get_current_site() - site_settings = current_site.settings - default_settings = Settings.get_default_settings() - - vote_stats = ( - Vote.objects - .values("article_id") - .annotate( - sum_rate=Coalesce(Sum("rate"), 0.0), - count_rate=Count("rate"), - good_updown=Count("rate", filter=Q(rate=1)), - avg_rate=Coalesce(Avg("rate"), 0.0), - good_stars=Count("rate", filter=Q(rate__gte=3)) - ) - ) - votes_map = {v["article_id"]: v for v in vote_stats} - - results = {} - for article in articles_qs: - cat = categories_map.get(article.category) - category_settings = getattr(cat, "_settings", None) - merged_settings = default_settings.merge(site_settings).merge(category_settings) - - rating_mode = merged_settings.rating_mode - votes = votes_map.get(article.id, {}) - - if rating_mode == Settings.RatingMode.UpDown: - rating_value = votes.get("sum_rate", 0) - votes_count = votes.get("count_rate", 0) - popularity = round((votes.get("good_updown", 0) / (votes_count or 1)) * 100) - elif rating_mode == Settings.RatingMode.Stars: - rating_value = round(votes.get("avg_rate", 0.0), 1) - votes_count = votes.get("count_rate", 0) - popularity = round((votes.get("good_stars", 0) / (votes_count or 1)) * 100) - else: - rating_value = votes_count = popularity = 0 - - results[article.id] = ( - rating_value, - votes_count, - popularity, - rating_mode, - ) - - return results - - -def get_formatted_rating(full_name_or_article: _FullNameOrArticle) -> str: - article = get_article(full_name_or_article) - if not article: - return '0' - rating, votes, _, mode = get_rating(article) - if mode == Settings.RatingMode.UpDown: - return '%+d' % rating - elif mode == Settings.RatingMode.Stars: - if not votes: - return '—' - return '%.1f' % rating - else: - return '%d' % rating - - -class VotedTooSoonError(RuntimeError): - def __init__(self, *args, time_left=0, time_total=0, **kwargs): - super().__init__(*args, **kwargs) - self.time_left = time_left - self.time_total = time_total - - -def add_vote(full_name_or_article: _FullNameOrArticle, user: _UserType, rate: int | float | None): - article = get_article(full_name_or_article) - - old_vote_query = Vote.objects.filter(article=article, user=user) - old_vote = old_vote_query.first() - old_vote_query.delete() - - # temporarily disabled - if False and not user.is_staff and not user.is_superuser and not old_vote: - last_vote_of_this_user = Vote.objects.filter(user=user).order_by('-id').first() - if last_vote_of_this_user and last_vote_of_this_user.date: - time_since = datetime.datetime.utcnow().replace(tzinfo=datetime.timezone.utc) - last_vote_of_this_user.date - time_total = datetime.timedelta(minutes=3) - if time_since < time_total: - time_left = time_total - time_since - raise VotedTooSoonError('Voting too soon (at least 5 minutes between votes expected)', time_left=time_left.seconds, time_total=time_total.seconds) - - new_vote = None - if rate is not None: - new_vote = Vote(article=article, user=user, rate=rate, role=user.vote_role) - new_vote.save() - - OnVote(user, article, old_vote, new_vote).emit() - - - -# Set article lock status -def set_lock(full_name_or_article: _FullNameOrArticle, locked: bool, user: _UserType = None): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - article.locked = locked - article.save() - - -# Get file in article -def get_file_in_article(full_name_or_article: _FullNameOrArticle, file_name: str) -> Optional[File]: - article = get_article(full_name_or_article) - if article is None: - return None - files = File.objects.filter(article=article, name=file_name, deleted_at__isnull=True) - if not files: - return None - return files[0] - - -# Get file(s) in article -def get_files_in_article(full_name_or_article: _FullNameOrArticle) -> QuerySet[File]: - article = get_article(full_name_or_article) - if article is None: - return File.objects.none() - files = File.objects.filter(article=article, deleted_at__isnull=True) - return files - - -# Add file to article -def add_file_to_article(full_name_or_article: _FullNameOrArticle, file: File, user: _UserType = None): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - if file.article and file.article != article: - raise ValueError('File already belongs to an article') - file.article = article - file.save() - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.FileAdded, - meta={'name': file.name, 'id': file.pk} - ) - add_log_entry(article, log) - media.symlinks_article_update(article) - - -def get_file_space_usage() -> tuple[int, int]: - current_files_size = File.objects.filter(deleted_at=None).aggregate(size=Sum('size')).get('size') or 0 - absolute_files_size = File.objects.aggregate(size=Sum('size')).get('size') or 0 - return current_files_size, absolute_files_size - - -# Delete file from article. -# Permanent deletion is irreversible and should not be used unless for technical cleanup purposes or from admin panel. -# We also cannot track who performed a permanent deletion. -def delete_file_from_article(full_name_or_article: _FullNameOrArticle, file: File, user: _UserType = None, permanent = False): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - if file.article != article: - raise ValueError(f'File article "{get_full_name(article)}" is not the same as "{article.full_name}" for deletion') - if file.deleted_at and not permanent: - raise ValueError('File is already deleted') - if permanent: - if os.path.exists(file.local_media_path): - os.unlink(file.local_media_path) - file.delete() - media.symlinks_article_update(article) - else: - file.deleted_at = datetime.datetime.now(datetime.timezone.utc) - file.deleted_by = user - file.save() - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.FileDeleted, - meta={'name': file.name, 'id': file.pk} - ) - add_log_entry(article, log) - media.symlinks_article_update(article) - - -# Restore deleted file to article -def restore_file_from_article(full_name_or_article: _FullNameOrArticle, file: File, user: _UserType = None): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - if file.article != article: - raise ValueError(f'File article "{get_full_name(article)}" is not the same as "{article.full_name}" for restoration') - if not file.deleted_at: - raise ValueError('File is not deleted') - file.deleted_at = None - file.deleted_by = None - file.save() - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.FileAdded, - meta={'name': file.name, 'id': file.pk} - ) - add_log_entry(article, log) - media.symlinks_article_update(article) - - -# Rename file in article -def rename_file_in_article(full_name_or_article: _FullNameOrArticle, file: File, name: str, user: _UserType = None): - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - if file.article != article: - raise ValueError(f'File article "{get_full_name(article)}" is not the same as "{article.full_name}" for renaming') - old_name = file.name - file.name = name - file.save() - if file.name != old_name: - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.FileRenamed, - meta={'name': file.name, 'prev_name': old_name, 'id': file.pk} - ) - add_log_entry(article, log) - media.symlinks_article_update(article) - - -# Check if name is allowed for creation -# Pretty much this blocks six 100% special paths, everything else is OK -def is_full_name_allowed(article_name: str) -> bool: - article_name = article_name.lower() - reserved = ['-', '_', 'api', 'pw-api', 'forum', 'local--files', 'local--code', 'local--html', 'local--theme'] - if article_name in reserved: - return False - if len(article_name) > 128: - return False - if not re.match(r'^[A-Za-z0-9\-_:]+$', article_name): - return False - category, name = get_name(article_name) - if not category.strip() or not name.strip(): - return False - return True - - -# Fetch multiple articles by names -def fetch_articles_by_names(original_names): - names = list(dict.fromkeys([('_default:%s' % x).lower() if ':' not in x else x.lower() for x in original_names])) - all_articles = Article.objects.filter(complete_full_name__in=names) - ret_map = dict() - for article in all_articles: - ret_map[article.complete_full_name] = article - articles_dict = dict() - for name in original_names: - dumb_name = ('_default:%s' % name).lower() if ':' not in name else name.lower() - articles_dict[name] = ret_map[dumb_name] - return articles_dict - - -# Get hidden categories for specific user (none -> AnonymousUser) -def get_hidden_categories_for(user: _UserType=None) -> list[Category]: - if user is None: - user = AnonymousUser() - all_categories = Category.objects.all() - hidden_categories = [] - for category in all_categories: - if not user.has_perm('roles.view_articles', category): - hidden_categories.append(category) - return hidden_categories - - -def get_authors(full_name_or_article): - article = get_article(full_name_or_article) - if not article: - return [] - return article.authors.all() - - -# Set article lock status -def set_authors(full_name_or_article: _FullNameOrArticle, authors: list[_UserIdOrUser], user: _UserType): - if not authors: - return - - article = get_article(full_name_or_article) - if not article: - raise ValueError(f'Article {full_name_or_article} does not found') - - authors_qs: QuerySet[User] = User.objects.filter(id__in=[author.pk if isinstance(author, User) else author for author in authors]) - if authors_qs.count(): - old_authors: set[User] = set(article.authors.all()) - article.authors.set(authors_qs) - new_authors = set(authors_qs) - - added_authors = [author.pk for author in (new_authors - old_authors)] - removed_authors = [author.pk for author in (old_authors - new_authors)] - - if added_authors or removed_authors: - log = ArticleLogEntry( - article=article, - user=user, - type=ArticleLogEntry.LogEntryType.Authorship, - meta={'added_authors': added_authors, 'removed_authors': removed_authors} - ) - add_log_entry(article, log) diff --git a/web/controllers/logging.py b/web/controllers/logging.py deleted file mode 100644 index 8d4855f9..00000000 --- a/web/controllers/logging.py +++ /dev/null @@ -1,128 +0,0 @@ -import json -from django.contrib.auth.models import AbstractUser as _UserType -from django.utils.safestring import mark_safe - -from renderer import single_pass_render -from renderer.parser import RenderContext -from renderer.utils import render_template_from_string, render_user_to_html -from modules.forumthread import render_posts - -from web import threadvars -from web.models.logs import ActionLogEntry -from web.models.users import User - - -def add_action_log(user: _UserType, type: ActionLogEntry.ActionType, meta): - with threadvars.context(): - ActionLogEntry( - user=user, - stale_username=user.username, - type=type, - meta=meta, - origin_ip = threadvars.get('current_client_ip') - ).save() - - -def _mark_safe_all(data: dict): - return {k: mark_safe(v) if isinstance(v, str) else v for k, v in data.items()} - - -def _make_post_preview(post_id, author_id, title, source): - context = RenderContext(None, None, {}, None) - post_info = { - 'id': post_id, - 'name':title, - 'author': render_user_to_html(User.objects.filter(id=author_id).first()), - 'content': single_pass_render(source, context, 'message'), - 'created_at': '', - 'updated_at': '', - 'replies': [], - 'rendered_replies': False, - 'options_config': json.dumps({ - 'hasRevisions': False, - 'canReply': False, - 'canEdit': False, - 'canDelete': False, - }) - } - return render_posts([post_info]) - -def _render_post_edit_preview(m): - body = render_template_from_string( - ''' -
- -
- -
- {{post}} -
-
-
- ''', - prev_post=_make_post_preview(m['post']['id'], m['post']['author'], m['prev_title'], m['prev_source']), - post=_make_post_preview(m['post']['id'], m['post']['author'], m['title'], m['source']) - ) - return body - - -def get_action_log_entry_description(log_entry: ActionLogEntry): - ActionType = ActionLogEntry.ActionType - m = log_entry.meta - try: - match log_entry.type: - case ActionType.Vote: - m = _mark_safe_all(m) - if m['is_new']: - return f'向页面 {m['article']} 添加了评分 {m['new_vote']:.1f}' - elif m['is_remove']: - return f'从页面 {m['article']} 移除了评分 {m['old_vote']:.1f}' - elif m['is_change']: - return f'页面 {m['article']} 的评分已从 {m['old_vote']:.1f} 更改为 {m['new_vote']:.1f}' - else: - return f'页面 {m['article']} 的评分被重复移除（原本不存在）' - case ActionType.NewArticle: - m = _mark_safe_all(m) - return f'创建了新页面：{m['article']}' - case ActionType.RemoveArticle: - m = _mark_safe_all(m) - return f'页面：{m['article']}，删除时评分：{m['rating']}，投票数：{m['votes']}，人气值：{m['popularity']}' - case ActionType.EditArticle: - m = _mark_safe_all(m) - msg = [f'页面：{m['article']}，版本：{m['rev_number']}'] - meta = m['log_entry_meta'] - match m['edit_type']: - case 'tags': - added_tags = meta['added_tags'] - removed_tags = meta['removed_tags'] - if added_tags: - msg.append(f'添加标签：{', '.join([t['name'] for t in added_tags])}') - if removed_tags: - msg.append(f'移除标签：{', '.join([t['name'] for t in removed_tags])}') - case 'title': - msg.append(f'标题已从 {meta['prev_title']} 更改为 {meta['title']}') - case 'name': - msg.append(f'地址已从 {meta['prev_name']} 更改为 {meta['name']}') - case 'votes_deleted': - msg.append(f'评分已重置') - case _: - msg.append(f'编辑类型：{m['edit_type']}') - if m['comment']: - msg.append(f'注释：{m['comment']}') - return '，'.join(msg) - case ActionType.NewForumPost: - return _make_post_preview(m['post']['id'], m['post']['author'], m['title'], m['source']) - case ActionType.EditForumPost: - return _render_post_edit_preview(m) - case ActionType.RemoveForumPost: - return _make_post_preview(m['post']['id'], m['post']['author'], m['title'], m['source']) - case _: - return None - except: - return f'处理日志 #{log_entry.id} 时出错' \ No newline at end of file diff --git a/web/controllers/media.py b/web/controllers/media.py deleted file mode 100644 index a273b777..00000000 --- a/web/controllers/media.py +++ /dev/null @@ -1,83 +0,0 @@ -import logging -import shutil -import threading -from pathlib import Path - -from django.conf import settings - -from web.models.articles import Article -from web.models.files import File - - -def symlinks_full_update(): - if not settings.CREATE_SYMLINKS: - return - - logging.info('%s：正在后台重新加载符号链接', threading.current_thread().ident) - - files = File.objects.filter(deleted_at__isnull=True) - - symlinks_dir = Path(settings.MEDIA_ROOT) / 'symlinks' - rel_media_path = Path('../../media') - rel_system_static_path = Path('../-') - - shutil.rmtree(symlinks_dir, ignore_errors=True) - symlinks_dir.mkdir(exist_ok=True) - - try: - system_symlinks_dir = symlinks_dir / '-' - if not system_symlinks_dir.exists(): - system_symlinks_dir.symlink_to(rel_system_static_path, True) - for file in files: - try: - link_dir: Path = symlinks_dir / file.article.full_name - link_name = link_dir / file.name - - link_dir.mkdir(exist_ok=True) - link_name.symlink_to(rel_media_path / file.local_media_destination) - except FileNotFoundError: - logging.exception(f'更新文章符号链接失败：{file.article}') - except: - logging.exception('更新静态文件符号链接失败') - logging.info('%s：符号链接重新加载完成', threading.current_thread().ident) - - -def symlinks_article_update(article: Article, old_name: str=None): - if not settings.CREATE_SYMLINKS: - return - - files = File.objects.filter(article=article, deleted_at__isnull=True) - - symlinks_dir = Path(settings.MEDIA_ROOT) / 'symlinks' - article_dir = symlinks_dir / article.full_name - del_name = old_name or article.full_name - rel_media_path = Path('../../media') - - shutil.rmtree(symlinks_dir / del_name, ignore_errors=True) - article_dir.mkdir(exist_ok=True) - - try: - for file in files: - try: - link_name = article_dir / file.name - link_name.symlink_to(rel_media_path / file.local_media_destination) - except FileNotFoundError: - logging.exception(f'更新文章符号链接失败：{file.article}') - except: - logging.exception(f'更新文章符号链接失败：{article}') - - -def symlinks_article_delete(article: Article): - if not settings.CREATE_SYMLINKS: - return - - article_dir = Path(settings.MEDIA_ROOT) / 'symlinks' / article.full_name - shutil.rmtree(article_dir, ignore_errors=True) - - -def update_all_symlinks_in_background(): - if not settings.CREATE_SYMLINKS: - return - - t = threading.Thread(target=symlinks_full_update, daemon=True) - t.start() \ No newline at end of file diff --git a/web/controllers/messages.py b/web/controllers/messages.py deleted file mode 100644 index 4f52b611..00000000 --- a/web/controllers/messages.py +++ /dev/null @@ -1,158 +0,0 @@ -from django.contrib.auth.models import AbstractUser as _UserType -from django.db.models import Q, Max - -from web.controllers.notifications import send_user_notification -from web.models.messages import DirectMessage, DirectMessageBlock -from web.models.notifications import UserNotification, UserNotificationMapping - - -MAX_BODY_LENGTH = 4000 - - -def is_blocked(blocker: _UserType, blocked: _UserType) -> bool: - if not blocker or not blocked or blocker.is_anonymous or blocked.is_anonymous: - return False - return DirectMessageBlock.objects.filter(blocker=blocker, blocked=blocked).exists() - - -def can_send_message(sender: _UserType, recipient: _UserType) -> tuple[bool, str | None]: - if not sender or sender.is_anonymous: - return False, '请先登录' - if not recipient or recipient.is_anonymous: - return False, '收件人不存在' - if sender.id == recipient.id: - return False, '不能给自己发私信' - if not recipient.is_active: - return False, '该用户已被禁用' - if not sender.can_send_direct_messages: - return False, '你的私信功能已被管理员禁用' - if not sender.has_perm('roles.send_direct_message'): - return False, '你没有发送私信的权限' - if is_blocked(recipient, sender): - return False, '你已被对方拉黑' - return True, None - - -def send_message(sender: _UserType, recipient: _UserType, body: str) -> DirectMessage: - body = (body or '').strip() - if not body: - raise ValueError('消息内容不能为空') - if len(body) > MAX_BODY_LENGTH: - raise ValueError(f'消息内容不能超过 {MAX_BODY_LENGTH} 个字符') - - message = DirectMessage.objects.create( - sender=sender, - recipient=recipient, - body=body, - ) - - send_user_notification( - recipient, - UserNotification.NotificationType.DirectMessage, - meta={ - 'sender_id': sender.id, - 'sender_name': str(sender), - 'message_id': message.id, - 'preview': message.preview(), - }, - ) - - return message - - -def list_conversations(user: _UserType) -> list[dict]: - if not user or user.is_anonymous: - return [] - - partner_last = ( - DirectMessage.objects - .filter(Q(sender=user) | Q(recipient=user)) - .annotate(partner_id=_partner_id_expr(user)) - .values('partner_id') - .annotate(last_id=Max('id')) - ) - last_ids = [row['last_id'] for row in partner_last] - - messages = ( - DirectMessage.objects - .filter(id__in=last_ids) - .select_related('sender', 'recipient') - .order_by('-created_at') - ) - - result = [] - for msg in messages: - partner = msg.recipient if msg.sender_id == user.id else msg.sender - unread_count = DirectMessage.objects.filter( - sender=partner, recipient=user, is_read=False, - ).count() - result.append({ - 'partner': partner, - 'last_message': msg, - 'unread_count': unread_count, - }) - return result - - -def _partner_id_expr(user: _UserType): - from django.db.models import Case, When, F - return Case( - When(sender=user, then=F('recipient_id')), - default=F('sender_id'), - ) - - -def get_conversation(user: _UserType, partner: _UserType, cursor: int = -1, limit: int = 30, after: int = -1) -> tuple[list[DirectMessage], int]: - if not user or user.is_anonymous: - return [], -1 - - qs = DirectMessage.objects.filter( - Q(sender=user, recipient=partner) | Q(sender=partner, recipient=user) - ) - - if after >= 0: - messages = list(qs.filter(id__gt=after).order_by('id')[:limit]) - return messages, -1 - - qs = qs.order_by('-id') - if cursor != -1: - qs = qs.filter(id__lt=cursor) - - messages = list(qs[:limit]) - next_cursor = messages[-1].id if messages else -1 - return messages, next_cursor - - -def mark_conversation_read(user: _UserType, partner: _UserType) -> int: - if not user or user.is_anonymous or not partner: - return 0 - - updated = DirectMessage.objects.filter( - sender=partner, recipient=user, is_read=False, - ).update(is_read=True) - - if updated: - UserNotificationMapping.objects.filter( - recipient=user, - notification__type=UserNotification.NotificationType.DirectMessage, - notification__meta__sender_id=partner.id, - is_viewed=False, - ).update(is_viewed=True) - - return updated - - -def block_user(blocker: _UserType, blocked: _UserType) -> bool: - if not blocker or blocker.is_anonymous or not blocked or blocked.is_anonymous: - return False - if blocker.id == blocked.id: - return False - _, created = DirectMessageBlock.objects.get_or_create(blocker=blocker, blocked=blocked) - return created - - -def unblock_user(blocker: _UserType, blocked: _UserType) -> bool: - if not blocker or blocker.is_anonymous or not blocked or blocked.is_anonymous: - return False - deleted, _ = DirectMessageBlock.objects.filter(blocker=blocker, blocked=blocked).delete() - return deleted > 0 diff --git a/web/controllers/notifications.py b/web/controllers/notifications.py deleted file mode 100644 index 9d620f4e..00000000 --- a/web/controllers/notifications.py +++ /dev/null @@ -1,88 +0,0 @@ -from typing import Iterable - -from django.contrib.auth.models import AbstractUser as _UserType - -from web.models.forum import ForumThread -from web.models.notifications import UserNotification, UserNotificationMapping, UserNotificationSubscription -from web.models.articles import Article - - -def send_user_notification(recipients: _UserType | Iterable[_UserType], type: UserNotification.NotificationType, meta={}) -> UserNotification: - notification = UserNotification( - meta=meta, - type=type, - ) - - notification.save() - - if isinstance(recipients, _UserType): - recipients = (recipients,) - - UserNotificationMapping.objects.bulk_create([ - UserNotificationMapping( - notification=notification, - recipient=recipient, - is_viewed=False - ) for recipient in recipients] - ) - - return notification - - -def get_notification_subscribtions(article: Article=None, forum_thread: ForumThread=None) -> list[UserNotificationSubscription]: - return UserNotificationSubscription.objects.filter(article=article, forum_thread=forum_thread) - - -def subscribe_to_notifications(subscriber: _UserType, article: Article=None, forum_thread: ForumThread=None) -> UserNotificationSubscription: - if subscriber is None: - return - - subscription = UserNotificationSubscription.objects.filter(subscriber=subscriber, article=article, forum_thread=forum_thread).first() - - if not subscription: - if not (article or forum_thread): - return None - - subscription = UserNotificationSubscription( - subscriber=subscriber, - article=article, - forum_thread=forum_thread - ) - subscription.save() - - return subscription - - -def unsubscribe_from_notifications(subscriber: _UserType, article: Article=None, forum_thread: ForumThread=None) -> bool: - subscription = UserNotificationSubscription.objects.filter(subscriber=subscriber, article=article, forum_thread=forum_thread).first() - - if subscription: - subscription.delete() - return True - return False - - -def is_subscribed(subscriber: _UserType, article: Article=None, forum_thread: ForumThread=None) -> bool: - return UserNotificationSubscription.objects.filter(subscriber=subscriber, article=article, forum_thread=forum_thread).exists() - - -def get_notifications(user: _UserType, cursor=-1, limit=10, unread=True, mark_as_viewed=False) -> list[tuple[UserNotification, bool]]: - related = UserNotificationMapping.objects.all().order_by('-notification_id') - - if not related: - return [] - - if cursor == -1: - cursor = related.latest('notification_id').notification_id + 1 - - related = related.filter(recipient=user, notification_id__lt=cursor) - - if unread: - related = related.filter(is_viewed=False) - - result = [(n.notification, n.is_viewed) for n in related[:limit]] - - if mark_as_viewed: - related.update(is_viewed=True) - - return result diff --git a/web/controllers/search.py b/web/controllers/search.py deleted file mode 100644 index 449c5aab..00000000 --- a/web/controllers/search.py +++ /dev/null @@ -1,163 +0,0 @@ -import re - -from datetime import datetime, timezone - -from django.db.models import Q, Count -from django.contrib.postgres.search import SearchVector - -from renderer import RenderContext, single_pass_render_text - -from web.controllers import articles -from web.models import ArticleSearchIndex, Article -from web.models.articles import Tag -from web.models.forum import ForumPost -from web.models.users import User, canonicalize_username - - -def _parse_date(value, end_of_day=False): - if not value: - return None - try: - d = datetime.strptime(value.strip(), '%Y-%m-%d') - except (ValueError, AttributeError): - return None - if end_of_day: - d = d.replace(hour=23, minute=59, second=59) - return d.replace(tzinfo=timezone.utc) - - -def _find_tags(name): - if ':' in name: - category, tag_name = articles.get_name(name) - return list(Tag.objects.filter(category__slug=category, name=tag_name)) - return list(Tag.objects.filter(name=name)) - - -def _make_excerpt(plaintext, words, length=240): - body = plaintext.split('\n\n', 1)[-1] if plaintext else '' - body = re.sub(r'\s+', ' ', body).strip() - start = 0 - if words: - positions = [p for p in (body.lower().find(w.lower()) for w in words if w) if p >= 0] - if positions: - start = max(0, min(positions) - 60) - snippet = body[start:start + length] - if start > 0: - snippet = '…' + snippet - if start + length < len(body): - snippet = snippet + '…' - return snippet - - -def _format_rating(tup): - rating, votes, _popularity, mode = tup - if mode == 'updown': - return '%+d' % rating - if mode == 'stars': - return '—' if not votes else '%.1f' % rating - if mode == 'disabled': - return None - return '%d' % rating - - -def search_articles_filtered(text, *, author=None, tags=None, date_from=None, date_to=None, - user: User = None, offset=0, limit=20): - text = (text or '').strip() - hidden_categories = articles.get_hidden_categories_for(user) - - art_qs = Article.objects.exclude(category__in=hidden_categories) - - if author: - canon = canonicalize_username(author) - author_user = User.objects.filter( - Q(username=canon) | Q(wikidot_username=canon) | Q(display_name__iexact=author) - ).first() - if author_user is None: - return [], False, 0 - art_qs = art_qs.filter(authors=author_user) - - include_tag_ids = set() - if tags: - for name in tags: - if name.startswith('-'): - excluded = [t for t in _find_tags(name[1:]) if t is not None] - if excluded: - art_qs = art_qs.exclude(tags__in=excluded) - else: - found = [t for t in _find_tags(name) if t is not None] - if not found: - return [], False, 0 - art_qs = art_qs.filter(tags__in=found) - include_tag_ids.update(t.id for t in found) - - df = _parse_date(date_from) - dt = _parse_date(date_to, end_of_day=True) - if df: - art_qs = art_qs.filter(created_at__gte=df) - if dt: - art_qs = art_qs.filter(created_at__lte=dt) - - allowed_ids = art_qs.values('id') - - qs = ArticleSearchIndex.objects.filter(article__isnull=False, article_id__in=allowed_ids) - - words = [w for w in re.split(r'\s+', text) if w] if text else [] - for w in words: - qs = qs.filter(content_plaintext__icontains=w) - qs = qs.order_by('-article__created_at') - - qs = qs.select_related('article').prefetch_related('article__authors', 'article__tags__category') - - total = qs.count() - page = list(qs[offset:offset + limit + 1]) - has_more = len(page) > limit - page = page[:limit] - - page_ids = [si.article_id for si in page] - ratings = articles.get_all_ratings(Article.objects.filter(id__in=page_ids)) - comment_counts = { - row['thread__article_id']: row['c'] - for row in ForumPost.objects.filter(thread__article_id__in=page_ids) - .values('thread__article_id').annotate(c=Count('id')) - } - - items = [] - for si in page: - article = si.article - author_obj = article.authors.all()[0] if article.authors.all() else None - rating = ratings.get(article.id) - shown_tags = [t.full_name for t in article.tags.all() if t.id in include_tag_ids] if include_tag_ids else [] - items.append({ - 'title': article.title or article.display_name, - 'url': '/%s' % article.full_name, - 'excerpt': _make_excerpt(si.content_plaintext, words), - 'words': words, - 'author': ({'name': str(author_obj), 'url': '/-/users/%s' % author_obj.url_name} if author_obj else None), - 'tags': shown_tags, - 'comments': comment_counts.get(article.id, 0), - 'createdAt': article.created_at.isoformat() if article.created_at else None, - 'updatedAt': article.updated_at.isoformat() if article.updated_at else None, - 'rating': _format_rating(rating) if rating else None, - }) - - return items, has_more, total - - -def update_search_index(article: Article): - version = articles.get_latest_version(article) - - if version is None: - return - - search_obj, created = ArticleSearchIndex.objects.get_or_create(article=article) - context = RenderContext(article=version.article, source_article=article) - search_obj.content_source = article.title + '\n\n' + version.source - try: - search_obj.content_plaintext = article.title + '\n\n' + single_pass_render_text(version.source, context, 'system') - except: - search_obj.content_plaintext = search_obj.content_source - search_obj.save() - - ArticleSearchIndex.objects.filter(pk=search_obj.pk).update( - vector_plaintext=SearchVector('content_plaintext', config='english') + SearchVector('content_plaintext', config='russian') - ) diff --git a/web/dynamic_preferences_registry.py b/web/dynamic_preferences_registry.py deleted file mode 100644 index 7ce070ca..00000000 --- a/web/dynamic_preferences_registry.py +++ /dev/null @@ -1,12 +0,0 @@ -from dynamic_preferences.types import BooleanPreference -from dynamic_preferences.preferences import Section -from dynamic_preferences.users.registries import user_preferences_registry - - -articles = Section('qol') - -@user_preferences_registry.register -class AdvancedSourceEditorEnabled(BooleanPreference): - section = articles - name = 'advanced_source_editor_enabled' - default = False \ No newline at end of file diff --git a/web/events/__init__.py b/web/events/__init__.py deleted file mode 100644 index f6f2ba9a..00000000 --- a/web/events/__init__.py +++ /dev/null @@ -1,76 +0,0 @@ -import sys -import pkgutil -import logging - -from importlib.util import module_from_spec -from dataclasses import dataclass -from typing import dataclass_transform - -from web.util import camel_to_snake - - -_event_handlers: dict[str, list] = {} - - -@dataclass_transform() -class EventBase: - event_type = None - - def __init_subclass__(cls, **kwargs): - event_type = kwargs.pop('name', None) - is_abstract = kwargs.pop('is_abstract', False) - - dataclass_params = { - key: kwargs.pop(key) - for key in ['init', 'repr', 'eq', 'order', 'unsafe_hash', 'frozen'] - if key in kwargs - } - - cls = dataclass(**dataclass_params)(cls) - - if not is_abstract and cls.event_type is None: - cls.event_type = event_type or camel_to_snake(cls.__name__) - - - def emit(self): - if self.event_type is None: - raise TypeError(f'Event type is not specified for {self}.') - emit_event(self) - - -def on_trigger(event: EventBase | str): - def decorator(func): - if isinstance(event, str): - event_type = event - elif issubclass(event, EventBase): - event_type = event.event_type - else: - raise ValueError('Event must be str or derived from EventBase.') - - if event_type not in _event_handlers: - _event_handlers[event_type] = [] - _event_handlers[event_type].append(func) - - return func - - return decorator - - -def emit_event(event: EventBase): - handlers = _event_handlers.get(event.event_type, []) - - for handler in handlers: - handler(event) - - -def preload_events(): - package = sys.modules[__name__] - for importer, modname, ispkg in pkgutil.iter_modules(package.__path__): - try: - spec = importer.find_spec(modname) - m = module_from_spec(spec) - spec.loader.exec_module(m) - logging.info('Loaded events collection \'%s\'', modname.lower()) - except: - logging.error('Failed to load events collection \'%s\':', modname.lower(), exc_info=True) - continue \ No newline at end of file diff --git a/web/events/actions_logging.py b/web/events/actions_logging.py deleted file mode 100644 index 358fd5a5..00000000 --- a/web/events/actions_logging.py +++ /dev/null @@ -1,99 +0,0 @@ -from django.forms.models import model_to_dict - -from modules.forumpost import OnForumDeletePost, OnForumEditPost -from modules.forumnewpost import OnForumNewPost - -from web.events import on_trigger -from web.controllers.logging import add_action_log -from web.controllers.articles import OnVote, OnCreateArticle, OnDeleteArticle, OnEditArticle, get_rating -from web.models.logs import ActionLogEntry - - -@on_trigger(OnVote) -def log_vote(e: OnVote): - meta = { - 'article': str(e.article), - 'old_vote': e.old_vote.rate if e.old_vote else None, - 'new_vote': e.new_vote.rate if e.new_vote else None, - 'is_new': e.is_new, - 'is_change': e.is_change, - 'is_remove': e.is_remove - } - - add_action_log(e.user, ActionLogEntry.ActionType.Vote, meta) - - -@on_trigger(OnCreateArticle) -def log_create_article(e: OnCreateArticle): - meta = { - 'article': str(e.article) - } - - add_action_log(e.user, ActionLogEntry.ActionType.NewArticle, meta) - - -@on_trigger(OnDeleteArticle) -def log_delete_article(e: OnDeleteArticle): - rating, votes, popularity, _ = get_rating(e.article) - meta = { - 'article': str(e.article), - 'rating': rating, - 'votes': votes, - 'popularity': popularity - } - - add_action_log(e.user, ActionLogEntry.ActionType.RemoveArticle, meta) - - -@on_trigger(OnEditArticle) -def log_edit_article(e: OnEditArticle): - if e.is_new: - return - - meta = { - 'article': str(e.article), - 'comment': e.log_entry.comment, - 'edit_type': e.log_entry.type, - 'rev_number': e.log_entry.rev_number, - 'log_entry_meta': e.log_entry.meta - } - - add_action_log(e.user, ActionLogEntry.ActionType.EditArticle, meta) - - -@on_trigger(OnForumNewPost) -def log_forum_new_post(e: OnForumNewPost): - meta = { - 'author_id': e.post.author.id, - 'post': model_to_dict(e.post), - 'title': e.title, - 'source': e.source - } - - add_action_log(e.post.author, ActionLogEntry.ActionType.NewForumPost, meta) - - -@on_trigger(OnForumEditPost) -def log_forum_edit_post(e: OnForumEditPost): - meta = { - 'author_id': e.post.author.id, - 'post': model_to_dict(e.post), - 'title': e.title, - 'prev_title': e.prev_title, - 'source': e.source, - 'prev_source': e.prev_source - } - - add_action_log(e.user, ActionLogEntry.ActionType.EditForumPost, meta) - - -@on_trigger(OnForumDeletePost) -def log_forum_delete_post(e: OnForumDeletePost): - meta = { - 'author_id': e.post.author.id, - 'post': model_to_dict(e.post), - 'title': e.title, - 'source': e.source - } - - add_action_log(e.user, ActionLogEntry.ActionType.RemoveForumPost, meta) \ No newline at end of file diff --git a/web/events/notifications.py b/web/events/notifications.py deleted file mode 100644 index 412a0d18..00000000 --- a/web/events/notifications.py +++ /dev/null @@ -1,207 +0,0 @@ -import logging -import re - -from modules.forumnewpost import OnForumNewPost -from modules.forumpost import OnForumEditPost -from renderer.utils import render_user_to_json -from web.controllers import articles -from web.views.signup import OnUserSignUp - -from web.models.articles import ArticleLogEntry -from web.controllers.articles import OnEditArticle -from web.models.forum import ForumCategory -from web.models.users import User - -from web.events import on_trigger -from web.controllers.notifications import get_notification_subscribtions, send_user_notification, UserNotification - - -@on_trigger(OnUserSignUp) -def signup_notification(e: OnUserSignUp): - send_user_notification(e.user, UserNotification.NotificationType.Welcome) - - -@on_trigger(OnForumNewPost) -def new_forum_post_notification(e: OnForumNewPost): - user: User = e.post.author - - notification_subscribers = set([subscription.subscriber for subscription in get_notification_subscribtions(forum_thread=e.post.thread)]) - if user in notification_subscribers: - notification_subscribers.remove(user) - - thread = e.post.thread - category = thread.category - if not category: - # find first category that matches - for c in ForumCategory.objects.filter(is_for_comments=True): - category = c - break - section = category.section - - thread_name = thread.name if thread.category_id else thread.article.display_name - - section_url = '/forum/s-%d/%s' % (section.id, articles.normalize_article_name(section.name)) if category else '' - category_url = '/forum/c-%d/%s' % (category.id, articles.normalize_article_name(category.name)) if category else '' - thread_url = '/forum/t-%d/%s' % (thread.id, articles.normalize_article_name(thread_name)) - post_url = '%s#post-%d' % (thread_url, e.post.id) - - meta = { - 'thread': { - 'id': thread.id, - 'name': thread_name, - 'url': thread_url - }, - 'category': { - 'id': category.id, - 'name': category.name, - 'url': category_url - }, - 'section': { - 'id': section.id, - 'name': section.name, - 'url': section_url - }, - 'post': { - 'id': e.post.id, - 'name': e.title, - 'url': post_url - }, - 'author': render_user_to_json(e.post.author), - 'message_source': e.source - } - - if e.post.reply_to: - reply_subscribers = [] - curr_post = e.post - for _ in range(UserNotification.POST_REPLY_TTL): - reply_subscribers.append(curr_post.author) - curr_post = curr_post.reply_to - if not curr_post: - break - - reply_subscribers = set(reply_subscribers) - if user in reply_subscribers: - reply_subscribers.remove(user) - notification_subscribers -= reply_subscribers - - restricted_users = [] - for user in reply_subscribers: - if not user.has_perm('roles.view_forum_posts', e.post): - restricted_users.append(user) - reply_subscribers.difference_update(restricted_users) - - origin_post_url = '%s#post-%d' % (thread_url, e.post.reply_to.id) - - reply_meta = dict(meta) - reply_meta['origin'] = { - 'id': e.post.reply_to.id, - 'name': e.post.reply_to.name, - 'url': origin_post_url - } - - send_user_notification( - recipients=reply_subscribers, - type=UserNotification.NotificationType.NewPostReply, - meta=reply_meta - ) - - restricted_users = [] - for user in notification_subscribers: - if not user.has_perm('roles.view_forum_posts', e.post): - restricted_users.append(user) - notification_subscribers.difference_update(restricted_users) - - send_user_notification( - recipients=notification_subscribers, - type=UserNotification.NotificationType.NewThreadPost, - meta=meta - ) - - -@on_trigger(OnEditArticle) -def new_article_revision_notification(e: OnEditArticle): - log_entry: ArticleLogEntry = e.log_entry - article = log_entry.article - notification_subscribers = [subscription.subscriber for subscription in get_notification_subscribtions(article=log_entry.article) if subscription.subscriber != log_entry.user and subscription.subscriber.has_perm('roles.view_articles', article)] - - send_user_notification(notification_subscribers, UserNotification.NotificationType.NewArticleRevision, meta={ - 'user': render_user_to_json(log_entry.user), - 'article': { - 'uid': article.id, - 'pageId': article.full_name, - 'title': article.title, - }, - 'rev_id': log_entry.id, - 'rev_meta': log_entry.meta, - 'rev_number': log_entry.rev_number, - 'rev_type': log_entry.type, - 'comment': log_entry.comment - }) - - -@on_trigger(OnForumNewPost) -@on_trigger(OnForumEditPost) -def handle_forum_mention(e: OnForumNewPost | OnForumEditPost): - mention_regex = re.compile(r'(?<=@)[\w.-]+') - - if isinstance(e, OnForumNewPost): - mentions = set(map(str.lower, re.findall(mention_regex, e.source))) - else: - old_mentions = set(map(str.lower, re.findall(mention_regex, e.prev_source))) - new_mentions = set(map(str.lower, re.findall(mention_regex, e.source))) - mentions = new_mentions - old_mentions - - mentioned_users = set(User.objects.filter(username__in=mentions, is_active=True, type__in=[User.UserType.Normal, User.UserType.Bot]).exclude(id=e.user.id)) - - thread = e.post.thread - category = thread.category - if not category: - # find first category that matches - for c in ForumCategory.objects.filter(is_for_comments=True): - category = c - break - section = category.section - - thread_name = thread.name if thread.category_id else thread.article.display_name - - section_url = '/forum/s-%d/%s' % (section.id, articles.normalize_article_name(section.name)) if category else '' - category_url = '/forum/c-%d/%s' % (category.id, articles.normalize_article_name(category.name)) if category else '' - thread_url = '/forum/t-%d/%s' % (thread.id, articles.normalize_article_name(thread_name)) - post_url = '%s#post-%d' % (thread_url, e.post.id) - - meta = { - 'thread': { - 'id': thread.id, - 'name': thread_name, - 'url': thread_url - }, - 'category': { - 'id': category.id, - 'name': category.name, - 'url': category_url - }, - 'section': { - 'id': section.id, - 'name': section.name, - 'url': section_url - }, - 'post': { - 'id': e.post.id, - 'name': e.title, - 'url': post_url - }, - 'author': render_user_to_json(e.user), - 'message_source': e.source - } - - restricted_users = [] - for user in mentioned_users: - if not user.has_perm('roles.view_forum_posts', e.post): - restricted_users.append(user) - mentioned_users -= set(restricted_users) - - send_user_notification( - recipients=mentioned_users, - type=UserNotification.NotificationType.ForumMention, - meta=meta - ) \ No newline at end of file diff --git a/web/fields/__init__.py b/web/fields/__init__.py deleted file mode 100644 index dea3f934..00000000 --- a/web/fields/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -from .models import * -from .fields import * -from .widgets import * diff --git a/web/fields/fields.py b/web/fields/fields.py deleted file mode 100644 index caed412a..00000000 --- a/web/fields/fields.py +++ /dev/null @@ -1,63 +0,0 @@ -__all__ = [ - 'PermissionsField', - 'PermissionsOverrideField' -] - -from django import forms - -from web.models.roles import Role -from . import widgets - - -class PermissionsField(forms.Field): - widget = widgets.PermissionsInput - - def clean(self, value): - if not isinstance(value, dict): - raise forms.ValidationError("Invalid permissions data") - - cleaned = { - 'allow': [], - 'deny': [], - 'neutral': [] - } - - for codename, state in value.items(): - if state not in cleaned: - raise forms.ValidationError(f"Invalid state: {state}") - cleaned[state].append(codename) - - return cleaned - - -class PermissionsOverrideField(forms.Field): - widget = widgets.PermissionsOverrideInput - - def __init__(self, *args, exclude_admin=False, **kwargs): - super().__init__(*args, **kwargs) - self.widget.exclude_admin = exclude_admin - - def clean(self, value): - if not isinstance(value, dict): - raise forms.ValidationError("Invalid permissions data") - - cleaned = {} - - for role_id, perms in value.items(): - try: - Role.objects.get(id=role_id) - except: - forms.ValidationError(f"Invalid role id: {role_id}") - - cleaned[role_id] = { - 'allow': [], - 'deny': [], - 'neutral': [] - } - - for codename, state in perms.items(): - if state not in cleaned[role_id]: - raise forms.ValidationError(f"Invalid state: {state}") - cleaned[role_id][state].append(codename) - - return cleaned diff --git a/web/fields/models.py b/web/fields/models.py deleted file mode 100644 index a864173a..00000000 --- a/web/fields/models.py +++ /dev/null @@ -1,48 +0,0 @@ -__all__ = [ - 'CIText', - 'CICharField', - 'CIEmailField', - 'CITextField', - 'CSSColorField' -] - -import re - -from django.core import validators -from django.db import models - -from . import widgets - - -class CSSHexColorValidator(validators.RegexValidator): - regex = r"^#([0-9a-fA-F]{3}){1,2}$|^#([0-9a-fA-F]{4}){1,2}\Z" - message = '颜色格式无效，只允许十六进制值(#000/#000000/#00000000)。' - flags = re.ASCII - - -class CIText: - def get_internal_type(self): - return "CI" + super().get_internal_type() - - def db_type(self, connection): - return "citext" - - -class CICharField(CIText, models.CharField): - pass - - -class CIEmailField(CIText, models.EmailField): - pass - - -class CITextField(CIText, models.TextField): - pass - - -class CSSColorField(models.CharField): - default_validators = [CSSHexColorValidator()] - - def formfield(self, **kwargs): - kwargs.update({'widget': widgets.ColorInput}) - return super().formfield(**kwargs) \ No newline at end of file diff --git a/web/fields/widgets.py b/web/fields/widgets.py deleted file mode 100644 index 6449352b..00000000 --- a/web/fields/widgets.py +++ /dev/null @@ -1,138 +0,0 @@ -__all__ = [ - 'ColorInput', - 'PermissionsInput' -] - -from django import forms - -from web.permissions import ALL_PERMISSIONS - - -class ColorInput(forms.TextInput): - input_type = 'color' - - -class PermissionsInput(forms.Widget): - template_name = 'fields/permissions_widget.html' - - def value_from_datadict(self, data, files, name): - result = {} - for key in data: - if key.startswith('perm-'): - codename = key[5:] - value = data.get(key) - result[codename] = value - return result - - def get_context(self, name, value, attrs): - context = super().get_context(name, value, attrs) - context['perms'] = {} - - if self.instance: - permissions = [perm.codename for perm in self.instance.permissions.all()] - restrictions = [perm.codename for perm in self.instance.restrictions.all()] - else: - permissions = [] - restrictions = [] - - for perm in ALL_PERMISSIONS.values(): - state = 'neutral' - if perm.codename in permissions: - state = 'allow' - elif perm.codename in restrictions: - state = 'deny' - - if not perm.group in context['perms']: - context['perms'][perm.group] = [] - - context['perms'][perm.group].append({ - 'name': perm.name, - 'codename': perm.codename, - 'description': perm.description, - 'allow': state == 'allow', - 'deny': state == 'deny', - 'neutral': state == 'neutral', - }) - - for perm_group in context['perms']: - context['perms'][perm_group].sort( - key=lambda perm: perm['codename'] - .replace('view', '0') - .replace('create', '1') - .replace('edit', '2') - .replace('delete', '3') - ) - - return context - - -class PermissionsOverrideInput(forms.Widget): - template_name = 'fields/permissions_override_widget.html' - - def __init__(self, *args, exclude_admin=False, **kwargs): - super().__init__(*args, **kwargs) - self.exclude_admin = exclude_admin - - - def value_from_datadict(self, data, files, name): - result = {} - for key in data: - if key.startswith('perm-'): - _, role_id, codename = key.split('-', 2) - value = data.get(key) - if role_id not in result: - result[role_id] = {} - result[role_id][codename] = value - return result - - def get_context(self, name, value, attrs): - context = super().get_context(name, value, attrs) - context['roles'] = [] - - if self.instance: - perm_overrides = self.instance.permissions_override.all().order_by('role__index') - else: - perm_overrides = [] - - for perm_override in perm_overrides: - permissions = [perm.codename for perm in perm_override.permissions.all()] - restrictions = [perm.codename for perm in perm_override.restrictions.all()] - - context['roles'].append({ - 'role': perm_override.role, - 'perms': {} - }) - - for perm in ALL_PERMISSIONS.values(): - if self.exclude_admin and perm.admin_only: - continue - - state = 'neutral' - if perm.codename in permissions: - state = 'allow' - elif perm.codename in restrictions: - state = 'deny' - - if not perm.group in context['roles'][-1]['perms']: - context['roles'][-1]['perms'][perm.group] = [] - - context['roles'][-1]['perms'][perm.group].append({ - 'name': perm.name, - 'codename': perm.codename, - 'description': perm.description, - 'allow': state == 'allow', - 'deny': state == 'deny', - 'neutral': state == 'neutral', - }) - - for n, role in enumerate(context['roles']): - for perm_group in role['perms']: - context['roles'][n]['perms'][perm_group].sort( - key=lambda perm: perm['codename'] - .replace('view', '0') - .replace('create', '1') - .replace('edit', '2') - .replace('delete', '3') - ) - - return context diff --git a/web/forms.py b/web/forms.py deleted file mode 100644 index fb771009..00000000 --- a/web/forms.py +++ /dev/null @@ -1,85 +0,0 @@ -from django import forms -from django.core.validators import RegexValidator - -from web.models.roles import Role -from web.models.users import User - - -class UserProfileForm(forms.ModelForm): - full_name = forms.CharField(label='姓名', required=False) - - class Meta: - model = User - fields = ['full_name', 'bio', 'avatar'] - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - - if self.instance: - if self.instance.first_name and self.instance.last_name: - self.fields['full_name'].initial = f"{self.instance.first_name} {self.instance.last_name}" - elif self.instance.first_name: - self.fields['full_name'].initial = self.instance.first_name - - def save(self, commit=True): - full_name = self.cleaned_data.get('full_name', '').strip() - if full_name: - parts = full_name.rsplit(' ', 1) - self.instance.first_name = parts[0] - self.instance.last_name = parts[1] if len(parts) > 1 else '' - else: - self.instance.first_name = '' - self.instance.last_name = '' - return super().save(commit=commit) - -class InviteForm(forms.Form): - _selected_user = forms.IntegerField(widget=forms.MultipleHiddenInput, required=False) - email = forms.EmailField(widget=forms.EmailInput(attrs={'class': 'vTextField'})) - roles = forms.ModelMultipleChoiceField(label='用户组权限', queryset=Role.objects.exclude(slug__in=['everyone', 'registered']), required=False) - - -class ClaimLinkForm(forms.Form): - user = forms.ModelChoiceField( - label='待认领的 Wikidot 账号', - queryset=User.objects.none(), - required=True, - ) - roles = forms.ModelMultipleChoiceField( - label='认领后获得的用户组', - queryset=Role.objects.exclude(slug__in=['everyone', 'registered']), - required=False, - ) - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.fields['user'].queryset = User.objects.filter( - type=User.UserType.Wikidot, is_active=False, - ).order_by('wikidot_username') - - -class CreateAccountForm(forms.Form): - username = forms.CharField(label='用户名', required=True, validators=[RegexValidator(r'^[A-Za-z0-9_-]+$', '用户名格式无效')]) - password = forms.CharField(label='密码', widget=forms.PasswordInput(), required=True) - password2 = forms.CharField(label='确认密码', widget=forms.PasswordInput(), required=True) - - def clean_password2(self): - cd = self.cleaned_data - if cd['password'] != cd['password2']: - raise forms.ValidationError('密码不匹配') - return cd['password2'] - - -class CreateBotForm(forms.Form): - username = forms.CharField( - label='机器人昵称', - required=True, - validators=[ - RegexValidator(r'^[A-Za-z0-9_-]+$', '用户名格式无效') - ] - ) - -class SignupForm(forms.Form): - username = forms.CharField(label='用户名', required=True, validators=[RegexValidator(r'^[\w.-]+\Z', '格式错误')]) - password = forms.CharField(label='密码', widget=forms.PasswordInput(), required=True) - password_confirm = forms.CharField(label='确认密码', widget=forms.PasswordInput(), required=True) - verification_code = forms.CharField(label='验证码', required=False) \ No newline at end of file diff --git a/web/management/__init__.py b/web/management/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/web/management/commands/__init__.py b/web/management/commands/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/web/management/commands/createsite.py b/web/management/commands/createsite.py deleted file mode 100644 index c1826e8b..00000000 --- a/web/management/commands/createsite.py +++ /dev/null @@ -1,35 +0,0 @@ -from django.core.management.base import BaseCommand - -from web.models.settings import Settings -from web.models.site import Site - - -class Command(BaseCommand): - help = 'Creates a website' - - def add_arguments(self, parser): - parser.add_argument('-s', '--slug', required=True, help='网站标识符 (e.g.: wikit-site, wikit, scp, backrooms)') - parser.add_argument('-d', '--domain', required=True, help='网站域名 (e.g.: projwikit.unitreaty.org)') - parser.add_argument('-D', '--media-domain', required=False, help='本地文件沙箱域名 (e.g.: files.projwikit.unitreaty.org)') - parser.add_argument('-t', '--title', required=True, help='网站标题 (e.g.: SCP Foundation, The Backrooms)') - parser.add_argument('-H', '--headline', required=True, help='网站副标题 (e.g.: 控制, 收容, 保护)') - - def handle(self, *args, **options): - if Site.objects.exists(): - curr_site = Site.objects.get() - print(f"无法创建多个网站！已存在 \"{curr_site.title}\" on {curr_site.domain}.") - return - - media_domain = options["media_domain"] if options["media_domain"] else options["domain"] - - site = Site( - title=options["title"], - headline=options["headline"], - slug=options["slug"], - domain=options["domain"], - media_domain=media_domain - ) - site.save() - - settings = Settings(site=site) - settings.save() diff --git a/web/management/commands/initsearch.py b/web/management/commands/initsearch.py deleted file mode 100644 index 55446fe6..00000000 --- a/web/management/commands/initsearch.py +++ /dev/null @@ -1,28 +0,0 @@ -import concurrent - -from django.core.management.base import BaseCommand -from tqdm import tqdm - -from web import threadvars -from web.controllers.search import update_search_index -from web.models import Article, Site - - -class Command(BaseCommand): - help = 'Recreates index for article text search.\nNote: very heavy operation.\nUsually done after bulk import or migrating the database.\nPer-article indexes will be updated on-demand and do not require running this' - - def handle(self, *args, **options): - all_articles = Article.objects.all() - - if not all_articles: - return - - site = Site.objects.get() - - def worker(article): - with threadvars.context(): - threadvars.put('current_site', site) - update_search_index(article) - - with concurrent.futures.ThreadPoolExecutor(max_workers=16) as executor: - list(tqdm(executor.map(worker, all_articles), total=len(all_articles))) diff --git a/web/management/commands/migrate.py b/web/management/commands/migrate.py deleted file mode 100644 index 01a3f621..00000000 --- a/web/management/commands/migrate.py +++ /dev/null @@ -1,13 +0,0 @@ -from django.core.management.commands.migrate import Command as MigrateCommand - -from web.signals import just_after_migration - - -class Command(MigrateCommand): - def migration_progress_callback(self, action, migration=None, fake=False): - super().migration_progress_callback(action, migration, fake) - just_after_migration.send( - sender=self, - migration=f'{migration.app_label}.{migration.name[:migration.name.index('_')]}' if migration else None, - action=action - ) \ No newline at end of file diff --git a/web/management/commands/runserver.py b/web/management/commands/runserver.py deleted file mode 100644 index 170a471f..00000000 --- a/web/management/commands/runserver.py +++ /dev/null @@ -1,207 +0,0 @@ -import sys - -import psutil -from django.core.management.commands.runserver import Command as BaseRunserverCommand -import os -import shutil -import subprocess -import atexit - -from django.core.servers.basehttp import WSGIServer, WSGIRequestHandler -from watchdog.observers import Observer -from watchdog.events import FileSystemEventHandler -import platform -import threading -import time - - -_ALREADY_WATCHING = False -_ALREADY_WATCHING_RUST = False - -_SHELL = platform.system() == "Windows" - - -def _safe_kill(p): - try: - p.terminate() - p.wait(5) - except: - pass - try: - p.kill() - except: - pass - - -class WSGIRequestHandlerWithRawURL(WSGIRequestHandler): - def get_environ(self): - env_base = super().get_environ() - env_base['RAW_PATH'] = self.path - return env_base - - -class WSGIServerWithRawURL(WSGIServer): - def __init__(self, address, _handler, **kwargs): - super().__init__(address, WSGIRequestHandlerWithRawURL, **kwargs) - - -class Command(BaseRunserverCommand): - server_cls = WSGIServerWithRawURL - - def add_arguments(self, parser): - super().add_arguments(parser) - parser.add_argument('--watch', action='store_true', dest='watch', help='Runs JS build in development mode') - parser.add_argument('--ftml-release', action='store_true', dest='ftml_release', help='Build FTML in release mode') - parser.add_argument('--internal-run', action='store_true', dest='internal_run', help='This starts the actual server') - - def handle(self, *args, **options): - if not options['watch'] or options['internal_run']: - super().handle(*args, **options) - return - - self.watch_js() - self.watch_ftml(options['ftml_release']) - - def watch_js(self): - global _ALREADY_WATCHING - if _ALREADY_WATCHING or os.environ.get('RUN_MAIN') == 'true': - return - print('Will watch JS '+repr(self)) - base_project_dir = os.path.dirname(__file__) + '/../..' - p = subprocess.Popen(['yarn', 'run', 'watch'], shell=_SHELL, cwd=base_project_dir + '/js') - atexit.register(lambda: _safe_kill(p)) - _ALREADY_WATCHING = True - - # Runs this command but with --internal-run - def run_child(self, second=False): - add_args = ['--skip-checks'] - # with shell=False it does NOT interrupt as intended - c = subprocess.Popen([sys.executable] + sys.argv + ['--internal-run', '--noreload'] + add_args, shell=_SHELL) - return c - - def watch_ftml(self, ftml_release=False): - # You cannot reload a PYD file. For this reason, entire watcher will restart. - global _ALREADY_WATCHING_RUST - if _ALREADY_WATCHING_RUST or os.environ.get('RUN_MAIN') == 'true': - return True - print('Will watch FTML '+repr(self)) - base_project_dir = './ftml' - - observer = Observer() - - class FtmlWatcher(FileSystemEventHandler): - def __init__(self): - super().__init__() - self.lock = threading.RLock() - self.is_updated = False - self.updated_rust = False - self.should_continue_normally = False - if not self.is_compiled(): - self.updated(base_project_dir + '/src') - - def on_moved(self, event): - super().on_moved(event) - self.updated(event.dest_path) - - def on_created(self, event): - super().on_created(event) - self.updated(event.src_path) - - def on_deleted(self, event): - super().on_deleted(event) - self.updated(event.src_path) - - def on_modified(self, event): - super().on_modified(event) - self.updated(event.src_path) - - def filenames(self): - if platform.system() == 'Windows': - filename = ('ftml.dll',) - new_filename = 'ftml.pyd' - else: - filename = ('ftml.so', 'libftml.so', 'libftml.dylib') - new_filename = filename[0] - return filename, new_filename - - def is_compiled(self): - filename, new_filename = self.filenames() - target_dir = '/target/release/' if ftml_release else '/target/debug/' - for file in filename + (new_filename,): - if os.path.exists(base_project_dir + target_dir + file): - return True - return False - - def updated(self, filename): - filename = filename.replace('\\', '/') - # filename must start with ./ - if filename.endswith('.py')\ - or filename.endswith('.html')\ - or filename.startswith(base_project_dir + '/src/')\ - or filename == base_project_dir + '/src': - with self.lock: - self.is_updated = True - self.updated_rust = not filename.endswith('.py') and not filename.endswith('.html') - - w = FtmlWatcher() - observer.schedule(w, '.', recursive=True) - observer.start() - current_child = self.run_child() - while observer.is_alive(): - time.sleep(0.25) - s = current_child.poll() - if s is not None: - print('Child process died with status %d' % s) - return - with w.lock: - is_updated = w.is_updated - updated_rust = w.updated_rust - w.is_updated = False - if not is_updated: - continue - if not updated_rust: - # This branch means we just have .py updates; restart child, don't do anything else - print('Interrupting child process...') - parent = psutil.Process(current_child.pid) - for child in parent.children(recursive=True): - child.kill() - _safe_kill(current_child) - print('Reloading...') - current_child = self.run_child(True) - else: - rel_cmdline = ['--release'] if ftml_release else [] - p = subprocess.Popen(['cargo', 'build'] + rel_cmdline, cwd=base_project_dir) - code = p.wait() - if code != 0: - print('FTML compilation failed; skipping') - continue - filename, new_filename = w.filenames() - target_dir = '/target/release/' if ftml_release else '/target/debug/' - for file in filename: - if os.path.exists(base_project_dir + target_dir + file): - # Kill child - if current_child: - print('Interrupting child process...') - # KILL everything in the child tree - # Otherwise we have hanging processes that prevent us from copying into PYD/so - parent = psutil.Process(current_child.pid) - for child in parent.children(recursive=True): - child.kill() - _safe_kill(current_child) - print('Copying FTML library') - copied = False - for i in range(30): - try: - shutil.copy(base_project_dir + target_dir + file, base_project_dir + '/' + new_filename) - copied = True - break - except PermissionError: - print('Could not replace FTML library, retrying...') - time.sleep(1) - if not copied: - print('Fatal: could not unlock FTML dynamic library, reloading is not possible. Is this the only instance running?') - return - # Create another instance of runserver - print('Reloading...') - current_child = self.run_child(True) - break diff --git a/web/management/commands/seed.py b/web/management/commands/seed.py deleted file mode 100644 index 862f41dd..00000000 --- a/web/management/commands/seed.py +++ /dev/null @@ -1,37 +0,0 @@ -from django.core.management.base import BaseCommand, CommandError - -from web import threadvars -from web.models.site import Site - - -class Command(BaseCommand): - help = 'Seeds the database' - - def add_arguments(self, parser): - parser.add_argument("-a", "--archive", required=True, help="从指定的 wikitCLI 备份归档进行迁移") - # parser.add_argument("-o", "--fetch-from", required=False, help="Fetch from existing site, running on RuFoundation Engine.\nMake sure that the site engine version matches your version") - parser.add_argument("-s", "--scope", choices=['all', 'pages', 'forum'], default='all', - help="迁移范围（仅归档模式）：all=全部，pages=仅页面（含文件/标签/评分/父页面），forum=仅论坛。默认 all") - parser.add_argument("-t", "--force-tags", action='store_true', - help="强制迁移标签：绕过站点“禁止用户创建标签”设置，导入时按需新建标签") - parser.add_argument("--no-votes", action='store_true', - help="跳过页面评分（votings）的迁移") - parser.add_argument("--update-existing", action='store_true', - help="对已存在的文章也重新同步标签与评分（默认已存在文章整体跳过；仅补充缺失的评分，不覆盖已有投票）") - - def handle(self, *args, **options): - if not Site.objects.exists(): - raise CommandError("You must create new site to run this command") - - site = Site.objects.get() - - with threadvars.context(): - threadvars.put('current_site', site) - from web.seeds import wikit_archive - wikit_archive.run( - options["archive"], - scope=options["scope"], - force_tags=options["force_tags"], - import_votes=not options["no_votes"], - update_existing=options["update_existing"], - ) diff --git a/web/middleware.py b/web/middleware.py deleted file mode 100644 index 70d6ff26..00000000 --- a/web/middleware.py +++ /dev/null @@ -1,189 +0,0 @@ -from django.conf import settings -from django.db.models import Q -from django.http import HttpResponseRedirect -from django.core.exceptions import PermissionDenied -from django.contrib.auth import get_user_model -from django.shortcuts import render - -from web.models.site import Site -from web.models.users import ExtendedAnonymousUser -from web import threadvars - -import logging -import django.middleware.csrf -import urllib.parse - - -User = get_user_model() - -class BotAuthTokenMiddleware(object): - def __init__(self, get_response): - self.get_response = get_response - - def __call__(self, request): - if "Authorization" in request.headers and request.headers["Authorization"].startswith("Bearer "): - try: - request.user = User.objects.get(type="bot", api_key=request.headers["Authorization"][7:]) - setattr(request, 'csrf_processing_done', True) - except User.DoesNotExist: - pass - return self.get_response(request) - - -class FixRawPathMiddleware(object): - def __init__(self, get_response): - self.get_response = get_response - - def __call__(self, request): - # normalize meta. - # if we do not have RAW_PATH, but have RAW_URI, get path from RAW_URI. - # if we do not have both, put at least regular path there (wrong, but won't crash) - - if 'RAW_PATH' not in request.META: - if 'RAW_URI' in request.META: - parsed = urllib.parse.urlparse(request.META['RAW_URI']) - request.META['RAW_PATH'] = parsed.path - else: - request.META['RAW_PATH'] = request.path - - return self.get_response(request) - - -# This class redirects the user if they are trying to access media file using non-media host and the other way around. -# This is for cookie safety -class MediaHostMiddleware(object): - def __init__(self, get_response): - self.get_response = get_response - - def __call__(self, request): - # set current site - with threadvars.context(): - # find site by domain+port - raw_host = request.get_host() - if ':' not in raw_host and 'SERVER_PORT' in request.META: - raw_host += ':' + request.META['SERVER_PORT'] - possible_sites = Site.objects.filter(Q(domain=raw_host) | Q(media_domain=raw_host)) - else: - possible_sites = [] - if not possible_sites: - # find site by domain - raw_host = request.get_host().split(':')[0] - possible_sites = Site.objects.filter(Q(domain=raw_host) | Q(media_domain=raw_host)) - if not possible_sites: - if Site.objects.exists(): - logging.warning('This domain (\'%s\') is not configured' % raw_host) - raise PermissionDenied() - else: - return render(request, 'no_site.html') - - site = possible_sites[0] - threadvars.put('current_site', site) - - is_media_host = request.get_host().split(':')[0] == site.media_domain - media_prefixes = ['local--files', 'local--code', 'local--html', 'local--theme'] - is_media_url = bool([x for x in media_prefixes if request.path.startswith(f'/{x}/')]) - - if site.media_domain != site.domain: - non_media_host = site.domain - - if is_media_host and not is_media_url: - return HttpResponseRedirect('//%s%s' % (non_media_host, request.get_full_path())) - elif not is_media_host and is_media_url: - return HttpResponseRedirect('//%s%s' % (site.media_domain, request.get_full_path())) - - response = self.get_response(request) - - if is_media_host or (site.domain == site.media_domain and is_media_url): - response['Access-Control-Allow-Origin'] = '*' - else: - response['X-Content-Type-Options'] = 'nosniff' - response['X-Frame-Options'] = 'DENY' - - return response - - -class UserContextMiddleware(object): - def __init__(self, get_response): - self.get_response = get_response - - def __call__(self, request): - threadvars.put('current_user', request.user) - return self.get_response(request) - - -class CsrfViewMiddleware(django.middleware.csrf.CsrfViewMiddleware): - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self.request = None - - @property - def csrf_trusted_origins_hosts(self): - return [site.domain for site in Site.objects.all()] - - @property - def allowed_origins_exact(self): - port = ':'+str(self.request.META['SERVER_PORT']) - hosts = self.csrf_trusted_origins_hosts - return \ - ['http://'+host+port for host in hosts] +\ - ['http://'+host for host in hosts] +\ - ['https://'+host for host in hosts] - - @property - def allowed_origin_subdomains(self): - return dict() - - def process_view(self, request, callback, callback_args, callback_kwargs): - self.request = request - return super().process_view(request, callback, callback_args, callback_kwargs) - - -class ForwardedPortMiddleware(object): - def __init__(self, get_response): - self.get_response = get_response - - def __call__(self, request): - request.META['HTTP_HOST'] = request.META['HTTP_HOST'].split(':')[0] - return self.get_response(request) - - -class DropWikidotAuthMiddleware(object): - def __init__(self, get_response): - self.get_response = get_response - - def __call__(self, request): - response = self.get_response(request) - for cookie in request.COOKIES: - if cookie in ['wikidot_token7', 'wikidot_udsession', 'WIKIDOT_SESSION_ID']: - response.delete_cookie(cookie, path='/') - if cookie.startswith('WIKIDOT_SESSION_ID_'): - response.delete_cookie(cookie, path='/') - return response - - -class SpyRequestMiddleware(object): - def __init__(self, get_response): - self.get_response = get_response - - def __call__(self, request): - with threadvars.context(): - x_forwarded_for = request.META.get('HTTP_X_FORWARDED_FOR') - if x_forwarded_for: - ip = x_forwarded_for.split(',')[0] - else: - ip = request.META.get('REMOTE_ADDR') - - threadvars.put('current_request', request) - threadvars.put('current_client_ip', ip) - return self.get_response(request) - - -# TODO: Handle this shit properly -class ExtendedAnonymousMiddleware: - def __init__(self, get_response): - self.get_response = get_response - - def __call__(self, request): - if request.user.is_anonymous: - request.user.__class__ = ExtendedAnonymousUser - return self.get_response(request) \ No newline at end of file diff --git a/web/migrations/0001_initial.py b/web/migrations/0001_initial.py deleted file mode 100644 index 33f77328..00000000 --- a/web/migrations/0001_initial.py +++ /dev/null @@ -1,301 +0,0 @@ -# Generated by Django 4.0.6 on 2022-07-23 14:02 - -import auto_prefetch -import django.contrib.auth.models -from django.conf import settings -from django.db import migrations, models -import django.db.models.deletion - -import web.fields - - -class Migration(migrations.Migration): - - initial = True - - dependencies = [ - migrations.swappable_dependency(settings.AUTH_USER_MODEL), - ('auth', '0012_alter_user_first_name_max_length'), - ] - - system_migrated_operations = [ - migrations.RunSQL('CREATE EXTENSION IF NOT EXISTS citext'), - migrations.CreateModel( - name='UsedToken', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('token', models.TextField(verbose_name='令牌')), - ('is_case_sensitive', models.BooleanField(default=True, verbose_name='区分大小写')), - ], - options={ - 'verbose_name': '已使用令牌', - 'verbose_name_plural': '已使用令牌', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.CreateModel( - name='VisualUserGroup', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(unique=True, verbose_name='组名称')), - ('index', models.IntegerField(default=0, verbose_name='列表排序')), - ], - options={ - 'verbose_name': '视觉组', - 'verbose_name_plural': '视觉组', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.CreateModel( - name='User', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('password', models.CharField(max_length=128, verbose_name='密码')), - ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='上次登录')), - ('is_superuser', models.BooleanField(default=False, help_text='指明此用户拥有所有权限而无需显式分配。', verbose_name='超级用户状态')), - ('first_name', models.CharField(blank=True, max_length=150, verbose_name='名')), - ('last_name', models.CharField(blank=True, max_length=150, verbose_name='姓')), - ('email', models.EmailField(blank=True, max_length=254, verbose_name='邮箱地址')), - ('is_staff', models.BooleanField(default=False, help_text='指明用户是否可以登录到此管理站点。', verbose_name='工作人员状态')), - ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='加入日期')), - ('username', web.fields.CITextField(error_messages={'unique': '此用户名已存在'}, max_length=150, unique=True, validators=[web.models.users.StrictUsernameValidator()], verbose_name='用户名')), - ('wikidot_username', web.fields.CITextField(max_length=150, null=True, unique=True, validators=[web.models.users.StrictUsernameValidator()], verbose_name='Wikidot用户名')), - ('type', models.TextField(choices=[('normal', '普通'), ('wikidot', 'Wikidot用户'), ('system', '系统'), ('bot', '机器人')], default='normal', verbose_name='类型')), - ('avatar', models.ImageField(blank=True, null=True, upload_to='-/users', verbose_name='头像')), - ('bio', models.TextField(blank=True, verbose_name='个人简介')), - ('api_key', models.CharField(blank=True, max_length=67, null=True, unique=True, verbose_name='API密钥')), - ('is_forum_active', models.BooleanField(default=True, verbose_name='论坛已激活')), - ('forum_inactive_until', models.DateTimeField(null=True, verbose_name='论坛停用至')), - ('is_active', models.BooleanField(default=True, verbose_name='已激活')), - ('inactive_until', models.DateTimeField(null=True, verbose_name='停用至')), - ('is_editor', models.BooleanField(default=False, verbose_name='成员状态')), - ('groups', models.ManyToManyField(blank=True, help_text='此用户所属的组。用户将获得其所属组的所有权限。', related_name='user_set', related_query_name='user', to='auth.group', verbose_name='组')), - ('user_permissions', models.ManyToManyField(blank=True, help_text='此用户的特定权限。', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='用户权限')), - ('visual_group', auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.visualusergroup', verbose_name='视觉组')), - ], - options={ - 'verbose_name': '用户', - 'verbose_name_plural': '用户', - }, - managers=[ - ('objects', django.contrib.auth.models.UserManager()), - ], - ), - ] - - operations = [ - *system_migrated_operations, - migrations.CreateModel( - name='Article', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('category', models.TextField(default='_default', verbose_name='分类')), - ('name', models.TextField(verbose_name='名称')), - ('title', models.TextField(verbose_name='标题')), - ('locked', models.BooleanField(default=False, verbose_name='页面已保护')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='创建时间')), - ('updated_at', models.DateTimeField(auto_now=True, verbose_name='修改时间')), - ('author', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='作者')), - ('parent', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.article', verbose_name='父页面')), - ], - options={ - 'verbose_name': '文章', - 'verbose_name_plural': '文章', - 'permissions': [('can_vote_article', '可以给文章投票'), ('can_lock_article', '可以锁定页面禁止编辑')], - }, - ), - migrations.CreateModel( - name='Settings', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('type', models.TextField(choices=[('disabled', '禁用'), ('updown', '加减'), ('stars', '星级')], default=None, null=True, verbose_name='评分系统')), - ], - options={ - 'verbose_name': '设置', - 'verbose_name_plural': '设置', - }, - ), - migrations.CreateModel( - name='Site', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('slug', models.TextField(verbose_name='缩写')), - ('title', models.TextField(verbose_name='标题')), - ('headline', models.TextField(verbose_name='副标题')), - ('icon', models.ImageField(blank=True, null=True, upload_to='-/sites', verbose_name='图标')), - ('domain', models.TextField(verbose_name='文章域名')), - ('media_domain', models.TextField(verbose_name='文件域名')), - ('settings', models.OneToOneField(on_delete=django.db.models.deletion.DO_NOTHING, to='web.settings')), - ], - options={ - 'verbose_name': '站点', - 'verbose_name_plural': '站点', - 'permissions': [('can_vote_article', '可以给文章投票')], - }, - ), - migrations.CreateModel( - name='Vote', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('rate', models.IntegerField(verbose_name='评分')), - ('article', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='votes', to='web.article', verbose_name='文章')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ('user', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='用户')), - ], - options={ - 'verbose_name': '评分', - 'verbose_name_plural': '评分', - }, - ), - migrations.CreateModel( - name='Tag', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(unique=True, verbose_name='名称')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '标签', - 'verbose_name_plural': '标签', - }, - ), - migrations.CreateModel( - name='File', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(verbose_name='文件名')), - ('media_name', models.TextField(verbose_name='文件系统中的文件名')), - ('mime_type', models.TextField(verbose_name='MIME类型')), - ('size', models.PositiveBigIntegerField(verbose_name='文件大小')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='创建时间')), - ('deleted_at', models.DateTimeField(blank=True, null=True)), - ('article', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章')), - ('author', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='created_files', to=settings.AUTH_USER_MODEL, verbose_name='文件作者')), - ('deleted_by', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='deleted_files', to=settings.AUTH_USER_MODEL, verbose_name='删除文件的用户')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '文件', - 'verbose_name_plural': '文件', - }, - ), - migrations.CreateModel( - name='Category', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(verbose_name='名称')), - ('settings', models.OneToOneField(on_delete=django.db.models.deletion.DO_NOTHING, to='web.settings')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '分类', - 'verbose_name_plural': '分类', - 'permissions': [('add_article_in_category', '可以在分类中添加新文章'), ('change_article_in_category', '可以修改分类中的文章'), ('delete_article_in_category', '可以删除分类中的文章'), ('can_vote_article_in_category', '可以为分类中的文章投票'), ('can_lock_article_in_category', '可以锁定分类中的页面禁止编辑')], - }, - ), - migrations.CreateModel( - name='ArticleVersion', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('source', models.TextField(verbose_name='源代码')), - ('rendered', models.TextField(blank=True, null=True, verbose_name='文章渲染结果')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='创建时间')), - ('article', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '文章版本', - 'verbose_name_plural': '文章版本', - }, - ), - migrations.CreateModel( - name='ArticleLogEntry', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('type', models.TextField(choices=[('source', '源代码'), ('title', '标题'), ('name', '名称'), ('tags', '标签'), ('new', '新建'), ('parent', '父页面'), ('file_added', '文件添加'), ('file_deleted', '文件删除'), ('file_renamed', '文件重命名'), ('wikidot', 'Wikidot')], verbose_name='类型')), - ('meta', models.JSONField(blank=True, default=dict, verbose_name='元数据')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='创建时间')), - ('comment', models.TextField(blank=True, verbose_name='注释')), - ('rev_number', models.PositiveIntegerField(verbose_name='版本号')), - ('article', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='用户')), - ], - options={ - 'verbose_name': '日志条目', - 'verbose_name_plural': '日志条目', - }, - ), - migrations.AddField( - model_name='article', - name='site', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AddField( - model_name='article', - name='tags', - field=models.ManyToManyField(blank=True, related_name='articles', to='web.tag', verbose_name='标签'), - ), - migrations.AddConstraint( - model_name='vote', - constraint=models.UniqueConstraint(fields=('site', 'article', 'user'), name='web_vote_unique'), - ), - migrations.AddIndex( - model_name='tag', - index=models.Index(fields=['name'], name='web_tag_name_41cd6e_idx'), - ), - migrations.AddConstraint( - model_name='tag', - constraint=models.UniqueConstraint(fields=('site', 'name'), name='web_tag_unique'), - ), - migrations.AddConstraint( - model_name='site', - constraint=models.UniqueConstraint(fields=('domain',), name='web_site_domain_unique'), - ), - migrations.AddConstraint( - model_name='site', - constraint=models.UniqueConstraint(fields=('slug',), name='web_site_slug_unique'), - ), - migrations.AddIndex( - model_name='file', - index=models.Index(fields=['article', 'name'], name='web_file_article_c1ccbd_idx'), - ), - migrations.AddConstraint( - model_name='file', - constraint=models.UniqueConstraint(fields=('site', 'article', 'name', 'deleted_at'), name='web_file_unique'), - ), - migrations.AddIndex( - model_name='category', - index=models.Index(fields=['name'], name='web_categor_name_e51bae_idx'), - ), - migrations.AddConstraint( - model_name='category', - constraint=models.UniqueConstraint(fields=('site', 'name'), name='web_category_unique'), - ), - migrations.AddIndex( - model_name='articleversion', - index=models.Index(fields=['article', 'created_at'], name='web_article_article_eb894c_idx'), - ), - migrations.AddConstraint( - model_name='articlelogentry', - constraint=models.UniqueConstraint(fields=('site', 'article', 'rev_number'), name='web_articlelogentry_unique'), - ), - migrations.AddIndex( - model_name='article', - index=models.Index(fields=['category', 'name'], name='web_article_categor_006394_idx'), - ), - migrations.AddConstraint( - model_name='article', - constraint=models.UniqueConstraint(fields=('site', 'category', 'name'), name='web_article_unique'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0002_rename_type_settings_rating_mode_and_more.py b/web/migrations/0002_rename_type_settings_rating_mode_and_more.py deleted file mode 100644 index 36956851..00000000 --- a/web/migrations/0002_rename_type_settings_rating_mode_and_more.py +++ /dev/null @@ -1,37 +0,0 @@ -# Generated by Django 4.0.6 on 2022-07-23 19:23 - -from django.db import migrations, models -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0001_initial'), - ] - - operations = [ - migrations.RenameField( - model_name='settings', - old_name='type', - new_name='rating_mode', - ), - migrations.RemoveField( - model_name='category', - name='settings', - ), - migrations.RemoveField( - model_name='site', - name='settings', - ), - migrations.AddField( - model_name='settings', - name='category', - field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='settings', to='web.category'), - ), - migrations.AddField( - model_name='settings', - name='site', - field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='settings', to='web.site'), - ), - ] diff --git a/web/migrations/0003_alter_settings_rating_mode_alter_vote_rate.py b/web/migrations/0003_alter_settings_rating_mode_alter_vote_rate.py deleted file mode 100644 index e00ea45c..00000000 --- a/web/migrations/0003_alter_settings_rating_mode_alter_vote_rate.py +++ /dev/null @@ -1,23 +0,0 @@ -# Generated by Django 4.0.6 on 2022-07-23 19:35 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0002_rename_type_settings_rating_mode_and_more'), - ] - - operations = [ - migrations.AlterField( - model_name='settings', - name='rating_mode', - field=models.TextField(choices=[('None', '默认'), ('disabled', '禁用'), ('updown', '加减'), ('stars', '星级')], default=None, null=True, verbose_name='评分系统'), - ), - migrations.AlterField( - model_name='vote', - name='rate', - field=models.FloatField(verbose_name='评分'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0004_alter_settings_rating_mode.py b/web/migrations/0004_alter_settings_rating_mode.py deleted file mode 100644 index 97ce6ed2..00000000 --- a/web/migrations/0004_alter_settings_rating_mode.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 4.0.6 on 2022-07-23 20:06 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0003_alter_settings_rating_mode_alter_vote_rate'), - ] - - operations = [ - migrations.AlterField( - model_name='settings', - name='rating_mode', - field=models.TextField(choices=[('default', '默认'), ('disabled', '禁用'), ('updown', '加减'), ('stars', '星级')], default='default', verbose_name='评分系统'), - ), - ] diff --git a/web/migrations/0005_externallink_externallink_web_externallink_unique.py b/web/migrations/0005_externallink_externallink_web_externallink_unique.py deleted file mode 100644 index 14abffb1..00000000 --- a/web/migrations/0005_externallink_externallink_web_externallink_unique.py +++ /dev/null @@ -1,33 +0,0 @@ -# Generated by Django 4.0.6 on 2022-07-25 18:51 - -from django.db import migrations, models -import django.db.models.deletion -import web.fields - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0004_alter_settings_rating_mode'), - ] - - operations = [ - migrations.CreateModel( - name='ExternalLink', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('link_from', web.fields.CITextField(verbose_name='源文章')), - ('link_to', web.fields.CITextField(verbose_name='目标文章')), - ('link_type', models.TextField(choices=[('include', '包含'), ('link', '链接')], verbose_name='链接类型')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '链接关系', - 'verbose_name_plural': '链接关系', - }, - ), - migrations.AddConstraint( - model_name='externallink', - constraint=models.UniqueConstraint(fields=('site', 'link_from', 'link_to', 'link_type'), name='web_externallink_unique'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0006_articleversion_ast.py b/web/migrations/0006_articleversion_ast.py deleted file mode 100644 index d18994fa..00000000 --- a/web/migrations/0006_articleversion_ast.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 4.0.6 on 2022-07-28 20:21 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0005_externallink_externallink_web_externallink_unique'), - ] - - operations = [ - migrations.AddField( - model_name='articleversion', - name='ast', - field=models.TextField(blank=True, null=True, verbose_name='文章的AST树'), - ), - ] diff --git a/web/migrations/0007_alter_articleversion_ast.py b/web/migrations/0007_alter_articleversion_ast.py deleted file mode 100644 index 624637b5..00000000 --- a/web/migrations/0007_alter_articleversion_ast.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 4.0.6 on 2022-07-30 15:57 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0006_articleversion_ast'), - ] - - operations = [ - migrations.AlterField( - model_name='articleversion', - name='ast', - field=models.JSONField(blank=True, null=True, verbose_name='文章的AST树'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0008_alter_article_options_alter_category_options_and_more.py b/web/migrations/0008_alter_article_options_alter_category_options_and_more.py deleted file mode 100644 index be952df4..00000000 --- a/web/migrations/0008_alter_article_options_alter_category_options_and_more.py +++ /dev/null @@ -1,50 +0,0 @@ -# Generated by Django 4.0.6 on 2022-07-31 14:39 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0007_alter_articleversion_ast'), - ] - - operations = [ - migrations.AlterModelOptions( - name='article', - options={'verbose_name': '文章', 'verbose_name_plural': '文章'}, - ), - migrations.AlterModelOptions( - name='category', - options={'verbose_name': '分类', 'verbose_name_plural': '分类'}, - ), - migrations.AlterModelOptions( - name='site', - options={'verbose_name': '站点', 'verbose_name_plural': '站点'}, - ), - migrations.AddField( - model_name='category', - name='users_can_create', - field=models.BooleanField(default=True, verbose_name='用户可以创建文章'), - ), - migrations.AddField( - model_name='category', - name='users_can_delete', - field=models.BooleanField(default=True, verbose_name='用户可以删除文章'), - ), - migrations.AddField( - model_name='category', - name='users_can_edit', - field=models.BooleanField(default=True, verbose_name='用户可以编辑文章'), - ), - migrations.AddField( - model_name='category', - name='users_can_rate', - field=models.BooleanField(default=True, verbose_name='用户可以给文章投票'), - ), - migrations.AddField( - model_name='category', - name='users_can_view', - field=models.BooleanField(default=True, verbose_name='用户可以浏览文章'), - ), - ] diff --git a/web/migrations/0009_assign_author_to_articles.py b/web/migrations/0009_assign_author_to_articles.py deleted file mode 100644 index f7739ce8..00000000 --- a/web/migrations/0009_assign_author_to_articles.py +++ /dev/null @@ -1,14 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-12 20:24 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0008_alter_article_options_alter_category_options_and_more'), - ] - - operations = [ - migrations.RunSQL('UPDATE web_article a SET author_id=v.user_id FROM web_articlelogentry v WHERE v.article_id=a.id AND v.rev_number=0') - ] diff --git a/web/migrations/0010_update_rimg_syntax.py b/web/migrations/0010_update_rimg_syntax.py deleted file mode 100644 index da6110d8..00000000 --- a/web/migrations/0010_update_rimg_syntax.py +++ /dev/null @@ -1,55 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-14 04:51 - -from django.db import migrations -import re -import logging - - -# This migration converts [[div class="rimg"]] into [[div_ class="rimg"]] -# See https://github.com/SCPru/RuFoundation/issues/51 - - -# logic: [[divclass=""]] -regex = r'\[\[div([^_\]]*)class="([^"]*)"([^\]]*)\]\]' - - -def replacer(match): - before, cls, after = match.groups() - if 'rimg' not in cls.split(' '): - return match[0] - return '[[div_%sclass="%s"%s]]' % (before, cls, after) - - -def convert_rimg(apps, schema_editor): - Article = apps.get_model("web", "Article") - ArticleVersion = apps.get_model("web", "ArticleVersion") - db = schema_editor.connection.alias - articles = Article.objects.using(db).all() - total = len(articles) - done = -1 - for article in articles: - done += 1 - if (done and done % 100 == 0) or done == total - 1: - print('%d...' % done, end='') - import sys - sys.stdout.flush() - latest_version = ArticleVersion.objects.using(db).filter(article=article).order_by('-created_at') - if not latest_version: - continue - latest_version = latest_version[0] - new_source = re.sub(regex, replacer, latest_version.source) - if new_source != latest_version.source: - # cba adding proper version to the article, let's just do it in-place - latest_version.source = new_source - latest_version.save() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0009_assign_author_to_articles'), - ] - - operations = [ - migrations.RunPython(convert_rimg, atomic=True) - ] diff --git a/web/migrations/0011_alter_category_options_article_media_name_and_more.py b/web/migrations/0011_alter_category_options_article_media_name_and_more.py deleted file mode 100644 index a54bb2d3..00000000 --- a/web/migrations/0011_alter_category_options_article_media_name_and_more.py +++ /dev/null @@ -1,38 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-16 01:15 - -from django.db import migrations, models -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0010_update_rimg_syntax'), - ] - - operations = [ - migrations.AlterModelOptions( - name='category', - options={'verbose_name': '分类设置', 'verbose_name_plural': '分类设置'}, - ), - migrations.AddField( - model_name='article', - name='media_name', - field=models.TextField(null=True, verbose_name='文件系统中文件文件夹的名称'), - ), - migrations.AlterField( - model_name='category', - name='users_can_delete', - field=models.BooleanField(default=False, verbose_name='用户可以删除文章'), - ), - migrations.AlterField( - model_name='settings', - name='category', - field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='_settings', to='web.category'), - ), - migrations.AlterField( - model_name='settings', - name='site', - field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='_settings', to='web.site'), - ), - ] diff --git a/web/migrations/0012_assign_uuid_to_articles.py b/web/migrations/0012_assign_uuid_to_articles.py deleted file mode 100644 index adbbe4d9..00000000 --- a/web/migrations/0012_assign_uuid_to_articles.py +++ /dev/null @@ -1,27 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-16 01:16 - -from django.db import migrations, models -from uuid import uuid4 - - -def assign_uuids(apps, schema_editor): - Article = apps.get_model("web", "Article") - db = schema_editor.connection.alias - for article in Article.objects.using(db).all(): - Article.objects.using(db).filter(id=article.id).update(media_name=uuid4()) - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0011_alter_category_options_article_media_name_and_more'), - ] - - operations = [ - migrations.RunPython(assign_uuids), - migrations.AlterField( - model_name='article', - name='media_name', - field=models.TextField(null=False, unique=True, verbose_name='文件系统中文件文件夹的名称'), - ), - ] diff --git a/web/migrations/0013_rename_media_folders.py b/web/migrations/0013_rename_media_folders.py deleted file mode 100644 index cc3dbe14..00000000 --- a/web/migrations/0013_rename_media_folders.py +++ /dev/null @@ -1,54 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-16 01:20 -from pathlib import Path -from uuid import uuid4 - -from django.conf import settings -from django.db import migrations, models - -import os - - -def get_full_name(article): - if article.category == '_default': - return article.name - else: - return '%s:%s' % (article.category, article.name) - - -def partial_quote(url): - return url.replace(':', '%3A').replace('/', '%2F').replace('?', '%3F') - - -def rename_media_folders(apps, schema_editor): - Article = apps.get_model("web", "Article") - ArticleLogEntry = apps.get_model("web", "ArticleLogEntry") - db = schema_editor.connection.alias - for article in Article.objects.using(db).all(): - # 查找重命名记录（如果有） - renames = ArticleLogEntry.objects.using(db).filter(article=article, type='name').order_by('-rev_number') - real_current_dir_name = get_full_name(article) - for rename in renames: - if real_current_dir_name == rename.meta['name']: - real_current_dir_name = rename.meta['prev_name'] - else: - raise ValueError('完整性错误：预期重命名为 %s，但找到 %s' % (real_current_dir_name, rename.meta['name'])) - path_rename_from = Path(settings.MEDIA_ROOT) / article.site.slug / partial_quote(real_current_dir_name) - path_rename_to = Path(settings.MEDIA_ROOT) / article.site.slug / article.media_name - if os.path.exists(path_rename_from): - os.rename(path_rename_from, path_rename_to) - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0012_assign_uuid_to_articles'), - ] - - operations = [ - migrations.RunPython(rename_media_folders), - migrations.AlterField( - model_name='article', - name='media_name', - field=models.TextField(default=uuid4, unique=True, verbose_name='文件系统中文件文件夹的名称'), - ), - ] diff --git a/web/migrations/0014_rename_external_links.py b/web/migrations/0014_rename_external_links.py deleted file mode 100644 index 7281ea1e..00000000 --- a/web/migrations/0014_rename_external_links.py +++ /dev/null @@ -1,51 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-16 01:55 - -from django.db import migrations -import sys - - -def get_full_name(article): - if article.category == '_default': - return article.name - else: - return '%s:%s' % (article.category, article.name) - - -def rename_external_links(apps, schema_editor): - Article = apps.get_model("web", "Article") - ArticleLogEntry = apps.get_model("web", "ArticleLogEntry") - ExternalLink = apps.get_model("web", "ExternalLink") - db = schema_editor.connection.alias - first_log = False - for article in Article.objects.using(db).all(): - # 查找重命名记录（如果有） - renames = ArticleLogEntry.objects.using(db).filter(article=article, type='name').order_by('-rev_number') - old_name = get_full_name(article) - new_name = old_name - for rename in renames: - if old_name == rename.meta['name']: - old_name = rename.meta['prev_name'] - else: - raise ValueError('完整性错误：预期重命名为 %s，但找到 %s' % (old_name, rename.meta['name'])) - if new_name != old_name: - if not first_log: - print('\n', end='') - first_log = True - if len(ExternalLink.objects.using(db).filter(link_from__iexact=new_name)): - print(' 跳过（冲突，请手动处理）：%s -> %s\n ' % (old_name, new_name), end='') - sys.stdout.flush() - else: - print(' 更新：%s -> %s\n ' % (old_name, new_name), end='') - sys.stdout.flush() - ExternalLink.objects.using(db).filter(link_from__iexact=old_name).update(link_from=new_name) - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0013_rename_media_folders'), - ] - - operations = [ - migrations.RunPython(rename_external_links) - ] diff --git a/web/migrations/0015_delete_external_links.py b/web/migrations/0015_delete_external_links.py deleted file mode 100644 index 653a243a..00000000 --- a/web/migrations/0015_delete_external_links.py +++ /dev/null @@ -1,41 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-16 02:04 - -import sys - -from django.db import migrations - - -def get_name(category_and_name): - ss = category_and_name.split(':', 1) - if len(ss) == 2: - return ss[0], ss[1] - else: - return '_default', ss[0] - - -def delete_external_links(apps, schema_editor): - Article = apps.get_model("web", "Article") - ExternalLink = apps.get_model("web", "ExternalLink") - db = schema_editor.connection.alias - first_log = False - # not optimal. easiest, because of name shenanigans we can't easily do join - for link in ExternalLink.objects.using(db).all().distinct('link_from'): - category, name = get_name(link.link_from) - if not len(Article.objects.filter(category__iexact=category, name__iexact=name)): - if not first_log: - print('\n', end='') - first_log = True - print(' delete: %s\n ' % (link.link_from), end='') - sys.stdout.flush() - ExternalLink.objects.using(db).filter(link_from__iexact=link.link_from).delete() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0014_rename_external_links'), - ] - - operations = [ - migrations.RunPython(delete_external_links) - ] diff --git a/web/migrations/0016_lower_article_ids.py b/web/migrations/0016_lower_article_ids.py deleted file mode 100644 index e0f54628..00000000 --- a/web/migrations/0016_lower_article_ids.py +++ /dev/null @@ -1,15 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-16 13:58 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0015_delete_external_links'), - ] - - operations = [ - migrations.RunSQL('update web_article set name=lower(name), category=lower(category)'), - migrations.RunSQL('update web_externallink set link_from=lower(link_from), link_to=lower(link_to)') - ] diff --git a/web/migrations/0017_update_rimg_syntax_2.py b/web/migrations/0017_update_rimg_syntax_2.py deleted file mode 100644 index 26259887..00000000 --- a/web/migrations/0017_update_rimg_syntax_2.py +++ /dev/null @@ -1,54 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-23 19:47 - -from django.db import migrations -import re - - -# This migration converts [[div class="rimg"]] into [[div_ class="rimg"]] -# See https://github.com/SCPru/RuFoundation/issues/51 - - -# logic: [[divclass=""]] -regex = r'\[\[div([^_\]]*)class="([^"]*)"([^\]]*)\]\]' - - -def replacer(match): - before, cls, after = match.groups() - if 'rimg' not in cls.split(' ') and 'cimg' not in cls.split(' ') and 'limg' not in cls.split(' ') and 'img' not in cls.split(' '): - return match[0] - return '[[div_%sclass="%s"%s]]' % (before, cls, after) - - -def convert_rimg(apps, schema_editor): - Article = apps.get_model("web", "Article") - ArticleVersion = apps.get_model("web", "ArticleVersion") - db = schema_editor.connection.alias - articles = Article.objects.using(db).all() - total = len(articles) - done = -1 - for article in articles: - done += 1 - if (done and done % 100 == 0) or done == total - 1: - print('%d...' % done, end='') - import sys - sys.stdout.flush() - latest_version = ArticleVersion.objects.using(db).filter(article=article).order_by('-created_at') - if not latest_version: - continue - latest_version = latest_version[0] - new_source = re.sub(regex, replacer, latest_version.source) - if new_source != latest_version.source: - # cba adding proper version to the article, let's just do it in-place - latest_version.source = new_source - latest_version.save() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0016_lower_article_ids'), - ] - - operations = [ - migrations.RunPython(convert_rimg, atomic=True) - ] diff --git a/web/migrations/0018_alter_category_options_alter_articleversion_article_and_more.py b/web/migrations/0018_alter_category_options_alter_articleversion_article_and_more.py deleted file mode 100644 index e24bd922..00000000 --- a/web/migrations/0018_alter_category_options_alter_articleversion_article_and_more.py +++ /dev/null @@ -1,35 +0,0 @@ -# Generated by Django 4.0.6 on 2022-09-04 15:18 - -from django.db import migrations, models -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0017_update_rimg_syntax_2'), - ] - - operations = [ - migrations.AlterModelOptions( - name='category', - options={'verbose_name': '分类设置', 'verbose_name_plural': '分类设置'}, - ), - migrations.AlterField( - model_name='articleversion', - name='article', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='versions', to='web.article', verbose_name='文章'), - ), - migrations.AddIndex( - model_name='article', - index=models.Index(fields=['created_at'], name='web_article_created_5524a8_idx'), - ), - migrations.AddIndex( - model_name='article', - index=models.Index(fields=['updated_at'], name='web_article_updated_20aa03_idx'), - ), - migrations.AddIndex( - model_name='vote', - index=models.Index(fields=['article'], name='web_vote_article_a54b49_idx'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0018_forumcategory_forumpost_alter_category_options_and_more.py b/web/migrations/0018_forumcategory_forumpost_alter_category_options_and_more.py deleted file mode 100644 index fa720ef0..00000000 --- a/web/migrations/0018_forumcategory_forumpost_alter_category_options_and_more.py +++ /dev/null @@ -1,117 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-27 20:51 - -from django.conf import settings -from django.db import migrations, models -import django.db.models.deletion -import django.db.models.expressions -import django.db.models.lookups - - -class Migration(migrations.Migration): - - dependencies = [ - migrations.swappable_dependency(settings.AUTH_USER_MODEL), - ('web', '0017_update_rimg_syntax_2'), - ] - - operations = [ - migrations.CreateModel( - name='ForumCategory', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(verbose_name='名称')), - ('description', models.TextField(verbose_name='描述')), - ('order', models.IntegerField(default=0, verbose_name='排序顺序')), - ('is_for_comments', models.BooleanField(default=False, verbose_name='在此版块显示文章评论')), - ], - options={ - 'verbose_name': '论坛版块', - 'verbose_name_plural': '论坛版块', - }, - ), - migrations.CreateModel( - name='ForumPost', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(verbose_name='标题')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='创建时间')), - ('updated_at', models.DateTimeField(auto_now=True, verbose_name='修改时间')), - ('deleted_at', models.DateTimeField(verbose_name='删除时间')), - ('author', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='作者')), - ('reply_to', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.forumpost', verbose_name='回复的评论')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '论坛帖子', - 'verbose_name_plural': '论坛帖子', - }, - ), - migrations.AlterModelOptions( - name='category', - options={'verbose_name': '分类设置', 'verbose_name_plural': '分类设置'}, - ), - migrations.AlterField( - model_name='articleversion', - name='article', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='versions', to='web.article', verbose_name='文章'), - ), - migrations.CreateModel( - name='ForumThread', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(verbose_name='标题')), - ('description', models.TextField(verbose_name='描述')), - ('article', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章（如果是评论）')), - ('author', models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='作者')), - ('category', models.ForeignKey(null=True, on_delete=django.db.models.deletion.DO_NOTHING, to='web.forumcategory', verbose_name='版块（如果是主题）')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '论坛主题', - 'verbose_name_plural': '论坛主题', - }, - ), - migrations.CreateModel( - name='ForumSection', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(verbose_name='名称')), - ('description', models.TextField(verbose_name='描述')), - ('order', models.IntegerField(default=0, verbose_name='排序顺序')), - ('is_hidden', models.BooleanField(default=False, verbose_name='隐藏版块')), - ('is_hidden_for_users', models.BooleanField(default=False, verbose_name='仅管理员可见')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '论坛分类', - 'verbose_name_plural': '论坛分类', - }, - ), - migrations.CreateModel( - name='ForumPostVersion', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('source', models.TextField(verbose_name='帖子内容')), - ('post', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.forumpost', verbose_name='帖子')), - ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点')), - ], - options={ - 'verbose_name': '论坛帖子版本', - 'verbose_name_plural': '论坛帖子版本', - }, - ), - migrations.AddField( - model_name='forumcategory', - name='section', - field=models.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, to='web.forumsection', verbose_name='分类'), - ), - migrations.AddField( - model_name='forumcategory', - name='site', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AddConstraint( - model_name='forumthread', - constraint=models.CheckConstraint(check=django.db.models.lookups.Exact(lhs=django.db.models.expressions.Func('article_id', 'category_id', function='num_nonnulls', output_field=models.IntegerField()), rhs=django.db.models.expressions.Value(1)), name='web_forumthread_category_or_article'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0019_category_users_can_comment_forumpost_thread_and_more.py b/web/migrations/0019_category_users_can_comment_forumpost_thread_and_more.py deleted file mode 100644 index 82a77490..00000000 --- a/web/migrations/0019_category_users_can_comment_forumpost_thread_and_more.py +++ /dev/null @@ -1,55 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-27 21:56 - -from django.db import migrations, models -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0018_forumcategory_forumpost_alter_category_options_and_more'), - ] - - operations = [ - migrations.AddField( - model_name='category', - name='users_can_comment', - field=models.BooleanField(default=True, verbose_name='用户可以评论文章'), - ), - migrations.AddField( - model_name='forumpost', - name='thread', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.forumthread', verbose_name='主题'), - preserve_default=False, - ), - migrations.AlterField( - model_name='forumcategory', - name='description', - field=models.TextField(blank=True, verbose_name='描述'), - ), - migrations.AlterField( - model_name='forumcategory', - name='order', - field=models.IntegerField(blank=True, default=0, verbose_name='排序顺序'), - ), - migrations.AlterField( - model_name='forumpost', - name='name', - field=models.TextField(blank=True, verbose_name='标题'), - ), - migrations.AlterField( - model_name='forumsection', - name='description', - field=models.TextField(blank=True, verbose_name='描述'), - ), - migrations.AlterField( - model_name='forumsection', - name='order', - field=models.IntegerField(blank=True, default=0, verbose_name='排序顺序'), - ), - migrations.AlterField( - model_name='forumthread', - name='description', - field=models.TextField(blank=True, verbose_name='描述'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0020_forumthread_is_pinned.py b/web/migrations/0020_forumthread_is_pinned.py deleted file mode 100644 index 343424ac..00000000 --- a/web/migrations/0020_forumthread_is_pinned.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-28 01:00 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0019_category_users_can_comment_forumpost_thread_and_more'), - ] - - operations = [ - migrations.AddField( - model_name='forumthread', - name='is_pinned', - field=models.BooleanField(default=False, verbose_name='置顶'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0021_forumthread_created_at_forumthread_deleted_at_and_more.py b/web/migrations/0021_forumthread_created_at_forumthread_deleted_at_and_more.py deleted file mode 100644 index a7577249..00000000 --- a/web/migrations/0021_forumthread_created_at_forumthread_deleted_at_and_more.py +++ /dev/null @@ -1,35 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-28 03:03 - -from django.db import migrations, models -import django.utils.timezone - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0020_forumthread_is_pinned'), - ] - - operations = [ - migrations.AddField( - model_name='forumthread', - name='created_at', - field=models.DateTimeField(auto_now_add=True, default=django.utils.timezone.now, verbose_name='Время создания'), - preserve_default=False, - ), - migrations.AddField( - model_name='forumthread', - name='deleted_at', - field=models.DateTimeField(null=True, verbose_name='Время удаления'), - ), - migrations.AddField( - model_name='forumthread', - name='updated_at', - field=models.DateTimeField(auto_now=True, verbose_name='Время изменения'), - ), - migrations.AlterField( - model_name='forumpost', - name='deleted_at', - field=models.DateTimeField(null=True, verbose_name='Время удаления'), - ), - ] diff --git a/web/migrations/0022_remove_forumpost_deleted_at_and_more.py b/web/migrations/0022_remove_forumpost_deleted_at_and_more.py deleted file mode 100644 index defa299f..00000000 --- a/web/migrations/0022_remove_forumpost_deleted_at_and_more.py +++ /dev/null @@ -1,26 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-28 03:29 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0021_forumthread_created_at_forumthread_deleted_at_and_more'), - ] - - operations = [ - migrations.RemoveField( - model_name='forumpost', - name='deleted_at', - ), - migrations.RemoveField( - model_name='forumthread', - name='deleted_at', - ), - migrations.AddField( - model_name='forumthread', - name='is_locked', - field=models.BooleanField(default=False, verbose_name='已锁定'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0023_forumpostversion_created_at.py b/web/migrations/0023_forumpostversion_created_at.py deleted file mode 100644 index e18ffc15..00000000 --- a/web/migrations/0023_forumpostversion_created_at.py +++ /dev/null @@ -1,20 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-28 19:40 - -from django.db import migrations, models -import django.utils.timezone - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0022_remove_forumpost_deleted_at_and_more'), - ] - - operations = [ - migrations.AddField( - model_name='forumpostversion', - name='created_at', - field=models.DateTimeField(auto_now_add=True, default=django.utils.timezone.now, verbose_name='创建时间'), - preserve_default=False, - ), - ] \ No newline at end of file diff --git a/web/migrations/0024_forumpostversion_author.py b/web/migrations/0024_forumpostversion_author.py deleted file mode 100644 index 71cfd702..00000000 --- a/web/migrations/0024_forumpostversion_author.py +++ /dev/null @@ -1,21 +0,0 @@ -# Generated by Django 4.0.6 on 2022-08-28 22:05 - -from django.conf import settings -from django.db import migrations, models -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - migrations.swappable_dependency(settings.AUTH_USER_MODEL), - ('web', '0023_forumpostversion_created_at'), - ] - - operations = [ - migrations.AddField( - model_name='forumpostversion', - name='author', - field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='编辑作者'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0025_merge_20220906_1945.py b/web/migrations/0025_merge_20220906_1945.py deleted file mode 100644 index 89ffc8bc..00000000 --- a/web/migrations/0025_merge_20220906_1945.py +++ /dev/null @@ -1,14 +0,0 @@ -# Generated by Django 4.0.6 on 2022-09-06 16:45 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0018_alter_category_options_alter_articleversion_article_and_more'), - ('web', '0024_forumpostversion_author'), - ] - - operations = [ - ] diff --git a/web/migrations/0026_alter_article_updated_at_alter_articlelogentry_type_and_more.py b/web/migrations/0026_alter_article_updated_at_alter_articlelogentry_type_and_more.py deleted file mode 100644 index cf28120f..00000000 --- a/web/migrations/0026_alter_article_updated_at_alter_articlelogentry_type_and_more.py +++ /dev/null @@ -1,33 +0,0 @@ -# Generated by Django 4.1.2 on 2022-11-20 09:27 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0025_merge_20220906_1945'), - ] - - operations = [ - migrations.AlterField( - model_name='article', - name='updated_at', - field=models.DateTimeField(auto_now_add=True, verbose_name='修改时间'), - ), - migrations.AlterField( - model_name='articlelogentry', - name='type', - field=models.TextField(choices=[('source', '源代码'), ('title', '标题'), ('name', '名称'), ('tags', '标签'), ('new', '新建'), ('parent', '父页面'), ('file_added', '文件添加'), ('file_deleted', '文件删除'), ('file_renamed', '文件重命名'), ('wikidot', 'Wikidot'), ('revert', '恢复')], verbose_name='类型'), - ), - migrations.AlterField( - model_name='forumpost', - name='updated_at', - field=models.DateTimeField(auto_now_add=True, verbose_name='修改时间'), - ), - migrations.AlterField( - model_name='forumthread', - name='updated_at', - field=models.DateTimeField(auto_now_add=True, verbose_name='修改时间'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0027_tagscategory_remove_tag_web_tag_unique_and_more.py b/web/migrations/0027_tagscategory_remove_tag_web_tag_unique_and_more.py deleted file mode 100644 index ca09195d..00000000 --- a/web/migrations/0027_tagscategory_remove_tag_web_tag_unique_and_more.py +++ /dev/null @@ -1,67 +0,0 @@ -# Generated by Django 4.1.2 on 2022-12-01 10:48 - -from django.db import migrations, models -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0026_alter_article_updated_at_alter_articlelogentry_type_and_more'), - ] - - operations = [ - migrations.CreateModel( - name='TagsCategory', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(verbose_name='完整名称')), - ('description', models.TextField(blank=True, verbose_name='描述')), - ('priority', models.PositiveIntegerField(null=True, blank=True, verbose_name='排序编号')), - ('slug', models.TextField(unique=True, verbose_name='标识符')), - ], - options={ - 'verbose_name': '标签分类', - 'verbose_name_plural': '标签分类', - }, - ), - migrations.RemoveConstraint( - model_name='tag', - name='web_tag_unique', - ), - migrations.RemoveIndex( - model_name='tag', - name='web_tag_name_41cd6e_idx', - ), - migrations.AlterField( - model_name='tag', - name='name', - field=models.TextField(verbose_name='名称'), - ), - migrations.AddField( - model_name='tagscategory', - name='site', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AddField( - model_name='tag', - name='category', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.tagscategory', verbose_name='分类'), - ), - migrations.AddIndex( - model_name='tag', - index=models.Index(fields=['category', 'name'], name='web_tag_categor_b8c5d5_idx'), - ), - migrations.AddConstraint( - model_name='tag', - constraint=models.UniqueConstraint(fields=('site', 'category', 'name'), name='web_tag_unique'), - ), - migrations.AddIndex( - model_name='tagscategory', - index=models.Index(fields=['name'], name='web_tagscat_name_19e56e_idx'), - ), - migrations.AddConstraint( - model_name='tagscategory', - constraint=models.UniqueConstraint(fields=('site', 'slug'), name='web_tagscategory_unique'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0028_alter_article_options_alter_articlelogentry_options_and_more.py b/web/migrations/0028_alter_article_options_alter_articlelogentry_options_and_more.py deleted file mode 100644 index 7d18c17f..00000000 --- a/web/migrations/0028_alter_article_options_alter_articlelogentry_options_and_more.py +++ /dev/null @@ -1,379 +0,0 @@ -# Generated by Django 4.1.2 on 2022-12-02 13:56 - -import auto_prefetch -from django.conf import settings -from django.db import migrations, models -import django.db.models.deletion -import django.db.models.manager - - -class Migration(migrations.Migration): - - dependencies = [ - migrations.swappable_dependency(settings.AUTH_USER_MODEL), - ('web', '0027_tagscategory_remove_tag_web_tag_unique_and_more'), - ] - - operations = [ - migrations.AlterModelOptions( - name='article', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '文章', 'verbose_name_plural': '文章'}, - ), - migrations.AlterModelOptions( - name='articlelogentry', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '日志条目', 'verbose_name_plural': '日志条目'}, - ), - migrations.AlterModelOptions( - name='articleversion', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '文章版本', 'verbose_name_plural': '文章版本'}, - ), - migrations.AlterModelOptions( - name='category', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '分类设置', 'verbose_name_plural': '分类设置'}, - ), - migrations.AlterModelOptions( - name='externallink', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '链接关系', 'verbose_name_plural': '链接关系'}, - ), - migrations.AlterModelOptions( - name='file', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '文件', 'verbose_name_plural': '文件'}, - ), - migrations.AlterModelOptions( - name='forumcategory', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '论坛版块', 'verbose_name_plural': '论坛版块'}, - ), - migrations.AlterModelOptions( - name='forumpost', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '论坛帖子', 'verbose_name_plural': '论坛帖子'}, - ), - migrations.AlterModelOptions( - name='forumpostversion', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '论坛帖子版本', 'verbose_name_plural': '论坛帖子版本'}, - ), - migrations.AlterModelOptions( - name='forumsection', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '论坛分类', 'verbose_name_plural': '论坛分类'}, - ), - migrations.AlterModelOptions( - name='forumthread', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '论坛主题', 'verbose_name_plural': '论坛主题'}, - ), - migrations.AlterModelOptions( - name='settings', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '设置', 'verbose_name_plural': '设置'}, - ), - migrations.AlterModelOptions( - name='site', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '站点', 'verbose_name_plural': '站点'}, - ), - migrations.AlterModelOptions( - name='tag', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '标签', 'verbose_name_plural': '标签'}, - ), - migrations.AlterModelOptions( - name='tagscategory', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '标签分类', 'verbose_name_plural': '标签分类'}, - ), - migrations.AlterModelOptions( - name='vote', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '评分', 'verbose_name_plural': '评分'}, - ), - migrations.AlterModelManagers( - name='article', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='articlelogentry', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='articleversion', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='category', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='externallink', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='file', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='forumcategory', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='forumpost', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='forumpostversion', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='forumsection', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='forumthread', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='settings', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='site', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='tag', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='tagscategory', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterModelManagers( - name='vote', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterField( - model_name='article', - name='author', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='作者'), - ), - migrations.AlterField( - model_name='article', - name='parent', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.article', verbose_name='父页面'), - ), - migrations.AlterField( - model_name='article', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='articlelogentry', - name='article', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章'), - ), - migrations.AlterField( - model_name='articlelogentry', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='articlelogentry', - name='user', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='用户'), - ), - migrations.AlterField( - model_name='articleversion', - name='article', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='versions', to='web.article', verbose_name='文章'), - ), - migrations.AlterField( - model_name='articleversion', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='category', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='externallink', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='file', - name='article', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章'), - ), - migrations.AlterField( - model_name='file', - name='author', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='created_files', to=settings.AUTH_USER_MODEL, verbose_name='文件作者'), - ), - migrations.AlterField( - model_name='file', - name='deleted_by', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='deleted_files', to=settings.AUTH_USER_MODEL, verbose_name='删除文件的用户'), - ), - migrations.AlterField( - model_name='file', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='forumcategory', - name='section', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, to='web.forumsection', verbose_name='分类'), - ), - migrations.AlterField( - model_name='forumcategory', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='forumpost', - name='author', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='作者'), - ), - migrations.AlterField( - model_name='forumpost', - name='reply_to', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.forumpost', verbose_name='回复的评论'), - ), - migrations.AlterField( - model_name='forumpost', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='forumpost', - name='thread', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.forumthread', verbose_name='主题'), - ), - migrations.AlterField( - model_name='forumpostversion', - name='author', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='编辑作者'), - ), - migrations.AlterField( - model_name='forumpostversion', - name='post', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.forumpost', verbose_name='帖子'), - ), - migrations.AlterField( - model_name='forumpostversion', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='forumsection', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='forumthread', - name='article', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章（如果是评论）'), - ), - migrations.AlterField( - model_name='forumthread', - name='author', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='作者'), - ), - migrations.AlterField( - model_name='forumthread', - name='category', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.DO_NOTHING, to='web.forumcategory', verbose_name='版块（如果是主题）'), - ), - migrations.AlterField( - model_name='forumthread', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='settings', - name='category', - field=auto_prefetch.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='_settings', to='web.category'), - ), - migrations.AlterField( - model_name='settings', - name='site', - field=auto_prefetch.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='_settings', to='web.site'), - ), - migrations.AlterField( - model_name='tag', - name='category', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.tagscategory', verbose_name='分类'), - ), - migrations.AlterField( - model_name='tag', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='tagscategory', - name='priority', - field=models.PositiveIntegerField(blank=True, null=True, unique=True, verbose_name='排序编号'), - ), - migrations.AlterField( - model_name='tagscategory', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='vote', - name='article', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='votes', to='web.article', verbose_name='文章'), - ), - migrations.AlterField( - model_name='vote', - name='site', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.site', verbose_name='站点'), - ), - migrations.AlterField( - model_name='vote', - name='user', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL, verbose_name='用户'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0029_add_default_category.py b/web/migrations/0029_add_default_category.py deleted file mode 100644 index 2adbc60a..00000000 --- a/web/migrations/0029_add_default_category.py +++ /dev/null @@ -1,36 +0,0 @@ -from django.db import migrations - - -def add_default(apps, schema_editor): - Site = apps.get_model("web", "Site") - TagsCategory = apps.get_model("web", "TagsCategory") - Tag = apps.get_model("web", "Tag") - for site in Site.objects.all(): - category, created = TagsCategory.objects.get_or_create(slug="_default", site=site) - if created: - category.name = "_default" - category.save() - for tag in Tag.objects.filter(site=site, category__isnull=True): - try: - old_tag = Tag.objects.get(category=category, name=tag.name) - for article in tag.articles.all(): - article.tags.add(old_tag) - tag.delete() - except Tag.DoesNotExist: - tag.category = category - tag.save() - - -def reverse_func(apps, schema_editor): - pass - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0028_alter_article_options_alter_articlelogentry_options_and_more'), - ] - - operations = [ - migrations.RunPython(add_default, reverse_func, atomic=True) - ] \ No newline at end of file diff --git a/web/migrations/0030_update_updated_at_to_last_revision.py b/web/migrations/0030_update_updated_at_to_last_revision.py deleted file mode 100644 index 3973c6d5..00000000 --- a/web/migrations/0030_update_updated_at_to_last_revision.py +++ /dev/null @@ -1,30 +0,0 @@ -from web.controllers.articles import get_latest_log_entry -from django.db import migrations - - -def update_updated_at(apps, schema_editor): - Site = apps.get_model("web", "Site") - Article = apps.get_model("web", "Article") - ArticleLogEntry = apps.get_model("web", "ArticleLogEntry") - for site in Site.objects.all(): - articles = Article.objects.filter(site=site) - for article in articles: - latest = ArticleLogEntry.objects.filter(article=article).order_by('-rev_number').first() - if latest and article.updated_at != latest.created_at: - article.updated_at = latest.created_at - article.save() - - -def reverse_func(apps, schema_editor): - pass - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0029_add_default_category'), - ] - - operations = [ - migrations.RunPython(update_updated_at, reverse_func, atomic=True) - ] \ No newline at end of file diff --git a/web/migrations/0031_update_tags_in_log_entries.py b/web/migrations/0031_update_tags_in_log_entries.py deleted file mode 100644 index 02484838..00000000 --- a/web/migrations/0031_update_tags_in_log_entries.py +++ /dev/null @@ -1,68 +0,0 @@ -from web.controllers.articles import get_latest_log_entry -from django.db import migrations - - -get_full_name = lambda tag: f"{tag.category.slug}:{tag.name}" if tag.category.slug != "_default" else tag.name - - -def update_entries(apps, schema_editor): - Site = apps.get_model("web", "Site") - Tag = apps.get_model("web", "Tag") - ArticleLogEntry = apps.get_model("web", "ArticleLogEntry") - for site in Site.objects.all(): - for entry in ArticleLogEntry.objects.filter(site=site, type='tags'): - new_added = [] - new_removed = [] - if 'added_tags' in entry.meta: - for tag in entry.meta['added_tags']: - try: - new_tag = Tag.objects.get(site=site, name=tag) - new_added.append({'id': new_tag.id, 'name': get_full_name(new_tag)}) - except (Tag.DoesNotExist, Tag.MultipleObjectsReturned): - pass - entry.meta['added_tags'] = new_added - if 'removed_tags' in entry.meta: - for tag in entry.meta['removed_tags']: - try: - new_tag = Tag.objects.get(site=site, name=tag) - new_removed.append({'id': new_tag.id, 'name': get_full_name(new_tag)}) - except (Tag.DoesNotExist, Tag.MultipleObjectsReturned): - pass - entry.meta['removed_tags'] = new_removed - entry.save() - - -def reverse_func(apps, schema_editor): - Site = apps.get_model("web", "Site") - Tag = apps.get_model("web", "Tag") - ArticleLogEntry = apps.get_model("web", "ArticleLogEntry") - for site in Site.objects.all(): - for entry in ArticleLogEntry.objects.filter(site=site, type='tags'): - new_added = [] - new_removed = [] - if 'added_tags' in entry.meta: - for tag in entry.meta['added_tags']: - try: - new_added.append(get_full_name(Tag.objects.get(site=site, id=tag['id']))) - except Tag.DoesNotExist: - pass - entry.meta['added_tags'] = new_added - if 'removed_tags' in entry.meta: - for tag in entry.meta['removed_tags']: - try: - new_removed.append(get_full_name(Tag.objects.get(site=site, id=tag['id']))) - except Tag.DoesNotExist: - pass - entry.meta['removed_tags'] = new_removed - entry.save() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0030_update_updated_at_to_last_revision'), - ] - - operations = [ - migrations.RunPython(update_entries, reverse_func, atomic=True) - ] diff --git a/web/migrations/0032_settings_can_user_create_tags.py b/web/migrations/0032_settings_can_user_create_tags.py deleted file mode 100644 index 12c0e59d..00000000 --- a/web/migrations/0032_settings_can_user_create_tags.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 4.1.2 on 2022-12-08 14:53 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0031_update_tags_in_log_entries'), - ] - - operations = [ - migrations.AddField( - model_name='settings', - name='can_user_create_tags', - field=models.TextField(choices=[('default', '默认'), ('disabled', '禁用'), ('enabled', '启用')], default='default', verbose_name='用户是否可以创建标签'), - ), - ] diff --git a/web/migrations/0033_vote_date.py b/web/migrations/0033_vote_date.py deleted file mode 100644 index 5481c693..00000000 --- a/web/migrations/0033_vote_date.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 4.0.6 on 2023-03-22 06:50 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0032_settings_can_user_create_tags'), - ] - - operations = [ - migrations.AddField( - model_name='vote', - name='date', - field=models.DateTimeField(auto_now_add=True, null=True, verbose_name='Дата голоса'), - ), - ] diff --git a/web/migrations/0034_category_readers_can_comment_and_more.py b/web/migrations/0034_category_readers_can_comment_and_more.py deleted file mode 100644 index d78ca512..00000000 --- a/web/migrations/0034_category_readers_can_comment_and_more.py +++ /dev/null @@ -1,73 +0,0 @@ -# Generated by Django 4.0.6 on 2023-05-14 19:42 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0033_vote_date'), - ] - - operations = [ - migrations.AddField( - model_name='category', - name='readers_can_comment', - field=models.BooleanField(default=True, verbose_name='读者可以评论文章'), - ), - migrations.AddField( - model_name='category', - name='readers_can_create', - field=models.BooleanField(default=False, verbose_name='读者可以创建文章'), - ), - migrations.AddField( - model_name='category', - name='readers_can_delete', - field=models.BooleanField(default=False, verbose_name='读者可以删除文章'), - ), - migrations.AddField( - model_name='category', - name='readers_can_edit', - field=models.BooleanField(default=False, verbose_name='读者可以编辑文章'), - ), - migrations.AddField( - model_name='category', - name='readers_can_rate', - field=models.BooleanField(default=True, verbose_name='读者可以给文章投票'), - ), - migrations.AddField( - model_name='category', - name='readers_can_view', - field=models.BooleanField(default=True, verbose_name='读者可以浏览文章'), - ), - migrations.AlterField( - model_name='category', - name='users_can_comment', - field=models.BooleanField(default=True, verbose_name='成员可以评论文章'), - ), - migrations.AlterField( - model_name='category', - name='users_can_create', - field=models.BooleanField(default=True, verbose_name='成员可以创建文章'), - ), - migrations.AlterField( - model_name='category', - name='users_can_delete', - field=models.BooleanField(default=False, verbose_name='成员可以删除文章'), - ), - migrations.AlterField( - model_name='category', - name='users_can_edit', - field=models.BooleanField(default=True, verbose_name='成员可以编辑文章'), - ), - migrations.AlterField( - model_name='category', - name='users_can_rate', - field=models.BooleanField(default=True, verbose_name='成员可以给文章投票'), - ), - migrations.AlterField( - model_name='category', - name='users_can_view', - field=models.BooleanField(default=True, verbose_name='会员可以浏览文章'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0035_current_users_are_editors.py b/web/migrations/0035_current_users_are_editors.py deleted file mode 100644 index b9521063..00000000 --- a/web/migrations/0035_current_users_are_editors.py +++ /dev/null @@ -1,14 +0,0 @@ -# Generated by Django 4.0.6 on 2023-05-14 19:47 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0034_category_readers_can_comment_and_more'), - ] - - operations = [ - migrations.RunSQL('UPDATE "web_user" SET is_editor=TRUE'), - ] diff --git a/web/migrations/0036_externallink_web_externa_link_fr_92155a_idx_and_more.py b/web/migrations/0036_externallink_web_externa_link_fr_92155a_idx_and_more.py deleted file mode 100644 index 64a6101e..00000000 --- a/web/migrations/0036_externallink_web_externa_link_fr_92155a_idx_and_more.py +++ /dev/null @@ -1,21 +0,0 @@ -# Generated by Django 4.1.10 on 2024-05-11 18:03 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0035_current_users_are_editors'), - ] - - operations = [ - migrations.AddIndex( - model_name='externallink', - index=models.Index(fields=['link_from', 'link_to'], name='web_externa_link_fr_92155a_idx'), - ), - migrations.AddIndex( - model_name='externallink', - index=models.Index(fields=['link_type'], name='web_externa_link_ty_8f2d31_idx'), - ), - ] diff --git a/web/migrations/0037_vote_visual_group.py b/web/migrations/0037_vote_visual_group.py deleted file mode 100644 index 0622e2bb..00000000 --- a/web/migrations/0037_vote_visual_group.py +++ /dev/null @@ -1,20 +0,0 @@ -# Generated by Django 4.0.6 on 2024-09-22 16:23 - -import auto_prefetch -from django.db import migrations -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0036_externallink_web_externa_link_fr_92155a_idx_and_more'), - ] - - operations = [ - migrations.AddField( - model_name='vote', - name='visual_group', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.visualusergroup', verbose_name='视觉组'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0038_alter_articlelogentry_type.py b/web/migrations/0038_alter_articlelogentry_type.py deleted file mode 100644 index 35c20f43..00000000 --- a/web/migrations/0038_alter_articlelogentry_type.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 5.0.6 on 2024-12-24 11:44 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0037_vote_visual_group'), - ] - - operations = [ - migrations.AlterField( - model_name='articlelogentry', - name='type', - field=models.TextField(choices=[('source', '源代码'), ('title', '标题'), ('name', '名称'), ('tags', '标签'), ('new', '新建'), ('parent', '父页面'), ('file_added', '文件添加'), ('file_deleted', '文件删除'), ('file_renamed', '文件重命名'), ('votes_deleted', '投票删除'), ('wikidot', 'Wikidot'), ('revert', '恢复')], verbose_name='类型'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0039_alter_externallink_link_from_and_more.py b/web/migrations/0039_alter_externallink_link_from_and_more.py deleted file mode 100644 index 39db225d..00000000 --- a/web/migrations/0039_alter_externallink_link_from_and_more.py +++ /dev/null @@ -1,23 +0,0 @@ -# Generated by Django 5.0.6 on 2024-12-24 11:51 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0038_alter_articlelogentry_type'), - ] - - operations = [ - migrations.AlterField( - model_name='externallink', - name='link_from', - field=models.TextField(verbose_name='源文章'), - ), - migrations.AlterField( - model_name='externallink', - name='link_to', - field=models.TextField(verbose_name='目标文章'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0040_alter_externallink_link_from_and_more.py b/web/migrations/0040_alter_externallink_link_from_and_more.py deleted file mode 100644 index 4ba9f943..00000000 --- a/web/migrations/0040_alter_externallink_link_from_and_more.py +++ /dev/null @@ -1,24 +0,0 @@ -# Generated by Django 5.1.4 on 2025-01-08 10:56 - -import web.fields -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0039_alter_externallink_link_from_and_more'), - ] - - operations = [ - migrations.AlterField( - model_name='externallink', - name='link_from', - field=web.fields.CITextField(verbose_name='源文章'), - ), - migrations.AlterField( - model_name='externallink', - name='link_to', - field=web.fields.CITextField(verbose_name='目标文章'), - ), - ] diff --git a/web/migrations/0041_alter_site_options_alter_site_managers_and_more.py b/web/migrations/0041_alter_site_options_alter_site_managers_and_more.py deleted file mode 100644 index ff8d3cfa..00000000 --- a/web/migrations/0041_alter_site_options_alter_site_managers_and_more.py +++ /dev/null @@ -1,144 +0,0 @@ -# Generated by Django 5.1.4 on 2025-01-17 12:58 - -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0040_alter_externallink_link_from_and_more'), - migrations.swappable_dependency(settings.AUTH_USER_MODEL), - ] - - operations = [ - migrations.AlterModelOptions( - name='site', - options={'verbose_name': '站点', 'verbose_name_plural': '站点'}, - ), - migrations.AlterModelManagers( - name='site', - managers=[ - ], - ), - migrations.RemoveConstraint( - model_name='article', - name='web_article_unique', - ), - migrations.RemoveConstraint( - model_name='articlelogentry', - name='web_articlelogentry_unique', - ), - migrations.RemoveConstraint( - model_name='category', - name='web_category_unique', - ), - migrations.RemoveConstraint( - model_name='externallink', - name='web_externallink_unique', - ), - migrations.RemoveConstraint( - model_name='file', - name='web_file_unique', - ), - migrations.RemoveConstraint( - model_name='tag', - name='web_tag_unique', - ), - migrations.RemoveConstraint( - model_name='tagscategory', - name='web_tagscategory_unique', - ), - migrations.RemoveConstraint( - model_name='vote', - name='web_vote_unique', - ), - migrations.RemoveField( - model_name='article', - name='site', - ), - migrations.RemoveField( - model_name='articlelogentry', - name='site', - ), - migrations.RemoveField( - model_name='articleversion', - name='site', - ), - migrations.RemoveField( - model_name='category', - name='site', - ), - migrations.RemoveField( - model_name='externallink', - name='site', - ), - migrations.RemoveField( - model_name='file', - name='site', - ), - migrations.RemoveField( - model_name='forumcategory', - name='site', - ), - migrations.RemoveField( - model_name='forumpost', - name='site', - ), - migrations.RemoveField( - model_name='forumpostversion', - name='site', - ), - migrations.RemoveField( - model_name='forumsection', - name='site', - ), - migrations.RemoveField( - model_name='forumthread', - name='site', - ), - migrations.RemoveField( - model_name='tag', - name='site', - ), - migrations.RemoveField( - model_name='tagscategory', - name='site', - ), - migrations.RemoveField( - model_name='vote', - name='site', - ), - migrations.AddConstraint( - model_name='article', - constraint=models.UniqueConstraint(fields=('category', 'name'), name='web_article_unique'), - ), - migrations.AddConstraint( - model_name='articlelogentry', - constraint=models.UniqueConstraint(fields=('article', 'rev_number'), name='web_articlelogentry_unique'), - ), - migrations.AddConstraint( - model_name='category', - constraint=models.UniqueConstraint(fields=('name',), name='web_category_unique'), - ), - migrations.AddConstraint( - model_name='externallink', - constraint=models.UniqueConstraint(fields=('link_from', 'link_to', 'link_type'), name='web_externallink_unique'), - ), - migrations.AddConstraint( - model_name='file', - constraint=models.UniqueConstraint(fields=('article', 'name', 'deleted_at'), name='web_file_unique'), - ), - migrations.AddConstraint( - model_name='tag', - constraint=models.UniqueConstraint(fields=('category', 'name'), name='web_tag_unique'), - ), - migrations.AddConstraint( - model_name='tagscategory', - constraint=models.UniqueConstraint(fields=('slug',), name='web_tagscategory_unique'), - ), - migrations.AddConstraint( - model_name='vote', - constraint=models.UniqueConstraint(fields=('article', 'user'), name='web_vote_unique'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0042_alter_articlelogentry_type_and_more.py b/web/migrations/0042_alter_articlelogentry_type_and_more.py deleted file mode 100644 index 7a96502e..00000000 --- a/web/migrations/0042_alter_articlelogentry_type_and_more.py +++ /dev/null @@ -1,34 +0,0 @@ -# Generated by Django 5.1.4 on 2025-02-06 18:24 - -import web.models.articles -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0041_alter_site_options_alter_site_managers_and_more'), - ] - - operations = [ - migrations.AlterField( - model_name='articlelogentry', - name='type', - field=models.TextField(choices=[('source', '内容更改'), ('title', '标题更改'), ('name', '页面地址更改'), ('tags', '标签更改'), ('new', '页面创建'), ('parent', '父页面更改'), ('file_added', '文件添加'), ('file_deleted', '文件删除'), ('file_renamed', '文件重命名'), ('votes_deleted', '评分重置'), ('wikidot', '来自Wikidot的编辑'), ('revert', '版本回退')], verbose_name='类型'), - ), - migrations.AlterField( - model_name='settings', - name='can_user_create_tags', - field=models.TextField(choices=[('default', '默认'), ('disabled', '禁止'), ('enabled', '允许')], default='default', verbose_name='用户是否可以创建标签'), - ), - migrations.AlterField( - model_name='settings', - name='rating_mode', - field=models.TextField(choices=[('default', '默认'), ('disabled', '禁用'), ('updown', '点赞/点踩'), ('stars', '星级评分')], default='default', verbose_name='评分系统'), - ), - migrations.AlterField( - model_name='tagscategory', - name='slug', - field=models.TextField(unique=True, validators=[web.models.articles.TagsCategorySlugValidator()], verbose_name='标识符'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0043_migrate_system_to_web.py b/web/migrations/0043_migrate_system_to_web.py deleted file mode 100644 index 0e825cad..00000000 --- a/web/migrations/0043_migrate_system_to_web.py +++ /dev/null @@ -1,36 +0,0 @@ - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0042_alter_articlelogentry_type_and_more'), - ] - - operations = [migrations.RunSQL(""" - DO $$ - DECLARE - rec RECORD; - old_table_name TEXT; - new_table_name TEXT; - BEGIN - UPDATE public.django_content_type - SET app_label = 'web' - WHERE app_label = 'system'; - - FOR rec IN - SELECT table_name - FROM information_schema.tables - WHERE table_schema = 'public' - AND table_name LIKE 'system_%' - LOOP - old_table_name := rec.table_name; - new_table_name := 'web_' || SUBSTRING(old_table_name FROM 8); - - EXECUTE FORMAT('DROP TABLE IF EXISTS %I;', new_table_name); - EXECUTE FORMAT('ALTER TABLE %I RENAME TO %I;', old_table_name, new_table_name); - END LOOP; - END $$; - """) - ] diff --git a/web/migrations/0044_alter_tag_category.py b/web/migrations/0044_alter_tag_category.py deleted file mode 100644 index 83d30a83..00000000 --- a/web/migrations/0044_alter_tag_category.py +++ /dev/null @@ -1,21 +0,0 @@ -# Generated by Django 5.1.4 on 2025-02-18 08:39 - -import auto_prefetch -import django.db.models.deletion -import web.models.articles -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0043_migrate_system_to_web'), - ] - - operations = [ - migrations.AlterField( - model_name='tag', - name='category', - field=auto_prefetch.ForeignKey(default=web.models.articles.TagsCategory.get_or_create_default_tags_category, on_delete=django.db.models.deletion.CASCADE, to='web.tagscategory', verbose_name='分类'), - ), - ] diff --git a/web/migrations/0045_actionlogentry.py b/web/migrations/0045_actionlogentry.py deleted file mode 100644 index 60be0e6f..00000000 --- a/web/migrations/0045_actionlogentry.py +++ /dev/null @@ -1,47 +0,0 @@ -# Generated by Django 5.1.4 on 2025-03-07 10:41 - -import django.db.models.deletion -import django.db.models.manager -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0044_alter_tag_category'), - ] - - operations = [ - migrations.CreateModel( - name='ActionLogEntry', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('stale_username', models.TextField(verbose_name='操作时的用户名')), - ('type', models.TextField(choices=[ - ('vote', '评分'), - ('create_article', '页面已创建'), - ('edit_article', '页面已编辑'), - ('remove_article', '页面已删除'), - ('add_forum_post', '论坛帖子已创建'), - ('edit_forum_post', '论坛帖子已修改'), - ('remove_forum_post', '论坛帖子已删除'), - ('change_profile_info', '个人资料已更改') - ], verbose_name='类型')), - ('meta', models.JSONField(blank=True, default=dict)), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='时间')), - ('origin_ip', models.GenericIPAddressField(blank=True, null=True, verbose_name='IP 地址')), - ('user', models.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, to=settings.AUTH_USER_MODEL, verbose_name='用户')), - ], - options={ - 'verbose_name': '操作记录', - 'verbose_name_plural': '操作记录', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - ] diff --git a/web/migrations/0046_usernotification_usernotificationtemplate_and_more.py b/web/migrations/0046_usernotification_usernotificationtemplate_and_more.py deleted file mode 100644 index c212953a..00000000 --- a/web/migrations/0046_usernotification_usernotificationtemplate_and_more.py +++ /dev/null @@ -1,97 +0,0 @@ -# Generated by Django 5.1.4 on 2025-03-29 00:00 - -import auto_prefetch -import django.db.models.deletion -import django.db.models.manager -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0045_actionlogentry'), - ] - - operations = [ - migrations.CreateModel( - name='UserNotification', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('type', models.TextField(choices=[('welcome', '欢迎消息'), ('new_post_reply', '帖子回复'), ('new_thread_post', '新帖子'), ('new_article_revision', '文章编辑')], verbose_name='通知类型')), - ('meta', models.JSONField(blank=True, default=dict, verbose_name='元数据')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='发送日期')), - ('referred_to', models.TextField(blank=True, null=True, verbose_name='指向链接')), - ], - options={ - 'verbose_name': '通知', - 'verbose_name_plural': '通知', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.CreateModel( - name='UserNotificationTemplate', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('template_type', models.TextField(choices=[('welcome', '欢迎消息'), ('new_post_reply', '帖子回复'), ('new_thread_post', '新帖子'), ('new_article_revision', '文章编辑')], unique=True, verbose_name='通知类型')), - ('title', models.CharField(max_length=100, verbose_name='标题')), - ('message', models.TextField(verbose_name='消息内容')), - ], - options={ - 'verbose_name': '通知模板', - 'verbose_name_plural': '通知模板', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterField( - model_name='actionlogentry', - name='type', - field=models.TextField(choices=[('vote', '评分'), ('create_article', '页面已创建'), ('edit_article', '页面已编辑'), ('remove_article', '页面已删除'), ('add_forum_post', '新论坛帖子'), ('edit_forum_post', '论坛帖子已修改'), ('remove_forum_post', '论坛帖子已删除'), ('change_profile_info', '个人资料信息已修改')], verbose_name='类型'), - ), - migrations.CreateModel( - name='UserNotificationMapping', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('is_viewed', models.BooleanField(default=False)), - ('notification', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.usernotification')), - ('recipient', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)), - ], - options={ - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.CreateModel( - name='UserNotificationSubscription', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('article', auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章')), - ('forum_thread', auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='web.forumthread', verbose_name='论坛主题')), - ('subscriber', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL, verbose_name='订阅者')), - ], - options={ - 'verbose_name': '通知订阅', - 'verbose_name_plural': '通知订阅', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - ] \ No newline at end of file diff --git a/web/migrations/0047_subscribe_users.py b/web/migrations/0047_subscribe_users.py deleted file mode 100644 index 02dec5ea..00000000 --- a/web/migrations/0047_subscribe_users.py +++ /dev/null @@ -1,55 +0,0 @@ -# Generated by Django 5.1.4 on 2025-04-17 17:14 - -from django.db import migrations - - -def subscribe_users(apps, schema_editor): - Article = apps.get_model("web", "Article") - ForumThread = apps.get_model("web", "ForumThread") - UserNotificationSubscription = apps.get_model("web", "UserNotificationSubscription") - - all_subscriptions = [] - - for article in Article.objects.all(): - if not article.author_id: - continue - all_subscriptions.append( - UserNotificationSubscription( - subscriber=article.author, - article=article, - forum_thread=None - ) - ) - article_comments = ForumThread.objects.filter(article=article) - for comment_thread in article_comments: - all_subscriptions.append( - UserNotificationSubscription( - subscriber=article.author, - article=None, - forum_thread=comment_thread - ) - ) - - for forum_thread in ForumThread.objects.all(): - if not forum_thread.author_id: - continue - all_subscriptions.append( - UserNotificationSubscription( - subscriber=forum_thread.author, - article=None, - forum_thread=forum_thread - ) - ) - - UserNotificationSubscription.objects.bulk_create(all_subscriptions) - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0046_usernotification_usernotificationtemplate_and_more'), - ] - - operations = [ - migrations.RunPython(subscribe_users), - ] diff --git a/web/migrations/0048_delete_usernotificationtemplate_and_more.py b/web/migrations/0048_delete_usernotificationtemplate_and_more.py deleted file mode 100644 index eb51eaff..00000000 --- a/web/migrations/0048_delete_usernotificationtemplate_and_more.py +++ /dev/null @@ -1,21 +0,0 @@ -# Generated by Django 5.1.4 on 2025-04-17 21:11 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0047_subscribe_users'), - ] - - operations = [ - migrations.DeleteModel( - name='UserNotificationTemplate', - ), - migrations.AlterField( - model_name='usernotification', - name='type', - field=models.TextField(choices=[('welcome', '欢迎消息'), ('new_post_reply', '帖子回复'), ('new_thread_post', '新帖子'), ('new_article_revision', '文章编辑')], verbose_name='通知类型'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0049_category_is_indexed.py b/web/migrations/0049_category_is_indexed.py deleted file mode 100644 index 66c85129..00000000 --- a/web/migrations/0049_category_is_indexed.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 5.1.4 on 2025-04-23 21:12 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0048_delete_usernotificationtemplate_and_more'), - ] - - operations = [ - migrations.AddField( - model_name='category', - name='is_indexed', - field=models.BooleanField(default=True, verbose_name='是否被搜索引擎索引'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0050_rename_media_folders.py b/web/migrations/0050_rename_media_folders.py deleted file mode 100644 index de6a9ce8..00000000 --- a/web/migrations/0050_rename_media_folders.py +++ /dev/null @@ -1,31 +0,0 @@ -# Generated by Django 5.1.4 on 2025-04-30 00:20 - -import os -from pathlib import Path -from django.conf import settings -from django.db import migrations - - -def rename_media_folders(apps, schema_editor): - Site = apps.get_model("web", "Site") - media_root = Path(settings.MEDIA_ROOT) - new_media_folder = media_root / 'media' - - if Site.objects.exists(): - slug: str = Site.objects.get().slug - slug_folder = media_root / slug - if slug_folder.exists(): - os.rename(slug_folder, new_media_folder) - elif not new_media_folder.exists(): - os.mkdir(new_media_folder) - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0049_category_is_indexed'), - ] - - operations = [ - migrations.RunPython(rename_media_folders, migrations.RunPython.noop, atomic=True), - ] diff --git a/web/migrations/0051_visualusergroup_badge_visualusergroup_badge_bg_and_more.py b/web/migrations/0051_visualusergroup_badge_visualusergroup_badge_bg_and_more.py deleted file mode 100644 index f9470bdb..00000000 --- a/web/migrations/0051_visualusergroup_badge_visualusergroup_badge_bg_and_more.py +++ /dev/null @@ -1,34 +0,0 @@ -# Generated by Django 5.1.4 on 2025-08-23 12:52 - -import web.models.users -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0050_rename_media_folders'), - ] - - operations = [ - migrations.AddField( - model_name='visualusergroup', - name='badge', - field=models.TextField(default='', verbose_name='徽章'), - ), - migrations.AddField( - model_name='visualusergroup', - name='badge_bg', - field=models.TextField(default='#808080', validators=[web.models.users.CSSValueValidator()], verbose_name='徽章颜色'), - ), - migrations.AddField( - model_name='visualusergroup', - name='badge_text_color', - field=models.TextField(default='#FFFFFF', validators=[web.models.users.CSSValueValidator()], verbose_name='文字颜色'), - ), - migrations.AddField( - model_name='visualusergroup', - name='show_badge', - field=models.BooleanField(default=False, verbose_name='显示徽章'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0052_visualusergroup_badge_show_border.py b/web/migrations/0052_visualusergroup_badge_show_border.py deleted file mode 100644 index ad00f484..00000000 --- a/web/migrations/0052_visualusergroup_badge_show_border.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 5.1.4 on 2025-08-23 15:30 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0051_visualusergroup_badge_visualusergroup_badge_bg_and_more'), - ] - - operations = [ - migrations.AddField( - model_name='visualusergroup', - name='badge_show_border', - field=models.BooleanField(default=False, verbose_name='显示边框'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0053_articlesearchindex.py b/web/migrations/0053_articlesearchindex.py deleted file mode 100644 index 8c9d2033..00000000 --- a/web/migrations/0053_articlesearchindex.py +++ /dev/null @@ -1,41 +0,0 @@ -# Generated by Django 5.1.4 on 2025-08-17 16:44 - -import auto_prefetch -import django.contrib.postgres.indexes -import django.contrib.postgres.search -import django.db.models.deletion -import django.db.models.manager -from django.contrib.postgres.operations import TrigramExtension -from django.db import migrations, models - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0052_visualusergroup_badge_show_border'), - ] - - operations = [ - TrigramExtension(), - migrations.CreateModel( - name='ArticleSearchIndex', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('content_plaintext', models.TextField(verbose_name='文章纯文本')), - ('content_source', models.TextField(verbose_name='文章源代码')), - ('vector_plaintext', django.contrib.postgres.search.SearchVectorField(null=True)), - ('article', auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.article', verbose_name='文章')), - ], - options={ - 'verbose_name': '文章搜索索引', - 'verbose_name_plural': '文章搜索索引', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - 'indexes': [models.Index(fields=['article'], name='web_article_article_5eb4fb_idx'), django.contrib.postgres.indexes.GinIndex(fields=['vector_plaintext'], name='web_article_vector__7954ea_gin'), django.contrib.postgres.indexes.GinIndex(fields=['content_plaintext'], name='article_search_plaintext_gin', opclasses=['gin_trgm_ops']), django.contrib.postgres.indexes.GinIndex(fields=['content_source'], name='article_search_source_gin', opclasses=['gin_trgm_ops'])], - 'constraints': [models.UniqueConstraint(fields=('article',), name='web_articlesearchindex_unique')], - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ) - ] \ No newline at end of file diff --git a/web/migrations/0054_alter_articlesearchindex_options_and_more.py b/web/migrations/0054_alter_articlesearchindex_options_and_more.py deleted file mode 100644 index 13289498..00000000 --- a/web/migrations/0054_alter_articlesearchindex_options_and_more.py +++ /dev/null @@ -1,39 +0,0 @@ -# Generated by Django 5.1.4 on 2025-08-25 12:05 - -import django.contrib.postgres.indexes -import django.db.models.deletion -import django.db.models.functions.text -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0053_articlesearchindex'), - ] - - operations = [ - migrations.AlterModelOptions( - name='articlesearchindex', - options={'verbose_name': '文章搜索索引', 'verbose_name_plural': '文章搜索索引'}, - ), - migrations.AlterModelManagers( - name='articlesearchindex', - managers=[ - ], - ), - migrations.RenameIndex( - model_name='articlesearchindex', - new_name='web_article_vector__0d2eb2_gin', - old_name='web_article_vector__7954ea_gin', - ), - migrations.AlterField( - model_name='articlesearchindex', - name='article', - field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.article', verbose_name='文章'), - ), - migrations.AddIndex( - model_name='articlesearchindex', - index=django.contrib.postgres.indexes.GinIndex(django.contrib.postgres.indexes.OpClass(django.db.models.functions.text.Upper('content_source'), name='gin_trgm_ops'), name='content_source_lower_trgm_gin'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0055_alter_articlesearchindex_options_and_more.py b/web/migrations/0055_alter_articlesearchindex_options_and_more.py deleted file mode 100644 index 1f079857..00000000 --- a/web/migrations/0055_alter_articlesearchindex_options_and_more.py +++ /dev/null @@ -1,53 +0,0 @@ -# Generated by Django 5.1.4 on 2025-08-29 08:39 - -import auto_prefetch -import django.db.models.deletion -import django.db.models.manager -from django.conf import settings -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0054_alter_articlesearchindex_options_and_more'), - ] - - operations = [ - migrations.AlterModelOptions( - name='articlesearchindex', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '文章搜索索引', 'verbose_name_plural': '文章搜索索引'}, - ), - migrations.AlterModelManagers( - name='articlesearchindex', - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AlterField( - model_name='actionlogentry', - name='user', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, to=settings.AUTH_USER_MODEL, verbose_name='用户'), - ), - migrations.AlterField( - model_name='articlesearchindex', - name='article', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.article', verbose_name='文章'), - ), - migrations.AlterField( - model_name='usernotificationmapping', - name='notification', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.usernotification'), - ), - migrations.AlterField( - model_name='usernotificationmapping', - name='recipient', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL), - ), - migrations.AlterField( - model_name='usernotificationsubscription', - name='subscriber', - field=auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL, verbose_name='订阅者'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0056_create_roles_and_more.py b/web/migrations/0056_create_roles_and_more.py deleted file mode 100644 index 80d59d5e..00000000 --- a/web/migrations/0056_create_roles_and_more.py +++ /dev/null @@ -1,154 +0,0 @@ -import auto_prefetch -import django.db.models.deletion -import django.db.models.manager -import web.fields.models -import web.models.roles - -from django.db import migrations, models -from django.apps.registry import Apps - - - -def create_default_roles(apps: Apps, schema_editor): - Role = apps.get_model('web', 'Role') - Role.objects.create( - slug='everyone', - index=0 - ) - Role.objects.create( - slug='registered', - index=0 - ) - -def visualgroups_to_roles(apps: Apps, schema_editor): - VisualUserGroup = apps.get_model('web', 'VisualUserGroup') - Role = apps.get_model('web', 'Role') - Vote = apps.get_model('web', 'Vote') - User = apps.get_model('web', 'User') - - new_roles = [] - for n, group in enumerate(VisualUserGroup.objects.all().order_by('index')): - new_roles.append(Role( - slug=f'migrated_role_{n}', - name=group.name, - index=n, - group_votes=True, - inline_visual_mode='badge' if group.show_badge else 'hidden', - profile_visual_mode='status', - badge_text=group.badge, - badge_bg=group.badge_bg, - badge_text_color=group.badge_text_color, - badge_show_border=group.badge_show_border, - )) - - Role.objects.bulk_create(new_roles) - - for user in User.objects.filter(visual_group__isnull=False): - user.roles.add(Role.objects.get(name=user.visual_group.name)) - - votes_to_update = [] - for vote in Vote.objects.filter(visual_group__isnull=False): - vote.role = Role.objects.get(name=vote.visual_group.name) - votes_to_update.append(vote) - - Vote.objects.bulk_update(votes_to_update, ['role']) - - -class Migration(migrations.Migration): - - dependencies = [ - ('auth', '0012_alter_user_first_name_max_length'), - ('web', '0055_alter_articlesearchindex_options_and_more'), - ] - - operations = [ - migrations.CreateModel( - name='RoleCategory', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.CharField(verbose_name='名称')), - ], - options={ - 'verbose_name': '角色分类', - 'verbose_name_plural': '角色分类', - }, - ), - migrations.AlterField( - model_name='forumsection', - name='is_hidden_for_users', - field=models.BooleanField(default=False, verbose_name='仅管理员可见'), - ), - migrations.CreateModel( - name='Role', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('slug', models.CharField(unique=True, verbose_name='标识符')), - ('name', models.CharField(blank=True, verbose_name='完整名称')), - ('short_name', models.CharField(blank=True, verbose_name='简称')), - ('index', models.PositiveIntegerField(db_index=True, default=0, editable=False, verbose_name='优先级')), - ('is_staff', models.BooleanField(default=False, verbose_name='可访问管理后台')), - ('group_votes', models.BooleanField(default=False, verbose_name='分组显示投票')), - ('votes_title', models.CharField(blank=True, verbose_name='投票组标签')), - ('inline_visual_mode', models.CharField(choices=[('hidden', '隐藏'), ('badge', '徽章'), ('icon', '图标')], default='hidden', verbose_name='用户名旁显示模式')), - ('profile_visual_mode', models.CharField(choices=[('hidden', '隐藏'), ('badge', '徽章'), ('status', '状态')], default='hidden', verbose_name='个人资料显示模式')), - ('color', web.fields.models.CSSColorField(default='#000000', verbose_name='颜色')), - ('icon', models.FileField(blank=True, upload_to='-/roles', validators=[web.models.roles.svg_file_validator], verbose_name='图标')), - ('badge_text', models.CharField(blank=True, verbose_name='徽章文本')), - ('badge_bg', web.fields.models.CSSColorField(default='#808080', verbose_name='徽章背景色')), - ('badge_text_color', web.fields.models.CSSColorField(default='#ffffff', verbose_name='文本颜色')), - ('badge_show_border', models.BooleanField(default=False, verbose_name='显示边框')), - ('permissions', models.ManyToManyField(blank=True, related_name='role_permissions_set', to='auth.permission', verbose_name='权限')), - ('restrictions', models.ManyToManyField(blank=True, related_name='role_restrictions_set', to='auth.permission', verbose_name='限制')), - ('category', auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.rolecategory', verbose_name='分类')), - ], - options={ - 'verbose_name': '角色', - 'verbose_name_plural': '角色', - 'ordering': ['index'], - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddField( - model_name='user', - name='roles', - field=models.ManyToManyField(blank=True, related_name='users', related_query_name='user', to='web.role', verbose_name='角色'), - ), - migrations.AddField( - model_name='vote', - name='role', - field=auto_prefetch.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='web.role', verbose_name='角色'), - ), - migrations.CreateModel( - name='RolePermissionsOverride', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('permissions', models.ManyToManyField(blank=True, related_name='override_role_permissions_set', to='auth.permission')), - ('restrictions', models.ManyToManyField(blank=True, related_name='override_role_restrictions_set', to='auth.permission')), - ('role', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.role')), - ], - options={ - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddField( - model_name='category', - name='permissions_override', - field=models.ManyToManyField(to='web.rolepermissionsoverride'), - ), - - # 创建默认角色 - migrations.RunPython(create_default_roles, migrations.RunPython.noop, atomic=True), - - # 从视觉用户组迁移到角色 - migrations.RunPython(visualgroups_to_roles, migrations.RunPython.noop, atomic=True), - ] \ No newline at end of file diff --git a/web/migrations/0057_create_built_in_roles_and_migrate_categories.py b/web/migrations/0057_create_built_in_roles_and_migrate_categories.py deleted file mode 100644 index 185ab9a2..00000000 --- a/web/migrations/0057_create_built_in_roles_and_migrate_categories.py +++ /dev/null @@ -1,151 +0,0 @@ -from django.apps.registry import Apps -from django.db import migrations -from django.db.models import Max - - - -def create_built_in_roles(apps: Apps, schema_editor): - RoleCategory = apps.get_model('web', 'RoleCategory') - Role = apps.get_model('web', 'Role') - User = apps.get_model('web', 'User') - - last_index = Role.objects.aggregate(max_index=Max('index'))['max_index'] - - category = RoleCategory.objects.create( - name='用户状态' - ) - - reader_role = Role.objects.create( - slug='reader', - name='读者', - category=category, - votes_title='读者投票', - profile_visual_mode='status', - group_votes=True, - index=last_index+2, - ) - editor_role = Role.objects.create( - slug='editor', - name='成员', - category=category, - votes_title='成员投票', - profile_visual_mode='status', - group_votes=True, - index=last_index+1 - ) - - reader_role.users.set(User.objects.filter(is_active=True, is_editor=False)) - editor_role.users.set(User.objects.filter(is_active=True, is_editor=True)) - - for user in User.objects.all(): - if user.is_editor: - user.vote_set.all().filter(role__isnull=True).update(role=editor_role) - else: - user.vote_set.all().filter(role__isnull=True).update(role=reader_role) - - registered_role = Role.objects.get(slug='registered') - everyone_role = Role.objects.get(slug='everyone') - - registered_role.index = last_index+3 - everyone_role.index = last_index+4 - - registered_role.save() - everyone_role.save() - - -def migrate_categories(apps: Apps, schema_editor): - RolePermissionsOverride = apps.get_model('web', 'RolePermissionsOverride') - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - Category = apps.get_model('web', 'Category') - Role = apps.get_model('web', 'Role') - - content_type, _ = ContentType.objects.get_or_create( - app_label='web', - model='roles' - ) - - def get_permission(codename): - return Permission.objects.get( - codename=codename, - content_type=content_type - ) - - reader_role = Role.objects.get(slug='reader') - editor_role = Role.objects.get(slug='editor') - - for category in Category.objects.all(): - reader_perms = [] - reader_restrs = [] - editor_perms = [] - editor_restrs = [] - - if not category.readers_can_comment: - reader_restrs.append(get_permission('comment_articles')) - - if category.readers_can_create: - reader_perms.append(get_permission('create_articles')) - - if category.readers_can_delete: - reader_perms.append(get_permission('delete_articles')) - - if category.readers_can_edit: - reader_perms.append(get_permission('edit_articles')) - reader_perms.append(get_permission('manage_article_files')) - reader_perms.append(get_permission('tag_articles')) - reader_perms.append(get_permission('move_articles')) - - if not category.readers_can_rate: - reader_restrs.append(get_permission('rate_articles')) - - if not category.readers_can_view: - reader_restrs.append(get_permission('view_articles')) - - if not category.users_can_comment: - editor_restrs.append(get_permission('comment_articles')) - - if not category.users_can_create: - editor_restrs.append(get_permission('create_articles')) - - if category.users_can_delete: - editor_perms.append(get_permission('delete_articles')) - - if not category.users_can_edit: - editor_perms.append(get_permission('edit_articles')) - editor_perms.append(get_permission('manage_article_files')) - editor_perms.append(get_permission('tag_articles')) - editor_perms.append(get_permission('move_articles')) - - if not category.users_can_rate: - editor_restrs.append(get_permission('rate_articles')) - - if not category.users_can_view: - editor_restrs.append(get_permission('view_articles')) - - if reader_perms or reader_restrs: - perms_override = RolePermissionsOverride.objects.create(role=reader_role) - perms_override.permissions.add(*reader_perms) - perms_override.restrictions.add(*reader_restrs) - category.permissions_override.add(perms_override) - - if editor_perms or editor_restrs: - perms_override = RolePermissionsOverride.objects.create(role=editor_role) - perms_override.permissions.add(*editor_perms) - perms_override.restrictions.add(*editor_restrs) - category.permissions_override.add(perms_override) - - -class Migration(migrations.Migration): - - dependencies = [ - ('auth', '0012_alter_user_first_name_max_length'), - ('web', '0056_create_roles_and_more'), - ] - - operations = [ - # 为读者和成员创建角色 - migrations.RunPython(create_built_in_roles, migrations.RunPython.noop, atomic=True), - - # 迁移分类中的权限 - migrations.RunPython(migrate_categories, migrations.RunPython.noop, atomic=True), - ] \ No newline at end of file diff --git a/web/migrations/0058_remove_user_visual_group_remove_vote_visual_group_and_more.py b/web/migrations/0058_remove_user_visual_group_remove_vote_visual_group_and_more.py deleted file mode 100644 index a612dd92..00000000 --- a/web/migrations/0058_remove_user_visual_group_remove_vote_visual_group_and_more.py +++ /dev/null @@ -1,80 +0,0 @@ -# Generated by Django 5.1.4 on 2025-09-05 00:13 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0057_create_built_in_roles_and_migrate_categories'), - ] - - operations = [ - migrations.RemoveField( - model_name='user', - name='visual_group', - ), - migrations.RemoveField( - model_name='vote', - name='visual_group', - ), - migrations.RemoveField( - model_name='category', - name='readers_can_comment', - ), - migrations.RemoveField( - model_name='category', - name='readers_can_create', - ), - migrations.RemoveField( - model_name='category', - name='readers_can_delete', - ), - migrations.RemoveField( - model_name='category', - name='readers_can_edit', - ), - migrations.RemoveField( - model_name='category', - name='readers_can_rate', - ), - migrations.RemoveField( - model_name='category', - name='readers_can_view', - ), - migrations.RemoveField( - model_name='category', - name='users_can_comment', - ), - migrations.RemoveField( - model_name='category', - name='users_can_create', - ), - migrations.RemoveField( - model_name='category', - name='users_can_delete', - ), - migrations.RemoveField( - model_name='category', - name='users_can_edit', - ), - migrations.RemoveField( - model_name='category', - name='users_can_rate', - ), - migrations.RemoveField( - model_name='category', - name='users_can_view', - ), - migrations.RemoveField( - model_name='user', - name='is_editor', - ), - migrations.RemoveField( - model_name='user', - name='is_staff', - ), - migrations.DeleteModel( - name='VisualUserGroup', - ), - ] diff --git a/web/migrations/0059_remove_forum_post_edit_delete_event_logs.py b/web/migrations/0059_remove_forum_post_edit_delete_event_logs.py deleted file mode 100644 index a6bd1a61..00000000 --- a/web/migrations/0059_remove_forum_post_edit_delete_event_logs.py +++ /dev/null @@ -1,20 +0,0 @@ -# Generated by Django 5.1.4 on 2025-09-25 10:56 - -from django.db import migrations - - -def delete_broken_logs(apps, schema_editor): - ActionLogEntry = apps.get_model("web", "ActionLogEntry") - ActionLogEntry.objects.filter(type__in=["edit_forum_post", "remove_forum_post"]).delete() - - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0058_remove_user_visual_group_remove_vote_visual_group_and_more'), - ] - - operations = [ - migrations.RunPython(delete_broken_logs, migrations.RunPython.noop, atomic=True), - ] diff --git a/web/migrations/0060_alter_article_category_alter_article_name_and_more.py b/web/migrations/0060_alter_article_category_alter_article_name_and_more.py deleted file mode 100644 index 2072b0b0..00000000 --- a/web/migrations/0060_alter_article_category_alter_article_name_and_more.py +++ /dev/null @@ -1,38 +0,0 @@ -# Generated by Django 5.1.4 on 2025-09-26 11:52 - -import web.fields.models -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('auth', '0012_alter_user_first_name_max_length'), - ('web', '0059_remove_forum_post_edit_delete_event_logs'), - ] - - operations = [ - migrations.AlterField( - model_name='article', - name='category', - field=web.fields.models.CITextField(default='_default', verbose_name='分类'), - ), - migrations.AlterField( - model_name='article', - name='name', - field=web.fields.models.CITextField(verbose_name='名称'), - ), - migrations.AlterField( - model_name='category', - name='name', - field=web.fields.models.CITextField(verbose_name='名称'), - ), - migrations.AddIndex( - model_name='role', - index=models.Index(fields=['slug'], name='web_role_slug_06c2fa_idx'), - ), - migrations.AddIndex( - model_name='role', - index=models.Index(fields=['category'], name='web_role_categor_bd0076_idx'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0061_remove_article_web_article_categor_006394_idx_and_more.py b/web/migrations/0061_remove_article_web_article_categor_006394_idx_and_more.py deleted file mode 100644 index 1511d047..00000000 --- a/web/migrations/0061_remove_article_web_article_categor_006394_idx_and_more.py +++ /dev/null @@ -1,36 +0,0 @@ -# Generated by Django 5.1.4 on 2025-09-28 14:26 - -import django.db.models.functions.text -import web.fields.models -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0060_alter_article_category_alter_article_name_and_more'), - ] - - operations = [ - migrations.RemoveIndex( - model_name='article', - name='web_article_categor_006394_idx', - ), - migrations.AddField( - model_name='article', - name='complete_full_name', - field=models.GeneratedField(db_persist=True, expression=django.db.models.functions.text.Concat('category', models.Value(':', output_field=web.fields.models.CITextField()), 'name'), output_field=web.fields.models.CITextField()), - ), - migrations.AddIndex( - model_name='article', - index=models.Index(fields=['category'], name='web_article_categor_7c81ec_idx'), - ), - migrations.AddIndex( - model_name='article', - index=models.Index(fields=['name'], name='web_article_name_1c14b5_idx'), - ), - migrations.AddIndex( - model_name='article', - index=models.Index(fields=['complete_full_name'], name='web_article_complet_ea3782_idx'), - ), - ] diff --git a/web/migrations/0062_article_authors.py b/web/migrations/0062_article_authors.py deleted file mode 100644 index d2eb1f3e..00000000 --- a/web/migrations/0062_article_authors.py +++ /dev/null @@ -1,19 +0,0 @@ -# Generated by Django 5.1.4 on 2025-11-14 22:27 - -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0061_remove_article_web_article_categor_006394_idx_and_more'), - ] - - operations = [ - migrations.AddField( - model_name='article', - name='authors', - field=models.ManyToManyField(related_name='authored_by', to=settings.AUTH_USER_MODEL, verbose_name='Авторы'), - ), - ] diff --git a/web/migrations/0063_author_to_authors.py b/web/migrations/0063_author_to_authors.py deleted file mode 100644 index 3f10ce5a..00000000 --- a/web/migrations/0063_author_to_authors.py +++ /dev/null @@ -1,29 +0,0 @@ -# Generated by Django 5.1.4 on 2025-11-14 22:28 - -from django.db import migrations - - -def copy_fk_to_m2m(apps, schema_editor): - Article = apps.get_model('web', 'Article') - for instance in Article.objects.all(): - if instance.author: - instance.authors.add(instance.author) - -def reverse_copy_fk_to_m2m(apps, schema_editor): - Article = apps.get_model('web', 'Article') - for instance in Article.objects.all(): - if instance.authors.exists(): - instance.author = instance.authors.first() - instance.save() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0062_article_authors'), - ] - - operations = [ - migrations.RunPython(copy_fk_to_m2m, reverse_copy_fk_to_m2m) - ] - diff --git a/web/migrations/0064_remove_article_author.py b/web/migrations/0064_remove_article_author.py deleted file mode 100644 index 52faa4a0..00000000 --- a/web/migrations/0064_remove_article_author.py +++ /dev/null @@ -1,17 +0,0 @@ -# Generated by Django 5.1.4 on 2025-11-14 23:14 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0063_author_to_authors'), - ] - - operations = [ - migrations.RemoveField( - model_name='article', - name='author', - ), - ] diff --git a/web/migrations/0065_alter_articlelogentry_type.py b/web/migrations/0065_alter_articlelogentry_type.py deleted file mode 100644 index 37d97004..00000000 --- a/web/migrations/0065_alter_articlelogentry_type.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 5.1.4 on 2025-11-15 04:34 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0064_remove_article_author'), - ] - - operations = [ - migrations.AlterField( - model_name='articlelogentry', - name='type', - field=models.TextField(choices=[('source', '内容更改'), ('title', '标题更改'), ('name', '页面地址更改'), ('tags', '标签更改'), ('new', '页面创建'), ('parent', '父页面更改'), ('file_added', '文件添加'), ('file_deleted', '文件删除'), ('file_renamed', '文件重命名'), ('votes_deleted', '评分重置'), ('authorship', '作者变更'), ('wikidot', '来自Wikidot的编辑'), ('revert', '版本回退')], verbose_name='类型'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0066_actionlogentry_user_origin_ip_idx.py b/web/migrations/0066_actionlogentry_user_origin_ip_idx.py deleted file mode 100644 index 46927a52..00000000 --- a/web/migrations/0066_actionlogentry_user_origin_ip_idx.py +++ /dev/null @@ -1,17 +0,0 @@ -# Generated by Django 5.1.4 on 2025-11-16 13:50 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0065_alter_articlelogentry_type'), - ] - - operations = [ - migrations.AddIndex( - model_name='actionlogentry', - index=models.Index(fields=['user', 'origin_ip'], name='user_origin_ip_idx'), - ), - ] diff --git a/web/migrations/0067_remove_usernotification_referred_to_and_more.py b/web/migrations/0067_remove_usernotification_referred_to_and_more.py deleted file mode 100644 index a6e02da5..00000000 --- a/web/migrations/0067_remove_usernotification_referred_to_and_more.py +++ /dev/null @@ -1,22 +0,0 @@ -# Generated by Django 5.1.4 on 2025-11-16 12:35 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0066_actionlogentry_user_origin_ip_idx'), - ] - - operations = [ - migrations.RemoveField( - model_name='usernotification', - name='referred_to', - ), - migrations.AlterField( - model_name='usernotification', - name='type', - field=models.TextField(choices=[('welcome', '欢迎消息'), ('new_post_reply', '帖子回复'), ('new_thread_post', '新帖子'), ('new_article_revision', '文章编辑'), ('forum_mention', '论坛提及')], verbose_name='通知类型'), - ), - ] \ No newline at end of file diff --git a/web/migrations/0068_user_user_email_ci_uniqueness.py b/web/migrations/0068_user_user_email_ci_uniqueness.py deleted file mode 100644 index 1b990e23..00000000 --- a/web/migrations/0068_user_user_email_ci_uniqueness.py +++ /dev/null @@ -1,19 +0,0 @@ -# Generated by Django 5.2.8 on 2025-11-29 03:11 - -import django.db.models.functions.text -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('auth', '0012_alter_user_first_name_max_length'), - ('web', '0067_remove_usernotification_referred_to_and_more'), - ] - - operations = [ - migrations.AddConstraint( - model_name='user', - constraint=models.UniqueConstraint(django.db.models.functions.text.Lower('email'), condition=models.Q(('email__isnull', False), models.Q(('email', ''), _negated=True)), name='user_email_ci_uniqueness'), - ), - ] diff --git a/web/migrations/0069_directmessage_and_user_can_send_direct_messages.py b/web/migrations/0069_directmessage_and_user_can_send_direct_messages.py deleted file mode 100644 index 0d0f8051..00000000 --- a/web/migrations/0069_directmessage_and_user_can_send_direct_messages.py +++ /dev/null @@ -1,76 +0,0 @@ -import auto_prefetch -import django.db.models.deletion -import django.db.models.manager -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0068_user_user_email_ci_uniqueness'), - ] - - operations = [ - migrations.AddField( - model_name='user', - name='can_send_direct_messages', - field=models.BooleanField(default=True, verbose_name='允许发送私信'), - ), - migrations.CreateModel( - name='DirectMessage', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('body', models.TextField(verbose_name='内容')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='发送时间')), - ('is_read', models.BooleanField(default=False, verbose_name='已读')), - ('recipient', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='received_direct_messages', to=settings.AUTH_USER_MODEL, verbose_name='接收者')), - ('sender', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='sent_direct_messages', to=settings.AUTH_USER_MODEL, verbose_name='发送者')), - ], - options={ - 'verbose_name': '私信', - 'verbose_name_plural': '私信', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddIndex( - model_name='directmessage', - index=models.Index(fields=['recipient', 'is_read'], name='dm_recip_read_idx'), - ), - migrations.AddIndex( - model_name='directmessage', - index=models.Index(fields=['sender', 'recipient', 'created_at'], name='dm_sr_created_idx'), - ), - migrations.AddIndex( - model_name='directmessage', - index=models.Index(fields=['recipient', 'sender', 'created_at'], name='dm_rs_created_idx'), - ), - migrations.CreateModel( - name='DirectMessageBlock', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='创建时间')), - ('blocked', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='dm_blocks_in', to=settings.AUTH_USER_MODEL, verbose_name='被拉黑者')), - ('blocker', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='dm_blocks_out', to=settings.AUTH_USER_MODEL, verbose_name='拉黑者')), - ], - options={ - 'verbose_name': '私信拉黑', - 'verbose_name_plural': '私信拉黑', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddConstraint( - model_name='directmessageblock', - constraint=models.UniqueConstraint(fields=('blocker', 'blocked'), name='dm_block_uniqueness'), - ), - ] diff --git a/web/migrations/0070_alter_usernotification_type.py b/web/migrations/0070_alter_usernotification_type.py deleted file mode 100644 index d25a8984..00000000 --- a/web/migrations/0070_alter_usernotification_type.py +++ /dev/null @@ -1,16 +0,0 @@ -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0069_directmessage_and_user_can_send_direct_messages'), - ] - - operations = [ - migrations.AlterField( - model_name='usernotification', - name='type', - field=models.TextField(choices=[('welcome', '欢迎消息'), ('new_post_reply', '帖子回复'), ('new_thread_post', '新帖子'), ('new_article_revision', '文章编辑'), ('forum_mention', '论坛提及'), ('direct_message', '私信')], verbose_name='通知类型'), - ), - ] diff --git a/web/migrations/0071_assign_send_dm_permission.py b/web/migrations/0071_assign_send_dm_permission.py deleted file mode 100644 index 2ef0dae3..00000000 --- a/web/migrations/0071_assign_send_dm_permission.py +++ /dev/null @@ -1,47 +0,0 @@ -from django.apps.registry import Apps -from django.db import migrations - - -def assign_send_dm_permission(apps: Apps, schema_editor): - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - Role = apps.get_model('web', 'Role') - - content_type, _ = ContentType.objects.get_or_create( - app_label='web', - model='roles', - ) - - perm, _ = Permission.objects.get_or_create( - codename='send_direct_message', - content_type=content_type, - defaults={'name': '发送私信'}, - ) - - for role in Role.objects.exclude(slug__in=['everyone', 'registered', 'reader']): - role.permissions.add(perm) - - -def remove_send_dm_permission(apps: Apps, schema_editor): - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - - content_type = ContentType.objects.filter( - app_label='web', - model='roles', - ).first() - if not content_type: - return - - Permission.objects.filter(codename='send_direct_message', content_type=content_type).delete() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0070_alter_usernotification_type'), - ] - - operations = [ - migrations.RunPython(assign_send_dm_permission, remove_send_dm_permission, atomic=True), - ] diff --git a/web/migrations/0072_userreport.py b/web/migrations/0072_userreport.py deleted file mode 100644 index ebaf7272..00000000 --- a/web/migrations/0072_userreport.py +++ /dev/null @@ -1,48 +0,0 @@ -import auto_prefetch -import django.db.models.deletion -import django.db.models.manager -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0071_assign_send_dm_permission'), - ] - - operations = [ - migrations.CreateModel( - name='UserReport', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('reason', models.TextField(verbose_name='举报理由')), - ('reported_messages', models.JSONField(blank=True, default=list, verbose_name='举报的消息（快照）')), - ('status', models.TextField(choices=[('pending', '待处理'), ('reviewed', '已处理'), ('dismissed', '已驳回')], default='pending', verbose_name='状态')), - ('admin_notes', models.TextField(blank=True, verbose_name='处理备注')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='提交时间')), - ('reviewed_at', models.DateTimeField(blank=True, null=True, verbose_name='处理时间')), - ('reported', auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='reports_received', to=settings.AUTH_USER_MODEL, verbose_name='被举报人')), - ('reporter', auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='reports_submitted', to=settings.AUTH_USER_MODEL, verbose_name='举报人')), - ('reviewed_by', auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='reports_reviewed', to=settings.AUTH_USER_MODEL, verbose_name='处理人')), - ], - options={ - 'verbose_name': '用户检举', - 'verbose_name_plural': '用户检举', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddIndex( - model_name='userreport', - index=models.Index(fields=['status', 'created_at'], name='report_status_ct_idx'), - ), - migrations.AddIndex( - model_name='userreport', - index=models.Index(fields=['reported', 'status'], name='report_target_status_idx'), - ), - ] diff --git a/web/migrations/0073_assign_view_user_reports_permission.py b/web/migrations/0073_assign_view_user_reports_permission.py deleted file mode 100644 index 20d04bee..00000000 --- a/web/migrations/0073_assign_view_user_reports_permission.py +++ /dev/null @@ -1,59 +0,0 @@ -from django.apps.registry import Apps -from django.db import migrations - - -def assign_view_user_reports_permission(apps: Apps, schema_editor): - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - Role = apps.get_model('web', 'Role') - - content_type, _ = ContentType.objects.get_or_create( - app_label='web', - model='roles', - ) - - view_perm, _ = Permission.objects.get_or_create( - codename='view_user_reports', - content_type=content_type, - defaults={'name': '查看用户检举'}, - ) - - Permission.objects.get_or_create( - codename='view_reported_full_conversation', - content_type=content_type, - defaults={'name': '查看被举报会话全部记录'}, - ) - - manage_users_perm = Permission.objects.filter( - codename='manage_users', content_type=content_type, - ).first() - if manage_users_perm: - for role in Role.objects.filter(permissions=manage_users_perm): - role.permissions.add(view_perm) - - -def remove_permissions(apps: Apps, schema_editor): - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - - content_type = ContentType.objects.filter( - app_label='web', model='roles', - ).first() - if not content_type: - return - - Permission.objects.filter( - codename__in=['view_user_reports', 'view_reported_full_conversation'], - content_type=content_type, - ).delete() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0072_userreport'), - ] - - operations = [ - migrations.RunPython(assign_view_user_reports_permission, remove_permissions, atomic=True), - ] diff --git a/web/migrations/0074_user_display_name.py b/web/migrations/0074_user_display_name.py deleted file mode 100644 index 5af5eb13..00000000 --- a/web/migrations/0074_user_display_name.py +++ /dev/null @@ -1,17 +0,0 @@ -import web.models.users -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0073_assign_view_user_reports_permission'), - ] - - operations = [ - migrations.AddField( - model_name='user', - name='display_name', - field=models.CharField(blank=True, max_length=150, null=True, validators=[web.models.users.StrictDisplayNameValidator()], verbose_name='显示名'), - ), - ] diff --git a/web/migrations/0075_canonicalize_usernames.py b/web/migrations/0075_canonicalize_usernames.py deleted file mode 100644 index 3f531a2a..00000000 --- a/web/migrations/0075_canonicalize_usernames.py +++ /dev/null @@ -1,67 +0,0 @@ -import re - -from django.db import migrations - - -def _canon(name): - # 与 web.models.users.canonicalize_username 保持一致：小写 + [空格 _ -] 折叠为单个 - + 去首尾 - - return re.sub(r'[\s_-]+', '-', name or '').strip('-').lower() - - -def forwards(apps, schema_editor): - User = apps.get_model('web', 'User') - display_re = re.compile(r'^[\w -]+\Z', re.ASCII) - skipped = [] - - for u in User.objects.all().iterator(): - # 普通用户规范化 username；Wikidot 用户规范化 wikidot_username（其 username 是 uuid 占位，不动） - if u.type == 'wikidot': - field, original = 'wikidot_username', u.wikidot_username - else: - field, original = 'username', u.username - - if not original: - continue - - canon = _canon(original) - if not canon or canon == original: - continue - - update_fields = [] - # 保留原名为显示名（仅当当前无显示名且原名符合显示名字符集） - if not u.display_name and display_re.match(original): - u.display_name = original - update_fields.append('display_name') - - # 冲突检测（citext 大小写不敏感）：撞名就跳过，保持原值不动 - clash = User.objects.filter(**{'%s__iexact' % field: canon}).exclude(pk=u.pk).exists() - if clash: - skipped.append('%s (%s=%r -> %r 冲突，已跳过)' % (u.pk, field, original, canon)) - if update_fields: - u.save(update_fields=update_fields) - continue - - setattr(u, field, canon) - update_fields.append(field) - u.save(update_fields=update_fields) - - if skipped: - print('\n以下用户因规范化后与他人冲突而未改动，请人工处理：') - for line in skipped: - print(' - ' + line) - - -def backwards(apps, schema_editor): - # 不可逆（原始大小写/下划线已无法从 canon 还原）；显示名保留即可作为参考 - pass - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0074_user_display_name'), - ] - - operations = [ - migrations.RunPython(forwards, backwards), - ] diff --git a/web/migrations/0076_assign_manage_updates_permission.py b/web/migrations/0076_assign_manage_updates_permission.py deleted file mode 100644 index 15f97ed1..00000000 --- a/web/migrations/0076_assign_manage_updates_permission.py +++ /dev/null @@ -1,53 +0,0 @@ -from django.apps.registry import Apps -from django.db import migrations - - -def assign_manage_updates_permission(apps: Apps, schema_editor): - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - Role = apps.get_model('web', 'Role') - - content_type, _ = ContentType.objects.get_or_create( - app_label='web', - model='roles', - ) - - manage_updates_perm, _ = Permission.objects.get_or_create( - codename='manage_updates', - content_type=content_type, - defaults={'name': '管理系统更新'}, - ) - - manage_site_perm = Permission.objects.filter( - codename='manage_site', content_type=content_type, - ).first() - if manage_site_perm: - for role in Role.objects.filter(permissions=manage_site_perm): - role.permissions.add(manage_updates_perm) - - -def remove_permission(apps: Apps, schema_editor): - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - - content_type = ContentType.objects.filter( - app_label='web', model='roles', - ).first() - if not content_type: - return - - Permission.objects.filter( - codename='manage_updates', - content_type=content_type, - ).delete() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0075_canonicalize_usernames'), - ] - - operations = [ - migrations.RunPython(assign_manage_updates_permission, remove_permission, atomic=True), - ] diff --git a/web/migrations/0077_theme_and_site_options.py b/web/migrations/0077_theme_and_site_options.py deleted file mode 100644 index d10fa754..00000000 --- a/web/migrations/0077_theme_and_site_options.py +++ /dev/null @@ -1,68 +0,0 @@ -import os - -import django.db.models.deletion -from django.conf import settings -from django.db import migrations, models - - -def seed_default_theme(apps, schema_editor): - Theme = apps.get_model('web', 'Theme') - Site = apps.get_model('web', 'Site') - - css = '' - path = os.path.join(settings.BASE_DIR, 'static', 'theme.css') - try: - with open(path, 'r', encoding='utf-8') as f: - css = f.read() - except OSError: - css = '' - - Theme.objects.create(name='默认主题', mode='inline', css=css) - - -def unseed_default_theme(apps, schema_editor): - Theme = apps.get_model('web', 'Theme') - Site = apps.get_model('web', 'Site') - - site = Site.objects.first() - if site is not None: - site.active_theme = None - site.save(update_fields=['active_theme']) - - Theme.objects.filter(name='默认主题').delete() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0076_assign_manage_updates_permission'), - ] - - operations = [ - migrations.CreateModel( - name='Theme', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('name', models.TextField(verbose_name='主题名称')), - ('mode', models.TextField(choices=[('inline', '内联CSS'), ('external', '外部链接')], default='inline', verbose_name='类型')), - ('css', models.TextField(blank=True, default='', verbose_name='CSS 内容')), - ('external_url', models.TextField(blank=True, default='', verbose_name='外部 CSS 链接')), - ('updated_at', models.DateTimeField(auto_now=True, verbose_name='更新时间')), - ], - options={ - 'verbose_name': '主题', - 'verbose_name_plural': '主题', - }, - ), - migrations.AddField( - model_name='site', - name='home_page', - field=models.TextField(default='main', verbose_name='主页名称'), - ), - migrations.AddField( - model_name='site', - name='active_theme', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.theme', verbose_name='站点主题'), - ), - migrations.RunPython(seed_default_theme, unseed_default_theme), - ] diff --git a/web/migrations/0078_systemupdate_proxy.py b/web/migrations/0078_systemupdate_proxy.py deleted file mode 100644 index 8c1fb08d..00000000 --- a/web/migrations/0078_systemupdate_proxy.py +++ /dev/null @@ -1,23 +0,0 @@ -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0077_theme_and_site_options'), - ] - - operations = [ - migrations.CreateModel( - name='SystemUpdate', - fields=[], - options={ - 'verbose_name': '系统更新', - 'verbose_name_plural': '系统更新', - 'proxy': True, - 'indexes': [], - 'constraints': [], - }, - bases=('web.site',), - ), - ] diff --git a/web/migrations/0079_theme_slug.py b/web/migrations/0079_theme_slug.py deleted file mode 100644 index 3f6d6a60..00000000 --- a/web/migrations/0079_theme_slug.py +++ /dev/null @@ -1,60 +0,0 @@ -import os -from pathlib import Path - -import django.core.validators -from django.conf import settings -from django.db import migrations, models -from django.utils.text import slugify - - -def populate_slugs(apps, schema_editor): - Theme = apps.get_model('web', 'Theme') - used = set() - for theme in Theme.objects.all().order_by('pk'): - if theme.name == '默认主题': - slug = 'default' - else: - slug = slugify(theme.name) or ('theme%d' % theme.pk) - base = slug - i = 1 - while slug in used: - i += 1 - slug = '%s-%d' % (base, i) - used.add(slug) - theme.slug = slug - theme.save(update_fields=['slug']) - - if theme.mode == 'inline': - directory = Path(settings.MEDIA_ROOT) / 'theme' - try: - directory.mkdir(parents=True, exist_ok=True) - with open(directory / (slug + '.css'), 'w', encoding='utf-8') as f: - f.write(theme.css or '') - except OSError: - pass - - -def noop(apps, schema_editor): - pass - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0078_systemupdate_proxy'), - ] - - operations = [ - migrations.AddField( - model_name='theme', - name='slug', - field=models.TextField(default='', verbose_name='标识名'), - preserve_default=False, - ), - migrations.RunPython(populate_slugs, noop), - migrations.AlterField( - model_name='theme', - name='slug', - field=models.TextField(unique=True, validators=[django.core.validators.RegexValidator('^[A-Za-z0-9_-]+$', '标识名只能包含英文字母、数字、- 和 _')], verbose_name='标识名'), - ), - ] diff --git a/web/migrations/0080_user_tickets_and_site_membership_options.py b/web/migrations/0080_user_tickets_and_site_membership_options.py deleted file mode 100644 index 0dc1b8cb..00000000 --- a/web/migrations/0080_user_tickets_and_site_membership_options.py +++ /dev/null @@ -1,140 +0,0 @@ -import auto_prefetch -import django.db.models.deletion -import django.db.models.manager -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0079_theme_slug'), - ] - - operations = [ - migrations.CreateModel( - name='UserTicket', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('kind', models.TextField(choices=[('ticket', '工单'), ('membershipapply', '入组申请')], default='ticket', verbose_name='类型')), - ('subject', models.TextField(blank=True, verbose_name='标题')), - ('body', models.TextField(verbose_name='正文')), - ('source_page', models.TextField(blank=True, verbose_name='提交页面')), - ('status', models.TextField(choices=[('pending', '待处理'), ('approved', '已通过'), ('rejected', '已驳回'), ('closed', '已关闭')], default='pending', verbose_name='状态')), - ('admin_notes', models.TextField(blank=True, verbose_name='处理备注')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='提交时间')), - ('reviewed_at', models.DateTimeField(blank=True, null=True, verbose_name='处理时间')), - ], - options={ - 'verbose_name': '用户提交', - 'verbose_name_plural': '用户提交', - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddField( - model_name='site', - name='auth_icon', - field=models.ImageField(blank=True, null=True, upload_to='-/sites', verbose_name='登录/注册页图标'), - ), - migrations.AddField( - model_name='site', - name='default_role', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.role', verbose_name='普通注册获得的角色'), - ), - migrations.AddField( - model_name='site', - name='footer_license', - field=models.TextField(blank=True, help_text='留空使用内置文案。支持 wikitext，并且只允许 [[module time]] 这一个模块。', verbose_name='页脚授权说明'), - ), - migrations.AddField( - model_name='site', - name='membership_password', - field=models.TextField(blank=True, verbose_name='入组密码'), - ), - migrations.AddField( - model_name='site', - name='membership_password_enabled', - field=models.BooleanField(default=False, verbose_name='启用密码入组'), - ), - migrations.AddField( - model_name='site', - name='membership_password_role', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.role', verbose_name='密码入组获得的角色'), - ), - migrations.AddField( - model_name='site', - name='signup_notice', - field=models.TextField(blank=True, help_text='留空使用内置文案。显示在注册按钮下方。', verbose_name='注册页提示'), - ), - migrations.AddField( - model_name='site', - name='verified_role', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.role', verbose_name='认证账号获得的角色'), - ), - migrations.AddField( - model_name='userticket', - name='author', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='tickets_submitted', to=settings.AUTH_USER_MODEL, verbose_name='提交人'), - ), - migrations.AddField( - model_name='userticket', - name='granted_role', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='web.role', verbose_name='授予的角色'), - ), - migrations.AddField( - model_name='userticket', - name='reviewed_by', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='tickets_reviewed', to=settings.AUTH_USER_MODEL, verbose_name='处理人'), - ), - migrations.CreateModel( - name='MembershipApplication', - fields=[ - ], - options={ - 'verbose_name': '申请书', - 'verbose_name_plural': '申请书', - 'abstract': False, - 'proxy': True, - 'base_manager_name': 'prefetch_manager', - 'indexes': [], - 'constraints': [], - }, - bases=('web.userticket',), - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.CreateModel( - name='SupportTicket', - fields=[ - ], - options={ - 'verbose_name': '用户工单', - 'verbose_name_plural': '用户工单', - 'abstract': False, - 'proxy': True, - 'base_manager_name': 'prefetch_manager', - 'indexes': [], - 'constraints': [], - }, - bases=('web.userticket',), - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddIndex( - model_name='userticket', - index=models.Index(fields=['kind', 'status', 'created_at'], name='web_usertic_kind_b5423e_idx'), - ), - migrations.AddIndex( - model_name='userticket', - index=models.Index(fields=['author', 'kind'], name='web_usertic_author__6ccbb3_idx'), - ), - ] diff --git a/web/migrations/0081_assign_ticket_permissions.py b/web/migrations/0081_assign_ticket_permissions.py deleted file mode 100644 index ba273206..00000000 --- a/web/migrations/0081_assign_ticket_permissions.py +++ /dev/null @@ -1,72 +0,0 @@ -from django.apps.registry import Apps -from django.db import migrations - - -NEW_PERMISSIONS = { - 'view_user_tickets': '查看用户工单', - 'review_membership_applications': '审核入组申请', - 'manage_permissions': '访问权限表', -} - - -def assign_ticket_permissions(apps: Apps, schema_editor): - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - Role = apps.get_model('web', 'Role') - - content_type, _ = ContentType.objects.get_or_create( - app_label='web', - model='roles', - ) - - created = {} - for codename, name in NEW_PERMISSIONS.items(): - created[codename], _ = Permission.objects.get_or_create( - codename=codename, - content_type=content_type, - defaults={'name': name}, - ) - - view_reports = Permission.objects.filter( - codename='view_user_reports', content_type=content_type, - ).first() - if view_reports: - for role in Role.objects.filter(permissions=view_reports): - role.permissions.add(created['view_user_tickets']) - role.permissions.add(created['review_membership_applications']) - - # 在这条迁移之前，改权限的门是「管理角色」；不给这些角色补上「访问权限表」， - # 升级之后他们会突然失去一项本来就有的能力。 - manage_roles = Permission.objects.filter( - codename='manage_roles', content_type=content_type, - ).first() - if manage_roles: - for role in Role.objects.filter(permissions=manage_roles): - role.permissions.add(created['manage_permissions']) - - -def remove_permissions(apps: Apps, schema_editor): - ContentType = apps.get_model('contenttypes', 'ContentType') - Permission = apps.get_model('auth', 'Permission') - - content_type = ContentType.objects.filter( - app_label='web', model='roles', - ).first() - if not content_type: - return - - Permission.objects.filter( - codename__in=list(NEW_PERMISSIONS), - content_type=content_type, - ).delete() - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0080_user_tickets_and_site_membership_options'), - ] - - operations = [ - migrations.RunPython(assign_ticket_permissions, remove_permissions, atomic=True), - ] diff --git a/web/migrations/0082_invite_links.py b/web/migrations/0082_invite_links.py deleted file mode 100644 index dc06bbc3..00000000 --- a/web/migrations/0082_invite_links.py +++ /dev/null @@ -1,59 +0,0 @@ -import auto_prefetch -import django.db.models.deletion -import django.db.models.manager -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0081_assign_ticket_permissions'), - ] - - operations = [ - migrations.CreateModel( - name='InviteLink', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('kind', models.TextField(choices=[('register', '邀请注册'), ('claim', '认领')], default='register', verbose_name='类型')), - ('delivery', models.TextField(choices=[('link', '手动发链接'), ('email', '邮件发送')], default='link', verbose_name='发放方式')), - ('email', models.TextField(blank=True, verbose_name='邮箱')), - ('wikidot_username', models.TextField(blank=True, verbose_name='Wikidot 用户名')), - ('token', models.TextField(verbose_name='令牌')), - ('uidb64', models.TextField(verbose_name='账号编码')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='创建时间')), - ('activated_at', models.DateTimeField(blank=True, null=True, verbose_name='激活时间')), - ('activated_username', models.TextField(blank=True, verbose_name='激活后用户名')), - ], - options={ - 'verbose_name': '邀请链接', - 'verbose_name_plural': '邀请链接', - 'ordering': ['-created_at'], - 'abstract': False, - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddField( - model_name='invitelink', - name='created_by', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='invite_links_created', to=settings.AUTH_USER_MODEL, verbose_name='创建人'), - ), - migrations.AddField( - model_name='invitelink', - name='target', - field=auto_prefetch.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='invite_links', to=settings.AUTH_USER_MODEL, verbose_name='目标账号'), - ), - migrations.AddIndex( - model_name='invitelink', - index=models.Index(fields=['kind', 'activated_at'], name='web_invitel_kind_bfa536_idx'), - ), - migrations.AddIndex( - model_name='invitelink', - index=models.Index(fields=['token'], name='web_invitel_token_4bbe08_idx'), - ), - ] diff --git a/web/migrations/0083_site_system_theme.py b/web/migrations/0083_site_system_theme.py deleted file mode 100644 index 08533a7b..00000000 --- a/web/migrations/0083_site_system_theme.py +++ /dev/null @@ -1,25 +0,0 @@ -import django.db.models.deletion -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0082_invite_links'), - ] - - operations = [ - migrations.AddField( - model_name='site', - name='system_theme', - field=models.ForeignKey( - blank=True, - help_text='登录、注册、个人资料这类页面额外加载的 CSS。留空则只用内置样式。', - null=True, - on_delete=django.db.models.deletion.SET_NULL, - related_name='+', - to='web.theme', - verbose_name='系统页主题', - ), - ), - ] diff --git a/web/migrations/0084_forum_post_like_article_favourite.py b/web/migrations/0084_forum_post_like_article_favourite.py deleted file mode 100644 index 003d9750..00000000 --- a/web/migrations/0084_forum_post_like_article_favourite.py +++ /dev/null @@ -1,68 +0,0 @@ -import auto_prefetch -import django.db.models.deletion -import django.db.models.manager -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - migrations.swappable_dependency(settings.AUTH_USER_MODEL), - ('web', '0083_site_system_theme'), - ] - - operations = [ - migrations.CreateModel( - name='ForumPostLike', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='点赞时间')), - ('post', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.forumpost', verbose_name='帖子')), - ('user', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL, verbose_name='点赞者')), - ], - options={ - 'verbose_name': '帖子点赞', - 'verbose_name_plural': '帖子点赞', - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.CreateModel( - name='ArticleFavourite', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), - ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='收藏时间')), - ('article', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='web.article', verbose_name='文章')), - ('user', auto_prefetch.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL, verbose_name='收藏者')), - ], - options={ - 'verbose_name': '收藏', - 'verbose_name_plural': '收藏', - 'base_manager_name': 'prefetch_manager', - }, - managers=[ - ('objects', django.db.models.manager.Manager()), - ('prefetch_manager', django.db.models.manager.Manager()), - ], - ), - migrations.AddConstraint( - model_name='forumpostlike', - constraint=models.UniqueConstraint(fields=('post', 'user'), name='web_forumpostlike_unique'), - ), - migrations.AddIndex( - model_name='forumpostlike', - index=models.Index(fields=['post', 'created_at'], name='web_forumpo_post_id_3cdbb2_idx'), - ), - migrations.AddConstraint( - model_name='articlefavourite', - constraint=models.UniqueConstraint(fields=('article', 'user'), name='web_articlefavourite_unique'), - ), - migrations.AddIndex( - model_name='articlefavourite', - index=models.Index(fields=['user', 'created_at'], name='web_article_user_id_e697e3_idx'), - ), - ] diff --git a/web/migrations/0085_site_password_help.py b/web/migrations/0085_site_password_help.py deleted file mode 100644 index 9430c47d..00000000 --- a/web/migrations/0085_site_password_help.py +++ /dev/null @@ -1,22 +0,0 @@ -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0084_forum_post_like_article_favourite'), - ] - - operations = [ - migrations.AddField( - model_name='site', - name='password_help', - field=models.TextField( - blank=True, - default='', - help_text='找回密码页上「邮箱收不到信？」展开后显示的内容。' - '留空使用内置文案。支持 wikitext，不允许任何模块。', - verbose_name='找回密码求助文案', - ), - ), - ] diff --git a/web/migrations/0086_email_verification.py b/web/migrations/0086_email_verification.py deleted file mode 100644 index 13059fd4..00000000 --- a/web/migrations/0086_email_verification.py +++ /dev/null @@ -1,64 +0,0 @@ -import django.db.models.functions.text -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('web', '0085_site_password_help'), - ] - - operations = [ - migrations.AddField( - model_name='user', - name='email_verified_at', - field=models.DateTimeField(blank=True, null=True, verbose_name='邮箱验证时间'), - ), - migrations.AddField( - model_name='user', - name='pending_email', - field=models.TextField(blank=True, default='', verbose_name='待验证的新邮箱'), - ), - migrations.AddField( - model_name='user', - name='previous_email', - field=models.TextField(blank=True, default='', verbose_name='改绑前的邮箱'), - ), - migrations.AddField( - model_name='user', - name='email_changed_at', - field=models.DateTimeField(blank=True, null=True, verbose_name='邮箱上次改绑时间'), - ), - migrations.AddField( - model_name='user', - name='username_changed_at', - field=models.DateTimeField(blank=True, null=True, verbose_name='用户名上次修改时间'), - ), - migrations.AddField( - model_name='site', - name='email_policy', - field=models.TextField( - choices=[ - ('at_signup', '注册时就必须验证'), - ('required', '可以注册，但未验证不能操作'), - ('optional', '只当标识，未验证只影响找回密码'), - ], - default='optional', - help_text='注册一律要填邮箱。这里决定没验证的人还能做什么。', - verbose_name='邮箱验证要求', - ), - ), - migrations.RemoveConstraint( - model_name='user', - name='user_email_ci_uniqueness', - ), - migrations.AddConstraint( - model_name='user', - constraint=models.UniqueConstraint( - django.db.models.functions.text.Lower('email'), - condition=models.Q(email__isnull=False) & ~models.Q(email='') - & models.Q(email_verified_at__isnull=False), - name='user_email_ci_uniqueness', - ), - ), - ] diff --git a/web/migrations/0087_align_models_and_schema.py b/web/migrations/0087_align_models_and_schema.py deleted file mode 100644 index 2a1a1816..00000000 --- a/web/migrations/0087_align_models_and_schema.py +++ /dev/null @@ -1,170 +0,0 @@ -import django.utils.timezone -import web.fields.models -import web.models.users -import web.util -from django.conf import settings -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('auth', '0012_alter_user_first_name_max_length'), - ('web', '0086_email_verification'), - ] - - operations = [ - migrations.AlterModelOptions( - name='usedtoken', - options={'base_manager_name': 'prefetch_manager', 'verbose_name': '已使用的令牌', 'verbose_name_plural': '已使用的令牌列表'}, - ), - migrations.AlterModelOptions( - name='user', - options={'verbose_name': '用户', 'verbose_name_plural': '用户列表'}, - ), - migrations.RenameIndex( - model_name='directmessage', - new_name='web_directm_recipie_07e335_idx', - old_name='dm_recip_read_idx', - ), - migrations.RenameIndex( - model_name='directmessage', - new_name='web_directm_sender__630662_idx', - old_name='dm_sr_created_idx', - ), - migrations.RenameIndex( - model_name='directmessage', - new_name='web_directm_recipie_a11daa_idx', - old_name='dm_rs_created_idx', - ), - migrations.RenameIndex( - model_name='userreport', - new_name='web_userrep_status_466a49_idx', - old_name='report_status_ct_idx', - ), - migrations.RenameIndex( - model_name='userreport', - new_name='web_userrep_reporte_77ecac_idx', - old_name='report_target_status_idx', - ), - migrations.AlterField( - model_name='actionlogentry', - name='origin_ip', - field=models.GenericIPAddressField(blank=True, null=True, verbose_name='IP地址'), - ), - migrations.AlterField( - model_name='article', - name='authors', - field=models.ManyToManyField(related_name='authored_by', to=settings.AUTH_USER_MODEL, verbose_name='作者'), - ), - migrations.AlterField( - model_name='article', - name='media_name', - field=models.TextField(default=web.util.uuid4_str, unique=True, verbose_name='文件系统中文件文件夹的名称'), - ), - migrations.AlterField( - model_name='externallink', - name='link_type', - field=models.TextField(choices=[('include', 'Include'), ('link', 'Link')], verbose_name='链接类型'), - ), - migrations.AlterField( - model_name='forumsection', - name='is_hidden', - field=models.BooleanField(default=False, verbose_name='隐藏分类'), - ), - migrations.AlterField( - model_name='forumthread', - name='created_at', - field=models.DateTimeField(auto_now_add=True, verbose_name='创建时间'), - ), - migrations.AlterField( - model_name='site', - name='password_help', - field=models.TextField(blank=True, help_text='找回密码页上「邮箱收不到信？」展开后显示的内容。留空使用内置文案。支持 wikitext，不允许任何模块。', verbose_name='找回密码求助文案'), - ), - migrations.AlterField( - model_name='user', - name='api_key', - field=models.CharField(blank=True, max_length=255, null=True, unique=True, verbose_name='API密钥'), - ), - migrations.AlterField( - model_name='user', - name='date_joined', - field=models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined'), - ), - migrations.AlterField( - model_name='user', - name='email', - field=models.EmailField(blank=True, max_length=254, verbose_name='email address'), - ), - migrations.AlterField( - model_name='user', - name='first_name', - field=models.CharField(blank=True, max_length=150, verbose_name='first name'), - ), - migrations.AlterField( - model_name='user', - name='forum_inactive_until', - field=models.DateTimeField(null=True, verbose_name='论坛权限禁用至'), - ), - migrations.AlterField( - model_name='user', - name='groups', - field=models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.group', verbose_name='groups'), - ), - migrations.AlterField( - model_name='user', - name='inactive_until', - field=models.DateTimeField(null=True, verbose_name='禁用至'), - ), - migrations.AlterField( - model_name='user', - name='is_active', - field=models.BooleanField(default=True, verbose_name='已启用'), - ), - migrations.AlterField( - model_name='user', - name='is_forum_active', - field=models.BooleanField(default=True, verbose_name='论坛权限已启用'), - ), - migrations.AlterField( - model_name='user', - name='is_superuser', - field=models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status'), - ), - migrations.AlterField( - model_name='user', - name='last_login', - field=models.DateTimeField(blank=True, null=True, verbose_name='last login'), - ), - migrations.AlterField( - model_name='user', - name='last_name', - field=models.CharField(blank=True, max_length=150, verbose_name='last name'), - ), - migrations.AlterField( - model_name='user', - name='password', - field=models.CharField(max_length=128, verbose_name='password'), - ), - migrations.AlterField( - model_name='user', - name='type', - field=models.TextField(choices=[('normal', '普通用户'), ('wikidot', 'Wikidot 用户'), ('system', '系统用户'), ('bot', '机器人')], default='normal', verbose_name='用户类型'), - ), - migrations.AlterField( - model_name='user', - name='user_permissions', - field=models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='user permissions'), - ), - migrations.AlterField( - model_name='user', - name='username', - field=web.fields.models.CITextField(error_messages={'unique': '用户名已存在'}, max_length=150, unique=True, validators=[web.models.users.StrictUsernameValidator()], verbose_name='用户名'), - ), - migrations.AlterField( - model_name='vote', - name='date', - field=models.DateTimeField(auto_now_add=True, null=True, verbose_name='投票日期'), - ), - ] diff --git a/web/migrations/__init__.py b/web/migrations/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/web/models/__init__.py b/web/models/__init__.py deleted file mode 100644 index 4bc6b2c6..00000000 --- a/web/models/__init__.py +++ /dev/null @@ -1,14 +0,0 @@ -from .users import * -from .articles import * -from .files import * -from .forum import * -from .invites import * -from .logs import * -from .messages import * -from .reports import * -from .settings import * -from .site import * -from .tickets import * -from .users import * -from .search import * -from .roles import * diff --git a/web/models/articles.py b/web/models/articles.py deleted file mode 100644 index 2b28e1a8..00000000 --- a/web/models/articles.py +++ /dev/null @@ -1,302 +0,0 @@ -__all__ = [ - 'TagsCategory', - 'Tag', - 'Category', - 'Article', - 'ArticleVersion', - 'ArticleLogEntry', - 'Vote', - 'ExternalLink', - 'ArticleFavourite' -] - -import re -import auto_prefetch - -from uuid import uuid4 -from typing import Optional -from functools import cached_property - -from django.core.validators import RegexValidator -from django.db import models -from django.contrib.auth import get_user_model - -from web.fields import CITextField -from web.util import uuid4_str -from .roles import Role, PermissionsOverrideMixin, RolePermissionsOverrideMixin -from .settings import Settings -from .site import get_current_site - - -User = get_user_model() - - -class TagsCategorySlugValidator(RegexValidator): - regex = r'^[a-zа-я0-9.-_]+\Z' - message = '标签分类标识符只能包含小写字母、数字和符号[.-_]（不含括号）。' - flags = re.ASCII - - -class TagsCategory(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '标签分类' - verbose_name_plural = '标签分类' - - constraints = [models.UniqueConstraint(fields=['slug'], name='%(app_label)s_%(class)s_unique')] - indexes = [models.Index(fields=['name'])] - - name = models.TextField('完整名称') - description = models.TextField('描述', blank=True) - priority = models.PositiveIntegerField(null=True, blank=True, unique=True, verbose_name='排序编号') - slug = models.TextField('标识符', unique=True, validators=[TagsCategorySlugValidator()]) - - def __str__(self): - return f'{self.name} ({self.slug})' - - @staticmethod - def get_or_create_default_tags_category(): - category, _ = TagsCategory.objects.get_or_create(slug='_default', defaults=dict(name='默认')) - return category.pk - - @property - def is_default(self) -> bool: - return self.slug == '_default' - - def save(self, *args, **kwargs): - if not self.pk and not self.name: - self.name = self.slug - return super(TagsCategory, self).save(*args, **kwargs) - - -class Tag(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '标签' - verbose_name_plural = '标签' - - constraints = [models.UniqueConstraint(fields=['category', 'name'], name='%(app_label)s_%(class)s_unique')] - indexes = [models.Index(fields=['category', 'name'])] - - category = auto_prefetch.ForeignKey(TagsCategory, null=False, blank=False, on_delete=models.CASCADE, verbose_name='分类', default=TagsCategory.get_or_create_default_tags_category) - name = models.TextField('名称') - - def __str__(self): - return self.full_name - - @property - def full_name(self) -> str: - if self.category and not self.category.is_default: - return f'{self.category.slug}:{self.name}' - return self.name - - def save(self, *args, **kwargs): - self.name = self.name.lower() - return super(Tag, self).save(*args, **kwargs) - - -class Category(auto_prefetch.Model, RolePermissionsOverrideMixin): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '分类设置' - verbose_name_plural = '分类设置' - - constraints = [models.UniqueConstraint(fields=['name'], name='%(app_label)s_%(class)s_unique')] - indexes = [models.Index(fields=['name'])] - - name = CITextField('名称') - - is_indexed = models.BooleanField('是否被搜索引擎索引', null=False, default=True) - - def __str__(self) -> str: - return self.name - - def __eq__(self, value): - if isinstance(value, str) and self.name == value: - return True - return super().__eq__(value) - - def __hash__(self): - return super().__hash__() - - # 此函数返回由分类设置覆盖的站点设置。 - # 如果两者均未设置，则回退到Settings类中定义的默认值。 - @cached_property - def settings(self): - category_settings = Settings.objects.filter(category=self).first() - site_settings = get_current_site().settings - return Settings.get_default_settings().merge(site_settings).merge(category_settings) - - @staticmethod - def get_or_default_category(category): - cat = Category.objects.filter(name=category) - if not cat: - return Category(name=category) - else: - return cat[0] - - -class Article(auto_prefetch.Model, PermissionsOverrideMixin): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '文章' - verbose_name_plural = '文章' - - constraints = [models.UniqueConstraint(fields=['category', 'name'], name='%(app_label)s_%(class)s_unique')] - indexes = [models.Index(fields=['category']), models.Index(fields=['name']), models.Index(fields=['complete_full_name']), models.Index(fields=['created_at']), models.Index(fields=['updated_at'])] - - roles_override_pipeline = ['category_as_object'] - - category = CITextField('分类', default='_default') - name = CITextField('名称') - complete_full_name = models.GeneratedField( - expression=models.functions.Concat( - 'category', models.Value(':', output_field=CITextField()), 'name', - ), - output_field=CITextField(), - db_persist=True - ) - title = models.TextField('标题') - - parent = auto_prefetch.ForeignKey('self', on_delete=models.SET_NULL, null=True, blank=True, verbose_name='父页面') - tags = models.ManyToManyField(Tag, blank=True, related_name='articles', verbose_name='标签') - authors = models.ManyToManyField(User, blank=False, related_name='authored_by', verbose_name='作者') - - locked = models.BooleanField('页面已保护', default=False) - - created_at = models.DateTimeField('创建时间', auto_now_add=True) - updated_at = models.DateTimeField('修改时间', auto_now_add=True) - - media_name = models.TextField('文件系统中文件文件夹的名称', unique=True, default=uuid4_str) - - @cached_property - def settings(self): - if self.category_as_object: - return self.category_as_object.settings - else: - site_settings = get_current_site().settings - return Settings.get_default_settings().merge(site_settings) - - @property - def full_name(self) -> str: - if self.category != '_default': - return f'{self.category}:{self.name}' - return self.name - - @property - def display_name(self) -> str: - return self.title.strip() or self.full_name - - @cached_property - def category_as_object(self) -> Optional[Category]: - return Category.objects.filter(name=self.category).first() - - def __str__(self) -> str: - return f'{self.title} ({self.full_name})' - - def override_perms(self, user_obj, perms: set, roles=[]): - if self.locked: - if 'roles.lock_articles' not in perms: - lockable_perms = {'roles.edit_articles', 'roles.manage_article_authors', 'roles.manage_article_files', 'roles.tag_articles', 'roles.move_articles', 'roles.delete_articles'} - perms = perms.difference(lockable_perms) - elif user_obj and user_obj in self.authors.all(): - perms.add('roles.manage_article_authors') - return super().override_perms(user_obj, perms, roles) - - -class ArticleVersion(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '文章版本' - verbose_name_plural = '文章版本' - - indexes = [models.Index(fields=['article', 'created_at'])] - - article = auto_prefetch.ForeignKey(Article, on_delete=models.CASCADE, verbose_name='文章', related_name='versions') - source = models.TextField('源代码') - ast = models.JSONField('文章的AST树', blank=True, null=True) - rendered = models.TextField('文章渲染结果', blank=True, null=True) - created_at = models.DateTimeField('创建时间', auto_now_add=True) - - def __str__(self) -> str: - return f'{self.created_at.strftime('%Y-%m-%d, %H:%M:%S')} - {self.article}' - - -class ArticleLogEntry(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '日志条目' - verbose_name_plural = '日志条目' - - constraints = [models.UniqueConstraint(fields=['article', 'rev_number'], name='%(app_label)s_%(class)s_unique')] - - class LogEntryType(models.TextChoices): - Source = ('source', '内容更改') - Title = ('title', '标题更改') - Name = ('name', '页面地址更改') - Tags = ('tags', '标签更改') - New = ('new', '页面创建') - Parent = ('parent', '父页面更改') - FileAdded = ('file_added', '文件添加') - FileDeleted = ('file_deleted', '文件删除') - FileRenamed = ('file_renamed', '文件重命名') - VotesDeleted = ('votes_deleted', '评分重置') - Authorship = ('authorship', '作者变更') - Wikidot = ('wikidot', '来自Wikidot的编辑') - Revert = ('revert', '版本回退') - - article = auto_prefetch.ForeignKey(Article, on_delete=models.CASCADE, verbose_name='文章') - user = auto_prefetch.ForeignKey(User, null=True, blank=True, on_delete=models.SET_NULL, verbose_name='用户') - type = models.TextField('类型', choices=LogEntryType.choices) - meta = models.JSONField('元数据', default=dict, blank=True) - created_at = models.DateTimeField('创建时间', auto_now_add=True) - comment = models.TextField('注释', blank=True) - rev_number = models.PositiveIntegerField('版本号') - - def __str__(self) -> str: - return f'#{self.rev_number} - {self.article}' - - -class Vote(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '评分' - verbose_name_plural = '评分' - - constraints = [models.UniqueConstraint(fields=['article', 'user'], name='%(app_label)s_%(class)s_unique')] - indexes = [models.Index(fields=['article'])] - - article = auto_prefetch.ForeignKey(Article, on_delete=models.CASCADE, verbose_name='文章', related_name='votes') - user = auto_prefetch.ForeignKey(User, null=True, on_delete=models.SET_NULL, verbose_name='用户') - rate = models.FloatField('评分') - date = models.DateTimeField('投票日期', auto_now_add=True, null=True) - role = auto_prefetch.ForeignKey(Role, on_delete=models.SET_NULL, verbose_name='角色', null=True) - - def __str__(self) -> str: - return f'{self.article}: {self.user} - {self.rate}' - - -class ExternalLink(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '链接关系' - verbose_name_plural = '链接关系' - - indexes = [ - models.Index(fields=['link_from', 'link_to']), - models.Index(fields=['link_type']) - ] - - constraints = [models.UniqueConstraint(fields=['link_from', 'link_to', 'link_type'], name='%(app_label)s_%(class)s_unique')] - - class Type(models.TextChoices): - Include = 'include' - Link = 'link' - - link_from = CITextField('源文章', null=False) - link_to = CITextField('目标文章', null=False) - link_type = models.TextField('链接类型', choices=Type.choices, null=False) - -class ArticleFavourite(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '收藏' - verbose_name_plural = '收藏' - - constraints = [models.UniqueConstraint(fields=['article', 'user'], name='%(app_label)s_%(class)s_unique')] - indexes = [models.Index(fields=['user', 'created_at'])] - - article = auto_prefetch.ForeignKey(Article, on_delete=models.CASCADE, verbose_name='文章') - user = auto_prefetch.ForeignKey(User, on_delete=models.CASCADE, verbose_name='收藏者') - created_at = models.DateTimeField('收藏时间', auto_now_add=True) diff --git a/web/models/files.py b/web/models/files.py deleted file mode 100644 index d8a61026..00000000 --- a/web/models/files.py +++ /dev/null @@ -1,60 +0,0 @@ -__all__ = [ - 'File' -] - -from django.conf import settings -import auto_prefetch -from django.db import models -from pathlib import Path -from django.contrib.auth import get_user_model - -from .articles import Article -from .site import get_current_site - -import urllib.parse - - -User = get_user_model() - - -class File(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = "文件" - verbose_name_plural = "文件" - - indexes = [models.Index(fields=['article', 'name'])] - constraints = [models.UniqueConstraint(fields=['article', 'name', 'deleted_at'], name='%(app_label)s_%(class)s_unique')] # 逻辑：未删除的文件应保持唯一 - - article = auto_prefetch.ForeignKey(Article, on_delete=models.CASCADE, verbose_name="文章") - - name = models.TextField(verbose_name="文件名") - media_name = models.TextField(verbose_name="文件系统中的文件名") - - mime_type = models.TextField(verbose_name="MIME类型") - size = models.PositiveBigIntegerField(verbose_name="文件大小") - - author = auto_prefetch.ForeignKey(User, on_delete=models.SET_NULL, verbose_name="文件作者", null=True, related_name='created_files') - created_at = models.DateTimeField(auto_now_add=True, verbose_name="创建时间") - - deleted_by = auto_prefetch.ForeignKey(User, on_delete=models.SET_NULL, verbose_name="删除文件的用户", blank=True, null=True, related_name='deleted_files') - deleted_at = models.DateTimeField(blank=True, null=True) - - def __str__(self) -> str: - return f"{self.name} ({self.media_name})" - - @staticmethod - def escape_media_name(name) -> str: - return name.replace(':', '%3A').replace('/', '%2F') - - @property - def media_url(self) -> str: - site = get_current_site() - return '//%s/%s/%s' % (site.media_domain, urllib.parse.quote(self.article.full_name), urllib.parse.quote(self.name)) - - @property - def local_media_path(self) -> str: - return Path(settings.MEDIA_ROOT) / 'media' / self.escape_media_name(self.article.media_name) / self.escape_media_name(self.media_name) - - @property - def local_media_destination(self): - return Path(self.escape_media_name(self.article.media_name)) / self.escape_media_name(self.media_name) \ No newline at end of file diff --git a/web/models/forum.py b/web/models/forum.py deleted file mode 100644 index a4c0c9d4..00000000 --- a/web/models/forum.py +++ /dev/null @@ -1,138 +0,0 @@ -__all__ = [ - 'ForumSection', - 'ForumCategory', - 'ForumThread', - 'ForumPost', - 'ForumPostVersion', - 'ForumPostLike' -] - -import auto_prefetch -from django.db import models -from django.db.models import Func, Value -from django.db.models.lookups import Exact -from django.contrib.auth import get_user_model - -from web.models.roles import PermissionsOverrideMixin -from .articles import Article - - -User = get_user_model() - - -class ForumSection(auto_prefetch.Model, PermissionsOverrideMixin): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '论坛分类' - verbose_name_plural = '论坛分类' - - name = models.TextField('名称') - description = models.TextField('描述', blank=True) - order = models.IntegerField('排序顺序', default=0, blank=True) - # 此设置对所有人隐藏，除非他们点击"显示隐藏" - is_hidden = models.BooleanField('隐藏分类', default=False) - # 此设置对版主和管理员显示，但对普通用户完全隐藏 - is_hidden_for_users = models.BooleanField('仅管理员可见', default=False) - - def __str__(self): - return self.name - - def override_perms(self, user_obj, perms: set, roles=[]): - if self.is_hidden_for_users and 'roles.view_forum_sections' in perms and 'roles.view_hidden_forum_sections' not in perms: - perms.remove('roles.view_forum_sections') - return super().override_perms(user_obj, perms, roles) - - -class ForumCategory(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '论坛版块' - verbose_name_plural = '论坛版块' - - name = models.TextField('名称') - description = models.TextField('描述', blank=True) - order = models.IntegerField('排序顺序', default=0, blank=True) - section = auto_prefetch.ForeignKey(ForumSection, on_delete=models.DO_NOTHING, verbose_name='分类') # 待办：后续审查 - is_for_comments = models.BooleanField('在此版块显示文章评论', default=False) - - def __str__(self): - return self.name - - -class ForumThread(auto_prefetch.Model, PermissionsOverrideMixin): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '论坛主题' - verbose_name_plural = '论坛主题' - - constraints = [ - # 逻辑：主题必须分配了'article'或'category' - # 需要postgres >9.2 - models.CheckConstraint( - name='%(app_label)s_%(class)s_category_or_article', - check=Exact( - lhs=Func('article_id', 'category_id', function='num_nonnulls', output_field=models.IntegerField()), - rhs=Value(1), - ), - ) - ] - - roles_override_pipeline = ['article'] - - name = models.TextField('标题') - description = models.TextField('描述', blank=True) - created_at = models.DateTimeField('创建时间', auto_now_add=True) - updated_at = models.DateTimeField('修改时间', auto_now_add=True) - category = auto_prefetch.ForeignKey(ForumCategory, on_delete=models.DO_NOTHING, null=True, verbose_name='版块（如果是主题）') # 待办：后续审查 - article = auto_prefetch.ForeignKey(Article, on_delete=models.CASCADE, null=True, verbose_name='文章（如果是评论）') - author = auto_prefetch.ForeignKey(User, on_delete=models.SET_NULL, null=True, verbose_name='作者') - is_pinned = models.BooleanField('置顶', default=False) - is_locked = models.BooleanField('已锁定', default=False) - - def override_perms(self, user_obj, perms: set, roles=[]): - if user_obj == self.author: - perms.add('roles.edit_forum_threads') - if not user_obj.is_anonymous and not user_obj.is_forum_active or self.is_locked and 'roles.lock_forum_threads' not in perms: - perms_to_revoke = {'roles.comment_articles', 'roles.create_forum_posts', 'roles.edit_forum_posts', 'roles.delete_forum_posts', 'roles.edit_forum_threads', 'roles.pin_forum_threads', 'roles.move_forum_threads'} - perms = perms.difference(perms_to_revoke) - return super().override_perms(user_obj, perms, roles) - - -class ForumPost(auto_prefetch.Model, PermissionsOverrideMixin): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '论坛帖子' - verbose_name_plural = '论坛帖子' - - perms_override_pipeline = ['thread'] - - name = models.TextField('标题', blank=True) - created_at = models.DateTimeField('创建时间', auto_now_add=True, ) - updated_at = models.DateTimeField('修改时间', auto_now_add=True) - author = auto_prefetch.ForeignKey(User, on_delete=models.SET_NULL, null=True, verbose_name='作者') - reply_to = auto_prefetch.ForeignKey('ForumPost', on_delete=models.SET_NULL, null=True, verbose_name='回复的评论') - thread = auto_prefetch.ForeignKey(ForumThread, on_delete=models.CASCADE, verbose_name='主题') - - def override_perms(self, user_obj, perms: set, roles=[]): - if user_obj == self.author and user_obj.has_perm('roles.create_forum_posts'): - perms.add('roles.edit_forum_posts') - return super().override_perms(user_obj, perms, roles) - - -class ForumPostVersion(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '论坛帖子版本' - verbose_name_plural = '论坛帖子版本' - - post = auto_prefetch.ForeignKey(ForumPost, on_delete=models.CASCADE, verbose_name='帖子') - source = models.TextField('帖子内容') - created_at = models.DateTimeField('创建时间', auto_now_add=True) - author = auto_prefetch.ForeignKey(User, on_delete=models.SET_NULL, null=True, verbose_name='编辑作者') - -class ForumPostLike(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '帖子点赞' - verbose_name_plural = '帖子点赞' - - constraints = [models.UniqueConstraint(fields=['post', 'user'], name='%(app_label)s_%(class)s_unique')] - indexes = [models.Index(fields=['post', 'created_at'])] - - post = auto_prefetch.ForeignKey(ForumPost, on_delete=models.CASCADE, verbose_name='帖子') - user = auto_prefetch.ForeignKey(User, on_delete=models.CASCADE, verbose_name='点赞者') - created_at = models.DateTimeField('点赞时间', auto_now_add=True) diff --git a/web/models/invites.py b/web/models/invites.py deleted file mode 100644 index e6368854..00000000 --- a/web/models/invites.py +++ /dev/null @@ -1,72 +0,0 @@ -__all__ = [ - 'InviteLink', -] - -import auto_prefetch - -from django.contrib.auth import get_user_model -from django.db import models - - -User = get_user_model() - - -class InviteLink(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '邀请链接' - verbose_name_plural = '邀请链接' - ordering = ['-created_at'] - indexes = [ - models.Index(fields=['kind', 'activated_at']), - models.Index(fields=['token']), - ] - - class Kind(models.TextChoices): - Register = ('register', '邀请注册') - Claim = ('claim', '认领') - - class Delivery(models.TextChoices): - Link = ('link', '手动发链接') - Email = ('email', '邮件发送') - - kind = models.TextField('类型', choices=Kind.choices, default=Kind.Register, null=False, blank=False) - delivery = models.TextField('发放方式', choices=Delivery.choices, default=Delivery.Link, null=False, blank=False) - - target = auto_prefetch.ForeignKey( - User, on_delete=models.SET_NULL, null=True, blank=True, - verbose_name='目标账号', related_name='invite_links', - ) - # 目标账号可能被删掉，而这一行还要说得清它当初是发给谁的。 - email = models.TextField('邮箱', blank=True) - wikidot_username = models.TextField('Wikidot 用户名', blank=True) - - token = models.TextField('令牌', null=False, blank=False) - uidb64 = models.TextField('账号编码', null=False, blank=False) - - created_at = models.DateTimeField('创建时间', auto_now_add=True, null=False, blank=False) - created_by = auto_prefetch.ForeignKey( - User, on_delete=models.SET_NULL, null=True, blank=True, - verbose_name='创建人', related_name='invite_links_created', - ) - - activated_at = models.DateTimeField('激活时间', null=True, blank=True) - activated_username = models.TextField('激活后用户名', blank=True) - - @property - def path(self): - return '/-/accept/%s/%s' % (self.uidb64, self.token) - - @property - def is_activated(self): - return self.activated_at is not None - - # 记的是身份用户名而不是 __str__ 的显示名，因为这一列的用处是回头去找那个账号。 - @classmethod - def mark_activated(cls, token, user, when): - cls.objects.filter(token=token, activated_at__isnull=True).update( - activated_at=when, - activated_username=user.username, - ) - - def __str__(self): - return '#%s %s → %s' % (self.pk, self.get_kind_display(), self.email or self.wikidot_username or self.target) diff --git a/web/models/logs.py b/web/models/logs.py deleted file mode 100644 index b71faca9..00000000 --- a/web/models/logs.py +++ /dev/null @@ -1,40 +0,0 @@ -__all__ = [ - 'ActionLogEntry' -] - -import auto_prefetch -from django.db import models -from django.contrib.auth import get_user_model - - -User = get_user_model() - - -class ActionLogEntry(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '操作记录' - verbose_name_plural = '操作记录' - - indexes = [ - models.Index( - fields=['user', 'origin_ip'], - name='user_origin_ip_idx' - ), - ] - - class ActionType(models.TextChoices): - Vote = ('vote', '评分') - NewArticle = ('create_article', '页面已创建') - EditArticle = ('edit_article', '页面已编辑') - RemoveArticle = ('remove_article', '页面已删除') - NewForumPost = ('add_forum_post', '新论坛帖子') - EditForumPost = ('edit_forum_post', '论坛帖子已修改') - RemoveForumPost = ('remove_forum_post', '论坛帖子已删除') - ChangeProfileInfo = ('change_profile_info', '个人资料信息已修改') - - user = auto_prefetch.ForeignKey(User, verbose_name='用户', on_delete=models.DO_NOTHING) - stale_username = models.TextField(verbose_name='操作时的用户名') - type = models.TextField(choices=ActionType.choices, verbose_name='类型') - meta = models.JSONField(default=dict, blank=True) - created_at = models.DateTimeField(auto_now_add=True, verbose_name='时间') - origin_ip = models.GenericIPAddressField(verbose_name='IP地址', blank=True, null=True) \ No newline at end of file diff --git a/web/models/messages.py b/web/models/messages.py deleted file mode 100644 index 849140be..00000000 --- a/web/models/messages.py +++ /dev/null @@ -1,49 +0,0 @@ -__all__ = [ - 'DirectMessage', - 'DirectMessageBlock', -] - -import auto_prefetch - -from django.contrib.auth import get_user_model -from django.db import models - - -User = get_user_model() - - -class DirectMessage(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '私信' - verbose_name_plural = '私信' - indexes = [ - models.Index(fields=['recipient', 'is_read']), - models.Index(fields=['sender', 'recipient', 'created_at']), - models.Index(fields=['recipient', 'sender', 'created_at']), - ] - - PREVIEW_MAX_SIZE = 150 - - sender = auto_prefetch.ForeignKey(User, on_delete=models.CASCADE, verbose_name='发送者', related_name='sent_direct_messages') - recipient = auto_prefetch.ForeignKey(User, on_delete=models.CASCADE, verbose_name='接收者', related_name='received_direct_messages') - body = models.TextField('内容', blank=False, null=False) - created_at = models.DateTimeField('发送时间', auto_now_add=True, blank=False, null=False) - is_read = models.BooleanField('已读', default=False, blank=False, null=False) - - def preview(self) -> str: - if len(self.body) <= self.PREVIEW_MAX_SIZE: - return self.body - return self.body[:self.PREVIEW_MAX_SIZE] + '…' - - -class DirectMessageBlock(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '私信拉黑' - verbose_name_plural = '私信拉黑' - constraints = [ - models.UniqueConstraint(fields=['blocker', 'blocked'], name='dm_block_uniqueness'), - ] - - blocker = auto_prefetch.ForeignKey(User, on_delete=models.CASCADE, verbose_name='拉黑者', related_name='dm_blocks_out') - blocked = auto_prefetch.ForeignKey(User, on_delete=models.CASCADE, verbose_name='被拉黑者', related_name='dm_blocks_in') - created_at = models.DateTimeField('创建时间', auto_now_add=True, blank=False, null=False) diff --git a/web/models/notifications.py b/web/models/notifications.py deleted file mode 100644 index 59bc89ad..00000000 --- a/web/models/notifications.py +++ /dev/null @@ -1,53 +0,0 @@ -__all__ = [ - 'UserNotification', - 'UserNotificationMapping', - 'UserNotificationSubscription' -] - -import auto_prefetch - -from django.db import models -from django.contrib.auth import get_user_model - -from web.models.articles import Article -from web.models.forum import ForumThread - - -User = get_user_model() - - -class UserNotification(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '通知' - verbose_name_plural = '通知' - - POST_REPLY_TTL = 100 - POST_PREVIEW_MAX_SIZE = 150 - - class NotificationType(models.TextChoices): - Welcome = ('welcome', '欢迎消息') - NewPostReply = ('new_post_reply', '帖子回复') - NewThreadPost = ('new_thread_post', '新帖子') - NewArticleRevision = ('new_article_revision', '文章编辑') - ForumMention = ('forum_mention', '论坛提及') - DirectMessage = ('direct_message', '私信') - - type = models.TextField('通知类型', choices=NotificationType.choices, blank=False, null=False) - meta = models.JSONField('元数据', default=dict, blank=True, null=False) - created_at = models.DateTimeField('发送日期', auto_now_add=True, blank=False, null=False) - - -class UserNotificationMapping(auto_prefetch.Model): - recipient = auto_prefetch.ForeignKey(User, on_delete=models.CASCADE, blank=False, null=False) - notification = auto_prefetch.ForeignKey(UserNotification, on_delete=models.CASCADE) - is_viewed = models.BooleanField(blank=False, null=False, default=False) - - -class UserNotificationSubscription(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '通知订阅' - verbose_name_plural = '通知订阅' - - subscriber = auto_prefetch.ForeignKey(User, on_delete=models.CASCADE, verbose_name='订阅者', blank=False, null=False) - article = auto_prefetch.ForeignKey(Article, on_delete=models.CASCADE, verbose_name='文章', blank=True, null=True) - forum_thread = auto_prefetch.ForeignKey(ForumThread, on_delete=models.CASCADE, verbose_name='论坛主题', blank=True, null=True) \ No newline at end of file diff --git a/web/models/reports.py b/web/models/reports.py deleted file mode 100644 index 0a88f84d..00000000 --- a/web/models/reports.py +++ /dev/null @@ -1,51 +0,0 @@ -__all__ = [ - 'UserReport', -] - -import auto_prefetch - -from django.contrib.auth import get_user_model -from django.db import models - - -User = get_user_model() - - -class UserReport(auto_prefetch.Model): - class Meta(auto_prefetch.Model.Meta): - verbose_name = '用户检举' - verbose_name_plural = '用户检举' - indexes = [ - models.Index(fields=['status', 'created_at']), - models.Index(fields=['reported', 'status']), - ] - - class ReportStatus(models.TextChoices): - Pending = ('pending', '待处理') - Reviewed = ('reviewed', '已处理') - Dismissed = ('dismissed', '已驳回') - - reporter = auto_prefetch.ForeignKey( - User, on_delete=models.SET_NULL, null=True, blank=True, - verbose_name='举报人', related_name='reports_submitted', - ) - reported = auto_prefetch.ForeignKey( - User, on_delete=models.SET_NULL, null=True, blank=True, - verbose_name='被举报人', related_name='reports_received', - ) - reason = models.TextField('举报理由', blank=False, null=False) - reported_messages = models.JSONField('举报的消息（快照）', default=list, blank=True) - status = models.TextField( - '状态', choices=ReportStatus.choices, default=ReportStatus.Pending, - blank=False, null=False, - ) - admin_notes = models.TextField('处理备注', blank=True) - created_at = models.DateTimeField('提交时间', auto_now_add=True, blank=False, null=False) - reviewed_at = models.DateTimeField('处理时间', null=True, blank=True) - reviewed_by = auto_prefetch.ForeignKey( - User, on_delete=models.SET_NULL, null=True, blank=True, - verbose_name='处理人', related_name='reports_reviewed', - ) - - def __str__(self): - return f'#{self.pk} {self.reporter or "(已删除)"}→{self.reported or "(已删除)"}' diff --git a/web/models/roles.py b/web/models/roles.py deleted file mode 100644 index a3936d53..00000000 --- a/web/models/roles.py +++ /dev/null @@ -1,406 +0,0 @@ -import auto_prefetch - -from functools import cached_property -from urllib.parse import quote -from typing import Optional - -from django.core.exceptions import ValidationError -from django.contrib.auth.models import Permission -from django.db import models -from django.contrib import admin - -import web.permissions.articles -import web.permissions.forum - -from web import fields -from web.util.pydantic import JSONInterface - - -__all__ = [ - 'RoleCategory', - 'Role', - 'RolePermissionsOverride', - 'RolesMixin', - 'PermissionsOverrideMixin', - 'RolePermissionsOverrideMixin', - 'ProtectSensitiveAdmin' -] - - -def svg_file_validator(file): - if not file.name.lower().endswith('.svg'): - raise ValidationError('只允许SVG格式的文件。') - try: - header = file.read(1024).decode('utf-8', errors='ignore') - file.seek(0) - except Exception: - raise ValidationError('无法读取文件。') - - if '
+
+ + +
-
页面版本: 0, 最后编辑: 1月5日, 2026年 09:07
+
页面版本: 0, 最后编辑: 1月5日, 2026年 09:07 (UTC+08:00)
@@ -1229,7 +1229,7 @@
-
页面版本: 3, 最后编辑: 3月1日, 2026年 00:30
+
页面版本: 3, 最后编辑: 3月1日, 2026年 00:30 (UTC+08:00)
diff --git a/internal/site/context.go b/internal/site/context.go index f5b279c9..1170bde6 100644 --- a/internal/site/context.go +++ b/internal/site/context.go @@ -2,8 +2,10 @@ package site import ( "context" + "time" "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/timezone" ) type contextKey struct{} @@ -18,3 +20,11 @@ func FromContext(ctx context.Context) *db.Site { s, _ := ctx.Value(contextKey{}).(*db.Site) return s } + +func Zone(ctx context.Context) *time.Location { + s := FromContext(ctx) + if s == nil { + return time.UTC + } + return timezone.Load(s.TimeZone) +} diff --git a/internal/site/site.go b/internal/site/site.go index a6f6091d..bbdeb5df 100644 --- a/internal/site/site.go +++ b/internal/site/site.go @@ -92,6 +92,30 @@ const maxHostName = 253 var hostLabel = regexp.MustCompile(`^[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?$`) +var unsignable = []string{ + "localhost", "localdomain", "local", "test", "example", "invalid", "internal", "lan", "home.arpa", + "example.com", "example.net", "example.org", +} + +func PublicHost(value string) bool { + if !ValidHost(value) || net.ParseIP(value) != nil { + return false + } + if _, _, err := net.SplitHostPort(value); err == nil { + return false + } + name := strings.ToLower(value) + if !strings.Contains(name, ".") { + return false + } + for _, suffix := range unsignable { + if name == suffix || strings.HasSuffix(name, "."+suffix) { + return false + } + } + return true +} + // A value no request can carry stores a site that nothing reaches and nothing // reports, so a scheme or a path is refused here rather than later. func ValidHost(value string) bool { diff --git a/internal/site/unresolved.go b/internal/site/unresolved.go index 9f99940f..c580b871 100644 --- a/internal/site/unresolved.go +++ b/internal/site/unresolved.go @@ -3,7 +3,6 @@ package site import ( "net/http" "strings" - "time" "github.com/WikitTeam/ProjectWikit/internal/i18n" "github.com/WikitTeam/ProjectWikit/internal/shell" @@ -12,10 +11,10 @@ import ( // A wildcard DNS record sends every subdomain to this server, so a mistyped one // has to land somewhere that says so. -func NewUnresolved(bundle *i18n.Bundle, assets *static.Assets, tz *time.Location) http.Handler { +func NewUnresolved(bundle *i18n.Bundle, assets *static.Assets) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { loc := bundle.For(r.Context()) - render := shell.New(loc, assets, tz) + render := shell.New(loc, assets) host := StripPort(r.Host) // The host is echoed and nothing else is. Listing the sites that do diff --git a/internal/site/validhost_test.go b/internal/site/validhost_test.go index c9f60019..326dbcba 100644 --- a/internal/site/validhost_test.go +++ b/internal/site/validhost_test.go @@ -2,6 +2,22 @@ package site import "testing" +func TestPublicHost(t *testing.T) { + for _, host := range []string{"wiki.scp-wiki.cn", "Wiki.Example.io", "a.b.c.dev"} { + if !PublicHost(host) { + t.Errorf("PublicHost(%q) = false, want true", host) + } + } + for _, host := range []string{ + "", "localhost", "localhost:8080", "wiki.localhost", "wiki", "192.0.2.7", "wiki.example.io:8443", + "media.test", "nas.local", "example.org", "wiki.example.com", "router.lan", "box.home.arpa", + } { + if PublicHost(host) { + t.Errorf("PublicHost(%q) = true, want false", host) + } + } +} + func TestValidHostAcceptsWhatARequestCarries(t *testing.T) { for _, host := range []string{ "localhost", diff --git a/internal/timezone/timezone.go b/internal/timezone/timezone.go new file mode 100644 index 00000000..a27ff7e3 --- /dev/null +++ b/internal/timezone/timezone.go @@ -0,0 +1,44 @@ +// Package timezone answers which zone a site's dates fall in on the server. +package timezone + +import ( + "sync" + "time" + + // Windows and scratch containers carry no zone database. + _ "time/tzdata" +) + +var loaded sync.Map + +func Load(name string) *time.Location { + if cached, ok := loaded.Load(name); ok { + return cached.(*time.Location) + } + if !Valid(name) { + return time.UTC + } + loc, err := time.LoadLocation(name) + if err != nil { + return time.UTC + } + loaded.Store(name, loc) + return loc +} + +// Local is the server machine's zone, which a site's zone must never depend on. +func Valid(name string) bool { + if name == "" || name == "Local" { + return false + } + _, err := time.LoadLocation(name) + return err == nil +} + +func Label(at time.Time) string { + _, offset := at.Zone() + if offset == 0 { + return "UTC" + } + return "UTC" + at.Format("-07:00") +} diff --git a/internal/timezone/timezone_test.go b/internal/timezone/timezone_test.go new file mode 100644 index 00000000..7a0bc246 --- /dev/null +++ b/internal/timezone/timezone_test.go @@ -0,0 +1,48 @@ +package timezone + +import ( + "testing" + "time" +) + +func TestLoadResolvesANamedZone(t *testing.T) { + if got := Load("Asia/Shanghai").String(); got != "Asia/Shanghai" { + t.Errorf("Load(%q) = %q, want %q", "Asia/Shanghai", got, "Asia/Shanghai") + } +} + +func TestLoadFallsBackToUTC(t *testing.T) { + for _, name := range []string{"", "Local", "Mars/Olympus", "../etc/passwd"} { + if got := Load(name); got != time.UTC { + t.Errorf("Load(%q) = %v, want UTC", name, got) + } + } +} + +func TestValid(t *testing.T) { + for _, name := range []string{"UTC", "Asia/Shanghai", "America/New_York", "Europe/Moscow"} { + if !Valid(name) { + t.Errorf("Valid(%q) = false, want true", name) + } + } + for _, name := range []string{"", "Local", "Beijing", "Mars/Olympus"} { + if Valid(name) { + t.Errorf("Valid(%q) = true, want false", name) + } + } +} + +func TestLabel(t *testing.T) { + at := time.Date(2026, 9, 11, 6, 30, 0, 0, time.UTC) + cases := map[string]string{ + "UTC": "UTC", + "Asia/Shanghai": "UTC+08:00", + "Asia/Kolkata": "UTC+05:30", + "America/New_York": "UTC-04:00", + } + for name, want := range cases { + if got := Label(at.In(Load(name))); got != want { + t.Errorf("Label(at in %s) = %q, want %q", name, got, want) + } + } +} diff --git a/internal/userpage/edit.go b/internal/userpage/edit.go index 0e66ecd8..54dfce6b 100644 --- a/internal/userpage/edit.go +++ b/internal/userpage/edit.go @@ -243,7 +243,7 @@ func (h *EditHandler) page(r *http.Request, loc *i18n.Localizer, current *db.Sit Saved: problem == "" && r.URL.Query().Get("saved") == "1", } - render := shell.New(loc, h.deps.Assets, h.deps.TimeZone) + render := shell.New(loc, h.deps.Assets) content, err := render.ProfileEdit(data) if err != nil { return "", err diff --git a/internal/userpage/reactivepage.go b/internal/userpage/reactivepage.go index dfece363..a192091c 100644 --- a/internal/userpage/reactivepage.go +++ b/internal/userpage/reactivepage.go @@ -107,7 +107,7 @@ func (h *ReactiveHandler) page(r *http.Request, current *db.Site, viewer *db.Use } var out strings.Builder - err = shell.New(loc, h.deps.Assets, h.deps.TimeZone).Reactive(&out, shell.Reactive{ThemeURL: theme, Config: config}) + err = shell.New(loc, h.deps.Assets).Reactive(&out, shell.Reactive{ThemeURL: theme, Config: config}) return out.String(), err } diff --git a/internal/userpage/userpage.go b/internal/userpage/userpage.go index 244d5035..06151990 100644 --- a/internal/userpage/userpage.go +++ b/internal/userpage/userpage.go @@ -35,14 +35,13 @@ const Prefix = "/-/users/" const userNotFoundBody = "User not found" type Deps struct { - DB *db.DB - Engine renderer.Renderer - Bundle *i18n.Bundle - Icons roles.IconLoader - Assets *static.Assets - TimeZone *time.Location - Files string - Log *slog.Logger + DB *db.DB + Engine renderer.Renderer + Bundle *i18n.Bundle + Icons roles.IconLoader + Assets *static.Assets + Files string + Log *slog.Logger } func (d Deps) logger() *slog.Logger { @@ -59,9 +58,6 @@ type Handler struct { var _ http.Handler = (*Handler)(nil) func New(d Deps) *Handler { - if d.TimeZone == nil { - d.TimeZone = time.UTC - } return &Handler{deps: d} } @@ -118,7 +114,7 @@ func (h *Handler) page(r *http.Request, name string) (string, error) { if err != nil { return "", err } - render := shell.New(loc, h.deps.Assets, h.deps.TimeZone) + render := shell.New(loc, h.deps.Assets) content, err := render.Profile(data) if err != nil { return "", err @@ -184,6 +180,7 @@ func (h *Handler) data(r *http.Request, loc *i18n.Localizer, current *db.Site, FullName: strings.TrimSpace(profile.FirstName + " " + profile.LastName), Bio: profile.Bio, JoinedAt: profile.DateJoined, + TimeZone: site.Zone(ctx), } titles, err := h.titles(ctx, loc, profile) From 92c3d36bc571b0a6dfc8bb5ced38a74669de5c22 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Fri, 11 Sep 2026 20:53:19 +0900 Subject: [PATCH 392/428] put the page info inside the page options as wikidot does --- .gitignore | 2 ++ frontend/entrypoints/page-options.tsx | 8 +++++++- frontend/index.tsx | 4 +++- internal/shell/templates/page.html | 5 +---- internal/shell/testdata/shell.golden | 23 +++-------------------- 5 files changed, 16 insertions(+), 26 deletions(-) diff --git a/.gitignore b/.gitignore index 440da67c..c1961afa 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,5 @@ files/* /secrets postgresql /internal/pgbundle/archive +/pwikit.toml +/logs diff --git a/frontend/entrypoints/page-options.tsx b/frontend/entrypoints/page-options.tsx index 64d9f4f5..867497df 100644 --- a/frontend/entrypoints/page-options.tsx +++ b/frontend/entrypoints/page-options.tsx @@ -49,6 +49,7 @@ interface Props { favourites?: number isFavourited?: boolean preferences?: { [key: string]: any } + pageInfo?: string } type SubViewType = @@ -114,6 +115,7 @@ const PageOptions: React.FC = ({ canWatch, isWatching, preferences, + pageInfo, }: Props) => { const [subView, setSubView] = useState(null) const [extOptions, setExtOptions] = useState(false) @@ -376,12 +378,16 @@ const PageOptions: React.FC = ({ ) } + // fix as wikidot + const info = pageInfo !== undefined ?
: null + if (!optionsEnabled) { - return null + return info } return ( <> + {info} {canWatch && (
{pageId === 'forum:thread' && ( diff --git a/frontend/index.tsx b/frontend/index.tsx index 0d5d2f75..4038c5af 100644 --- a/frontend/index.tsx +++ b/frontend/index.tsx @@ -48,7 +48,9 @@ window.addEventListener('DOMContentLoaded', () => { document.querySelectorAll('#create-new-page').forEach((node: HTMLElement) => renderTo(node, )) document .querySelectorAll('#page-options-container') - .forEach((node: HTMLElement) => renderTo(node, )) + .forEach((node: HTMLElement) => + renderTo(node, ), + ) document.querySelectorAll('#login-status').forEach((node: HTMLElement) => renderTo(node, )) document .querySelectorAll('.w-forum-new-thread') diff --git a/internal/shell/templates/page.html b/internal/shell/templates/page.html index e01b2ff5..539c009b 100644 --- a/internal/shell/templates/page.html +++ b/internal/shell/templates/page.html @@ -117,10 +117,7 @@

{{esc .SiteHeadline}}

- {{if not .UpdatedAt.IsZero}} -
{{.PageInfo}}
- {{end}} -
+
{{if not .UpdatedAt.IsZero}}
{{.PageInfo}}
{{end}}
diff --git a/internal/shell/testdata/shell.golden b/internal/shell/testdata/shell.golden index c6c39053..baee69c2 100644 --- a/internal/shell/testdata/shell.golden +++ b/internal/shell/testdata/shell.golden @@ -81,7 +81,6 @@
-
@@ -242,10 +241,7 @@
- -
页面版本: 12, 最后编辑: 8月25日, 2026年 14:03 (UTC+08:00)
- -
+
页面版本: 12, 最后编辑: 8月25日, 2026年 14:03 (UTC+08:00)
@@ -382,7 +378,6 @@
-
@@ -500,7 +495,6 @@
-
@@ -626,7 +620,6 @@
-
@@ -742,7 +735,6 @@
-
@@ -871,7 +863,6 @@
-
@@ -994,7 +985,6 @@
-
@@ -1110,10 +1100,7 @@
- -
页面版本: 0, 最后编辑: 1月5日, 2026年 09:07 (UTC+08:00)
- -
+
页面版本: 0, 最后编辑: 1月5日, 2026年 09:07 (UTC+08:00)
@@ -1228,10 +1215,7 @@
- -
页面版本: 3, 最后编辑: 3月1日, 2026年 00:30 (UTC+08:00)
- -
+
页面版本: 3, 最后编辑: 3月1日, 2026年 00:30 (UTC+08:00)
@@ -1355,7 +1339,6 @@
-
From 1611ba340895a58d84d57d86ff74bf3ff07ae7b1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 12 Sep 2026 00:22:23 +0900 Subject: [PATCH 393/428] keep admin writes on their own site --- internal/admin/adminlog.go | 1 + internal/admin/adminlog_write_test.go | 58 +++++++++ internal/admin/report.go | 2 +- internal/db/account_write.go | 12 ++ internal/db/report_admin.go | 4 +- internal/db/site_scope_write_test.go | 180 ++++++++++++++++++++++++++ internal/db/user_admin.go | 17 ++- 7 files changed, 265 insertions(+), 9 deletions(-) create mode 100644 internal/admin/adminlog_write_test.go create mode 100644 internal/db/site_scope_write_test.go diff --git a/internal/admin/adminlog.go b/internal/admin/adminlog.go index 087a940b..1411a087 100644 --- a/internal/admin/adminlog.go +++ b/internal/admin/adminlog.go @@ -25,6 +25,7 @@ func (h *Handler) note(r *http.Request, action, screen, target, label string) { Screen: screen, Target: target, Label: label, + SiteID: siteID(r.Context()), At: time.Now().UTC(), } if by := auth.FromContext(r.Context()); by != nil { diff --git a/internal/admin/adminlog_write_test.go b/internal/admin/adminlog_write_test.go new file mode 100644 index 00000000..86d771b6 --- /dev/null +++ b/internal/admin/adminlog_write_test.go @@ -0,0 +1,58 @@ +package admin + +import ( + "context" + "net/http/httptest" + "os" + "slices" + "strconv" + "testing" + "time" + + "github.com/jackc/pgx/v5" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/site" +) + +func TestNoteRecordsTheSiteOfTheRequest(t *testing.T) { + dsn := os.Getenv(db.EnvWriteDSN) + if dsn == "" { + t.Skipf("%s not set, skipping the write test", db.EnvWriteDSN) + } + ctx := context.Background() + conn, err := db.Open(ctx, dsn) + if err != nil { + t.Fatalf("db.Open() err = %v, want nil", err) + } + t.Cleanup(conn.Close) + current, err := conn.SiteByHosts(ctx, []string{"localhost"}) + if err != nil { + t.Fatalf("SiteByHosts(localhost) err = %v, want nil", err) + } + + screen := "probe-" + strconv.FormatInt(time.Now().UnixNano(), 36) + t.Cleanup(func() { + raw, err := pgx.Connect(context.Background(), dsn) + if err != nil { + t.Errorf("pgx.Connect() err = %v, want nil", err) + return + } + defer raw.Close(context.Background()) + if _, err := raw.Exec(context.Background(), `DELETE FROM pwikit_admin_log WHERE screen = $1`, screen); err != nil { + t.Errorf("clean up admin log err = %v, want nil", err) + } + }) + + h := &Handler{deps: Deps{DB: conn}} + r := httptest.NewRequest("POST", "/-/admin/", nil).WithContext(site.WithSite(ctx, current)) + h.note(r, db.AdminChanged, screen, "", "probe") + + screens, err := conn.AdminNoteScreens(ctx, current.ID) + if err != nil { + t.Fatalf("AdminNoteScreens() err = %v, want nil", err) + } + if !slices.Contains(screens, screen) { + t.Errorf("AdminNoteScreens(%d) = %v, want it to contain %q", current.ID, screens, screen) + } +} diff --git a/internal/admin/report.go b/internal/admin/report.go index e9cd3d24..1287c739 100644 --- a/internal/admin/report.go +++ b/internal/admin/report.go @@ -120,7 +120,7 @@ func (h *Handler) saveReport(w http.ResponseWriter, r *http.Request, loc *i18n.L http.Error(w, http.StatusText(http.StatusForbidden), http.StatusForbidden) return nil } - err = h.deps.DB.ReviewReport(ctx, id, status, r.PostFormValue("admin_notes"), mine.ID, time.Now()) + err = h.deps.DB.ReviewReport(ctx, siteID(ctx), id, status, r.PostFormValue("admin_notes"), mine.ID, time.Now()) if err != nil { return err } diff --git a/internal/db/account_write.go b/internal/db/account_write.go index a01900eb..fe47cea4 100644 --- a/internal/db/account_write.go +++ b/internal/db/account_write.go @@ -116,6 +116,18 @@ func (d *DB) UserByEmail(ctx context.Context, email string) (*User, error) { return d.scanUser(ctx, qUserByEmail, email) } +// Only a verified address is trusted with a way into the account. +var qUserByVerifiedEmail = register("UserByVerifiedEmail", ` +SELECT `+userColumns+` +FROM web_user +WHERE lower(email) = lower($1) AND email <> '' AND email_verified_at IS NOT NULL +ORDER BY id +LIMIT 1`) + +func (d *DB) UserByVerifiedEmail(ctx context.Context, email string) (*User, error) { + return d.scanUser(ctx, qUserByVerifiedEmail, email) +} + var qSetEmail = register("SetEmail", `UPDATE web_user SET email = $2 WHERE id = $1`) func (d *DB) SetEmail(ctx context.Context, id int64, email string) error { diff --git a/internal/db/report_admin.go b/internal/db/report_admin.go index 68a5a39b..5fdc4569 100644 --- a/internal/db/report_admin.go +++ b/internal/db/report_admin.go @@ -91,13 +91,13 @@ var qReviewReport = register("ReviewReport", ` UPDATE web_userreport SET status = $2, admin_notes = $3, reviewed_at = $4, reviewed_by_id = $5 WHERE id = $1 AND site_id = $6`) -func (d *DB) ReviewReport(ctx context.Context, id int64, status, notes string, by int64, at time.Time) error { +func (d *DB) ReviewReport(ctx context.Context, siteID, id int64, status, notes string, by int64, at time.Time) error { var reviewedAt *time.Time var reviewer *int64 if status != ReportPending { reviewedAt, reviewer = &at, &by } - if _, err := d.pool.Exec(ctx, qReviewReport, id, status, notes, reviewedAt, reviewer); err != nil { + if _, err := d.pool.Exec(ctx, qReviewReport, id, status, notes, reviewedAt, reviewer, siteID); err != nil { return fmt.Errorf("review report %d: %w", id, err) } return nil diff --git a/internal/db/site_scope_write_test.go b/internal/db/site_scope_write_test.go new file mode 100644 index 00000000..1519d094 --- /dev/null +++ b/internal/db/site_scope_write_test.go @@ -0,0 +1,180 @@ +package db + +import ( + "context" + "errors" + "strconv" + "testing" + "time" +) + +func scratchSite(t *testing.T, d *DB) int64 { + t.Helper() + ctx := context.Background() + stamp := strconv.FormatInt(time.Now().UnixNano(), 36) + id, err := d.CreateSite(ctx, NewSite{ + Slug: "probe-" + stamp, Title: "Probe", Headline: "Probe", + Domain: "probe-" + stamp + ".test", MediaDomain: "probe-" + stamp + ".test", + }) + if err != nil { + t.Fatalf("CreateSite() err = %v, want nil", err) + } + t.Cleanup(func() { + ctx := context.Background() + for _, sql := range []string{ + `DELETE FROM web_user_roles WHERE role_id IN (SELECT id FROM web_role WHERE site_id = $1)`, + `DELETE FROM web_role_permissions WHERE role_id IN (SELECT id FROM web_role WHERE site_id = $1)`, + `DELETE FROM web_role WHERE site_id = $1`, + `DELETE FROM web_settings WHERE site_id = $1`, + `DELETE FROM pwikit_admin_log WHERE site_id = $1`, + `DELETE FROM web_userreport WHERE site_id = $1`, + `DELETE FROM web_site WHERE id = $1`, + } { + if _, err := d.pool.Exec(ctx, sql, id); err != nil { + t.Errorf("clean up site %d err = %v, want nil", id, err) + } + } + }) + return id +} + +func scratchRole(t *testing.T, d *DB, siteID int64) int64 { + t.Helper() + var id int64 + slug := "probe-role-" + strconv.FormatInt(time.Now().UnixNano(), 36) + if err := d.pool.QueryRow(context.Background(), qInsertBuiltInRole, siteID, slug, 99).Scan(&id); err != nil { + t.Fatalf("insert role err = %v, want nil", err) + } + return id +} + +func heldRoles(t *testing.T, d *DB, userID int64) map[int64]bool { + t.Helper() + rows, err := d.pool.Query(context.Background(), `SELECT role_id FROM web_user_roles WHERE user_id = $1`, userID) + if err != nil { + t.Fatalf("read roles err = %v, want nil", err) + } + defer rows.Close() + held := map[int64]bool{} + for rows.Next() { + var id int64 + if err := rows.Scan(&id); err != nil { + t.Fatal(err) + } + held[id] = true + } + return held +} + +func TestSaveAdminUserLeavesRolesOnOtherSites(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + here, there := scratchSite(t, d), scratchSite(t, d) + roleHere, roleThere := scratchRole(t, d, here), scratchRole(t, d, there) + + userID, err := d.CreateUser(ctx, scratchName(t), "Probe Roles", "!", true, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateUser() err = %v, want nil", err) + } + dropUser(t, d, userID) + for site, role := range map[int64]int64{here: roleHere, there: roleThere} { + if err := d.GrantRole(ctx, site, userID, role); err != nil { + t.Fatalf("GrantRole(%d) err = %v, want nil", role, err) + } + } + + row, err := d.AdminUser(ctx, here, userID) + if err != nil { + t.Fatalf("AdminUser() err = %v, want nil", err) + } + if len(row.Roles) != 1 || row.Roles[0] != roleHere { + t.Errorf("AdminUser(here).Roles = %v, want [%d]", row.Roles, roleHere) + } + + row.Roles = nil + if err := d.SaveAdminUser(ctx, here, row, []string{"registered", "everyone"}, true, false); err != nil { + t.Fatalf("SaveAdminUser() err = %v, want nil", err) + } + held := heldRoles(t, d, userID) + if held[roleHere] { + t.Errorf("role %d on this site after clearing = held, want removed", roleHere) + } + if !held[roleThere] { + t.Errorf("role %d on the other site after clearing here = removed, want held", roleThere) + } +} + +func TestReviewReportStoresTheDecision(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + site := scratchSite(t, d) + var id int64 + err := d.pool.QueryRow(ctx, ` +INSERT INTO web_userreport (reason, reported_messages, status, admin_notes, created_at, site_id) +VALUES ('probe', '[]', $1, '', now(), $2) RETURNING id`, ReportPending, site).Scan(&id) + if err != nil { + t.Fatalf("insert report err = %v, want nil", err) + } + + userID, err := d.CreateUser(ctx, scratchName(t), "Probe Reviewer", "!", true, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateUser() err = %v, want nil", err) + } + dropUser(t, d, userID) + t.Cleanup(func() { + d.pool.Exec(context.Background(), `DELETE FROM web_userreport WHERE id = $1`, id) + }) + + if err := d.ReviewReport(ctx, site, id, ReportReviewed, "handled", userID, time.Now().UTC()); err != nil { + t.Fatalf("ReviewReport() err = %v, want nil", err) + } + got, err := d.AdminReport(ctx, site, id) + if err != nil { + t.Fatalf("AdminReport() err = %v, want nil", err) + } + if got.Status != ReportReviewed { + t.Errorf("AdminReport().Status = %q, want %q", got.Status, ReportReviewed) + } + if got.AdminNotes != "handled" { + t.Errorf("AdminReport().AdminNotes = %q, want %q", got.AdminNotes, "handled") + } +} + +func TestUserByVerifiedEmailSkipsAnUnverifiedAddress(t *testing.T) { + d := writeTestDB(t) + ctx := context.Background() + email := scratchName(t) + "@example.invalid" + + typo, err := d.CreateUser(ctx, scratchName(t)+"-a", "Probe Typo", "!", true, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateUser() err = %v, want nil", err) + } + dropUser(t, d, typo) + if err := d.SetEmail(ctx, typo, email); err != nil { + t.Fatalf("SetEmail() err = %v, want nil", err) + } + + if _, err := d.UserByVerifiedEmail(ctx, email); !errors.Is(err, ErrNotFound) { + t.Errorf("UserByVerifiedEmail() with only an unverified holder err = %v, want ErrNotFound", err) + } + + owner, err := d.CreateUser(ctx, scratchName(t)+"-b", "Probe Owner", "!", true, time.Now().UTC()) + if err != nil { + t.Fatalf("CreateUser() err = %v, want nil", err) + } + dropUser(t, d, owner) + if err := d.SetEmail(ctx, owner, email); err != nil { + t.Fatalf("SetEmail() err = %v, want nil", err) + } + if ok, err := d.MarkEmailVerified(ctx, owner, email, time.Now().UTC()); err != nil || !ok { + t.Fatalf("MarkEmailVerified() = %t, %v, want true, nil", ok, err) + } + + got, err := d.UserByVerifiedEmail(ctx, email) + if err != nil { + t.Fatalf("UserByVerifiedEmail() err = %v, want nil", err) + } + if got.ID != owner { + t.Errorf("UserByVerifiedEmail().ID = %d, want %d", got.ID, owner) + } +} diff --git a/internal/db/user_admin.go b/internal/db/user_admin.go index 1ec8f679..4c4436f2 100644 --- a/internal/db/user_admin.go +++ b/internal/db/user_admin.go @@ -80,7 +80,10 @@ func (d *DB) AdminUsers(ctx context.Context, query, kind string, limit, offset i var qAdminUser = register("AdminUser", `SELECT `+adminUserColumns+` FROM web_user WHERE id = $1`) -var qAdminUserRoles = register("AdminUserRoles", `SELECT role_id FROM web_user_roles WHERE user_id = $1`) +var qAdminUserRoles = register("AdminUserRoles", ` +SELECT ur.role_id FROM web_user_roles ur +JOIN web_role r ON r.id = ur.role_id +WHERE ur.user_id = $1 AND r.site_id = $2`) func (d *DB) AdminUser(ctx context.Context, siteID, id int64) (AdminUserRow, error) { var u AdminUserRow @@ -92,7 +95,7 @@ func (d *DB) AdminUser(ctx context.Context, siteID, id int64) (AdminUserRow, err return AdminUserRow{}, fmt.Errorf("read user %d: %w", id, err) } - rows, err := d.pool.Query(ctx, qAdminUserRoles, id) + rows, err := d.pool.Query(ctx, qAdminUserRoles, id, siteID) if err != nil { return AdminUserRow{}, fmt.Errorf("read the roles of user %d: %w", id, err) } @@ -119,8 +122,10 @@ UPDATE web_user SET username=$2, wikidot_username=$3, display_name=$4, email=$5, WHERE id=$1`) qSetSuperuser = register("SetSuperuser", `UPDATE web_user SET is_superuser = $2 WHERE id = $1`) - qClearUserRole = register("ClearUserRoles", `DELETE FROM web_user_roles WHERE user_id = $1`) - qAddUserRole = register("AddUserRoles", ` + qClearUserRole = register("ClearUserRoles", ` +DELETE FROM web_user_roles ur USING web_role r +WHERE ur.role_id = r.id AND ur.user_id = $1 AND r.site_id = $2`) + qAddUserRole = register("AddUserRoles", ` INSERT INTO web_user_roles (user_id, role_id) SELECT $1, r.id FROM web_role r WHERE r.id = ANY($2) AND r.slug <> ALL($3) AND r.site_id = $4`) ) @@ -133,7 +138,7 @@ func (d *DB) SaveAdminUser(ctx context.Context, siteID int64, u AdminUserRow, bu defer tx.Rollback(context.WithoutCancel(ctx)) _, err = tx.Exec(ctx, qUpdateAdminUser, u.ID, u.Username, nullable(u.WikidotUsername), - nullable(u.DisplayName), nullable(u.Email), u.Bio, u.IsActive, u.InactiveUntil, + nullable(u.DisplayName), u.Email, u.Bio, u.IsActive, u.InactiveUntil, u.IsForumActive, u.ForumInactiveUntil, u.CanSendDM) if err != nil { return fmt.Errorf("save user %d: %w", u.ID, err) @@ -144,7 +149,7 @@ func (d *DB) SaveAdminUser(ctx context.Context, siteID int64, u AdminUserRow, bu } } if withRoles { - if _, err := tx.Exec(ctx, qClearUserRole, u.ID); err != nil { + if _, err := tx.Exec(ctx, qClearUserRole, u.ID, siteID); err != nil { return err } if len(u.Roles) > 0 { From 8b2ad61620a8ba52638b60dc08503c1143d17dfb Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 12 Sep 2026 00:22:23 +0900 Subject: [PATCH 394/428] send resets to verified addresses with links in the visitor's scheme --- cmd/pwikit/articles.go | 2 +- internal/account/email.go | 4 +- internal/account/login.go | 4 +- internal/account/notices.go | 66 +++++++++++++----------- internal/account/notices_test.go | 42 +++++++++++++++ internal/account/reset.go | 12 +---- internal/account/settings.go | 8 +-- internal/account/signup.go | 4 +- internal/admin/admin.go | 2 + internal/admin/useractions.go | 9 +--- internal/proxyheader/proxyheader.go | 3 ++ internal/proxyheader/proxyheader_test.go | 12 +++++ internal/webapi/invite.go | 9 +--- 13 files changed, 109 insertions(+), 68 deletions(-) create mode 100644 internal/account/notices_test.go diff --git a/cmd/pwikit/articles.go b/cmd/pwikit/articles.go index 90e7a4e3..c42537e3 100644 --- a/cmd/pwikit/articles.go +++ b/cmd/pwikit/articles.go @@ -149,7 +149,7 @@ func newPageStack(conn *db.DB, p *paths.Paths, assets fs.FS, next http.Handler, adminPages, err := admin.New(admin.Deps{ DB: conn, Bundle: bundle, Assets: static.NewAssets(assets), Files: p.Files(), Tokens: token.Generator{Secret: secret}, Articles: stack.articleAPI, - Mail: mail.New(mailConfig(cfg.Mail)), Log: log, + Mail: mail.New(mailConfig(cfg.Mail)), Trust: trust, Log: log, }, next) if err != nil { return nil, err diff --git a/internal/account/email.go b/internal/account/email.go index 29f37469..e823c9aa 100644 --- a/internal/account/email.go +++ b/internal/account/email.go @@ -132,7 +132,7 @@ func (h *EmailHandler) act(r *http.Request, purpose, uid, secret string) (string if state.Pending == "" || !h.deps.Tokens.Check(secret, token.Custom(purposeApprove, id(user.ID), lower(state.Pending)), now) { return "dead", nil } - return "approved", h.deps.sendActivation(ctx, h.loc(ctx), user, state.Pending) + return "approved", h.deps.sendActivation(r, h.loc(ctx), user, state.Pending) case purposeActivate: if state.Pending == "" || !h.deps.Tokens.Check(secret, token.Custom(purposeActivate, id(user.ID), lower(state.Pending)), now) { @@ -151,7 +151,7 @@ func (h *EmailHandler) act(r *http.Request, purpose, uid, secret string) (string return "dead", err } if state.VerifiedAt != nil { - if err := h.deps.warnPrevious(ctx, h.loc(ctx), user, state.Email, pending); err != nil { + if err := h.deps.warnPrevious(r, h.loc(ctx), user, state.Email, pending); err != nil { return "", err } } diff --git a/internal/account/login.go b/internal/account/login.go index d2768bea..7200e840 100644 --- a/internal/account/login.go +++ b/internal/account/login.go @@ -176,7 +176,7 @@ func (d Deps) signIn(ctx context.Context, w http.ResponseWriter, r *http.Request http.SetCookie(w, &http.Cookie{ Name: session.CookieName, Value: key, Path: "/", Expires: now.Add(session.CookieAge), MaxAge: int(session.CookieAge / time.Second), - HttpOnly: true, Secure: r.TLS != nil, SameSite: http.SameSiteLaxMode, + HttpOnly: true, Secure: d.Trust.Scheme(r) == "https", SameSite: http.SameSiteLaxMode, }) return nil } @@ -203,7 +203,7 @@ func (h *LogoutHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { } http.SetCookie(w, &http.Cookie{ Name: session.CookieName, Value: "", Path: "/", MaxAge: -1, - HttpOnly: true, Secure: r.TLS != nil, SameSite: http.SameSiteLaxMode, + HttpOnly: true, Secure: h.deps.Trust.Scheme(r) == "https", SameSite: http.SameSiteLaxMode, }) redirect(w, destination(r), http.StatusFound) } diff --git a/internal/account/notices.go b/internal/account/notices.go index 1b83f9b7..d4f09850 100644 --- a/internal/account/notices.go +++ b/internal/account/notices.go @@ -5,6 +5,7 @@ import ( "crypto/rand" "encoding/base64" "encoding/hex" + "net/http" "strings" "time" @@ -14,16 +15,19 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/token" ) -func (d Deps) link(ctx context.Context, purpose string, userID int64, value token.Value) string { - current := site.FromContext(ctx) +func (d Deps) link(r *http.Request, purpose string, userID int64, value token.Value) string { host := "" - if current != nil { - host = "https://" + current.Domain + if current := site.FromContext(r.Context()); current != nil { + host = d.origin(r, current) } uid := base64.RawURLEncoding.EncodeToString([]byte(id(userID))) return host + EmailPrefix + purpose + "/" + uid + "/" + d.Tokens.Make(value, time.Now()) } +func (d Deps) origin(r *http.Request, current *db.Site) string { + return d.Trust.Scheme(r) + "://" + current.Domain +} + func (d Deps) siteTitle(ctx context.Context) string { if current := site.FromContext(ctx); current != nil { return current.Title @@ -31,49 +35,49 @@ func (d Deps) siteTitle(ctx context.Context) string { return "" } -func (d Deps) sendVerification(ctx context.Context, loc *i18n.Localizer, user *db.User, state db.AccountEmail) error { +func (d Deps) sendVerification(r *http.Request, loc *i18n.Localizer, user *db.User, state db.AccountEmail) error { if state.Email == "" { return nil } - url := d.link(ctx, purposeVerify, user.ID, verifyValue(user.ID, state)) - return d.Mail.Send(ctx, []string{state.Email}, - loc.T("email.verify-subject", "site", d.siteTitle(ctx)), - loc.T("email.verify-body", "name", user.DisplayLabel(), "link", url, "site", d.siteTitle(ctx))) + url := d.link(r, purposeVerify, user.ID, verifyValue(user.ID, state)) + return d.Mail.Send(r.Context(), []string{state.Email}, + loc.T("email.verify-subject", "site", d.siteTitle(r.Context())), + loc.T("email.verify-body", "name", user.DisplayLabel(), "link", url, "site", d.siteTitle(r.Context()))) } -func (d Deps) sendApproval(ctx context.Context, loc *i18n.Localizer, user *db.User, to, pending string) error { - url := d.link(ctx, purposeApprove, user.ID, token.Custom(purposeApprove, id(user.ID), lower(pending))) - return d.Mail.Send(ctx, []string{to}, - loc.T("email.approve-subject", "site", d.siteTitle(ctx)), - loc.T("email.approve-body", "name", user.DisplayLabel(), "email", pending, "link", url, "site", d.siteTitle(ctx))) +func (d Deps) sendApproval(r *http.Request, loc *i18n.Localizer, user *db.User, to, pending string) error { + url := d.link(r, purposeApprove, user.ID, token.Custom(purposeApprove, id(user.ID), lower(pending))) + return d.Mail.Send(r.Context(), []string{to}, + loc.T("email.approve-subject", "site", d.siteTitle(r.Context())), + loc.T("email.approve-body", "name", user.DisplayLabel(), "email", pending, "link", url, "site", d.siteTitle(r.Context()))) } -func (d Deps) sendActivation(ctx context.Context, loc *i18n.Localizer, user *db.User, pending string) error { - url := d.link(ctx, purposeActivate, user.ID, token.Custom(purposeActivate, id(user.ID), lower(pending))) - return d.Mail.Send(ctx, []string{pending}, - loc.T("email.activate-subject", "site", d.siteTitle(ctx)), - loc.T("email.activate-body", "name", user.DisplayLabel(), "link", url, "site", d.siteTitle(ctx))) +func (d Deps) sendActivation(r *http.Request, loc *i18n.Localizer, user *db.User, pending string) error { + url := d.link(r, purposeActivate, user.ID, token.Custom(purposeActivate, id(user.ID), lower(pending))) + return d.Mail.Send(r.Context(), []string{pending}, + loc.T("email.activate-subject", "site", d.siteTitle(r.Context())), + loc.T("email.activate-body", "name", user.DisplayLabel(), "link", url, "site", d.siteTitle(r.Context()))) } -func (d Deps) warnPrevious(ctx context.Context, loc *i18n.Localizer, user *db.User, previous, now string) error { - url := d.link(ctx, purposeRevert, user.ID, token.Custom(purposeRevert, id(user.ID), lower(now), lower(previous))) - return d.Mail.Send(ctx, []string{previous}, - loc.T("email.moved-subject", "site", d.siteTitle(ctx)), - loc.T("email.moved-body", "name", user.DisplayLabel(), "email", masked(now), "link", url, "site", d.siteTitle(ctx))) +func (d Deps) warnPrevious(r *http.Request, loc *i18n.Localizer, user *db.User, previous, now string) error { + url := d.link(r, purposeRevert, user.ID, token.Custom(purposeRevert, id(user.ID), lower(now), lower(previous))) + return d.Mail.Send(r.Context(), []string{previous}, + loc.T("email.moved-subject", "site", d.siteTitle(r.Context())), + loc.T("email.moved-body", "name", user.DisplayLabel(), "email", masked(now), "link", url, "site", d.siteTitle(r.Context()))) } -func (d Deps) warnPasswordChanged(ctx context.Context, loc *i18n.Localizer, user *db.User, to string) error { +func (d Deps) warnPasswordChanged(r *http.Request, loc *i18n.Localizer, user *db.User, to string) error { if to == "" { return nil } - return d.Mail.Send(ctx, []string{to}, - loc.T("email.password-subject", "site", d.siteTitle(ctx)), - loc.T("email.password-body", "name", user.DisplayLabel(), "site", d.siteTitle(ctx), "link", "https://"+d.host(ctx)+ResetPath)) + return d.Mail.Send(r.Context(), []string{to}, + loc.T("email.password-subject", "site", d.siteTitle(r.Context())), + loc.T("email.password-body", "name", user.DisplayLabel(), "site", d.siteTitle(r.Context()), "link", d.home(r)+ResetPath)) } -func (d Deps) host(ctx context.Context) string { - if current := site.FromContext(ctx); current != nil { - return current.Domain +func (d Deps) home(r *http.Request) string { + if current := site.FromContext(r.Context()); current != nil { + return d.origin(r, current) } return "" } diff --git a/internal/account/notices_test.go b/internal/account/notices_test.go new file mode 100644 index 00000000..e076dd40 --- /dev/null +++ b/internal/account/notices_test.go @@ -0,0 +1,42 @@ +package account + +import ( + "net/http/httptest" + "strings" + "testing" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" + "github.com/WikitTeam/ProjectWikit/internal/site" + "github.com/WikitTeam/ProjectWikit/internal/token" +) + +func TestLinkUsesTheSchemeTheProxyReports(t *testing.T) { + trust, err := proxyheader.NewTrust([]string{"127.0.0.1"}) + if err != nil { + t.Fatal(err) + } + tests := []struct { + name string + trust *proxyheader.Trust + proto string + want string + }{ + {"trusted proxy terminating tls", trust, "https", "https://wiki.example" + EmailPrefix}, + {"trusted proxy over plain http", trust, "http", "http://wiki.example" + EmailPrefix}, + {"no proxy configured", nil, "https", "http://wiki.example" + EmailPrefix}, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + r := httptest.NewRequest("POST", "/-/profile", nil) + r.RemoteAddr = "127.0.0.1:5000" + r.Header.Set("X-Forwarded-Proto", tt.proto) + r = r.WithContext(site.WithSite(r.Context(), &db.Site{Domain: "wiki.example"})) + d := Deps{Trust: tt.trust, Tokens: token.Generator{Secret: "probe"}} + got := d.link(r, purposeVerify, 7, token.Custom(purposeVerify, "7")) + if !strings.HasPrefix(got, tt.want) { + t.Errorf("link() = %q, want prefix %q", got, tt.want) + } + }) + } +} diff --git a/internal/account/reset.go b/internal/account/reset.go index 22e5853c..e2be79d8 100644 --- a/internal/account/reset.go +++ b/internal/account/reset.go @@ -173,7 +173,7 @@ func (h *ResetHandler) request(r *http.Request, loc *i18n.Localizer, current *db if email == "" { return nil } - user, err := h.deps.DB.UserByEmail(ctx, email) + user, err := h.deps.DB.UserByVerifiedEmail(ctx, email) if errors.Is(err, db.ErrNotFound) { return nil } @@ -189,7 +189,7 @@ func (h *ResetHandler) request(r *http.Request, loc *i18n.Localizer, current *db } minted := h.deps.Tokens.Make(value, time.Now()) uid := base64.RawURLEncoding.EncodeToString([]byte(strconv.FormatInt(user.ID, 10))) - home := siteURL(r, current) + home := h.deps.origin(r, current) link := home + ResetConfirmPath + uid + "/" + minted subject := loc.T("reset.mail-subject", "site", current.Title) @@ -274,11 +274,3 @@ func (h *ResetHandler) resetValue(ctx context.Context, user *db.User) (token.Val } return token.ResetValue(user.ID, hash, last, email), nil } - -func siteURL(r *http.Request, current *db.Site) string { - scheme := "http" - if r.TLS != nil { - scheme = "https" - } - return scheme + "://" + current.Domain -} diff --git a/internal/account/settings.go b/internal/account/settings.go index fcd1ebd2..bd9dc15d 100644 --- a/internal/account/settings.go +++ b/internal/account/settings.go @@ -113,7 +113,7 @@ func (h *SettingsHandler) email(r *http.Request, loc *i18n.Localizer, user *db.U if state.VerifiedAt != nil { return "email-same", nil } - return "email-verified-sent", h.deps.sendVerification(ctx, loc, user, state) + return "email-verified-sent", h.deps.sendVerification(r, loc, user, state) } taken, err := h.deps.DB.VerifiedEmailTaken(ctx, wanted, user.ID) @@ -135,9 +135,9 @@ func (h *SettingsHandler) email(r *http.Request, loc *i18n.Localizer, user *db.U return "", err } if proven { - return "email-sent", h.deps.sendActivation(ctx, loc, user, wanted) + return "email-sent", h.deps.sendActivation(r, loc, user, wanted) } - return "email-approval-sent", h.deps.sendApproval(ctx, loc, user, state.Email, wanted) + return "email-approval-sent", h.deps.sendApproval(r, loc, user, state.Email, wanted) } func (h *SettingsHandler) password(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, user *db.User) (string, error) { @@ -177,7 +177,7 @@ func (h *SettingsHandler) password(w http.ResponseWriter, r *http.Request, loc * if state.VerifiedAt == nil { return "password-changed", nil } - return "password-changed", h.deps.warnPasswordChanged(ctx, loc, user, state.Email) + return "password-changed", h.deps.warnPasswordChanged(r, loc, user, state.Email) } func (h *SettingsHandler) name(r *http.Request, user *db.User) (string, error) { diff --git a/internal/account/signup.go b/internal/account/signup.go index 50d622e3..d589442b 100644 --- a/internal/account/signup.go +++ b/internal/account/signup.go @@ -205,7 +205,7 @@ func (h *SignupHandler) register(w http.ResponseWriter, r *http.Request, loc *i1 if err != nil { return false, err } - if err := h.deps.sendVerification(ctx, loc, user, db.AccountEmail{Email: form.Email}); err != nil { + if err := h.deps.sendVerification(r, loc, user, db.AccountEmail{Email: form.Email}); err != nil { return false, err } if current.EmailPolicy == db.EmailAtSignup { @@ -250,7 +250,7 @@ func (h *SignupHandler) claim(w http.ResponseWriter, r *http.Request, loc *i18n. if err != nil { return false, err } - if err := h.deps.sendVerification(ctx, loc, user, db.AccountEmail{Email: form.Email}); err != nil { + if err := h.deps.sendVerification(r, loc, user, db.AccountEmail{Email: form.Email}); err != nil { return false, err } if current.EmailPolicy == db.EmailAtSignup { diff --git a/internal/admin/admin.go b/internal/admin/admin.go index bf4cd6bc..76b8924e 100644 --- a/internal/admin/admin.go +++ b/internal/admin/admin.go @@ -21,6 +21,7 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/mail" "github.com/WikitTeam/ProjectWikit/internal/pageconfig" "github.com/WikitTeam/ProjectWikit/internal/perms" + "github.com/WikitTeam/ProjectWikit/internal/proxyheader" "github.com/WikitTeam/ProjectWikit/internal/repo" "github.com/WikitTeam/ProjectWikit/internal/shell" "github.com/WikitTeam/ProjectWikit/internal/site" @@ -45,6 +46,7 @@ type Deps struct { Articles http.Handler Mail mail.Sender + Trust *proxyheader.Trust Log *slog.Logger } diff --git a/internal/admin/useractions.go b/internal/admin/useractions.go index ed22eda7..c85e47ec 100644 --- a/internal/admin/useractions.go +++ b/internal/admin/useractions.go @@ -244,7 +244,7 @@ func (h *Handler) mintLinkAs(w http.ResponseWriter, r *http.Request, kind, deliv minted, uid, owner, id, now); err != nil { return "", err } - return scheme(r) + "://" + current.Domain + acceptPrefix + uid + "/" + minted, nil + return h.deps.Trust.Scheme(r) + "://" + current.Domain + acceptPrefix + uid + "/" + minted, nil } func (h *Handler) resetVotes(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, rest string) error { @@ -310,13 +310,6 @@ func (h *Handler) grantPicked(r *http.Request, userID int64) error { return nil } -func scheme(r *http.Request) string { - if r.TLS != nil { - return "https" - } - return "http" -} - func (h *Handler) mailInvite(w http.ResponseWriter, r *http.Request, loc *i18n.Localizer, target *db.AdminUserRow, problem, done string) error { diff --git a/internal/proxyheader/proxyheader.go b/internal/proxyheader/proxyheader.go index f9197a9e..55c063af 100644 --- a/internal/proxyheader/proxyheader.go +++ b/internal/proxyheader/proxyheader.go @@ -43,6 +43,9 @@ func NewTrust(sources []string) (*Trust, error) { } func (t *Trust) Trusted(addr netip.Addr) bool { + if t == nil { + return false + } addr = addr.Unmap() for _, p := range t.nets { if p.Contains(addr) { diff --git a/internal/proxyheader/proxyheader_test.go b/internal/proxyheader/proxyheader_test.go index 0c47e4d8..ac51de93 100644 --- a/internal/proxyheader/proxyheader_test.go +++ b/internal/proxyheader/proxyheader_test.go @@ -195,3 +195,15 @@ func TestScheme(t *testing.T) { }) } } + +func TestSchemeOnNilTrustReadsTheConnection(t *testing.T) { + var tr *Trust + r := request("10.0.0.1:1", headers(headerProto, "https")) + if got := tr.Scheme(r); got != "http" { + t.Errorf("(*Trust)(nil).Scheme() = %q, want %q", got, "http") + } + r.TLS = &tls.ConnectionState{} + if got := tr.Scheme(r); got != "https" { + t.Errorf("(*Trust)(nil).Scheme() over TLS = %q, want %q", got, "https") + } +} diff --git a/internal/webapi/invite.go b/internal/webapi/invite.go index c1ab0fed..7e03e352 100644 --- a/internal/webapi/invite.go +++ b/internal/webapi/invite.go @@ -107,7 +107,7 @@ func (h *Users) mintInvite(r *http.Request, current *db.Site, by *db.User, email } minted := h.deps.Tokens.Make(token.InviteValue(id, false), now) uid := base64.RawURLEncoding.EncodeToString([]byte(strconv.FormatInt(id, 10))) - link := scheme(r) + "://" + current.Domain + acceptPrefix + uid + "/" + minted + link := h.deps.Trust.Scheme(r) + "://" + current.Domain + acceptPrefix + uid + "/" + minted owner := by.ID if _, err := h.deps.DB.CreateInviteLink(ctx, siteID(ctx), inviteKindRegister, inviteByLink, @@ -120,10 +120,3 @@ func (h *Users) mintInvite(r *http.Request, current *db.Site, by *db.User, email {Key: "userId", Value: id}, }) } - -func scheme(r *http.Request) string { - if r.TLS != nil { - return "https" - } - return "http" -} From 2a4b8c3247854d5261c3e2002af5ace127eff305 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 12 Sep 2026 00:22:23 +0900 Subject: [PATCH 395/428] let restore treat a freshly migrated database as empty --- cmd/pwikit/backup.go | 15 +++++-- internal/backup/backup_test.go | 81 ++++++++++++++++++++++++++++++++++ internal/backup/restore.go | 44 ++++++++++++++---- 3 files changed, 127 insertions(+), 13 deletions(-) diff --git a/cmd/pwikit/backup.go b/cmd/pwikit/backup.go index b812b601..277ea588 100644 --- a/cmd/pwikit/backup.go +++ b/cmd/pwikit/backup.go @@ -32,7 +32,7 @@ func backupCommand(args []string) error { Options: -output where create writes; defaults to a timestamped name in backups/ - -no-files leave the uploaded files out of the backup + -no-files leave the uploaded files out of a backup, or alone on restore -site back up one site on its own instead of the whole instance -keep-passwords carry the sign-in passwords into a single site backup -dir directory list reads; defaults to backups/ @@ -44,7 +44,7 @@ Options: fs := flag.NewFlagSet("backup "+sub, flag.ContinueOnError) output := fs.String("output", "", "where create writes the backup") - noFiles := fs.Bool("no-files", false, "leave the uploaded files out of the backup") + noFiles := fs.Bool("no-files", false, "leave the uploaded files out of a backup, or alone on restore") site := fs.String("site", "", "back up one site on its own instead of the whole instance") keepPasswords := fs.Bool("keep-passwords", false, "carry the sign-in passwords into a single site backup") dir := fs.String("dir", "", "directory list reads") @@ -93,7 +93,7 @@ Options: if len(loose) != 1 { return errors.New("restore needs one backup file") } - return restoreBackup(loose[0], dsn, p.Files(), p.Backups(), *force, *noSafety) + return restoreBackup(loose[0], dsn, files, p.Backups(), *force, *noSafety) } // A file name reads naturally before the flags, and the flag package stops at @@ -160,7 +160,14 @@ func printReport(name string, report backup.Report) { } func restoreBackup(name, dsn, files, backups string, force, noSafety bool) error { - if !noSafety { + holdsData, err := backup.Ready(context.Background(), dsn, force) + if err != nil { + return err + } + if !holdsData && !noSafety { + fmt.Println("the database holds no data yet, so there is nothing to back up first") + } + if holdsData && !noSafety { safety := filepath.Join(backups, "before-restore-"+backup.DefaultName(time.Now(), "")) fmt.Println("backing up the current state first") result, err := backup.Create(context.Background(), backup.CreateOptions{ diff --git a/internal/backup/backup_test.go b/internal/backup/backup_test.go index 44e2ab4e..2e7dd967 100644 --- a/internal/backup/backup_test.go +++ b/internal/backup/backup_test.go @@ -807,3 +807,84 @@ func TestDescribeReadsBackAsAVersion(t *testing.T) { } } } + +func TestReadyOnABlankDatabase(t *testing.T) { + target := scratch(t) + holdsData, err := Ready(context.Background(), target, false) + if err != nil { + t.Fatalf("Ready(blank) err = %v, want nil", err) + } + if holdsData { + t.Error("Ready(blank) holdsData = true, want false") + } +} + +func TestReadyOnADatabaseOnlyMigrated(t *testing.T) { + target := scratch(t) + ctx := context.Background() + if _, err := migrate.Run(ctx, target); err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + holdsData, err := Ready(ctx, target, false) + if err != nil { + t.Fatalf("Ready(migrated) err = %v, want nil", err) + } + if holdsData { + t.Error("Ready(migrated) holdsData = true, want false") + } +} + +func TestSeededNamesEveryTableTheMigrationsFill(t *testing.T) { + target := scratch(t) + ctx := context.Background() + if _, err := migrate.Run(ctx, target); err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + conn := connect(t, target) + tables, err := db.BackupTables(ctx, conn) + if err != nil { + t.Fatal(err) + } + full, err := db.NonEmptyTables(ctx, conn, tables) + if err != nil { + t.Fatal(err) + } + for _, name := range full { + if !seeded[name] { + t.Errorf("seeded[%q] = false, want true", name) + } + } +} + +func TestReadyOnADatabaseThatHoldsData(t *testing.T) { + target, _ := filled(t) + holdsData, err := Ready(context.Background(), target, true) + if err != nil { + t.Fatalf("Ready(full, force) err = %v, want nil", err) + } + if !holdsData { + t.Error("Ready(full, force) holdsData = false, want true") + } +} + +func TestRestoreIntoAMigratedDatabaseWithoutForce(t *testing.T) { + source, files := filled(t) + name, _ := create(t, source, files) + + target := scratch(t) + ctx := context.Background() + if _, err := migrate.Run(ctx, target); err != nil { + t.Fatalf("Run() err = %v, want nil", err) + } + if _, err := Restore(ctx, name, RestoreOptions{DSN: target}); err != nil { + t.Fatalf("Restore(into a migrated database) err = %v, want nil", err) + } + conn := connect(t, target) + var slug string + if err := conn.QueryRow(ctx, `SELECT slug FROM web_site`).Scan(&slug); err != nil { + t.Fatalf("read the restored site err = %v, want nil", err) + } + if slug != "probe" { + t.Errorf("restored site slug = %q, want %q", slug, "probe") + } +} diff --git a/internal/backup/restore.go b/internal/backup/restore.go index a10c0ef3..4de2dc61 100644 --- a/internal/backup/restore.go +++ b/internal/backup/restore.go @@ -36,6 +36,26 @@ type RestoreResult struct { var ErrNotEmpty = errors.New("the database already holds data") +// The migrations fill these before anyone uses the database, so rows in them +// alone leave nothing to replace or keep. +var seeded = map[string]bool{ + "auth_permission": true, + "django_content_type": true, + "web_role": true, + "web_role_permissions": true, + "web_rolecategory": true, + "web_theme": true, +} + +func Ready(ctx context.Context, dsn string, force bool) (holdsData bool, err error) { + conn, err := pgx.Connect(ctx, dsn) + if err != nil { + return false, fmt.Errorf("connect to restore: %w", err) + } + defer conn.Close(ctx) + return readyToRestore(ctx, conn, force) +} + func Restore(ctx context.Context, name string, opts RestoreOptions) (RestoreResult, error) { var out RestoreResult @@ -57,7 +77,7 @@ func Restore(ctx context.Context, name string, opts RestoreOptions) (RestoreResu } defer conn.Close(ctx) - if err := readyToRestore(ctx, conn, opts.Force); err != nil { + if _, err := readyToRestore(ctx, conn, opts.Force); err != nil { return out, err } @@ -133,27 +153,33 @@ func named(m Manifest) map[string]bool { return out } -func readyToRestore(ctx context.Context, conn *pgx.Conn, force bool) error { +func readyToRestore(ctx context.Context, conn *pgx.Conn, force bool) (bool, error) { others, err := db.OtherConnections(ctx, conn) if err != nil { - return err + return false, err } if others > 0 { - return fmt.Errorf("%d other connections are using this database; stop pwikit before restoring", others) + return false, fmt.Errorf("%d other connections are using this database; stop pwikit before restoring", others) } tables, err := db.BackupTables(ctx, conn) if err != nil { - return err + return false, err + } + var used []string + for _, name := range tables { + if !seeded[name] { + used = append(used, name) + } } - full, err := db.NonEmptyTables(ctx, conn, tables) + full, err := db.NonEmptyTables(ctx, conn, used) if err != nil { - return err + return false, err } if len(full) > 0 && !force { - return fmt.Errorf("%w (%s and %d more tables); run again with -force to replace it", + return true, fmt.Errorf("%w (%s and %d more tables); run again with -force to replace it", ErrNotEmpty, full[0], len(full)-1) } - return nil + return len(full) > 0, nil } func loadTables(ctx context.Context, tx pgx.Tx, name string, m Manifest, out func(string)) (int64, error) { From 5d31f39e01572d60728f38a37e7aa81054064ef3 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 12 Sep 2026 00:22:23 +0900 Subject: [PATCH 396/428] make listpages dates, order, exact tags and skipcurrent do what they say --- internal/db/listpages.go | 29 ++-- internal/db/listpages_test.go | 1 + internal/db/listpages_write_test.go | 141 ++++++++++++++++++ internal/listpages/params.go | 72 +++++---- internal/listpages/params_test.go | 57 ++++--- internal/listpages/render.go | 9 +- internal/listpages/render_test.go | 2 + internal/listpages/testdata/params.golden | 26 ++-- internal/listpages/testdata/sections.golden | 30 ++-- .../listpages/testdata/sections_corpus.json | 8 + internal/modules/listpages_test.go | 2 +- 11 files changed, 290 insertions(+), 87 deletions(-) create mode 100644 internal/db/listpages_write_test.go diff --git a/internal/db/listpages.go b/internal/db/listpages.go index 7445eb9a..abb9b1c6 100644 --- a/internal/db/listpages.go +++ b/internal/db/listpages.go @@ -8,8 +8,8 @@ import ( "time" ) -// Range and ExcludeRange read both ends, the rest read only the end the -// operator names. +// End is the first moment after the period. Range and ExcludeRange read both +// ends, the rest read only the end the operator names. type TimeFilter struct { Op string Start time.Time @@ -77,6 +77,8 @@ type ListFilter struct { AbsentTags []int64 ExactTags []int64 + NotID *int64 + Categories []string NotCategories []string @@ -192,6 +194,9 @@ func (f ListFilter) build(b *listBuilder) string { b.where = append(b.where, "NOT EXISTS (SELECT 1 FROM web_article_tags t WHERE t.article_id = a.id)") } f.buildTags(b) + if f.NotID != nil { + b.where = append(b.where, "a.id <> "+b.arg(*f.NotID)) + } if len(f.Categories) > 0 { b.where = append(b.where, "a.category = ANY("+b.arg(f.Categories)+")") } @@ -248,6 +253,10 @@ func (f ListFilter) buildTags(b *listBuilder) { " WHERE t.article_id = a.id AND t.tag_id = ANY("+b.arg(ids)+")) = "+b.arg(len(ids))) } hasAll(f.ExactTags) + if len(f.ExactTags) > 0 { + b.where = append(b.where, "NOT EXISTS (SELECT 1 FROM web_article_tags t"+ + " WHERE t.article_id = a.id AND NOT (t.tag_id = ANY("+b.arg(f.ExactTags)+")))") + } hasAll(f.RequiredTags) if len(f.PresentTags) > 0 { b.where = append(b.where, "EXISTS (SELECT 1 FROM web_article_tags t"+ @@ -265,17 +274,17 @@ func (f ListFilter) buildTime(b *listBuilder, column string, c *TimeFilter) { } switch c.Op { case TimeRange: - b.where = append(b.where, column+" >= "+b.arg(c.Start)+" AND "+column+" <= "+b.arg(c.End)) + b.where = append(b.where, column+" >= "+b.arg(c.Start)+" AND "+column+" < "+b.arg(c.End)) case TimeExcludeRange: - b.where = append(b.where, "("+column+" < "+b.arg(c.Start)+" OR "+column+" > "+b.arg(c.End)+")") + b.where = append(b.where, "("+column+" < "+b.arg(c.Start)+" OR "+column+" >= "+b.arg(c.End)+")") case TimeLT: b.where = append(b.where, column+" < "+b.arg(c.Start)) case TimeLTE: - b.where = append(b.where, column+" <= "+b.arg(c.Start)) + b.where = append(b.where, column+" < "+b.arg(c.End)) case TimeGT: - b.where = append(b.where, column+" > "+b.arg(c.End)) - case TimeGTE: b.where = append(b.where, column+" >= "+b.arg(c.End)) + case TimeGTE: + b.where = append(b.where, column+" >= "+b.arg(c.Start)) } } @@ -318,6 +327,8 @@ func (f ListFilter) orderBy() (expr, extra string) { direction = " DESC" } switch f.Sort.Column { + case SortCreatedAt: + return "a.created_at" + direction, "" case SortCreatedBy: return "author_name" + direction, ", au.username AS author_name" case SortName: @@ -343,8 +354,8 @@ func (f ListFilter) orderBy() (expr, extra string) { case SortComments: return "comments" + direction, ", " + commentsExpr + " AS comments" } - // A column nobody recognises falls back to the newest first, direction and - // all, so asking for one is not the same as asking for created_at. + // A column nobody recognises lists the newest first whatever direction was + // asked for. return "a.created_at DESC", "" } diff --git a/internal/db/listpages_test.go b/internal/db/listpages_test.go index b39aacd0..612b6202 100644 --- a/internal/db/listpages_test.go +++ b/internal/db/listpages_test.go @@ -23,6 +23,7 @@ func listFilterVariants() map[string]ListFilter { "name-prefix": {NamePrefix: "scp-", HasNamePrefix: true}, "no-tags": {NoTags: true}, "exact-tags": {ExactTags: int64s(1, 2)}, + "not-id": {NotID: &parent}, "required-tags": {RequiredTags: int64s(1, 2)}, "present-tags": {PresentTags: int64s(3)}, "absent-tags": {AbsentTags: int64s(4)}, diff --git a/internal/db/listpages_write_test.go b/internal/db/listpages_write_test.go new file mode 100644 index 00000000..f6779118 --- /dev/null +++ b/internal/db/listpages_write_test.go @@ -0,0 +1,141 @@ +package db + +import ( + "context" + "slices" + "testing" + "time" +) + +type listedProbe struct { + site int64 + ids map[string]int64 +} + +func listedPages(t *testing.T, d *DB) listedProbe { + t.Helper() + ctx := context.Background() + site := scratchSite(t, d) + t.Cleanup(func() { + clean := context.Background() + for _, sql := range []string{ + `DELETE FROM web_article_tags WHERE article_id IN (SELECT id FROM web_article WHERE site_id = $1)`, + `DELETE FROM web_tag WHERE category_id IN (SELECT id FROM web_tagscategory WHERE site_id = $1)`, + `DELETE FROM web_tagscategory WHERE site_id = $1`, + `DELETE FROM web_articlelogentry WHERE article_id IN (SELECT id FROM web_article WHERE site_id = $1)`, + `DELETE FROM web_articleversion WHERE article_id IN (SELECT id FROM web_article WHERE site_id = $1)`, + `DELETE FROM web_article_authors WHERE article_id IN (SELECT id FROM web_article WHERE site_id = $1)`, + `DELETE FROM web_article WHERE site_id = $1`, + } { + if _, err := d.pool.Exec(clean, sql, site); err != nil { + t.Errorf("clean up pages of site %d err = %v, want nil", site, err) + } + } + }) + pages := []struct { + name string + created time.Time + tags []string + }{ + {"alpha", time.Date(2021, 2, 9, 15, 0, 0, 0, time.UTC), []string{"x", "y"}}, + {"beta", time.Date(2021, 2, 10, 0, 0, 0, 0, time.UTC), []string{"x", "y", "z"}}, + {"gamma", time.Date(2021, 12, 31, 23, 30, 0, 0, time.UTC), []string{"x"}}, + } + probe := listedProbe{site: site, ids: map[string]int64{}} + for _, p := range pages { + id, err := d.CreateArticle(ctx, site, "_default", p.name, p.name, nil, p.created) + if err != nil { + t.Fatalf("CreateArticle(%s) err = %v, want nil", p.name, err) + } + if _, _, err := d.SetArticleTags(ctx, site, id, p.tags, true, nil, p.created); err != nil { + t.Fatalf("SetArticleTags(%s) err = %v, want nil", p.name, err) + } + if _, err := d.pool.Exec(ctx, `UPDATE web_article SET created_at = $2 WHERE id = $1`, id, p.created); err != nil { + t.Fatal(err) + } + probe.ids[p.name] = id + } + return probe +} + +func (p listedProbe) names(t *testing.T, d *DB, f ListFilter) []string { + t.Helper() + f.SiteID = p.site + listed, err := d.ListArticles(context.Background(), f, 0, nil) + if err != nil { + t.Fatalf("ListArticles() err = %v, want nil", err) + } + var out []string + for _, a := range listed { + out = append(out, a.Name) + } + return out +} + +func TestListArticlesExactTags(t *testing.T) { + d := writeTestDB(t) + p := listedPages(t, d) + var tags []int64 + if err := d.pool.QueryRow(context.Background(), ` +SELECT array_agg(tag_id ORDER BY tag_id) FROM web_article_tags WHERE article_id = $1`, p.ids["alpha"]).Scan(&tags); err != nil { + t.Fatal(err) + } + + got := p.names(t, d, ListFilter{ExactTags: tags}) + if !slices.Equal(got, []string{"alpha"}) { + t.Errorf("ListArticles(ExactTags of alpha) = %v, want [alpha]", got) + } + got = p.names(t, d, ListFilter{RequiredTags: tags, Sort: Sort{Column: SortName, Ascending: true}}) + if !slices.Equal(got, []string{"alpha", "beta"}) { + t.Errorf("ListArticles(RequiredTags of alpha) = %v, want [alpha beta]", got) + } +} + +func TestListArticlesNotID(t *testing.T) { + d := writeTestDB(t) + p := listedPages(t, d) + got := p.names(t, d, ListFilter{NotID: new(p.ids["beta"]), Sort: Sort{Column: SortName, Ascending: true}}) + if !slices.Equal(got, []string{"alpha", "gamma"}) { + t.Errorf("ListArticles(NotID beta) = %v, want [alpha gamma]", got) + } +} + +func TestListArticlesSortsByCreatedAtBothWays(t *testing.T) { + d := writeTestDB(t) + p := listedPages(t, d) + got := p.names(t, d, ListFilter{Sort: Sort{Column: SortCreatedAt, Ascending: true}}) + if !slices.Equal(got, []string{"alpha", "beta", "gamma"}) { + t.Errorf("ListArticles(created_at asc) = %v, want [alpha beta gamma]", got) + } + got = p.names(t, d, ListFilter{Sort: Sort{Column: SortCreatedAt}}) + if !slices.Equal(got, []string{"gamma", "beta", "alpha"}) { + t.Errorf("ListArticles(created_at desc) = %v, want [gamma beta alpha]", got) + } +} + +func TestListArticlesTimeFilterCoversTheWholePeriod(t *testing.T) { + d := writeTestDB(t) + p := listedPages(t, d) + day := time.Date(2021, 2, 9, 0, 0, 0, 0, time.UTC) + year := time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC) + cases := []struct { + name string + f TimeFilter + want []string + }{ + {"range 2021-02-09", TimeFilter{Op: TimeRange, Start: day, End: day.AddDate(0, 0, 1)}, []string{"alpha"}}, + {"range 2021", TimeFilter{Op: TimeRange, Start: year, End: year.AddDate(1, 0, 0)}, []string{"alpha", "beta", "gamma"}}, + {"exclude 2021-02-09", TimeFilter{Op: TimeExcludeRange, Start: day, End: day.AddDate(0, 0, 1)}, []string{"beta", "gamma"}}, + {"lt 2021-02-09", TimeFilter{Op: TimeLT, Start: day, End: day.AddDate(0, 0, 1)}, nil}, + {"lte 2021-02-09", TimeFilter{Op: TimeLTE, Start: day, End: day.AddDate(0, 0, 1)}, []string{"alpha"}}, + {"gt 2021-02-09", TimeFilter{Op: TimeGT, Start: day, End: day.AddDate(0, 0, 1)}, []string{"beta", "gamma"}}, + {"gte 2021-02-09", TimeFilter{Op: TimeGTE, Start: day, End: day.AddDate(0, 0, 1)}, []string{"alpha", "beta", "gamma"}}, + } + for _, c := range cases { + f := c.f + got := p.names(t, d, ListFilter{CreatedAt: &f, Sort: Sort{Column: SortName, Ascending: true}}) + if !slices.Equal(got, c.want) { + t.Errorf("ListArticles(%s) = %v, want %v", c.name, got, c.want) + } + } +} diff --git a/internal/listpages/params.go b/internal/listpages/params.go index cedbbb27..4876e016 100644 --- a/internal/listpages/params.go +++ b/internal/listpages/params.go @@ -84,6 +84,7 @@ func Parse(src Source, article *db.Article, viewer *db.User, zone *time.Location if p.parseSinglePage() { return p.out, p.err } + p.parseRange() p.parseType() p.parseName() p.parseTags() @@ -131,6 +132,12 @@ func (p *parser) parseSinglePage() bool { return false } +func (p *parser) parseRange() { + if p.get("range") == "others" && p.article != nil { + p.out.Filter.NotID = &p.article.ID + } +} + func (p *parser) parseType() { pageType := p.get("pagetype") if _, ok := p.params["pagetype"]; !ok { @@ -185,9 +192,12 @@ func (p *parser) parseTags() { p.fail(err) return } - if raw == "=" { + switch { + case raw == "=": p.out.Filter.RequiredTags = ids - } else { + case len(ids) == 0: + p.out.Filter.NoTags = true + default: p.out.Filter.ExactTags = ids } return @@ -397,19 +407,18 @@ func (p *parser) parseTime(key string, of func(*db.Article) time.Time, set func( return } y, m, d := of(p.article).In(p.zone).Date() - dayStart := time.Date(y, m, d, 0, 0, 0, 0, p.zone) - dayEnd := time.Date(y, m, d, 23, 59, 59, 0, p.zone) - set(&db.TimeFilter{Op: db.TimeRange, Start: dayStart, End: dayEnd}) + set(&db.TimeFilter{Op: db.TimeRange, + Start: time.Date(y, m, d, 0, 0, 0, 0, p.zone), End: time.Date(y, m, d+1, 0, 0, 0, 0, p.zone)}) return } op, rest := splitArgOperator(raw, []string{">=", "<=", "<>", ">", "<", "="}, "=") - first, last, ok := parseDateBounds(strings.TrimSpace(rest), p.zone) + start, end, ok := parseDateBounds(strings.TrimSpace(rest), p.zone) if !ok { p.invalid() return } - set(&db.TimeFilter{Op: timeOp(op), Start: first, End: last}) + set(&db.TimeFilter{Op: timeOp(op), Start: start, End: end}) } func timeOp(op string) string { @@ -428,37 +437,40 @@ func timeOp(op string) string { return db.TimeRange } -// Month and day are clamped rather than rejected, so 2020-13-99 is the last -// day of 2020-12. -func parseDateBounds(text string, zone *time.Location) (first, last time.Time, ok bool) { +// The end is the first moment after the period rather than its last day, so a +// day covers all of its hours. Month and day are clamped rather than rejected, +// so 2020-13-99 is the last day of 2020-12. +func parseDateBounds(text string, zone *time.Location) (start, end time.Time, ok bool) { parts := strings.Split(text, "-") year, err := wikinum.Int(parts[0]) if err != nil || year < 1 || year > 9999 { return time.Time{}, time.Time{}, false } - month, day := 1, 1 - lastMonth, lastDay := 12, 31 + start = time.Date(year, 1, 1, 0, 0, 0, 0, zone) + end = time.Date(year+1, 1, 1, 0, 0, 0, 0, zone) + if len(parts) < 2 { + return start, end, true + } - if len(parts) >= 2 { - m, err := wikinum.Int(parts[1]) - if err != nil { - return time.Time{}, time.Time{}, false - } - month = clamp(m, 1, 12) - lastMonth = month - lastDay = daysIn(year, month) + m, err := wikinum.Int(parts[1]) + if err != nil { + return time.Time{}, time.Time{}, false } - if len(parts) >= 3 { - d, err := wikinum.Int(parts[2]) - if err != nil { - return time.Time{}, time.Time{}, false - } - day = clamp(d, 1, daysIn(year, month)) - lastDay = day + month := time.Month(clamp(m, 1, 12)) + start = time.Date(year, month, 1, 0, 0, 0, 0, zone) + end = time.Date(year, month+1, 1, 0, 0, 0, 0, zone) + if len(parts) < 3 { + return start, end, true + } + + d, err := wikinum.Int(parts[2]) + if err != nil { + return time.Time{}, time.Time{}, false } - first = time.Date(year, time.Month(month), day, 0, 0, 0, 0, zone) - last = time.Date(year, time.Month(lastMonth), lastDay, 0, 0, 0, 0, zone) - return first, last, true + day := clamp(d, 1, daysIn(year, int(month))) + start = time.Date(year, month, day, 0, 0, 0, 0, zone) + end = time.Date(year, month, day+1, 0, 0, 0, 0, zone) + return start, end, true } func daysIn(year, month int) int { diff --git a/internal/listpages/params_test.go b/internal/listpages/params_test.go index 969c4034..52b6e2bf 100644 --- a/internal/listpages/params_test.go +++ b/internal/listpages/params_test.go @@ -272,6 +272,27 @@ func TestParseTagsDoubleEqualsTakesTheOwnTags(t *testing.T) { if len(q.Filter.ExactTags) != 2 { t.Errorf("ExactTags = %v, want two entries", q.Filter.ExactTags) } + if len(q.Filter.RequiredTags) != 0 { + t.Errorf("RequiredTags = %v, want []", q.Filter.RequiredTags) + } +} + +func TestParseRangeOthersLeavesOutTheOwnPage(t *testing.T) { + a := article173() + q := parse(t, newFakeSource(), a, nil, map[string]string{"range": "others"}) + if q.Filter.NotID == nil || *q.Filter.NotID != a.ID { + t.Errorf("Parse(range=others).NotID = %v, want %d", q.Filter.NotID, a.ID) + } + if q.HasOnly { + t.Error("Parse(range=others).HasOnly = true, want false") + } +} + +func TestParseRangeOthersWithoutAnArticle(t *testing.T) { + q := parse(t, newFakeSource(), nil, nil, map[string]string{"range": "others", "category": "*"}) + if q.Filter.NotID != nil { + t.Errorf("Parse(range=others, nil article).NotID = %d, want nil", *q.Filter.NotID) + } } func TestParseTagsWithoutACategoryMatchesEveryCategory(t *testing.T) { @@ -383,17 +404,19 @@ func TestParseCreatedAtBounds(t *testing.T) { op string start, end string }{ - {"2021", db.TimeRange, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, - {"2021-02", db.TimeRange, "2021-02-01T00:00:00Z", "2021-02-28T00:00:00Z"}, - {"2020-02", db.TimeRange, "2020-02-01T00:00:00Z", "2020-02-29T00:00:00Z"}, - {"2021-02-09", db.TimeRange, "2021-02-09T00:00:00Z", "2021-02-09T00:00:00Z"}, - {"2021-13-99", db.TimeRange, "2021-12-31T00:00:00Z", "2021-12-31T00:00:00Z"}, - {"2021-00-00", db.TimeRange, "2021-01-01T00:00:00Z", "2021-01-01T00:00:00Z"}, - {">2021", db.TimeGT, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, - {">=2021", db.TimeGTE, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, - {"<2021", db.TimeLT, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, - {"<=2021", db.TimeLTE, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, - {"<>2021", db.TimeExcludeRange, "2021-01-01T00:00:00Z", "2021-12-31T00:00:00Z"}, + {"2021", db.TimeRange, "2021-01-01T00:00:00Z", "2022-01-01T00:00:00Z"}, + {"2021-02", db.TimeRange, "2021-02-01T00:00:00Z", "2021-03-01T00:00:00Z"}, + {"2020-02", db.TimeRange, "2020-02-01T00:00:00Z", "2020-03-01T00:00:00Z"}, + {"2021-02-09", db.TimeRange, "2021-02-09T00:00:00Z", "2021-02-10T00:00:00Z"}, + {"2021-12", db.TimeRange, "2021-12-01T00:00:00Z", "2022-01-01T00:00:00Z"}, + {"2021-12-31", db.TimeRange, "2021-12-31T00:00:00Z", "2022-01-01T00:00:00Z"}, + {"2021-13-99", db.TimeRange, "2021-12-31T00:00:00Z", "2022-01-01T00:00:00Z"}, + {"2021-00-00", db.TimeRange, "2021-01-01T00:00:00Z", "2021-01-02T00:00:00Z"}, + {">2021", db.TimeGT, "2021-01-01T00:00:00Z", "2022-01-01T00:00:00Z"}, + {">=2021", db.TimeGTE, "2021-01-01T00:00:00Z", "2022-01-01T00:00:00Z"}, + {"<2021", db.TimeLT, "2021-01-01T00:00:00Z", "2022-01-01T00:00:00Z"}, + {"<=2021", db.TimeLTE, "2021-01-01T00:00:00Z", "2022-01-01T00:00:00Z"}, + {"<>2021", db.TimeExcludeRange, "2021-01-01T00:00:00Z", "2022-01-01T00:00:00Z"}, } for _, c := range cases { q := parse(t, newFakeSource(), article173(), nil, map[string]string{"created_at": c.in}) @@ -423,8 +446,8 @@ func TestParseCreatedAtEqualsIsTheOwnDay(t *testing.T) { if start := got.Start.Format(time.RFC3339); start != "2021-06-05T00:00:00Z" { t.Errorf("Start = %q, want %q", start, "2021-06-05T00:00:00Z") } - if end := got.End.Format(time.RFC3339); end != "2021-06-05T23:59:59Z" { - t.Errorf("End = %q, want %q", end, "2021-06-05T23:59:59Z") + if end := got.End.Format(time.RFC3339); end != "2021-06-06T00:00:00Z" { + t.Errorf("End = %q, want %q", end, "2021-06-06T00:00:00Z") } } @@ -490,8 +513,8 @@ func TestParseUpdatedAtBounds(t *testing.T) { if got.Op != db.TimeGTE { t.Errorf("Op = %q, want %q", got.Op, db.TimeGTE) } - if end := got.End.Format(time.RFC3339); end != "2021-02-28T00:00:00Z" { - t.Errorf("End = %q, want %q", end, "2021-02-28T00:00:00Z") + if start := got.Start.Format(time.RFC3339); start != "2021-02-01T00:00:00Z" { + t.Errorf("Start = %q, want %q", start, "2021-02-01T00:00:00Z") } } @@ -513,8 +536,8 @@ func TestParseUpdatedAtEqualsIsTheOwnDay(t *testing.T) { if start := got.Start.Format(time.RFC3339); start != "2022-03-09T00:00:00Z" { t.Errorf("Start = %q, want %q", start, "2022-03-09T00:00:00Z") } - if end := got.End.Format(time.RFC3339); end != "2022-03-09T23:59:59Z" { - t.Errorf("End = %q, want %q", end, "2022-03-09T23:59:59Z") + if end := got.End.Format(time.RFC3339); end != "2022-03-10T00:00:00Z" { + t.Errorf("End = %q, want %q", end, "2022-03-10T00:00:00Z") } } diff --git a/internal/listpages/render.go b/internal/listpages/render.go index 4f24b8d1..cdb422b2 100644 --- a/internal/listpages/render.go +++ b/internal/listpages/render.go @@ -16,12 +16,9 @@ type Sections struct { Foot string } -// The two characters this eats around each part are not a mistake to fix. They -// are what the running site's output already has, so removing them would move -// every listing by two characters. -var sectionPattern = regexp.MustCompile(`(?is)\A(?:.*\s*(\[\[head]]\n?.(?P.*?).\[\[/head]])|)` + - `(?:.*\s*(\[\[body]]\n?.(?P.*?).\[\[/body]])|)` + - `(?:.*\s*(\[\[foot]]\n?.(?P.*?).\[\[/foot]])|)`) +var sectionPattern = regexp.MustCompile(`(?is)\A(?:.*\s*(\[\[head]]\n*(?P.*?)\n*\[\[/head]])|)` + + `(?:.*\s*(\[\[body]]\n*(?P.*?)\n*\[\[/body]])|)` + + `(?:.*\s*(\[\[foot]]\n*(?P.*?)\n*\[\[/foot]])|)`) func Split(content string) Sections { match := sectionPattern.FindStringSubmatch(content) diff --git a/internal/listpages/render_test.go b/internal/listpages/render_test.go index 6af9cb5c..fb827fc8 100644 --- a/internal/listpages/render_test.go +++ b/internal/listpages/render_test.go @@ -89,6 +89,8 @@ func sectionCases() []sectionCase { {"multiline-body", "[[body]]\none\ntwo\nthree\n[[/body]]"}, {"leading-text", "junk\n[[body]]\nrow\n[[/body]]"}, {"empty-body", "[[body]]\n[[/body]]"}, + {"blank-line-after-open", "[[head]]\n\n||~ Title||\n[[/head]]\n[[body]]\n\n||%%title%%||\n\n[[/body]]"}, + {"table-rows", "[[head]]\n||~ Title||\n[[/head]]\n[[body]]\n||%%title%%||\n[[/body]]\n[[foot]]\n||~ End||\n[[/foot]]"}, {"body-before-head", "[[body]]\nrow\n[[/body]]\n[[head]]\ntop\n[[/head]]"}, } } diff --git a/internal/listpages/testdata/params.golden b/internal/listpages/testdata/params.golden index 3739c7d6..30aa6802 100644 --- a/internal/listpages/testdata/params.golden +++ b/internal/listpages/testdata/params.golden @@ -551,7 +551,7 @@ fullname=- pagetype=normal name=- nameprefix=- -notags=false +notags=true required= present= absent= @@ -899,7 +899,7 @@ notcategories= parent=- notparent=- author=- -created_at=range 2021-01-01T00:00:00 2021-12-31T00:00:00 +created_at=range 2021-01-01T00:00:00 2022-01-01T00:00:00 rating=- votes=- popularity=- @@ -925,7 +925,7 @@ notcategories= parent=- notparent=- author=- -created_at=range 2021-02-01T00:00:00 2021-02-28T00:00:00 +created_at=range 2021-02-01T00:00:00 2021-03-01T00:00:00 rating=- votes=- popularity=- @@ -951,7 +951,7 @@ notcategories= parent=- notparent=- author=- -created_at=range 2020-02-01T00:00:00 2020-02-29T00:00:00 +created_at=range 2020-02-01T00:00:00 2020-03-01T00:00:00 rating=- votes=- popularity=- @@ -977,7 +977,7 @@ notcategories= parent=- notparent=- author=- -created_at=range 2021-02-09T00:00:00 2021-02-09T00:00:00 +created_at=range 2021-02-09T00:00:00 2021-02-10T00:00:00 rating=- votes=- popularity=- @@ -1003,7 +1003,7 @@ notcategories= parent=- notparent=- author=- -created_at=range 2021-12-31T00:00:00 2021-12-31T00:00:00 +created_at=range 2021-12-31T00:00:00 2022-01-01T00:00:00 rating=- votes=- popularity=- @@ -1029,7 +1029,7 @@ notcategories= parent=- notparent=- author=- -created_at=range 2021-01-01T00:00:00 2021-01-01T00:00:00 +created_at=range 2021-01-01T00:00:00 2021-01-02T00:00:00 rating=- votes=- popularity=- @@ -1055,7 +1055,7 @@ notcategories= parent=- notparent=- author=- -created_at=gt 2021-01-01T00:00:00 2021-12-31T00:00:00 +created_at=gt 2021-01-01T00:00:00 2022-01-01T00:00:00 rating=- votes=- popularity=- @@ -1081,7 +1081,7 @@ notcategories= parent=- notparent=- author=- -created_at=gte 2021-01-01T00:00:00 2021-12-31T00:00:00 +created_at=gte 2021-01-01T00:00:00 2022-01-01T00:00:00 rating=- votes=- popularity=- @@ -1107,7 +1107,7 @@ notcategories= parent=- notparent=- author=- -created_at=lt 2021-01-01T00:00:00 2021-12-31T00:00:00 +created_at=lt 2021-01-01T00:00:00 2022-01-01T00:00:00 rating=- votes=- popularity=- @@ -1133,7 +1133,7 @@ notcategories= parent=- notparent=- author=- -created_at=lte 2021-01-01T00:00:00 2021-12-31T00:00:00 +created_at=lte 2021-01-01T00:00:00 2022-01-01T00:00:00 rating=- votes=- popularity=- @@ -1159,7 +1159,7 @@ notcategories= parent=- notparent=- author=- -created_at=exclude_range 2021-01-01T00:00:00 2021-12-31T00:00:00 +created_at=exclude_range 2021-01-01T00:00:00 2022-01-01T00:00:00 rating=- votes=- popularity=- @@ -1185,7 +1185,7 @@ notcategories= parent=- notparent=- author=- -created_at=range 2026-08-20T00:00:00 2026-08-20T23:59:59 +created_at=range 2026-08-20T00:00:00 2026-08-21T00:00:00 rating=- votes=- popularity=- diff --git a/internal/listpages/testdata/sections.golden b/internal/listpages/testdata/sections.golden index 4f397643..6d8f2b8d 100644 --- a/internal/listpages/testdata/sections.golden +++ b/internal/listpages/testdata/sections.golden @@ -7,42 +7,50 @@ head="" body="" foot="" === head-only -head="efore" +head="before" body="" foot="" === body-only head="" -body="%title%%" +body="%%title%%" foot="" === foot-only head="" body="" -foot="fter" +foot="after" === all-three -head="efore" -body="%title%%" -foot="fter" +head="before" +body="%%title%%" +foot="after" === no-newline-after-open -head="efor" +head="before" body="" foot="" === uppercase-tags -head="efore" +head="before" body="" foot="" === multiline-body head="" -body="ne\ntwo\nthree" +body="one\ntwo\nthree" foot="" === leading-text head="" -body="ow" +body="row" foot="" === empty-body head="" body="" foot="" +=== blank-line-after-open +head="||~ Title||" +body="||%%title%%||" +foot="" +=== table-rows +head="||~ Title||" +body="||%%title%%||" +foot="||~ End||" === body-before-head -head="op" +head="top" body="" foot="" diff --git a/internal/listpages/testdata/sections_corpus.json b/internal/listpages/testdata/sections_corpus.json index 092780ad..4e756e55 100644 --- a/internal/listpages/testdata/sections_corpus.json +++ b/internal/listpages/testdata/sections_corpus.json @@ -43,6 +43,14 @@ "name": "empty-body", "content": "[[body]]\n[[/body]]" }, + { + "name": "blank-line-after-open", + "content": "[[head]]\n\n||~ Title||\n[[/head]]\n[[body]]\n\n||%%title%%||\n\n[[/body]]" + }, + { + "name": "table-rows", + "content": "[[head]]\n||~ Title||\n[[/head]]\n[[body]]\n||%%title%%||\n[[/body]]\n[[foot]]\n||~ End||\n[[/foot]]" + }, { "name": "body-before-head", "content": "[[body]]\nrow\n[[/body]]\n[[head]]\ntop\n[[/head]]" diff --git a/internal/modules/listpages_test.go b/internal/modules/listpages_test.go index 27a93c6f..6a9324a3 100644 --- a/internal/modules/listpages_test.go +++ b/internal/modules/listpages_test.go @@ -280,7 +280,7 @@ func TestListPagesBodySectionsOverrideTheParameters(t *testing.T) { env, seen := listEnv(t, data, ctx) params := map[string]string{"wrapper": "no", "prependline": "ignored"} - body := "[[head]]\nXtop\n[[/head]]\n[[body]]\nX%%name%%\n[[/body]]" + body := "[[head]]\ntop\n[[/head]]\n[[body]]\n%%name%%\n[[/body]]" if _, err := module.Render(env, "listpages", params, body); err != nil { t.Fatalf("Render(listpages) err = %v, want nil", err) } From 9431491ccfb9df01b95dabf93cd8a19d1be9f0fb Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 12 Sep 2026 00:22:32 +0900 Subject: [PATCH 397/428] stop reading the word else as [[else]] --- .../rule/impls/block/blocks/expression.rs | 2 ++ internal/renderer/cgo/renderer_test.go | 30 +++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/ftml/src/parsing/rule/impls/block/blocks/expression.rs b/ftml/src/parsing/rule/impls/block/blocks/expression.rs index e787d298..6b8edac9 100644 --- a/ftml/src/parsing/rule/impls/block/blocks/expression.rs +++ b/ftml/src/parsing/rule/impls/block/blocks/expression.rs @@ -204,6 +204,8 @@ fn parse_with_body<'r, 't>(parser: &mut Parser<'r, 't>, name: &'t str, rule: &Bl // check for presence of "else" let found_else = parser.save_evaluate_fn(|parser| { + // Without the opening brackets the plain word "else" in the body would end it. + parser.get_token(Token::LeftBlock, ParseWarningKind::ManualBreak)?; let (name, _) = parser.get_block_name(false)?; if name == "else" { diff --git a/internal/renderer/cgo/renderer_test.go b/internal/renderer/cgo/renderer_test.go index 5e9edeb5..4a44e3fe 100644 --- a/internal/renderer/cgo/renderer_test.go +++ b/internal/renderer/cgo/renderer_test.go @@ -222,3 +222,33 @@ func TestRenderIsReusableAcrossCalls(t *testing.T) { } } } + +func TestRenderHTMLIfBody(t *testing.T) { + tests := []struct { + name string + source string + want string + without string + }{ + {"word else in the shown text", "[[if yes]]\nsomething else here\n[[else]]\nhidden\n[[/if]]", "something else here", "hidden"}, + {"word else in the hidden text", "[[if false]]\nnot shown\n[[else]]\nor else\n[[/if]]", "or else", "not shown"}, + {"word else without an else block", "[[if yes]]\nelse\n[[/if]]", "else", "[[/if]]"}, + {"ifexpr keeps the word", "[[ifexpr 1]]\nnothing else\n[[else]]\nzero\n[[/ifexpr]]", "nothing else", "zero"}, + } + + r := New() + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := r.RenderHTML(context.Background(), tt.source, info(), newHost(), renderer.ModeArticle) + if err != nil { + t.Fatalf("RenderHTML(%q) err = %v, want nil", tt.source, err) + } + if !strings.Contains(got.Body, tt.want) { + t.Errorf("RenderHTML(%q) = %q, want substring %q", tt.source, got.Body, tt.want) + } + if strings.Contains(got.Body, tt.without) { + t.Errorf("RenderHTML(%q) = %q, want no %q", tt.source, got.Body, tt.without) + } + }) + } +} From 9336484767ee9dd06ee68ffbd0edc0372bdebbe0 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Sat, 12 Sep 2026 00:22:32 +0900 Subject: [PATCH 398/428] drop the seeded syntax guide --- internal/seed/pages/nav/top-impl.ftml | 1 - internal/seed/pages/wiki-syntax-guide.ftml | 1770 -------------------- internal/seed/seed_test.go | 9 +- 3 files changed, 4 insertions(+), 1776 deletions(-) delete mode 100644 internal/seed/pages/wiki-syntax-guide.ftml diff --git a/internal/seed/pages/nav/top-impl.ftml b/internal/seed/pages/nav/top-impl.ftml index 39a22bc7..ccc62199 100644 --- a/internal/seed/pages/nav/top-impl.ftml +++ b/internal/seed/pages/nav/top-impl.ftml @@ -24,4 +24,3 @@ * [https://github.com/WikitTeam/ProjectWikit GitHub页面] * [[[/forum/start|论坛]]] * [[[/forum:recent-posts|最新帖子]]] - * [[[/wiki-syntax-guide|维基语法指南]]] diff --git a/internal/seed/pages/wiki-syntax-guide.ftml b/internal/seed/pages/wiki-syntax-guide.ftml deleted file mode 100644 index 0c806911..00000000 --- a/internal/seed/pages/wiki-syntax-guide.ftml +++ /dev/null @@ -1,1770 +0,0 @@ -以下指南是关于PojectWikit网站整体运行机制以及维基标记语言（wiki markup）相关内容的技术文档。 - -本指南面向具备最低限度 HTML 和 CSS 基础知识的读者；其目标是全面、详尽地描述所有可用功能，并解释为什么某些内容会以目前这种方式运行。 - -[[toc]] - -[[module CSS]] - -#page-content h1, #page-content h2, #page-content h3 { - padding-bottom: 8px; - border-bottom: 1px solid #aaa; - margin-top: 32px; - clear: both; -} - -#page-content h1 + h2, #page-content h2 + h3 { - margin-top: 16px; -} - -code, .code, .code pre { - background: #f7f7f7; - color: #050; - font-weight: 500; - font-family: 'Cascadia Mono', 'Courier New', Courier, FreeMono, monospace; -} - -code { - padding: 4px; - border-radius: 4px; - white-space: nowrap; -} - -.code { - padding: 8px; -} - -.code p, .code pre { - margin: 0; -} - -#page-content dl { - display: grid; - grid-template-columns: max-content max-content; - border: 1px solid #eee; - border-radius: 8px; - float: right; - overflow: hidden; - margin-left: 32px; - margin-bottom: 32px; - background: white; -} - -#page-content dl dd, #page-content dl dt { - padding: 8px; - border-bottom: 1px solid #eee; - margin: 0; -} - -#page-content dl dd { - text-align: right; -} - -.actual-page-content a[href^="#"] { - border-bottom: 1px dotted #050; - color: #050; - text-decoration: none; -} - -.actual-page-content a[href^="#"]:hover { - border-bottom-style: solid; -} - @media (max-width: 700px) { -code { - white-space: wrap; - word-break: break-all; -} - } -[[/module]] - -[[div class="actual-page-content"]] - -+ 引言 - -标记语言分为四种类型： - -* **自动替换** 在文章开始处理之前执行。因此，自动替换允许在文章中添加新的代码，这些代码随后会作为语法被处理。详见 {{[[include]]}} 章节。 - -* **段落划分** 按既定规则自动进行。 - -* **自由语法** 没有严格的格式；每个标记元素可能以完全不可预测的方式被解析。这些元素不总是彼此兼容，也不一定与块级元素兼容。 - -* **块级元素** 具有严格规则；其格式在外观上类似于 HTML 标记或 BBCode。块级元素具有名称、属性、修饰符。那些原则上可以包含其他元素的块级元素，对其所包含元素的类型不作限制（包括其他块级元素）。 - -+ [[# autoreplace]] 自动替换 - -++ {{[[include]]}}：从其他文章插入代码 - -语法： - -[[div class="code"]] -@@[[include 文章名称 参数1 = 值1 | 参数2 = 值2]]@@ -[[/div]] - -为了使该元素正常工作，在起始的 {{[[}} 前面从行首开始不得有任何文本（包括空格）。同样，在结束的 {{]]}} 之后也不能有任何文本。 - -元素 {{[[include]]}}，以及其中的各个参数，都可以占用多行。 - -使用该元素时，系统会访问指定的站点文章，获取其源代码，并将该源代码插入到 {{[[include]]}} 所在的位置。 - -在插入之前，会对指定文章中的所有变量进行自动替换。例如，形如 {{@@{$参数1}@@}} 的变量将被替换为在该元素中指定的对应参数值。 - -由于插入源代码是在“行级”而非“元素级”进行的，因此被嵌入的文章中可以包含完整或部分源代码。同样，{{[[include]]}} 的参数中也可以包含完整或部分源代码。 - -示例： - -* 文章 {{page1}} 中的代码： _ -[[div class="code"]] -@@{$param}@@ -[[/div]] - -* 使用 {{[[include]]}} 的文章中的代码： _ -[[div class="code"]] -@@[[include page1 param=[[div class="code"]] ]]@@ -@@text@@ -@@[[include page1 param=[[/div]] ]]@@ -[[/div]] - -* 结果： _ -[[div class="code"]] -@@[[div class="code"]]@@ -@@text@@ -@@[[/div]]@@ -[[/div]] - -++ {{[[noinclude]]}}：在被插入到其他页面时忽略部分代码 - -语法： - -[[div class="code"]] -@@[[noinclude]]@@ -...任意文本... -@@[[/noinclude]]@@ -[[/div]] - -某些站点组件同时包含可调用代码（组件本身）、使用说明文档以及预览内容。 - -为了防止这些可视化元素被包含到作者文章中，可以使用 {{[[noinclude]]}} 标签。 - -无论是起始还是结束的 {{[[noinclude]]}} 标签，都必须单独占据一整行，否则标签不会生效。这样设计是为了降低误触发或错误触发的概率，例如在记录该功能自身文档时。 - -++ 分类模板 - -分类模板是形如 [[[component:_template|component:_template]]] 的隐藏页面。对于主分类，页面名称为 [[[_default:_template|_template]]]. - -如果为某个分类（例如此处的 {{component}}）指定了模板，那么该模板将会为该分类下的所有文章渲染显示，**而不是文章的实际代码**。同时，模板中支持 [#module-listpages ListPages 模块] 中使用的所有变量。例如，可以通过 {{%%content%%}} 获取原始文章代码。 - -++ [[# path-params]] {{%%path%%}}, {{%%path_expr%%}}, {{%%path_url%%}}：页面参数 - -站点引擎支持通过形如 {{/参数/值}} 的语法在页面地址中传递参数。 - -例如，为了在文章 {{page1}} 中访问参数 {{%%param%%}} 和 {{%%param2%%}}，可以通过如下地址访问： - -{{@@https://projwikit.unitreaty.org/page1/param/example1/param2/example2@@}} - -由于这些变量替换属于自动替换，目标文章可以通过三种方式访问参数： - -* {{%%path|param%%}} 直接将变量值插入文章代码；如果未指定该变量，则插入文本 {{%%path|param%%}}。 - -* {{%%path_expr|param%%}} 以 JSON 字符串格式插入变量值；若未指定，则插入文本 {{"%%path_expr|param%%"}}。这允许在块级元素属性中传递包含特殊字符的复杂值（例如 {{@@[[input type="text" value=%%path_expr|param%%]]@@}} 可确保即便用户使用特殊字符，值也能正确写入）。 - -* {{%%path_url|param%%}} 插入 URL 编码格式的变量值；若未指定，则插入 {{%25%25path_url%7Cparam%25%25}}。这允许在链接或传递给其他页面的参数中使用这些值（例如 {{@@[[module Redirect to="/other_page/param/%%path_url|param%%"]]@@}}）。 - -++ 排版符号的自动替换 - -* {{@<`>@文本@<'>@}} —— 替换为 ‘文本’。 - -* {{@<`>@@<`>@文本@<'>@@<'>@}} —— 替换为 “文本”。 - -* {{@<,>@@<,>@文本@<'>@@<'>@}} —— 替换为 „文本”。 - -[!-- * {{@<.>@@<.>@@<.>@}}, {{@<.>@ @<.>@ @<.>@}} —— 替换为符号 "…". --] [!-- 暂时移除 // jewalky --] - -需要注意的是，由于这些符号替换发生在自动替换阶段，因此可能跨多行发生，甚至包括在 [#literals 字面量]、{{@@[[code]]@@}}、{{@@[[module]]@@}} 等内容中；请务必注意。 - -+ 段落划分 - -系统中所有可以包含其他元素的元素，分为两大类： - -* 行内元素。包括普通文本、所有文本格式元素，以及 {{@@[[span]]@@}} 和其他诸如 {{@@[[image]]@@}}、{{@@[[user]]@@}} 等元素。一般来说，如果该元素默认显示为 {{display: inline}} 或 {{display: inline-block}}，则可视为行内元素。 - -* 全宽元素。包括标题、分隔线、列表、{{@@[[toc]]@@}}、{{@@[[div]]@@}}、{{@@[[blockquote]]@@}}、{{@@[[footnoteblock]]@@}}、{{@@[[collapsible]]@@}} 等。大致对应 {{display: block}}。 - -尽管上文提及 CSS 属性，但该属性的实际值不会影响段落生成，因为元素的分类是在其从标记转换为 HTML 的初始阶段完成的。 - -段落会被创建： - -* 在全宽块级元素中，如果未为其指定修饰符 {{_}}（例如 {{@@[[div_]]@@}}）。_ -该修饰符并非对所有块级元素都可用，详见各元素说明。 - -* 在简单引用块（{{>}}）中。 - -段落不会被创建： - -* 在任何行内元素中。 - -* 在块级表格（{{@@[[table]]@@}}）中。 - -* 在大多数自由语法元素中（{{>}} 除外）。_ -可以通过将所需文本包裹在 {{@@[[div]]@@}} 或 {{@@[[p]]@@}} 中来绕过该限制，例如：_ -[[code]]|| [[div]]第一行 - -第二行[[/div]] || 下一个表格单元格 ||[[/code]]在此示例中，{{@@[[div]]@@}} 内的内容会被包裹为段落，而下一个表格单元格则会被直接作为文本添加。_ -该技巧同样适用于块级表格。 - -要在支持段落的元素中创建或分隔新段落，需要满足以下多个条件： - -* 该行必须是元素中的第一行，或者其上方至少有一整行空行，或者其上方存在一个全宽元素。 - -* 该行必须仅包含行内元素。全宽元素周围不会创建段落。在段落内部插入全宽元素会在该处终止当前段落，并在该全宽元素之后创建新段落。 - -如果在不创建段落的元素中存在文本（根据上述任一条件），文本中的空行将被视为普通换行（{{
}}，而不是 {{

}}）。 - -++ 控制换行 - -如果你希望空行仅作为空行，而不是创建段落，可以使用两种方法： - -* 在该行放置任何视觉上为空的元素（但在段落判定上不视为空）。例如 {{@@[[span]][[/span]]@@}}、{{@<@>@@<@>@@<@>@@<@>@}}、{{@<@<>@@<>@>@}}。 - -* 在该行末尾添加符号 {{_}}。该符号会被明确解释为换行，并且绝不会转换为段落。 - -你也可以在代码分成多行时阻止换行（以及段落创建）。这在编写复杂代码时非常有用，可以保持可读性，同时不在视觉上拆分文本。为此，请在行末添加 {{\}}，则下一行会“粘连”到当前行。例如，下列代码在插入文章后将显示为一行 “abc”： - -[[div class="code"]] -@@a\@@ -@@[[span class="some-class"]]\@@ -@@b\@@ -@@[[/span]]\@@ -@@c@@ -[[/div]] - -+ 自由语法 - -++ 文本格式 - -* {{@@**文本**@@}} —— **粗体** 文本。 - -* {{@@//文本//@@}} —— //斜体// 文本。 - -* {{@@{{文本}}@@}} —— 等宽文本。 - -* {{@@--文本--@@}} —— --删除线-- 文本。 - -* {{@@^^文本^^@@}} —— ^^上标^^ 文本。 - -* {{@@,,文本,,@@}} —— ,,下标,, 文本。 - -* {{@@__文本__@@}} —— __下划线__ 文本。 - -所有上述文本格式化方式都遵循相同的规则： - -* 元素与其内部文本之间不得有空格（例如，{{@@__ 文本 __@@}} 不是正确语法）。 - -* 元素可以跨多行，但不能跨多个段落。 - 正确： -[[code]]//a -b -c//[[/code]] - 错误： -[[code]]//a - -b - -c//[[/code]] - -* 元素内部可以包含任何其他元素，包括块级元素。在使用块级元素的情况下，段落限制将被解除。例如： -[[code]]//[[div]]a - -b - -c[[/div]]//[[/code]] - -同时也支持文本着色： - -* {{@@##颜色|文本##@@}} — ##red|有颜色的## 文本。 - 颜色可以使用任何 CSS 支持的颜色，例如表达式 {{@@##rgba(255, 127, 0, 0.5)|文本##@@}} 是合法的。 - 当使用十六进制值表示颜色（RRGGBB、RRGGBBAA、RGB、RGBA）时，不必额外使用 {{#}} 符号（例如：{{@@##ffe|文本##@@}} 与 {{@@###ffe|文本##@@}} 等效）。 - -++ [[# links]] 链接 - -[[ul]] -[[li]]{{@@[地址 文本]@@}} 或 {{[*地址 文本]}} — 普通链接。 -通常用于外部链接，或在站内文章之间使用参数进行链接，或用于锚点链接（例如：{{@@[#toc-0 指向第一个标题的链接]@@}}）。 -地址不能包含空格，而链接文本可以包含空格。链接文本不得跨多行。 -如果链接以星号 {{*}} 开头，则会在新窗口（标签页）中打开。 -[[/li]] - -[[li]]{{@@[[[文章]]]@@}} 或 {{@@[[[文章|]]]@@}} 或 {{@@[[[文章|链接文本]]]@@}} — 使用完整标识符（地址）创建站内文章链接。 -此类链接会显示在文章的反向链接中；如果目标文章不存在，则会以不同颜色显示。 - -语法变体： - -[[ul]] - [[li]]{{@@[[[category:page1]]]@@}} — 创建指向 {{category:page1}} 的链接，链接文本大致对应文章标识符（符号 {{-}} 会被替换为空格，分类前缀会被移除等）。 - [[/li]] - - [[li]]{{@@[[[category:page1|]]]@@}} — 创建指向 {{category:page1}} 的链接。 - 如果该文章存在，则自动使用其标题作为链接文本；否则使用其标识符。 - [[/li]] - - [[li]]{{@@[[[category:page1|文本]]]@@}} — 创建指向 {{category:page1}} 的链接，并使用指定文本作为链接名称。 - 链接文本同样不得跨多行。 - [[/li]] -[[/ul]] -[[/li]] - -[[li]]自动链接：形如 {{@@http://...@@}}、{{@@ftp://...@@}} 的文本会自动转换为对应链接。 -这种自动替换可能会引发问题并破坏其他语法。如需避免，可以使用 [#literals 字面量]。 -[[/li]] -[[/ul]] - -++ 元素位置控制 - -* {{@@= 文本@@}} — 段落居中。必须放在段落开头使用，此后整个段落（包括后续行）都会居中对齐。 - -* {{@@_@@}} — 显式换行。只能用于行尾。 -例如，可用于防止两个连续空行被合并为一个段落，如下所示： -[[code]]a -_ -_ -b[[/code]] - -此外，{{@@_@@}} 允许在原本不支持换行的元素中插入换行（例如表格或列表）。 -为了正确生效，显式换行符必须与前面的文本或元素之间用空格分隔。 - -* {{@@~~~@@}}、{{@@~~~<@@}}、{{@@~~~>@@}} — 清除浮动元素。 -仅在行首使用时有效。 -分别等同于： -{{@@[[div style="clear: both"]][/div]]@@}} -{{@@[[div style="clear: left"]][[/div]]@@}} -{{@@[[div style="clear: right"]][[/div]]@@}} - -++ [[# headers]] 标题 - -{{@@+ 文本@@}}、 -{{@@++ 文本@@}}、 -{{@@+++ 文本@@}}、 -{{@@++++ 文本@@}}、 -{{@@+++++ 文本@@}}、 -{{@@++++++ 文本@@}} — 分别对应一级至六级标题。 - -不支持六级以上标题。 - -该元素只能在新行使用。 -内部不支持换行，但可以嵌入块级元素或显式换行，例如： - -[[code]]++ 第一行 _ -第二行[[/code]] - -在标题文本前可以添加符号 {{*}}，例如 {{@@++* 文本@@}}。 -此时该标题不会被加入目录。 - -++ 水平线 - -{{@@---@@}} — 添加水平分隔线。 - -该元素只能在新行使用。 -前三个 {{-}} 之后的数量没有限制。 - -++ 引用 - -以下语法会创建两个嵌套的引用块： - -[[code]] -> 第一级 ->> 第二级 ->> 第二级的第二行 -> 回到第一级 -[[/code]] - -由于 {{@@[[blockquote]]@@}} 具有更好的可读性（和可编辑性），因此不推荐使用此语法。 - -++ 列表 - -网站支持三种列表类型：有序列表、无序列表和字典列表。 -前两种可以相互嵌套。 - -示例：无序列表中嵌套有序列表： - -[[code]] -* 元素1 -* 元素2 - # 元素2.1 - # 元素2.2 -* 元素3 -[[/code]] - -列表的嵌套级别由 {{*}} 或 {{#}} 前的空格或制表符数量决定。 - -列表项中可以通过 {{_}} 或使用 {{@@[[span]]@@}} 包裹内容来实现多行，例如： - -[[code]] -* 元素1 _ -下一行 -* [[span]]元素2 -下一行[[/span]] -[[/code]] - -字典列表定义如下： - -[[code]] -: 术语1 : 定义 -: 术语2 : 定义 -: 术语3 : 定义 -[[/code]] - -在术语或定义中同样可以使用 {{_}} 或 {{@@[[span]]@@}}。 - -++ 表格 - -简化（自由）语法的表格如下所示： - -[[code]] -||~ 标题 ||~ 标题2 || -||> 右对齐文本 ||= 居中文本 || -|||| 横向跨越两列的单元格 || -[[/code]] - -要在单元格中添加多行文本，可以使用 {{_}} 或 {{@@[[span]]@@}}。 - -该元素无法创建跨越多行（纵向合并）的单元格。在这种情况下，可以使用块级元素 {{@@[[table]]@@}}，它不受此限制。 - -++ 其他 - -* {{@@[[# anchor]]@@}} — 创建一个具有指定标识符的元素，从而可以通过链接跳转到该位置（例如：{{@@[#anchor 跳转到锚点]@@}}）。 - 该元素在视觉上类似于块级元素，但实际上并不是。 - 在元素定义中，{{#}} 后必须保留一个空格。 - -* {{@@[!-- 注释 --]@@}} — 定义一段在最终页面显示时不会呈现的源代码区域。 - 可用于在代码中添加技术性备注。 - [!-- 我就知道你会看到这里。 --] - -* [[# literals]]{{@<@@>@文本@<@@>@}} — 阻止 {{@<@@>@}} 包裹的内容被当作标记语法解析。 - 始终生成一行文本（字面量）。 - 可用于在出于视觉效果使用标记符号时避免歧义（例如，并非链接用途的单个方括号）。 - 也可用于破坏自动替换语法（当不希望发生自动替换时），例如： - {{%%pat@<@@>@h|param%%}} 始终会显示为文本 %%pat@@@@h|param%%，即便指定了参数 {{param}}。 - 也可用于像 {{_}} 那样创建空行（但不推荐这样使用）。 - -* {{@<@<>@—©@<>@>@}} — 插入指定的 HTML 实体符号（或多个符号）。 - -* 符号 «、» 和 — 的替换 -_ -_ -由于这些替换不属于自动替换，因此在仅支持纯文本的场景下不会生效（例如块属性或链接名称中）。 - - * {{@@ <<@@}} — 左引号：« - - * {{@@ >>@@}} — 右引号：» - - * {{@@ --@@}} — 长破折号：— - 需要注意的是，为了使该元素被解析为破折号而不是删除线语法，其两侧必须有空格。 - -+ 块级元素 - -所有块级元素都遵循类似规则构建。 - -每个块级元素都有名称（例如 {{div}}、{{iftags}}、{{blockquote}} 等）、可选的标识符，以及一个起始标签（例如 {{@@[[div]]@@}}）。 -可以包含文本或其他块级元素的块级元素，还必须有与起始标签对应名称的结束标签（例如 {{@@[[/div]]@@}}）。 - -某些块可以使用修饰符 {{_}}。 -该修饰符写在块名称之后，用于阻止在块内自动创建段落（文本会直接放入块中，换行通过 {{
}} 实现）。 -修饰符只写在起始标签中，因此以下语法是正确的： -[[code]][[div_]]text[[/div]][[/code]] - -块的标识符是可选文本，写在块名称之后（但在修饰符 {{_}} 之前），通过 {{:}} 指定。例如： - -[[code]] -[[module:lu ListUsers]] - [[module CSS]] - body { - background: url(%%avatar%%); - } - [[/module]] -[[/module:lu]] -[[/code]] - -块标识符允许在接受文本内容的块（如 {{@@[[code]]@@}}、{{@@[[module]]@@}}、{{@@[[html]]@@}}）内部使用该块的标准结束标签，而不会真正关闭它。 -这样可以将多个模块相互嵌套，或在该块内部写出 {{@@[[code]]@@}} 的示例： - -[[code:outer]] -[[code:2]] - [[code:b]] - 示例：使用块 [[cоde]] - [[/code:b]] -[[/code:2]] -[[/code:outer]] - -大多数块可以以某种形式接受属性（要么是 HTML 属性，要么是特定块自定义属性）。 -属性写法为 {{参数=值}} 或 {{参数="值"}}。 -不同于 HTML，在属性值中使用特殊字符时，不使用 HTML 实体（如 {{"}}），而是通过 {{\}} 转义： -例如 {{@@[[collapsible show="协议 \"忧郁\""]]@@}}。 - -++ [[# html-attributes]] 标准 HTML 属性 - -某些元素（例如 {{@@[[a]]@@}}、{{@@[[span]]@@}} 等）是 HTML 的直接接口， -其标记中的属性会直接插入生成的 HTML 页面中。 - -并非所有 HTML 属性都允许在标记中使用。 -允许使用的属性列表如下；更多详情请参阅 -https://www.w3schools.com/tags/ref_attributes.asp 的 HTML 文档。 -在本网站语境中最常用的属性已用 ##red|红色## 标出。 - -* {{##red|alt##}} -* {{##red|class##}} -* {{##red|colspan##}} -* {{##red|href##}} -* {{##red|id##}}：该属性会被特殊处理。标识符必须以 {{u-}} 作为前缀。如果未指定此前缀，系统会自动添加。例如，{{id="myid"}} 将会被转换为 {{id="u-myid"}}。 -* {{##red|rowspan##}} -* {{##red|style##}} -* {{##red|target##}} -* {{accept}} -* {{align}} -* {{autocapitalize}} -* {{autoplay}} -* {{background}} -* {{bgcolor}} -* {{border}} -* {{buffered}} -* {{checked}} -* {{cite}} -* {{cols}} -* {{contenteditable}} -* {{controls}} -* {{coords}} -* {{datetime}} -* {{decoding}} -* {{default}} -* {{dir}} -* {{dirname}} -* {{disabled}} -* {{download}} -* {{draggable}} -* {{for}} -* {{form}} -* {{headers}} -* {{height}} -* {{hidden}} -* {{high}} -* {{hreflang}} -* {{inputmode}} -* {{ismap}} -* {{itemprop}} -* {{kind}} -* {{label}} -* {{lang}} -* {{list}} -* {{loop}} -* {{low}} -* {{max}} -* {{maxlength}} -* {{min}} -* {{minlength}} -* {{multiple}} -* {{muted}} -* {{name}} -* {{optimum}} -* {{pattern}} -* {{placeholder}} -* {{poster}} -* {{preload}} -* {{readonly}} -* {{required}} -* {{reversed}} -* {{role}} -* {{rows}} -* {{scope}} -* {{selected}} -* {{shape}} -* {{size}} -* {{sizes}} -* {{span}} -* {{spellcheck}} -* {{src}} -* {{srclang}} -* {{srcset}} -* {{start}} -* {{step}} -* {{tabindex}} -* {{title}} -* {{translate}} -* {{type}} -* {{usemap}} -* {{value}} -* {{width}} -* {{wrap}} -* {{scrolling}} -* {{frameborder}} - -++ [[# booleans]] 布尔属性 - -文档中标记为可接受布尔值的属性，在实际使用中可以用以下字符串表示： - -True： - -* {{true}} -* {{t}} -* {{1}} -* {{yes}} - -False： - -* {{false}} -* {{f}} -* {{0}} -* {{no}} - -同样适用于以下内置 HTML 属性： - -* {{allowfullscreen}} -* {{allowpaymentrequest}} -* {{async}} -* {{autofocus}} -* {{autoplay}} -* {{checked}} -* {{controls}} -* {{default}} -* {{disabled}} -* {{formnovalidate}} -* {{hidden}} -* {{ismap}} -* {{itemscope}} -* {{loop}} -* {{multiple}} -* {{muted}} -* {{nomodule}} -* {{novalidate}} -* {{open}} -* {{playsinline}} -* {{readonly}} -* {{required}} -* {{reversed}} -* {{selected}} -* {{truespeed}} - -++ {{@@[[<]]@@}}、{{@@[[>]]@@}}、{{@@[[=]]@@}}、{{@@[[==]]@@}}：对齐 - -: 类型 : 全宽 -: 段落 : ✅ -: 支持属性 : ❌ - -* {{@@[[<]]@@}} — 将内部文本左对齐。 - -* {{@@[[>]]@@}} — 将内部文本右对齐。 - -* {{@@[[=]]@@}} — 将内部文本居中对齐。 - -* {{@@[[==]]@@}} — 将内部文本两端对齐。 - -++ {{@@[[a]]@@}}：链接 - -: 类型 : 行内 -: 别名 : {{@@[[anchor]]@@}} -: 支持 [#html-attributes HTML 属性] : ✅ -: 支持 {{*}} : ✅ -: 支持 {{_}} : ✅ - -使用修饰符 {{*}}（例如 {{@@[[*a href="https://google.com"]]Google[[/a]]@@}}）等同于使用 {{target="_blank"}}；该链接会在新窗口（标签页）中打开。 -若同时使用该修饰符和 {{target}}，其值将会叠加。 - -通过该元素创建的链接会经过 [#link-handling 标准过滤]。 - -++ {{@@[[blockquote]]@@}}：引用块 - -: 类型 : 全宽 -: 段落 : ✅ -: 别名 : {{@@[[quote]]@@}} -: 支持 [#html-attributes HTML 属性] : ✅ - -在功能上等同于使用 {{>}}，但在标记层面更加“干净”和易读。 - -++ {{@@[[b]]@@}}：加粗文本 - -: 类型 : 行内 -: 别名 : {{@@[[bold]]@@}}、{{@@[[strong]]@@}} -: 支持 [#html-attributes HTML 属性] : ✅ - -++ {{@@[[char]]@@}}：HTML 字符 - -: 类型 : 行内 -: 别名 : {{@@[[character]]@@}} -: 支持属性 : ❌ - -在文本中插入一个 HTML 实体字符。 -其工作方式与 {{@<@<>@@<>@>@}} 语法几乎相同。 - -使用示例：{{@@[[char —]]@@}} - -++ {{@@[[code]]@@}}：代码块 - -: 类型 : 全宽 -: 段落 : ❌ -: 支持属性 : ✅ - -允许忽略 {{@@[[code]]@@}} 与 {{@@[[/code]]@@}} 之间的标记规则。 -主要用于展示标记示例而不被立即解析。 - -该元素也可用于代码高亮。 - -通过该元素添加到页面的代码，可以通过如下格式的单独文件访问： - -{{@@https@@://files.projwikit.unitreaty.org/local@@--@@code/<页面名称>/<页面中的代码块编号，从 1 开始>}} - -对于 HTML、JavaScript、XML、CSS 语言，将设置对应的 MIME 类型， -从而可以在 {{` +} diff --git a/internal/update/board_test.go b/internal/update/board_test.go new file mode 100644 index 00000000..d7f6694d --- /dev/null +++ b/internal/update/board_test.go @@ -0,0 +1,79 @@ +package update + +import ( + "net/http" + "net/http/httptest" + "strconv" + "strings" + "testing" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/i18n" +) + +func boardWith(t *testing.T, st db.UpdateState, s Settings) *Board { + t.Helper() + bundle, err := i18n.Load("") + if err != nil { + t.Fatal(err) + } + return &Board{Bundle: bundle, Settings: s, Current: "v1.0.0", state: st, loaded: time.Now()} +} + +func serveThrough(b *Board, contentType, body string) *httptest.ResponseRecorder { + next := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", contentType) + w.Write([]byte(body)) + }) + rec := httptest.NewRecorder() + b.Wrap(next).ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/", nil)) + return rec +} + +func TestWrapAddsTheBannerBeforeTheBodyEnds(t *testing.T) { + at := time.Now().Add(10 * time.Minute) + b := boardWith(t, db.UpdateState{ScheduledVersion: "v1.1.0", ScheduledAt: &at}, defaultSettings()) + + rec := serveThrough(b, "text/html; charset=utf-8", "

page
") + got := rec.Body.String() + if !strings.Contains(got, `id="pwikit-update-banner"`) { + t.Fatalf("page = %q, want the banner in it", got) + } + if strings.Index(got, "pwikit-update-banner") > strings.Index(got, "") { + t.Errorf("page = %q, want the banner before ", got) + } + if !strings.Contains(got, `
page
`) { + t.Errorf("page = %q, want the page's own markup unchanged", got) + } + if want := strconv.Itoa(len(got)); rec.Header().Get("Content-Length") != want { + t.Errorf("Content-Length = %q, want %s", rec.Header().Get("Content-Length"), want) + } +} + +func TestWrapLeavesOtherResponsesAlone(t *testing.T) { + soon := time.Now().Add(10 * time.Minute) + later := time.Now().Add(3 * time.Hour) + private := defaultSettings() + private.PublicBanner = false + + cases := []struct { + name string + st db.UpdateState + s Settings + contentType string + }{ + {"json", db.UpdateState{ScheduledVersion: "v1.1.0", ScheduledAt: &soon}, defaultSettings(), "application/json"}, + {"not yet announced", db.UpdateState{ScheduledVersion: "v1.1.0", ScheduledAt: &later}, defaultSettings(), "text/html"}, + {"nothing scheduled", db.UpdateState{}, defaultSettings(), "text/html"}, + {"banner for admins only", db.UpdateState{ScheduledVersion: "v1.1.0", ScheduledAt: &soon}, private, "text/html"}, + } + for _, tt := range cases { + t.Run(tt.name, func(t *testing.T) { + rec := serveThrough(boardWith(t, tt.st, tt.s), tt.contentType, "x") + if strings.Contains(rec.Body.String(), "pwikit-update-banner") { + t.Errorf("body = %q, want no banner", rec.Body.String()) + } + }) + } +} diff --git a/internal/update/disk_unix.go b/internal/update/disk_unix.go new file mode 100644 index 00000000..9ab77c19 --- /dev/null +++ b/internal/update/disk_unix.go @@ -0,0 +1,50 @@ +//go:build unix + +package update + +import ( + "io/fs" + "os" + "path/filepath" + "syscall" + + "golang.org/x/sys/unix" +) + +func FreeBytes(dir string) (uint64, error) { + var st unix.Statfs_t + if err := unix.Statfs(dir, &st); err != nil { + return 0, err + } + return uint64(st.Bavail) * uint64(st.Bsize), nil +} + +func ChownTree(root string, like string) error { + info, err := os.Stat(like) + if err != nil { + return err + } + st, ok := info.Sys().(*syscall.Stat_t) + if !ok || os.Geteuid() != 0 { + return nil + } + uid, gid := int(st.Uid), int(st.Gid) + return filepath.WalkDir(root, func(path string, _ fs.DirEntry, err error) error { + if err != nil { + return err + } + return os.Lchown(path, uid, gid) + }) +} + +func Owner(path string) (uint32, uint32, bool) { + info, err := os.Stat(path) + if err != nil { + return 0, 0, false + } + st, ok := info.Sys().(*syscall.Stat_t) + if !ok { + return 0, 0, false + } + return st.Uid, st.Gid, true +} diff --git a/internal/update/disk_windows.go b/internal/update/disk_windows.go new file mode 100644 index 00000000..774464bc --- /dev/null +++ b/internal/update/disk_windows.go @@ -0,0 +1,21 @@ +//go:build windows + +package update + +import "golang.org/x/sys/windows" + +func FreeBytes(dir string) (uint64, error) { + path, err := windows.UTF16PtrFromString(dir) + if err != nil { + return 0, err + } + var free, total, all uint64 + if err := windows.GetDiskFreeSpaceEx(path, &free, &total, &all); err != nil { + return 0, err + } + return free, nil +} + +func ChownTree(string, string) error { return nil } + +func Owner(string) (uint32, uint32, bool) { return 0, 0, false } diff --git a/internal/update/files.go b/internal/update/files.go new file mode 100644 index 00000000..76233323 --- /dev/null +++ b/internal/update/files.go @@ -0,0 +1,139 @@ +package update + +import ( + "errors" + "fmt" + "io" + "io/fs" + "os" + "path/filepath" + "strings" + "time" +) + +func CopyTree(src, dst string) error { + return filepath.WalkDir(src, func(path string, d fs.DirEntry, err error) error { + if err != nil { + return err + } + rel, err := filepath.Rel(src, path) + if err != nil { + return err + } + target := filepath.Join(dst, rel) + info, err := d.Info() + if err != nil { + return err + } + switch { + case d.IsDir(): + return os.MkdirAll(target, info.Mode().Perm()|0o700) + case info.Mode()&fs.ModeSymlink != 0: + link, err := os.Readlink(path) + if err != nil { + return err + } + return os.Symlink(link, target) + case !info.Mode().IsRegular(): + return nil + case rel == "postmaster.pid": + return nil + } + return copyFile(path, target, info.Mode().Perm()) + }) +} + +func copyFile(from, to string, mode fs.FileMode) error { + in, err := os.Open(from) + if err != nil { + return err + } + defer in.Close() + out, err := os.OpenFile(to, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, mode) + if err != nil { + return err + } + if _, err := io.Copy(out, in); err != nil { + out.Close() + return err + } + return out.Close() +} + +func CopyFile(from, to string) error { + info, err := os.Stat(from) + if err != nil { + return err + } + tmp := to + ".part" + if err := copyFile(from, tmp, info.Mode().Perm()); err != nil { + os.Remove(tmp) + return err + } + return os.Rename(tmp, to) +} + +func TreeSize(dir string) (int64, error) { + var total int64 + err := filepath.WalkDir(dir, func(_ string, d fs.DirEntry, err error) error { + if err != nil { + return err + } + if d.Type().IsRegular() { + info, err := d.Info() + if err != nil { + return err + } + total += info.Size() + } + return nil + }) + return total, err +} + +// Windows refuses to overwrite a running program but lets it be renamed, and +// the updater is itself that program. +func Replace(current, next, keep string) error { + os.Remove(keep) + if err := os.Rename(current, keep); err != nil { + return fmt.Errorf("move %s aside: %w", current, err) + } + if err := os.Rename(next, current); err != nil { + if restoreErr := os.Rename(keep, current); restoreErr != nil { + return fmt.Errorf("put %s in place: %w; and the old one could not be put back: %v", next, err, restoreErr) + } + return fmt.Errorf("put %s in place: %w", next, err) + } + return nil +} + +const lockName = "update.lock" + +var ErrBusy = errors.New("another pwikit update is running") + +const staleLock = 6 * time.Hour + +func Lock(dir string) (func(), error) { + if err := os.MkdirAll(dir, 0o755); err != nil { + return nil, err + } + path := filepath.Join(dir, lockName) + for attempt := 0; attempt < 2; attempt++ { + f, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0o644) + if err == nil { + fmt.Fprintf(f, "%d\n", os.Getpid()) + f.Close() + return func() { os.Remove(path) }, nil + } + if !errors.Is(err, fs.ErrExist) { + return nil, err + } + info, statErr := os.Stat(path) + if statErr != nil || time.Since(info.ModTime()) < staleLock { + holder, _ := os.ReadFile(path) + return nil, fmt.Errorf("%w (process %s)", ErrBusy, strings.TrimSpace(string(holder))) + } + os.Remove(path) + } + return nil, ErrBusy +} diff --git a/internal/update/maintenance.go b/internal/update/maintenance.go new file mode 100644 index 00000000..3021f942 --- /dev/null +++ b/internal/update/maintenance.go @@ -0,0 +1,45 @@ +package update + +import ( + "net/http" + "strings" + + "github.com/WikitTeam/ProjectWikit/internal/i18n" + "github.com/WikitTeam/ProjectWikit/internal/shell" + "github.com/WikitTeam/ProjectWikit/internal/static" +) + +func MaintenanceHandler(bundle *i18n.Bundle, assets *static.Assets, files http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if strings.HasPrefix(r.URL.Path, static.Prefix) && files != nil { + files.ServeHTTP(w, r) + return + } + loc := bundle.Localizer(bundle.Match(r.Header.Get(i18n.AcceptHeader))) + render := shell.New(loc, assets) + body, err := render.Notice(shell.Notice{ + Heading: loc.T("update.maintenance-title"), + Body: loc.T("update.maintenance"), + }) + if err != nil { + http.Error(w, http.StatusText(http.StatusServiceUnavailable), http.StatusServiceUnavailable) + return + } + var out strings.Builder + if err := render.SystemPage(&out, shell.System{ + Title: loc.T("update.maintenance-title"), + BodyClass: "wikit-page", + Content: body, + }); err != nil { + http.Error(w, http.StatusText(http.StatusServiceUnavailable), http.StatusServiceUnavailable) + return + } + w.Header().Set("Content-Type", "text/html; charset=utf-8") + w.Header().Set("Cache-Control", "no-store") + w.Header().Set("Retry-After", "120") + w.WriteHeader(http.StatusServiceUnavailable) + if r.Method != http.MethodHead { + _, _ = w.Write([]byte(out.String())) + } + }) +} diff --git a/internal/update/manifest.go b/internal/update/manifest.go new file mode 100644 index 00000000..043551f1 --- /dev/null +++ b/internal/update/manifest.go @@ -0,0 +1,69 @@ +package update + +import ( + "encoding/json" + "fmt" + "time" +) + +const ( + ManifestName = "latest.json" + ChecksumsName = "SHA256SUMS" + ManifestFormat = 1 +) + +type Manifest struct { + Format int `json:"format"` + Version string `json:"version"` + PublishedAt string `json:"published_at"` + Notes string `json:"notes"` + Postgres string `json:"postgres"` + Packages map[string]Package `json:"packages"` +} + +type Package struct { + File string `json:"file"` + SHA256 string `json:"sha256"` + Size int64 `json:"size"` +} + +func ParseManifest(body []byte) (Manifest, error) { + var m Manifest + if err := json.Unmarshal(body, &m); err != nil { + return Manifest{}, fmt.Errorf("read %s: %w", ManifestName, err) + } + if m.Format > ManifestFormat { + return Manifest{}, fmt.Errorf("%s is format %d and this pwikit reads up to %d; update by hand once", ManifestName, m.Format, ManifestFormat) + } + if _, ok := ParseVersion(m.Version); !ok { + return Manifest{}, fmt.Errorf("%s names %q, which is not a release", ManifestName, m.Version) + } + return m, nil +} + +func (m Manifest) Published() time.Time { + at, err := time.Parse(time.RFC3339, m.PublishedAt) + if err != nil { + return time.Time{} + } + return at +} + +func PackageFile(version, goos, goarch string) string { + base := "pwikit-" + version + "-" + goos + "-" + goarch + if goos == "windows" { + return base + ".zip" + } + return base + ".tar.gz" +} + +func PackageDir(version, goos, goarch string) string { + return "pwikit-" + version + "-" + goos + "-" + goarch +} + +func ExecutableName(goos string) string { + if goos == "windows" { + return "pwikit.exe" + } + return "pwikit" +} diff --git a/internal/update/runtime.go b/internal/update/runtime.go new file mode 100644 index 00000000..8d398460 --- /dev/null +++ b/internal/update/runtime.go @@ -0,0 +1,143 @@ +package update + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "net" + "net/http" + "os" + "path/filepath" + "time" +) + +const ( + RuntimeFile = "serve.json" + HealthPath = "/-/health" +) + +type Runtime struct { + PID int `json:"pid"` + Version string `json:"version"` + StartedAt time.Time `json:"started_at"` + Health string `json:"health"` + + Mode string `json:"mode"` + Plain string `json:"plain"` + Secure string `json:"secure"` + CertFile string `json:"cert_file"` + KeyFile string `json:"key_file"` + CacheDir string `json:"cache_dir"` + Email string `json:"email"` + Directory string `json:"directory"` + Hosts []string `json:"hosts"` +} + +func WriteRuntime(dir string, r Runtime) error { + if err := os.MkdirAll(dir, 0o755); err != nil { + return err + } + body, err := json.MarshalIndent(r, "", " ") + if err != nil { + return err + } + path := filepath.Join(dir, RuntimeFile) + tmp := path + ".part" + if err := os.WriteFile(tmp, body, 0o644); err != nil { + return err + } + return os.Rename(tmp, path) +} + +func ReadRuntime(dir string) (Runtime, error) { + body, err := os.ReadFile(filepath.Join(dir, RuntimeFile)) + if err != nil { + return Runtime{}, err + } + var r Runtime + if err := json.Unmarshal(body, &r); err != nil { + return Runtime{}, fmt.Errorf("read %s: %w", RuntimeFile, err) + } + return r, nil +} + +type Health struct { + Version string `json:"version"` + Database bool `json:"database"` + Page int `json:"page"` + Problem string `json:"problem,omitempty"` +} + +func (h Health) OK() bool { + return h.Problem == "" && h.Database && h.Page > 0 && h.Page < 500 && h.Page != http.StatusNotFound +} + +func HealthHandler(check func(context.Context) Health) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if r.URL.Path != HealthPath { + http.NotFound(w, r) + return + } + ctx, cancel := context.WithTimeout(r.Context(), 30*time.Second) + defer cancel() + h := check(ctx) + w.Header().Set("Content-Type", "application/json") + if !h.OK() { + w.WriteHeader(http.StatusServiceUnavailable) + } + _ = json.NewEncoder(w).Encode(h) + }) +} + +func ListenHealth() (net.Listener, error) { + return net.Listen("tcp", "127.0.0.1:0") +} + +func WaitHealthy(ctx context.Context, dir, want string, since time.Time, within time.Duration) (Health, error) { + deadline := time.Now().Add(within) + client := &http.Client{Timeout: 45 * time.Second} + last := errors.New("the server has not written its runtime record yet") + for time.Now().Before(deadline) { + if err := ctx.Err(); err != nil { + return Health{}, err + } + rt, err := ReadRuntime(dir) + switch { + case err != nil: + case rt.StartedAt.Before(since): + last = errors.New("the server has not started again yet") + case rt.Version != want: + return Health{}, fmt.Errorf("the server that started is %s, not %s", rt.Version, want) + default: + h, err := probe(ctx, client, rt.Health) + if err == nil && h.OK() { + return h, nil + } + if err != nil { + last = err + } else { + last = fmt.Errorf("the health check answered database=%t page=%d %s", h.Database, h.Page, h.Problem) + } + } + time.Sleep(2 * time.Second) + } + return Health{}, fmt.Errorf("no healthy %s within %s: %w", want, within, last) +} + +func probe(ctx context.Context, client *http.Client, addr string) (Health, error) { + req, err := http.NewRequestWithContext(ctx, http.MethodGet, "http://"+addr+HealthPath, nil) + if err != nil { + return Health{}, err + } + resp, err := client.Do(req) + if err != nil { + return Health{}, err + } + defer resp.Body.Close() + var h Health + if err := json.NewDecoder(resp.Body).Decode(&h); err != nil { + return Health{}, fmt.Errorf("read the health answer: %w", err) + } + return h, nil +} diff --git a/internal/update/schedule.go b/internal/update/schedule.go new file mode 100644 index 00000000..c285735a --- /dev/null +++ b/internal/update/schedule.go @@ -0,0 +1,308 @@ +package update + +import ( + "fmt" + "math/rand/v2" + "slices" + "strconv" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +const ( + AnnounceAhead = 30 * time.Minute + DefaultWindow = "03:00-05:00" + DefaultMinAge = 24 * time.Hour + + MissedAfter = 2 * time.Hour + + RollbackKept = 7 * 24 * time.Hour + PostponeFor = 24 * time.Hour + UpdatedShown = 24 * time.Hour +) + +type Settings struct { + Auto bool + PublicBanner bool + Check bool + Window Window + MinAge time.Duration + Mirror string +} + +type Window struct { + start time.Duration + end time.Duration +} + +func ParseWindow(s string) (Window, error) { + from, to, ok := strings.Cut(strings.ReplaceAll(s, " ", ""), "-") + if !ok { + return Window{}, fmt.Errorf("update window %q is not two times such as 03:00-05:00", s) + } + start, err := clock(from) + if err != nil { + return Window{}, fmt.Errorf("update window %q: %w", s, err) + } + end, err := clock(to) + if err != nil { + return Window{}, fmt.Errorf("update window %q: %w", s, err) + } + w := Window{start: start, end: end} + if w.length() < AnnounceAhead+time.Minute { + return Window{}, fmt.Errorf("update window %q is shorter than the %s an update is announced ahead", s, AnnounceAhead) + } + return w, nil +} + +func clock(s string) (time.Duration, error) { + h, m, ok := strings.Cut(s, ":") + hours, herr := strconv.Atoi(h) + minutes, merr := strconv.Atoi(m) + if !ok || herr != nil || merr != nil || hours < 0 || hours > 23 || minutes < 0 || minutes > 59 { + return 0, fmt.Errorf("%q is not a time such as 03:00", s) + } + return time.Duration(hours)*time.Hour + time.Duration(minutes)*time.Minute, nil +} + +func (w Window) length() time.Duration { + if w.end > w.start { + return w.end - w.start + } + return 24*time.Hour - w.start + w.end +} + +func (w Window) String() string { + format := func(d time.Duration) string { + return fmt.Sprintf("%02d:%02d", int(d.Hours()), int(d.Minutes())%60) + } + return format(w.start) + "-" + format(w.end) +} + +func (w Window) NextCheck(now time.Time, r *rand.Rand) time.Time { + span := w.length() - AnnounceAhead + midnight := time.Date(now.Year(), now.Month(), now.Day(), 0, 0, 0, 0, now.Location()) + base := midnight.Add(w.start) + if !base.Add(span).After(now) { + midnight = midnight.AddDate(0, 0, 1) + base = midnight.Add(w.start) + } + at := base.Add(time.Duration(r.Int64N(int64(span)))) + if !at.After(now) { + at = now.Add(time.Minute) + } + return at +} + +type Facts struct { + Current string + + BundledPostgres string + + Container bool + Now time.Time +} + +type Reason struct { + Code string + Detail string +} + +var reasonText = map[string]string{ + "check-off": "checking for releases is off", + "container": "pwikit runs in a container, where a new image replaces it", + "unknown": "no release is known yet", + "no-number": "this build carries no release number", + "newest": "this is the newest release", + "pinned": "held at %s until pwikit update unpin", + "auto-off": "automatic updates are off", + "skipped": "%s was skipped", + "failed": "%s failed before and was rolled back", + "postponed": "postponed until %s", + "too-new": "released less than %s hours ago", + "postgres": "it moves the bundled PostgreSQL to %s, which pwikit update does by hand", +} + +func (r Reason) String() string { + text := reasonText[r.Code] + if strings.Contains(text, "%s") { + return fmt.Sprintf(text, r.Detail) + } + return text +} + +func Eligible(st db.UpdateState, s Settings, f Facts) (string, Reason) { + latest := st.LatestVersion + no := func(code, detail string) (string, Reason) { return "", Reason{Code: code, Detail: detail} } + switch { + case !s.Check: + return no("check-off", "") + case f.Container: + return no("container", "") + case latest == "": + return no("unknown", "") + case !isRelease(f.Current): + return no("no-number", "") + case !Newer(latest, f.Current): + return no("newest", "") + case st.PinnedVersion != "": + return no("pinned", st.PinnedVersion) + case !s.Auto: + return no("auto-off", "") + case st.SkippedVersion == latest: + return no("skipped", latest) + case slices.Contains(st.FailedVersions, latest): + return no("failed", latest) + case st.PostponedUntil != nil && f.Now.Before(*st.PostponedUntil): + return no("postponed", st.PostponedUntil.Format(time.RFC3339)) + case st.LatestPublishedAt != nil && f.Now.Sub(*st.LatestPublishedAt) < s.MinAge: + return no("too-new", strconv.FormatFloat(s.MinAge.Hours(), 'f', -1, 64)) + case f.BundledPostgres != "" && st.LatestPostgres != "" && + PostgresMajor(st.LatestPostgres) != PostgresMajor(f.BundledPostgres): + return no("postgres", PostgresMajor(st.LatestPostgres)) + } + return latest, Reason{} +} + +func isRelease(v string) bool { + _, ok := ParseVersion(v) + return ok +} + +func Tick(st *db.UpdateState, s Settings, f Facts, fetch func() (Manifest, error), r *rand.Rand) string { + now := f.Now + if !s.Check { + clearSchedule(st) + return "" + } + if st.NextCheckAt == nil { + next := s.Window.NextCheck(now, r) + st.NextCheckAt = &next + return "" + } + if !now.Before(*st.NextCheckAt) { + checked := now + st.CheckedAt = &checked + if m, err := fetch(); err != nil { + st.CheckError = err.Error() + } else { + st.CheckError = "" + st.LatestVersion = m.Version + st.LatestPostgres = m.Postgres + st.LatestNotes = m.Notes + if published := m.Published(); !published.IsZero() { + st.LatestPublishedAt = &published + } else { + st.LatestPublishedAt = nil + } + } + next := s.Window.NextCheck(now.Add(time.Minute), r) + st.NextCheckAt = &next + if version, _ := Eligible(*st, s, f); version != "" { + if st.ScheduledVersion == "" || st.ScheduledAt == nil { + at := now.Add(AnnounceAhead) + st.ScheduledAt = &at + } + st.ScheduledVersion = version + } + } + + if st.ScheduledVersion == "" || st.ScheduledAt == nil { + return "" + } + version, _ := Eligible(*st, s, f) + if version == "" || now.After(st.ScheduledAt.Add(MissedAfter)) { + clearSchedule(st) + return "" + } + st.ScheduledVersion = version + if now.Before(*st.ScheduledAt) { + return "" + } + return version +} + +func clearSchedule(st *db.UpdateState) { + st.ScheduledVersion = "" + st.ScheduledAt = nil +} + +func Postpone(st *db.UpdateState, now time.Time) { + until := now.Add(PostponeFor) + st.PostponedUntil = &until + clearSchedule(st) +} + +func Skip(st *db.UpdateState) string { + version := st.ScheduledVersion + if version == "" { + version = st.LatestVersion + } + st.SkippedVersion = version + clearSchedule(st) + return version +} + +func Banner(st db.UpdateState, s Settings, now time.Time) (time.Time, bool) { + if !s.Auto || !s.PublicBanner || st.ScheduledVersion == "" || st.ScheduledAt == nil { + return time.Time{}, false + } + at := *st.ScheduledAt + if now.Before(at.Add(-AnnounceAhead)) || now.After(at.Add(MissedAfter)) { + return time.Time{}, false + } + return at, true +} + +type NoticeKind string + +const ( + NoticeScheduled NoticeKind = "scheduled" + NoticeAvailable NoticeKind = "available" + NoticeUpdated NoticeKind = "updated" + NoticeRolledBack NoticeKind = "rolled-back" +) + +type Notice struct { + Kind NoticeKind + Version string + From string + At time.Time + Reason Reason + Error string + Notes string +} + +func Notices(st db.UpdateState, s Settings, f Facts) []Notice { + var out []Notice + if st.LastOutcome == OutcomeRolledBack && st.LastAt != nil && f.Now.Sub(*st.LastAt) < RollbackKept { + out = append(out, Notice{Kind: NoticeRolledBack, Version: st.LastTo, From: st.LastFrom, At: *st.LastAt, Error: st.LastError}) + } + if st.LastOutcome == OutcomeUpdated && st.LastAt != nil && f.Now.Sub(*st.LastAt) < UpdatedShown && st.LastTo == f.Current { + out = append(out, Notice{Kind: NoticeUpdated, Version: st.LastTo, From: st.LastFrom, At: *st.LastAt, Notes: releaseNotes(st.LastTo, st)}) + } + if st.ScheduledVersion != "" && st.ScheduledAt != nil && s.Auto { + out = append(out, Notice{Kind: NoticeScheduled, Version: st.ScheduledVersion, At: *st.ScheduledAt, Notes: st.LatestNotes}) + return out + } + if Newer(st.LatestVersion, f.Current) { + _, reason := Eligible(st, s, f) + out = append(out, Notice{Kind: NoticeAvailable, Version: st.LatestVersion, Reason: reason, Notes: st.LatestNotes}) + } + return out +} + +func releaseNotes(version string, st db.UpdateState) string { + if st.LatestVersion == version { + return st.LatestNotes + } + return "" +} + +const ( + OutcomeUpdated = "updated" + OutcomeRolledBack = "rolled-back" + OutcomeFailed = "failed" +) diff --git a/internal/update/schedule_test.go b/internal/update/schedule_test.go new file mode 100644 index 00000000..e6d22958 --- /dev/null +++ b/internal/update/schedule_test.go @@ -0,0 +1,209 @@ +package update + +import ( + "errors" + "math/rand/v2" + "testing" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/db" +) + +func TestNewer(t *testing.T) { + cases := []struct { + candidate, current string + want bool + }{ + {"v1.0.1", "v1.0.0", true}, + {"v1.1.0", "v1.0.9", true}, + {"v2.0.0", "v1.99.99", true}, + {"v1.0.0", "v1.0.0", false}, + {"v1.0.0", "v1.0.1", false}, + {"v1.0.0", "v1.0.0-rc.1", true}, + {"v1.0.0-rc.2", "v1.0.0-rc.1", true}, + {"v1.0.0-rc.10", "v1.0.0-rc.9", true}, + {"v1.0.0-rc.1", "v1.0.0", false}, + {"v1.0.1", "cf4ec6467c79", false}, + {"nonsense", "v1.0.0", false}, + } + for _, tt := range cases { + if got := Newer(tt.candidate, tt.current); got != tt.want { + t.Errorf("Newer(%q, %q) = %t, want %t", tt.candidate, tt.current, got, tt.want) + } + } +} + +func TestParseWindow(t *testing.T) { + for _, bad := range []string{"", "03:00", "3-5", "25:00-26:00", "03:00-03:20"} { + if _, err := ParseWindow(bad); err == nil { + t.Errorf("ParseWindow(%q) err = nil, want an error", bad) + } + } + w, err := ParseWindow("23:30-01:00") + if err != nil { + t.Fatalf("ParseWindow(across midnight) err = %v, want nil", err) + } + if w.length() != 90*time.Minute { + t.Errorf("ParseWindow(23:30-01:00).length() = %s, want 1h30m", w.length()) + } +} + +func TestNextCheckLandsWhereTheUpdateStillFits(t *testing.T) { + w, _ := ParseWindow(DefaultWindow) + zone := time.FixedZone("server", 9*3600) + r := rand.New(rand.NewPCG(1, 2)) + cases := []struct { + name string + now time.Time + day int + }{ + {"before the window", time.Date(2026, 9, 13, 1, 0, 0, 0, zone), 13}, + {"inside the window", time.Date(2026, 9, 13, 3, 10, 0, 0, zone), 13}, + {"after the window", time.Date(2026, 9, 13, 12, 0, 0, 0, zone), 14}, + {"too late in the window", time.Date(2026, 9, 13, 4, 40, 0, 0, zone), 14}, + } + for _, tt := range cases { + t.Run(tt.name, func(t *testing.T) { + for i := 0; i < 200; i++ { + got := w.NextCheck(tt.now, r) + earliest := time.Date(2026, 9, tt.day, 3, 0, 0, 0, zone) + latest := time.Date(2026, 9, tt.day, 4, 30, 0, 0, zone) + if got.Before(earliest) && !got.After(tt.now) || got.After(latest) || !got.After(tt.now) { + t.Fatalf("NextCheck(%s) = %s, want after now and between %s and %s", tt.now, got, earliest, latest) + } + } + }) + } +} + +func eligibleState(now time.Time) db.UpdateState { + published := now.Add(-48 * time.Hour) + return db.UpdateState{LatestVersion: "v1.1.0", LatestPublishedAt: &published, LatestPostgres: "18.6.0"} +} + +func defaultSettings() Settings { + w, _ := ParseWindow(DefaultWindow) + return Settings{Auto: true, PublicBanner: true, Check: true, Window: w, MinAge: DefaultMinAge} +} + +func TestEligible(t *testing.T) { + now := time.Date(2026, 9, 13, 3, 0, 0, 0, time.UTC) + facts := Facts{Current: "v1.0.0", BundledPostgres: "18.6.0", Now: now} + later := now.Add(time.Hour) + fresh := now.Add(-time.Hour) + + cases := []struct { + name string + change func(*db.UpdateState, *Settings, *Facts) + want string + }{ + {"eligible", func(*db.UpdateState, *Settings, *Facts) {}, "v1.1.0"}, + {"auto off", func(_ *db.UpdateState, s *Settings, _ *Facts) { s.Auto = false }, ""}, + {"check off", func(_ *db.UpdateState, s *Settings, _ *Facts) { s.Check = false }, ""}, + {"container", func(_ *db.UpdateState, _ *Settings, f *Facts) { f.Container = true }, ""}, + {"development build", func(_ *db.UpdateState, _ *Settings, f *Facts) { f.Current = "cf4ec6467c79" }, ""}, + {"already newest", func(_ *db.UpdateState, _ *Settings, f *Facts) { f.Current = "v1.1.0" }, ""}, + {"pinned", func(st *db.UpdateState, _ *Settings, _ *Facts) { st.PinnedVersion = "v1.0.0" }, ""}, + {"skipped", func(st *db.UpdateState, _ *Settings, _ *Facts) { st.SkippedVersion = "v1.1.0" }, ""}, + {"skipped an older one", func(st *db.UpdateState, _ *Settings, _ *Facts) { st.SkippedVersion = "v1.0.5" }, "v1.1.0"}, + {"failed before", func(st *db.UpdateState, _ *Settings, _ *Facts) { st.FailedVersions = []string{"v1.1.0"} }, ""}, + {"postponed", func(st *db.UpdateState, _ *Settings, _ *Facts) { st.PostponedUntil = &later }, ""}, + {"too fresh", func(st *db.UpdateState, _ *Settings, _ *Facts) { st.LatestPublishedAt = &fresh }, ""}, + {"too fresh for a shorter age", func(st *db.UpdateState, s *Settings, _ *Facts) { + st.LatestPublishedAt = &fresh + s.MinAge = 30 * time.Minute + }, "v1.1.0"}, + {"new PostgreSQL major", func(st *db.UpdateState, _ *Settings, _ *Facts) { st.LatestPostgres = "19.1.0" }, ""}, + {"own PostgreSQL ignores the major", func(st *db.UpdateState, _ *Settings, f *Facts) { + st.LatestPostgres = "19.1.0" + f.BundledPostgres = "" + }, "v1.1.0"}, + } + for _, tt := range cases { + t.Run(tt.name, func(t *testing.T) { + st, s, f := eligibleState(now), defaultSettings(), facts + tt.change(&st, &s, &f) + got, reason := Eligible(st, s, f) + if got != tt.want { + t.Errorf("Eligible() = %q (%s), want %q", got, reason, tt.want) + } + if got == "" && reason.String() == "" { + t.Error("Eligible() reason = empty, want one when nothing is eligible") + } + }) + } +} + +func TestTickSchedulesThenInstalls(t *testing.T) { + zone := time.UTC + r := rand.New(rand.NewPCG(3, 4)) + s := defaultSettings() + published := time.Date(2026, 9, 10, 0, 0, 0, 0, zone) + manifest := Manifest{Version: "v1.1.0", PublishedAt: published.Format(time.RFC3339), Postgres: "18.6.0"} + fetches := 0 + fetch := func() (Manifest, error) { fetches++; return manifest, nil } + facts := func(now time.Time) Facts { return Facts{Current: "v1.0.0", BundledPostgres: "18.6.0", Now: now} } + + var st db.UpdateState + start := time.Date(2026, 9, 13, 12, 0, 0, 0, zone) + if got := Tick(&st, s, facts(start), fetch, r); got != "" || fetches != 0 { + t.Fatalf("first Tick() = %q with %d fetches, want nothing before the window", got, fetches) + } + check := *st.NextCheckAt + if got := Tick(&st, s, facts(check.Add(-time.Minute)), fetch, r); got != "" || fetches != 0 { + t.Fatalf("Tick() before the check = %q with %d fetches, want nothing", got, fetches) + } + if got := Tick(&st, s, facts(check), fetch, r); got != "" { + t.Fatalf("Tick() at the check = %q, want it scheduled rather than installed", got) + } + if fetches != 1 || st.ScheduledVersion != "v1.1.0" || st.ScheduledAt == nil { + t.Fatalf("Tick() at the check left fetches=%d scheduled=%q at=%v, want v1.1.0 scheduled", fetches, st.ScheduledVersion, st.ScheduledAt) + } + if want := check.Add(AnnounceAhead); !st.ScheduledAt.Equal(want) { + t.Errorf("ScheduledAt = %s, want %s", st.ScheduledAt, want) + } + if at, ok := Banner(st, s, check.Add(time.Minute)); !ok || !at.Equal(*st.ScheduledAt) { + t.Errorf("Banner() = %s, %t, want the scheduled time shown", at, ok) + } + if got := Tick(&st, s, facts(st.ScheduledAt.Add(-time.Second)), fetch, r); got != "" { + t.Errorf("Tick() a second early = %q, want nothing", got) + } + if got := Tick(&st, s, facts(*st.ScheduledAt), fetch, r); got != "v1.1.0" { + t.Errorf("Tick() when due = %q, want v1.1.0", got) + } +} + +func TestTickDropsASkippedOrMissedSchedule(t *testing.T) { + r := rand.New(rand.NewPCG(5, 6)) + s := defaultSettings() + now := time.Date(2026, 9, 13, 3, 30, 0, 0, time.UTC) + fetch := func() (Manifest, error) { return Manifest{}, errors.New("offline") } + facts := func(at time.Time) Facts { return Facts{Current: "v1.0.0", Now: at} } + + st := eligibleState(now) + next := now.Add(24 * time.Hour) + st.NextCheckAt = &next + at := now.Add(10 * time.Minute) + st.ScheduledVersion, st.ScheduledAt = "v1.1.0", &at + + skipped := st + Skip(&skipped) + if got := Tick(&skipped, s, facts(at), fetch, r); got != "" || skipped.ScheduledVersion != "" { + t.Errorf("Tick() after Skip = %q, scheduled %q, want nothing", got, skipped.ScheduledVersion) + } + + missed := st + if got := Tick(&missed, s, facts(at.Add(MissedAfter+time.Minute)), fetch, r); got != "" || missed.ScheduledAt != nil { + t.Errorf("Tick() long after the schedule = %q, at %v, want it dropped", got, missed.ScheduledAt) + } +} + +func TestNoticesAfterARollback(t *testing.T) { + now := time.Date(2026, 9, 13, 9, 0, 0, 0, time.UTC) + at := now.Add(-time.Hour) + st := db.UpdateState{LastOutcome: OutcomeRolledBack, LastFrom: "v1.0.0", LastTo: "v1.1.0", LastAt: &at, LastError: "health check failed"} + got := Notices(st, defaultSettings(), Facts{Current: "v1.0.0", Now: now}) + if len(got) != 1 || got[0].Kind != NoticeRolledBack || got[0].Error != "health check failed" { + t.Errorf("Notices() = %+v, want one rolled-back notice with the error", got) + } +} diff --git a/internal/update/source.go b/internal/update/source.go new file mode 100644 index 00000000..12702e6b --- /dev/null +++ b/internal/update/source.go @@ -0,0 +1,151 @@ +package update + +import ( + "bufio" + "bytes" + "context" + "crypto/sha256" + "encoding/hex" + "fmt" + "io" + "net/http" + "os" + "strings" + "time" +) + +const ( + GitHubReleases = "https://github.com/WikitTeam/ProjectWikit/releases" + + EnvReleases = "PWIKIT_RELEASES_URL" + + maxManifest = 1 << 20 +) + +type Source struct { + Releases string + Mirror string + Log func(string) + client *http.Client +} + +func NewSource(mirror string) Source { + releases := GitHubReleases + if env := os.Getenv(EnvReleases); env != "" { + releases = env + } + return Source{ + Releases: strings.TrimSuffix(releases, "/"), + Mirror: strings.TrimSuffix(mirror, "/"), + client: &http.Client{Timeout: 30 * time.Minute}, + } +} + +func (s Source) Latest(ctx context.Context) (Manifest, error) { + body, err := s.small(ctx, "latest/download/"+ManifestName) + if err != nil { + return Manifest{}, err + } + return ParseManifest(body) +} + +func (s Source) Checksums(ctx context.Context, version string) (map[string]string, error) { + body, err := s.small(ctx, "download/"+version+"/"+ChecksumsName) + if err != nil { + return nil, err + } + out := map[string]string{} + scanner := bufio.NewScanner(bytes.NewReader(body)) + for scanner.Scan() { + fields := strings.Fields(scanner.Text()) + if len(fields) == 2 { + out[strings.TrimPrefix(fields[1], "*")] = strings.ToLower(fields[0]) + } + } + return out, scanner.Err() +} + +func (s Source) Download(ctx context.Context, version, file, dest, want string) error { + return s.each(ctx, "download/"+version+"/"+file, func(url string) error { + tmp := dest + ".part" + out, err := os.Create(tmp) + if err != nil { + return err + } + h := sha256.New() + err = s.fetch(ctx, url, io.MultiWriter(out, h), 0) + if closeErr := out.Close(); err == nil { + err = closeErr + } + if err == nil { + if got := hex.EncodeToString(h.Sum(nil)); !strings.EqualFold(got, want) { + err = fmt.Errorf("%s has sha256 %s, want %s; the download is damaged or was altered", file, got, want) + } + } + if err != nil { + os.Remove(tmp) + return err + } + return os.Rename(tmp, dest) + }) +} + +func (s Source) small(ctx context.Context, path string) ([]byte, error) { + var body []byte + err := s.each(ctx, path, func(url string) error { + var buf bytes.Buffer + if err := s.fetch(ctx, url, &buf, maxManifest); err != nil { + return err + } + body = buf.Bytes() + return nil + }) + return body, err +} + +func (s Source) each(ctx context.Context, path string, attempt func(url string) error) error { + err := attempt(s.Releases + "/" + path) + if err == nil || s.Mirror == "" || ctx.Err() != nil { + return err + } + rest := strings.TrimPrefix(strings.TrimPrefix(path, "latest/download/"), "download/") + s.note(fmt.Sprintf("GitHub could not be reached (%v), trying %s", err, s.Mirror)) + if mirrorErr := attempt(s.Mirror + "/" + rest); mirrorErr != nil { + return fmt.Errorf("%w; the mirror failed too: %v", err, mirrorErr) + } + return nil +} + +func (s Source) fetch(ctx context.Context, url string, into io.Writer, limit int64) error { + req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil) + if err != nil { + return err + } + req.Header.Set("User-Agent", "pwikit-updater") + client := s.client + if client == nil { + client = http.DefaultClient + } + resp, err := client.Do(req) + if err != nil { + return fmt.Errorf("fetch %s: %w", url, err) + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return fmt.Errorf("fetch %s: %s", url, resp.Status) + } + body := io.Reader(resp.Body) + if limit > 0 { + body = io.LimitReader(resp.Body, limit) + } + if _, err := io.Copy(into, body); err != nil { + return fmt.Errorf("fetch %s: %w", url, err) + } + return nil +} + +func (s Source) note(line string) { + if s.Log != nil { + s.Log(line) + } +} diff --git a/internal/update/unpack.go b/internal/update/unpack.go new file mode 100644 index 00000000..a7262f64 --- /dev/null +++ b/internal/update/unpack.go @@ -0,0 +1,83 @@ +package update + +import ( + "archive/tar" + "archive/zip" + "compress/gzip" + "fmt" + "io" + "os" + "path" + "strings" +) + +func ExtractExecutable(archive, dest, goos string) error { + want := ExecutableName(goos) + if strings.HasSuffix(archive, ".zip") { + return extractZip(archive, dest, want) + } + return extractTarGz(archive, dest, want) +} + +func extractTarGz(archive, dest, want string) error { + f, err := os.Open(archive) + if err != nil { + return err + } + defer f.Close() + gz, err := gzip.NewReader(f) + if err != nil { + return fmt.Errorf("read %s: %w", archive, err) + } + tr := tar.NewReader(gz) + for { + h, err := tr.Next() + if err == io.EOF { + return fmt.Errorf("%s holds no %s", archive, want) + } + if err != nil { + return fmt.Errorf("read %s: %w", archive, err) + } + if h.Typeflag == tar.TypeReg && path.Base(h.Name) == want && strings.Count(strings.Trim(h.Name, "/"), "/") == 1 { + return writeExecutable(dest, tr) + } + } +} + +func extractZip(archive, dest, want string) error { + zr, err := zip.OpenReader(archive) + if err != nil { + return fmt.Errorf("read %s: %w", archive, err) + } + defer zr.Close() + for _, f := range zr.File { + if f.FileInfo().IsDir() || path.Base(f.Name) != want || strings.Count(strings.Trim(f.Name, "/"), "/") != 1 { + continue + } + in, err := f.Open() + if err != nil { + return err + } + defer in.Close() + return writeExecutable(dest, in) + } + return fmt.Errorf("%s holds no %s", archive, want) +} + +func writeExecutable(dest string, from io.Reader) error { + tmp := dest + ".part" + out, err := os.OpenFile(tmp, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o755) + if err != nil { + return err + } + if _, err := io.Copy(out, from); err != nil { + out.Close() + os.Remove(tmp) + return err + } + if err := out.Close(); err != nil { + os.Remove(tmp) + return err + } + return os.Rename(tmp, dest) +} diff --git a/internal/update/version.go b/internal/update/version.go new file mode 100644 index 00000000..9b3aa9a5 --- /dev/null +++ b/internal/update/version.go @@ -0,0 +1,95 @@ +// Package update answers whether a newer release exists and how to put it in place. +package update + +import ( + "regexp" + "strconv" + "strings" +) + +type Version struct { + Major, Minor, Patch int + Pre string +} + +var versionPattern = regexp.MustCompile(`^v(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?$`) + +func ParseVersion(s string) (Version, bool) { + m := versionPattern.FindStringSubmatch(s) + if m == nil { + return Version{}, false + } + major, _ := strconv.Atoi(m[1]) + minor, _ := strconv.Atoi(m[2]) + patch, _ := strconv.Atoi(m[3]) + return Version{Major: major, Minor: minor, Patch: patch, Pre: m[4]}, true +} + +func (v Version) Compare(o Version) int { + for _, pair := range [][2]int{{v.Major, o.Major}, {v.Minor, o.Minor}, {v.Patch, o.Patch}} { + if pair[0] != pair[1] { + if pair[0] < pair[1] { + return -1 + } + return 1 + } + } + switch { + case v.Pre == o.Pre: + return 0 + case v.Pre == "": + return 1 + case o.Pre == "": + return -1 + } + return comparePre(v.Pre, o.Pre) +} + +func comparePre(a, b string) int { + as, bs := strings.Split(a, "."), strings.Split(b, ".") + for i := 0; i < len(as) && i < len(bs); i++ { + an, aErr := strconv.Atoi(as[i]) + bn, bErr := strconv.Atoi(bs[i]) + switch { + case aErr == nil && bErr == nil: + if an != bn { + if an < bn { + return -1 + } + return 1 + } + case aErr == nil: + return -1 + case bErr == nil: + return 1 + default: + if c := strings.Compare(as[i], bs[i]); c != 0 { + return c + } + } + } + switch { + case len(as) < len(bs): + return -1 + case len(as) > len(bs): + return 1 + } + return 0 +} + +func Newer(candidate, current string) bool { + c, ok := ParseVersion(candidate) + if !ok { + return false + } + have, ok := ParseVersion(current) + if !ok { + return false + } + return c.Compare(have) > 0 +} + +func PostgresMajor(version string) string { + major, _, _ := strings.Cut(version, ".") + return major +} From ba6d33f931245b5c492403f548114460fe89b87e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 17:11:41 +0900 Subject: [PATCH 420/428] add install scripts --- install/install.ps1 | 116 +++++++++++++++++++++++++++++++ install/install.sh | 163 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 279 insertions(+) create mode 100644 install/install.ps1 create mode 100644 install/install.sh diff --git a/install/install.ps1 b/install/install.ps1 new file mode 100644 index 00000000..80e78833 --- /dev/null +++ b/install/install.ps1 @@ -0,0 +1,116 @@ +# Installs a ProjectWikit release on Windows. +# +# irm https://github.com/WikitTeam/ProjectWikit/releases/latest/download/install.ps1 | iex +# +# Piped into iex, the script takes its options from environment variables: +# PWIKIT_VERSION, PWIKIT_DIR, PWIKIT_MIRROR and PWIKIT_NO_PATH. Saved to a file, +# it also takes them as parameters: +# +# .\install.ps1 -Version v1.0.0 -Dir D:\pwikit -Mirror -NoPath +param( + [string]$Version = $env:PWIKIT_VERSION, + [string]$Dir = $env:PWIKIT_DIR, + [string]$Mirror = $env:PWIKIT_MIRROR, + [switch]$NoPath = [bool]$env:PWIKIT_NO_PATH +) + +$ErrorActionPreference = 'Stop' +$ProgressPreference = 'SilentlyContinue' +[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12 + +function Fail([string]$Message) { + Write-Host "install.ps1: $Message" -ForegroundColor Red + throw $Message +} + +$Releases = if ($env:PWIKIT_RELEASES_URL) { $env:PWIKIT_RELEASES_URL } else { 'https://github.com/WikitTeam/ProjectWikit/releases' } +if ($Mirror) { $Mirror = $Mirror.TrimEnd('/') } +if (-not $Dir) { $Dir = Join-Path $HOME 'pwikit' } + +if ($env:PROCESSOR_ARCHITECTURE -ne 'AMD64' -and $env:PROCESSOR_ARCHITEW6432 -ne 'AMD64') { + if ($env:PROCESSOR_ARCHITECTURE -eq 'ARM64') { + Write-Host 'No ARM64 build exists; installing the x64 build, which Windows 11 runs through emulation.' + } else { + Fail "no release is built for $($env:PROCESSOR_ARCHITECTURE)" + } +} + +if (Test-Path (Join-Path $Dir 'pwikit.exe')) { + Fail "$Dir already holds pwikit; update it with: $Dir\pwikit.exe update" +} +if ((Test-Path $Dir) -and (Get-ChildItem -Force $Dir | Select-Object -First 1)) { + Fail "$Dir is not empty; pass -Dir with a new or empty directory" +} + +function Get-ReleaseFile([string]$Path, [string]$OutFile) { + try { + Invoke-WebRequest -UseBasicParsing -TimeoutSec 60 -Uri "$Releases/$Path" -OutFile $OutFile + return + } catch { + if (-not $Mirror) { throw } + } + $mirrored = $Path -replace '^latest/download/', '' -replace '^download/', '' + Write-Host "GitHub could not be reached, trying $Mirror" + Invoke-WebRequest -UseBasicParsing -TimeoutSec 600 -Uri "$Mirror/$mirrored" -OutFile $OutFile +} + +$work = Join-Path ([IO.Path]::GetTempPath()) ("pwikit-install-" + [Guid]::NewGuid().ToString('N')) +New-Item -ItemType Directory -Path $work | Out-Null +try { + $platform = 'windows-amd64' + if (-not $Version) { + try { Get-ReleaseFile 'latest/download/latest.json' (Join-Path $work 'latest.json') } + catch { Fail 'could not fetch latest.json; check the network, or pass -Mirror' } + $latest = Get-Content -Raw (Join-Path $work 'latest.json') | ConvertFrom-Json + $Version = $latest.version + $entry = $latest.packages.$platform + if (-not $entry) { Fail "latest.json has no package for $platform" } + $file = $entry.file + $want = $entry.sha256 + } else { + if (-not $Version.StartsWith('v')) { $Version = "v$Version" } + $file = "pwikit-$Version-$platform.zip" + try { Get-ReleaseFile "download/$Version/SHA256SUMS" (Join-Path $work 'SHA256SUMS') } + catch { Fail "could not fetch the checksums of $Version; does that release exist?" } + $want = $null + foreach ($line in Get-Content (Join-Path $work 'SHA256SUMS')) { + $parts = $line -split '\s+' + if ($parts.Count -ge 2 -and $parts[1] -eq $file) { $want = $parts[0] } + } + if (-not $want) { Fail "release $Version has no package for $platform" } + } + + Write-Host "Downloading pwikit $Version for $platform" + $archive = Join-Path $work $file + try { Get-ReleaseFile "download/$Version/$file" $archive } + catch { Fail "could not download $file" } + $got = (Get-FileHash -Algorithm SHA256 $archive).Hash.ToLowerInvariant() + if ($got -ne $want.ToLowerInvariant()) { + Fail "$file has sha256 $got, want $want; the download is damaged or was altered" + } + + $unpacked = Join-Path $work 'unpacked' + Expand-Archive -Path $archive -DestinationPath $unpacked + $top = Join-Path $unpacked "pwikit-$Version-$platform" + if (-not (Test-Path (Join-Path $top 'pwikit.exe'))) { Fail "$file does not hold pwikit.exe" } + + New-Item -ItemType Directory -Force -Path $Dir | Out-Null + Copy-Item (Join-Path $top 'pwikit.exe') $Dir + if (Test-Path (Join-Path $top 'LICENSE')) { Copy-Item (Join-Path $top 'LICENSE') $Dir } + Write-Host "Installed pwikit $Version into $Dir" + + if (-not $NoPath) { + & (Join-Path $Dir 'pwikit.exe') path install + if ($LASTEXITCODE -ne 0) { + Write-Host "pwikit is installed, but could not be made runnable by name; run $Dir\pwikit.exe path install later" + } + } + + Write-Host '' + Write-Host 'Next, create the site from that directory:' + Write-Host " cd $Dir" + Write-Host ' .\pwikit.exe createsite -slug main -title "My Wiki" -headline "A wiki" -domain wiki.example.org -media-domain files.example.org' + Write-Host 'Then follow the quick start: https://github.com/WikitTeam/ProjectWikit/blob/main/docs/en/quickstart.md' +} finally { + Remove-Item -Recurse -Force $work -ErrorAction SilentlyContinue +} diff --git a/install/install.sh b/install/install.sh new file mode 100644 index 00000000..ca0303a1 --- /dev/null +++ b/install/install.sh @@ -0,0 +1,163 @@ +#!/bin/sh +# Installs a ProjectWikit release on Linux or macOS. +# +# curl -fsSL https://github.com/WikitTeam/ProjectWikit/releases/latest/download/install.sh | sh +# curl -fsSL /install.sh | sh -s -- --mirror +# +# Options: +# --version release to install; defaults to the newest +# --dir where pwikit and all of its data go +# --mirror mirror to use when GitHub cannot be reached +# --user account that owns the directory when run as root +# --no-path do not make pwikit runnable by name +set -eu + +releases="${PWIKIT_RELEASES_URL:-https://github.com/WikitTeam/ProjectWikit/releases}" +version="" +dir="" +mirror="${PWIKIT_MIRROR:-}" +owner="" +add_path=1 + +say() { printf '%s\n' "$*"; } +fail() { printf 'install.sh: %s\n' "$*" >&2; exit 1; } + +while [ $# -gt 0 ]; do + case "$1" in + --version) [ $# -ge 2 ] || fail "--version needs a value"; version="$2"; shift 2 ;; + --dir) [ $# -ge 2 ] || fail "--dir needs a value"; dir="$2"; shift 2 ;; + --mirror) [ $# -ge 2 ] || fail "--mirror needs a value"; mirror="$2"; shift 2 ;; + --user) [ $# -ge 2 ] || fail "--user needs a value"; owner="$2"; shift 2 ;; + --no-path) add_path=0; shift ;; + -h|--help) + say "Usage: install.sh [--version vX.Y.Z] [--dir directory] [--mirror url] [--user account] [--no-path]" + exit 0 ;; + *) fail "unknown option $1" ;; + esac +done +mirror="${mirror%/}" + +case "$(uname -s)" in + Linux) os=linux ;; + Darwin) os=darwin ;; + *) fail "this script installs on Linux and macOS; on Windows use install.ps1" ;; +esac +case "$(uname -m)" in + x86_64|amd64) arch=amd64 ;; + aarch64|arm64) arch=arm64 ;; + *) fail "no release is built for $(uname -m)" ;; +esac + +if command -v curl >/dev/null 2>&1; then + fetch() { curl -fsSL --connect-timeout 15 --retry 2 -o "$2" "$1"; } +elif command -v wget >/dev/null 2>&1; then + fetch() { wget -q -T 15 -O "$2" "$1"; } +else + fail "curl or wget is needed" +fi +if command -v sha256sum >/dev/null 2>&1; then + sha256() { sha256sum "$1" | cut -d' ' -f1; } +elif command -v shasum >/dev/null 2>&1; then + sha256() { shasum -a 256 "$1" | cut -d' ' -f1; } +else + fail "sha256sum or shasum is needed" +fi +command -v tar >/dev/null 2>&1 || fail "tar is needed" + +if [ "$(id -u)" -eq 0 ]; then + if [ -z "$owner" ]; then + if [ -n "${SUDO_USER:-}" ] && [ "$SUDO_USER" != root ]; then + owner="$SUDO_USER" + else + fail "pwikit does not run as root; pass --user to say who owns the installation" + fi + fi + id "$owner" >/dev/null 2>&1 || fail "no account named $owner" + [ "$owner" != root ] || fail "pwikit does not run as root; pass another account to --user" + [ -n "$dir" ] || dir=/opt/pwikit +else + [ -z "$owner" ] || fail "--user only applies when running as root" + [ -n "$dir" ] || dir="$HOME/pwikit" +fi + +if [ -e "$dir/pwikit" ]; then + fail "$dir already holds pwikit; update it with: $dir/pwikit update" +fi +if [ -d "$dir" ] && [ -n "$(ls -A "$dir" 2>/dev/null)" ]; then + fail "$dir is not empty; pass --dir with a new or empty directory" +fi + +work="$(mktemp -d)" +trap 'rm -rf "$work"' EXIT INT TERM + +download() { + if fetch "$releases/$1" "$2" 2>/dev/null; then + return 0 + fi + if [ -n "$mirror" ]; then + case "$1" in + latest/download/*) mirrored="$mirror/${1#latest/download/}" ;; + download/*) mirrored="$mirror/${1#download/}" ;; + esac + say "GitHub could not be reached, trying $mirror" + fetch "$mirrored" "$2" && return 0 + fi + return 1 +} + +package_line() { + awk -v want="\"$os-$arch\"" -v key="\"$1\"" ' + index($0, want) { inside = 1; next } + inside && index($0, key) { + sub(/^[^:]*:[ \t]*"?/, ""); sub(/"?,?[ \t\r]*$/, ""); print; exit + } + inside && /}/ { exit } + ' "$work/latest.json" +} + +if [ -z "$version" ]; then + download latest/download/latest.json "$work/latest.json" || fail "could not fetch latest.json; check the network, or pass --mirror" + version="$(awk -F'"' '/"version"/ { print $4; exit }' "$work/latest.json")" + file="$(package_line file)" + want="$(package_line sha256)" + [ -n "$version" ] && [ -n "$file" ] && [ -n "$want" ] || fail "latest.json has no package for $os-$arch" +else + case "$version" in v*) ;; *) version="v$version" ;; esac + file="pwikit-$version-$os-$arch.tar.gz" + download "download/$version/SHA256SUMS" "$work/SHA256SUMS" || fail "could not fetch the checksums of $version; does that release exist?" + want="$(awk -v f="$file" '$2 == f { print $1; exit }' "$work/SHA256SUMS")" + [ -n "$want" ] || fail "release $version has no package for $os-$arch" +fi + +say "Downloading pwikit $version for $os-$arch" +download "download/$version/$file" "$work/$file" || fail "could not download $file" +got="$(sha256 "$work/$file")" +[ "$got" = "$want" ] || fail "$file has sha256 $got, want $want; the download is damaged or was altered" + +mkdir -p "$work/unpacked" +tar -xzf "$work/$file" -C "$work/unpacked" +top="$work/unpacked/pwikit-$version-$os-$arch" +[ -x "$top/pwikit" ] || fail "$file does not hold pwikit" + +mkdir -p "$dir" +cp "$top/pwikit" "$dir/pwikit" +[ ! -f "$top/LICENSE" ] || cp "$top/LICENSE" "$dir/LICENSE" +chmod 755 "$dir/pwikit" +if [ -n "$owner" ]; then + chown -R "$owner" "$dir" +fi +say "Installed pwikit $version into $dir" + +if [ "$add_path" -eq 1 ]; then + "$dir/pwikit" path install || say "pwikit is installed, but could not be made runnable by name; run $dir/pwikit path install later" +fi + +say "" +say "Next, create the site from that directory:" +say " cd $dir" +if [ -n "$owner" ]; then + say " sudo -u $owner ./pwikit createsite -slug main -title \"My Wiki\" -headline \"A wiki\" -domain wiki.example.org -media-domain files.example.org" +else + say " ./pwikit createsite -slug main -title \"My Wiki\" -headline \"A wiki\" -domain wiki.example.org -media-domain files.example.org" +fi +say "Then follow the quick start: https://github.com/WikitTeam/ProjectWikit/blob/main/docs/en/quickstart.md" From bcf2b6d1bac89bebcf2998897622641beb6de5bd Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 17:11:41 +0900 Subject: [PATCH 421/428] add docker image --- .dockerignore | 21 ++++++++++++++++ Dockerfile | 44 ++++++++++++++++++++++++++++++++++ cmd/pwikit/database.go | 30 +++++++++++++++++++++-- cmd/pwikit/main.go | 5 +++- docker/compose.yaml | 54 ++++++++++++++++++++++++++++++++++++++++++ static/files.go | 2 +- static/files_none.go | 2 +- 7 files changed, 153 insertions(+), 5 deletions(-) create mode 100644 .dockerignore create mode 100644 Dockerfile create mode 100644 docker/compose.yaml diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..2916ee85 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,21 @@ +.git +.github +docs +dist +frontend/node_modules +ftml-capi/target +ftml/target +internal/pgbundle/archive +files +archive +pgdata +postgres +secrets +backups +logs +update +pwikit +pwikit.exe +pwikit.toml +postgres.lock +docker-compose.override.yaml diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..9f0736c6 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,44 @@ +# ProjectWikit container image. It carries no PostgreSQL of its own; the compose +# file in docker/ runs the official one next to it. +# +# docker build -t pwikit --build-arg VERSION=v1.0.0 . +# docker build --target binary --output dist . + +FROM node:20-bookworm AS frontend +WORKDIR /src/frontend +COPY frontend/package.json frontend/yarn.lock ./ +RUN yarn install --frozen-lockfile +COPY frontend/ ./ +COPY static/ /src/static/ +RUN yarn build + +FROM golang:1.26-bookworm AS build +RUN curl -sSf https://sh.rustup.rs | sh -s -- -y --profile minimal +ENV PATH=/root/.cargo/bin:$PATH +WORKDIR /src +COPY ftml/ ftml/ +COPY ftml-capi/ ftml-capi/ +RUN cd ftml-capi && cargo build --release +COPY go.mod go.sum ./ +RUN go mod download +COPY . . +COPY --from=frontend /src/static/ static/ +ARG VERSION=v0.0.0-dev +RUN CGO_ENABLED=1 go build -tags assets -trimpath \ + -ldflags "-s -w -X github.com/WikitTeam/ProjectWikit/internal/version.Release=${VERSION}" \ + -o /out/pwikit ./cmd/pwikit \ + && mkdir -p /out/data + +FROM scratch AS binary +COPY --from=build /out/pwikit /pwikit + +FROM gcr.io/distroless/cc-debian12:nonroot +COPY --from=build /out/pwikit /usr/local/bin/pwikit +COPY --from=build --chown=65532:65532 /out/data /data +ENV PWIKIT_DATA_DIR=/data \ + PWIKIT_CONTAINER=1 +WORKDIR /data +VOLUME /data +EXPOSE 8080 +ENTRYPOINT ["/usr/local/bin/pwikit"] +CMD ["serve", "-listen", ":8080"] diff --git a/cmd/pwikit/database.go b/cmd/pwikit/database.go index 62a7d313..2fe7335e 100644 --- a/cmd/pwikit/database.go +++ b/cmd/pwikit/database.go @@ -5,7 +5,9 @@ import ( "errors" "fmt" "log/slog" + "net/url" "os" + "strings" "time" "github.com/WikitTeam/ProjectWikit/internal/config" @@ -34,9 +36,32 @@ func prepareDataDir(p *paths.Paths) error { return err } +const envDatabasePasswordFile = "PWIKIT_DATABASE_PASSWORD_FILE" + +func withPasswordFile(dsn string) (string, error) { + name := os.Getenv(envDatabasePasswordFile) + if name == "" || dsn == "" { + return dsn, nil + } + u, err := url.Parse(dsn) + if err != nil || u.User == nil { + return dsn, nil + } + if _, has := u.User.Password(); has { + return dsn, nil + } + secret, err := os.ReadFile(name) + if err != nil { + return "", fmt.Errorf("read the database password from %s: %w", name, err) + } + u.User = url.UserPassword(u.User.Username(), strings.TrimSpace(string(secret))) + return u.String(), nil +} + func resolveDatabase(ctx context.Context, explicit, dataDir string) (string, func(), error) { if explicit != "" { - return explicit, func() {}, nil + dsn, err := withPasswordFile(explicit) + return dsn, func() {}, err } p, err := paths.New(dataDir) if err != nil { @@ -47,7 +72,8 @@ func resolveDatabase(ctx context.Context, explicit, dataDir string) (string, fun return "", nil, err } if file.Database != "" { - return file.Database, func() {}, nil + dsn, err := withPasswordFile(file.Database) + return dsn, func() {}, err } cfg := bundledConfig(p, slog.Default()) diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index d28f7b3c..421d23cb 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -203,7 +203,10 @@ func serve(ctx context.Context, args []string) (err error) { ctx, stopSignals := signal.NotifyContext(ctx, os.Interrupt, syscall.SIGTERM) defer stopSignals() - dsn := *o.database + dsn, err := withPasswordFile(*o.database) + if err != nil { + return err + } bundledPostgres := "" if dsn == "" { bundledPostgres = pgbundle.Version diff --git a/docker/compose.yaml b/docker/compose.yaml new file mode 100644 index 00000000..fda22bc6 --- /dev/null +++ b/docker/compose.yaml @@ -0,0 +1,54 @@ +name: pwikit + +services: + password: + image: postgres:18 + entrypoint: ["sh", "-c"] + command: + - | + if [ ! -s /run/pwikit/db-password ]; then + umask 022 + head -c 32 /dev/urandom | od -An -tx1 | tr -d ' \n' > /run/pwikit/db-password + fi + volumes: + - secrets:/run/pwikit + restart: "no" + + postgres: + image: postgres:18 + restart: unless-stopped + depends_on: + password: + condition: service_completed_successfully + environment: + POSTGRES_USER: pwikit + POSTGRES_DB: pwikit + POSTGRES_PASSWORD_FILE: /run/pwikit/db-password + volumes: + - pgdata:/var/lib/postgresql + - secrets:/run/pwikit:ro + healthcheck: + test: ["CMD-SHELL", "pg_isready -U pwikit -d pwikit"] + interval: 5s + timeout: 3s + retries: 20 + + pwikit: + image: ${PWIKIT_IMAGE:-ghcr.io/wikitteam/pwikit:latest} + restart: unless-stopped + depends_on: + postgres: + condition: service_healthy + environment: + DATABASE_URL: postgres://pwikit@postgres:5432/pwikit?sslmode=disable + PWIKIT_DATABASE_PASSWORD_FILE: /run/pwikit/db-password + volumes: + - data:/data + - secrets:/run/pwikit:ro + ports: + - "${PWIKIT_PORT:-8080}:8080" + +volumes: + data: + pgdata: + secrets: diff --git a/static/files.go b/static/files.go index 65f44939..e6edc14f 100644 --- a/static/files.go +++ b/static/files.go @@ -1,4 +1,4 @@ -//go:build bundle +//go:build bundle || assets // Package static carries the frontend asset bundle inside the binary. package static diff --git a/static/files_none.go b/static/files_none.go index bc1450df..b1b836bc 100644 --- a/static/files_none.go +++ b/static/files_none.go @@ -1,4 +1,4 @@ -//go:build !bundle +//go:build !bundle && !assets package static From decc3a378a950591088e83388de51ea4b5c7df3d Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 17:11:41 +0900 Subject: [PATCH 422/428] build ci for release --- .github/workflows/frontend.yml | 44 +++++ .github/workflows/go.yml | 101 ++++++++++++ .github/workflows/release.yml | 226 +++++++++++++++++++++++++ internal/renderer/cgo/flags.go | 1 + tools/ftmllib/main.go | 7 +- tools/release/build.go | 293 +++++++++++++++++++++++++++++++++ tools/release/linux.sh | 46 ++++++ tools/release/main.go | 58 +++++++ tools/release/manifest.go | 111 +++++++++++++ 9 files changed, 886 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/frontend.yml create mode 100644 .github/workflows/go.yml create mode 100644 .github/workflows/release.yml create mode 100644 tools/release/build.go create mode 100644 tools/release/linux.sh create mode 100644 tools/release/main.go create mode 100644 tools/release/manifest.go diff --git a/.github/workflows/frontend.yml b/.github/workflows/frontend.yml new file mode 100644 index 00000000..1214fd69 --- /dev/null +++ b/.github/workflows/frontend.yml @@ -0,0 +1,44 @@ +name: Frontend + +on: + pull_request: + branches: [main] + paths: + - "frontend/**" + - "static/**" + - ".github/workflows/frontend.yml" + push: + branches: [main] + paths: + - "frontend/**" + - "static/**" + - ".github/workflows/frontend.yml" + +permissions: + contents: read + +concurrency: + group: frontend-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + name: text, types and bundle + runs-on: ubuntu-24.04 + defaults: + run: + working-directory: frontend + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: yarn + cache-dependency-path: frontend/yarn.lock + + - name: Install + run: yarn install --frozen-lockfile + + - name: Check text, types and bundle + run: yarn build diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml new file mode 100644 index 00000000..9c6a9222 --- /dev/null +++ b/.github/workflows/go.yml @@ -0,0 +1,101 @@ +name: Go + +on: + pull_request: + branches: [main] + paths: + - "**.go" + - "go.mod" + - "go.sum" + - "internal/migrate/sql/**" + - "internal/i18n/locales/**" + - "internal/**/templates/**" + - "ftml/**" + - "ftml-capi/**" + - ".github/workflows/go.yml" + push: + branches: [main] + paths: + - "**.go" + - "go.mod" + - "go.sum" + - "internal/migrate/sql/**" + - "internal/i18n/locales/**" + - "internal/**/templates/**" + - "ftml/**" + - "ftml-capi/**" + - ".github/workflows/go.yml" + +permissions: + contents: read + +concurrency: + group: go-${{ github.ref }} + cancel-in-progress: true + +jobs: + lint: + name: format and vet + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-go@v5 + with: + go-version-file: go.mod + + - name: Check formatting + run: | + unformatted=$(gofmt -l cmd internal tools static) + if [ -n "$unformatted" ]; then + echo "These files need gofmt:" + echo "$unformatted" + exit 1 + fi + + - name: Vet + run: go vet -tags nocgo ./... + + migrations: + name: migration declarations + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-go@v5 + with: + go-version-file: go.mod + + - name: Every migration declares whether older releases can run on it + run: go test -tags nocgo -run TestEveryMigrationDeclaresCompatibility ./internal/migrate + + test: + name: build and test + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-go@v5 + with: + go-version-file: go.mod + + - uses: dtolnay/rust-toolchain@stable + + - uses: Swatinem/rust-cache@v2 + with: + workspaces: ftml-capi + + - name: Build the ftml library + working-directory: ftml-capi + run: cargo build --release + + - name: Build + run: | + go build ./... + go build -tags nocgo ./... + + - name: Vet with cgo + run: go vet ./... + + - name: Test + run: go test -p 1 ./... diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 00000000..e113156a --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,226 @@ +name: Release + +on: + push: + branches: [main] + tags: ["v*"] + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: release-${{ github.ref }} + cancel-in-progress: ${{ !startsWith(github.ref, 'refs/tags/') }} + +jobs: + version: + runs-on: ubuntu-24.04 + outputs: + version: ${{ steps.pick.outputs.version }} + image: ${{ steps.pick.outputs.image }} + steps: + - id: pick + shell: bash + run: | + if [[ "$GITHUB_REF" == refs/tags/v* ]]; then + echo "version=${GITHUB_REF_NAME}" >> "$GITHUB_OUTPUT" + else + echo "version=v0.0.0-dev.${GITHUB_SHA::7}" >> "$GITHUB_OUTPUT" + fi + echo "image=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/pwikit" >> "$GITHUB_OUTPUT" + + build: + needs: version + strategy: + fail-fast: false + matrix: + include: + - platform: linux-amd64 + runner: ubuntu-24.04 + manylinux: quay.io/pypa/manylinux_2_28_x86_64 + - platform: linux-arm64 + runner: ubuntu-24.04-arm + manylinux: quay.io/pypa/manylinux_2_28_aarch64 + - platform: darwin-amd64 + runner: macos-15-intel + - platform: darwin-arm64 + runner: macos-15 + - platform: windows-amd64 + runner: windows-2022 + runs-on: ${{ matrix.runner }} + name: build ${{ matrix.platform }} + env: + VERSION: ${{ needs.version.outputs.version }} + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-node@v4 + with: + node-version: 20 + cache: yarn + cache-dependency-path: frontend/yarn.lock + + - name: Build the page assets + shell: bash + working-directory: frontend + run: | + yarn install --frozen-lockfile + yarn build + + - name: Build the package in manylinux + if: runner.os == 'Linux' + run: | + docker run --rm -v "$PWD:/src" -w /src -e VERSION="$VERSION" ${{ matrix.manylinux }} sh tools/release/linux.sh + sudo chown -R "$(id -u):$(id -g)" dist + + - uses: actions/setup-go@v5 + if: runner.os != 'Linux' + with: + go-version-file: go.mod + + - name: Install the Rust toolchain + if: runner.os == 'macOS' + uses: dtolnay/rust-toolchain@stable + + - name: Install the Rust toolchain for the GNU linker + if: runner.os == 'Windows' + shell: bash + run: | + rustup toolchain install stable-x86_64-pc-windows-gnu --profile minimal + gcc --version + + - name: Build the package + if: runner.os != 'Linux' + shell: bash + run: go run ./tools/release build -version "$VERSION" -out dist -skip-frontend + + - uses: actions/upload-artifact@v4 + with: + name: pwikit-${{ matrix.platform }} + path: | + dist/pwikit-* + dist/libftml_capi-* + if-no-files-found: error + retention-days: 14 + + image: + needs: version + strategy: + fail-fast: false + matrix: + include: + - arch: amd64 + runner: ubuntu-24.04 + - arch: arm64 + runner: ubuntu-24.04-arm + runs-on: ${{ matrix.runner }} + name: image ${{ matrix.arch }} + permissions: + contents: read + packages: write + env: + PUSH: ${{ startsWith(github.ref, 'refs/tags/v') }} + steps: + - uses: actions/checkout@v4 + + - uses: docker/setup-buildx-action@v3 + + - uses: docker/login-action@v3 + if: env.PUSH == 'true' + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ github.token }} + + - id: build + uses: docker/build-push-action@v6 + with: + context: . + platforms: linux/${{ matrix.arch }} + build-args: VERSION=${{ needs.version.outputs.version }} + outputs: type=image,name=${{ needs.version.outputs.image }},push-by-digest=true,name-canonical=true,push=${{ env.PUSH }} + + - name: Keep the digest + if: env.PUSH == 'true' + run: | + mkdir -p digests + digest="${{ steps.build.outputs.digest }}" + touch "digests/${digest#sha256:}" + + - uses: actions/upload-artifact@v4 + if: env.PUSH == 'true' + with: + name: digest-${{ matrix.arch }} + path: digests/* + retention-days: 1 + + publish: + needs: [version, build, image] + runs-on: ubuntu-24.04 + permissions: + contents: write + packages: write + env: + VERSION: ${{ needs.version.outputs.version }} + IMAGE: ${{ needs.version.outputs.image }} + steps: + - uses: actions/checkout@v4 + + - uses: actions/setup-go@v5 + with: + go-version-file: go.mod + + - uses: actions/download-artifact@v4 + with: + pattern: pwikit-* + path: dist + merge-multiple: true + + - name: Write SHA256SUMS and latest.json + run: | + cp install/install.sh install/install.ps1 dist/ + go run ./tools/release manifest -dir dist -version "$VERSION" -repository "$GITHUB_REPOSITORY" + + - uses: actions/upload-artifact@v4 + with: + name: release-${{ env.VERSION }} + path: dist/* + retention-days: 14 + + - name: Create a draft release + if: startsWith(github.ref, 'refs/tags/v') + env: + GH_TOKEN: ${{ github.token }} + run: | + gh release create "$VERSION" dist/* \ + --repo "$GITHUB_REPOSITORY" \ + --title "$VERSION" \ + --draft \ + --verify-tag \ + --notes "Release notes for $VERSION are written here before the draft is published." + + - uses: actions/download-artifact@v4 + if: startsWith(github.ref, 'refs/tags/v') + with: + pattern: digest-* + path: digests + merge-multiple: true + + - uses: docker/setup-buildx-action@v3 + if: startsWith(github.ref, 'refs/tags/v') + + - uses: docker/login-action@v3 + if: startsWith(github.ref, 'refs/tags/v') + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ github.token }} + + - name: Tag the image + if: startsWith(github.ref, 'refs/tags/v') + working-directory: digests + run: | + tags="-t $IMAGE:$VERSION" + case "$VERSION" in *-*) ;; *) tags="$tags -t $IMAGE:latest" ;; esac + docker buildx imagetools create $tags $(printf "$IMAGE@sha256:%s " *) diff --git a/internal/renderer/cgo/flags.go b/internal/renderer/cgo/flags.go index bd3e2cc6..20615829 100644 --- a/internal/renderer/cgo/flags.go +++ b/internal/renderer/cgo/flags.go @@ -6,5 +6,6 @@ package cgo #cgo CFLAGS: -I${SRCDIR} #cgo LDFLAGS: -L${SRCDIR}/../../../ftml-capi/target/release -lftml_capi #cgo windows LDFLAGS: -lws2_32 -luserenv -lbcrypt -lntdll -ladvapi32 -lsynchronization +#cgo linux LDFLAGS: -ldl -lm */ import "C" diff --git a/tools/ftmllib/main.go b/tools/ftmllib/main.go index efad2783..37078dc7 100644 --- a/tools/ftmllib/main.go +++ b/tools/ftmllib/main.go @@ -183,7 +183,7 @@ func download(dir, baseURL, target string) error { } client := &http.Client{Timeout: 10 * time.Minute} for _, name := range []string{libraryName, metadataName} { - url := strings.TrimSuffix(baseURL, "/") + "/" + target + "/" + name + url := strings.TrimSuffix(baseURL, "/") + "/" + releaseAssetName(name, target) if err := fetch(client, url, filepath.Join(dir, name)); err != nil { return err } @@ -192,6 +192,11 @@ func download(dir, baseURL, target string) error { return nil } +func releaseAssetName(name, target string) string { + ext := filepath.Ext(name) + return strings.TrimSuffix(name, ext) + "-" + target + ext +} + func fetch(client *http.Client, url, dest string) error { resp, err := client.Get(url) if err != nil { diff --git a/tools/release/build.go b/tools/release/build.go new file mode 100644 index 00000000..bb9e74d2 --- /dev/null +++ b/tools/release/build.go @@ -0,0 +1,293 @@ +package main + +import ( + "archive/tar" + "archive/zip" + "compress/gzip" + "encoding/json" + "errors" + "flag" + "fmt" + "io" + "os" + "os/exec" + "path/filepath" + "regexp" + "runtime" + "strings" + "time" +) + +const versionPackage = "github.com/WikitTeam/ProjectWikit/internal/version.Release" + +var versionPattern = regexp.MustCompile(`^v\d+\.\d+\.\d+(-[0-9A-Za-z.-]+)?$`) + +func buildCommand(args []string) error { + fs := flag.NewFlagSet("build", flag.ContinueOnError) + version := fs.String("version", "", "release version, such as v1.0.0 or v0.0.0-dev.abc1234") + out := fs.String("out", "dist", "directory the package is written into") + skipFrontend := fs.Bool("skip-frontend", false, "use the page assets already in static/") + skipFtml := fs.Bool("skip-ftml", false, "use the ftml library already in ftml-capi/target/release") + skipPostgres := fs.Bool("skip-postgres", false, "use the PostgreSQL archive already in internal/pgbundle/archive") + toolchain := fs.String("cargo-toolchain", defaultToolchain(), "rustup toolchain the ftml library is built with; empty uses the default") + if err := fs.Parse(args); err != nil { + if errors.Is(err, flag.ErrHelp) { + return nil + } + return err + } + if !versionPattern.MatchString(*version) { + return fmt.Errorf("-version %q is not a version such as v1.0.0", *version) + } + if _, err := os.Stat(filepath.Join("cmd", "pwikit")); err != nil { + return errors.New("run this from the repository root") + } + + started := time.Now() + if !*skipFrontend { + if err := step("frontend", "frontend", nil, "yarn", "install", "--frozen-lockfile"); err != nil { + return err + } + if err := step("frontend", "frontend", nil, "yarn", "build"); err != nil { + return err + } + } + if !*skipFtml { + if err := buildFtml(*toolchain); err != nil { + return err + } + } + if err := step("ftml", ".", nil, "go", "run", "./tools/ftmllib", "-emit-metadata"); err != nil { + return err + } + if !*skipPostgres { + if err := step("postgres", ".", nil, "go", "run", "./tools/pgarchive"); err != nil { + return err + } + } + + base := packageBase(*version, runtime.GOOS, runtime.GOARCH) + stage := filepath.Join(*out, "stage", base) + if err := os.RemoveAll(stage); err != nil { + return err + } + if err := os.MkdirAll(stage, 0o755); err != nil { + return err + } + binary := filepath.Join(stage, executableName(runtime.GOOS)) + env := []string{"CGO_ENABLED=1"} + if err := step("pwikit", ".", env, "go", "build", "-tags", "bundle", "-trimpath", + "-ldflags", "-s -w -X "+versionPackage+"="+*version, + "-o", binary, "./cmd/pwikit"); err != nil { + return err + } + if err := copyFile("LICENSE", filepath.Join(stage, "LICENSE"), 0o644); err != nil { + return err + } + + target := filepath.Join(*out, packageFile(*version, runtime.GOOS, runtime.GOARCH)) + if runtime.GOOS == "windows" { + err := writeZip(target, filepath.Join(*out, "stage"), base) + if err != nil { + return err + } + } else if err := writeTarGz(target, filepath.Join(*out, "stage"), base); err != nil { + return err + } + if err := os.RemoveAll(filepath.Join(*out, "stage")); err != nil { + return err + } + + if err := copyFtmlLibrary(*out); err != nil { + return err + } + + info, err := os.Stat(target) + if err != nil { + return err + } + fmt.Printf("wrote %s, %d MB, in %s\n", target, info.Size()>>20, time.Since(started).Round(time.Second)) + return nil +} + +func copyFtmlLibrary(out string) error { + meta, err := os.ReadFile(filepath.Join("ftml-capi", "target", "release", "libftml_capi.json")) + if err != nil { + return err + } + var described struct { + Target string `json:"target"` + } + if err := json.Unmarshal(meta, &described); err != nil { + return err + } + for _, name := range []string{"libftml_capi.a", "libftml_capi.json"} { + ext := filepath.Ext(name) + published := strings.TrimSuffix(name, ext) + "-" + described.Target + ext + if err := copyFile(filepath.Join("ftml-capi", "target", "release", name), filepath.Join(out, published), 0o644); err != nil { + return err + } + } + return nil +} + +func defaultToolchain() string { + if runtime.GOOS == "windows" { + return "stable-x86_64-pc-windows-gnu" + } + return "" +} + +func buildFtml(toolchain string) error { + args := []string{} + if toolchain != "" { + args = append(args, "+"+toolchain) + } + args = append(args, "rustc", "--release", "--lib", "--", "--print", "native-static-libs") + var env []string + if runtime.GOOS == "windows" { + env = append(env, "RUSTFLAGS="+strings.TrimSpace(os.Getenv("RUSTFLAGS")+" -C link-arg=-ladvapi32")) + } + return step("ftml", "ftml-capi", env, "cargo", args...) +} + +func step(label, dir string, env []string, name string, args ...string) error { + fmt.Printf("==> [%s] %s %s\n", label, name, strings.Join(args, " ")) + cmd := exec.Command(name, args...) + cmd.Dir = dir + cmd.Stdout = os.Stdout + cmd.Stderr = os.Stderr + cmd.Env = append(os.Environ(), env...) + if err := cmd.Run(); err != nil { + return fmt.Errorf("%s: %s %s: %w", label, name, strings.Join(args, " "), err) + } + return nil +} + +func copyFile(from, to string, mode os.FileMode) error { + in, err := os.Open(from) + if err != nil { + return err + } + defer in.Close() + out, err := os.OpenFile(to, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, mode) + if err != nil { + return err + } + if _, err := io.Copy(out, in); err != nil { + out.Close() + return err + } + return out.Close() +} + +func packedMode(name string, info os.FileInfo) int64 { + if info.IsDir() { + return 0o755 + } + if base := filepath.Base(name); base == "pwikit" || base == "pwikit.exe" { + return 0o755 + } + return 0o644 +} + +func writeTarGz(target, root, top string) error { + file, err := os.Create(target) + if err != nil { + return err + } + defer file.Close() + gz := gzip.NewWriter(file) + tw := tar.NewWriter(gz) + + walkErr := filepath.Walk(filepath.Join(root, top), func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + rel, err := filepath.Rel(root, path) + if err != nil { + return err + } + header := &tar.Header{ + Name: filepath.ToSlash(rel), + Mode: packedMode(path, info), + ModTime: info.ModTime(), + Format: tar.FormatPAX, + } + if info.IsDir() { + header.Typeflag = tar.TypeDir + header.Name += "/" + return tw.WriteHeader(header) + } + header.Typeflag = tar.TypeReg + header.Size = info.Size() + if err := tw.WriteHeader(header); err != nil { + return err + } + in, err := os.Open(path) + if err != nil { + return err + } + defer in.Close() + _, err = io.Copy(tw, in) + return err + }) + if walkErr != nil { + return walkErr + } + if err := tw.Close(); err != nil { + return err + } + if err := gz.Close(); err != nil { + return err + } + return file.Close() +} + +func writeZip(target, root, top string) error { + file, err := os.Create(target) + if err != nil { + return err + } + defer file.Close() + zw := zip.NewWriter(file) + + walkErr := filepath.Walk(filepath.Join(root, top), func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + rel, err := filepath.Rel(root, path) + if err != nil { + return err + } + header, err := zip.FileInfoHeader(info) + if err != nil { + return err + } + header.Name = filepath.ToSlash(rel) + if info.IsDir() { + header.Name += "/" + _, err := zw.CreateHeader(header) + return err + } + header.Method = zip.Deflate + w, err := zw.CreateHeader(header) + if err != nil { + return err + } + in, err := os.Open(path) + if err != nil { + return err + } + defer in.Close() + _, err = io.Copy(w, in) + return err + }) + if walkErr != nil { + return walkErr + } + if err := zw.Close(); err != nil { + return err + } + return file.Close() +} diff --git a/tools/release/linux.sh b/tools/release/linux.sh new file mode 100644 index 00000000..bd4f3309 --- /dev/null +++ b/tools/release/linux.sh @@ -0,0 +1,46 @@ +#!/bin/sh +set -eu + +if [ -z "${VERSION:-}" ]; then + cat >&2 <<'USAGE' +Usage: VERSION=v1.0.0 sh tools/release/linux.sh + +Builds the Linux release package into dist/. Run it inside a manylinux_2_28 +container, whose old C library lets the package run on RHEL 8, Debian 10, +Ubuntu 20.04 and anything newer: + + docker run --rm -v "$PWD:/src" -w /src -e VERSION=v1.0.0 quay.io/pypa/manylinux_2_28_x86_64 sh tools/release/linux.sh + +Build the page assets first, outside the container, with yarn build. +USAGE + exit 2 +fi +GO_VERSION="${GO_VERSION:-$(sed -n 's/^go //p' go.mod)}" + +case "$(uname -m)" in + x86_64) goarch=amd64 ;; + aarch64) goarch=arm64 ;; + *) echo "linux.sh: no Go build for $(uname -m)" >&2; exit 1 ;; +esac + +if ! command -v go >/dev/null 2>&1; then + full="$(curl -fsSL 'https://go.dev/dl/?mode=json&include=all' | python3 -c ' +import json, sys +want = sys.argv[1] +for release in json.load(sys.stdin): + v = release["version"] + if release["stable"] and (v == "go" + want or v.startswith("go" + want + ".")): + print(v) + break +' "$GO_VERSION")" + [ -n "$full" ] || { echo "linux.sh: no stable Go release matches $GO_VERSION" >&2; exit 1; } + curl -fsSL "https://go.dev/dl/$full.linux-$goarch.tar.gz" | tar -xz -C /usr/local + export PATH="/usr/local/go/bin:$PATH" +fi +if ! command -v cargo >/dev/null 2>&1; then + curl -sSf https://sh.rustup.rs | sh -s -- -y --profile minimal -q + export PATH="$HOME/.cargo/bin:$PATH" +fi + +git config --global --add safe.directory "$(pwd)" 2>/dev/null || true +go run ./tools/release build -version "$VERSION" -out "${OUT:-dist}" -skip-frontend diff --git a/tools/release/main.go b/tools/release/main.go new file mode 100644 index 00000000..1ba13be8 --- /dev/null +++ b/tools/release/main.go @@ -0,0 +1,58 @@ +package main + +import ( + "errors" + "fmt" + "os" +) + +const usage = `Usage: go run ./tools/release [options] + + build build the release package for this machine's platform into -out + manifest write SHA256SUMS and latest.json for the packages in -dir + +Run from the repository root. Add -h after a subcommand to list its options. +` + +func main() { + if err := run(os.Args[1:]); err != nil { + fmt.Fprintln(os.Stderr, "release: "+err.Error()) + os.Exit(1) + } +} + +func run(args []string) error { + if len(args) == 0 { + fmt.Fprint(os.Stderr, usage) + return errors.New("missing subcommand") + } + switch args[0] { + case "build": + return buildCommand(args[1:]) + case "manifest": + return manifestCommand(args[1:]) + case "-h", "--help", "help": + fmt.Fprint(os.Stderr, usage) + return nil + } + fmt.Fprint(os.Stderr, usage) + return fmt.Errorf("unknown subcommand %q", args[0]) +} + +func packageBase(version, goos, goarch string) string { + return "pwikit-" + version + "-" + goos + "-" + goarch +} + +func packageFile(version, goos, goarch string) string { + if goos == "windows" { + return packageBase(version, goos, goarch) + ".zip" + } + return packageBase(version, goos, goarch) + ".tar.gz" +} + +func executableName(goos string) string { + if goos == "windows" { + return "pwikit.exe" + } + return "pwikit" +} diff --git a/tools/release/manifest.go b/tools/release/manifest.go new file mode 100644 index 00000000..f8533114 --- /dev/null +++ b/tools/release/manifest.go @@ -0,0 +1,111 @@ +package main + +import ( + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "flag" + "fmt" + "io" + "os" + "path/filepath" + "regexp" + "sort" + "strings" + "time" + + "github.com/WikitTeam/ProjectWikit/internal/pgbundle" + "github.com/WikitTeam/ProjectWikit/internal/update" +) + +func manifestCommand(args []string) error { + fs := flag.NewFlagSet("manifest", flag.ContinueOnError) + dir := fs.String("dir", "dist", "directory holding the release packages") + version := fs.String("version", "", "release version the packages were built as") + repository := fs.String("repository", "WikitTeam/ProjectWikit", "GitHub repository the release notes live in") + published := fs.String("published", "", "publication time in RFC 3339; defaults to now") + if err := fs.Parse(args); err != nil { + if errors.Is(err, flag.ErrHelp) { + return nil + } + return err + } + if !versionPattern.MatchString(*version) { + return fmt.Errorf("-version %q is not a version such as v1.0.0", *version) + } + at := time.Now().UTC() + if *published != "" { + parsed, err := time.Parse(time.RFC3339, *published) + if err != nil { + return fmt.Errorf("-published: %w", err) + } + at = parsed.UTC() + } + + entries, err := os.ReadDir(*dir) + if err != nil { + return err + } + pattern := regexp.MustCompile(`^` + regexp.QuoteMeta("pwikit-"+*version+"-") + `([a-z0-9]+-[a-z0-9]+)\.(tar\.gz|zip)$`) + + m := update.Manifest{ + Format: update.ManifestFormat, + Version: *version, + PublishedAt: at.Format(time.RFC3339), + Notes: "https://github.com/" + *repository + "/releases/tag/" + *version, + Postgres: pgbundle.Version, + Packages: map[string]update.Package{}, + } + var sums []string + for _, e := range entries { + name := e.Name() + if e.IsDir() || name == update.ChecksumsName || name == update.ManifestName { + continue + } + sum, size, err := hashFile(filepath.Join(*dir, name)) + if err != nil { + return err + } + sums = append(sums, sum+" "+name) + if match := pattern.FindStringSubmatch(name); match != nil { + m.Packages[match[1]] = update.Package{File: name, SHA256: sum, Size: size} + } + } + if len(m.Packages) == 0 { + return fmt.Errorf("no package for %s in %s", *version, *dir) + } + sort.Slice(sums, func(i, j int) bool { return sums[i][66:] < sums[j][66:] }) + + if err := os.WriteFile(filepath.Join(*dir, update.ChecksumsName), []byte(strings.Join(sums, "\n")+"\n"), 0o644); err != nil { + return err + } + body, err := json.MarshalIndent(m, "", " ") + if err != nil { + return err + } + if err := os.WriteFile(filepath.Join(*dir, update.ManifestName), append(body, '\n'), 0o644); err != nil { + return err + } + platforms := make([]string, 0, len(m.Packages)) + for p := range m.Packages { + platforms = append(platforms, p) + } + sort.Strings(platforms) + fmt.Printf("wrote %s and %s for %s: %s\n", update.ChecksumsName, update.ManifestName, *version, strings.Join(platforms, ", ")) + return nil +} + +func hashFile(path string) (string, int64, error) { + f, err := os.Open(path) + if err != nil { + return "", 0, err + } + defer f.Close() + h := sha256.New() + n, err := io.Copy(h, f) + if err != nil { + return "", 0, err + } + return hex.EncodeToString(h.Sum(nil)), n, nil +} From 2e644429a289c02f11b9bbf5ef24c9507df1402c Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 17:28:34 +0900 Subject: [PATCH 423/428] run ci only on PR --- .github/workflows/frontend.yml | 6 ------ .github/workflows/go.yml | 12 ------------ .github/workflows/release.yml | 21 ++------------------- 3 files changed, 2 insertions(+), 37 deletions(-) diff --git a/.github/workflows/frontend.yml b/.github/workflows/frontend.yml index 1214fd69..7412de9d 100644 --- a/.github/workflows/frontend.yml +++ b/.github/workflows/frontend.yml @@ -7,12 +7,6 @@ on: - "frontend/**" - "static/**" - ".github/workflows/frontend.yml" - push: - branches: [main] - paths: - - "frontend/**" - - "static/**" - - ".github/workflows/frontend.yml" permissions: contents: read diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 9c6a9222..b24ed95c 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -13,18 +13,6 @@ on: - "ftml/**" - "ftml-capi/**" - ".github/workflows/go.yml" - push: - branches: [main] - paths: - - "**.go" - - "go.mod" - - "go.sum" - - "internal/migrate/sql/**" - - "internal/i18n/locales/**" - - "internal/**/templates/**" - - "ftml/**" - - "ftml-capi/**" - - ".github/workflows/go.yml" permissions: contents: read diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e113156a..26fd879b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,16 +2,13 @@ name: Release on: push: - branches: [main] tags: ["v*"] - workflow_dispatch: permissions: contents: read concurrency: group: release-${{ github.ref }} - cancel-in-progress: ${{ !startsWith(github.ref, 'refs/tags/') }} jobs: version: @@ -23,11 +20,7 @@ jobs: - id: pick shell: bash run: | - if [[ "$GITHUB_REF" == refs/tags/v* ]]; then - echo "version=${GITHUB_REF_NAME}" >> "$GITHUB_OUTPUT" - else - echo "version=v0.0.0-dev.${GITHUB_SHA::7}" >> "$GITHUB_OUTPUT" - fi + echo "version=${GITHUB_REF_NAME}" >> "$GITHUB_OUTPUT" echo "image=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/pwikit" >> "$GITHUB_OUTPUT" build: @@ -119,15 +112,12 @@ jobs: permissions: contents: read packages: write - env: - PUSH: ${{ startsWith(github.ref, 'refs/tags/v') }} steps: - uses: actions/checkout@v4 - uses: docker/setup-buildx-action@v3 - uses: docker/login-action@v3 - if: env.PUSH == 'true' with: registry: ghcr.io username: ${{ github.actor }} @@ -139,17 +129,15 @@ jobs: context: . platforms: linux/${{ matrix.arch }} build-args: VERSION=${{ needs.version.outputs.version }} - outputs: type=image,name=${{ needs.version.outputs.image }},push-by-digest=true,name-canonical=true,push=${{ env.PUSH }} + outputs: type=image,name=${{ needs.version.outputs.image }},push-by-digest=true,name-canonical=true,push=true - name: Keep the digest - if: env.PUSH == 'true' run: | mkdir -p digests digest="${{ steps.build.outputs.digest }}" touch "digests/${digest#sha256:}" - uses: actions/upload-artifact@v4 - if: env.PUSH == 'true' with: name: digest-${{ matrix.arch }} path: digests/* @@ -189,7 +177,6 @@ jobs: retention-days: 14 - name: Create a draft release - if: startsWith(github.ref, 'refs/tags/v') env: GH_TOKEN: ${{ github.token }} run: | @@ -201,24 +188,20 @@ jobs: --notes "Release notes for $VERSION are written here before the draft is published." - uses: actions/download-artifact@v4 - if: startsWith(github.ref, 'refs/tags/v') with: pattern: digest-* path: digests merge-multiple: true - uses: docker/setup-buildx-action@v3 - if: startsWith(github.ref, 'refs/tags/v') - uses: docker/login-action@v3 - if: startsWith(github.ref, 'refs/tags/v') with: registry: ghcr.io username: ${{ github.actor }} password: ${{ github.token }} - name: Tag the image - if: startsWith(github.ref, 'refs/tags/v') working-directory: digests run: | tags="-t $IMAGE:$VERSION" From 94b9350e048131c6e7956aceabbf650e489963d9 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 18:37:31 +0900 Subject: [PATCH 424/428] fix theme param expansion and noinclude strip --- internal/localitem/localitem_test.go | 44 ++++++++++++++++++++++++- internal/localitem/theme.go | 49 ++++++++++++++++++++++++---- 2 files changed, 86 insertions(+), 7 deletions(-) diff --git a/internal/localitem/localitem_test.go b/internal/localitem/localitem_test.go index 9fe494bd..b3715178 100644 --- a/internal/localitem/localitem_test.go +++ b/internal/localitem/localitem_test.go @@ -1,6 +1,9 @@ package localitem -import "testing" +import ( + "strings" + "testing" +) func TestSplitTakesTwoSegments(t *testing.T) { cases := []struct { @@ -63,6 +66,7 @@ func TestStripNoInclude(t *testing.T) { "a[[noinclude]]b": "a", "[[noinclude]]b[[/noinclude]]": "", "a[[/noinclude]]b[[noinclude]]c": "a[[/noinclude]]b", + "[[noinclude]]b[[/noinclude]]c": "c", } for source, want := range cases { if got := stripNoInclude(source); got != want { @@ -71,6 +75,44 @@ func TestStripNoInclude(t *testing.T) { } } +func TestStripNoIncludeManyPairs(t *testing.T) { + source := "x" + strings.Repeat("[[noinclude]]a[[/noinclude]]", 1<<16) + "y" + if got := stripNoInclude(source); got != "xy" { + t.Errorf("stripNoInclude(%d pairs) = %q, want %q", 1<<16, got, "xy") + } +} + +func TestExpandParams(t *testing.T) { + cases := []struct { + source string + params map[string]string + want string + }{ + {"color: {$c};", map[string]string{"c": "red"}, "color: red;"}, + {"{$a} {$b}", map[string]string{"a": "{$b}", "b": "x"}, "{$b} x"}, + {"{$b} {$a}", map[string]string{"a": "{$b}", "b": "x"}, "x {$b}"}, + {"{$missing}", map[string]string{"c": "red"}, "{$missing}"}, + {"plain", nil, "plain"}, + } + for _, c := range cases { + got, ok := expandParams(c.source, c.params) + if !ok || got != c.want { + t.Errorf("expandParams(%q, %v) = %q, %v, want %q, true", c.source, c.params, got, ok, c.want) + } + } +} + +func TestExpandParamsRefusesLargeGrowth(t *testing.T) { + source := strings.Repeat("{$a}", 1024) + value := strings.Repeat("x", 4096) + if got, ok := expandParams(source, map[string]string{"a": value}); ok { + t.Errorf("expandParams(1024 tokens, 4096 bytes) = %d bytes, true, want false", len(got)) + } + if _, ok := expandParams("{$a}", map[string]string{"a": value}); !ok { + t.Errorf("expandParams(1 token, 4096 bytes) ok = false, want true") + } +} + func TestBlockByHash(t *testing.T) { blocks := []string{"one", "two"} const secondHash = "e64f30f9218c6b2848f37c7dfb36593b" diff --git a/internal/localitem/theme.go b/internal/localitem/theme.go index 7b7b4689..e3daed2d 100644 --- a/internal/localitem/theme.go +++ b/internal/localitem/theme.go @@ -1,6 +1,7 @@ package localitem import ( + "net/http" "strings" "github.com/WikitTeam/ProjectWikit/internal/page" @@ -14,14 +15,19 @@ const ( noIncludeClose = "[[/noinclude]]" ) +// The parameters come from the query string, so anyone can make one value +// repeat across a page that names it many times. +const maxParamGrowth = 1 << 20 + func (h *handler) theme(req *request, rest string) (item, error) { if rest != themeFile { return missing(noResource), nil } - source := stripNoInclude(req.source) - for key, value := range stringMap(req.query.Get("includeParams")) { - source = strings.ReplaceAll(source, "{$"+key+"}", value) + source, ok := expandParams(stripNoInclude(req.source), stringMap(req.query.Get("includeParams"))) + if !ok { + return item{status: http.StatusRequestEntityTooLarge, contentType: textMime, + body: http.StatusText(http.StatusRequestEntityTooLarge)}, nil } info, err := req.env.PageInfo(req.article) @@ -39,15 +45,46 @@ func (h *handler) theme(req *request, rest string) (item, error) { // An opening tag with nothing closing it takes the rest of the source with it, // since what follows was written to stay out of an include either way. func stripNoInclude(source string) string { + var out strings.Builder for { start := strings.Index(source, noIncludeOpen) if start < 0 { - return source + if out.Len() == 0 { + return source + } + out.WriteString(source) + return out.String() } + out.WriteString(source[:start]) end := strings.Index(source[start:], noIncludeClose) if end < 0 { - return source[:start] + return out.String() } - source = source[:start] + source[start+end+len(noIncludeClose):] + source = source[start+end+len(noIncludeClose):] + } +} + +// One pass, so a value that spells another parameter stays as written instead +// of being expanded again. +func expandParams(source string, params map[string]string) (string, bool) { + pairs := make([]string, 0, 2*len(params)) + growth := 0 + for key, value := range params { + token := "{$" + key + "}" + n := strings.Count(source, token) + if n == 0 { + continue + } + pairs = append(pairs, token, value) + if extra := len(value) - len(token); extra > 0 { + growth += n * extra + if growth > maxParamGrowth { + return "", false + } + } + } + if len(pairs) == 0 { + return source, true } + return strings.NewReplacer(pairs...).Replace(source), true } From e46cf72f496700bd5ab87bdc3f3cc3d15e1bfad1 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 18:37:31 +0900 Subject: [PATCH 425/428] treat an empty database as having no site --- internal/db/site.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/internal/db/site.go b/internal/db/site.go index ba9e55a4..6d0ad49d 100644 --- a/internal/db/site.go +++ b/internal/db/site.go @@ -7,6 +7,7 @@ import ( "strings" "github.com/jackc/pgx/v5" + "github.com/jackc/pgx/v5/pgconn" ) type Site struct { @@ -82,6 +83,10 @@ func (d *DB) SiteBySlug(ctx context.Context, slug string) (*Site, error) { func (d *DB) SiteSlugs(ctx context.Context) ([]string, error) { rows, err := d.pool.Query(ctx, qSiteSlugs) + var pgErr *pgconn.PgError + if errors.As(err, &pgErr) && pgErr.Code == "42P01" { + return nil, nil + } if err != nil { return nil, fmt.Errorf("list sites: %w", err) } From 4f2c8c9392500a4e22f3be397eed3b221fc68f84 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 18:37:31 +0900 Subject: [PATCH 426/428] add import command --- cmd/pwikit/import.go | 120 +++++++++++++++++++++++++++++++++++++++++++ cmd/pwikit/main.go | 63 ++--------------------- 2 files changed, 124 insertions(+), 59 deletions(-) create mode 100644 cmd/pwikit/import.go diff --git a/cmd/pwikit/import.go b/cmd/pwikit/import.go new file mode 100644 index 00000000..50ee7a50 --- /dev/null +++ b/cmd/pwikit/import.go @@ -0,0 +1,120 @@ +package main + +import ( + "context" + "errors" + "flag" + "fmt" + "io/fs" + "os" + "slices" + + "github.com/WikitTeam/ProjectWikit/internal/archive" + "github.com/WikitTeam/ProjectWikit/internal/db" + "github.com/WikitTeam/ProjectWikit/internal/paths" +) + +func importCommand(args []string) error { + flags := flag.NewFlagSet("import", flag.ContinueOnError) + flags.Usage = func() { + fmt.Fprint(flags.Output(), `Usage: pwikit import [directory] [options] + +Imports an unpacked wikitCLI backup: a site directory, or the directory holding +several of them next to _users. Without a directory, archive/ in the state +directory is read. + +Options: +`) + flags.PrintDefaults() + } + database := flags.String("database", os.Getenv(envDatabase), "PostgreSQL connection string") + slug := flags.String("site", "", "slug of the site to write into; needed once a database holds more than one") + from := flags.String("from", "", "slug of the site inside the backup; needed when it holds more than one") + forceTags := flags.Bool("force-tags", false, "create tags this site would otherwise refuse") + noVotes := flags.Bool("no-votes", false, "leave the ratings behind") + noFiles := flags.Bool("no-files", false, "leave the attachments behind") + noAccounts := flags.Bool("no-accounts", false, "import even when the backup holds no accounts, leaving every author off") + dataDir := flags.String("data-dir", "", "state directory holding archive/ and receiving the attachments; defaults to the directory holding the executable") + loose, err := parseMixed(flags, args) + if err != nil { + if errors.Is(err, flag.ErrHelp) { + return nil + } + return err + } + if len(loose) > 1 { + return fmt.Errorf("import takes one directory, got %d", len(loose)) + } + + p, err := paths.New(*dataDir) + if err != nil { + return err + } + dir := p.Archive() + if len(loose) == 1 { + dir = loose[0] + } else if _, err := os.Stat(dir); errors.Is(err, fs.ErrNotExist) { + return fmt.Errorf("%s does not exist; put the unpacked backup there or name its directory", dir) + } + found, err := archive.Open(dir) + if err != nil { + return err + } + + ctx := context.Background() + dsn, release, err := resolveDatabase(ctx, *database, *dataDir) + if err != nil { + return err + } + defer release() + conn, err := db.Open(ctx, dsn) + if err != nil { + return err + } + defer conn.Close() + + current, err := resolveSite(ctx, conn, *slug) + if err != nil { + return err + } + + files := "" + if !*noFiles { + if err := p.EnsureBase(); err != nil { + return err + } + files = p.Files() + } + return importArchive(ctx, conn, current, found, *from, archive.Options{ + ForceTags: *forceTags, + Votes: !*noVotes, + Files: files, + WithoutAccounts: *noAccounts, + }) +} + +func importArchive(ctx context.Context, conn *db.DB, current *db.Site, found *archive.Archive, from string, opts archive.Options) error { + slugs := found.Sites() + switch { + case from == "" && len(slugs) > 1: + return fmt.Errorf("the backup holds %d sites, name one with -from", len(slugs)) + case from == "": + from = slugs[0] + case !slices.Contains(slugs, from): + return fmt.Errorf("the backup has no site %q", from) + } + + fmt.Printf("importing %s into %s\n", from, current.Slug) + opts.Report = func(line string) { fmt.Println(line) } + result, err := archive.ImportPages(ctx, conn, current.ID, found, from, opts) + if errors.Is(err, archive.ErrNoAccounts) { + return fmt.Errorf("%w, so nothing was imported. The accounts are in a _users directory, "+ + "usually beside the site directory; import the directory holding both, "+ + "or pass -no-accounts to import without authors", err) + } + fmt.Printf("%d pages, %d already there, %d revisions, %d parents, %d files, %d accounts\n", + result.Pages, result.Skipped, result.Revisions, result.Parents, result.Files, result.Users) + fmt.Printf("%d forum categories, %d threads, %d posts\n", + result.Categories, result.Threads, result.Posts) + return err +} diff --git a/cmd/pwikit/main.go b/cmd/pwikit/main.go index 421d23cb..01214307 100644 --- a/cmd/pwikit/main.go +++ b/cmd/pwikit/main.go @@ -19,7 +19,6 @@ import ( "github.com/WikitTeam/ProjectWikit/internal/account" "github.com/WikitTeam/ProjectWikit/internal/admin" - "github.com/WikitTeam/ProjectWikit/internal/archive" "github.com/WikitTeam/ProjectWikit/internal/backup" "github.com/WikitTeam/ProjectWikit/internal/compress" "github.com/WikitTeam/ProjectWikit/internal/config" @@ -115,6 +114,8 @@ func run(args []string) error { return backupCommand(args[1:]) case "seed": return seedPages(args[1:]) + case "import": + return importCommand(args[1:]) case "reindex": return reindex(args[1:]) case "service": @@ -144,6 +145,7 @@ Commands: admin create an administrator or give an account every right backup write, check, list or put back a backup seed write the pages a new site starts with + import import an unpacked wikidot backup reindex put every page of a site back into the search index service start pwikit whenever the machine boots path make pwikit runnable by name from any directory @@ -514,13 +516,7 @@ func seedPages(args []string) error { fs := flag.NewFlagSet("seed", flag.ContinueOnError) database := fs.String("database", os.Getenv(envDatabase), "PostgreSQL connection string") slug := fs.String("site", "", "slug of the site to write into; needed once a database holds more than one") - archivePath := fs.String("archive", "", "directory of an unpacked wikitCLI backup to import instead of the starter pages") - from := fs.String("from", "", "slug of the site inside the backup; needed when it holds more than one") - forceTags := fs.Bool("force-tags", false, "create tags this site would otherwise refuse") - noVotes := fs.Bool("no-votes", false, "leave the ratings behind") - noFiles := fs.Bool("no-files", false, "leave the attachments behind") - noAccounts := fs.Bool("no-accounts", false, "import even when the backup holds no accounts, leaving every author off") - dataDir := fs.String("data-dir", "", "state directory attachments are copied into; defaults to the directory holding the executable") + dataDir := fs.String("data-dir", "", "state directory; defaults to the directory holding the executable") if err := fs.Parse(args); err != nil { if errors.Is(err, flag.ErrHelp) { return nil @@ -544,26 +540,6 @@ func seedPages(args []string) error { return err } - if *archivePath != "" { - files := "" - if !*noFiles { - p, err := paths.New(*dataDir) - if err != nil { - return err - } - if err := p.EnsureBase(); err != nil { - return err - } - files = p.Files() - } - return importArchive(ctx, conn, current, *archivePath, *from, archive.Options{ - ForceTags: *forceTags, - Votes: !*noVotes, - Files: files, - WithoutAccounts: *noAccounts, - }) - } - written, err := seed.Run(ctx, conn, current.ID) for _, name := range written { fmt.Println("wrote " + name) @@ -767,37 +743,6 @@ func resolveSite(ctx context.Context, conn *db.DB, slug string) (*db.Site, error return nil, fmt.Errorf("this database holds %d sites, name one with -site", len(slugs)) } -func importArchive(ctx context.Context, conn *db.DB, current *db.Site, path, from string, opts archive.Options) error { - found, err := archive.Open(path) - if err != nil { - return err - } - - slugs := found.Sites() - switch { - case from == "" && len(slugs) > 1: - return fmt.Errorf("the backup holds %d sites, name one with -from", len(slugs)) - case from == "": - from = slugs[0] - case !slices.Contains(slugs, from): - return fmt.Errorf("the backup has no site %q", from) - } - - fmt.Printf("importing %s into %s\n", from, current.Slug) - opts.Report = func(line string) { fmt.Println(line) } - result, err := archive.ImportPages(ctx, conn, current.ID, found, from, opts) - if errors.Is(err, archive.ErrNoAccounts) { - return fmt.Errorf("%w, so nothing was imported. The accounts are in a _users directory, "+ - "usually beside the site directory; pass the directory holding both to -archive, "+ - "or pass -no-accounts to import without authors", err) - } - fmt.Printf("%d pages, %d already there, %d revisions, %d parents, %d files, %d accounts\n", - result.Pages, result.Skipped, result.Revisions, result.Parents, result.Files, result.Users) - fmt.Printf("%d forum categories, %d threads, %d posts\n", - result.Categories, result.Threads, result.Posts) - return err -} - func siteCommand(args []string) error { sub := "" if len(args) > 0 { From 798bec8200b887c1f8cc21e3ba9b05fdc10a2e5e Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 19:11:47 +0900 Subject: [PATCH 427/428] remove leftovers --- REVISIONS.md | 213 ----------------------------------- docker-compose.yaml | 22 ---- files/.gitkeep | 0 frontend/build.ts | 5 +- frontend/package.json | 2 +- ftml-capi/src/lib.rs | 3 +- internal/db/forum_test.go | 2 +- internal/media/mimetable.go | 1 - internal/page/corpus_test.go | 2 +- 9 files changed, 5 insertions(+), 245 deletions(-) delete mode 100644 REVISIONS.md delete mode 100644 docker-compose.yaml delete mode 100644 files/.gitkeep diff --git a/REVISIONS.md b/REVISIONS.md deleted file mode 100644 index 541c0265..00000000 --- a/REVISIONS.md +++ /dev/null @@ -1,213 +0,0 @@ -# Article revision format - -Our revisions are currently encoded using free-form JSONB. - -That might be changed in the future at some point; to keep some sane documentation for now, this file is used. - -Each revision is an instance of `ArticleLogEntry`. Thus, all of them have the following shared fields: - -- Article ID -- User ID -- Revision type -- Revision metadata (see below) -- Date -- Comment -- Revision index (within the article) - -Supported revision types currently: - -- `LogEntryType.Source`: source code change -- `LogEntryType.Title`: title change -- `LogEntryType.Name`: slug (URL, pageId) change -- `LogEntryType.Tags`: tag list change -- `LogEntryType.New`: formal revision that marks the creation of a page -- `LogEntryType.Parent`: parent page change -- `LogEntryType.FileAdded`: file added -- `LogEntryType.FileDeleted`: file deleted -- `LogEntryType.FileRenamed`: file renamed -- `LogEntryType.VotesDeleted`: votes deleted -- `LogEntryType.Wikidot`: wikidot revision; does nothing, cannot be reverted, contains comments (added for historical review) -- `LogEntryType.Revert`: revert revision - -Each of them has special format of metadata field; these are detailed below. - -## `LogEntryType.Source` - -```javascript -{ - "version_id": int /* ArticleVersion ID */ -} -``` - -## `LogEntryType.Title` - -```javascript -{ - "title": string, - "prev_title": string -} -``` - -## `LogEntryType.Name` - -```javascript -{ - "name": string, /* full slug, including category */ - "prev_name": string /* full slug, including category */ -} -``` - -## `LogEntryType.Tags` - -```javascript -{ - "added_tags": [{ - "id": int, /* Tag ID */ - "name": string /* full slug, including category; used only for visuals */ - }], - "removed_tags": [{ - "id": int, /* Tag ID */ - "name": string /* full slug, including category; used only for visuals */ - }] -} -``` - -## `LogEntryType.New` - -These values are _usually_ not used, just present tracking. - -This is because reverting revisions is done by undoing the change, and you can't undo the "new" revision. - -```javascript -{ - "version_id": int, /* ArticleVersion ID */ - "title": string /* initial title of article */ -} -``` - -## `LogEntryType.Parent` - -```javascript -{ - "parent": string, /* full slug, including category; used only for visuals */ - "prev_parent": string, /* full slug, including category; used only for visuals */ - "parent_id": int, /* Article ID */ - "prev_parent_id": int /* Article ID */ -} -``` - -## `LogEntryType.FileAdded` - -```javascript -{ - "id": int, /* File ID */ - "name": string -} -``` - -## `LogEntryType.FileDeleted` - -```javascript -{ - "id": int, /* File ID */ - "name": string -} -``` - -## `LogEntryType.FileRenamed` - -```javascript -{ - "id": int, /* File ID */ - "name": string, - "prev_name": string -} -``` - -## `LogEntryType.VotesDeleted` - -The system stores votes that were present at the moment of deletion. - -```javascript -{ - "rating_mode": string, /* Settings.RatingMode enum */ - "rating": int | float, /* sum or average, depending on rating mode */ - "votes_count": int, - "popularity": float, - "votes": [{ - "user_id": int, /* User ID */ - "vote": int | float, /* 1 or -1, or 0..5 float, depending on rating mode */ - "visual_group_id": int | null, /* VisualUserGroup ID */ - "date": string /* ISO 8601 datetime */ - }] -} -``` - -## `LogEntryType.Revert` - -Note that metadata fields here are optional depending on specific revert subtypes. - -```javascript -{ - "subtypes": [string], /* LogEntryType enum */ - "rev_number": int, /* revision index that was reverted to */ - /* present only for file-related subtypes */ - "files": { - /* present if subtype has FileAdded */ - "added": [{ - "id": int, /* File ID */ - "name": string - }], - /* present if subtype has FileDeleted */ - "deleted": [{ - "id": int, /* File ID */ - "name": string - }], - /* present if subtype has FileRenamed */ - "renamed": [{ - "id": int, /* File ID */ - "name": string, - "prev_name": string - }] - }, - /* present if subtype has Tags */ - "tags": { - "added": [int], /* Tag ID */ - "removed": [int] /* Tag ID */ - }, - /* present if subtype has Source */ - "source": { - "version_id": int /* ArticleVersion ID */ - }, - /* present if subtype has Title */ - "title": { - "title": string, - "prev_title": string - }, - /* present if subtype has Name */ - "name": { - "name": string, /* full slug, including category */ - "prev_name": string /* full slug, including category */ - }, - /* present if subtype has Parent */ - "parent": { - "parent": string, /* full slug, including category; used only for visuals */ - "prev_parent": string, /* full slug, including category; used only for visuals */ - "parent_id": int, /* Article ID */ - "prev_parent_id": int /* Article ID */ - }, - /* present if subtype has Votes */ - "votes": { - "rating_mode": string, /* Settings.RatingMode enum */ - "rating": int | float, /* sum or average, depending on rating mode */ - "votes_count": int, - "popularity": float, - "votes": [{ - "user_id": int, /* User ID */ - "vote": int | float, /* 1 or -1, or 0..5 float, depending on rating mode */ - "visual_group_id": int | null, /* VisualUserGroup ID */ - "date": string /* ISO 8601 datetime */ - }] - } -} -``` \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml deleted file mode 100644 index 3af6dcc7..00000000 --- a/docker-compose.yaml +++ /dev/null @@ -1,22 +0,0 @@ -name: ${COMPOSE_PROJECT_NAME:-wikitgo} -services: - postgres: - image: postgres:14 - restart: unless-stopped - volumes: - - ./postgresql:/var/lib/postgresql - - ./postgresql/data:/var/lib/postgresql/data - environment: - POSTGRES_USER: ${DB_PG_USERNAME:-admin} - POSTGRES_PASSWORD: ${DB_PG_PASSWORD:-wikitpassword} - POSTGRES_DB: ${DB_PG_DATABASE:-projwikit} - healthcheck: - test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"] - interval: 5s - timeout: 3s - retries: 3 - logging: - driver: json-file - options: - max-size: "10m" - max-file: "3" diff --git a/files/.gitkeep b/files/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/frontend/build.ts b/frontend/build.ts index f64d652a..d0c1ff90 100644 --- a/frontend/build.ts +++ b/frontend/build.ts @@ -12,10 +12,7 @@ const CJK = new RegExp('[\\u4e00-\\u9fff]') // app.js is what this script emits and fontawesome is vendored, so neither is // ours to fix; skipping them by name keeps the check from reporting its own output. -// static/admin is Django admin, which cannot reach the bundle's catalog and goes -// away with Django; giving it a catalog of its own would be a second table nobody -// maintains. -const SKIP_NAMES = ['node_modules', 'locales', 'fontawesome', 'app.js', 'admin'] +const SKIP_NAMES = ['node_modules', 'locales', 'fontawesome', 'app.js'] // Text belongs in locales/, reachable through t(). A literal here would render // the same in every language and nothing else would notice. diff --git a/frontend/package.json b/frontend/package.json index 71335e24..daaaeaf8 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -1,5 +1,5 @@ { - "name": "wikitgo-js", + "name": "pwikit-frontend", "version": "1.0.0", "description": "JS scripts", "main": "index.js", diff --git a/ftml-capi/src/lib.rs b/ftml-capi/src/lib.rs index 019fdeb0..927351dd 100644 --- a/ftml-capi/src/lib.rs +++ b/ftml-capi/src/lib.rs @@ -431,8 +431,7 @@ impl<'t, 'b> Includer<'t> for BridgeIncluder<'b> { f(self.0.host, refs.as_ptr(), refs.len(), &mut sink); // ftml wants one FetchedPage per request, in request order, while the - // host may answer a subset -- the Python binding's host does exactly - // that for pages it cannot find. + // host may leave out the pages it cannot find. let mut out = Vec::with_capacity(includes.len()); for (index, include) in includes.iter().enumerate() { let content = sink diff --git a/internal/db/forum_test.go b/internal/db/forum_test.go index e969cd68..a72c2bb2 100644 --- a/internal/db/forum_test.go +++ b/internal/db/forum_test.go @@ -106,7 +106,7 @@ func categoryNamed(t *testing.T, d *DB, ctx context.Context, name string) ForumC return c } } - t.Fatalf("ForumCategories() has no %q, want it; run oracle_seed.py first", name) + t.Fatalf("ForumCategories() has no %q, want it", name) return ForumCategory{} } diff --git a/internal/media/mimetable.go b/internal/media/mimetable.go index 07d250e5..a78302a0 100644 --- a/internal/media/mimetable.go +++ b/internal/media/mimetable.go @@ -1,6 +1,5 @@ package media -// Generated from testdata/oracle_mime.py; do not edit by hand. // mime.TypeByExtension is a different table and reads the Windows registry, // which would make a file's Content-Type depend on the machine. diff --git a/internal/page/corpus_test.go b/internal/page/corpus_test.go index 1e91c49d..5f89a64d 100644 --- a/internal/page/corpus_test.go +++ b/internal/page/corpus_test.go @@ -100,7 +100,7 @@ func TestVarsMatchOracle(t *testing.T) { for _, entry := range corpus.Articles { article, err := conn.ArticleByName(ctx, site.ID, entry.Name) if err != nil { - t.Fatalf("ArticleByName(%q) = %v, want nil; run testdata/oracle_seed.py", entry.Name, err) + t.Fatalf("ArticleByName(%q) = %v, want nil", entry.Name, err) } var viewer *db.User if entry.Viewer != "" { From 7ab3387252726dcec1b06994f19637735d150ec8 Mon Sep 17 00:00:00 2001 From: Kakushi <70345058+kakushi-w@users.noreply.github.com> Date: Mon, 14 Sep 2026 19:27:02 +0900 Subject: [PATCH 428/428] drop old entries from gitignore --- .gitignore | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index c1961afa..9d2ecf1f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,13 +1,11 @@ .idea .DS_Store *.log -*.pyc node_modules target .env *.env -files/* -!files/.gitkeep +/files /archive /locales /secrets
+ +
+
+
+ +
+ +
+
+
+ {{esc .Title}} +
+ {{if gt (len .Breadcrumbs) 1}}{{$last := sub (len .Breadcrumbs) 1}} + + {{end}} +
+ {{.Content}} +
+
+ +
+ {{range .TagCategories}} +
+ {{esc .Name}}: + {{range .Tags}} + {{if not .Hidden}} + {{esc .Name}} + {{end}} + {{end}} +
+ {{end}} +
+ +
+
+ {{if not .UpdatedAt.IsZero}} +
{{.PageInfo}}
+ {{end}} +
+
+
+
+ +
+ {{.License}} +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+