2 |
22 |
--------------------------------------------------------------------------------
/docs/subreddit-configuration/in-depth/regex/matchSubsetHistoryActivity.yaml:
--------------------------------------------------------------------------------
1 | name: swear
2 | kind: regex
3 | criteria:
4 | # triggers if there are more than 5 regex matches in the last 10 activities (comments only)
5 | - regex: '/fuck|shit|damn/'
6 | # this differs from "activityMatchThreshold"
7 | #
8 | # activityMatchThreshold => # of activities from window must match regex
9 | # totalMatchThreshold => # of matches across all activities from window must match regex
10 | totalMatchThreshold: '> 5'
11 | # if `window` is specified it tells the rule to check the current activity as well as the activities returned from `window`
12 | # learn more about `window` here https://github.com/FoxxMD/context-mod/blob/master/docs/activitiesWindow.md
13 | window: 10
14 | # determines which activities from window to consider
15 | # defaults to "all" (submissions and comments)
16 | lookAt: comments
17 |
--------------------------------------------------------------------------------
/src/Web/assets/public/yaml/7792.entry.js.LICENSE.txt:
--------------------------------------------------------------------------------
1 | /*! *****************************************************************************
2 | Copyright (c) Microsoft Corporation. All rights reserved.
3 | Licensed under the Apache License, Version 2.0 (the "License"); you may not use
4 | this file except in compliance with the License. You may obtain a copy of the
5 | License at http://www.apache.org/licenses/LICENSE-2.0
6 |
7 | THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8 | KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
9 | WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
10 | MERCHANTABLITY OR NON-INFRINGEMENT.
11 |
12 | See the Apache Version 2.0 License for specific language governing permissions
13 | and limitations under the License.
14 | ***************************************************************************** */
15 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | title: ContextMod
2 | description: Documentation for ContextMod
3 | theme: just-the-docs
4 |
5 | source: docs
6 |
7 | url: https://contextmod.dev
8 |
9 | color_scheme: dark
10 |
11 | mermaid:
12 | version: "9.1.3"
13 |
14 | aux_links:
15 | Github: https://github.com/foxxmd/context-mod
16 |
17 | plugins:
18 | - jekyll-readme-index
19 | - jekyll-default-layout
20 | - jekyll-titles-from-headings
21 | - jekyll-optional-front-matter
22 | - jekyll-relative-links
23 |
24 | titles_from_headings:
25 | enabled: true
26 | strip_title: false
27 | collections: false
28 |
29 | readme_index:
30 | enabled: true
31 | remove_originals: true
32 | with_frontmatter: true
33 |
34 | optional_front_matter:
35 | remove_originals: true
36 |
37 | defaults:
38 | - scope:
39 | path: ""
40 | values:
41 | has_toc: false
42 | - scope:
43 | path: "images"
44 | values:
45 | image: true
46 |
--------------------------------------------------------------------------------
/src/Web/assets/views/partials/logSettings.ejs:
--------------------------------------------------------------------------------
1 |
3 |
21 |
4 |
20 |
5 | 
6 | <% if(locals.title !== undefined) { %>
7 | <%= title %>
8 | <% } %>
9 |
10 |
6 | <% if(locals.title !== undefined) { %>
7 | <%= title %>
8 | <% } %>
9 |
11 |
12 | Docs
13 |
14 |
15 |
16 |
17 | Logout
18 |
19 |
2 |
3 |
4 |
8 |
9 |
10 |
11 |
15 |
16 |
17 |
18 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/Common/Entities/FilterCriteria/ActivityStateFilterCriteriaResult.ts:
--------------------------------------------------------------------------------
1 | import {ChildEntity, ManyToOne} from "typeorm";
2 | import {FilterCriteriaResult} from "./FilterCriteriaResult";
3 | import {ActivityStateFilterCriteria} from "./ActivityStateFilterCriteria";
4 | import {TypedActivityState} from "../../Infrastructure/Filters/FilterCriteria";
5 | import {FilterCriteriaResult as IFilterCriteriaResult} from "../../Infrastructure/Filters/FilterShapes";
6 |
7 | @ChildEntity()
8 | export class ActivityStateFilterCriteriaResult extends FilterCriteriaResult
5 | <%- include('partials/title', {title: 'Error'}) %>
6 |
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/Common/Infrastructure/Database.ts:
--------------------------------------------------------------------------------
1 | import {LoggerOptions} from "typeorm/logger/LoggerOptions";
2 | import {SqljsConnectionOptions} from "typeorm/driver/sqljs/SqljsConnectionOptions";
3 | import {MysqlConnectionOptions} from "typeorm/driver/mysql/MysqlConnectionOptions";
4 | import {PostgresConnectionOptions} from "typeorm/driver/postgres/PostgresConnectionOptions";
5 | import {BetterSqlite3ConnectionOptions} from "typeorm/driver/better-sqlite3/BetterSqlite3ConnectionOptions";
6 |
7 | export type DatabaseDriverType = 'sqljs' | 'better-sqlite3' | 'mysql' | 'mariadb' | 'postgres';
8 | export type DatabaseConfig =
9 | SqljsConnectionOptions
10 | | MysqlConnectionOptions
11 | | PostgresConnectionOptions
12 | | BetterSqlite3ConnectionOptions;
13 | export type DatabaseDriverConfig = {
14 | type: DatabaseDriverType,
15 | [key: string]: any
16 | /**
17 | * Set the type of logging typeorm should output
18 | *
19 | * Defaults to errors, warnings, and schema (migration progress)
20 | * */
21 | logging?: LoggerOptions
22 | }
23 | export type DatabaseDriver = DatabaseDriverType | DatabaseDriverConfig;
24 |
--------------------------------------------------------------------------------
/src/SubredditConfigData.ts:
--------------------------------------------------------------------------------
1 | import {
2 | ActivityCheckConfigValue,
3 | } from "./Check";
4 | import {ManagerOptions} from "./Common/interfaces";
5 | import {RunConfigHydratedData, RunConfigValue, RunConfigObject} from "./Run";
6 |
7 | export interface SubredditConfigData extends ManagerOptions {
8 | /**
9 | * A list of all the checks that should be run for a subreddit.
10 | *
11 | * Checks are split into two lists -- submission or comment -- based on kind and run independently.
12 | *
13 | * Checks in each list are run in the order found in the configuration.
14 | *
15 | * When a check "passes", and actions are performed, then all subsequent checks are skipped.
16 | * @minItems 1
17 | * */
18 | checks?: ActivityCheckConfigValue[]
19 |
20 | /**
21 | * A list of sets of Checks to run
22 | * @minItems 1
23 | * */
24 | runs?: RunConfigValue[]
25 | }
26 |
27 | export interface SubredditConfigHydratedData extends Omit
7 |
22 | <%- include('partials/footer') %>
23 |
8 |
21 |
9 |
20 |
10 |
19 | Oops 😬
11 |
12 |
18 | Something went wrong while processing that last request:
13 | <%- error %>
14 | <% if(locals.operatorDisplay !== undefined && locals.operatorDisplay !== 'Anonymous') { %>
15 | Operated By: <%= operatorDisplay %>
16 | <% } %>
17 |
2 |
6 |
7 |
33 |
--------------------------------------------------------------------------------
/src/Common/Entities/RunnableAssociation/RunnableToResultEntity.ts:
--------------------------------------------------------------------------------
1 | import {
2 | Entity,
3 | Column,
4 | PrimaryGeneratedColumn,
5 | ManyToOne,
6 | OneToOne,
7 | CreateDateColumn,
8 | JoinColumn,
9 | OneToMany, TableInheritance, AfterLoad
10 | } from "typeorm";
11 | import {CheckResultEntity} from "../CheckResultEntity";
12 | import {TimeAwareRandomBaseEntity} from "../Base/TimeAwareRandomBaseEntity";
13 | import {RuleResultEntity} from "../RuleResultEntity";
14 | import {RuleSetResultEntity} from "../RuleSetResultEntity";
15 | import {RunResultEntity} from "../RunResultEntity";
16 |
17 | export interface RunnableToRuleResultEntityOptions
3 | ContextMod <%= locals.applicationIdentifier%> created by /u/FoxxMD
4 |
5 |
5 | <%- include('partials/header') %>
6 |
24 |
40 |
41 |
42 |
--------------------------------------------------------------------------------
/app.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Reddit Context Bot",
3 | "description": "An event-based, reddit moderation bot built on top of snoowrap and written in typescript",
4 | "repository": "https://github.com/FoxxMD/context-mod",
5 | "stack": "container",
6 | "env": {
7 | "CLIENT_ID": {
8 | "description": "Client ID for your Reddit application",
9 | "value": "",
10 | "required": true
11 | },
12 | "CLIENT_SECRET": {
13 | "description": "Client Secret for your Reddit application",
14 | "value": "",
15 | "required": true
16 | },
17 | "REFRESH_TOKEN": {
18 | "description": "Refresh token retrieved from authenticating an account with your Reddit Application",
19 | "value": "",
20 | "required": false
21 | },
22 | "ACCESS_TOKEN": {
23 | "description": "Access token retrieved from authenticating an account with your Reddit Application",
24 | "value": "",
25 | "required": false
26 | },
27 | "REDIRECT_URI": {
28 | "description": "Redirect URI you specified when creating your Reddit Application. Required if you want to use the web interface. In the provided example replace 'your-heroku-app-name' with the name of your HEROKU app.",
29 | "value": "https://your-heroku-6app-name.herokuapp.com/callback",
30 | "required": false
31 | },
32 | "OPERATOR": {
33 | "description": "Your reddit username WITHOUT any prefixes EXAMPLE /u/FoxxMD => FoxxMD. Specified user will be recognized as an admin.",
34 | "value": "",
35 | "required": false
36 | },
37 | "WIKI_CONFIG": {
38 | "description": "Relative url to contextbot wiki page EX https://reddit.com/r/subreddit/wiki/
7 |
22 | <%- include('partials/footer') %>
23 |
8 |
21 |
9 |
20 |
10 |
19 | Oops 😬
11 |
12 |
18 | Something went wrong while processing that last request:
13 | <%- error %>
14 | <% if(locals.operatorDisplay !== undefined && locals.operatorDisplay !== 'Anonymous') { %>
15 | Operated By: <%= operatorDisplay %>
16 | <% } %>
17 |
5 | <%- include('partials/title', {title: ''}) %>
6 |
30 |
31 |
32 |
--------------------------------------------------------------------------------
/docs/subreddit-configuration/in-depth/userNotes/usernoteFilter.json5:
--------------------------------------------------------------------------------
1 | {
2 | "runs": [
3 | {
4 | "checks": [
5 | {
6 | "name": "Self Promo Activities",
7 | "description": "Tag SP only if user does not have good contributor user note",
8 | // check will run on a new submission in your subreddit and look at the Author of that submission
9 | "kind": "submission",
10 | "rules": [
11 | {
12 | "name": "attr10all",
13 | "kind": "attribution",
14 | "author": {
15 | "exclude": [
16 | {
17 | // the key of the usernote type to look for https://github.com/toolbox-team/reddit-moderator-toolbox/wiki/Subreddit-Wikis%3A-usernotes#working-with-note-types
18 | // rule will not run if current usernote on Author is of type 'gooduser'
19 | "type": "gooduser"
20 | }
21 | ]
22 | },
23 | "criteria": [
24 | {
25 | "threshold": "> 10%",
26 | "window": "90 days"
27 | },
28 | {
29 | "threshold": "> 10%",
30 | "window": 100
31 | }
32 | ],
33 | }
34 | ],
35 | "actions": [
36 | {
37 | "kind": "usernote",
38 | // the key of usernote type
39 | // https://github.com/toolbox-team/reddit-moderator-toolbox/wiki/Subreddit-Wikis%3A-usernotes#working-with-note-types
40 | "type": "spamwarn",
41 | // content is mustache templated as usual
42 | "content": "Self Promotion: {{rules.attr10all.titlesDelim}} {{rules.attr10sub.largestPercent}}%"
43 | }
44 | ]
45 | }
46 | ]
47 | }
48 | ]
49 | }
50 |
--------------------------------------------------------------------------------
/docs/subreddit-configuration/in-depth/author/ignoreVettedUser.yaml:
--------------------------------------------------------------------------------
1 | runs:
2 | - checks:
3 | - name: non-vetted karma/meme activity
4 | description: >-
5 | Report if Author has SP and has recent karma/meme sub activity and isn't
6 | vetted
7 | # check will run on a new submission in your subreddit and look at the Author of that submission
8 | kind: submission
9 | rules:
10 | # The Author Rule is best used in conjunction with other Rules --
11 | # instead of having to write an AuthorFilter for every Rule where you want to skip it based on Author criteria
12 | # you can write one Author Rule and make it fail on the required criteria
13 | # so that the check fails and Actions don't run
14 | - name: nonvet
15 | kind: author
16 | exclude:
17 | - flairText:
18 | - vet
19 | - name: attr10
20 | kind: attribution
21 | criteria:
22 | - threshold: '> 10%'
23 | window: 90 days
24 | - threshold: '> 10%'
25 | window: 100
26 | - name: freekarma
27 | kind: recentActivity
28 | lookAt: submissions
29 | thresholds:
30 | - threshold: '>= 1'
31 | subreddits:
32 | - DeFreeKarma
33 | - FreeKarma4U
34 | window: 7 days
35 | - name: memes
36 | kind: recentActivity
37 | lookAt: submissions
38 | thresholds:
39 | - threshold: '>= 3'
40 | subreddits:
41 | - dankmemes
42 | window: 7 days
43 | # will NOT run if the Author for this Submission has the flair "vet"
44 | actions:
45 | - kind: report
46 | content: Author has posted in free karma or meme subs recently
47 |
--------------------------------------------------------------------------------
/src/Web/assets/public/yaml/3315.entry.js:
--------------------------------------------------------------------------------
1 | "use strict";(self.webpackChunkdemo=self.webpackChunkdemo||[]).push([[3315],{3315:(e,o,n)=>{n.r(o),n.d(o,{conf:()=>t,language:()=>s});var t={comments:{lineComment:"//",blockComment:["(*","*)"]},brackets:[["{","}"],["[","]"],["(",")"],["<",">"]],autoClosingPairs:[{open:"{",close:"}"},{open:"[",close:"]"},{open:"(",close:")"},{open:"<",close:">"},{open:"'",close:"'"}],surroundingPairs:[{open:"{",close:"}"},{open:"[",close:"]"},{open:"(",close:")"},{open:"<",close:">"},{open:"'",close:"'"}]},s={defaultToken:"",tokenPostfix:".pascaligo",ignoreCase:!0,brackets:[{open:"{",close:"}",token:"delimiter.curly"},{open:"[",close:"]",token:"delimiter.square"},{open:"(",close:")",token:"delimiter.parenthesis"},{open:"<",close:">",token:"delimiter.angle"}],keywords:["begin","block","case","const","else","end","fail","for","from","function","if","is","nil","of","remove","return","skip","then","type","var","while","with","option","None","transaction"],typeKeywords:["bool","int","list","map","nat","record","string","unit","address","map","mtz","xtz"],operators:["=",">","<","<=",">=","<>",":",":=","and","mod","or","+","-","*","/","@","&","^","%"],symbols:/[=><:@\^&|+\-*\/\^%]+/,tokenizer:{root:[[/[a-zA-Z_][\w]*/,{cases:{"@keywords":{token:"keyword.$0"},"@default":"identifier"}}],{include:"@whitespace"},[/[{}()\[\]]/,"@brackets"],[/[<>](?!@symbols)/,"@brackets"],[/@symbols/,{cases:{"@operators":"delimiter","@default":""}}],[/\d*\.\d+([eE][\-+]?\d+)?/,"number.float"],[/\$[0-9a-fA-F]{1,16}/,"number.hex"],[/\d+/,"number"],[/[;,.]/,"delimiter"],[/'([^'\\]|\\.)*$/,"string.invalid"],[/'/,"string","@string"],[/'[^\\']'/,"string"],[/'/,"string.invalid"],[/\#\d+/,"string"]],comment:[[/[^\(\*]+/,"comment"],[/\*\)/,"comment","@pop"],[/\(\*/,"comment"]],string:[[/[^\\']+/,"string"],[/\\./,"string.escape.invalid"],[/'/,{token:"string.quote",bracket:"@close",next:"@pop"}]],whitespace:[[/[ \t\r\n]+/,"white"],[/\(\*/,"comment","@comment"],[/\/\/.*$/,"comment"]]}}}}]);
--------------------------------------------------------------------------------
/docs/subreddit-configuration/cookbook/youtubeCommentRepost.yaml:
--------------------------------------------------------------------------------
1 | #polling:
2 | # - newComm
3 | #runs:
4 | # - checks:
5 | #### Uncomment the code above to use this as a FULL subreddit config
6 | ####
7 | #### Otherwise copy-paste the code below to use as a CHECK
8 | #
9 | # If submission type is a youtube video CM will check top comments on the video and remove comment if it at least 85% the same
10 | # optionally, bans user if they have more than one modnote for comment reposts
11 | #
12 | - name: commRepostYT
13 | description: Check if comment has been reposted from youtube
14 | kind: comment
15 | itemIs:
16 | - removed: false
17 | approved: false
18 | op: false
19 | condition: AND
20 | rules:
21 | - name: commRepost
22 | kind: repost
23 | criteria:
24 | - searchOn:
25 | - external
26 | actions:
27 | - kind: remove
28 | spam: true
29 | note: 'reposted comment from youtube with {{rules.commrepostyt.closestSameness}}% sameness'
30 |
31 | - kind: ban
32 | authorIs:
33 | # if the author has more than one spamwatch usernote then just ban em
34 | include:
35 | - modActions:
36 | - noteType: SPAM_WATCH
37 | note: "/comment repost.*/i"
38 | search: total
39 | count: "> 1"
40 | message: You have been banned for repeated spammy behavior including reposting youtube comments
41 | note: yt comment repost + spammy behavior
42 | reason: yt comment repost + spammy behavior
43 |
44 | - name: commRepostYTModNote
45 | kind: modnote
46 | content: 'YT comment repost with {{rules.commrepostyt.closestSameness}}% sameness'
47 | type: SPAM_WATCH
48 |
--------------------------------------------------------------------------------
/src/Web/assets/views/partials/subredditsTab.ejs:
--------------------------------------------------------------------------------
1 |
7 |
28 | <%- include('partials/footer') %>
29 |
8 |
27 |
9 |
26 |
10 |
25 | Sorry!
11 |
12 |
24 | Your account was successfully logged in but you cannot access this ContextMod client or route for one of these reasons:
13 | -
14 |
- You are not a moderator of any of the subreddits this client has access to 15 |
- You are not a moderator of any of the subreddits of the specific instance/bot you are trying to access 16 |
- The instance(s) running the subreddits you are a moderator of are offline 17 |
- The bot(s) running the subreddits you are a moderator of are not configured correctly IE the subreddits they moderate could not be retrieved 18 |
Note: You must Logout in order for the instance to detect changes in your subreddits/moderator status
20 | <% if(locals.operatorDisplay !== undefined && locals.operatorDisplay !== 'Anonymous') { %>
21 | Operated By: <%= operatorDisplay %>
22 | <% } %>
23 |
2 |
33 |
--------------------------------------------------------------------------------
/src/Common/Infrastructure/Runnable.ts:
--------------------------------------------------------------------------------
1 | import {MinimalOrFullFilter, MinimalOrFullFilterJson} from "./Filters/FilterShapes";
2 | import {AuthorCriteria, TypedActivityState} from "./Filters/FilterCriteria";
3 | import {Logger} from "winston";
4 | import {SubredditResources} from "../../Subreddit/SubredditResources";
5 |
6 | export interface RunnableBaseOptions extends Omit
3 | <% if(locals.bots !== undefined) { %>
4 | <% bots.forEach(function (botData){ %>
5 |
32 | -
6 | <% botData.subreddits.forEach(function (data){ %>
7 |
- 8 | 9 | 11 | <%= data.name === 'All' ? 'All Subreddits' : data.name %> 12 | 13 | <% if ((data.name === 'All' && isOperator) || data.name !== 'All') { %> 14 | 15 | <% } %> 16 | 17 | 18 | <% }) %> 19 | <% if(locals.isOperator === true && locals.instanceId !== undefined) { %> 20 |
- 21 | 22 | 23 | Manage Subreddits Invites + 24 | 25 | 26 | 27 | <% } %> 28 |