Samus Aran

Samus Aran è un Bot basato su uzzbot (il quale era già basato su telegram-bot), scritto in Lua con modifiche da parte di Casa con lo scopo di amministrare gruppi e supergruppi.

Samus usa, come altri bot, un sistema di autorizzazioni con funzioni e accessi diversificati.

Alla base di tutto c'è l'utente comune, l'user guest, a lui sono accessibili solo i comandi riservati a tutti, non può svolgere funzioni amministrative e può essere ulteriormente limitato in un gruppo con il comando !whitelist modonly enable.

È la figura amministrativa base, viene automaticamente nominato in questa lista la persona che invita Samus nel gruppo. È valido solo nel gruppo di appartenenza, ha accesso a tutti i comandi amministrativi e può nominare altri moderatori con !promote <@username> o #promote da reply.

Può essere nominato solo da un sudo, può accedere ad alcune funzioni riservate ed è moderatore di qualsiasi gruppo.

I sudo sono gli utenti con i privilegi massimi, possono accedere ad ogni funzionalità. Un sudo non può nominare altri sudo, per diventare sudo bisogna aggiungere il proprio ID manualmente nella configurazione del bot stesso.

Samus è in grado di eseguire vari comandi, sia di moderazione/amministrazione che, anche se meno usati, di svago/utilità.

Qui sono raccolti tutti i plugin a cui Samus ha accesso:

Con il comando !9gag è possibile ricevere un immagine casuale dal portale 9GAG.

Permette di rimuovere automaticamente gli utenti che superano un certo numero di messaggi in un tempo stabilito.

Appena aggiunto il bot al gruppo l'opzione è disabilitata, la si può abilitare con !anti-flood enable e di fabbrica è settato a un limite di 5 messaggi in 5 secondi. Il limite di messaggi può essere modificato con !antiflood maxmsg <num_msg> mentre il tempo può essere modificato con !antiflood timeframe <seconds>, per vedere la configurazione utilizzata si può usare !antiflood status. Si possono aggiungere eccezioni, ovvero utenti che possono sforare il limite di flood senza conseguenze, con il comando !antiflood addexcept/delexcept <user_id> oppure con #addexcept e #delexcept via reply all utente interessato.

Permette di rimuovere automaticamente tutti gli utenti che condividono determinati link, nei supergruppi elimina anche il messaggio di spam, i collegamenti rimossi sono quelli: Telegram (privati e pubblici), adf.ly e sh.st.

Appena aggiunto il bot al gruppo l' opzione è disabilitata, la si può abilitare con !antispam enable. La lista nera dei link, non può essere modificata, ma si possono aggiungere eccezioni, ovvero utenti che possono condividere link senza conseguenze, con il comando !antispam addexcept/delexcept <user_id> oppure con #addspamexcept e #delspamexcept via reply all utente interessato.

Il plugin banhammer è quello che si occupa dell'amministrazione. I comandi base sono: !kickme che serve a farsi bannare dal gruppo ed è l'unico comando utilizzabile da tutti.

!kick <@user/ID> che serve a cacciare un utente tramite ID o UserName, si può utilizzare anche via reply con #kick, nei supergruppi il comando kick equivale al comando ban.

!ban user <@user/ID> come il comando kick, serve per rimuovere un utente, inoltre rende il kick permanente (perciò l'utente se rientra viene automaticamente rimosso), la versione reply del comando è #ban. Per rimuovere il ban si può usare !ban delete <ID> oppure da reply #unban.

!superban user <@user/ID> come il comando ban, ma è valido su tutti i gruppi dove samus è admin, il comando è riservato agli amministratori del bot, attualmente Casa e Len.

È possibile disabilitare i superban in un gruppo, per permettere anche alle persone bannate globalmente di entrare. Il comando per effettuare tale operazione è !superban <enable>/<disable>

Infine abbiamo il comando !whitelist modonly <enable/disable> che permette di bloccare/sbloccare tutti i comandi di samus agli utenti normali, perciò rende i comandi pubblici usabili solo ai moderatori o sup.

Uno dei plugin NSFW, permette di ricevere immagini di seni con !boobs e immagini di sederi con !butts.

Sulla strada dei plugin NSFW permette di ricevere un immagine casuale dal sito Danbooru con l'omonimo comando !danbooru

Permette di eliminare un messaggio via reply sui supergruppi, tramite il comando #delmsg.

Comunica il cambio euro/dollaro tramite il comando !eurusd

Il plugin groupmanager come quello banhammer si occupa dell'amministrazione. I comandi base sono:

!creategroup <group_name> che permette di creare nuovi gruppi, ma è riservato agli amministratori.

!setabout <description> e !about che permettono rispettivamente di settare e vedere la descrizione del gruppo. I comandi !setrules <rules> e !rules hanno le stesse funzioni dei comandi precedenti solo con le regole.

!setname <new name> e !setimage permettono rispettivamente di modificare il nome o l'immagine del gruppo.

!group <lock|unlock> <name|photo|member> permette di bloccare il nome, l'immagine o i membri, in quest'ultimo caso i nuovi utenti verranno rimossi.

Questo comando molto semplice permette di far salutare qualcuno al bot tramite il comando say hello to <name>

È il comando aiuto, elenca tutti i plugin con !help e con !help all mostra anche i relativi comandi seguiti da una descrizione in inglese.

Questi comandi sono riservati ai fedeli dell hydra, con !hailhydra è possibile glorificare l'hydra, con !ruleshydra è possibile vedere le regole dei fedeli.

È possibile riceve l'ID di un utente, anche non presente nel gruppo usando il comando !id <@username> oppure usando il comando #id in risposta a un messaggio inviato dall'utente interessato. Con !id è possibile ricevere le proprie informazioni.

Con !ids chat è possibile stampare tutti gli ID degli utenti in un gruppo, anche in privato se si è almeno moderatori del gruppo/supergruppo in questione. È necessario avere l'ID prima di utilizzare quest'ultima funzione, lo si può ottenere con !id, inviato nel gruppo del quale si vuole la lista.

Con il comando !imdb <movie> è possibile cercare film sul noto database IMDB

Con il comando !join <invite link> gli amministratori del bot possono far joinare il bot in un gruppo a partire dal link, questo comando è utilizzabile solo con i link privati

Con il comando !loc <città> è possibile ricevere un link da google maps con le cordinate della città e uno screenshoot dello stesso.

Questo plugin permette di creare meme a partire da una lista di circa 1134 immagini, la lista può essere esplorata con il comando !meme list che vi darà come output un link hastebin, è possibile cercare l'immagine desiderata manualmente (tramite il sito) oppure con il comando !meme search <parola chiave>.

Una volta scelta l'immagine che fà più per noi, si usa il comando !meme <parola chiave> - <testo superiore> - <testo inferiore> o con !meme <parola chiave> “<testo superiore>” “<testo inferiore>”

Questo plugin si occupa di alcune impostazioni di moderazione e di aggiungere/rimuovere i moderatori.

Con !promote <@username> è possibile aggiungere un nuovo moderatore mentre con !demote <@username> per demotarne uno. Si possono usare via reply anche #promote e #demote. Con !modlist viene mostrata la lista dei moderatori.

Con !modadd è possibile aggiungere il gruppo tra i moderati, cosa che accade automaticamente appena aggiunta samsus, mentre con !modrem si può rimuovere il gruppo dai moderati.

Con il comando !music <nome> è possibile ricevere i link per il download di una canzone.

Questo plugin permette nei supergruppi di mutare gli utenti, eliminando tutti i loro nuovi messaggi.

Con il comando !mute user <@username/ID> è possibile mutare un utente invece con !mute delete <@username/ID> per smutarne uno, in alternativa si possono usare anche #mute e #unmute da reply.

Infine con il comando !mute all è possibile mutare tutti esclusi i moderatori e con il comando !mute undo smutare tutti.

Con il comando !plugins enable <plugin> chat o !plugins disable <plugin> chat è possibile abilitare o disabilitare un determinato plugin nel gruppo.

Con !pokedex <name/id> con nome o id del pokemon, come output vi darà le informazioni di quel pokemon, come il pokedex.

Con !roll <numero di dadi>d<numero di facce> darà un numero casuale generato lanciando degli ipotetici dadi. Un po' come fa Dice Bot.

In scrittura…

Il comando !sos restituisce il link del gruppo di supporto.

Con !stats permette di vedere una statistica minimale, ordinata in base al numero di messaggi scritti dagli utenti.

È possibile eseguire anche il comando da remoto con l'ID del gruppo con !stats chat <id>.

Infine !stats bot mostra le statistiche globali, ma è accessibile solo al sudo.

Con il comando !tex <equation> è possibile convertire un equazione LaTeX in immagine.

Mostra la data e ora del fuso orario scelto, con il comando !time <area>

Tramite il comando !ud <term> è possibile ottenere la descrizione del termine <term> da Urban Dictionary

Il comando !version mostra la versione del bot e alcune informazioni riguardo licenza e sorgenti.

Con !weather <city> è possibile vedere il meteo in una città.

Con il comando !webshot <URL> è possibile avere lo screenshot di un determinato sito.

Con il comando !why <@username>/<id> o #why via reply si può vedere lo stato di un utente, che può essere:

• Utente non bannato o superbannato
• Utente superbannato, puoi disattivare i superban con !superban disable
• Utente bannato (dal gruppo), puoi sbannarlo con !ban delete <ID>

Con !wiki <text> è possibile leggere un estratto di Wikipedia in lingua originale, con !wiki<lang> <text> è possibile leggere estratti da Wikipedia nella lingua desiderata. Con !wiki search <text> è possibile cercare articoli su Wikipedia, con !wiki<lang> search <text> si può cercare su Wikipedia nella lingua desiderata.

Con il comando !xkcd si può ricevere un immagine casuale dal portale xkcd. Se si ha l'ID dell immagine desiderata si può usare !xkcd <id>.

Samus Aran usa tg-cli per connettersi a telegram, questo la rende identica a un normale utente, ma non la rende esente da bug o problemi, la maggior parte dovuti allo stato di abbandono in cui si presentano i sorgenti di tg-cli stesso.

Problema ricorrente degli utenti è la segnalazione per spam anche Samus non ne è immune, infatti può essere spambannata dai gruppi pubblici. Questo significa che Samus non potrebbe scrivere sui gruppi pubblici, ma neanche bannare, cambiare il titolo e altro.

Per ovviare a questo problema si può usare la versione API.

Samus non riceve i messaggi da gruppi con più di 200 membri in quanto, per risparmiare banda, Telegram non recapita più i messaggi in tempo reale e di conseguenza non risponde ad alcun comando.

Per ovviare al problema si poteva aggiungere al gruppo con Samus, oldbirdbot un bot che consegna i messaggi a Samus, questo perché i bot API ricevono i messaggi in qualunque caso. Con l'introduzione della versione API il bot è stato abbandonato.

Ad aprile inizia lo sviluppo di una versione API di Samus, a fine giugno quasi tutti i comandi sono funzionanti e il bot viene diciamo dichiarato idoneo all'uso e quindi fuori dalla fase beta. Non ci sono grandi differenze se non che questa versione non soffre del bug della consegna dei messaggi e che alcuni comandi non sono funzionanti causa limitazioni imposte ai bot API.

Con il rilascio dei sorgenti sono ora in funzione diversi cloni e fork del codice originale. Gli stessi vengono utilizzati da Group Help e Control Panel Group per effettuare l'effettiva eliminazione dei messaggi con il loro complementare MTProto GroupHelpMaster ControlPanelGroupSupport. I sorgenti sono disponibili su github

I cloni attualmente funzionanti di Samus Aran sono: Akuma95 e Akuma95 (Api)

• Italian Admin Telegram Alliance
• Group Help
• Control Panel Group

• Bot ufficiale
• Versione API
• Sorgenti
• Gruppo di supporto