mirror of
https://github.com/FoxxMD/context-mod.git
synced 2026-01-14 16:08:02 -05:00
Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
aaed0d3419 | ||
|
|
2a77c71645 | ||
|
|
780e5c185e | ||
|
|
38e2a4e69a | ||
|
|
7e0c34b6a3 | ||
|
|
e3ceb90d6f | ||
|
|
6977e3bcdf | ||
|
|
f382cddc2a | ||
|
|
99a5642bdf | ||
|
|
174d832ab0 | ||
|
|
3ee7586fe2 | ||
|
|
e2c724b4ae | ||
|
|
d581f19a36 | ||
|
|
48dea24bea | ||
|
|
5fc2a693a0 | ||
|
|
7be0722140 | ||
|
|
6ab9fe4bf4 | ||
|
|
5811af0342 | ||
|
|
ed2924264a | ||
|
|
e9394ccf2e | ||
|
|
dec72f95c6 |
9
.gitignore
vendored
9
.gitignore
vendored
@@ -383,3 +383,12 @@ dist
|
||||
**/src/**/*.js
|
||||
!src/Web/assets/public/yaml/*
|
||||
**/src/**/*.map
|
||||
/**/*.sqlite
|
||||
/**/*.bak
|
||||
*.yaml
|
||||
*.json5
|
||||
|
||||
!src/Schema/*.json
|
||||
!docs/**/*.json5
|
||||
!docs/**/*.yaml
|
||||
!docs/**/*.json
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
[](https://github.com/FoxxMD/context-mod/releases)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://hub.docker.com/r/foxxmd/context-mod)
|
||||
# ContextMod [](https://github.com/FoxxMD/context-mod/releases) [](https://opensource.org/licenses/MIT) [](https://hub.docker.com/r/foxxmd/context-mod)
|
||||
|
||||
<img src="/docs/logo.png" align="right"
|
||||
alt="ContextMod logo" width="180" height="176">
|
||||
|
||||
**Context Mod** (CM) is an event-based, [reddit](https://reddit.com) moderation bot built on top of [snoowrap](https://github.com/not-an-aardvark/snoowrap) and written in [typescript](https://www.typescriptlang.org/).
|
||||
|
||||
|
||||
BIN
docs/logo.png
Normal file
BIN
docs/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
202
package-lock.json
generated
202
package-lock.json
generated
@@ -20,6 +20,7 @@
|
||||
"cache-manager": "^3.4.4",
|
||||
"cache-manager-redis-store": "^2.0.0",
|
||||
"commander": "^8.0.0",
|
||||
"comment-json": "^4.1.1",
|
||||
"cookie-parser": "^1.3.5",
|
||||
"dayjs": "^1.10.5",
|
||||
"deepmerge": "^4.2.2",
|
||||
@@ -37,7 +38,6 @@
|
||||
"he": "^1.2.0",
|
||||
"http-proxy": "^1.18.1",
|
||||
"image-size": "^1.0.0",
|
||||
"js-yaml": "^4.1.0",
|
||||
"json5": "^2.2.0",
|
||||
"jsonwebtoken": "^8.5.1",
|
||||
"leven": "^3.1.0",
|
||||
@@ -67,6 +67,7 @@
|
||||
"winston-daily-rotate-file": "^4.5.5",
|
||||
"winston-duplex": "^0.1.1",
|
||||
"winston-transport": "^4.4.0",
|
||||
"yaml": "2.0.0-10",
|
||||
"zlib": "^1.0.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
@@ -96,6 +97,7 @@
|
||||
"@types/string-similarity": "^4.0.0",
|
||||
"@types/tcp-port-used": "^1.0.0",
|
||||
"@types/triple-beam": "^1.3.2",
|
||||
"ts-essentials": "^9.1.2",
|
||||
"ts-json-schema-generator": "^0.93.0",
|
||||
"typescript-json-schema": "^0.50.1"
|
||||
},
|
||||
@@ -758,16 +760,16 @@
|
||||
"integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/argparse": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
|
||||
"integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
|
||||
},
|
||||
"node_modules/array-flatten": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz",
|
||||
"integrity": "sha1-ml9pkFGx5wczKPKgCJaLZOopVdI="
|
||||
},
|
||||
"node_modules/array-timsort": {
|
||||
"version": "1.0.3",
|
||||
"resolved": "https://registry.npmjs.org/array-timsort/-/array-timsort-1.0.3.tgz",
|
||||
"integrity": "sha512-/+3GRL7dDAGEfM6TseQk/U+mi18TU2Ms9I3UlLdUMhz2hbvGNTKdj9xniwXfUqgYhHxRx0+8UnKkvlNwVU+cWQ=="
|
||||
},
|
||||
"node_modules/arrify": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/arrify/-/arrify-2.0.1.tgz",
|
||||
@@ -1235,6 +1237,21 @@
|
||||
"node": ">= 12"
|
||||
}
|
||||
},
|
||||
"node_modules/comment-json": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/comment-json/-/comment-json-4.1.1.tgz",
|
||||
"integrity": "sha512-v8gmtPvxhBlhdRBLwdHSjGy9BgA23t9H1FctdQKyUrErPjSrJcdDMqBq9B4Irtm7w3TNYLQJNH6ARKnpyag1sA==",
|
||||
"dependencies": {
|
||||
"array-timsort": "^1.0.3",
|
||||
"core-util-is": "^1.0.2",
|
||||
"esprima": "^4.0.1",
|
||||
"has-own-prop": "^2.0.0",
|
||||
"repeat-string": "^1.6.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 6"
|
||||
}
|
||||
},
|
||||
"node_modules/component-emitter": {
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.0.tgz",
|
||||
@@ -1298,8 +1315,7 @@
|
||||
"node_modules/core-util-is": {
|
||||
"version": "1.0.3",
|
||||
"resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz",
|
||||
"integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==",
|
||||
"optional": true
|
||||
"integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ=="
|
||||
},
|
||||
"node_modules/cors": {
|
||||
"version": "2.8.5",
|
||||
@@ -1547,9 +1563,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/engine.io": {
|
||||
"version": "6.1.0",
|
||||
"resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.1.0.tgz",
|
||||
"integrity": "sha512-ErhZOVu2xweCjEfYcTdkCnEYUiZgkAcBBAhW4jbIvNG8SLU3orAqoJCiytZjYF7eTpVmmCrLDjLIEaPlUAs1uw==",
|
||||
"version": "6.1.1",
|
||||
"resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.1.1.tgz",
|
||||
"integrity": "sha512-AyMc20q8JUUdvKd46+thc9o7yCZ6iC6MoBCChG5Z1XmFMpp+2+y/oKvwpZTUJB0KCjxScw1dV9c2h5pjiYBLuQ==",
|
||||
"dependencies": {
|
||||
"@types/cookie": "^0.4.1",
|
||||
"@types/cors": "^2.8.12",
|
||||
@@ -1668,6 +1684,18 @@
|
||||
"node": ">=0.8.0"
|
||||
}
|
||||
},
|
||||
"node_modules/esprima": {
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
|
||||
"integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==",
|
||||
"bin": {
|
||||
"esparse": "bin/esparse.js",
|
||||
"esvalidate": "bin/esvalidate.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=4"
|
||||
}
|
||||
},
|
||||
"node_modules/etag": {
|
||||
"version": "1.8.1",
|
||||
"resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz",
|
||||
@@ -1888,9 +1916,9 @@
|
||||
"integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw=="
|
||||
},
|
||||
"node_modules/follow-redirects": {
|
||||
"version": "1.14.6",
|
||||
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.6.tgz",
|
||||
"integrity": "sha512-fhUl5EwSJbbl8AR+uYL2KQDxLkdSjZGR36xy46AO7cOMTrCMON6Sa28FmAnC2tRTDbd/Uuzz3aJBv7EBN7JH8A==",
|
||||
"version": "1.14.7",
|
||||
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.7.tgz",
|
||||
"integrity": "sha512-+hbxoLbFMbRKDwohX8GkTataGqO6Jb7jGwpAlwgy2bIz25XtRm7KEzJM76R1WiNT5SwZkX4Y75SwBolkpmE7iQ==",
|
||||
"funding": [
|
||||
{
|
||||
"type": "individual",
|
||||
@@ -2084,11 +2112,11 @@
|
||||
}
|
||||
},
|
||||
"node_modules/google-p12-pem": {
|
||||
"version": "3.1.2",
|
||||
"resolved": "https://registry.npmjs.org/google-p12-pem/-/google-p12-pem-3.1.2.tgz",
|
||||
"integrity": "sha512-tjf3IQIt7tWCDsa0ofDQ1qqSCNzahXDxdAGJDbruWqu3eCg5CKLYKN+hi0s6lfvzYZ1GDVr+oDF9OOWlDSdf0A==",
|
||||
"version": "3.1.3",
|
||||
"resolved": "https://registry.npmjs.org/google-p12-pem/-/google-p12-pem-3.1.3.tgz",
|
||||
"integrity": "sha512-MC0jISvzymxePDVembypNefkAQp+DRP7dBE+zNUPaIjEspIlYg0++OrsNr248V9tPbz6iqtZ7rX1hxWA5B8qBQ==",
|
||||
"dependencies": {
|
||||
"node-forge": "^0.10.0"
|
||||
"node-forge": "^1.0.0"
|
||||
},
|
||||
"bin": {
|
||||
"gp12-pem": "build/src/bin/gp12-pem.js"
|
||||
@@ -2204,6 +2232,14 @@
|
||||
"node": ">=4"
|
||||
}
|
||||
},
|
||||
"node_modules/has-own-prop": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/has-own-prop/-/has-own-prop-2.0.0.tgz",
|
||||
"integrity": "sha512-Pq0h+hvsVm6dDEa8x82GnLSYHOzNDt7f0ddFa3FqcQlgzEiptPqL+XrOJNavjOzSYiYWIrgeVYYgGlLmnxwilQ==",
|
||||
"engines": {
|
||||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/has-unicode": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz",
|
||||
@@ -2488,17 +2524,6 @@
|
||||
"resolved": "https://registry.npmjs.org/async/-/async-0.9.2.tgz",
|
||||
"integrity": "sha1-rqdNXmHB+JlhO/ZL2mbUx48v0X0="
|
||||
},
|
||||
"node_modules/js-yaml": {
|
||||
"version": "4.1.0",
|
||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
|
||||
"integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
|
||||
"dependencies": {
|
||||
"argparse": "^2.0.1"
|
||||
},
|
||||
"bin": {
|
||||
"js-yaml": "bin/js-yaml.js"
|
||||
}
|
||||
},
|
||||
"node_modules/jsbn": {
|
||||
"version": "0.1.1",
|
||||
"resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz",
|
||||
@@ -2911,11 +2936,11 @@
|
||||
}
|
||||
},
|
||||
"node_modules/node-forge": {
|
||||
"version": "0.10.0",
|
||||
"resolved": "https://registry.npmjs.org/node-forge/-/node-forge-0.10.0.tgz",
|
||||
"integrity": "sha512-PPmu8eEeG9saEUvI97fm4OYxXVB6bFvyNTyiUOBichBpFG8A1Ljw3bY62+5oOjDEMHRnd0Y7HQ+x7uzxOzC6JA==",
|
||||
"version": "1.2.1",
|
||||
"resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.2.1.tgz",
|
||||
"integrity": "sha512-Fcvtbb+zBcZXbTTVwqGA5W+MKBj56UjVRevvchv5XrcyXbmNdesfZL37nlcWOfpgHhgmxApw3tQbTr4CqNmX4w==",
|
||||
"engines": {
|
||||
"node": ">= 6.0.0"
|
||||
"node": ">= 6.13.0"
|
||||
}
|
||||
},
|
||||
"node_modules/normalize-url": {
|
||||
@@ -3381,6 +3406,14 @@
|
||||
"node": ">=4"
|
||||
}
|
||||
},
|
||||
"node_modules/repeat-string": {
|
||||
"version": "1.6.1",
|
||||
"resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz",
|
||||
"integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=",
|
||||
"engines": {
|
||||
"node": ">=0.10"
|
||||
}
|
||||
},
|
||||
"node_modules/request": {
|
||||
"version": "2.88.2",
|
||||
"resolved": "https://registry.npmjs.org/request/-/request-2.88.2.tgz",
|
||||
@@ -4083,6 +4116,15 @@
|
||||
"resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.3.0.tgz",
|
||||
"integrity": "sha512-XrHUvV5HpdLmIj4uVMxHggLbFSZYIn7HEWsqePZcI50pco+MPqJ50wMGY794X7AOOhxOBAjbkqfAbEe/QMp2Lw=="
|
||||
},
|
||||
"node_modules/ts-essentials": {
|
||||
"version": "9.1.2",
|
||||
"resolved": "https://registry.npmjs.org/ts-essentials/-/ts-essentials-9.1.2.tgz",
|
||||
"integrity": "sha512-EaSmXsAhEiirrTY1Oaa7TSpei9dzuCuFPmjKRJRPamERYtfaGS8/KpOSbjergLz/Y76/aZlV9i/krgzsuWEBbg==",
|
||||
"dev": true,
|
||||
"peerDependencies": {
|
||||
"typescript": ">=4.1.0"
|
||||
}
|
||||
},
|
||||
"node_modules/ts-json-schema-generator": {
|
||||
"version": "0.93.0",
|
||||
"resolved": "https://registry.npmjs.org/ts-json-schema-generator/-/ts-json-schema-generator-0.93.0.tgz",
|
||||
@@ -4580,6 +4622,14 @@
|
||||
"resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
|
||||
"integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
|
||||
},
|
||||
"node_modules/yaml": {
|
||||
"version": "2.0.0-10",
|
||||
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.0.0-10.tgz",
|
||||
"integrity": "sha512-FHV8s5ODFFQXX/enJEU2EkanNl1UDBUz8oa4k5Qo/sR+Iq7VmhCDkRMb0/mjJCNeAWQ31W8WV6PYStDE4d9EIw==",
|
||||
"engines": {
|
||||
"node": ">= 12"
|
||||
}
|
||||
},
|
||||
"node_modules/yargs": {
|
||||
"version": "16.2.0",
|
||||
"resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz",
|
||||
@@ -5198,16 +5248,16 @@
|
||||
"integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==",
|
||||
"dev": true
|
||||
},
|
||||
"argparse": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
|
||||
"integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
|
||||
},
|
||||
"array-flatten": {
|
||||
"version": "1.1.1",
|
||||
"resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz",
|
||||
"integrity": "sha1-ml9pkFGx5wczKPKgCJaLZOopVdI="
|
||||
},
|
||||
"array-timsort": {
|
||||
"version": "1.0.3",
|
||||
"resolved": "https://registry.npmjs.org/array-timsort/-/array-timsort-1.0.3.tgz",
|
||||
"integrity": "sha512-/+3GRL7dDAGEfM6TseQk/U+mi18TU2Ms9I3UlLdUMhz2hbvGNTKdj9xniwXfUqgYhHxRx0+8UnKkvlNwVU+cWQ=="
|
||||
},
|
||||
"arrify": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/arrify/-/arrify-2.0.1.tgz",
|
||||
@@ -5588,6 +5638,18 @@
|
||||
"resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz",
|
||||
"integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww=="
|
||||
},
|
||||
"comment-json": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/comment-json/-/comment-json-4.1.1.tgz",
|
||||
"integrity": "sha512-v8gmtPvxhBlhdRBLwdHSjGy9BgA23t9H1FctdQKyUrErPjSrJcdDMqBq9B4Irtm7w3TNYLQJNH6ARKnpyag1sA==",
|
||||
"requires": {
|
||||
"array-timsort": "^1.0.3",
|
||||
"core-util-is": "^1.0.2",
|
||||
"esprima": "^4.0.1",
|
||||
"has-own-prop": "^2.0.0",
|
||||
"repeat-string": "^1.6.1"
|
||||
}
|
||||
},
|
||||
"component-emitter": {
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.0.tgz",
|
||||
@@ -5639,8 +5701,7 @@
|
||||
"core-util-is": {
|
||||
"version": "1.0.3",
|
||||
"resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz",
|
||||
"integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==",
|
||||
"optional": true
|
||||
"integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ=="
|
||||
},
|
||||
"cors": {
|
||||
"version": "2.8.5",
|
||||
@@ -5830,9 +5891,9 @@
|
||||
}
|
||||
},
|
||||
"engine.io": {
|
||||
"version": "6.1.0",
|
||||
"resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.1.0.tgz",
|
||||
"integrity": "sha512-ErhZOVu2xweCjEfYcTdkCnEYUiZgkAcBBAhW4jbIvNG8SLU3orAqoJCiytZjYF7eTpVmmCrLDjLIEaPlUAs1uw==",
|
||||
"version": "6.1.1",
|
||||
"resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.1.1.tgz",
|
||||
"integrity": "sha512-AyMc20q8JUUdvKd46+thc9o7yCZ6iC6MoBCChG5Z1XmFMpp+2+y/oKvwpZTUJB0KCjxScw1dV9c2h5pjiYBLuQ==",
|
||||
"requires": {
|
||||
"@types/cookie": "^0.4.1",
|
||||
"@types/cors": "^2.8.12",
|
||||
@@ -5912,6 +5973,11 @@
|
||||
"resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
|
||||
"integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ="
|
||||
},
|
||||
"esprima": {
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz",
|
||||
"integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A=="
|
||||
},
|
||||
"etag": {
|
||||
"version": "1.8.1",
|
||||
"resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz",
|
||||
@@ -6107,9 +6173,9 @@
|
||||
"integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw=="
|
||||
},
|
||||
"follow-redirects": {
|
||||
"version": "1.14.6",
|
||||
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.6.tgz",
|
||||
"integrity": "sha512-fhUl5EwSJbbl8AR+uYL2KQDxLkdSjZGR36xy46AO7cOMTrCMON6Sa28FmAnC2tRTDbd/Uuzz3aJBv7EBN7JH8A=="
|
||||
"version": "1.14.7",
|
||||
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.7.tgz",
|
||||
"integrity": "sha512-+hbxoLbFMbRKDwohX8GkTataGqO6Jb7jGwpAlwgy2bIz25XtRm7KEzJM76R1WiNT5SwZkX4Y75SwBolkpmE7iQ=="
|
||||
},
|
||||
"forever-agent": {
|
||||
"version": "0.6.1",
|
||||
@@ -6250,11 +6316,11 @@
|
||||
}
|
||||
},
|
||||
"google-p12-pem": {
|
||||
"version": "3.1.2",
|
||||
"resolved": "https://registry.npmjs.org/google-p12-pem/-/google-p12-pem-3.1.2.tgz",
|
||||
"integrity": "sha512-tjf3IQIt7tWCDsa0ofDQ1qqSCNzahXDxdAGJDbruWqu3eCg5CKLYKN+hi0s6lfvzYZ1GDVr+oDF9OOWlDSdf0A==",
|
||||
"version": "3.1.3",
|
||||
"resolved": "https://registry.npmjs.org/google-p12-pem/-/google-p12-pem-3.1.3.tgz",
|
||||
"integrity": "sha512-MC0jISvzymxePDVembypNefkAQp+DRP7dBE+zNUPaIjEspIlYg0++OrsNr248V9tPbz6iqtZ7rX1hxWA5B8qBQ==",
|
||||
"requires": {
|
||||
"node-forge": "^0.10.0"
|
||||
"node-forge": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"googleapis-common": {
|
||||
@@ -6340,6 +6406,11 @@
|
||||
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
|
||||
"integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0="
|
||||
},
|
||||
"has-own-prop": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/has-own-prop/-/has-own-prop-2.0.0.tgz",
|
||||
"integrity": "sha512-Pq0h+hvsVm6dDEa8x82GnLSYHOzNDt7f0ddFa3FqcQlgzEiptPqL+XrOJNavjOzSYiYWIrgeVYYgGlLmnxwilQ=="
|
||||
},
|
||||
"has-unicode": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz",
|
||||
@@ -6551,14 +6622,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"js-yaml": {
|
||||
"version": "4.1.0",
|
||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
|
||||
"integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
|
||||
"requires": {
|
||||
"argparse": "^2.0.1"
|
||||
}
|
||||
},
|
||||
"jsbn": {
|
||||
"version": "0.1.1",
|
||||
"resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz",
|
||||
@@ -6907,9 +6970,9 @@
|
||||
}
|
||||
},
|
||||
"node-forge": {
|
||||
"version": "0.10.0",
|
||||
"resolved": "https://registry.npmjs.org/node-forge/-/node-forge-0.10.0.tgz",
|
||||
"integrity": "sha512-PPmu8eEeG9saEUvI97fm4OYxXVB6bFvyNTyiUOBichBpFG8A1Ljw3bY62+5oOjDEMHRnd0Y7HQ+x7uzxOzC6JA=="
|
||||
"version": "1.2.1",
|
||||
"resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.2.1.tgz",
|
||||
"integrity": "sha512-Fcvtbb+zBcZXbTTVwqGA5W+MKBj56UjVRevvchv5XrcyXbmNdesfZL37nlcWOfpgHhgmxApw3tQbTr4CqNmX4w=="
|
||||
},
|
||||
"normalize-url": {
|
||||
"version": "6.1.0",
|
||||
@@ -7258,6 +7321,11 @@
|
||||
"redis-errors": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"repeat-string": {
|
||||
"version": "1.6.1",
|
||||
"resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz",
|
||||
"integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc="
|
||||
},
|
||||
"request": {
|
||||
"version": "2.88.2",
|
||||
"resolved": "https://registry.npmjs.org/request/-/request-2.88.2.tgz",
|
||||
@@ -7791,6 +7859,13 @@
|
||||
"resolved": "https://registry.npmjs.org/triple-beam/-/triple-beam-1.3.0.tgz",
|
||||
"integrity": "sha512-XrHUvV5HpdLmIj4uVMxHggLbFSZYIn7HEWsqePZcI50pco+MPqJ50wMGY794X7AOOhxOBAjbkqfAbEe/QMp2Lw=="
|
||||
},
|
||||
"ts-essentials": {
|
||||
"version": "9.1.2",
|
||||
"resolved": "https://registry.npmjs.org/ts-essentials/-/ts-essentials-9.1.2.tgz",
|
||||
"integrity": "sha512-EaSmXsAhEiirrTY1Oaa7TSpei9dzuCuFPmjKRJRPamERYtfaGS8/KpOSbjergLz/Y76/aZlV9i/krgzsuWEBbg==",
|
||||
"dev": true,
|
||||
"requires": {}
|
||||
},
|
||||
"ts-json-schema-generator": {
|
||||
"version": "0.93.0",
|
||||
"resolved": "https://registry.npmjs.org/ts-json-schema-generator/-/ts-json-schema-generator-0.93.0.tgz",
|
||||
@@ -8175,6 +8250,11 @@
|
||||
"resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
|
||||
"integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
|
||||
},
|
||||
"yaml": {
|
||||
"version": "2.0.0-10",
|
||||
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.0.0-10.tgz",
|
||||
"integrity": "sha512-FHV8s5ODFFQXX/enJEU2EkanNl1UDBUz8oa4k5Qo/sR+Iq7VmhCDkRMb0/mjJCNeAWQ31W8WV6PYStDE4d9EIw=="
|
||||
},
|
||||
"yargs": {
|
||||
"version": "16.2.0",
|
||||
"resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz",
|
||||
|
||||
@@ -35,6 +35,7 @@
|
||||
"cache-manager": "^3.4.4",
|
||||
"cache-manager-redis-store": "^2.0.0",
|
||||
"commander": "^8.0.0",
|
||||
"comment-json": "^4.1.1",
|
||||
"cookie-parser": "^1.3.5",
|
||||
"dayjs": "^1.10.5",
|
||||
"deepmerge": "^4.2.2",
|
||||
@@ -52,7 +53,6 @@
|
||||
"he": "^1.2.0",
|
||||
"http-proxy": "^1.18.1",
|
||||
"image-size": "^1.0.0",
|
||||
"js-yaml": "^4.1.0",
|
||||
"json5": "^2.2.0",
|
||||
"jsonwebtoken": "^8.5.1",
|
||||
"leven": "^3.1.0",
|
||||
@@ -82,6 +82,7 @@
|
||||
"winston-daily-rotate-file": "^4.5.5",
|
||||
"winston-duplex": "^0.1.1",
|
||||
"winston-transport": "^4.4.0",
|
||||
"yaml": "2.0.0-10",
|
||||
"zlib": "^1.0.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
@@ -111,6 +112,7 @@
|
||||
"@types/string-similarity": "^4.0.0",
|
||||
"@types/tcp-port-used": "^1.0.0",
|
||||
"@types/triple-beam": "^1.3.2",
|
||||
"ts-essentials": "^9.1.2",
|
||||
"ts-json-schema-generator": "^0.93.0",
|
||||
"typescript-json-schema": "^0.50.1"
|
||||
},
|
||||
|
||||
@@ -1,31 +1,62 @@
|
||||
import {ActionJson, ActionConfig} from "./index";
|
||||
import {ActionJson, ActionConfig, ActionOptions} from "./index";
|
||||
import Action from "./index";
|
||||
import Snoowrap, {Comment, Submission} from "snoowrap";
|
||||
import Snoowrap from "snoowrap";
|
||||
import {RuleResult} from "../Rule";
|
||||
import {ActionProcessResult} from "../Common/interfaces";
|
||||
import Submission from "snoowrap/dist/objects/Submission";
|
||||
import Comment from "snoowrap/dist/objects/Comment";
|
||||
|
||||
export class ApproveAction extends Action {
|
||||
|
||||
targets: ApproveTarget[]
|
||||
|
||||
getKind() {
|
||||
return 'Approve';
|
||||
}
|
||||
|
||||
constructor(options: ApproveOptions) {
|
||||
super(options);
|
||||
const {
|
||||
targets = ['self']
|
||||
} = options;
|
||||
|
||||
this.targets = targets;
|
||||
}
|
||||
|
||||
async process(item: Comment | Submission, ruleResults: RuleResult[], runtimeDryrun?: boolean): Promise<ActionProcessResult> {
|
||||
const dryRun = runtimeDryrun || this.dryRun;
|
||||
const touchedEntities = [];
|
||||
//snoowrap typing issue, thinks comments can't be locked
|
||||
// @ts-ignore
|
||||
if (item.approved) {
|
||||
this.logger.warn('Item is already approved');
|
||||
return {
|
||||
dryRun,
|
||||
success: false,
|
||||
result: 'Item is already approved'
|
||||
|
||||
const realTargets = item instanceof Submission ? ['self'] : this.targets;
|
||||
|
||||
for(const target of realTargets) {
|
||||
let targetItem = item;
|
||||
if(target !== 'self' && item instanceof Comment) {
|
||||
targetItem = await this.resources.getActivity(this.client.getSubmission(item.link_id));
|
||||
}
|
||||
|
||||
// @ts-ignore
|
||||
if (item.approved) {
|
||||
const msg = `${target === 'self' ? 'Item' : 'Comment\'s parent Submission'} is already approved`;
|
||||
this.logger.warn(msg);
|
||||
return {
|
||||
dryRun,
|
||||
success: false,
|
||||
result: msg
|
||||
}
|
||||
}
|
||||
|
||||
if (!dryRun) {
|
||||
// make sure we have an actual item and not just a plain object from cache
|
||||
if(target !== 'self' && !(targetItem instanceof Submission)) {
|
||||
// @ts-ignore
|
||||
targetItem = await this.client.getSubmission((item as Comment).link_id).fetch();
|
||||
}
|
||||
// @ts-ignore
|
||||
touchedEntities.push(await targetItem.approve());
|
||||
}
|
||||
}
|
||||
if (!dryRun) {
|
||||
// @ts-ignore
|
||||
touchedEntities.push(await item.approve());
|
||||
}
|
||||
|
||||
return {
|
||||
dryRun,
|
||||
success: true,
|
||||
@@ -34,8 +65,20 @@ export class ApproveAction extends Action {
|
||||
}
|
||||
}
|
||||
|
||||
export interface ApproveActionConfig extends ActionConfig {
|
||||
export type ApproveTarget = 'self' | 'parent';
|
||||
|
||||
export interface ApproveOptions extends ApproveActionConfig, ActionOptions {}
|
||||
|
||||
export interface ApproveActionConfig extends ActionConfig {
|
||||
/**
|
||||
* Specify which Activities to approve
|
||||
*
|
||||
* This setting is only applicable if the Activity being acted on is a **comment**. On a **submission** the setting does nothing
|
||||
*
|
||||
* * self => approve activity being checked (comment)
|
||||
* * parent => approve parent (submission) of activity being checked (comment)
|
||||
* */
|
||||
targets?: ApproveTarget[]
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -12,7 +12,7 @@ export class UserFlairAction extends Action {
|
||||
super(options);
|
||||
|
||||
this.text = options.text === null || options.text === '' ? undefined : options.text;
|
||||
this.css = options.css === null || options.text === '' ? undefined : options.text;
|
||||
this.css = options.css === null || options.css === '' ? undefined : options.css;
|
||||
this.flair_template_id = options.flair_template_id === null || options.flair_template_id === '' ? undefined : options.flair_template_id;
|
||||
}
|
||||
|
||||
|
||||
12
src/App.ts
12
src/App.ts
@@ -1,7 +1,7 @@
|
||||
import winston, {Logger} from "winston";
|
||||
import dayjs, {Dayjs} from "dayjs";
|
||||
import {getLogger} from "./Utils/loggerFactory";
|
||||
import {Invokee, OperatorConfig} from "./Common/interfaces";
|
||||
import {Invokee, OperatorConfig, OperatorConfigWithFileContext, OperatorFileConfig} from "./Common/interfaces";
|
||||
import Bot from "./Bot";
|
||||
import LoggedError from "./Utils/LoggedError";
|
||||
import {sleep} from "./util";
|
||||
@@ -14,7 +14,10 @@ export class App {
|
||||
|
||||
error: any;
|
||||
|
||||
constructor(config: OperatorConfig) {
|
||||
config: OperatorConfig;
|
||||
fileConfig: OperatorFileConfig;
|
||||
|
||||
constructor(config: OperatorConfigWithFileContext) {
|
||||
const {
|
||||
operator: {
|
||||
name,
|
||||
@@ -23,6 +26,11 @@ export class App {
|
||||
bots = [],
|
||||
} = config;
|
||||
|
||||
const {fileConfig, ...rest} = config;
|
||||
|
||||
this.config = rest;
|
||||
this.fileConfig = fileConfig;
|
||||
|
||||
this.logger = getLogger(config.logging);
|
||||
|
||||
this.logger.info(`Operators: ${name.length === 0 ? 'None Specified' : name.join(', ')}`)
|
||||
|
||||
@@ -46,15 +46,20 @@ export interface AuthorCriteria {
|
||||
* */
|
||||
name?: string[],
|
||||
/**
|
||||
* A list of (user) flair css class values from the subreddit to match against
|
||||
* A (user) flair css class (or list of) from the subreddit to match against
|
||||
* @examples ["red"]
|
||||
* */
|
||||
flairCssClass?: string[],
|
||||
flairCssClass?: string | string[],
|
||||
/**
|
||||
* A list of (user) flair text values from the subreddit to match against
|
||||
* A (user) flair text value (or list of) from the subreddit to match against
|
||||
* @examples ["Approved"]
|
||||
* */
|
||||
flairText?: string[],
|
||||
flairText?: string | string[],
|
||||
|
||||
/**
|
||||
* A (user) flair template id (or list of) from the subreddit to match against
|
||||
* */
|
||||
flairTemplate?: string | string[]
|
||||
/**
|
||||
* Is the author a moderator?
|
||||
* */
|
||||
@@ -146,8 +151,12 @@ export class Author implements AuthorCriteria {
|
||||
|
||||
constructor(options: AuthorCriteria) {
|
||||
this.name = options.name;
|
||||
this.flairCssClass = options.flairCssClass;
|
||||
this.flairText = options.flairText;
|
||||
if(options.flairCssClass !== undefined) {
|
||||
this.flairCssClass = typeof options.flairCssClass === 'string' ? [options.flairCssClass] : options.flairCssClass;
|
||||
}
|
||||
if(options.flairText !== undefined) {
|
||||
this.flairText = typeof options.flairText === 'string' ? [options.flairText] : options.flairText;
|
||||
}
|
||||
this.isMod = options.isMod;
|
||||
this.userNotes = options.userNotes;
|
||||
this.age = options.age;
|
||||
|
||||
@@ -66,7 +66,7 @@ export abstract class Check implements ICheck {
|
||||
itemIs = [],
|
||||
authorIs: {
|
||||
include = [],
|
||||
excludeCondition = 'OR',
|
||||
excludeCondition,
|
||||
exclude = [],
|
||||
} = {},
|
||||
dryRun,
|
||||
|
||||
27
src/Common/Config/AbstractConfigDocument.ts
Normal file
27
src/Common/Config/AbstractConfigDocument.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import {ConfigFormat} from "../types";
|
||||
|
||||
export interface ConfigDocumentInterface<DocumentType> {
|
||||
format: ConfigFormat;
|
||||
parsed: DocumentType
|
||||
//parsingError: Error | string;
|
||||
raw: string;
|
||||
location?: string;
|
||||
toString(): string;
|
||||
toJS(): object;
|
||||
}
|
||||
|
||||
abstract class AbstractConfigDocument<DocumentType> implements ConfigDocumentInterface<DocumentType> {
|
||||
public abstract format: ConfigFormat;
|
||||
public abstract parsed: DocumentType;
|
||||
//public abstract parsingError: Error | string;
|
||||
|
||||
|
||||
constructor(public raw: string, public location?: string) {
|
||||
}
|
||||
|
||||
|
||||
public abstract toString(): string;
|
||||
public abstract toJS(): object;
|
||||
}
|
||||
|
||||
export default AbstractConfigDocument;
|
||||
30
src/Common/Config/JsonConfigDocument.ts
Normal file
30
src/Common/Config/JsonConfigDocument.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
import AbstractConfigDocument from "./AbstractConfigDocument";
|
||||
import {stringify, parse} from 'comment-json';
|
||||
import JSON5 from 'json5';
|
||||
import {ConfigFormat} from "../types";
|
||||
import {OperatorJsonConfig} from "../interfaces";
|
||||
|
||||
class JsonConfigDocument extends AbstractConfigDocument<OperatorJsonConfig> {
|
||||
|
||||
public parsed: OperatorJsonConfig;
|
||||
protected cleanParsed: OperatorJsonConfig;
|
||||
public format: ConfigFormat;
|
||||
|
||||
public constructor(raw: string, location?: string) {
|
||||
super(raw, location);
|
||||
this.parsed = parse(raw);
|
||||
this.cleanParsed = JSON5.parse(raw);
|
||||
this.format = 'json';
|
||||
}
|
||||
|
||||
public toJS(): OperatorJsonConfig {
|
||||
return this.cleanParsed;
|
||||
}
|
||||
|
||||
public toString(): string {
|
||||
return stringify(this.parsed, null, 1);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
export default JsonConfigDocument;
|
||||
54
src/Common/Config/Operator/index.ts
Normal file
54
src/Common/Config/Operator/index.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
import YamlConfigDocument from "../YamlConfigDocument";
|
||||
import JsonConfigDocument from "../JsonConfigDocument";
|
||||
import {YAMLMap, YAMLSeq} from "yaml";
|
||||
import {BotInstanceJsonConfig, OperatorJsonConfig} from "../../interfaces";
|
||||
import {assign} from 'comment-json';
|
||||
|
||||
export interface OperatorConfigDocumentInterface {
|
||||
addBot(botData: BotInstanceJsonConfig): void;
|
||||
toJS(): OperatorJsonConfig;
|
||||
}
|
||||
|
||||
export class YamlOperatorConfigDocument extends YamlConfigDocument implements OperatorConfigDocumentInterface {
|
||||
addBot(botData: BotInstanceJsonConfig) {
|
||||
const bots = this.parsed.get('bots') as YAMLSeq;
|
||||
if (bots === undefined) {
|
||||
this.parsed.add({key: 'bots', value: [botData]});
|
||||
} else if (botData.name !== undefined) {
|
||||
// overwrite if we find an existing
|
||||
const existingIndex = bots.items.findIndex(x => (x as YAMLMap).get('name') === botData.name);
|
||||
if (existingIndex !== -1) {
|
||||
this.parsed.setIn(['bots', existingIndex], botData);
|
||||
} else {
|
||||
this.parsed.addIn(['bots'], botData);
|
||||
}
|
||||
} else {
|
||||
this.parsed.addIn(['bots'], botData);
|
||||
}
|
||||
}
|
||||
|
||||
toJS(): OperatorJsonConfig {
|
||||
return super.toJS();
|
||||
}
|
||||
}
|
||||
|
||||
export class JsonOperatorConfigDocument extends JsonConfigDocument implements OperatorConfigDocumentInterface {
|
||||
addBot(botData: BotInstanceJsonConfig) {
|
||||
if (this.parsed.bots === undefined) {
|
||||
this.parsed.bots = [botData];
|
||||
} else if (botData.name !== undefined) {
|
||||
const existingIndex = this.parsed.bots.findIndex(x => x.name === botData.name);
|
||||
if (existingIndex !== -1) {
|
||||
this.parsed.bots[existingIndex] = assign(this.parsed.bots[existingIndex], botData);
|
||||
} else {
|
||||
this.parsed.bots.push(botData);
|
||||
}
|
||||
} else {
|
||||
this.parsed.bots.push(botData);
|
||||
}
|
||||
}
|
||||
|
||||
toJS(): OperatorJsonConfig {
|
||||
return super.toJS();
|
||||
}
|
||||
}
|
||||
24
src/Common/Config/YamlConfigDocument.ts
Normal file
24
src/Common/Config/YamlConfigDocument.ts
Normal file
@@ -0,0 +1,24 @@
|
||||
import AbstractConfigDocument from "./AbstractConfigDocument";
|
||||
import {Document, parseDocument} from 'yaml';
|
||||
import {ConfigFormat} from "../types";
|
||||
|
||||
class YamlConfigDocument extends AbstractConfigDocument<Document> {
|
||||
|
||||
public parsed: Document;
|
||||
public format: ConfigFormat;
|
||||
|
||||
public constructor(raw: string, location?: string) {
|
||||
super(raw, location);
|
||||
this.parsed = parseDocument(raw);
|
||||
this.format = 'yaml';
|
||||
}
|
||||
public toJS(): object {
|
||||
return this.parsed.toJS();
|
||||
}
|
||||
|
||||
public toString(): string {
|
||||
return this.parsed.toString();
|
||||
}
|
||||
}
|
||||
|
||||
export default YamlConfigDocument;
|
||||
@@ -8,7 +8,11 @@ import {IncomingMessage} from "http";
|
||||
import Submission from "snoowrap/dist/objects/Submission";
|
||||
import Comment from "snoowrap/dist/objects/Comment";
|
||||
import RedditUser from "snoowrap/dist/objects/RedditUser";
|
||||
import {AuthorOptions} from "../Author/Author";
|
||||
import {AuthorCriteria, AuthorOptions} from "../Author/Author";
|
||||
import {ConfigFormat} from "./types";
|
||||
import AbstractConfigDocument, {ConfigDocumentInterface} from "./Config/AbstractConfigDocument";
|
||||
import {Document as YamlDocument} from 'yaml';
|
||||
import {JsonOperatorConfigDocument, YamlOperatorConfigDocument} from "./Config/Operator";
|
||||
|
||||
/**
|
||||
* An ISO 8601 Duration
|
||||
@@ -939,8 +943,9 @@ export interface SubmissionState extends ActivityState {
|
||||
* */
|
||||
title?: string
|
||||
|
||||
link_flair_text?: string
|
||||
link_flair_css_class?: string
|
||||
link_flair_text?: string | string[]
|
||||
link_flair_css_class?: string | string[]
|
||||
flairTemplate?: string | string[]
|
||||
}
|
||||
|
||||
// properties calculated/derived by CM -- not provided as plain values by reddit
|
||||
@@ -1837,6 +1842,15 @@ export interface OperatorConfig extends OperatorJsonConfig {
|
||||
credentials: ThirdPartyCredentialsJsonConfig
|
||||
}
|
||||
|
||||
export interface OperatorFileConfig {
|
||||
document: YamlOperatorConfigDocument | JsonOperatorConfigDocument
|
||||
isWriteable?: boolean
|
||||
}
|
||||
|
||||
export interface OperatorConfigWithFileContext extends OperatorConfig {
|
||||
fileConfig: OperatorFileConfig
|
||||
}
|
||||
|
||||
//export type OperatorConfig = Required<OperatorJsonConfig>;
|
||||
|
||||
interface CacheTypeStat {
|
||||
@@ -2023,3 +2037,27 @@ export interface StringComparisonOptions {
|
||||
lengthWeight?: number,
|
||||
transforms?: ((str: string) => string)[]
|
||||
}
|
||||
|
||||
export interface FilterCriteriaPropertyResult<T> {
|
||||
property: keyof T
|
||||
expected: (string | boolean | number)[]
|
||||
found?: string | boolean | number | null
|
||||
passed?: null | boolean
|
||||
reason?: string
|
||||
behavior: FilterBehavior
|
||||
}
|
||||
|
||||
export interface FilterCriteriaResult<T> {
|
||||
behavior: FilterBehavior
|
||||
criteria: T//AuthorCriteria | TypedActivityStates
|
||||
propertyResults: FilterCriteriaPropertyResult<T>[]
|
||||
passed: boolean
|
||||
}
|
||||
|
||||
export type FilterBehavior = 'include' | 'exclude'
|
||||
|
||||
export interface FilterResult<T> {
|
||||
criteriaResults: FilterCriteriaResult<T>[]
|
||||
join: JoinOperands
|
||||
passed: boolean
|
||||
}
|
||||
|
||||
@@ -28,3 +28,5 @@ export type SetRandomInterval = (
|
||||
minDelay: number,
|
||||
maxDelay: number,
|
||||
) => { clear: () => void };
|
||||
|
||||
export type ConfigFormat = 'json' | 'yaml';
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
import {Logger} from "winston";
|
||||
import {
|
||||
buildCacheOptionsFromProvider, buildCachePrefix,
|
||||
createAjvFactory,
|
||||
createAjvFactory, fileOrDirectoryIsWriteable,
|
||||
mergeArr,
|
||||
normalizeName,
|
||||
overwriteMerge,
|
||||
parseBool, randomId,
|
||||
readConfigFile,
|
||||
parseBool, parseFromJsonOrYamlToObject, randomId,
|
||||
readConfigFile, removeFromSourceIfKeysExistsInDestination,
|
||||
removeUndefinedKeys
|
||||
} from "./util";
|
||||
import {CommentCheck} from "./Check/CommentCheck";
|
||||
@@ -35,11 +35,11 @@ import {
|
||||
RedditCredentials,
|
||||
BotCredentialsJsonConfig,
|
||||
BotCredentialsConfig,
|
||||
FilterCriteriaDefaults, TypedActivityStates
|
||||
FilterCriteriaDefaults, TypedActivityStates, OperatorFileConfig
|
||||
} from "./Common/interfaces";
|
||||
import {isRuleSetJSON, RuleSetJson, RuleSetObjectJson} from "./Rule/RuleSet";
|
||||
import deepEqual from "fast-deep-equal";
|
||||
import {ActionJson, ActionObjectJson, RuleJson, RuleObjectJson} from "./Common/types";
|
||||
import {ActionJson, ActionObjectJson, ConfigFormat, RuleJson, RuleObjectJson} from "./Common/types";
|
||||
import {isActionJson} from "./Action";
|
||||
import {getLogger} from "./Utils/loggerFactory";
|
||||
import {GetEnvVars} from 'env-cmd';
|
||||
@@ -49,6 +49,15 @@ import * as process from "process";
|
||||
import {cacheOptDefaults, cacheTTLDefaults, filterCriteriaDefault} from "./Common/defaults";
|
||||
import objectHash from "object-hash";
|
||||
import {AuthorCriteria, AuthorOptions} from "./Author/Author";
|
||||
import path from 'path';
|
||||
import {
|
||||
JsonOperatorConfigDocument,
|
||||
OperatorConfigDocumentInterface,
|
||||
YamlOperatorConfigDocument
|
||||
} from "./Common/Config/Operator";
|
||||
import SimpleError from "./Utils/SimpleError";
|
||||
import {ConfigDocumentInterface} from "./Common/Config/AbstractConfigDocument";
|
||||
import {Document as YamlDocument} from "yaml";
|
||||
|
||||
export interface ConfigBuilderOptions {
|
||||
logger: Logger,
|
||||
@@ -145,20 +154,26 @@ export class ConfigBuilder {
|
||||
const strongActions = insertNamedActions(c.actions, namedActions);
|
||||
|
||||
let derivedAuthorIs: AuthorOptions = authorIsDefault;
|
||||
if(authorIsBehavior === 'merge') {
|
||||
derivedAuthorIs = merge.all([authorIs, authorIsDefault], {arrayMerge: overwriteMerge});
|
||||
} else if(Object.keys(authorIs).length > 0) {
|
||||
if (authorIsBehavior === 'merge') {
|
||||
derivedAuthorIs = merge.all([authorIs, authorIsDefault], {arrayMerge: removeFromSourceIfKeysExistsInDestination});
|
||||
} else if (Object.keys(authorIs).length > 0) {
|
||||
derivedAuthorIs = authorIs;
|
||||
}
|
||||
|
||||
let derivedItemIs: TypedActivityStates = itemIsDefault;
|
||||
if(itemIsBehavior === 'merge') {
|
||||
if (itemIsBehavior === 'merge') {
|
||||
derivedItemIs = [...itemIs, ...itemIsDefault];
|
||||
} else if(itemIs.length > 0) {
|
||||
} else if (itemIs.length > 0) {
|
||||
derivedItemIs = itemIs;
|
||||
}
|
||||
|
||||
const strongCheck = {...c, authorIs: derivedAuthorIs, itemIs: derivedItemIs, rules: strongRules, actions: strongActions} as CheckStructuredJson;
|
||||
const strongCheck = {
|
||||
...c,
|
||||
authorIs: derivedAuthorIs,
|
||||
itemIs: derivedItemIs,
|
||||
rules: strongRules,
|
||||
actions: strongActions
|
||||
} as CheckStructuredJson;
|
||||
structuredChecks.push(strongCheck);
|
||||
}
|
||||
|
||||
@@ -321,7 +336,7 @@ export const parseDefaultBotInstanceFromArgs = (args: any): BotInstanceJsonConfi
|
||||
heartbeatInterval: heartbeat,
|
||||
},
|
||||
polling: {
|
||||
shared: sharedMod ? ['unmoderated','modqueue'] : undefined,
|
||||
shared: sharedMod ? ['unmoderated', 'modqueue'] : undefined,
|
||||
},
|
||||
nanny: {
|
||||
softLimit,
|
||||
@@ -424,7 +439,7 @@ export const parseDefaultBotInstanceFromEnv = (): BotInstanceJsonConfig => {
|
||||
heartbeatInterval: process.env.HEARTBEAT !== undefined ? parseInt(process.env.HEARTBEAT) : undefined,
|
||||
},
|
||||
polling: {
|
||||
shared: parseBool(process.env.SHARE_MOD) ? ['unmoderated','modqueue'] : undefined,
|
||||
shared: parseBool(process.env.SHARE_MOD) ? ['unmoderated', 'modqueue'] : undefined,
|
||||
},
|
||||
nanny: {
|
||||
softLimit: process.env.SOFT_LIMIT !== undefined ? parseInt(process.env.SOFT_LIMIT) : undefined,
|
||||
@@ -470,9 +485,9 @@ export const parseOpConfigFromEnv = (): OperatorJsonConfig => {
|
||||
},
|
||||
},
|
||||
credentials: {
|
||||
youtube: {
|
||||
apiKey: process.env.YOUTUBE_API_KEY
|
||||
}
|
||||
youtube: {
|
||||
apiKey: process.env.YOUTUBE_API_KEY
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -485,7 +500,7 @@ export const parseOpConfigFromEnv = (): OperatorJsonConfig => {
|
||||
// Actual ENVs (from environment)
|
||||
// json config
|
||||
// args from cli
|
||||
export const parseOperatorConfigFromSources = async (args: any): Promise<OperatorJsonConfig> => {
|
||||
export const parseOperatorConfigFromSources = async (args: any): Promise<[OperatorJsonConfig, OperatorFileConfig]> => {
|
||||
const {logLevel = process.env.LOG_LEVEL, logDir = process.env.LOG_DIR || false} = args || {};
|
||||
const envPath = process.env.OPERATOR_ENV;
|
||||
|
||||
@@ -516,25 +531,74 @@ export const parseOperatorConfigFromSources = async (args: any): Promise<Operato
|
||||
//swallow silently for now 😬
|
||||
}
|
||||
|
||||
const {operatorConfig = process.env.OPERATOR_CONFIG} = args;
|
||||
const {operatorConfig = (process.env.OPERATOR_CONFIG ?? path.resolve(__dirname, '../config.yaml'))} = args;
|
||||
let configFromFile: OperatorJsonConfig = {};
|
||||
if (operatorConfig !== undefined) {
|
||||
let rawConfig;
|
||||
try {
|
||||
rawConfig = await readConfigFile(operatorConfig, {log: initLogger}) as object;
|
||||
} catch (err: any) {
|
||||
initLogger.error('Cannot continue app startup because operator config file was not parseable.');
|
||||
let fileConfigFormat: ConfigFormat | undefined = undefined;
|
||||
let fileConfig: object = {};
|
||||
let rawConfig: string = '';
|
||||
let configDoc: YamlOperatorConfigDocument | JsonOperatorConfigDocument;
|
||||
let writeable = false;
|
||||
try {
|
||||
writeable = await fileOrDirectoryIsWriteable(operatorConfig);
|
||||
} catch (e) {
|
||||
initLogger.warn(`Issue while parsing operator config file location: ${e} \n This is only a problem if you do not have a config file but are planning on adding bots interactively.`);
|
||||
}
|
||||
|
||||
try {
|
||||
const [rawConfigValue, format] = await readConfigFile(operatorConfig, {log: initLogger});
|
||||
rawConfig = rawConfigValue ?? '';
|
||||
fileConfigFormat = format as ConfigFormat;
|
||||
} catch (err: any) {
|
||||
const {code} = err;
|
||||
if (code === 'ENOENT') {
|
||||
initLogger.warn('No operator config file found but will continue');
|
||||
if (err.extension !== undefined) {
|
||||
fileConfigFormat = err.extension
|
||||
}
|
||||
} else {
|
||||
initLogger.error('Cannot continue app startup because operator config file exists but was not parseable.');
|
||||
err.logged = true;
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
const [format, doc, jsonErr, yamlErr] = parseFromJsonOrYamlToObject(rawConfig, {
|
||||
location: operatorConfig,
|
||||
jsonDocFunc: (content, location) => new JsonOperatorConfigDocument(content, location),
|
||||
yamlDocFunc: (content, location) => new YamlOperatorConfigDocument(content, location)
|
||||
});
|
||||
|
||||
|
||||
if (format !== undefined && fileConfigFormat === undefined) {
|
||||
fileConfigFormat = 'yaml';
|
||||
}
|
||||
|
||||
if (doc === undefined && rawConfig !== '') {
|
||||
initLogger.error(`Could not parse file contents at ${operatorConfig} as JSON or YAML (likely it is ${fileConfigFormat}):`);
|
||||
initLogger.error(jsonErr);
|
||||
initLogger.error(yamlErr);
|
||||
throw new SimpleError(`Could not parse file contents at ${operatorConfig} as JSON or YAML`);
|
||||
} else if (doc === undefined && rawConfig === '') {
|
||||
// create an empty doc
|
||||
if(fileConfigFormat === 'json') {
|
||||
configDoc = new JsonOperatorConfigDocument('{}', operatorConfig);
|
||||
} else {
|
||||
configDoc = new YamlOperatorConfigDocument('', operatorConfig);
|
||||
configDoc.parsed = new YamlDocument({});
|
||||
}
|
||||
configFromFile = {};
|
||||
} else {
|
||||
configDoc = doc as (YamlOperatorConfigDocument | JsonOperatorConfigDocument);
|
||||
|
||||
try {
|
||||
configFromFile = validateJson(rawConfig, operatorSchema, initLogger) as OperatorJsonConfig;
|
||||
configFromFile = validateJson(configDoc.toJS(), operatorSchema, initLogger) as OperatorJsonConfig;
|
||||
const {bots = []} = configFromFile || {};
|
||||
for(const b of bots) {
|
||||
const {polling: {
|
||||
sharedMod
|
||||
} = {}} = b;
|
||||
if(sharedMod !== undefined) {
|
||||
for (const b of bots) {
|
||||
const {
|
||||
polling: {
|
||||
sharedMod
|
||||
} = {}
|
||||
} = b;
|
||||
if (sharedMod !== undefined) {
|
||||
initLogger.warn(`'sharedMod' bot config property is DEPRECATED and will be removed in next minor version. Use 'shared' property instead (see docs)`);
|
||||
break;
|
||||
}
|
||||
@@ -544,6 +608,7 @@ export const parseOperatorConfigFromSources = async (args: any): Promise<Operato
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
const opConfigFromArgs = parseOpConfigFromArgs(args);
|
||||
const opConfigFromEnv = parseOpConfigFromEnv();
|
||||
|
||||
@@ -570,7 +635,10 @@ export const parseOperatorConfigFromSources = async (args: any): Promise<Operato
|
||||
botInstances = botInstancesFromFile.map(x => merge.all([defaultBotInstance, x], {arrayMerge: overwriteMerge}));
|
||||
}
|
||||
|
||||
return removeUndefinedKeys({...mergedConfig, bots: botInstances}) as OperatorJsonConfig;
|
||||
return [removeUndefinedKeys({...mergedConfig, bots: botInstances}) as OperatorJsonConfig, {
|
||||
document: configDoc,
|
||||
isWriteable: writeable
|
||||
}];
|
||||
}
|
||||
|
||||
export const buildOperatorConfigWithDefaults = (data: OperatorJsonConfig): OperatorConfig => {
|
||||
@@ -656,163 +724,6 @@ export const buildOperatorConfigWithDefaults = (data: OperatorJsonConfig): Opera
|
||||
}
|
||||
}
|
||||
|
||||
let hydratedBots: BotInstanceConfig[] = bots.map(x => {
|
||||
const {
|
||||
name: botName,
|
||||
filterCriteriaDefaults = filterCriteriaDefault,
|
||||
polling: {
|
||||
sharedMod,
|
||||
shared = [],
|
||||
stagger,
|
||||
limit = 100,
|
||||
interval = 30,
|
||||
} = {},
|
||||
queue: {
|
||||
maxWorkers = 1,
|
||||
} = {},
|
||||
caching,
|
||||
nanny: {
|
||||
softLimit = 250,
|
||||
hardLimit = 50
|
||||
} = {},
|
||||
snoowrap = snoowrapOp,
|
||||
credentials = {},
|
||||
subreddits: {
|
||||
names = [],
|
||||
exclude = [],
|
||||
wikiConfig = 'botconfig/contextbot',
|
||||
dryRun,
|
||||
heartbeatInterval = 300,
|
||||
} = {},
|
||||
} = x;
|
||||
|
||||
let botCache: StrongCache;
|
||||
let botActionedEventsDefault: number;
|
||||
|
||||
if (caching === undefined) {
|
||||
|
||||
botCache = {
|
||||
...cacheTTLDefaults,
|
||||
actionedEventsDefault: opActionedEventsDefault,
|
||||
actionedEventsMax: opActionedEventsMax,
|
||||
provider: {...defaultProvider}
|
||||
};
|
||||
} else {
|
||||
const {
|
||||
provider,
|
||||
actionedEventsMax = opActionedEventsMax,
|
||||
actionedEventsDefault = opActionedEventsDefault,
|
||||
...restConfig
|
||||
} = caching;
|
||||
|
||||
botActionedEventsDefault = actionedEventsDefault;
|
||||
if (actionedEventsMax !== undefined) {
|
||||
botActionedEventsDefault = Math.min(actionedEventsDefault, actionedEventsMax);
|
||||
}
|
||||
|
||||
if (typeof provider === 'string') {
|
||||
botCache = {
|
||||
...cacheTTLDefaults,
|
||||
...restConfig,
|
||||
actionedEventsDefault: botActionedEventsDefault,
|
||||
provider: {
|
||||
store: provider as CacheProvider,
|
||||
...cacheOptDefaults
|
||||
}
|
||||
}
|
||||
} else {
|
||||
const {ttl = 60, max = 500, store = 'memory', ...rest} = provider || {};
|
||||
botCache = {
|
||||
...cacheTTLDefaults,
|
||||
...restConfig,
|
||||
actionedEventsDefault: botActionedEventsDefault,
|
||||
actionedEventsMax,
|
||||
provider: {
|
||||
store,
|
||||
...cacheOptDefaults,
|
||||
...rest,
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let botCreds: BotCredentialsConfig;
|
||||
|
||||
if((credentials as any).clientId !== undefined) {
|
||||
const creds = credentials as RedditCredentials;
|
||||
const {
|
||||
clientId: ci,
|
||||
clientSecret: cs,
|
||||
...restCred
|
||||
} = creds;
|
||||
botCreds = {
|
||||
reddit: {
|
||||
clientId: (ci as string),
|
||||
clientSecret: (cs as string),
|
||||
...restCred,
|
||||
}
|
||||
}
|
||||
} else {
|
||||
const creds = credentials as BotCredentialsJsonConfig;
|
||||
const {
|
||||
reddit: {
|
||||
clientId: ci,
|
||||
clientSecret: cs,
|
||||
...restRedditCreds
|
||||
},
|
||||
...rest
|
||||
} = creds;
|
||||
botCreds = {
|
||||
reddit: {
|
||||
clientId: (ci as string),
|
||||
clientSecret: (cs as string),
|
||||
...restRedditCreds,
|
||||
},
|
||||
...rest
|
||||
}
|
||||
}
|
||||
|
||||
if (botCache.provider.prefix === undefined || botCache.provider.prefix === defaultProvider.prefix) {
|
||||
// need to provide unique prefix to bot
|
||||
botCache.provider.prefix = buildCachePrefix([botCache.provider.prefix, 'bot', (botName || objectHash.sha1(botCreds))]);
|
||||
}
|
||||
|
||||
let realShared = shared === true ? ['unmoderated','modqueue','newComm','newSub'] : shared;
|
||||
if(sharedMod === true) {
|
||||
realShared.push('unmoderated');
|
||||
realShared.push('modqueue');
|
||||
}
|
||||
|
||||
return {
|
||||
name: botName,
|
||||
snoowrap,
|
||||
filterCriteriaDefaults,
|
||||
subreddits: {
|
||||
names,
|
||||
exclude,
|
||||
wikiConfig,
|
||||
heartbeatInterval,
|
||||
dryRun,
|
||||
},
|
||||
credentials: botCreds,
|
||||
caching: botCache,
|
||||
polling: {
|
||||
shared: [...new Set(realShared)] as PollOn[],
|
||||
stagger,
|
||||
limit,
|
||||
interval,
|
||||
},
|
||||
queue: {
|
||||
maxWorkers,
|
||||
},
|
||||
nanny: {
|
||||
softLimit,
|
||||
hardLimit
|
||||
}
|
||||
}
|
||||
|
||||
});
|
||||
|
||||
const defaultOperators = typeof name === 'string' ? [name] : name;
|
||||
|
||||
const config: OperatorConfig = {
|
||||
@@ -849,9 +760,175 @@ export const buildOperatorConfigWithDefaults = (data: OperatorJsonConfig): Opera
|
||||
secret: apiSecret,
|
||||
friendly
|
||||
},
|
||||
bots: hydratedBots,
|
||||
bots: [],
|
||||
credentials,
|
||||
};
|
||||
|
||||
config.bots = bots.map(x => buildBotConfig(x, config));
|
||||
|
||||
return config;
|
||||
}
|
||||
|
||||
export const buildBotConfig = (data: BotInstanceJsonConfig, opConfig: OperatorConfig): BotInstanceConfig => {
|
||||
const {
|
||||
snoowrap: snoowrapOp,
|
||||
caching: {
|
||||
actionedEventsMax: opActionedEventsMax,
|
||||
actionedEventsDefault: opActionedEventsDefault = 25,
|
||||
provider: defaultProvider,
|
||||
} = {}
|
||||
} = opConfig;
|
||||
const {
|
||||
name: botName,
|
||||
filterCriteriaDefaults = filterCriteriaDefault,
|
||||
polling: {
|
||||
sharedMod,
|
||||
shared = [],
|
||||
stagger,
|
||||
limit = 100,
|
||||
interval = 30,
|
||||
} = {},
|
||||
queue: {
|
||||
maxWorkers = 1,
|
||||
} = {},
|
||||
caching,
|
||||
nanny: {
|
||||
softLimit = 250,
|
||||
hardLimit = 50
|
||||
} = {},
|
||||
snoowrap = snoowrapOp,
|
||||
credentials = {},
|
||||
subreddits: {
|
||||
names = [],
|
||||
exclude = [],
|
||||
wikiConfig = 'botconfig/contextbot',
|
||||
dryRun,
|
||||
heartbeatInterval = 300,
|
||||
} = {},
|
||||
} = data;
|
||||
|
||||
let botCache: StrongCache;
|
||||
let botActionedEventsDefault: number;
|
||||
|
||||
if (caching === undefined) {
|
||||
|
||||
botCache = {
|
||||
...cacheTTLDefaults,
|
||||
actionedEventsDefault: opActionedEventsDefault,
|
||||
actionedEventsMax: opActionedEventsMax,
|
||||
provider: {...defaultProvider as CacheOptions}
|
||||
};
|
||||
} else {
|
||||
const {
|
||||
provider,
|
||||
actionedEventsMax = opActionedEventsMax,
|
||||
actionedEventsDefault = opActionedEventsDefault,
|
||||
...restConfig
|
||||
} = caching;
|
||||
|
||||
botActionedEventsDefault = actionedEventsDefault;
|
||||
if (actionedEventsMax !== undefined) {
|
||||
botActionedEventsDefault = Math.min(actionedEventsDefault, actionedEventsMax);
|
||||
}
|
||||
|
||||
if (typeof provider === 'string') {
|
||||
botCache = {
|
||||
...cacheTTLDefaults,
|
||||
...restConfig,
|
||||
actionedEventsDefault: botActionedEventsDefault,
|
||||
provider: {
|
||||
store: provider as CacheProvider,
|
||||
...cacheOptDefaults
|
||||
}
|
||||
}
|
||||
} else {
|
||||
const {ttl = 60, max = 500, store = 'memory', ...rest} = provider || {};
|
||||
botCache = {
|
||||
...cacheTTLDefaults,
|
||||
...restConfig,
|
||||
actionedEventsDefault: botActionedEventsDefault,
|
||||
actionedEventsMax,
|
||||
provider: {
|
||||
store,
|
||||
...cacheOptDefaults,
|
||||
...rest,
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let botCreds: BotCredentialsConfig;
|
||||
|
||||
if ((credentials as any).clientId !== undefined) {
|
||||
const creds = credentials as RedditCredentials;
|
||||
const {
|
||||
clientId: ci,
|
||||
clientSecret: cs,
|
||||
...restCred
|
||||
} = creds;
|
||||
botCreds = {
|
||||
reddit: {
|
||||
clientId: (ci as string),
|
||||
clientSecret: (cs as string),
|
||||
...restCred,
|
||||
}
|
||||
}
|
||||
} else {
|
||||
const creds = credentials as BotCredentialsJsonConfig;
|
||||
const {
|
||||
reddit: {
|
||||
clientId: ci,
|
||||
clientSecret: cs,
|
||||
...restRedditCreds
|
||||
},
|
||||
...rest
|
||||
} = creds;
|
||||
botCreds = {
|
||||
reddit: {
|
||||
clientId: (ci as string),
|
||||
clientSecret: (cs as string),
|
||||
...restRedditCreds,
|
||||
},
|
||||
...rest
|
||||
}
|
||||
}
|
||||
|
||||
if (botCache.provider.prefix === undefined || botCache.provider.prefix === (defaultProvider as CacheOptions).prefix) {
|
||||
// need to provide unique prefix to bot
|
||||
botCache.provider.prefix = buildCachePrefix([botCache.provider.prefix, 'bot', (botName || objectHash.sha1(botCreds))]);
|
||||
}
|
||||
|
||||
let realShared = shared === true ? ['unmoderated', 'modqueue', 'newComm', 'newSub'] : shared;
|
||||
if (sharedMod === true) {
|
||||
realShared.push('unmoderated');
|
||||
realShared.push('modqueue');
|
||||
}
|
||||
|
||||
return {
|
||||
name: botName,
|
||||
snoowrap: snoowrap || {},
|
||||
filterCriteriaDefaults,
|
||||
subreddits: {
|
||||
names,
|
||||
exclude,
|
||||
wikiConfig,
|
||||
heartbeatInterval,
|
||||
dryRun,
|
||||
},
|
||||
credentials: botCreds,
|
||||
caching: botCache,
|
||||
polling: {
|
||||
shared: [...new Set(realShared)] as PollOn[],
|
||||
stagger,
|
||||
limit,
|
||||
interval,
|
||||
},
|
||||
queue: {
|
||||
maxWorkers,
|
||||
},
|
||||
nanny: {
|
||||
softLimit,
|
||||
hardLimit
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,6 +2,7 @@ import {Rule, RuleJSONConfig, RuleOptions, RuleResult} from "./index";
|
||||
import {Comment} from "snoowrap";
|
||||
import Submission from "snoowrap/dist/objects/Submission";
|
||||
import {Author, AuthorCriteria} from "../Author/Author";
|
||||
import {checkAuthorFilter} from "../Subreddit/SubredditResources";
|
||||
|
||||
/**
|
||||
* Checks the author of the Activity against AuthorCriteria. This differs from a Rule's AuthorOptions as this is a full Rule and will only pass/fail, not skip.
|
||||
@@ -59,20 +60,8 @@ export class AuthorRule extends Rule {
|
||||
}
|
||||
|
||||
protected async process(item: Comment | Submission): Promise<[boolean, RuleResult]> {
|
||||
if (this.include.length > 0) {
|
||||
for (const auth of this.include) {
|
||||
if (await this.resources.testAuthorCriteria(item, auth)) {
|
||||
return Promise.resolve([true, this.getResult(true)]);
|
||||
}
|
||||
}
|
||||
return Promise.resolve([false, this.getResult(false)]);
|
||||
}
|
||||
for (const auth of this.exclude) {
|
||||
if (await this.resources.testAuthorCriteria(item, auth, false)) {
|
||||
return Promise.resolve([true, this.getResult(true)]);
|
||||
}
|
||||
}
|
||||
return Promise.resolve([false, this.getResult(false)]);
|
||||
const [result, filterType] = await checkAuthorFilter(item, {include: this.include, exclude: this.exclude}, this.resources, this.logger);
|
||||
return Promise.resolve([result, this.getResult(result)]);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -50,24 +50,52 @@
|
||||
]
|
||||
},
|
||||
"flairCssClass": {
|
||||
"description": "A list of (user) flair css class values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair css class (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"red"
|
||||
]
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
"description": "A (user) flair template id (or list of) from the subreddit to match against"
|
||||
},
|
||||
"flairText": {
|
||||
"description": "A list of (user) flair text values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair text value (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"Approved"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
]
|
||||
},
|
||||
"isMod": {
|
||||
"description": "Is the author a moderator?",
|
||||
@@ -249,14 +277,47 @@
|
||||
"filtered": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"is_self": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"link_flair_css_class": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"link_flair_text": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"type": "boolean"
|
||||
|
||||
@@ -222,6 +222,17 @@
|
||||
],
|
||||
"pattern": "^[a-zA-Z]([\\w -]*[\\w])?$",
|
||||
"type": "string"
|
||||
},
|
||||
"targets": {
|
||||
"description": "Specify which Activities to approve\n\nThis setting is only applicable if the Activity being acted on is a **comment**. On a **submission** the setting does nothing\n\n* self => approve activity being checked (comment)\n* parent => approve parent (submission) of activity being checked (comment)",
|
||||
"items": {
|
||||
"enum": [
|
||||
"parent",
|
||||
"self"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
@@ -505,24 +516,52 @@
|
||||
]
|
||||
},
|
||||
"flairCssClass": {
|
||||
"description": "A list of (user) flair css class values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair css class (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"red"
|
||||
]
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
"description": "A (user) flair template id (or list of) from the subreddit to match against"
|
||||
},
|
||||
"flairText": {
|
||||
"description": "A list of (user) flair text values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair text value (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"Approved"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
]
|
||||
},
|
||||
"isMod": {
|
||||
"description": "Is the author a moderator?",
|
||||
@@ -3439,14 +3478,47 @@
|
||||
"filtered": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"is_self": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"link_flair_css_class": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"link_flair_text": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"type": "boolean"
|
||||
|
||||
@@ -50,24 +50,52 @@
|
||||
]
|
||||
},
|
||||
"flairCssClass": {
|
||||
"description": "A list of (user) flair css class values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair css class (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"red"
|
||||
]
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
"description": "A (user) flair template id (or list of) from the subreddit to match against"
|
||||
},
|
||||
"flairText": {
|
||||
"description": "A list of (user) flair text values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair text value (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"Approved"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
]
|
||||
},
|
||||
"isMod": {
|
||||
"description": "Is the author a moderator?",
|
||||
@@ -873,14 +901,47 @@
|
||||
"filtered": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"is_self": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"link_flair_css_class": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"link_flair_text": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"type": "boolean"
|
||||
|
||||
@@ -454,24 +454,52 @@
|
||||
]
|
||||
},
|
||||
"flairCssClass": {
|
||||
"description": "A list of (user) flair css class values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair css class (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"red"
|
||||
]
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
"description": "A (user) flair template id (or list of) from the subreddit to match against"
|
||||
},
|
||||
"flairText": {
|
||||
"description": "A list of (user) flair text values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair text value (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"Approved"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
]
|
||||
},
|
||||
"isMod": {
|
||||
"description": "Is the author a moderator?",
|
||||
@@ -1922,14 +1950,47 @@
|
||||
"filtered": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"is_self": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"link_flair_css_class": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"link_flair_text": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"type": "boolean"
|
||||
|
||||
@@ -428,24 +428,52 @@
|
||||
]
|
||||
},
|
||||
"flairCssClass": {
|
||||
"description": "A list of (user) flair css class values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair css class (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"red"
|
||||
]
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
"description": "A (user) flair template id (or list of) from the subreddit to match against"
|
||||
},
|
||||
"flairText": {
|
||||
"description": "A list of (user) flair text values from the subreddit to match against",
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"description": "A (user) flair text value (or list of) from the subreddit to match against",
|
||||
"examples": [
|
||||
"Approved"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
]
|
||||
},
|
||||
"isMod": {
|
||||
"description": "Is the author a moderator?",
|
||||
@@ -1896,14 +1924,47 @@
|
||||
"filtered": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"flairTemplate": {
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"is_self": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"link_flair_css_class": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"link_flair_text": {
|
||||
"type": "string"
|
||||
"anyOf": [
|
||||
{
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
{
|
||||
"type": "string"
|
||||
}
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"type": "boolean"
|
||||
|
||||
@@ -554,14 +554,8 @@ export class Manager extends EventEmitter {
|
||||
throw new ConfigParseError('Wiki page contents was empty');
|
||||
}
|
||||
|
||||
const [configObj, jsonErr, yamlErr] = parseFromJsonOrYamlToObject(sourceData);
|
||||
if (jsonErr === undefined) {
|
||||
this.wikiFormat = 'json';
|
||||
} else if (yamlErr === undefined) {
|
||||
this.wikiFormat = 'yaml';
|
||||
} else {
|
||||
this.wikiFormat = likelyJson5(sourceData) ? 'json' : 'yaml';
|
||||
}
|
||||
const [format, configObj, jsonErr, yamlErr] = parseFromJsonOrYamlToObject(sourceData);
|
||||
this.wikiFormat = format;
|
||||
|
||||
if (configObj === undefined) {
|
||||
this.logger.error(`Could not parse wiki page contents as JSON or YAML. Looks like it should be ${this.wikiFormat}?`);
|
||||
@@ -577,7 +571,7 @@ export class Manager extends EventEmitter {
|
||||
throw new ConfigParseError('Could not parse wiki page contents as JSON or YAML')
|
||||
}
|
||||
|
||||
await this.parseConfigurationFromObject(configObj, suppressChangeEvent);
|
||||
await this.parseConfigurationFromObject(configObj.toJS(), suppressChangeEvent);
|
||||
this.logger.info('Checks updated');
|
||||
|
||||
if(!suppressNotification) {
|
||||
|
||||
@@ -20,11 +20,11 @@ import {
|
||||
comparisonTextOp,
|
||||
createCacheManager,
|
||||
createHistoricalStatsDisplay, FAIL,
|
||||
fetchExternalUrl,
|
||||
fetchExternalUrl, filterCriteriaSummary,
|
||||
formatNumber,
|
||||
getActivityAuthorName,
|
||||
getActivitySubredditName,
|
||||
isStrongSubredditState,
|
||||
isStrongSubredditState, isSubmission,
|
||||
mergeArr,
|
||||
parseDurationComparison,
|
||||
parseExternalUrl,
|
||||
@@ -55,7 +55,7 @@ import {
|
||||
HistoricalStats,
|
||||
HistoricalStatUpdateData,
|
||||
SubredditHistoricalStats,
|
||||
SubredditHistoricalStatsDisplay, ThirdPartyCredentialsJsonConfig,
|
||||
SubredditHistoricalStatsDisplay, ThirdPartyCredentialsJsonConfig, FilterCriteriaResult,
|
||||
} from "../Common/interfaces";
|
||||
import UserNotes from "./UserNotes";
|
||||
import Mustache from "mustache";
|
||||
@@ -185,7 +185,7 @@ export class SubredditResources {
|
||||
this.stats.cache.userNotes.requests++;
|
||||
this.stats.cache.userNotes.miss += miss ? 1 : 0;
|
||||
}
|
||||
this.userNotes = new UserNotes(userNotesTTL, this.subreddit, this.logger, this.cache, cacheUseCB)
|
||||
this.userNotes = new UserNotes(userNotesTTL, this.subreddit, this.client, this.logger, this.cache, cacheUseCB)
|
||||
|
||||
if(this.cacheType === 'memory' && this.cacheSettingsHash !== 'default') {
|
||||
const min = Math.min(...([this.wikiTTL, this.authorTTL, this.submissionTTL, this.commentTTL, this.filterCriteriaTTL].filter(x => typeof x === 'number' && x !== 0) as number[]));
|
||||
@@ -725,7 +725,7 @@ export class SubredditResources {
|
||||
return await this.isSubreddit(await this.getSubreddit(item), state, this.logger);
|
||||
}
|
||||
|
||||
async testAuthorCriteria(item: (Comment | Submission), authorOpts: AuthorCriteria, include = true) {
|
||||
async testAuthorCriteria(item: (Comment | Submission), authorOpts: AuthorCriteria, include = true): Promise<FilterCriteriaResult<AuthorCriteria>> {
|
||||
if (this.filterCriteriaTTL !== false) {
|
||||
// in the criteria check we only actually use the `item` to get the author flair
|
||||
// which will be the same for the entire subreddit
|
||||
@@ -738,17 +738,18 @@ export class SubredditResources {
|
||||
await this.stats.cache.authorCrit.identifierRequestCount.set(hash, (await this.stats.cache.authorCrit.identifierRequestCount.wrap(hash, () => 0) as number) + 1);
|
||||
this.stats.cache.authorCrit.requestTimestamps.push(Date.now());
|
||||
this.stats.cache.authorCrit.requests++;
|
||||
let miss = false;
|
||||
const cachedAuthorTest = await this.cache.wrap(hash, async () => {
|
||||
miss = true;
|
||||
return await testAuthorCriteria(item, authorOpts, include, this.userNotes);
|
||||
}, {ttl: this.filterCriteriaTTL});
|
||||
if (!miss) {
|
||||
|
||||
// need to check shape of result to invalidate old result type
|
||||
let cachedAuthorTest: FilterCriteriaResult<AuthorCriteria> = await this.cache.get(hash) as FilterCriteriaResult<AuthorCriteria>;
|
||||
if(cachedAuthorTest !== null && cachedAuthorTest !== undefined && typeof cachedAuthorTest === 'object') {
|
||||
this.logger.debug(`Cache Hit: Author Check on ${userName} (Hash ${hash})`);
|
||||
return cachedAuthorTest;
|
||||
} else {
|
||||
this.stats.cache.authorCrit.miss++;
|
||||
cachedAuthorTest = await testAuthorCriteria(item, authorOpts, include, this.userNotes);
|
||||
await this.cache.set(hash, cachedAuthorTest, {ttl: this.filterCriteriaTTL});
|
||||
return cachedAuthorTest;
|
||||
}
|
||||
return cachedAuthorTest;
|
||||
}
|
||||
|
||||
return await testAuthorCriteria(item, authorOpts, include, this.userNotes);
|
||||
@@ -778,7 +779,7 @@ export class SubredditResources {
|
||||
const cachedItem = await this.cache.get(hash);
|
||||
if (cachedItem !== undefined && cachedItem !== null) {
|
||||
this.logger.debug(`Cache Hit: Item Check on ${item.name} (Hash ${hash})`);
|
||||
return cachedItem as boolean;
|
||||
//return cachedItem as boolean;
|
||||
}
|
||||
const itemResult = await this.isItem(item, states, this.logger);
|
||||
this.stats.cache.itemCrit.miss++;
|
||||
@@ -872,7 +873,7 @@ export class SubredditResources {
|
||||
if (crit[k] !== undefined) {
|
||||
switch (k) {
|
||||
case 'submissionState':
|
||||
if(!(item instanceof Comment)) {
|
||||
if(isSubmission(item)) {
|
||||
log.warn('`submissionState` is not allowed in `itemIs` criteria when the main Activity is a Submission');
|
||||
continue;
|
||||
}
|
||||
@@ -991,7 +992,7 @@ export class SubredditResources {
|
||||
}
|
||||
break;
|
||||
case 'op':
|
||||
if(item instanceof Submission) {
|
||||
if(isSubmission(item)) {
|
||||
log.warn(`On a Submission the 'op' property will always be true. Did you mean to use this on a comment instead?`);
|
||||
break;
|
||||
}
|
||||
@@ -1003,7 +1004,7 @@ export class SubredditResources {
|
||||
}
|
||||
break;
|
||||
case 'depth':
|
||||
if(item instanceof Submission) {
|
||||
if(isSubmission(item)) {
|
||||
log.warn(`Cannot test for 'depth' on a Submission`);
|
||||
break;
|
||||
}
|
||||
@@ -1015,6 +1016,36 @@ export class SubredditResources {
|
||||
return false
|
||||
}
|
||||
break;
|
||||
case 'flairTemplate':
|
||||
case 'link_flair_text':
|
||||
case 'link_flair_css_class':
|
||||
if(asSubmission(item)) {
|
||||
const subCrit = crit as SubmissionState;
|
||||
let propertyValue: string | null;
|
||||
if(k === 'flairTemplate') {
|
||||
propertyValue = await item.link_flair_template_id;
|
||||
} else {
|
||||
propertyValue = await item[k];
|
||||
}
|
||||
const expectedValues = typeof subCrit[k] === 'string' ? [subCrit[k]] : (subCrit[k] as string[]);
|
||||
const VALUEPass = () => {
|
||||
for (const c of expectedValues) {
|
||||
if (c === propertyValue) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
};
|
||||
const valueResult = VALUEPass();
|
||||
if(!valueResult) {
|
||||
log.debug(`Failed: Expected => ${k} ${expectedValues.join(' OR ')} | Found => ${k}:${propertyValue}`);
|
||||
return false;
|
||||
}
|
||||
break;
|
||||
} else {
|
||||
log.warn(`Cannot test for ${k} on Comment`);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
// @ts-ignore
|
||||
if (item[k] !== undefined) {
|
||||
@@ -1296,43 +1327,67 @@ export const checkAuthorFilter = async (item: (Submission | Comment), filter: Au
|
||||
const authLogger = logger.child({labels: ['Author Filter']}, mergeArr);
|
||||
const {
|
||||
include = [],
|
||||
excludeCondition = 'OR',
|
||||
excludeCondition = 'AND',
|
||||
exclude = [],
|
||||
} = filter;
|
||||
let authorPass = null;
|
||||
if (include.length > 0) {
|
||||
let index = 1;
|
||||
for (const auth of include) {
|
||||
if (await resources.testAuthorCriteria(item, auth)) {
|
||||
authLogger.verbose(`${PASS} => Inclusive author criteria matched`);
|
||||
authLogger.debug(`Inclusive is always OR => At least one of ${include.length} matched`);
|
||||
const critResult = await resources.testAuthorCriteria(item, auth);
|
||||
const [summary, details] = filterCriteriaSummary(critResult);
|
||||
if (critResult.passed) {
|
||||
authLogger.verbose(`${PASS} => Inclusive Author Criteria ${index} => ${summary}`);
|
||||
authLogger.debug(`Criteria Details: \n${details.join('\n')}`);
|
||||
return [true, 'inclusive'];
|
||||
} else {
|
||||
authLogger.debug(`${FAIL} => Inclusive Author Criteria ${index} => ${summary}`);
|
||||
authLogger.debug(`Criteria Details: \n${details.join('\n')}`);
|
||||
}
|
||||
index++;
|
||||
}
|
||||
authLogger.verbose(`${FAIL} => Inclusive author criteria not matched`);
|
||||
authLogger.debug(`Inclusive is always OR => None of ${include.length} criteria matched`);
|
||||
authLogger.verbose(`${FAIL} => No Inclusive Author Criteria matched`);
|
||||
return [false, 'inclusive'];
|
||||
}
|
||||
if (exclude.length > 0) {
|
||||
let index = 1;
|
||||
const summaries: string[] = [];
|
||||
for (const auth of exclude) {
|
||||
const excludePass = await resources.testAuthorCriteria(item, auth, false);
|
||||
if (excludePass && excludeCondition === 'OR') {
|
||||
authorPass = true;
|
||||
break;
|
||||
} else if (!excludePass && excludeCondition === 'AND') {
|
||||
authorPass = false;
|
||||
break;
|
||||
const critResult = await resources.testAuthorCriteria(item, auth, false);
|
||||
const [summary, details] = filterCriteriaSummary(critResult);
|
||||
if (critResult.passed) {
|
||||
if(excludeCondition === 'OR') {
|
||||
authLogger.verbose(`${PASS} (OR) => Exclusive Author Criteria ${index} => ${summary}`);
|
||||
authLogger.debug(`Criteria Details: \n${details.join('\n')}`);
|
||||
authorPass = true;
|
||||
break;
|
||||
}
|
||||
summaries.push(summary);
|
||||
authLogger.debug(`${PASS} (AND) => Exclusive Author Criteria ${index} => ${summary}`);
|
||||
authLogger.debug(`Criteria Details: \n${details.join('\n')}`);
|
||||
} else if (!critResult.passed) {
|
||||
if(excludeCondition === 'AND') {
|
||||
authLogger.verbose(`${FAIL} (AND) => Exclusive Author Criteria ${index} => ${summary}`);
|
||||
authLogger.debug(`Criteria Details: \n${details.join('\n')}`);
|
||||
authorPass = false;
|
||||
break;
|
||||
}
|
||||
summaries.push(summary);
|
||||
authLogger.debug(`${FAIL} (OR) => Exclusive Author Criteria ${index} => ${summary}`);
|
||||
authLogger.debug(`Criteria Details: \n${details.join('\n')}`);
|
||||
}
|
||||
index++;
|
||||
}
|
||||
if(excludeCondition === 'AND' && authorPass === null) {
|
||||
authorPass = true;
|
||||
}
|
||||
if (authorPass !== true) {
|
||||
authLogger.verbose(`${FAIL} => Exclusive author criteria not matched`);
|
||||
if(exclude.length > 1) {
|
||||
authLogger.debug(excludeCondition === 'OR' ? `Exclusive OR => No criteria from set of ${exclude.length} matched` : `Exclusive AND => At least one of ${exclude.length} criteria did not match`)
|
||||
if(excludeCondition === 'OR') {
|
||||
authLogger.verbose(`${FAIL} => Exclusive author criteria not matched => ${summaries.length === 1 ? `${summaries[0]}` : '(many, see debug)'}`);
|
||||
}
|
||||
return [false, 'exclusive']
|
||||
}
|
||||
authLogger.verbose(`${PASS} => Exclusive author criteria matched`);
|
||||
if(exclude.length > 1) {
|
||||
authLogger.debug(excludeCondition === 'OR' ? `Exclusive OR => At least 1 in set of ${exclude.length} matched` : `Exclusive AND => All ${exclude.length} matched`)
|
||||
} else if(excludeCondition === 'AND') {
|
||||
authLogger.verbose(`${PASS} => Exclusive author criteria matched => ${summaries.length === 1 ? `${summaries[0]}` : '(many, see debug)'}`);
|
||||
}
|
||||
return [true, 'exclusive'];
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import dayjs, {Dayjs} from "dayjs";
|
||||
import {Comment, RedditUser, WikiPage} from "snoowrap";
|
||||
import Snoowrap, {Comment, RedditUser, WikiPage} from "snoowrap";
|
||||
import {
|
||||
COMMENT_URL_ID,
|
||||
deflateUserNotes, getActivityAuthorName,
|
||||
@@ -57,7 +57,7 @@ export type UserNotesConstants = Pick<any, "users" | "warnings">;
|
||||
export class UserNotes {
|
||||
notesTTL: number | false;
|
||||
subreddit: Subreddit;
|
||||
wiki: WikiPage;
|
||||
client: Snoowrap;
|
||||
moderators?: RedditUser[];
|
||||
logger: Logger;
|
||||
identifier: string;
|
||||
@@ -70,14 +70,14 @@ export class UserNotes {
|
||||
debounceCB: any;
|
||||
batchCount: number = 0;
|
||||
|
||||
constructor(ttl: number | boolean, subreddit: Subreddit, logger: Logger, cache: Cache, cacheCB: Function) {
|
||||
constructor(ttl: number | boolean, subreddit: Subreddit, client: Snoowrap, logger: Logger, cache: Cache, cacheCB: Function) {
|
||||
this.notesTTL = ttl === true ? 0 : ttl;
|
||||
this.subreddit = subreddit;
|
||||
this.logger = logger;
|
||||
this.wiki = subreddit.getWikiPage('usernotes');
|
||||
this.identifier = `${this.subreddit.display_name}-usernotes`;
|
||||
this.cache = cache;
|
||||
this.cacheCB = cacheCB;
|
||||
this.client = client;
|
||||
}
|
||||
|
||||
async getUserNotes(user: RedditUser): Promise<UserNote[]> {
|
||||
@@ -172,8 +172,8 @@ export class UserNotes {
|
||||
// this.saveDebounce = undefined;
|
||||
// }
|
||||
// @ts-ignore
|
||||
this.wiki = await this.subreddit.getWikiPage('usernotes').fetch();
|
||||
const wikiContent = this.wiki.content_md;
|
||||
const wiki = this.client.getSubreddit(this.subreddit.display_name).getWikiPage('usernotes');
|
||||
const wikiContent = await wiki.content_md;
|
||||
// TODO don't handle for versions lower than 6
|
||||
const userNotes = JSON.parse(wikiContent);
|
||||
|
||||
@@ -197,6 +197,7 @@ export class UserNotes {
|
||||
const blob = deflateUserNotes(payload.blob);
|
||||
const wikiPayload = {text: JSON.stringify({...payload, blob}), reason: 'ContextBot edited usernotes'};
|
||||
try {
|
||||
const wiki = this.client.getSubreddit(this.subreddit.display_name).getWikiPage('usernotes');
|
||||
if (this.notesTTL !== false) {
|
||||
// DISABLED for now because if it fails throws an uncaught rejection
|
||||
// and need to figured out how to handle this other than just logging (want to interrupt action flow too?)
|
||||
@@ -226,12 +227,12 @@ export class UserNotes {
|
||||
// this.logger.debug(`Saving Usernotes has been debounced for 5 seconds (${this.batchCount} batched)`)
|
||||
|
||||
// @ts-ignore
|
||||
await this.subreddit.getWikiPage('usernotes').edit(wikiPayload);
|
||||
await wiki.edit(wikiPayload);
|
||||
await this.cache.set(this.identifier, payload, {ttl: this.notesTTL});
|
||||
this.users = new Map();
|
||||
} else {
|
||||
// @ts-ignore
|
||||
this.wiki = await this.subreddit.getWikiPage('usernotes').edit(wikiPayload);
|
||||
await wiki.edit(wikiPayload);
|
||||
}
|
||||
|
||||
return payload as RawUserNotesPayload;
|
||||
|
||||
@@ -56,7 +56,7 @@ export const port = new commander.Option('-p, --port <port>', 'Port for web serv
|
||||
export const sharedMod = new commander.Option('-q, --shareMod', `If enabled then all subreddits using the default settings to poll "unmoderated" or "modqueue" will retrieve results from a shared request to /r/mod (default: process.env.SHARE_MOD || false)`)
|
||||
.argParser(parseBool);
|
||||
|
||||
export const operatorConfig = new commander.Option('-c, --operatorConfig <path>', 'An absolute path to a JSON file to load all parameters from (default: process.env.OPERATOR_CONFIG)');
|
||||
export const operatorConfig = new commander.Option('-c, --operatorConfig <path>', 'An absolute path to a YAML/JSON file to load all parameters from (default: process.env.OPERATOR_CONFIG | CWD/config.yaml)');
|
||||
|
||||
export const getUniversalWebOptions = (): commander.Option[] => {
|
||||
return [
|
||||
|
||||
@@ -8,22 +8,23 @@ import he from "he";
|
||||
import {RuleResult, UserNoteCriteria} from "../Rule";
|
||||
import {
|
||||
ActivityWindowType, CommentState, DomainInfo,
|
||||
DurationVal,
|
||||
DurationVal, FilterCriteriaPropertyResult, FilterCriteriaResult,
|
||||
SubmissionState,
|
||||
TypedActivityStates
|
||||
} from "../Common/interfaces";
|
||||
import {
|
||||
asUserNoteCriteria,
|
||||
compareDurationValue,
|
||||
comparisonTextOp, escapeRegex, getActivityAuthorName,
|
||||
isActivityWindowCriteria,
|
||||
comparisonTextOp, escapeRegex, formatNumber, getActivityAuthorName,
|
||||
isActivityWindowCriteria, isUserNoteCriteria,
|
||||
normalizeName,
|
||||
parseDuration,
|
||||
parseDurationComparison,
|
||||
parseGenericValueComparison,
|
||||
parseGenericValueOrPercentComparison,
|
||||
parseRuleResultsToMarkdownSummary, parseStringToRegex,
|
||||
parseSubredditName,
|
||||
truncateStringToLength, windowToActivityWindowCriteria
|
||||
parseSubredditName, removeUndefinedKeys,
|
||||
truncateStringToLength, userNoteCriteriaSummary, windowToActivityWindowCriteria
|
||||
} from "../util";
|
||||
import UserNotes from "../Subreddit/UserNotes";
|
||||
import {Logger} from "winston";
|
||||
@@ -32,6 +33,7 @@ import SimpleError from "./SimpleError";
|
||||
import {AuthorCriteria} from "../Author/Author";
|
||||
import {URL} from "url";
|
||||
import {isStatusError} from "./Errors";
|
||||
import {Dictionary, ElementOf, SafeDictionary} from "ts-essentials";
|
||||
|
||||
export const BOT_LINK = 'https://www.reddit.com/r/ContextModBot/comments/otz396/introduction_to_contextmodbot';
|
||||
|
||||
@@ -354,24 +356,54 @@ export const renderContent = async (template: string, data: (Submission | Commen
|
||||
return he.decode(rendered);
|
||||
}
|
||||
|
||||
export const testAuthorCriteria = async (item: (Comment | Submission), authorOpts: AuthorCriteria, include = true, userNotes: UserNotes) => {
|
||||
const {shadowBanned, ...rest} = authorOpts;
|
||||
type AuthorCritPropHelper = SafeDictionary<FilterCriteriaPropertyResult<AuthorCriteria>, keyof AuthorCriteria>;
|
||||
type RequiredAuthorCrit = Required<AuthorCriteria>;
|
||||
|
||||
if(shadowBanned !== undefined) {
|
||||
export const testAuthorCriteria = async (item: (Comment | Submission), authorOpts: AuthorCriteria, include = true, userNotes: UserNotes): Promise<FilterCriteriaResult<AuthorCriteria>> => {
|
||||
|
||||
|
||||
const definedAuthorOpts = (removeUndefinedKeys(authorOpts) as RequiredAuthorCrit);
|
||||
|
||||
const propResultsMap = Object.entries(definedAuthorOpts).reduce((acc: AuthorCritPropHelper, [k, v]) => {
|
||||
const key = (k as keyof AuthorCriteria);
|
||||
let ex;
|
||||
if (Array.isArray(v)) {
|
||||
ex = v.map(x => {
|
||||
if (asUserNoteCriteria(x)) {
|
||||
return userNoteCriteriaSummary(x);
|
||||
}
|
||||
return x;
|
||||
});
|
||||
} else {
|
||||
ex = [v];
|
||||
}
|
||||
acc[key] = {
|
||||
property: key,
|
||||
expected: ex,
|
||||
behavior: include ? 'include' : 'exclude',
|
||||
};
|
||||
return acc;
|
||||
}, {});
|
||||
|
||||
const {shadowBanned} = authorOpts;
|
||||
|
||||
if (shadowBanned !== undefined) {
|
||||
try {
|
||||
// @ts-ignore
|
||||
await item.author.fetch();
|
||||
// user is not shadowbanned
|
||||
// if criteria specifies they SHOULD be shadowbanned then return false now
|
||||
if(shadowBanned) {
|
||||
return false;
|
||||
if (shadowBanned) {
|
||||
propResultsMap.shadowBanned!.found = false;
|
||||
propResultsMap.shadowBanned!.passed = false;
|
||||
}
|
||||
} catch (err: any) {
|
||||
if(isStatusError(err) && err.statusCode === 404) {
|
||||
if (isStatusError(err) && err.statusCode === 404) {
|
||||
// user is shadowbanned
|
||||
// if criteria specifies they should not be shadowbanned then return false now
|
||||
if(!shadowBanned) {
|
||||
return false;
|
||||
if (!shadowBanned) {
|
||||
propResultsMap.shadowBanned!.found = true;
|
||||
propResultsMap.shadowBanned!.passed = false;
|
||||
}
|
||||
} else {
|
||||
throw err;
|
||||
@@ -379,17 +411,30 @@ export const testAuthorCriteria = async (item: (Comment | Submission), authorOpt
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
const authorName = getActivityAuthorName(item.author);
|
||||
|
||||
for (const k of Object.keys(rest)) {
|
||||
// @ts-ignore
|
||||
if (authorOpts[k] !== undefined) {
|
||||
|
||||
if (propResultsMap.shadowBanned === undefined || propResultsMap.shadowBanned.passed === undefined) {
|
||||
try {
|
||||
const authorName = getActivityAuthorName(item.author);
|
||||
|
||||
const keys = Object.keys(propResultsMap) as (keyof AuthorCriteria)[]
|
||||
|
||||
let shouldContinue = true;
|
||||
for (const k of keys) {
|
||||
if (k === 'shadowBanned') {
|
||||
// we have already taken care of this with shadowban check above
|
||||
continue;
|
||||
}
|
||||
|
||||
const authorOptVal = definedAuthorOpts[k];
|
||||
|
||||
//if (authorOpts[k] !== undefined) {
|
||||
switch (k) {
|
||||
case 'name':
|
||||
const nameVal = authorOptVal as RequiredAuthorCrit['name'];
|
||||
const authPass = () => {
|
||||
// @ts-ignore
|
||||
for (const n of authorOpts[k]) {
|
||||
|
||||
for (const n of nameVal) {
|
||||
if (n.toLowerCase() === authorName.toLowerCase()) {
|
||||
return true;
|
||||
}
|
||||
@@ -397,8 +442,10 @@ export const testAuthorCriteria = async (item: (Comment | Submission), authorOpt
|
||||
return false;
|
||||
}
|
||||
const authResult = authPass();
|
||||
if ((include && !authResult) || (!include && authResult)) {
|
||||
return false;
|
||||
propResultsMap.name!.found = authorName;
|
||||
propResultsMap.name!.passed = !((include && !authResult) || (!include && authResult));
|
||||
if (!propResultsMap.name!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'flairCssClass':
|
||||
@@ -413,8 +460,10 @@ export const testAuthorCriteria = async (item: (Comment | Submission), authorOpt
|
||||
return false;
|
||||
}
|
||||
const cssResult = cssPass();
|
||||
if ((include && !cssResult) || (!include && cssResult)) {
|
||||
return false;
|
||||
propResultsMap.flairCssClass!.found = css;
|
||||
propResultsMap.flairCssClass!.passed = !((include && !cssResult) || (!include && cssResult));
|
||||
if (!propResultsMap.flairCssClass!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'flairText':
|
||||
@@ -429,68 +478,103 @@ export const testAuthorCriteria = async (item: (Comment | Submission), authorOpt
|
||||
return false;
|
||||
};
|
||||
const textResult = textPass();
|
||||
if ((include && !textResult) || (!include && textResult)) {
|
||||
propResultsMap.flairText!.found = text;
|
||||
propResultsMap.flairText!.passed = !((include && !textResult) || (!include && textResult));
|
||||
if (!propResultsMap.flairText!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'flairTemplate':
|
||||
const templateId = await item.author_flair_template_id;
|
||||
const templatePass = () => {
|
||||
// @ts-ignore
|
||||
for (const c of authorOpts[k]) {
|
||||
if (c === templateId) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
};
|
||||
const templateResult = templatePass();
|
||||
propResultsMap.flairTemplate!.found = templateId;
|
||||
propResultsMap.flairTemplate!.passed = !((include && !templateResult) || (!include && templateResult));
|
||||
if (!propResultsMap.flairTemplate!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'isMod':
|
||||
const mods: RedditUser[] = await item.subreddit.getModerators();
|
||||
const isModerator = mods.some(x => x.name === authorName);
|
||||
const modMatch = authorOpts.isMod === isModerator;
|
||||
if ((include && !modMatch) || (!include && modMatch)) {
|
||||
return false;
|
||||
propResultsMap.isMod!.found = isModerator;
|
||||
propResultsMap.isMod!.passed = !((include && !modMatch) || (!include && modMatch));
|
||||
if (!propResultsMap.isMod!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'age':
|
||||
const ageTest = compareDurationValue(parseDurationComparison(await authorOpts.age as string), dayjs.unix(await item.author.created));
|
||||
if ((include && !ageTest) || (!include && ageTest)) {
|
||||
return false;
|
||||
const authorAge = dayjs.unix(await item.author.created);
|
||||
const ageTest = compareDurationValue(parseDurationComparison(await authorOpts.age as string), authorAge);
|
||||
propResultsMap.age!.found = authorAge.fromNow(true);
|
||||
propResultsMap.age!.passed = !((include && !ageTest) || (!include && ageTest));
|
||||
if (!propResultsMap.age!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'linkKarma':
|
||||
// @ts-ignore
|
||||
const tk = await item.author.total_karma as number;
|
||||
const lkCompare = parseGenericValueOrPercentComparison(await authorOpts.linkKarma as string);
|
||||
let lkMatch;
|
||||
if (lkCompare.isPercent) {
|
||||
// @ts-ignore
|
||||
const tk = await item.author.total_karma as number;
|
||||
|
||||
lkMatch = comparisonTextOp(item.author.link_karma / tk, lkCompare.operator, lkCompare.value / 100);
|
||||
} else {
|
||||
lkMatch = comparisonTextOp(item.author.link_karma, lkCompare.operator, lkCompare.value);
|
||||
}
|
||||
if ((include && !lkMatch) || (!include && lkMatch)) {
|
||||
return false;
|
||||
propResultsMap.linkKarma!.found = tk;
|
||||
propResultsMap.linkKarma!.passed = !((include && !lkMatch) || (!include && lkMatch));
|
||||
if (!propResultsMap.linkKarma!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'commentKarma':
|
||||
// @ts-ignore
|
||||
const ck = await item.author.total_karma as number;
|
||||
const ckCompare = parseGenericValueOrPercentComparison(await authorOpts.commentKarma as string);
|
||||
let ckMatch;
|
||||
if (ckCompare.isPercent) {
|
||||
// @ts-ignore
|
||||
const ck = await item.author.total_karma as number;
|
||||
ckMatch = comparisonTextOp(item.author.comment_karma / ck, ckCompare.operator, ckCompare.value / 100);
|
||||
} else {
|
||||
ckMatch = comparisonTextOp(item.author.comment_karma, ckCompare.operator, ckCompare.value);
|
||||
}
|
||||
if ((include && !ckMatch) || (!include && ckMatch)) {
|
||||
return false;
|
||||
propResultsMap.commentKarma!.found = ck;
|
||||
propResultsMap.commentKarma!.passed = !((include && !ckMatch) || (!include && ckMatch));
|
||||
if (!propResultsMap.commentKarma!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'totalKarma':
|
||||
// @ts-ignore
|
||||
const totalKarma = await item.author.total_karma as number;
|
||||
const tkCompare = parseGenericValueComparison(await authorOpts.totalKarma as string);
|
||||
if (tkCompare.isPercent) {
|
||||
throw new SimpleError(`'totalKarma' value on AuthorCriteria cannot be a percentage`);
|
||||
}
|
||||
// @ts-ignore
|
||||
const totalKarma = await item.author.total_karma as number;
|
||||
const tkMatch = comparisonTextOp(totalKarma, tkCompare.operator, tkCompare.value);
|
||||
if ((include && !tkMatch) || (!include && tkMatch)) {
|
||||
return false;
|
||||
propResultsMap.totalKarma!.found = totalKarma;
|
||||
propResultsMap.totalKarma!.passed = !((include && !tkMatch) || (!include && tkMatch));
|
||||
if (!propResultsMap.totalKarma!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'verified':
|
||||
const vMatch = await item.author.has_verified_mail === authorOpts.verified as boolean;
|
||||
if ((include && !vMatch) || (!include && vMatch)) {
|
||||
return false;
|
||||
const verified = await item.author.has_verified_mail;
|
||||
const vMatch = verified === authorOpts.verified as boolean;
|
||||
propResultsMap.verified!.found = verified;
|
||||
propResultsMap.verified!.passed = !((include && !vMatch) || (!include && vMatch));
|
||||
if (!propResultsMap.verified!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
case 'description':
|
||||
@@ -498,25 +582,32 @@ export const testAuthorCriteria = async (item: (Comment | Submission), authorOpt
|
||||
const desc = await item.author.subreddit?.display_name.public_description;
|
||||
const dVals = authorOpts[k] as string[];
|
||||
let passed = false;
|
||||
for(const val of dVals) {
|
||||
let passReg;
|
||||
for (const val of dVals) {
|
||||
let reg = parseStringToRegex(val, 'i');
|
||||
if(reg === undefined) {
|
||||
if (reg === undefined) {
|
||||
reg = parseStringToRegex(`/.*${escapeRegex(val.trim())}.*/`, 'i');
|
||||
if(reg === undefined) {
|
||||
if (reg === undefined) {
|
||||
throw new SimpleError(`Could not convert 'description' value to a valid regex: ${authorOpts[k] as string}`);
|
||||
}
|
||||
}
|
||||
if(reg.test(desc)) {
|
||||
if (reg.test(desc)) {
|
||||
passed = true;
|
||||
passReg = reg.toString();
|
||||
break;
|
||||
}
|
||||
}
|
||||
if(!passed) {
|
||||
return false;
|
||||
propResultsMap.description!.found = typeof desc === 'string' ? truncateStringToLength(50)(desc) : desc;
|
||||
propResultsMap.description!.passed = !((include && !passed) || (!include && passed));
|
||||
if (!propResultsMap.description!.passed) {
|
||||
shouldContinue = false;
|
||||
} else {
|
||||
propResultsMap.description!.reason = `Matched with: ${passReg as string}`;
|
||||
}
|
||||
break;
|
||||
case 'userNotes':
|
||||
const notes = await userNotes.getUserNotes(item.author);
|
||||
let foundNoteResult: string[] = [];
|
||||
const notePass = () => {
|
||||
for (const noteCriteria of authorOpts[k] as UserNoteCriteria[]) {
|
||||
const {count = '>= 1', search = 'current', type} = noteCriteria;
|
||||
@@ -529,8 +620,14 @@ export const testAuthorCriteria = async (item: (Comment | Submission), authorOpt
|
||||
const order = extra.includes('asc') ? 'ascending' : 'descending';
|
||||
switch (search) {
|
||||
case 'current':
|
||||
if (notes.length > 0 && notes[notes.length - 1].noteType === type) {
|
||||
return true;
|
||||
if (notes.length > 0) {
|
||||
const currentNoteType = notes[notes.length - 1].noteType;
|
||||
foundNoteResult.push(`Current => ${currentNoteType}`);
|
||||
if (currentNoteType === type) {
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
foundNoteResult.push('No notes present');
|
||||
}
|
||||
break;
|
||||
case 'consecutive':
|
||||
@@ -549,39 +646,64 @@ export const testAuthorCriteria = async (item: (Comment | Submission), authorOpt
|
||||
if (isPercent) {
|
||||
throw new SimpleError(`When comparing UserNotes with 'consecutive' search 'count' cannot be a percentage. Given: ${count}`);
|
||||
}
|
||||
foundNoteResult.push(`Found ${currCount} ${type} consecutively`);
|
||||
if (comparisonTextOp(currCount, operator, value)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
break;
|
||||
case 'total':
|
||||
const filteredNotes = notes.filter(x => x.noteType === type);
|
||||
if (isPercent) {
|
||||
if (comparisonTextOp(notes.filter(x => x.noteType === type).length / notes.length, operator, value / 100)) {
|
||||
// avoid divide by zero
|
||||
const percent = notes.length === 0 ? 0 : filteredNotes.length / notes.length;
|
||||
foundNoteResult.push(`${formatNumber(percent)}% are ${type}`);
|
||||
if (comparisonTextOp(percent, operator, value / 100)) {
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
foundNoteResult.push(`${filteredNotes.length} are ${type}`);
|
||||
if (comparisonTextOp(notes.filter(x => x.noteType === type).length, operator, value)) {
|
||||
return true;
|
||||
}
|
||||
} else if (comparisonTextOp(notes.filter(x => x.noteType === type).length, operator, value)) {
|
||||
return true;
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
const noteResult = notePass();
|
||||
if ((include && !noteResult) || (!include && noteResult)) {
|
||||
return false;
|
||||
propResultsMap.userNotes!.found = foundNoteResult.join(' | ');
|
||||
propResultsMap.userNotes!.passed = !((include && !noteResult) || (!include && noteResult));
|
||||
if (!propResultsMap.userNotes!.passed) {
|
||||
shouldContinue = false;
|
||||
}
|
||||
break;
|
||||
}
|
||||
//}
|
||||
if (!shouldContinue) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
} catch (err: any) {
|
||||
if (isStatusError(err) && err.statusCode === 404) {
|
||||
throw new SimpleError('Reddit returned a 404 while trying to retrieve User profile. It is likely this user is shadowbanned.');
|
||||
} else {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
} catch (err: any) {
|
||||
if(isStatusError(err) && err.statusCode === 404) {
|
||||
throw new SimpleError('Reddit returned a 404 while trying to retrieve User profile. It is likely this user is shadowbanned.');
|
||||
} else {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
// gather values and determine overall passed
|
||||
const propResults = Object.values(propResultsMap);
|
||||
const passed = propResults.filter(x => typeof x.passed === 'boolean').every(x => x.passed === true);
|
||||
|
||||
return {
|
||||
behavior: include ? 'include' : 'exclude',
|
||||
criteria: authorOpts,
|
||||
propertyResults: propResults,
|
||||
passed,
|
||||
};
|
||||
}
|
||||
|
||||
export interface ItemContent {
|
||||
|
||||
@@ -9,10 +9,10 @@ import {Strategy as CustomStrategy} from 'passport-custom';
|
||||
import {OperatorConfig, BotConnection, LogInfo} from "../../Common/interfaces";
|
||||
import {
|
||||
buildCachePrefix,
|
||||
createCacheManager, filterLogBySubreddit,
|
||||
createCacheManager, defaultFormat, filterLogBySubreddit,
|
||||
formatLogLineToHtml,
|
||||
intersect, isLogLineMinLevel,
|
||||
LogEntry, parseFromJsonOrYamlToObject, parseInstanceLogInfoName, parseInstanceLogName,
|
||||
LogEntry, parseInstanceLogInfoName, parseInstanceLogName, parseRedditEntity,
|
||||
parseSubredditLogName, permissions,
|
||||
randomId, sleep, triggeredIndicator
|
||||
} from "../../util";
|
||||
@@ -47,6 +47,8 @@ import Autolinker from "autolinker";
|
||||
import path from "path";
|
||||
import {ExtendedSnoowrap} from "../../Utils/SnoowrapClients";
|
||||
import ClientUser from "../Common/User/ClientUser";
|
||||
import {BotStatusResponse} from "../Common/interfaces";
|
||||
import {TransformableInfo} from "logform";
|
||||
|
||||
const emitter = new EventEmitter();
|
||||
|
||||
@@ -318,32 +320,36 @@ const webClient = async (options: OperatorConfig) => {
|
||||
});
|
||||
// @ts-ignore
|
||||
const user = await client.getMe();
|
||||
const userName = `u/${user.name}`;
|
||||
// @ts-ignore
|
||||
await webCache.del(`invite:${req.session.inviteId}`);
|
||||
let data: any = {
|
||||
accessToken: client.accessToken,
|
||||
refreshToken: client.refreshToken,
|
||||
userName,
|
||||
};
|
||||
if(invite.instance !== undefined) {
|
||||
const bot = cmInstances.find(x => x.friendly === invite.instance);
|
||||
if(bot !== undefined) {
|
||||
const botPayload: any = {
|
||||
overwrite: invite.overwrite === true,
|
||||
name: userName,
|
||||
credentials: {
|
||||
accessToken: client.accessToken,
|
||||
refreshToken: client.refreshToken,
|
||||
clientId: invite.clientId,
|
||||
clientSecret: invite.clientSecret,
|
||||
reddit: {
|
||||
accessToken: client.accessToken,
|
||||
refreshToken: client.refreshToken,
|
||||
clientId: invite.clientId,
|
||||
clientSecret: invite.clientSecret,
|
||||
}
|
||||
}
|
||||
};
|
||||
if(invite.subreddit !== undefined) {
|
||||
botPayload.subreddits = {names: [invite.subreddit]};
|
||||
if(invite.subreddits !== undefined && invite.subreddits.length > 0) {
|
||||
botPayload.subreddits = {names: invite.subreddits};
|
||||
}
|
||||
const botAddResult: any = await addBot(bot, {name: invite.creator}, botPayload);
|
||||
let msg = botAddResult.success ? 'Bot successfully added to running instance' : 'An error occurred while adding the bot to the instance';
|
||||
if(botAddResult.success) {
|
||||
msg = `${msg}. ${botAddResult.stored === false ? 'Additionally, the bot was not stored in config so the operator will need to add it manually to persist after a restart.' : ''}`;
|
||||
}
|
||||
data.addResult = msg;
|
||||
// stored
|
||||
// success
|
||||
data = {...data, ...botAddResult};
|
||||
// @ts-ignore
|
||||
req.session.destroy();
|
||||
req.logout();
|
||||
@@ -388,12 +394,13 @@ const webClient = async (options: OperatorConfig) => {
|
||||
let token = randomId();
|
||||
interface InviteData {
|
||||
permissions: string[],
|
||||
subreddit?: string,
|
||||
subreddits?: string,
|
||||
instance?: string,
|
||||
clientId: string
|
||||
clientSecret: string
|
||||
redirectUri: string
|
||||
creator: string
|
||||
overwrite?: boolean
|
||||
}
|
||||
|
||||
const helperAuthed = async (req: express.Request, res: express.Response, next: Function) => {
|
||||
@@ -421,7 +428,8 @@ const webClient = async (options: OperatorConfig) => {
|
||||
redirectUri,
|
||||
clientId,
|
||||
clientSecret,
|
||||
token: req.isAuthenticated() && req.user?.clientData?.webOperator ? token : undefined
|
||||
token: req.isAuthenticated() && req.user?.clientData?.webOperator ? token : undefined,
|
||||
instances: cmInstances.filter(x => req.user?.isInstanceOperator(x)).map(x => x.friendly),
|
||||
});
|
||||
});
|
||||
|
||||
@@ -449,7 +457,7 @@ const webClient = async (options: OperatorConfig) => {
|
||||
clientSecret: ce,
|
||||
redirect: redir,
|
||||
instance,
|
||||
subreddit,
|
||||
subreddits,
|
||||
code,
|
||||
} = req.body as any;
|
||||
|
||||
@@ -474,7 +482,7 @@ const webClient = async (options: OperatorConfig) => {
|
||||
clientSecret: (ce || clientSecret).trim(),
|
||||
redirectUri: redir.trim(),
|
||||
instance,
|
||||
subreddit,
|
||||
subreddits: subreddits.trim() === '' ? [] : subreddits.split(',').map((x: string) => parseRedditEntity(x).name),
|
||||
creator: (req.user as Express.User).name,
|
||||
}, {ttl: invitesMaxAge * 1000});
|
||||
return res.send(inviteId);
|
||||
@@ -519,6 +527,8 @@ const webClient = async (options: OperatorConfig) => {
|
||||
|
||||
const cmInstances: CMInstance[] = [];
|
||||
let init = false;
|
||||
const formatter = defaultFormat();
|
||||
const formatTransform = formatter.transform as (info: TransformableInfo, opts?: any) => TransformableInfo;
|
||||
|
||||
let server: http.Server,
|
||||
io: SocketServer;
|
||||
@@ -559,7 +569,9 @@ const webClient = async (options: OperatorConfig) => {
|
||||
limit: sessionData.limit,
|
||||
sort: sessionData.sort,
|
||||
level: sessionData.level,
|
||||
stream: true
|
||||
stream: true,
|
||||
streamObjects: true,
|
||||
formatted: false,
|
||||
}
|
||||
});
|
||||
|
||||
@@ -583,8 +595,24 @@ const webClient = async (options: OperatorConfig) => {
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
delim.on('data', (c: any) => {
|
||||
io.to(sessionId).emit('log', formatLogLineToHtml(c.toString()));
|
||||
const logObj = JSON.parse(c) as LogInfo;
|
||||
let subredditMessage;
|
||||
let allMessage;
|
||||
if(logObj.subreddit !== undefined) {
|
||||
const {subreddit, bot, ...rest} = logObj
|
||||
// @ts-ignore
|
||||
subredditMessage = formatLogLineToHtml(formatter.transform(rest)[MESSAGE], rest.timestamp);
|
||||
}
|
||||
if(logObj.bot !== undefined) {
|
||||
const {bot, ...rest} = logObj
|
||||
// @ts-ignore
|
||||
allMessage = formatLogLineToHtml(formatter.transform(rest)[MESSAGE], rest.timestamp);
|
||||
}
|
||||
// @ts-ignore
|
||||
let formattedMessage = formatLogLineToHtml(formatter.transform(logObj)[MESSAGE], logObj.timestamp);
|
||||
io.to(sessionId).emit('log', {...logObj, subredditMessage, allMessage, formattedMessage});
|
||||
});
|
||||
|
||||
gotStream.once('retry', retryFn);
|
||||
@@ -816,12 +844,39 @@ const webClient = async (options: OperatorConfig) => {
|
||||
// return acc.concat({...curr, isOperator: instanceOperator});
|
||||
// },[]);
|
||||
|
||||
const isOp = req.user?.isInstanceOperator(instance);
|
||||
|
||||
res.render('status', {
|
||||
instances: shownInstances,
|
||||
bots: resp.bots,
|
||||
bots: resp.bots.map((x: BotStatusResponse) => {
|
||||
const {subreddits = []} = x;
|
||||
const subredditsWithSimpleLogs = subreddits.map(y => {
|
||||
let transformedLogs: string[];
|
||||
if(y.name === 'All') {
|
||||
// only need to remove bot name here
|
||||
transformedLogs = (y.logs as LogInfo[]).map((z: LogInfo) => {
|
||||
const {bot, ...rest} = z;
|
||||
// @ts-ignore
|
||||
return formatLogLineToHtml(formatter.transform(rest)[MESSAGE] as string, rest.timestamp);
|
||||
});
|
||||
} else {
|
||||
transformedLogs = (y.logs as LogInfo[]).map((z: LogInfo) => {
|
||||
const {bot, subreddit, ...rest} = z;
|
||||
// @ts-ignore
|
||||
return formatLogLineToHtml(formatter.transform(rest)[MESSAGE] as string, rest.timestamp);
|
||||
});
|
||||
}
|
||||
y.logs = transformedLogs;
|
||||
return y;
|
||||
});
|
||||
return {...x, subreddits: subredditsWithSimpleLogs};
|
||||
}),
|
||||
botId: (req.instance as CMInstance).friendly,
|
||||
instanceId: (req.instance as CMInstance).friendly,
|
||||
isOperator: req.user?.isInstanceOperator(instance),
|
||||
isOperator: isOp,
|
||||
system: isOp ? {
|
||||
logs: resp.system.logs,
|
||||
} : undefined,
|
||||
operators: instance.operators.join(', '),
|
||||
operatorDisplay: instance.operatorDisplay,
|
||||
logSettings: {
|
||||
@@ -1077,8 +1132,9 @@ const webClient = async (options: OperatorConfig) => {
|
||||
try {
|
||||
const token = createToken(bot, userPayload);
|
||||
const resp = await got.post(`${bot.normalUrl}/bot`, {
|
||||
body: botPayload,
|
||||
body: JSON.stringify(botPayload),
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
'Authorization': `Bearer ${token}`,
|
||||
}
|
||||
}).json() as object;
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import {RunningState} from "../../Subreddit/Manager";
|
||||
import {ManagerStats} from "../../Common/interfaces";
|
||||
import {LogInfo, ManagerStats} from "../../Common/interfaces";
|
||||
|
||||
export interface BotStats {
|
||||
startedAtHuman: string,
|
||||
@@ -15,7 +15,7 @@ export interface BotStats {
|
||||
|
||||
export interface SubredditDataResponse {
|
||||
name: string
|
||||
logs: string[]
|
||||
logs: (string|LogInfo)[]
|
||||
botState: RunningState
|
||||
eventsState: RunningState
|
||||
queueState: RunningState
|
||||
|
||||
@@ -5,7 +5,7 @@ import {formatNumber} from "../../util";
|
||||
import Bot from "../../Bot";
|
||||
|
||||
export const opStats = (bot: Bot): BotStats => {
|
||||
const limitReset = dayjs(bot.client.ratelimitExpiration);
|
||||
const limitReset = bot.client === undefined ? dayjs() : dayjs(bot.client.ratelimitExpiration);
|
||||
const nextHeartbeat = bot.nextHeartbeat !== undefined ? bot.nextHeartbeat.local().format('MMMM D, YYYY h:mm A Z') : 'N/A';
|
||||
const nextHeartbeatHuman = bot.nextHeartbeat !== undefined ? `in ${dayjs.duration(bot.nextHeartbeat.diff(dayjs())).humanize()}` : 'N/A'
|
||||
return {
|
||||
|
||||
@@ -3,6 +3,8 @@ import {BotInstanceConfig} from "../../../../../Common/interfaces";
|
||||
import {authUserCheck} from "../../../middleware";
|
||||
import Bot from "../../../../../Bot";
|
||||
import LoggedError from "../../../../../Utils/LoggedError";
|
||||
import {open} from 'fs/promises';
|
||||
import {buildBotConfig} from "../../../../../ConfigBuilder";
|
||||
|
||||
const addBot = () => {
|
||||
|
||||
@@ -16,9 +18,37 @@ const addBot = () => {
|
||||
return res.status(401).send("Must be an Operator to use this route");
|
||||
}
|
||||
|
||||
const newBot = new Bot(req.body as BotInstanceConfig, req.botApp.logger);
|
||||
if (!req.botApp.fileConfig.isWriteable) {
|
||||
return res.status(409).send('Operator config is not writeable');
|
||||
}
|
||||
|
||||
const {overwrite = false, ...botData} = req.body;
|
||||
|
||||
// check if bot is new or overwriting
|
||||
let existingBot = req.botApp.bots.find(x => x.botAccount === botData.name);
|
||||
// spin down existing
|
||||
if (existingBot !== undefined) {
|
||||
const {
|
||||
bots: botsFromConfig = []
|
||||
} = req.botApp.fileConfig.document.toJS();
|
||||
if(botsFromConfig.length === 0 || botsFromConfig.some(x => x.name !== botData.name)) {
|
||||
req.botApp.logger.warn('Overwriting existing bot with the same name BUT this bot does not exist in the operator CONFIG FILE. You should check how you have provided config before next start or else this bot may be started twice (once from file, once from arg/env)');
|
||||
|
||||
}
|
||||
|
||||
await existingBot.destroy('system');
|
||||
req.botApp.bots.filter(x => x.botAccount !== botData.name);
|
||||
}
|
||||
|
||||
req.botApp.fileConfig.document.addBot(botData);
|
||||
|
||||
const handle = await open(req.botApp.fileConfig.document.location as string, 'w');
|
||||
await handle.writeFile(req.botApp.fileConfig.document.toString());
|
||||
await handle.close();
|
||||
|
||||
const newBot = new Bot(buildBotConfig(botData, req.botApp.config), req.botApp.logger);
|
||||
req.botApp.bots.push(newBot);
|
||||
let result: any = {stored: true};
|
||||
let result: any = {stored: true, success: true};
|
||||
try {
|
||||
if (newBot.error !== undefined) {
|
||||
result.error = newBot.error;
|
||||
@@ -26,13 +56,14 @@ const addBot = () => {
|
||||
}
|
||||
await newBot.testClient();
|
||||
await newBot.buildManagers();
|
||||
newBot.runManagers('user').catch((err) => {
|
||||
newBot.runManagers('system').catch((err) => {
|
||||
req.botApp.logger.error(`Unexpected error occurred while running Bot ${newBot.botName}. Bot must be re-built to restart`);
|
||||
if (!err.logged || !(err instanceof LoggedError)) {
|
||||
req.botApp.logger.error(err);
|
||||
}
|
||||
});
|
||||
} catch (err: any) {
|
||||
result.success = false;
|
||||
if (newBot.error === undefined) {
|
||||
newBot.error = err.message;
|
||||
result.error = err.message;
|
||||
|
||||
@@ -27,7 +27,7 @@ const logs = (subLogMap: Map<string, LogEntry[]>) => {
|
||||
const userName = req.user?.name as string;
|
||||
const isOperator = req.user?.isInstanceOperator(req.botApp);
|
||||
const realManagers = req.botApp.bots.map(x => req.user?.accessibleSubreddits(x).map(x => x.displayLabel)).flat() as string[];
|
||||
const {level = 'verbose', stream, limit = 200, sort = 'descending', streamObjects = false} = req.query;
|
||||
const {level = 'verbose', stream, limit = 200, sort = 'descending', streamObjects = false, formatted = true} = req.query;
|
||||
if (stream) {
|
||||
const origin = req.header('X-Forwarded-For') ?? req.header('host');
|
||||
try {
|
||||
@@ -36,9 +36,16 @@ const logs = (subLogMap: Map<string, LogEntry[]>) => {
|
||||
const {subreddit: subName} = log;
|
||||
if (isOperator || (subName !== undefined && (realManagers.includes(subName) || subName.includes(userName)))) {
|
||||
if(streamObjects) {
|
||||
res.write(`${JSON.stringify(log)}\r\n`);
|
||||
} else {
|
||||
let obj: any = log;
|
||||
if(!formatted) {
|
||||
const {[MESSAGE]: fMessage, ...rest} = log;
|
||||
obj = rest;
|
||||
}
|
||||
res.write(`${JSON.stringify(obj)}\r\n`);
|
||||
} else if(formatted) {
|
||||
res.write(`${log[MESSAGE]}\r\n`)
|
||||
} else {
|
||||
res.write(`${log.message}\r\n`)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -62,11 +69,17 @@ const logs = (subLogMap: Map<string, LogEntry[]>) => {
|
||||
operator: isOperator,
|
||||
user: userName,
|
||||
sort: sort as 'descending' | 'ascending',
|
||||
limit: Number.parseInt((limit as string))
|
||||
limit: Number.parseInt((limit as string)),
|
||||
returnType: 'object',
|
||||
});
|
||||
const subArr: any = [];
|
||||
logs.forEach((v: string[], k: string) => {
|
||||
subArr.push({name: k, logs: v.join('')});
|
||||
logs.forEach((v: (string|LogInfo)[], k: string) => {
|
||||
let logs = v as LogInfo[];
|
||||
let output: any[] = formatted ? logs : logs.map((x) => {
|
||||
const {[MESSAGE]: fMessage, ...rest} = x;
|
||||
return rest;
|
||||
})
|
||||
subArr.push({name: k, logs: output});
|
||||
});
|
||||
return res.json(subArr);
|
||||
}
|
||||
|
||||
@@ -44,13 +44,15 @@ const status = () => {
|
||||
bots = req.user?.accessibleBots(req.botApp.bots) as Bot[];
|
||||
}
|
||||
const botResponses: BotStatusResponse[] = [];
|
||||
let index = 1;
|
||||
for(const b of bots) {
|
||||
botResponses.push(await botStatResponse(b, req, botLogMap));
|
||||
botResponses.push(await botStatResponse(b, req, botLogMap, index));
|
||||
index++;
|
||||
}
|
||||
const system: any = {};
|
||||
if(req.user?.isInstanceOperator(req.botApp)) {
|
||||
// @ts-ignore
|
||||
system.logs = filterLogBySubreddit(new Map([['app', systemLogs]]), [], {level, sort, limit, operator: true}).get('app');
|
||||
system.logs = filterLogBySubreddit(new Map([['app', systemLogs]]), [], {level, sort, limit, operator: true}).get('all');
|
||||
}
|
||||
const response = {
|
||||
bots: botResponses,
|
||||
@@ -59,7 +61,7 @@ const status = () => {
|
||||
return res.json(response);
|
||||
}
|
||||
|
||||
const botStatResponse = async (bot: Bot, req: Request, botLogMap: Map<string, Map<string, LogEntry[]>>) => {
|
||||
const botStatResponse = async (bot: Bot, req: Request, botLogMap: Map<string, Map<string, LogEntry[]>>, index: number) => {
|
||||
const {
|
||||
//subreddits = [],
|
||||
//user: userVal,
|
||||
@@ -77,7 +79,8 @@ const status = () => {
|
||||
user,
|
||||
// @ts-ignore
|
||||
sort,
|
||||
limit: Number.parseInt((limit as string))
|
||||
limit: Number.parseInt((limit as string)),
|
||||
returnType: 'object'
|
||||
});
|
||||
|
||||
const subManagerData = [];
|
||||
@@ -295,8 +298,8 @@ const status = () => {
|
||||
startedAt: bot.startedAt.local().format('MMMM D, YYYY h:mm A Z'),
|
||||
running: bot.running,
|
||||
error: bot.error,
|
||||
account: bot.botAccount as string,
|
||||
name: bot.botName as string,
|
||||
account: (bot.botAccount as string) ?? `Bot ${index}`,
|
||||
name: (bot.botName as string) ?? `Bot ${index}`,
|
||||
...opStats(bot),
|
||||
},
|
||||
subreddits: [allManagerData, ...subManagerData],
|
||||
|
||||
@@ -16,7 +16,7 @@ import {
|
||||
} from "../../util";
|
||||
import {getLogger} from "../../Utils/loggerFactory";
|
||||
import LoggedError from "../../Utils/LoggedError";
|
||||
import {Invokee, LogInfo, OperatorConfig} from "../../Common/interfaces";
|
||||
import {Invokee, LogInfo, OperatorConfigWithFileContext} from "../../Common/interfaces";
|
||||
import http from "http";
|
||||
import SimpleError from "../../Utils/SimpleError";
|
||||
import {heartbeat} from "./routes/authenticated/applicationRoutes";
|
||||
@@ -52,7 +52,7 @@ const botLogMap: Map<string, Map<string, LogEntry[]>> = new Map();
|
||||
|
||||
const botSubreddits: Map<string, string[]> = new Map();
|
||||
|
||||
const rcbServer = async function (options: OperatorConfig) {
|
||||
const rcbServer = async function (options: OperatorConfigWithFileContext) {
|
||||
|
||||
const {
|
||||
operator: {
|
||||
@@ -178,8 +178,10 @@ const rcbServer = async function (options: OperatorConfig) {
|
||||
bots = req.user.accessibleBots(req.botApp.bots);
|
||||
}
|
||||
const resp = [];
|
||||
let index = 1;
|
||||
for(const b of bots) {
|
||||
resp.push({name: b.botName, data: await opStats(b)});
|
||||
resp.push({name: b.botName ?? `Bot ${index}`, data: await opStats(b)});
|
||||
index++;
|
||||
}
|
||||
return res.json(resp);
|
||||
});
|
||||
@@ -202,7 +204,7 @@ const rcbServer = async function (options: OperatorConfig) {
|
||||
|
||||
server.getAsync('/check', ...actionRoute);
|
||||
|
||||
server.getAsync('/addBot', ...addBot());
|
||||
server.postAsync('/bot', ...addBot());
|
||||
|
||||
server.getAsync('/bot/invite', ...getInvitesRoute);
|
||||
|
||||
|
||||
@@ -9,19 +9,29 @@
|
||||
<div class="p-6 md:px-10 md:py-6">
|
||||
<div class="text-xl mb-4">Congrats! You did the thing.</div>
|
||||
<div class="space-y-3">
|
||||
<div>These are the credentials ContextMod will use to act as your bot, <b><%= userName %></b></div>
|
||||
<ul class="list-inside list-disc">
|
||||
<li>Access Token: <b><%= accessToken %></b></li>
|
||||
<li>Refresh Token: <b><%= refreshToken %></b></li>
|
||||
</ul>
|
||||
<% if(locals.addResult !== undefined) { %>
|
||||
<div>Result of trying to add bot automatically: <%= addResult %></div>
|
||||
<div>Note: You can revoke ContextMod's access to this account at any time by visiting the <a href="https://www.reddit.com/prefs/apps">reddit app preferences</a> while logged in as the account and clicking the <b>revoke access</b> link under ContextMod</div>
|
||||
</div>
|
||||
<div class="text-xl my-4">What Do I Do Now?</div>
|
||||
<div class="space-y-3">
|
||||
<% if(locals.stored === true) { %>
|
||||
<% if(locals.success === true) { %>
|
||||
<div>Credentials were successfully persisted to the application and the bot was automatically started! You may now <a href="/">login with your normal/moderator account</a> to view the web dashboard where your bot can be monitored.</div>
|
||||
<% } else { %>
|
||||
<div>The bot was successfully saved to the application but it could not be started automatically. Please inform the operator so they can restart the application.</div>
|
||||
<% } %>
|
||||
<% } else { %>
|
||||
<div>Bot was not automatically added to an instance and will need to manually appended to configuration...</div>
|
||||
<div>These credentials were <b>not automatically added</b> to an instance and will need to be <b>manually added by the operator</b>:</div>
|
||||
<ul class="list-inside list-disc">
|
||||
<li>If you are a <b>Moderator</b> then copy the above <b>Tokens</b> and pass them on to the Operator of this ContextMod instance.</li>
|
||||
<li>If you are an <b>Operator</b> copy these somewhere and then restart the application providing these as either arguments, environmental variables, or in a config as described in the <a
|
||||
href="https://github.com/FoxxMD/context-mod/blob/master/docs/operatorConfiguration.md#defining-configuration">configuration guide</a></li>
|
||||
</ul>
|
||||
<% } %>
|
||||
<div>If you are a <b>Moderator</b> then copy the above <b>Tokens</b> and pass them on to the Operator of this ContextMod instance.</div>
|
||||
<div>If you are an <b>Operator</b> copy these somewhere and then restart the application providing these as either arguments, environmental variables, or in a json config as described in the <a
|
||||
href="https://github.com/FoxxMD/context-mod/blob/master/docs/operatorConfiguration.md#defining-configuration">configuration guide</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -46,7 +46,43 @@
|
||||
class="text-black placeholder-gray-500 rounded mt-2 mb-3 p-2"
|
||||
placeholder="<%= locals.clientSecret !== undefined ? 'Use Provided Client Secret' : 'Client Secret Not Provided' %>">
|
||||
</div>
|
||||
<div class="text-lg text-semibold my-3">3. Select permissions</div>
|
||||
<div class="text-lg text-semibold my-3">3. Select Instance</div>
|
||||
<div class="my-2 ml-5">
|
||||
<div class="space-y-3">
|
||||
<div>Specify the ContextMod instance to add this bot to.</div>
|
||||
<select id="instanceSelect" style="max-width:400px;" class="form-select
|
||||
block
|
||||
w-full
|
||||
px-3
|
||||
py-1.5
|
||||
text-base
|
||||
font-normal
|
||||
text-gray-700
|
||||
bg-white bg-clip-padding bg-no-repeat
|
||||
border border-solid border-gray-300
|
||||
rounded
|
||||
transition
|
||||
ease-in-out
|
||||
m-0
|
||||
focus:text-gray-700 focus:bg-white focus:border-blue-600 focus:outline-none" aria-label="Default select example">
|
||||
<% instances.forEach(function (name, index){ %>
|
||||
<option selected="<%= index === 0 ? 'true' : 'false' %>" value="<%= name %>"><%= name %></option>
|
||||
<%= name %>
|
||||
<% }) %>
|
||||
</select>
|
||||
</div>
|
||||
</div>
|
||||
<div class="text-lg text-semibold my-3">4. Optionally, restrict to Subreddits</div>
|
||||
<div class="my-2 ml-5">
|
||||
<div class="space-y-3">
|
||||
<div>Specify which subreddits, out of all the subreddits the bot moderates, CM should run on.</div>
|
||||
<div>Subreddits should be seperated with a comma. Leave blank to run on all moderated subreddits</div>
|
||||
<input id="subreddits" style="max-width:800px; display: block;"
|
||||
class="text-black placeholder-gray-500 rounded mt-2 mb-3 p-2 w-full"
|
||||
placeholder="aSubreddit,aSecondSubreddit,aThirdSubreddit">
|
||||
</div>
|
||||
</div>
|
||||
<div class="text-lg text-semibold my-3">5. Select permissions</div>
|
||||
<div class="my-2 ml-5">
|
||||
<div class="space-y-3">
|
||||
<div>These are permissions to allow the bot account to perform these actions, <b>in
|
||||
@@ -220,6 +256,8 @@
|
||||
clientSecret: document.querySelector('#clientSecret').value,
|
||||
code: document.querySelector("#inviteCode").value === '' ? undefined : document.querySelector("#inviteCode").value,
|
||||
permissions,
|
||||
instance: document.querySelector('#instanceSelect').value,
|
||||
subreddits: document.querySelector('#subreddits').value
|
||||
})
|
||||
}).then((resp) => {
|
||||
if(!resp.ok) {
|
||||
|
||||
@@ -1,10 +1,19 @@
|
||||
<div class="space-x-4 py-1 md:px-10 leading-6 font-semibold bg-gray-700">
|
||||
<div class="container mx-auto">
|
||||
<% if(locals.bots !== undefined) { %>
|
||||
<ul id="botTabs" class="inline-flex flex-wrap">
|
||||
<% if(locals.system !== undefined && locals.system.logs !== undefined) {%>
|
||||
<li class="my-3 px-3">
|
||||
<span data-bot="system" class="rounded-md py-2 px-3 tabSelectWrapper">
|
||||
<a class="tabSelect instance font-normal pointer hover:font-bold" data-bot="system">
|
||||
System
|
||||
</a>
|
||||
</span>
|
||||
</li>
|
||||
<% } %>
|
||||
<% if(locals.bots !== undefined) { %>
|
||||
<% bots.forEach(function (data){ %>
|
||||
<li class="my-3 px-3">
|
||||
<span data-bot="<%= data.system.name %>" class="rounded-md py-2 px-3 tabSelectWrapper">
|
||||
<span data-bot="<%= data.system.name %>" class="rounded-md py-2 px-3 tabSelectWrapper real">
|
||||
<a class="tabSelect font-normal pointer hover:font-bold"
|
||||
data-bot="<%= data.system.name %>">
|
||||
<%= data.system.name %>
|
||||
@@ -24,7 +33,7 @@
|
||||
</span>
|
||||
</li>
|
||||
<% } %>
|
||||
</ul>
|
||||
<% } %>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -9,6 +9,19 @@
|
||||
<div class="grid">
|
||||
<div class="">
|
||||
<div class="pb-6 md:px-7">
|
||||
<% if(isOperator) { %>
|
||||
<div class="sub" data-bot="system" data-subreddit="All">
|
||||
<div class="grid grid-cols-1 lg:grid-cols-2 xl:grid-cols-3 2xl:grid-cols-3 gap-5">
|
||||
</div>
|
||||
<br/>
|
||||
<%- include('partials/loadingIcon') %>
|
||||
<div data-subreddit="All" class="logs font-mono text-sm">
|
||||
<% system.logs.forEach(function (logEntry){ %>
|
||||
<%- logEntry %>
|
||||
<% }) %>
|
||||
</div>
|
||||
</div>
|
||||
<% } %>
|
||||
<% bots.forEach(function (bot){ %>
|
||||
<% bot.subreddits.forEach(function (data){ %>
|
||||
<div class="sub <%= bot.system.running ? '' : 'offline' %>" data-subreddit="<%= data.name %>" data-bot="<%= bot.system.name %>">
|
||||
@@ -727,23 +740,31 @@
|
||||
const firstSub = document.querySelectorAll(`[data-bot="${bot}"].sub`)[0];
|
||||
firstSub.classList.add('active');
|
||||
|
||||
let firstSubWrapper;
|
||||
const firstSubTab = document.querySelector(`ul[data-bot="${bot}"] [data-subreddit="${firstSub.dataset.subreddit}"].tabSelect`);
|
||||
firstSubTab.classList.add('font-bold', 'no-underline', 'pointer-events-none');
|
||||
const firstSubWrapper = firstSubTab.closest('.tabSelectWrapper');
|
||||
//document.querySelector(`[data-subreddit="${subreddit}"][data-bot="${bot}"].sub`).classList.add('active');
|
||||
if(firstSubTab !== null) {
|
||||
firstSubTab.classList.add('font-bold', 'no-underline', 'pointer-events-none');
|
||||
firstSubWrapper = firstSubTab.closest('.tabSelectWrapper');
|
||||
//document.querySelector(`[data-subreddit="${subreddit}"][data-bot="${bot}"].sub`).classList.add('active');
|
||||
}
|
||||
|
||||
document.querySelectorAll('.tabSelectWrapper').forEach(el => {
|
||||
el.classList.remove('border-2');
|
||||
el.classList.add('border');
|
||||
})
|
||||
|
||||
firstSubWrapper.classList.remove('border');
|
||||
firstSubWrapper.classList.add('border-2');
|
||||
if(firstSubWrapper !== undefined) {
|
||||
firstSubWrapper.classList.remove('border');
|
||||
firstSubWrapper.classList.add('border-2');
|
||||
}
|
||||
|
||||
document.querySelectorAll('[data-bot].subreddit.nestedTabs').forEach(el => {
|
||||
el.classList.remove('active');
|
||||
})
|
||||
document.querySelector(`[data-bot="${bot}"].subreddit.nestedTabs`).classList.add('active');
|
||||
const nested = document.querySelector(`[data-bot="${bot}"].subreddit.nestedTabs`);
|
||||
if(nested !== null) {
|
||||
nested.classList.add('active');
|
||||
}
|
||||
|
||||
const wrapper = e.target.closest('.tabSelectWrapper');//document.querySelector(`[data-subreddit="${subreddit}"].tabSelectWrapper`);
|
||||
wrapper.classList.remove('border');
|
||||
@@ -752,7 +773,9 @@
|
||||
if ('URLSearchParams' in window) {
|
||||
var searchParams = new URLSearchParams(window.location.search)
|
||||
searchParams.set("bot", bot);
|
||||
searchParams.set("sub", firstSub.dataset.subreddit);
|
||||
if(firstSub.dataset.subreddit !== undefined) {
|
||||
searchParams.set("sub", firstSub.dataset.subreddit);
|
||||
}
|
||||
var newRelativePathQuery = window.location.pathname + '?' + searchParams.toString();
|
||||
history.pushState(null, '', newRelativePathQuery);
|
||||
}
|
||||
@@ -797,7 +820,10 @@
|
||||
let shownBot = searchParams.get('bot');
|
||||
if(shownBot === null) {
|
||||
// show the first bot listed if none is specified
|
||||
const firstBot = document.querySelector('.tabSelectWrapper[data-bot]');
|
||||
let firstBot = document.querySelector('.real.tabSelectWrapper[data-bot]');
|
||||
if(firstBot === null) {
|
||||
|
||||
}
|
||||
if(firstBot !== null) {
|
||||
shownBot = firstBot.dataset.bot;
|
||||
searchParams.set('bot', shownBot);
|
||||
@@ -807,17 +833,27 @@
|
||||
}
|
||||
|
||||
document.querySelector(`[data-bot="${shownBot}"].tabSelect`).classList.add('font-bold', 'no-underline', 'pointer-events-none');
|
||||
document.querySelector(`ul[data-bot="${shownBot}"] [data-subreddit="${shownSub}"].tabSelect`).classList.add('font-bold', 'no-underline', 'pointer-events-none');
|
||||
const tabSelect = document.querySelector(`ul[data-bot="${shownBot}"] [data-subreddit="${shownSub}"].tabSelect`);
|
||||
if(tabSelect !== null) {
|
||||
tabSelect.classList.add('font-bold', 'no-underline', 'pointer-events-none');
|
||||
}
|
||||
document.querySelectorAll('.tabSelectWrapper').forEach(el => el.classList.add('border'));
|
||||
document.querySelector(`[data-bot="${shownBot}"][data-subreddit="${shownSub}"].sub`).classList.add('active');
|
||||
const subWrapper = document.querySelector(`ul[data-bot="${shownBot}"] [data-subreddit="${shownSub}"].tabSelectWrapper`);
|
||||
subWrapper.classList.remove('border');
|
||||
subWrapper.classList.add('border-2');
|
||||
if(subWrapper !== null) {
|
||||
subWrapper.classList.remove('border');
|
||||
subWrapper.classList.add('border-2');
|
||||
}
|
||||
const wrapper = document.querySelector(`[data-bot="${shownBot}"].tabSelectWrapper`);
|
||||
wrapper.classList.remove('border');
|
||||
wrapper.classList.add('border-2');
|
||||
if(wrapper !== null) {
|
||||
wrapper.classList.remove('border');
|
||||
wrapper.classList.add('border-2');
|
||||
}
|
||||
|
||||
document.querySelector(`[data-bot="${shownBot}"].subreddit.nestedTabs`).classList.add('active');
|
||||
const nestedTabs = document.querySelector(`[data-bot="${shownBot}"].subreddit.nestedTabs`);
|
||||
if(nestedTabs !== null) {
|
||||
nestedTabs.classList.add('active');
|
||||
}
|
||||
|
||||
document.querySelectorAll('.stats.reloadStats').forEach(el => el.classList.add('hidden'));
|
||||
document.querySelectorAll('.allStatsToggle').forEach(el => el.classList.add('font-bold', 'no-underline', 'pointer-events-none'));
|
||||
@@ -825,19 +861,6 @@
|
||||
|
||||
<script src="https://cdn.socket.io/4.1.2/socket.io.min.js" integrity="sha384-toS6mmwu70G0fw54EGlWWeA4z3dyJ+dlXBtSURSKN4vyRFOcxd3Bzjj/AoOwY+Rg" crossorigin="anonymous"></script>
|
||||
<script>
|
||||
const SUBREDDIT_NAME_LOG_REGEX = /{(.+?)}/;
|
||||
const BOT_NAME_LOG_REGEX = /~(.+?)~/;
|
||||
const parseALogName = (reg) => {
|
||||
return (val) => {
|
||||
const matches = val.match(reg);
|
||||
if (matches === null) {
|
||||
return undefined;
|
||||
}
|
||||
return matches[1];
|
||||
}
|
||||
}
|
||||
const parseSubredditLogName = parseALogName(SUBREDDIT_NAME_LOG_REGEX);
|
||||
const parseBotLogName = parseALogName(BOT_NAME_LOG_REGEX);
|
||||
|
||||
let socket = io({
|
||||
reconnectionAttempts: 5, // bail after 5 attempts
|
||||
@@ -860,25 +883,29 @@
|
||||
socket.on("connect", () => {
|
||||
document.body.classList.add('connected')
|
||||
socket.on("log", data => {
|
||||
bufferedBot.set('All', bufferedBot.get('All').concat(data));
|
||||
|
||||
const bot = parseBotLogName(data);
|
||||
const {
|
||||
subreddit,
|
||||
bot,
|
||||
subredditMessage,
|
||||
allMessage,
|
||||
formattedMessage
|
||||
} = data;
|
||||
if(bot === undefined && subreddit === undefined) {
|
||||
const sys = bufferedBot.get('system');
|
||||
if(sys !== undefined) {
|
||||
sys.set('All', sys.get('All').concat(formattedMessage));
|
||||
bufferedBot.set('system', sys);
|
||||
}
|
||||
}
|
||||
if(bot !== undefined) {
|
||||
bufferedBot.set('All', bufferedBot.get('All').concat(allMessage));
|
||||
|
||||
const buffBot = bufferedBot.get(bot) || newBufferedLogs();
|
||||
buffBot.set('All', buffBot.get('All').concat(data));
|
||||
const sub = parseSubredditLogName(data);
|
||||
if (sub !== undefined) {
|
||||
buffBot.set(sub, (buffBot.get(sub) || []).concat(data));
|
||||
buffBot.set('All', buffBot.get('All').concat(allMessage));
|
||||
if (subreddit !== undefined) {
|
||||
buffBot.set(subreddit, (buffBot.get(subreddit) || []).concat(subredditMessage));
|
||||
}
|
||||
bufferedBot.set(bot, buffBot);
|
||||
} else {
|
||||
bufferedBot.forEach((logs, botName) => {
|
||||
if(botName === 'All') {
|
||||
return;
|
||||
}
|
||||
logs.set('All', logs.get('All').concat(data));
|
||||
bufferedBot.set(botName, logs);
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
15
src/index.ts
15
src/index.ts
@@ -64,7 +64,8 @@ const program = new Command();
|
||||
.allowUnknownOption();
|
||||
runCommand = addOptions(runCommand, getUniversalWebOptions());
|
||||
runCommand.action(async (interfaceVal, opts) => {
|
||||
const config = buildOperatorConfigWithDefaults(await parseOperatorConfigFromSources({...opts, mode: interfaceVal}));
|
||||
const [opConfig, fileConfig] = await parseOperatorConfigFromSources({...opts, mode: interfaceVal});
|
||||
const config = buildOperatorConfigWithDefaults(opConfig);
|
||||
const {
|
||||
mode,
|
||||
} = config;
|
||||
@@ -73,7 +74,7 @@ const program = new Command();
|
||||
await clientServer(config);
|
||||
}
|
||||
if(mode === 'all' || mode === 'server') {
|
||||
await apiServer(config);
|
||||
await apiServer({...config, fileConfig});
|
||||
}
|
||||
} catch (err: any) {
|
||||
throw err;
|
||||
@@ -92,9 +93,10 @@ const program = new Command();
|
||||
checkCommand
|
||||
.addOption(checks)
|
||||
.action(async (activityIdentifier, type, botVal, commandOptions = {}) => {
|
||||
const config = buildOperatorConfigWithDefaults(await parseOperatorConfigFromSources(commandOptions));
|
||||
const [opConfig, fileConfig] = await parseOperatorConfigFromSources(commandOptions);
|
||||
const config = buildOperatorConfigWithDefaults(opConfig);
|
||||
const {checks = []} = commandOptions;
|
||||
app = new App(config);
|
||||
app = new App({...config, fileConfig});
|
||||
|
||||
let a;
|
||||
const commentId = commentReg(activityIdentifier);
|
||||
@@ -168,7 +170,8 @@ const program = new Command();
|
||||
unmodCommand
|
||||
.addOption(checks)
|
||||
.action(async (subreddits = [], botVal, opts = {}) => {
|
||||
const config = buildOperatorConfigWithDefaults(await parseOperatorConfigFromSources(opts));
|
||||
const [opConfig, fileConfig] = await parseOperatorConfigFromSources(opts);
|
||||
const config = buildOperatorConfigWithDefaults(opConfig);
|
||||
const {checks = []} = opts;
|
||||
const logger = winston.loggers.get('app');
|
||||
let bots: Bot[] = [];
|
||||
@@ -201,7 +204,7 @@ const program = new Command();
|
||||
|
||||
} catch (err: any) {
|
||||
if (!err.logged && !(err instanceof LoggedError)) {
|
||||
const logger = winston.loggers.get('app');
|
||||
const logger = winston.loggers.has('app') ? winston.loggers.get('app') : winston.loggers.get('init');
|
||||
if(isScopeError(err)) {
|
||||
logger.error('Reddit responded with a 403 insufficient_scope which means the bot is lacking necessary OAUTH scopes to perform general actions.');
|
||||
}
|
||||
|
||||
229
src/util.ts
229
src/util.ts
@@ -1,7 +1,7 @@
|
||||
import winston, {Logger} from "winston";
|
||||
import jsonStringify from 'safe-stable-stringify';
|
||||
import dayjs, {Dayjs, OpUnitType} from 'dayjs';
|
||||
import {FormattedRuleResult, isRuleSetResult, RulePremise, RuleResult, RuleSetResult} from "./Rule";
|
||||
import {FormattedRuleResult, isRuleSetResult, RulePremise, RuleResult, RuleSetResult, UserNoteCriteria} from "./Rule";
|
||||
import deepEqual from "fast-deep-equal";
|
||||
import {Duration} from 'dayjs/plugin/duration.js';
|
||||
import Ajv from "ajv";
|
||||
@@ -15,7 +15,7 @@ import {
|
||||
ActivityWindowCriteria, ActivityWindowType,
|
||||
CacheOptions,
|
||||
CacheProvider,
|
||||
DurationComparison, DurationVal,
|
||||
DurationComparison, DurationVal, FilterCriteriaPropertyResult, FilterCriteriaResult,
|
||||
GenericComparison,
|
||||
HistoricalStats,
|
||||
HistoricalStatsDisplay, ImageComparisonResult,
|
||||
@@ -23,7 +23,7 @@ import {
|
||||
ImageDetection,
|
||||
//ImageDownloadOptions,
|
||||
LogInfo,
|
||||
NamedGroup,
|
||||
NamedGroup, OperatorJsonConfig,
|
||||
PollingOptionsStrong,
|
||||
RedditEntity,
|
||||
RedditEntityType,
|
||||
@@ -34,8 +34,7 @@ import {
|
||||
StrongSubredditState,
|
||||
SubredditState
|
||||
} from "./Common/interfaces";
|
||||
import JSON5 from "json5";
|
||||
import yaml, {JSON_SCHEMA} from "js-yaml";
|
||||
import { Document as YamlDocument } from 'yaml'
|
||||
import SimpleError from "./Utils/SimpleError";
|
||||
import InvalidRegexError from "./Utils/InvalidRegexError";
|
||||
import {constants, promises} from "fs";
|
||||
@@ -54,11 +53,17 @@ import ImageData from "./Common/ImageData";
|
||||
import {Sharp, SharpOptions} from "sharp";
|
||||
// @ts-ignore
|
||||
import {blockhashData, hammingDistance} from 'blockhash';
|
||||
import {SetRandomInterval} from "./Common/types";
|
||||
import {ConfigFormat, SetRandomInterval} from "./Common/types";
|
||||
import stringSimilarity from 'string-similarity';
|
||||
import calculateCosineSimilarity from "./Utils/StringMatching/CosineSimilarity";
|
||||
import levenSimilarity from "./Utils/StringMatching/levenSimilarity";
|
||||
import {isRequestError, isStatusError} from "./Utils/Errors";
|
||||
import {parse} from "path";
|
||||
import JsonConfigDocument from "./Common/Config/JsonConfigDocument";
|
||||
import YamlConfigDocument from "./Common/Config/YamlConfigDocument";
|
||||
import AbstractConfigDocument, {ConfigDocumentInterface} from "./Common/Config/AbstractConfigDocument";
|
||||
|
||||
|
||||
//import {ResembleSingleCallbackComparisonResult} from "resemblejs";
|
||||
|
||||
// want to guess how many concurrent image comparisons we should be doing
|
||||
@@ -289,13 +294,39 @@ export const mergeArr = (objValue: [], srcValue: []): (any[] | undefined) => {
|
||||
}
|
||||
}
|
||||
|
||||
export const removeFromSourceIfKeysExistsInDestination = (destinationArray: any[], sourceArray: any[], options: any): any[] => {
|
||||
// get all keys from objects in destination
|
||||
const destKeys = destinationArray.reduce((acc: string[], curr) => {
|
||||
// can only get keys for objects, skip for everything else
|
||||
if(curr !== null && typeof curr === 'object') {
|
||||
const keys = Object.keys(curr).map(x => x.toLowerCase());
|
||||
for(const k of keys) {
|
||||
if(!acc.includes(k)) {
|
||||
acc.push(k);
|
||||
}
|
||||
}
|
||||
}
|
||||
return acc;
|
||||
}, []);
|
||||
const sourceItemsToKeep = sourceArray.filter(x => {
|
||||
if(x !== null && typeof x === 'object') {
|
||||
const sourceKeys = Object.keys(x).map(x => x.toLowerCase());
|
||||
// only keep if keys from this object do not appear anywhere in destination items
|
||||
return intersect(sourceKeys, destKeys).length === 0;
|
||||
}
|
||||
// keep if item is not an object since we can't test for keys anyway
|
||||
return true;
|
||||
});
|
||||
return sourceItemsToKeep.concat(destinationArray);
|
||||
}
|
||||
|
||||
export const ruleNamesFromResults = (results: RuleResult[]) => {
|
||||
return results.map(x => x.name || x.premise.kind).join(' | ')
|
||||
}
|
||||
|
||||
export const triggeredIndicator = (val: boolean | null): string => {
|
||||
export const triggeredIndicator = (val: boolean | null, nullResultIndicator = '-'): string => {
|
||||
if(val === null) {
|
||||
return '-';
|
||||
return nullResultIndicator;
|
||||
}
|
||||
return val ? PASS : FAIL;
|
||||
}
|
||||
@@ -312,6 +343,40 @@ export const resultsSummary = (results: (RuleResult|RuleSetResult)[], topLevelCo
|
||||
//return results.map(x => x.name || x.premise.kind).join(' | ')
|
||||
}
|
||||
|
||||
export const filterCriteriaSummary = (val: FilterCriteriaResult<any>): [string, string[]] => {
|
||||
// summarize properties relevant to result
|
||||
const passedProps = {props: val.propertyResults.filter(x => x.passed === true), name: 'Passed'};
|
||||
const failedProps = {props: val.propertyResults.filter(x => x.passed === false), name: 'Failed'};
|
||||
const skippedProps = {props: val.propertyResults.filter(x => x.passed === null), name: 'Skipped'};
|
||||
const dnrProps = {props: val.propertyResults.filter(x => x.passed === undefined), name: 'DNR'};
|
||||
|
||||
const propSummary = [passedProps, failedProps];
|
||||
if (skippedProps.props.length > 0) {
|
||||
propSummary.push(skippedProps);
|
||||
}
|
||||
if (dnrProps.props.length > 0) {
|
||||
propSummary.push(dnrProps);
|
||||
}
|
||||
const propSummaryStrArr = propSummary.map(x => `${x.props.length} ${x.name}${x.props.length > 0 ? ` (${x.props.map(y => y.property as string)})` : ''}`);
|
||||
return [propSummaryStrArr.join(' | '), val.propertyResults.map(filterCriteriaPropertySummary)]
|
||||
}
|
||||
|
||||
export const filterCriteriaPropertySummary = (val: FilterCriteriaPropertyResult<any>): string => {
|
||||
let passResult: string;
|
||||
switch (val.passed) {
|
||||
case undefined:
|
||||
passResult = 'DNR'
|
||||
break;
|
||||
case null:
|
||||
case true:
|
||||
case false:
|
||||
passResult = triggeredIndicator(val.passed, 'Skipped');
|
||||
break;
|
||||
}
|
||||
const found = val.passed === null || val.passed === undefined ? '' : ` => Found: ${val.found}${val.reason !== undefined ? ` -- ${val.reason}` : ''}${val.behavior === 'exclude' ? ' (Exclude passes when Expected is not Found)' : ''}`;
|
||||
return `${val.property as string} => ${passResult} => Expected: ${val.expected}${found}`;
|
||||
}
|
||||
|
||||
export const createAjvFactory = (logger: Logger) => {
|
||||
return new Ajv({logger: logger, verbose: true, strict: "log", allowUnionTypes: true});
|
||||
}
|
||||
@@ -458,34 +523,64 @@ export const isActivityWindowCriteria = (val: any): val is ActivityWindowCriteri
|
||||
return false;
|
||||
}
|
||||
|
||||
export const parseFromJsonOrYamlToObject = (content: string): [object?, Error?, Error?] => {
|
||||
export interface ConfigToObjectOptions {
|
||||
location?: string,
|
||||
jsonDocFunc?: (content: string, location?: string) => AbstractConfigDocument<OperatorJsonConfig>,
|
||||
yamlDocFunc?: (content: string, location?: string) => AbstractConfigDocument<YamlDocument>
|
||||
}
|
||||
|
||||
export const parseFromJsonOrYamlToObject = (content: string, options?: ConfigToObjectOptions): [ConfigFormat, ConfigDocumentInterface<YamlDocument | object>?, Error?, Error?] => {
|
||||
let obj;
|
||||
let configFormat: ConfigFormat = 'yaml';
|
||||
let jsonErr,
|
||||
yamlErr;
|
||||
|
||||
const likelyType = likelyJson5(content) ? 'json' : 'yaml';
|
||||
|
||||
const {
|
||||
location,
|
||||
jsonDocFunc = (content: string, location?: string) => new JsonConfigDocument(content, location),
|
||||
yamlDocFunc = (content: string, location?: string) => new YamlConfigDocument(content, location),
|
||||
} = options || {};
|
||||
|
||||
try {
|
||||
obj = JSON5.parse(content);
|
||||
const oType = obj === null ? 'null' : typeof obj;
|
||||
const jsonObj = jsonDocFunc(content, location);
|
||||
const output = jsonObj.toJS();
|
||||
const oType = output === null ? 'null' : typeof output;
|
||||
if (oType !== 'object') {
|
||||
jsonErr = new SimpleError(`Parsing as json produced data of type '${oType}' (expected 'object')`);
|
||||
obj = undefined;
|
||||
} else {
|
||||
obj = jsonObj;
|
||||
configFormat = 'json';
|
||||
}
|
||||
} catch (err: any) {
|
||||
jsonErr = err;
|
||||
}
|
||||
if (obj === undefined) {
|
||||
try {
|
||||
obj = yaml.load(content, {schema: JSON_SCHEMA, json: true});
|
||||
const oType = obj === null ? 'null' : typeof obj;
|
||||
if (oType !== 'object') {
|
||||
yamlErr = new SimpleError(`Parsing as yaml produced data of type '${oType}' (expected 'object')`);
|
||||
obj = undefined;
|
||||
|
||||
try {
|
||||
const yamlObj = yamlDocFunc(content, location)
|
||||
const output = yamlObj.toJS();
|
||||
const oType = output === null ? 'null' : typeof output;
|
||||
if (oType !== 'object') {
|
||||
yamlErr = new SimpleError(`Parsing as yaml produced data of type '${oType}' (expected 'object')`);
|
||||
obj = undefined;
|
||||
} else if (obj === undefined && (likelyType !== 'json' || yamlObj.parsed.errors.length === 0)) {
|
||||
configFormat = 'yaml';
|
||||
if(yamlObj.parsed.errors.length !== 0) {
|
||||
yamlErr = new Error(yamlObj.parsed.errors.join('\n'))
|
||||
} else {
|
||||
obj = yamlObj;
|
||||
}
|
||||
} catch (err: any) {
|
||||
yamlErr = err;
|
||||
}
|
||||
} catch (err: any) {
|
||||
yamlErr = err;
|
||||
}
|
||||
return [obj, jsonErr, yamlErr];
|
||||
|
||||
if (obj === undefined) {
|
||||
configFormat = likelyType;
|
||||
}
|
||||
return [configFormat, obj, jsonErr, yamlErr];
|
||||
}
|
||||
|
||||
export const comparisonTextOp = (val1: number, strOp: string, val2: number): boolean => {
|
||||
@@ -887,7 +982,8 @@ export const isLogLineMinLevel = (log: string | LogInfo, minLevelText: string):
|
||||
|
||||
// https://regexr.com/3e6m0
|
||||
const HYPERLINK_REGEX: RegExp = /(http(s)?:\/\/.)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)/;
|
||||
export const formatLogLineToHtml = (log: string | LogInfo) => {
|
||||
const formattedTime = (short: string, full: string) => `<span class="has-tooltip"><span style="margin-top:35px" class='tooltip rounded shadow-lg p-1 bg-gray-100 text-black space-y-3 p-2 text-left'>${full}</span><span>${short}</span></span>`;
|
||||
export const formatLogLineToHtml = (log: string | LogInfo, timestamp?: string) => {
|
||||
const val = typeof log === 'string' ? log : log[MESSAGE];
|
||||
const logContent = Autolinker.link(val, {
|
||||
email: false,
|
||||
@@ -904,7 +1000,14 @@ export const formatLogLineToHtml = (log: string | LogInfo) => {
|
||||
.replace(/(\s*verbose\s*):/i, '<span class="error purple">$1</span>:')
|
||||
.replaceAll('\n', '<br />');
|
||||
//.replace(HYPERLINK_REGEX, '<a target="_blank" href="$&">$&</a>');
|
||||
return `<div class="logLine">${logContent}</div>`
|
||||
let line = `<div class="logLine">${logContent}</div>`
|
||||
|
||||
if(timestamp !== undefined) {
|
||||
line = line.replace(timestamp, (match) => {
|
||||
return formattedTime(dayjs(match).format('HH:mm:ss z'), match);
|
||||
});
|
||||
}
|
||||
return line;
|
||||
}
|
||||
|
||||
export type LogEntry = [number, LogInfo];
|
||||
@@ -915,10 +1018,11 @@ export interface LogOptions {
|
||||
operator?: boolean,
|
||||
user?: string,
|
||||
allLogsParser?: Function
|
||||
allLogName?: string
|
||||
allLogName?: string,
|
||||
returnType?: 'string' | 'object'
|
||||
}
|
||||
|
||||
export const filterLogBySubreddit = (logs: Map<string, LogEntry[]>, validLogCategories: string[] = [], options: LogOptions): Map<string, string[]> => {
|
||||
export const filterLogBySubreddit = (logs: Map<string, LogEntry[]>, validLogCategories: string[] = [], options: LogOptions): Map<string, (string|LogInfo)[]> => {
|
||||
const {
|
||||
limit,
|
||||
level,
|
||||
@@ -926,7 +1030,8 @@ export const filterLogBySubreddit = (logs: Map<string, LogEntry[]>, validLogCate
|
||||
operator = false,
|
||||
user,
|
||||
allLogsParser = parseSubredditLogInfoName,
|
||||
allLogName = 'app'
|
||||
allLogName = 'app',
|
||||
returnType = 'string',
|
||||
} = options;
|
||||
|
||||
// get map of valid logs categories
|
||||
@@ -960,13 +1065,18 @@ export const filterLogBySubreddit = (logs: Map<string, LogEntry[]>, validLogCate
|
||||
|
||||
const sortFunc = sort === 'ascending' ? (a: LogEntry, b: LogEntry) => a[0] - b[0] : (a: LogEntry, b: LogEntry) => b[0] - a[0];
|
||||
|
||||
const preparedMap: Map<string, string[]> = new Map();
|
||||
const preparedMap: Map<string, (string|LogInfo)[]> = new Map();
|
||||
// iterate each entry and
|
||||
// sort, filter by level, slice to limit, then map to html string
|
||||
for(const [k,v] of validSubMap.entries()) {
|
||||
let preparedEntries = v.filter(([time, l]) => isLogLineMinLevel(l, level));
|
||||
preparedEntries.sort(sortFunc);
|
||||
preparedMap.set(k, preparedEntries.slice(0, limit + 1).map(([time, l]) => formatLogLineToHtml(l)));
|
||||
const entriesSlice = preparedEntries.slice(0, limit + 1);
|
||||
if(returnType === 'string') {
|
||||
preparedMap.set(k, entriesSlice.map(([time, l]) => formatLogLineToHtml(l)));
|
||||
} else {
|
||||
preparedMap.set(k, entriesSlice.map(([time, l]) => l));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1130,19 +1240,25 @@ export const convertSubredditsRawToStrong = (x: (SubredditState | string), opts:
|
||||
return toStrongSubredditState(x, opts);
|
||||
}
|
||||
|
||||
export async function readConfigFile(path: string, opts: any) {
|
||||
export async function readConfigFile(path: string, opts: any): Promise<[string?, ConfigFormat?]> {
|
||||
const {log, throwOnNotFound = true} = opts;
|
||||
let extensionHint: ConfigFormat | undefined;
|
||||
const fileInfo = parse(path);
|
||||
if(fileInfo.ext !== undefined) {
|
||||
switch(fileInfo.ext) {
|
||||
case '.json':
|
||||
case '.json5':
|
||||
extensionHint = 'json';
|
||||
break;
|
||||
case '.yaml':
|
||||
extensionHint = 'yaml';
|
||||
break;
|
||||
}
|
||||
}
|
||||
try {
|
||||
await promises.access(path, constants.R_OK);
|
||||
const data = await promises.readFile(path);
|
||||
const [configObj, jsonErr, yamlErr] = parseFromJsonOrYamlToObject(data as unknown as string);
|
||||
if(configObj !== undefined) {
|
||||
return configObj as object;
|
||||
}
|
||||
log.error(`Could not parse file contents at ${path} as JSON or YAML:`);
|
||||
log.error(jsonErr);
|
||||
log.error(yamlErr);
|
||||
throw new SimpleError(`Could not parse file contents at ${path} as JSON or YAML`);
|
||||
return [(data as any).toString(), extensionHint]
|
||||
} catch (e: any) {
|
||||
const {code} = e;
|
||||
if (code === 'ENOENT') {
|
||||
@@ -1150,14 +1266,16 @@ export async function readConfigFile(path: string, opts: any) {
|
||||
if (log) {
|
||||
log.warn('No file found at given path', {filePath: path});
|
||||
}
|
||||
e.extension = extensionHint;
|
||||
throw e;
|
||||
} else {
|
||||
return;
|
||||
return [];
|
||||
}
|
||||
} else if (log) {
|
||||
log.warn(`Encountered error while parsing file`, {filePath: path});
|
||||
log.error(e);
|
||||
}
|
||||
e.extension = extensionHint;
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
@@ -1166,6 +1284,29 @@ export async function readConfigFile(path: string, opts: any) {
|
||||
// return (item && typeof item === 'object' && !Array.isArray(item));
|
||||
// }
|
||||
|
||||
export const fileOrDirectoryIsWriteable = async (location: string) => {
|
||||
const pathInfo = parse(location);
|
||||
try {
|
||||
await promises.access(location, constants.R_OK | constants.W_OK);
|
||||
return true;
|
||||
} catch (err: any) {
|
||||
const {code} = err;
|
||||
if (code === 'ENOENT') {
|
||||
// file doesn't exist, see if we can write to directory in which case we are good
|
||||
try {
|
||||
await promises.access(pathInfo.dir, constants.R_OK | constants.W_OK)
|
||||
// we can write to dir
|
||||
return true;
|
||||
} catch (accessError: any) {
|
||||
// also can't access directory :(
|
||||
throw new SimpleError(`No file exists at ${location} and application does not have permission to write to that directory`);
|
||||
}
|
||||
} else {
|
||||
throw new SimpleError(`File exists at ${location} but application does have permission to write to it.`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const overwriteMerge = (destinationArray: any[], sourceArray: any[], options: any): any[] => sourceArray;
|
||||
|
||||
export const removeUndefinedKeys = (obj: any) => {
|
||||
@@ -1282,6 +1423,18 @@ export const asSubmission = (value: any): value is Submission => {
|
||||
return isSubmission(value);
|
||||
}
|
||||
|
||||
export const isUserNoteCriteria = (value: any) => {
|
||||
return value !== null && typeof value === 'object' && value.type !== undefined;
|
||||
}
|
||||
|
||||
export const asUserNoteCriteria = (value: any): value is UserNoteCriteria => {
|
||||
return isUserNoteCriteria(value);
|
||||
}
|
||||
|
||||
export const userNoteCriteriaSummary = (val: UserNoteCriteria): string => {
|
||||
return `${val.count === undefined ? '>= 1' : val.count} of ${val.search === undefined ? 'current' : val.search} notes is ${val.type}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Serialized activities store subreddit and user properties as their string representations (instead of proxy)
|
||||
* */
|
||||
|
||||
Reference in New Issue
Block a user