├── .vscode ├── settings.json └── launch.json ├── .idea ├── .gitignore ├── Intellivoid.SpamProtection-go.iml └── modules.xml ├── .gitignore ├── go.mod ├── spamProtection ├── spamProtection.go ├── constants.go ├── helpers.go ├── types.go └── getMethods.go ├── FLAGS.md ├── tests ├── byId_test.go ├── byUname_test.go └── package_test.go ├── samples └── sample01.go ├── README.md └── LICENSE /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "git.ignoreLimitWarning": true 3 | } -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | # Datasource local storage ignored files 5 | /dataSources/ 6 | /dataSources.local.xml 7 | # Editor-based HTTP Client requests 8 | /httpRequests/ 9 | -------------------------------------------------------------------------------- /.idea/Intellivoid.SpamProtection-go.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | // Use IntelliSense to learn about possible attributes. 3 | // Hover to view descriptions of existing attributes. 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 5 | "version": "0.2.0", 6 | "configurations": [ 7 | { 8 | "name": "Launch Package", 9 | "type": "go", 10 | "request": "launch", 11 | "mode": "auto", 12 | "program": "${workspaceFolder}/main.go" 13 | } 14 | ] 15 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 2 | # Copyright (c) 2021 Sayan Biswas, ALiwoto. 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, version 3. 7 | # 8 | # This program is distributed in the hope that it will be useful, but 9 | # WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | # General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with this program. If not, see . 15 | 16 | /labs 17 | /netkas -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | // 2 | // This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | // Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | // 5 | // This program is free software: you can redistribute it and/or modify 6 | // it under the terms of the GNU General Public License as published by 7 | // the Free Software Foundation, version 3. 8 | // 9 | // This program is distributed in the hope that it will be useful, but 10 | // WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | // General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU General Public License 15 | // along with this program. If not, see . 16 | // 17 | 18 | module github.com/Intellivoid/Intellivoid.SpamProtection-go 19 | 20 | go 1.15 21 | -------------------------------------------------------------------------------- /spamProtection/spamProtection.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | // spamProtection package is a rich tool to lookup 19 | // a user, chat, channel or bot in the SpamProtection database. 20 | package spamProtection 21 | -------------------------------------------------------------------------------- /FLAGS.md: -------------------------------------------------------------------------------- 1 | 18 | 19 | # Blacklist flags 20 | 21 | ### Here you can see all blacklist flags in the API: 22 | 23 | * `0x0` : None or an Undefined reason 24 | * `0xSP` : Special reason, you can consult @IntellivoidSupport for solution 25 | * `0xSPAM` : Spam or Unwanted promotion 26 | * `0xEVADE` : Ban Evade using alt accounts 27 | * `0xCACP` : Child pornography or Child abuse 28 | * `0xIMPER` : Malicious Impersonation 29 | * `0xPIRACY` : Promote or spam of pirated content 30 | * `0xNSFW` : Promote or spam of NSFW content 31 | * `0xPRIVATE` : Unsolicited Spam or Promote 32 | * `0xRAID` : Raid initializer or Participator 33 | * `0xSCAM` : Scamming 34 | * `0xMASSADD` : Mass adding users to group or channels 35 | * `0xNAMESPAM` : Promotion or spam via name or bio 36 | 37 |
38 | 39 | ### Helpful links 40 | 41 | - [SpamProtection Support chat](https://t.me/SpamProtectionSupport) 42 | - [Intellivoid Support account](https://t.me/IntellivoidSupport) -------------------------------------------------------------------------------- /tests/byId_test.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | package main 19 | 20 | import ( 21 | "log" 22 | "testing" 23 | 24 | "github.com/Intellivoid/Intellivoid.SpamProtection-go/spamProtection" 25 | ) 26 | 27 | func TestById(t *testing.T) { 28 | info1, err := spamProtection.GetInfoByID(1181941155) 29 | if err != nil { 30 | log.Fatal(err.Error()) 31 | } 32 | 33 | if info1.Success != true { 34 | t.Errorf("[Intellivoid.SpamProtection-go (MakeRequestbyID)] Failed request, response code: %d", info1.ResponseCode) 35 | } 36 | 37 | if info1.IsBlacklisted() { 38 | log.Println("warning, this " + 39 | info1.GetType() + " is blacklisted!") 40 | } 41 | 42 | str := "Showing results for this " + info1.GetType() 43 | str += "\nHas Child abuse flag: " + info1.HasFlagChildAbuseStr() 44 | str += "\nHas Evade flag: " + info1.HasFlagEvadeStr() 45 | str += "\nHas Child Imporsonation flag: " + info1.HasFlagImperStr() 46 | str += "\nIs a mass adder: " + info1.HasFlagMassAddStr() 47 | str += "\nIs scam: " + info1.HasFlagScamStr() 48 | str += "\nIs spammer: " + info1.HasFlagSpamStr() 49 | str += "\nIs blacklisted for special reason: " + info1.HasFlagSpecialStr() 50 | str += "\nBlacklist flag: " + info1.GetBlacklistFlag() 51 | log.Println(str) 52 | } 53 | -------------------------------------------------------------------------------- /tests/byUname_test.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | package main 19 | 20 | import ( 21 | "log" 22 | "testing" 23 | 24 | "github.com/Intellivoid/Intellivoid.SpamProtection-go/spamProtection" 25 | ) 26 | 27 | func TestByUname1(t *testing.T) { 28 | info1, err := spamProtection.GetInfoByUsername("Falling_inside_the_black") 29 | if err != nil { 30 | log.Fatal(err.Error()) 31 | } 32 | 33 | if info1.Success != true { 34 | t.Errorf("[Intellivoid.SpamProtection-go (MakeRequestbyUsername)] Failed request, response code: %d", info1.ResponseCode) 35 | } 36 | } 37 | 38 | func TestByUname2(t *testing.T) { 39 | info1, err := spamProtection.GetInfoByUsername("I don't know what blah blag /NightShadowsHangout") 40 | if err != nil { 41 | log.Fatal(err.Error()) 42 | } 43 | 44 | if info1.Success != true { 45 | t.Errorf("[Intellivoid.SpamProtection-go (MakeRequestbyUsername)] Failed request, response code: %d", info1.ResponseCode) 46 | } 47 | } 48 | 49 | func TestByUname3(t *testing.T) { 50 | info1, err := spamProtection.GetInfoByUsername("facebook.me/NightShadowsHangout") 51 | if err != nil { 52 | log.Fatal(err.Error()) 53 | } 54 | 55 | if info1.Success != true { 56 | t.Errorf("[Intellivoid.SpamProtection-go (MakeRequestbyUsername)] Failed request, response code: %d", info1.ResponseCode) 57 | } 58 | } 59 | 60 | func TestByUname4(t *testing.T) { 61 | info1, err := spamProtection.GetInfoByUsername("facebook.me/NightShadowsHangout") 62 | if err != nil { 63 | log.Fatal(err.Error()) 64 | } 65 | 66 | if info1.Success != true { 67 | t.Errorf("[Intellivoid.SpamProtection-go (MakeRequestbyUsername)] Failed request, response code: %d", info1.ResponseCode) 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /tests/package_test.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | package main 19 | 20 | import ( 21 | "log" 22 | "testing" 23 | 24 | "github.com/Intellivoid/Intellivoid.SpamProtection-go/spamProtection" 25 | ) 26 | 27 | func TestFix(t *testing.T) { 28 | str := spamProtection.FixUsername("https://t.me/NightShadowsHangout") 29 | log.Println(str) 30 | 31 | str = spamProtection.FixUsername("http://t.me/NightShadowsHangout") 32 | log.Println(str) 33 | 34 | str = spamProtection.FixUsername("t.me/NightShadowsHangout") 35 | log.Println(str) 36 | 37 | str = spamProtection.FixUsername("bullshit.me/NightShadowsHangout") 38 | log.Println(str) 39 | 40 | str = spamProtection.FixUsername("twitter.me/NightShadowsHangout") 41 | log.Println(str) 42 | 43 | str = spamProtection.FixUsername("whatsapp.me/NightShadowsHangout") 44 | log.Println(str) 45 | 46 | str = spamProtection.FixUsername("whatsapp.me/NightShadowsHangout") 47 | log.Println(str) 48 | 49 | str = spamProtection.FixUsername("facebook.me/NightShadowsHangout") 50 | log.Println(str) 51 | 52 | str = spamProtection.FixUsername("I don't know what blah blag /NightShadowsHangout") 53 | log.Println(str) 54 | 55 | str = spamProtection.FixUsername("everything is supported/NightShadowsHangout") 56 | log.Println(str) 57 | 58 | str = spamProtection.FixUsername("Intellivoid.net/NightShadowsHangout") 59 | log.Println(str) 60 | 61 | str = spamProtection.FixUsername(" @ NightShadowsHangout ") 62 | log.Println(str) 63 | 64 | str = spamProtection.FixUsername("@NightShadowsHangout") 65 | log.Println(str) 66 | 67 | str = spamProtection.FixUsername("http://telesco.pe/NightShadowsHangout") 68 | log.Println(str) 69 | 70 | str = spamProtection.FixUsername("http://unknown_host/g/215600") 71 | log.Println(str) 72 | } 73 | -------------------------------------------------------------------------------- /spamProtection/constants.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | package spamProtection 19 | 20 | // the endpoint used to get responses from Intellivoid servers. 21 | // for more information please read our documents: 22 | // https://docs.intellivoid.net/spamprotection/v1/lookup 23 | const ( 24 | endPoint = "https://api.intellivoid.net/spamprotection/v1/lookup?query=%" 25 | endPointI = endPoint + "d" 26 | endPointS = endPoint + "s" 27 | ) 28 | 29 | // telegram limitations constants 30 | const ( 31 | baseIndex = 0x0 32 | minUsername = 4 33 | maxUsername = 32 34 | empty = "" 35 | ) 36 | 37 | // Intellivoid Spam protection flags 38 | const ( 39 | // None or an Undefined reason 40 | NoneFlag = "0x0" 41 | 42 | // Special reason, like consulting operators 43 | SpecialFlag = "0xSP" 44 | 45 | // Spam or Unwanted promotion 46 | SpamFlag = "0xSPAM" 47 | 48 | // Ban Evade using alt accounts 49 | EvadeFlag = "0xEVADE" 50 | 51 | // Child pornography or Child abuse 52 | ChildAbuseFlag = "0xCACP" 53 | 54 | // Malicious Impersonation 55 | ImperFlag = "0xIMPER" 56 | 57 | // Promote or spam of pirated content 58 | PiracyFlag = "0xPIRACY" 59 | 60 | // Promote or spam of NSFW content 61 | NSFWFlag = "0xNSFW" 62 | 63 | // Unsolicited Spam or Promote 64 | PrivateFlag = "0xPRIVATE" 65 | 66 | // Raid initializer or Participator 67 | RaidFlag = "0xRAID" 68 | 69 | // Scamming 70 | ScamFlag = "0xSCAM" 71 | 72 | // Mass adding users to group or channels 73 | MassAddFlag = "0xMASSADD" 74 | 75 | // Promotion or spam via name or bio 76 | NameSpamFlag = "0xNAMESPAM" 77 | ) 78 | 79 | // The entity type constants, 80 | // can be user, bot, group, supergroup or channel 81 | const ( 82 | UserType = "user" 83 | BotType = "bot" 84 | GroupType = "group" 85 | SupergroupType = "supergroup" 86 | ChannelType = "channel" 87 | ) 88 | 89 | // another string constants 90 | const ( 91 | yesStr = "Yes" 92 | noStr = "No" 93 | ) 94 | 95 | // prefixes used in fixing a username 96 | const ( 97 | atSign = "@" 98 | slash = "/" 99 | ) 100 | 101 | const ( 102 | underlineChar = '_' // _ 103 | letterA = 'a' // a 104 | letterZ = 'z' // z 105 | capLetterA = 'A' // A 106 | capLetterZ = 'Z' // Z 107 | letterZero = '0' // 0 108 | letterNine = '9' // 9 109 | ) 110 | -------------------------------------------------------------------------------- /samples/sample01.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | package samples 18 | 19 | import ( 20 | "log" 21 | 22 | "github.com/Intellivoid/Intellivoid.SpamProtection-go/spamProtection" 23 | ) 24 | 25 | func UsernameSample01() { 26 | info, err := spamProtection.GetInfoByUsername("@Falling_inside_the_black") 27 | if err != nil { 28 | log.Fatal(err) 29 | } 30 | 31 | if info.Success { 32 | log.Println("succeeded to get information of use from " + 33 | "intellivoid's databases") 34 | } 35 | 36 | if info.IsBlacklisted() { 37 | log.Println("target is blacklisted") 38 | f := info.GetBlacklistFlag() 39 | log.Println("with flag: " + f) 40 | } 41 | 42 | if info.IsVerified() { 43 | log.Println("target is verified by Intellivoid") 44 | } 45 | 46 | if info.HasFlag(spamProtection.NSFWFlag, spamProtection.ChildAbuseFlag) { 47 | log.Println("Oh no, the target has either NSFW flag or child abuse") 48 | } 49 | 50 | if info.HasFlagEvade() { 51 | log.Println("the user has a evade flag") 52 | } 53 | 54 | log.Println("The type is: " + info.Results.EntityType) 55 | } 56 | 57 | func IdSample01() { 58 | info, err := spamProtection.GetInfoByID(1234567890) 59 | if err != nil { 60 | log.Fatal(err) 61 | } 62 | 63 | if info.Success { 64 | log.Println("succeeded to get information of use from " + 65 | "intellivoid's database") 66 | } 67 | 68 | if info.IsBlacklisted() { 69 | log.Println("target is blacklisted") 70 | f := info.GetBlacklistFlag() 71 | log.Println("with flag: " + f) 72 | } 73 | 74 | if info.IsOfficial() { 75 | log.Println("target is an official Intellivoid " + 76 | info.GetType()) 77 | } 78 | 79 | if info.HasFlag(spamProtection.NameSpamFlag, spamProtection.ChildAbuseFlag) { 80 | log.Println("Oh no, the target has either" + 81 | " name spam flag or child abuse") 82 | } 83 | 84 | if info.HasFlagPrivate() { 85 | // for example for a user, this log will show us: 86 | // this user has a private flag 87 | log.Println("this " + info.GetType() + " has a private flag") 88 | } 89 | 90 | log.Println("The type is: " + info.Results.EntityType) 91 | // or we can use: 92 | log.Println("The type is: " + info.GetType()) 93 | // both of them will give us same result 94 | 95 | //**********printing some information****************** 96 | str := "Information about this " + info.GetType() 97 | str += "Has Child abuse flag: " + info.HasFlagChildAbuseStr() 98 | str += "Has Evade flag: " + info.HasFlagEvadeStr() 99 | str += "Has Child Imporsonation flag: " + info.HasFlagImperStr() 100 | str += "Is a mass adder: " + info.HasFlagMassAddStr() 101 | str += "Is scam: " + info.HasFlagScamStr() 102 | str += "Is spammer: " + info.HasFlagSpamStr() 103 | str += "Is blacklisted for special reason: " + info.HasFlagSpecialStr() 104 | } 105 | -------------------------------------------------------------------------------- /spamProtection/helpers.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | package spamProtection 19 | 20 | import ( 21 | "encoding/json" 22 | "errors" 23 | "fmt" 24 | "io/ioutil" 25 | "net/http" 26 | "strings" 27 | ) 28 | 29 | // This function allows you to lookup a user, chat or channel 30 | // by its id (which is a 64 bit integer) 31 | // in the SpamProtection database, this method does not require 32 | // authentication and there are no rate limits. 33 | // if something went wrong in server-side and we get the 34 | // full information in response, it will return you that 35 | // `error`, so the `info` value will be nil. 36 | // negative IDs (like group's id) are supported. 37 | func GetInfoByID(id int64) (info *APIResponse, err error) { 38 | if id == 0 { 39 | return nil, errors.New("ID cannot be zero") 40 | } 41 | 42 | addr := fmt.Sprintf(endPointI, id) 43 | resp, err := http.Get(addr) 44 | if err != nil { 45 | return nil, err 46 | } 47 | 48 | defer resp.Body.Close() 49 | 50 | b, err := ioutil.ReadAll(resp.Body) 51 | if err != nil { 52 | return nil, err 53 | } 54 | 55 | var res APIResponse 56 | 57 | err = json.Unmarshal(b, &res) 58 | if err != nil { 59 | return nil, err 60 | } 61 | 62 | if res.HasError() { 63 | // if something went wrong at server-side, 64 | // return it so the user can find out that 65 | // duty of this function ended in failure. 66 | return nil, res.Error 67 | } 68 | 69 | return &res, nil 70 | } 71 | 72 | // This function allows you to lookup a user, chat or channel 73 | // by its username (which is a string) 74 | // in the SpamProtection database, this method does not require 75 | // authentication and there are no rate limits. 76 | // if something went wrong in server-side and we get the 77 | // full information in response, it will return you that 78 | // `error`, so the `info` value will be nil. 79 | // it supports these formats: 80 | // * the_username 81 | // * @the_username 82 | // * t.me/falling_inside_the_black 83 | // * http://telesco.pe/NightShadowsHangout 84 | func GetInfoByUsername(username string) (info *APIResponse, err error) { 85 | if len(username) == 0 { 86 | return nil, errors.New("username cannot be empty") 87 | } 88 | 89 | // fix the username so it doesn't containt white space and '@' 90 | username = FixUsername(username) 91 | if !IsValidUsername(username) { 92 | // always check if the username is valid or not. 93 | // sending http request blindly without any checking 94 | // will only increase running time order. 95 | return nil, errors.New("the username \"" + 96 | username + "\" is invalid") 97 | } 98 | 99 | addr := fmt.Sprintf(endPointS, username) 100 | resp, err := http.Get(addr) 101 | if err != nil { 102 | return nil, err 103 | } 104 | 105 | defer resp.Body.Close() 106 | 107 | b, err := ioutil.ReadAll(resp.Body) 108 | if err != nil { 109 | return nil, err 110 | } 111 | 112 | var res APIResponse 113 | 114 | err = json.Unmarshal(b, &res) 115 | if err != nil { 116 | return nil, err 117 | } 118 | 119 | if res.HasError() { 120 | // if something went wrong at server-side, 121 | // return it so the user can find out that 122 | // duty of this function ended in failure. 123 | return nil, res.Error 124 | } 125 | 126 | return &res, nil 127 | } 128 | 129 | // IsValidUsername will check if `text` is a valid username or not. 130 | // please fix the string before using this function, 131 | // for example you have to do TrimPrefix, TrimSuffix, etc... 132 | func IsValidUsername(text string) bool { 133 | l := len(text) 134 | if l <= minUsername || l > maxUsername { 135 | return false 136 | } 137 | 138 | for i, c := range text { 139 | // when we are in the base index (0) 140 | // the character should be english, 141 | // otherwise return false 142 | if i == baseIndex { 143 | if !isEnglish(c) { 144 | return false 145 | } 146 | 147 | continue 148 | } 149 | 150 | // check if it's english, number or underline ('_'), 151 | // if it's not return false 152 | if !isNumOrEng(c) { 153 | return false 154 | } 155 | } 156 | 157 | // all checks have been passes, so return true 158 | return true 159 | } 160 | 161 | // FixUsername will fix the username and will return you a valid 162 | // username. 163 | // examples: 164 | // " @Falling_inside_the_black " => "Falling_inside_the_black" 165 | // "t.me/dank_as_fuck " => "dank_as_fuck" 166 | func FixUsername(value string) string { 167 | if len(value) == 0 { 168 | return empty 169 | } 170 | 171 | value = strings.TrimSpace(value) 172 | value = strings.TrimPrefix(value, atSign) 173 | value = strings.TrimSpace(value) 174 | 175 | if strings.Contains(value, slash) { 176 | strs := strings.Split(value, slash) 177 | l := len(strs) 178 | if l == baseIndex { 179 | return empty 180 | } 181 | 182 | l-- 183 | return strs[l] 184 | } 185 | 186 | return value 187 | } 188 | 189 | // isEnglish return `true` if `r` is an english letter, 190 | // otherwise `false`. 191 | func isEnglish(r rune) bool { 192 | if r >= letterA && r <= letterZ { 193 | return true 194 | } else { 195 | return r >= capLetterA && r <= capLetterZ 196 | } 197 | } 198 | 199 | // isNum returns `true` if `r` is considered as a 200 | // number rune, otherwise `false`. 201 | func isNum(r rune) bool { 202 | return r >= letterZero || r <= letterNine 203 | } 204 | 205 | // isNumOrEng will check if `r` is rather english, 206 | // number or underline ('_') rune or not. 207 | // return `true` if yes, otherwise `false`. 208 | func isNumOrEng(r rune) bool { 209 | return isNum(r) || 210 | isEnglish(r) || 211 | r == underlineChar 212 | } 213 | 214 | // yesNo returns "Yes" for `true`, 215 | // and "No" for `false`. 216 | func yesNo(value bool) string { 217 | if value { 218 | return yesStr 219 | } else { 220 | return noStr 221 | } 222 | } 223 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 18 | 19 | # SpamProtection-go 20 | > Name: SpamProtection-go \ 21 | > Version: v1.0.4 \ 22 | > Edit: 13 Jun 2021 \ 23 | > By: Intellivoid (C) 24 | 25 | ----------------------------------------------------------- 26 | 30 | 31 | [![Go Reference](https://pkg.go.dev/badge/github.com/Intellivoid/Intellivoid.SpamProtection-go.svg)](https://pkg.go.dev/github.com/Intellivoid/Intellivoid.SpamProtection-go) 32 | 33 | SpamProtection-Go is an Official [golang](https://go.dev) wrapper for [Intellivoid](https://intellivoid.net) SpamProtection API, which is fast, secure and requires no additional packages to be installed. 34 | 35 | ### Preview: 36 | 37 | * [What is SpamProtection?](#what-is-spamprotection) 38 | * [Supported Go versions](#supported-go-versions) 39 | * [Features](#features) 40 | * [Getting started](#getting-started) 41 | * [How to use](#how-to-use) 42 | * [Support and Contributions](#support-and-contributions) 43 | * [Links](#links) 44 | * [License](#license) 45 | 46 | 47 | 48 | 49 |
50 | 51 | 52 | ## What is SpamProtection? 53 | 54 | SpamProtection is a community powered solution with the goal to effectively combat spam on Telegram using machine learning and manual spam reporting. 55 | This API allows you to lookup a user, chat or channel in the SpamProtection database, this method does not require authentication and there are no rate limits. 56 | 57 |
58 | 59 | ## Supported Go versions 60 | 61 | For better experience, we recommend you to use latest version of Go (v1.16), but this library requires at least Go version 1.15. 62 | 63 |
64 | 65 | ## Features 66 | 67 | - Uses official Intellivoid API, which makes this library: 68 | - Easy to update 69 | - Guaranteed to match the docs 70 | - No third party endpoints 71 | - Self-documenting (Contains all pre-existing Intellivoid's docs) 72 | - It's in pure go, no need to install any kind of plugin or include any kind of additional files. 73 | - No third party library bloat; only uses standard library. 74 | - Type safe; no weird `interface{}` logic. 75 | - Multiple searching for blacklist flags. 76 | 77 |
78 | 79 | ## Getting started 80 | 81 | You can easily download the library with the standard `go get` command: 82 | 83 | ```bash 84 | go get github.com/Intellivoid/Intellivoid.SpamProtection-go 85 | ``` 86 | or 87 | ```bash 88 | dep ensure -add github.com/Intellivoid/Intellivoid.SpamProtection-go 89 | ``` 90 | 91 | Full documentation of this library, can be found [here](https://pkg.go.dev/github.com/Intellivoid/Intellivoid.SpamProtection-go). 92 | 93 |
94 | 95 | ## How to use 96 | 97 | The `spamProtection` package contains all helpers you need! 98 | You can lookup a user, channel, group or a bot and recieve it's status with calling only one function. (using either username or user id) 99 | 100 | ```go 101 | package main 102 | 103 | import "github.com/Intellivoid/Intellivoid.SpamProtection-go/spamProtection" 104 | 105 | func main() { 106 | // get information of a user, channel or a group with a telegram id (int64) 107 | info, err := spamProtection.GetInfoByID(1234567890) 108 | if err != nil { 109 | log.Fatal(err.Error()) 110 | } 111 | 112 | // use this method to see if the target is blacklisted or not 113 | if info.IsBlacklisted() { 114 | // use GetType() method to see if the target is a user, 115 | // channel, group or bot? 116 | log.Println("This " + info.GetType() + 117 | " is blacklisted, because of " + info.GetBlacklistReason()) 118 | // an example of the output would be: 119 | // This user is blacklisted, because of RAID Initializer / Participator 120 | } 121 | 122 | // get information of a user, channel or a group with a telegram username (string) 123 | // you can use also use '@' at the first of username 124 | info2, err := spamProtection.GetInfoByUsername("") 125 | if err != nil { 126 | log.Fatal(err.Error()) 127 | } 128 | 129 | // Yup! it supports multiple searching 130 | // pass more than one flag and see if the target has one of them or not! 131 | if info2.HasFlag(spamProtection.SpamFlag, spamProtection.ChildAbuseFlag) { 132 | log.Println("this " + info2.GetType() + 133 | " is either a spammer or a child abuser") 134 | log.Println("it has " + info2.GetBlacklistFlag() + " flag!") 135 | // an example of the output would be: 136 | // this user is either a spammer or a child abuser 137 | // it has 0xSPAM flag! 138 | } 139 | 140 | // or see if a user is a potential spammer or not 141 | // (based on their last activities) 142 | if info2.IsPotential() { 143 | log.Println("Be careful! this " + info2.GetType() + 144 | " is a potential spammer!") 145 | // an example for the output would be: 146 | // "Be careful! this bot is a potential spammer!" 147 | } 148 | 149 | // also make sure you are joined in our official group 150 | if info2.IsVerified() { 151 | log.Println("This " + info2.GetType() + 152 | " is verified by Intellivoid Technologies") 153 | // an example for the output would be: 154 | // This group is verified by Intellivoid Technologies 155 | } 156 | } 157 | ``` 158 | 159 | Still need more samples? Take a look at our [samples directory](samples). 160 | 161 |
162 | 163 | ## Support and Contributions 164 | 165 | * If you want to be aware of most recent changes, you can join [Intellivoid updates channel](https://t.me/Intellivoid). 166 | 167 | * Have a problem with API? Servers are down? Something went wrong? Ensure that you are joined at our [Support chat](https://t.me/IntellivoidDiscussions)! 168 | 169 | * Having a problem with library? Wanna talk with repository's owner? Contact the [Maintainer](https://t.me/dank_as_fuck)! 170 | 171 | * Still don't know what's going on? Not sure about how API works? Be sure to read [Introduction](https://docs.intellivoid.net/spamprotection/introduction). 172 | 173 | * Want to read original documentation? Want to see how we receive data from Servers? You can read [API documents](https://docs.intellivoid.net/spamprotection/v1/lookup) then! 174 | 175 | * Want to guarantee your group security? Protecting your groups from spammers is in high-priority for you? You can add our official [SpamProtection bot](https://t.me/SpamProtectionBot) with full features of our API! 176 | 177 | * If you think you have found a bug or have a feature request, feel free to use our [issue tracker](https://github.com/Intellivoid/Intellivoid.SpamProtection-go/issues). Before opening a new issue, please search to see if your problem has already been reported or not. Try to be as detailed as possible in your issue reports. 178 | 179 | * If you need help using Intellivoid's APIs or have other questions we suggest you to join our [telegram community](https://t.me/IntellivoidCommunity). Please do not use the GitHub issue tracker for personal support requests. 180 | 181 |
182 | 183 | ## Links 184 | 185 | * [Official website](https://intellivoid.net) 186 | * [Coffehouse](https://coffeehouse.intellivoid.net) 187 | * [Official channel](https://t.me/Intellivoid) 188 | * [Support chat](https://t.me/IntellivoidDiscussions) 189 | * [Intellivoid Community](https://t.me/IntellivoidCommunity) 190 | * [Discord server](https://discord.gg/euNkxEKPJb) 191 | * [Maintainer Telegram](https://t.me/dank_as_fuck) 192 | * [API Introduction](https://docs.intellivoid.net/spamprotection/introduction) 193 | * [API documents](https://docs.intellivoid.net/spamprotection/v1/lookup) 194 | * [SpamProtection bot](https://t.me/SpamProtectionBot) 195 | 196 |
197 | 198 | ## License 199 | 200 | The Intellivoid.SpamProtection-go project is under the [GPL-3.0](https://opensource.org/licenses/GPL-3.0) license. You can find the license file [here](LICENSE). 201 | 202 | 203 | 204 | -------------------------------------------------------------------------------- /spamProtection/types.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | package spamProtection 19 | 20 | // APIResponse is the Top-Level Struct in json data. 21 | // The value success will always be returned 22 | // If it's true then results will be available as an object. 23 | // If false the error object will return and 24 | // it is pretty much the same across all of our APIs 25 | type APIResponse struct { 26 | Success bool `json:"success"` 27 | ResponseCode int `json:"response_code"` 28 | Results *Results `json:"results"` 29 | Error *Error `json:"error"` 30 | } 31 | 32 | // Error contains an Error code, Type and Message. 33 | // The way your client should handle API errors is by this; 34 | // If applicable, apply the error code from 35 | // the API to your exception + the message. 36 | // For errors that you want to catch and resolve on your own, 37 | // refer to the error code. For this case; 38 | // SpamProtection only has one error code which is 0. 39 | // Other more complicated APIs has a set of pre-determined errors 40 | // that you can use to programmatically detect the error and 41 | // resolve it if it's on your client's end. 42 | // 0 Is pretty much telling you to read the message 43 | // the server returned, because it's unique or something weird. 44 | // Before the API would simply return a message and it 45 | // is up to your client to determine the error 46 | // by the HTTP response code; 47 | // this isn't good because if we were to 48 | // add more complicated methods in the future that 49 | // returns different errors but with the same HTTP code, 50 | // it can be harder for programs to automatically correct the error 51 | // if required. 52 | // So the 1.1 API update corrects this by using this new error 53 | // standard which returns `error_code`, `type` and `message`. 54 | type Error struct { 55 | ErrorCode int `json:"error_code"` 56 | Type string `json:"type"` 57 | Message string `json:"message"` 58 | } 59 | 60 | // SpamPrediction contains main statistics about 61 | // the target being looked up. 62 | type SpamPrediction struct { 63 | // The probability (confidence) of this generalized ham 64 | // (not spam) prediction, if no prediction is 65 | // available then it will be zero 66 | HamPrediction float64 `json:"ham_prediction"` 67 | 68 | // The probability (confidence) of this generalized 69 | // spam prediction, if no prediction is available 70 | // then it will be zero 71 | SpamPrediction float64 `json:"spam_prediction"` 72 | } 73 | 74 | // LanguagePrediction contains prediction of the language 75 | // of a user, channels or groups. 76 | // If unavailable; it can't determine the language and or 77 | // server didn't have any data to make the prediction 78 | // in the first place. 79 | // 80 | // > question: why predict language of a group or channel as well 81 | // as users? won't it only increase the payload of servers? 82 | // I mean has it worth to spend resources on predicting 83 | // a channel's language? 84 | // > founder's response: You forget how efficiently built it is. 85 | // It doesn't need to store the contents to remember the 86 | // prediction history, it uses Generalization to accomplish 87 | // this so it can accurately make a prediction based on 88 | // the last 100 messages. 89 | // And this takes up at least 1kb of data at best. 90 | // because it uses [ziproto](https://github.com/Netkas/ZiProto-Python) 91 | // for I/O. 92 | // This cannot be accomplished most of the time when using 93 | // stuff like Tensorflow; because it requires more resources 94 | // to accomplish and using these libraries and dependencies; 95 | // you don't really have control over how the data is stored and used. 96 | // When I build all these components from scratch, 97 | // I can control everything from how each byte is sent 98 | // to the hardware-level. 99 | // Minimizing the overhead in your software is 100 | // a great way to accomplish a lot more than what modern computers 101 | // are fully capable of; sadly not a lot of programmers are aware 102 | // of this and often uses 100% of the cpu resources to accomplish 103 | // something extremely inefficiently. 104 | // The problem with my approach is that it causes more ware 105 | // and tear on the hardware, which is why Intellivoid 106 | // has been down for the past month or so because 107 | // our hosting provider yelled at us for destroying their hardware. 108 | // Due to how optimized the software is on a hardware-level; 109 | // it uses more of the hardware than the hardware was 110 | // designed to handle. 111 | type LanguagePrediction struct { 112 | // The ISO 639-1 language code predicted by SpamProtectionBot, 113 | // if no prediction is available then it will be 114 | // an empty string 115 | Language string `json:"language"` 116 | 117 | // The probability (confidence) of this generalized 118 | // language prediction, if no prediction is available 119 | // then it will be zero 120 | Probability float64 `json:"probability"` 121 | } 122 | 123 | // Attributes struct contains attributes information 124 | // of a user, group or channel. 125 | // There is no such thing as "Official users", 126 | // only "Official channels" or groups, 127 | // these are entities with the "blue checkmark" 128 | // implemented by us; not by Telegram. 129 | // To show the public that this entity is the real thing. 130 | // 131 | // Operators are the people that maintains the SpamProtectionBot 132 | // database by handling user appeals, blacklisting spammers 133 | // and making sure that the bot is operating correctly. 134 | // Basically the Administrators of SpamProtectionBot 135 | // 136 | // Agents are basically userbots that spies on groups 137 | // where SpamProtectionBot isn't in and or resolve users 138 | // that the bot doesn't know. 139 | // 140 | // There are no sudo users or sudo capabilities; 141 | // operators cannot use the bot to ban people from your group, 142 | // manage your group and or promote themselves to an administrator. 143 | // Operators do not need to be administrators to preform 144 | // their tasks since it's related to the database itself, 145 | // not your group. 146 | type Attributes struct { 147 | 148 | // Indicates if this entity was blacklisted by a operator or agent. 149 | IsBlacklisted bool `json:"is_blacklisted"` 150 | 151 | // If the target is blacklisted, the blacklist flag will be 152 | // available otherwise it will be an empty string. 153 | BlacklistFlag string `json:"blacklist_flag"` 154 | 155 | // If the target is blacklisted, a user friendly message 156 | // of the blacklist flag will be available otherwise 157 | // it will be an empty string 158 | BlacklistReason string `json:"blacklist_reason"` 159 | 160 | // If the target was blacklisted for 0xEVADE then the 161 | // original private telegram ID (ptid) will be available, 162 | // otherwise it will be an empty string 163 | OriginalPrivateID string `json:"original_private_id"` 164 | 165 | // Indicates if SpamProtection believes that 166 | // this user may be a potential spammer based on past activities 167 | IsPotentialSpammer bool `json:"is_potential_spammer"` 168 | 169 | // Indicates if this user is an operator for SpamProtectionBot 170 | IsOperator bool `json:"is_operator"` 171 | 172 | // Indicates if this user is an agent that automatically 173 | // reports spam to SpamProtectionBot (Userbot Agent) 174 | IsAgent bool `json:"is_agent"` 175 | 176 | // Indicates if this user is whitelisted and 177 | // cannot be blacklisted or seen as a potential spammer 178 | IsWhitelisted bool `json:"is_whitelisted"` 179 | 180 | // Indicates if this user has verified their 181 | // Telegram Account with Intellivoid Accounts 182 | IntellivoidAccountsVerified bool `json:"intellivoid_accounts_verified"` 183 | 184 | // Indicates if this entity is deemed 185 | // official by Intellivoid Technologies 186 | IsOfficial bool `json:"is_official"` 187 | } 188 | 189 | // Results contains the results recieved from API. 190 | // > see also: https://docs.intellivoid.net/spamprotection/v1/lookup 191 | type Results struct { 192 | // The private Telegram ID of the entity 193 | PrivateTelegramID string `json:"private_telegram_id"` 194 | 195 | // The entity type, can be user, bot, group, supergroup or channel 196 | EntityType string `json:"entity_type"` 197 | 198 | // The attributes of the entity, such as blacklist information and so on. 199 | Attributes *Attributes `json:"attributes"` 200 | 201 | // Information about the generalized language prediction 202 | LanguagePrediction *LanguagePrediction `json:"language_prediction"` 203 | 204 | // Information about the generalized spam prediction 205 | SpamPrediction *SpamPrediction `json:"spam_prediction"` 206 | 207 | // The Unix Timestamp of when this was last updated in the database 208 | LastUpdated int `json:"last_updated"` 209 | } 210 | -------------------------------------------------------------------------------- /spamProtection/getMethods.go: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of Intellivoid.SpamProtection-go (https://github.com/Intellivoid/Intellivoid.SpamProtection-go). 3 | * Copyright (c) 2021 Sayan Biswas, ALiwoto. 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, version 3. 8 | * 9 | * This program is distributed in the hope that it will be useful, but 10 | * WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12 | * General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | package spamProtection 19 | 20 | import "strconv" 21 | 22 | //--------------------------------------------------------- 23 | 24 | // Error returns you a string indicating what really happened 25 | // at our servers. 26 | func (e *Error) Error() string { 27 | str := "error in spamProtection package: " 28 | str += "with code " + strconv.Itoa(e.ErrorCode) 29 | str += " : " + e.Message 30 | 31 | return str 32 | } 33 | 34 | //--------------------------------------------------------- 35 | 36 | // HasError will check if there is an error in 37 | // the response received from Intellivoid's servers. 38 | func (r *APIResponse) HasError() bool { 39 | return r.Error != nil 40 | } 41 | 42 | // IsBlacklisted will check Attributes of the 43 | // target, returns `true` if it's blacklisted, 44 | // otherwise false. 45 | func (r *APIResponse) IsBlacklisted() bool { 46 | if r.Results.Attributes == nil { 47 | return false 48 | } 49 | 50 | return r.Results.Attributes.IsBlacklisted 51 | } 52 | 53 | // GetBlacklistFlag will return the BlacklistFlag in 54 | // the Attributes of the target. it returns an empty 55 | // string if the user is not blacklisted. 56 | // > see full list of flags here: 57 | // https://github.com/intellivoid/Intellivoid.SpamProtection-go/FLAGS.md 58 | func (r *APIResponse) GetBlacklistFlag() string { 59 | if r.Results.Attributes == nil { 60 | return empty 61 | } 62 | 63 | return r.Results.Attributes.BlacklistFlag 64 | } 65 | 66 | // HasFlag will check if the target has at least one of 67 | // the passed flags or not. you can pass multiple flags to 68 | // this method to check them all, at least one of them 69 | // should exist, otherwise returns `false`. 70 | func (r *APIResponse) HasFlag(flags ...string) bool { 71 | if flags == nil { 72 | return false 73 | } 74 | 75 | real := r.GetBlacklistFlag() 76 | if real == empty { 77 | return false 78 | } 79 | 80 | for _, f := range flags { 81 | if f == real { 82 | return true 83 | } 84 | } 85 | 86 | return false 87 | } 88 | 89 | // HasFlagNone will check if the Attributes of the target 90 | // has None flag (0x0) or not. 91 | func (r *APIResponse) HasFlagNone() bool { 92 | return r.HasFlag(NoneFlag) 93 | } 94 | 95 | // HasFlagNoneStr will check if the Attributes of the target 96 | // has None flag (0x0) or not. It's equivalent to 97 | // HasFlagNone(), but it returns "Yes" for `true`, 98 | // and "No" for `false`. 99 | func (r *APIResponse) HasFlagNoneStr() string { 100 | return yesNo(r.HasFlag(NoneFlag)) 101 | } 102 | 103 | // HasFlagSpecial will check if the Attributes of the target 104 | // has Special flag (0xSP) or not. 105 | func (r *APIResponse) HasFlagSpecial() bool { 106 | return r.HasFlag(SpecialFlag) 107 | } 108 | 109 | // HasFlagSpecialStr will check if the Attributes of the target 110 | // has Special flag (0xSP) or not. It's equivalent to 111 | // HasFlagSpecial(), but it returns "Yes" for `true`, 112 | // and "No" for `false`. 113 | func (r *APIResponse) HasFlagSpecialStr() string { 114 | return yesNo(r.HasFlag(SpecialFlag)) 115 | } 116 | 117 | // HasFlagSpam will check if the Attributes of the target 118 | // has Spam flag (0xSPAM) or not. 119 | func (r *APIResponse) HasFlagSpam() bool { 120 | return r.HasFlag(SpamFlag) 121 | } 122 | 123 | // HasFlagSpamStr will check if the Attributes of the target 124 | // has Spam flag (0xSPAM) or not. It's equivalent to 125 | // HasFlagSpam(), but it returns "Yes" for `true`, 126 | // and "No" for `false`. 127 | func (r *APIResponse) HasFlagSpamStr() string { 128 | return yesNo(r.HasFlag(SpamFlag)) 129 | } 130 | 131 | // HasFlagEvade will check if the Attributes of the target 132 | // has Evade( flag (0xEVADE) or not. 133 | func (r *APIResponse) HasFlagEvade() bool { 134 | return r.HasFlag(EvadeFlag) 135 | } 136 | 137 | // HasFlagEvadeStr will check if the Attributes of the target 138 | // has Evade( flag (0xEVADE) or not. It's equivalent to 139 | // HasFlagEvade(), but it returns "Yes" for `true`, 140 | // and "No" for `false`. 141 | func (r *APIResponse) HasFlagEvadeStr() string { 142 | return yesNo(r.HasFlag(EvadeFlag)) 143 | } 144 | 145 | // HasFlagChildAbuse will check if the Attributes of the target 146 | // has child abuse flag (0xCACP) or not. 147 | func (r *APIResponse) HasFlagChildAbuse() bool { 148 | return r.HasFlag(ChildAbuseFlag) 149 | } 150 | 151 | // HasFlagChildAbuseStr will check if the Attributes of the target 152 | // has child abuse flag (0xCACP) or not. It's equivalent to 153 | // HasFlagChildAbuse(), but it returns "Yes" for `true`, 154 | // and "No" for `false`. 155 | func (r *APIResponse) HasFlagChildAbuseStr() string { 156 | return yesNo(r.HasFlag(ChildAbuseFlag)) 157 | } 158 | 159 | // HasFlagImper will check if the Attributes of the target 160 | // has Imper flag (0xIMPER) or not. 161 | func (r *APIResponse) HasFlagImper() bool { 162 | return r.HasFlag(ImperFlag) 163 | } 164 | 165 | // HasFlagImperStr will check if the Attributes of the target 166 | // has Imper flag (0xIMPER) or not. It's equivalent to 167 | // HasFlagImper(), but it returns "Yes" for `true`, 168 | // and "No" for `false`. 169 | func (r *APIResponse) HasFlagImperStr() string { 170 | return yesNo(r.HasFlag(ImperFlag)) 171 | } 172 | 173 | // HasFlagPiracy will check if the Attributes of the target 174 | // has piracy flag (0xPIRACY) or not. 175 | func (r *APIResponse) HasFlagPiracy() bool { 176 | return r.HasFlag(PiracyFlag) 177 | } 178 | 179 | // HasFlagPiracy will check if the Attributes of the target 180 | // has piracy flag (0xPIRACY) or not. It's equivalent to 181 | // HasFlagPiracy(), but it returns "Yes" for `true`, 182 | // and "No" for `false`. 183 | func (r *APIResponse) HasFlagPiracyStr() string { 184 | return yesNo(r.HasFlag(PiracyFlag)) 185 | } 186 | 187 | // HasFlagNSFW will check if the Attributes of the target 188 | // has NSFW flag (0xNSFW) or not. 189 | func (r *APIResponse) HasFlagNSFW() bool { 190 | return r.HasFlag(NSFWFlag) 191 | } 192 | 193 | // HasFlagNSFW will check if the Attributes of the target 194 | // has NSFW flag (0xNSFW) or not. It's equivalent to 195 | // HasFlagNSFW(), but it returns "Yes" for `true`, 196 | // and "No" for `false`. 197 | func (r *APIResponse) HasFlagNSFWStr() string { 198 | return yesNo(r.HasFlag(NSFWFlag)) 199 | } 200 | 201 | // HasFlagPrivate will check if the Attributes of the target 202 | // has private flag (0xPRIVATE) or not. 203 | func (r *APIResponse) HasFlagPrivate() bool { 204 | return r.HasFlag(PrivateFlag) 205 | } 206 | 207 | // HasFlagPrivateStr will check if the Attributes of the target 208 | // has private flag (0xPRIVATE) or not. It's equivalent to 209 | // HasFlagPrivate(), but it returns "Yes" for `true`, 210 | // and "No" for `false`. 211 | func (r *APIResponse) HasFlagPrivateStr() string { 212 | return yesNo(r.HasFlag(PrivateFlag)) 213 | } 214 | 215 | // HasFlagRaid will check if the Attributes of the target 216 | // has raid flag (0xRAID) or not. 217 | func (r *APIResponse) HasFlagRaid() bool { 218 | return r.HasFlag(RaidFlag) 219 | } 220 | 221 | // HasFlagRaidStr will check if the Attributes of the target 222 | // has raid flag (0xRAID) or not. It's equivalent to 223 | // HasFlagRaid(), but it returns "Yes" for `true`, 224 | // and "No" for `false`. 225 | func (r *APIResponse) HasFlagRaidStr() string { 226 | return yesNo(r.HasFlag(RaidFlag)) 227 | } 228 | 229 | // HasFlagScam will check if the Attributes of the target 230 | // has scam flag (0xSCAM) or not. 231 | func (r *APIResponse) HasFlagScam() bool { 232 | return r.HasFlag(ScamFlag) 233 | } 234 | 235 | // HasFlagScamStr will check if the Attributes of the target 236 | // has scam flag (0xSCAM) or not. It's equivalent to 237 | // HasFlagScam(), but it returns "Yes" for `true`, 238 | // and "No" for `false`. 239 | func (r *APIResponse) HasFlagScamStr() string { 240 | return yesNo(r.HasFlag(ScamFlag)) 241 | } 242 | 243 | // HasFlagMassAdd will check if the Attributes of the target 244 | // has mass add flag (0xMASSADD) or not. 245 | func (r *APIResponse) HasFlagMassAdd() bool { 246 | return r.HasFlag(MassAddFlag) 247 | } 248 | 249 | // HasFlagMassAddStr will check if the Attributes of the target 250 | // has mass add flag (0xMASSADD) or not. It's equivalent to 251 | // HasFlagMassAdd(), but it returns "Yes" for `true`, 252 | // and "No" for `false`. 253 | func (r *APIResponse) HasFlagMassAddStr() string { 254 | return yesNo(r.HasFlag(MassAddFlag)) 255 | } 256 | 257 | // HasFlagNameSpam will check if the Attributes of the target 258 | // has name spam flag (0xNAMESPAM) or not. 259 | func (r *APIResponse) HasFlagNameSpam() bool { 260 | return r.HasFlag(NameSpamFlag) 261 | } 262 | 263 | // HasFlagNameSpamStr will check if the Attributes of the target 264 | // has name spam flag (0xNAMESPAM) or not. It's equivalent to 265 | // HasFlagNameSpam(), but it returns "Yes" for `true`, 266 | // and "No" for `false`. 267 | func (r *APIResponse) HasFlagNameSpamStr() string { 268 | return yesNo(r.HasFlag(NameSpamFlag)) 269 | } 270 | 271 | // GetBlacklistReason will return the reason of 272 | // blacklisting of the target. if the target is not 273 | // blacklisted in the first place, it will return an 274 | // empty string. 275 | func (r *APIResponse) GetBlacklistReason() string { 276 | if r.Results.Attributes == nil { 277 | return empty 278 | } 279 | 280 | return r.Results.Attributes.BlacklistReason 281 | } 282 | 283 | // GetOriginId return the original private id of a user. 284 | // if the user was blacklisted with 0xEVADE flag, 285 | // then the original private telegram ID (ptid) 286 | // will be available, otherwise it will be an empty string. 287 | func (r *APIResponse) GetOriginId() string { 288 | if r.Results.Attributes == nil { 289 | return empty 290 | } 291 | 292 | return r.Results.Attributes.OriginalPrivateID 293 | } 294 | 295 | // IsPotential will return `true` if the target 296 | // is a potential spammer (based on past activities). 297 | func (r *APIResponse) IsPotential() bool { 298 | if r.Results.Attributes == nil { 299 | return false 300 | } 301 | 302 | return r.Results.Attributes.IsPotentialSpammer 303 | } 304 | 305 | // IsPotentialStr will return `"Yes"` if the target 306 | // is a potential spammer (based on past activities), 307 | // otherwise returns `"No".` 308 | func (r *APIResponse) IsPotentialStr() string { 309 | if r.Results.Attributes == nil { 310 | return empty 311 | } 312 | 313 | return yesNo(r.Results.Attributes.IsPotentialSpammer) 314 | } 315 | 316 | // IsOperator returns `true` if this user is an operator 317 | // of Spam Protection. 318 | func (r *APIResponse) IsOperator() bool { 319 | if r.Results.Attributes == nil { 320 | return false 321 | } 322 | 323 | return r.Results.Attributes.IsOperator 324 | } 325 | 326 | // IsOperatorStr returns `"Yes"` if this user is an operator 327 | // of Spam Protection, otherwise returns `"No"`. 328 | func (r *APIResponse) IsOperatorStr() string { 329 | if r.Results.Attributes == nil { 330 | return empty 331 | } 332 | 333 | return yesNo(r.Results.Attributes.IsOperator) 334 | } 335 | 336 | // IsAgent will check if this user is an agent or not. 337 | // Agents are basically userbots that spies on groups 338 | // where SpamProtectionBot isn't in and or resolve users 339 | // that the bot doesn't know. 340 | func (r *APIResponse) IsAgent() bool { 341 | if r.Results.Attributes == nil { 342 | return false 343 | } 344 | 345 | return r.Results.Attributes.IsAgent 346 | } 347 | 348 | // IsAgentStr will check if this user is an agent or not. 349 | // Agents are basically userbots that spies on groups 350 | // where SpamProtectionBot isn't in and or resolve users 351 | // that the bot doesn't know. 352 | // it returns `"Yes"` if the user is an agent, otherwise 353 | // `"No"`. 354 | func (r *APIResponse) IsAgentStr() string { 355 | if r.Results.Attributes == nil { 356 | return empty 357 | } 358 | 359 | return yesNo(r.Results.Attributes.IsAgent) 360 | } 361 | 362 | // IsWhitelisted will check if this user is a whitelisted 363 | // use or not. if this user is whitelisted, it annot be blacklisted 364 | // or seen as a potential spammer 365 | func (r *APIResponse) IsWhitelisted() bool { 366 | if r.Results.Attributes == nil { 367 | return false 368 | } 369 | 370 | return r.Results.Attributes.IsWhitelisted 371 | } 372 | 373 | // IsWhitelistedStr will check if this user is a whitelisted 374 | // use or not. if this user is whitelisted, it cannot be blacklisted 375 | // or seen as a potential spammer. 376 | // it returns `"Yes"` if the user is whitelisted, 377 | // otherwise returns `"No"`. 378 | func (r *APIResponse) IsWhitelistedStr() string { 379 | if r.Results.Attributes == nil { 380 | return empty 381 | } 382 | 383 | return yesNo(r.Results.Attributes.IsWhitelisted) 384 | } 385 | 386 | // IsVerified returns `true` if the target 387 | // (which can be user, group and channel), is 388 | // verified by intellivoid or not. 389 | func (r *APIResponse) IsVerified() bool { 390 | if r.Results.Attributes == nil { 391 | return false 392 | } 393 | 394 | return r.Results.Attributes.IntellivoidAccountsVerified 395 | } 396 | 397 | // IsVerified returns `"Yes"` if the target 398 | // (which can be user, group and channel), is 399 | // verified by intellivoid or not, otherwise 400 | // returns `"No"`. 401 | func (r *APIResponse) IsVerifiedStr() string { 402 | if r.Results.Attributes == nil { 403 | return empty 404 | } 405 | 406 | return yesNo(r.Results.Attributes.IntellivoidAccountsVerified) 407 | } 408 | 409 | // IsOfficial will check if the target is official or not. 410 | // There is no such thing as "Official users", 411 | // only "Official channels" or groups, 412 | // these are entities with the "blue checkmark" 413 | // implemented by us; not by Telegram. 414 | // To show the public that this entity is the real thing. 415 | func (r *APIResponse) IsOfficial() bool { 416 | if r.Results.Attributes == nil { 417 | return false 418 | } 419 | 420 | return r.Results.Attributes.IsOfficial 421 | } 422 | 423 | // IsOfficial will check if the target is official or not. 424 | // There is no such thing as "Official users", 425 | // only "Official channels" or groups, 426 | // these are entities with the "blue checkmark" 427 | // implemented by us; not by Telegram. 428 | // To show the public that this entity is the real thing. 429 | // it returns `"Yes"` if it's official, otherwise returns 430 | // `"No"`. 431 | func (r *APIResponse) IsOfficialStr() string { 432 | if r.Results.Attributes == nil { 433 | return empty 434 | } 435 | 436 | return yesNo(r.Results.Attributes.IsOfficial) 437 | } 438 | 439 | // GetType will return the type of the target. 440 | // it can be user, bot, group, supergroup or channel. 441 | func (r *APIResponse) GetType() string { 442 | if r.Results == nil { 443 | return empty 444 | } 445 | 446 | return r.Results.EntityType 447 | } 448 | 449 | // IsUser will check if the target is a 450 | // telegram user account or not. 451 | func (r *APIResponse) IsUser() bool { 452 | return r.GetType() == UserType 453 | } 454 | 455 | // IsBot will check if the target is a 456 | // bot or not. 457 | func (r *APIResponse) IsBot() bool { 458 | return r.GetType() == BotType 459 | } 460 | 461 | // IsGroup will check if the target is 462 | // either a super group or a normal group. 463 | func (r *APIResponse) IsGroup() bool { 464 | t := r.GetType() 465 | return t == GroupType || 466 | t == SupergroupType 467 | } 468 | 469 | // IsNormalGroup will check if the target is a 470 | // normal telegram group or not. 471 | func (r *APIResponse) IsNormalGroup() bool { 472 | return r.GetType() == GroupType 473 | } 474 | 475 | // IsSuperGroup will check if the target is a 476 | // super group or not. 477 | func (r *APIResponse) IsSuperGroup() bool { 478 | return r.GetType() == SupergroupType 479 | } 480 | 481 | // IsChannel will check if the target is a 482 | // telegram channel or not. 483 | func (r *APIResponse) IsChannel() bool { 484 | return r.GetType() == ChannelType 485 | } 486 | 487 | //--------------------------------------------------------- 488 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | Intellivoid.SpamProtection-go - A golang wrapper for Intellivoid SpamProtection API 635 | Copyright (C) 2021 Sayan Biswas, ALiwoto 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Intellivoid.SpamProtection-go Copyright (C) 2021 Sayan Biswas, ALiwoto 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------