igopher

package module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 21, 2021 License: MIT Imports: 33 Imported by: 0

README

IGopher : (WIP) Golang smart bot for Instagram DM automation

IGopher logo

Build CI Go Report Card Documentation link PkgGoDev

⚡ Powerful, customizable and easy to use Instagram dm bot. With TUI and GUI! Using Selenium webdriver and Yaml configuration files.

Disclaimer: This is a research project. I am in no way responsible for the use you made of this tool. In addition, I am not responsible for any sanctions and/or limitations imposed on your account after using this bot.

Table of Contents

Introduction

IGopher is a new Instagram automation tool that aims to simplify the deployment of such tools and make their use more pleasant thanks to a TUI (terminal User Interface) as well as a GUI (Graphical User Interface) arriving very soon.

Automatic user fetching and message sending!

The bot configuration is very easy thanks to the different configuration menus in the TUI. Parameters are managed and saved in Yaml files easy to edit manually!

Easily configurable and easy to use thanks to his TUI !

Requirements

Features

  • Selenium webdriver engine 🌠
  • Automatic dependencies downloading and installation 🌠
  • Automated IG connection & message sending 🌠
  • Users scrapping from ig user followers 🌠
  • Scheduler 🌠
  • Quotas & user blacklist modules 🌠
  • Human writing simulation 🌠
  • Fully and easily customizable through Yaml files or with TUI 🌠
  • TUI (Terminal User Interface) 🌠
  • Many more to come ! 🥳

Check this Project to see all planned features for this tool! Feel free to suggest additional features to implement! 🥳

Getting Started

From release

  1. Download and install Java and Java JDK (needed for Selenium webdriver) and add them to your path (on Windows)
  2. Download lastest release executable for your operating system
  3. Move the executable to a dedicated folder (it will create folders/files)
  4. Launch it:
  • On Windows, open a Windows Terminal in the folder (or powershell/cmd but the experience quality can be lower) and execute it: ./tui.exe or just drag and drop tui.exe in your command prompt
  • On Linux or MacOS, open you favorite shell in the folder, allow it to be executed with chmod +x ./tui and launch it: ./tui
  1. Configure the bot with your Instagram credentials and set your desired scrapping and autodm settings. To do that, you can use the TUI settings screen or directly edit the config.yaml file.
  2. You're ready! Just hit the "Launch" option in the TUI main menu 🚀

From sources

  1. Download and install Java and Java JDK (needed for Selenium webdriver) and add them to your path (on Windows)
  2. Install Go (v1.13+) on your system
  3. Download lastest release source archive or clone the master branch
  4. Launch it with this command: go run ./cmd/igopher/tui
  5. Configure the bot with your Instagram credentials and set your desired scrapping and autodm settings. To do that, you can use the TUI settings screen or directly edit the config.yaml file.
  6. You're ready! Just hit the "Launch" option in the TUI main menu 🚀

Flags

IGopher have a flags system for debuging or to enable system feature. You can activate them by adding them after the executable call, for exemple to activate headless mode: ./tui --headless

There is the list of all available flags:

--debug
      Display debug and selenium output
--force-download
      Force redownload of all dependencies even if exists
--headless
      Run WebDriver with frame buffer
--ignore-dependencies
      Skip dependencies management
--loglevel string
      Log level threshold (default "info")
--port int
      Specify custom communication port (default 8080)

You can recover this list by adding --help flag.

🤝 Contributing

Contributions are greatly appreciated!

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some amazing stuff')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Create a new Pull Request

Issues and feature requests are welcome! Feel free to check issues page.

Author

👤 Hugo Bollon

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is under MIT license.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CheckConfigValidity 

func CheckConfigValidity() error

CheckConfigValidity check bot config validity

func CheckEnvironment 

func CheckEnvironment()

CheckEnvironment check existence of sub-directories and files required for the operation of the program and creates them otherwise

func ClearTerminal 

func ClearTerminal()

ClearTerminal clear current terminal session according to user OS

func DownloadDependencies 

func DownloadDependencies(downloadBrowsers, downloadLatest, forceDl bool)

DownloadDependencies automate selenium dependencies downloading (ChromeDriver binary, the Firefox binary, the Selenium WebDriver JARs, and the Sauce Connect proxy binary)

func ExportConfig 

func ExportConfig(c BotConfigYaml)

ExportConfig export BotConfigYaml instance to config.yaml config file

func SimulateHandWriting 

func SimulateHandWriting(element selenium.WebElement, input string) bool

SimulateHandWriting simulate human writing by typing input string character by character with random interruptions between letters

Types

type Account 

type Account struct {
	Username string `yaml:"username" validate:"required,min=1,max=30"`
	Password string `yaml:"password" validate:"required,min=1"`
}

Account store personnal credentials

type AccountYaml 

type AccountYaml struct {
	Username string `yaml:"username" validate:"required,min=1,max=30"`
	Password string `yaml:"password" validate:"required"`
}

AccountYaml is the yaml account configuration representation

type AutoDM 

type AutoDM struct {
	Activated bool `yaml:"activated"`
	// List of all availlables message templates
	DmTemplates []string `yaml:"dm_templates" validate:"required"`
	// Greeting module add a customized DM header with recipient username
	Greeting GreetingConfig `yaml:"greeting"`
}

AutoDM store messaging module configuration

type AutoDmYaml 

type AutoDmYaml struct {
	DmTemplates []string     `yaml:"dm_templates" validate:"required"`
	Greeting    GreetingYaml `yaml:"greeting"`
	Activated   bool         `yaml:"activated"`
}

AutoDmYaml is the yaml autodm module configuration representation

type BlacklistManager 

type BlacklistManager struct {
	// BlacklistedUsers: list of all blacklisted usernames
	BlacklistedUsers [][]string
	// Activated: quota manager activation boolean
	Activated bool `yaml:"activated"`
}

BlacklistManager data

func (*BlacklistManager) AddUser 

func (bm *BlacklistManager) AddUser(user string)

AddUser add argument username to the blacklist

func (*BlacklistManager) FilterScrappedUsers 

func (bm *BlacklistManager) FilterScrappedUsers(users []selenium.WebElement) []selenium.WebElement

FilterScrappedUsers remove blacklisted users from WebElement slice and return it

func (*BlacklistManager) InitializeBlacklist 

func (bm *BlacklistManager) InitializeBlacklist() error

InitializeBlacklist check existence of the blacklist csv file and initialize it if it doesn't exist.

func (*BlacklistManager) IsBlacklisted 

func (bm *BlacklistManager) IsBlacklisted(user string) bool

IsBlacklisted check if the given user is already blacklisted

type BlacklistYaml 

type BlacklistYaml struct {
	Activated bool `yaml:"activated"`
}

BlacklistYaml is the yaml blacklist module configuration representation

type BotConfigYaml 

type BotConfigYaml struct {
	Account   AccountYaml   `yaml:"account"`
	SrcUsers  ScrapperYaml  `yaml:"scrapper"`
	AutoDm    AutoDmYaml    `yaml:"auto_dm"`
	Quotas    QuotasYaml    `yaml:"quotas"`
	Schedule  ScheduleYaml  `yaml:"schedule"`
	Blacklist BlacklistYaml `yaml:"blacklist"`
}

BotConfigYaml is the raw representation of the yaml bot config file

func ImportConfig 

func ImportConfig() BotConfigYaml

ImportConfig read config.yaml, parse it in BotConfigYaml instance and finally return it

func ResetBotConfig 

func ResetBotConfig() BotConfigYaml

ResetBotConfig return default bot configuration instance

type ClientConfig 

type ClientConfig struct {
	// LogLevel set loglevel threshold
	// If undefined or wrong set it to INFO level
	LogLevel logrus.Level
	// ForceDependenciesDl force re-download of all dependencies
	ForceDependenciesDl bool
	// Debug set selenium debug mode and display its logging to stderr
	Debug bool
	// IgnoreDependencies disable dependencies manager on startup
	IgnoreDependencies bool
	// Headless execute Selenium webdriver in headless mode
	Headless bool
	// Port : communication port
	Port uint16
}

ClientConfig struct centralize all client configuration and flags. Inizialized at program startup, not safe to modify this after.

func CreateClientConfig 

func CreateClientConfig() *ClientConfig

CreateClientConfig create default ClientConfig instance and return a pointer on it

type GreetingConfig 

type GreetingConfig struct {
	Activated bool `yaml:"activated"`
	// Add a string before the username
	Template string `yaml:"template"`
}

GreetingConfig store greeting configuration for AutoDM module

type GreetingYaml 

type GreetingYaml struct {
	Template  string `yaml:"template"`
	Activated bool   `yaml:"activated"`
}

GreetingYaml is the yaml dm greeting configuration representation

type IGopher 

type IGopher struct {
	// SeleniumStruct contain all selenium stuff and config
	SeleniumStruct Selenium
	// User credentials
	UserAccount Account `yaml:"account"`
	// Automatic messages sending module
	DmModule AutoDM `yaml:"auto_dm"`
	// Quotas
	Quotas QuotaManager `yaml:"quotas"`
	// Scrapper
	ScrapperManager ScrapperConfig `yaml:"scrapper"`
	// Scheduler
	Scheduler SchedulerManager `yaml:"schedule"`
	// Interracted users blacklist
	Blacklist BlacklistManager `yaml:"blacklist"`
}

IGopher struct store all bot and ig related configuration and modules instances. Settings are readed from Yaml config files.

func ReadBotConfigYaml 

func ReadBotConfigYaml() IGopher

ReadBotConfigYaml read config yml file and initialize it for use with bot

func (*IGopher) ConnectToInstagram 

func (bot *IGopher) ConnectToInstagram()

ConnectToInstagram get ig login webpage and connect user account

func (*IGopher) FetchUsersFromUserFollowers 

func (sc *IGopher) FetchUsersFromUserFollowers() ([]string, error)

FetchUsersFromUserFollowers scrap username list from users followers. Source accounts and quantity are set by the bot user.

func (*IGopher) SendMessage 

func (bot *IGopher) SendMessage(user, message string) (bool, error)

SendMessage navigate to Instagram direct message interface and send one to specified user by simulating human typing

type QuotaManager 

type QuotaManager struct {
	// HourTimestamp: hourly timestamp used to handle hour limitations
	HourTimestamp time.Time
	// DayTimestamp: daily timestamp used to handle day limitations
	DayTimestamp time.Time
	// DmSent: quantity of dm sent in the last hour
	DmSent int
	// DmSentDay: quantity of dm sent in the last day
	DmSentDay int
	// MaxDmHour: maximum dm quantity per hour
	MaxDmHour int `yaml:"dm_per_hour" validate:"numeric"`
	// MaxDmDay: maximum dm quantity per day
	MaxDmDay int `yaml:"dm_per_day" validate:"numeric"`
	// Activated: quota manager activation boolean
	Activated bool `yaml:"activated"`
}

QuotaManager data

func (*QuotaManager) AddDm 

func (qm *QuotaManager) AddDm()

AddDm report to the manager a message sending. It increment dm counter and check if quotas are still valid.

func (*QuotaManager) CheckQuotas 

func (qm *QuotaManager) CheckQuotas()

CheckQuotas check if quotas have not been exceeded and pauses the program otherwise.

func (*QuotaManager) InitializeQuotaManager 

func (qm *QuotaManager) InitializeQuotaManager()

InitializeQuotaManager initialize Quota manager with user settings

func (*QuotaManager) ResetDailyQuotas 

func (qm *QuotaManager) ResetDailyQuotas()

ResetDailyQuotas reset daily dm counter and update timestamp

func (*QuotaManager) ResetHourlyQuotas 

func (qm *QuotaManager) ResetHourlyQuotas()

ResetHourlyQuotas reset hourly dm counter and update timestamp

type QuotasYaml 

type QuotasYaml struct {
	DmDay     int  `yaml:"dm_per_day" validate:"numeric"`
	DmHour    int  `yaml:"dm_per_hour" validate:"numeric"`
	Activated bool `yaml:"activated"`
}

QuotasYaml is the yaml quotas module configuration representation

type ScheduleYaml 

type ScheduleYaml struct {
	BeginAt   string `yaml:"begin_at" validate:"contains=:"`
	EndAt     string `yaml:"end_at" validate:"contains=:"`
	Activated bool   `yaml:"activated"`
}

ScheduleYaml is the yaml scheduler module configuration representation

type SchedulerManager 

type SchedulerManager struct {
	// BeginAt: Begin time setting
	BeginAt string `yaml:"begin_at" validate:"contains=:"`
	// EndAt: End time setting
	EndAt string `yaml:"end_at" validate:"contains=:"`
	// BeginAtTimestamp: begin timestamp
	BeginAtTimestamp time.Time
	// EndAtTimestamp: end timestamp
	EndAtTimestamp time.Time
	// Activated: quota manager activation boolean
	Activated bool `yaml:"activated"`
}

SchedulerManager data

func (*SchedulerManager) CheckTime 

func (s *SchedulerManager) CheckTime() error

CheckTime check scheduler and pause the bot if it's not working time

func (*SchedulerManager) InitializeScheduler 

func (s *SchedulerManager) InitializeScheduler() error

InitializeScheduler convert string time from config to time.Time instances

type ScrapperConfig 

type ScrapperConfig struct {
	SrcAccounts     []string `yaml:"src_accounts"`
	FetchedAccounts []string
	Quantity        int `yaml:"fetch_quantity" validate:"numeric"`
}

ScrapperConfig store scrapper configuration for user fetching It also store fetched usernames

type ScrapperYaml 

type ScrapperYaml struct {
	Accounts []string `yaml:"src_accounts" validate:"required"`
	Quantity int      `yaml:"fetch_quantity" validate:"numeric,min=1"`
}

ScrapperYaml is the yaml user scrapping configuration representation

type Selenium 

type Selenium struct {
	Instance  *selenium.Service
	Config    *ClientConfig
	Opts      []selenium.ServiceOption
	WebDriver selenium.WebDriver
}

Selenium instance and opts

func (*Selenium) CloseSelenium 

func (s *Selenium) CloseSelenium()

CloseSelenium close webdriver and selenium instance

func (*Selenium) Fatal 

func (s *Selenium) Fatal(msg string, err error)

Fatal closes all selenium stuff and call logrus fatal with error printing

func (*Selenium) GetElement 

func (s *Selenium) GetElement(elementTag, locator string) (selenium.WebElement, error)

GetElement wait for element and then return when it's available

func (*Selenium) GetElements 

func (s *Selenium) GetElements(elementTag, locator string) ([]selenium.WebElement, error)

GetElements wait for elements and then return when they're available

func (*Selenium) InitChromeWebDriver 

func (s *Selenium) InitChromeWebDriver()

InitChromeWebDriver init and launch web driver with Chrome

func (*Selenium) InitFirefoxWebDriver 

func (s *Selenium) InitFirefoxWebDriver()

InitFirefoxWebDriver init and launch web driver with Firefox

func (*Selenium) InitializeSelenium 

func (s *Selenium) InitializeSelenium(clientConfig *ClientConfig)

InitializeSelenium start a Selenium WebDriver server instance (if one is not already running).

func (*Selenium) IsElementPresent 

func (s *Selenium) IsElementPresent(by, value string) bool

IsElementPresent check if an element is present on the current webpage

func (*Selenium) WaitForElement 

func (s *Selenium) WaitForElement(elementTag, locator string, delay int) (bool, error)

WaitForElement search and wait until searched element appears. Delay argument is in seconds.

Source Files

View all Source files

Directories

Path Synopsis
cmd
igopher command
igopher/tui command
internal
tui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.