171 lines
9.7 KiB
Python
171 lines
9.7 KiB
Python
"""
|
|
Plugin for providing a command to display the list of available commands and their descriptions.
|
|
"""
|
|
|
|
import logging
|
|
import simplematrixbotlib as botlib
|
|
|
|
async def handle_command(room, message, bot, prefix, config):
|
|
"""
|
|
Function to handle the !help command.
|
|
|
|
Args:
|
|
room (Room): The Matrix room where the command was invoked.
|
|
message (RoomMessage): The message object containing the command.
|
|
bot (MatrixBot): The Matrix bot instance.
|
|
prefix (str): The command prefix.
|
|
config (dict): The bot's configuration.
|
|
|
|
Returns:
|
|
None
|
|
"""
|
|
match = botlib.MessageMatch(room, message, bot, prefix)
|
|
if match.is_not_from_this_bot() and match.prefix() and match.command("help"):
|
|
logging.info("Fetching command help documentation")
|
|
commands_message = """
|
|
<details><summary><strong>🍄 Funguy Bot Commands 🍄</strong></summary>
|
|
<p>
|
|
<details><summary>📖 <strong>!help</strong></summary>
|
|
<p>Displays comprehensive help documentation for all available commands with usage examples.</p>
|
|
</details>
|
|
|
|
<details><summary>🔌 <strong>!plugins</strong></summary>
|
|
<p>Lists all loaded plugins along with their descriptions in alphabetical order.</p>
|
|
</details>
|
|
|
|
<details><summary>🃏 <strong>!fortune</strong></summary>
|
|
<p>Returns a random fortune message. Executes the `/usr/games/fortune` utility and sends the output as a message to the chat room.</p>
|
|
</details>
|
|
|
|
<details><summary>⏰ <strong>!date</strong></summary>
|
|
<p>Displays the current date and time. Fetches the current date and time using Python's `datetime` module and sends it in a formatted message with proper ordinal suffixes to the chat room.</p>
|
|
</details>
|
|
|
|
<details><summary>💻 <strong>!proxy</strong></summary>
|
|
<p>Retrieves a tested/working random SOCKS5 proxy. Fetches a list of SOCKS5 proxies from public sources, tests their availability, and sends the first working proxy with latency information to the chat room. Caches working proxies for faster access.</p>
|
|
</details>
|
|
|
|
<details><summary>📶 <strong>!isup [domain/ip]</strong></summary>
|
|
<p>Checks if the specified domain or IP address is reachable. Performs DNS resolution and checks HTTP/HTTPS service availability. Reports successful DNS resolution and service status.</p>
|
|
</details>
|
|
|
|
<details><summary>☯ <strong>!karma [user]</strong></summary>
|
|
<p>Retrieves the karma points for the specified user. Retrieves the karma points for the specified user from a SQLite database and sends them as a message to the chat room.</p>
|
|
</details>
|
|
|
|
<details><summary>⇧ <strong>!karma [user] up</strong></summary>
|
|
<p>Increases the karma points for the specified user by 1. Increases the karma points for the specified user by 1 in the database and sends the updated points as a message to the chat room. Users cannot modify their own karma.</p>
|
|
</details>
|
|
|
|
<details><summary>⇩ <strong>!karma [user] down</strong></summary>
|
|
<p>Decreases the karma points for the specified user by 1. Decreases the karma points for the specified user by 1 in the database and sends the updated points as a message to the chat room. Users cannot modify their own karma.</p>
|
|
</details>
|
|
|
|
<details><summary>🌧️ <strong>!weather [location]</strong></summary>
|
|
<p>Fetches current weather information for any location using OpenWeatherMap API. Shows temperature (Celsius/Fahrenheit), conditions, humidity, wind speed, and weather emojis. Requires OPENWEATHER_API_KEY environment variable.</p>
|
|
</details>
|
|
|
|
<details><summary>📖 <strong>!ud [term] [index]</strong></summary>
|
|
<p>Fetches definitions from Urban Dictionary. Use without arguments for random definition, or specify term and optional index number. Shows definition, example, author, votes, and permalink.</p>
|
|
</details>
|
|
|
|
<details><summary>🔍 <strong>!dns [domain]</strong></summary>
|
|
<p>Performs comprehensive DNS reconnaissance on a domain. Queries multiple DNS record types including A, AAAA, MX, NS, TXT, CNAME, SOA, and SRV records. Validates domain format and provides formatted results.</p>
|
|
</details>
|
|
|
|
<details><summary>💰 <strong>!btc</strong></summary>
|
|
<p>Fetches the current Bitcoin price in USD from bitcointicker.co API. Shows real-time BTC/USD price with proper formatting. Includes error handling for API timeouts and data parsing issues.</p>
|
|
</details>
|
|
|
|
<details><summary>🔍 <strong>!shodan [command] [query]</strong></summary>
|
|
<p>Shodan.io integration for security reconnaissance and threat intelligence.</p>
|
|
<p><strong>Commands:</strong></p>
|
|
<ul>
|
|
<li><code>!shodan ip <ip_address></code> - Detailed IP information (services, ports, banners)</li>
|
|
<li><code>!shodan search <query></code> - Search Shodan database with filters</li>
|
|
<li><code>!shodan host <domain></code> - Host information and subdomain enumeration</li>
|
|
<li><code>!shodan count <query></code> - Count results with geographic/organization breakdown</li>
|
|
<li><code>!shodan test</code> - Test API connection and debug queries</li>
|
|
</ul>
|
|
<p><strong>Search Examples:</strong></p>
|
|
<ul>
|
|
<li><code>!shodan search apache</code></li>
|
|
<li><code>!shodan search "port:22 country:US"</code></li>
|
|
<li><code>!shodan search "product:nginx"</code></li>
|
|
<li><code>!shodan search "net:192.168.1.0/24"</code></li>
|
|
<li><code>!shodan search "http.title:'admin'"</code></li>
|
|
</ul>
|
|
<p><strong>Common Filters:</strong> country, city, port, product, os, org, net, has_ssl, http.title</p>
|
|
<p><em>Requires SHODAN_KEY environment variable</em></p>
|
|
</details>
|
|
|
|
<details><summary>📸 <strong>!sd [prompt]</strong></summary>
|
|
<p>Generates images using self-hosted Stable Diffusion. Supports options: --steps, --cfg, --h, --w, --neg, --sampler. Uses queuing system to handle multiple requests. See available options using just '!sd'.</p>
|
|
</details>
|
|
|
|
<details><summary>📄 <strong>!text [prompt]</strong></summary>
|
|
<p>Generates text using Ollama's Mistral 7B Instruct model. Options: --max_tokens, --temperature. Uses queuing system for sequential processing.</p>
|
|
</details>
|
|
|
|
<details><summary>📰 <strong>!xkcd</strong></summary>
|
|
<p>Fetches and displays a random XKCD comic. Downloads comic image and sends it directly to the chat room.</p>
|
|
</details>
|
|
|
|
<details><summary>🎬 <strong>YouTube Features</strong></summary>
|
|
<p>Automatic preview when YouTube links are posted. Shows video info, description, and attempts to fetch lyrics. Also supports !yt [search terms] for direct YouTube searching.</p>
|
|
</details>
|
|
|
|
<details><summary>⏱️ <strong>!cron [add|remove] [room_id] [cron_entry] [command]</strong></summary>
|
|
<p>Schedule automated commands using cron syntax. Add or remove cron jobs for specific rooms and commands.</p>
|
|
</details>
|
|
|
|
<details><summary>🔧 <strong>Admin Commands</strong></summary>
|
|
<p>
|
|
<strong>!set [option] [value]</strong> - Set configuration options (admin_user, prefix)<br>
|
|
<strong>!get [option]</strong> - Get configuration values<br>
|
|
<strong>!saveconf</strong> - Save current configuration<br>
|
|
<strong>!loadconf</strong> - Load saved configuration<br>
|
|
<strong>!show</strong> - Display current configuration<br>
|
|
<strong>!reset</strong> - Reset configuration to defaults<br>
|
|
<strong>!load [plugin]</strong> - Load a plugin<br>
|
|
<strong>!unload [plugin]</strong> - Unload a plugin<br>
|
|
<strong>!reload</strong> - Reload all plugins<br>
|
|
<strong>!disable [plugin] [room_id]</strong> - Disable a plugin for specific room<br>
|
|
<strong>!enable [plugin] [room_id]</strong> - Enable a plugin for specific room<br>
|
|
<strong>!rehash</strong> - Reload configuration<br>
|
|
<em>Note: Admin commands require admin_user privileges</em>
|
|
</p>
|
|
</details>
|
|
</p>
|
|
</details>
|
|
|
|
<details><summary><strong>🤖 Funguy Bot AI Commands</strong></summary>
|
|
<p>
|
|
<strong>Creative & Writing</strong>: !write, !script, !author, !poem, !rap, !story, !comic, !motiv, !debate, !crit, !litcrit<br>
|
|
<strong>Technical</strong>: !tech, !dev, !py, !php, !regex, !math, !web, !it, !security, !ai, !ml, !data, !game, !gaming<br>
|
|
<strong>Professional</strong>: !seo, !recruit, !coach, !devrel, !sales, !ceo, !mgmt, !startup, !invest, !fin, !acad<br>
|
|
<strong>Educational</strong>: !tutor, !teach, !edu, !hist, !astro, !chem, !psych, !meditate, !socrat, !philos<br>
|
|
<strong>Lifestyle</strong>: !fit, !health, !diet, !cook, !travel, !art, !music, !film, !selfhelp<br>
|
|
<strong>Specialized</strong>: !legal, !medical, !realest, !auto, !fashion, !design, !interior, !florist<br>
|
|
<strong>Communication</strong>: !pron, !spk, !speak, !eloc, !comm, !msg, !langdet<br>
|
|
<strong>Business</strong>: !eth, !browse, !search, !create, !review, !curation, !domain<br>
|
|
<strong>Entertainment</strong>: !char, !adv, !advgame, !esc, !title, !stats, !prompt<br>
|
|
<strong>Technical Specialties</strong>: !intv, !plag, !trv, !foot, !rel, !etymo, !magic, !counsel, !behavior, !mh, !log, !dental, !acc, !chef, !tea, !telemed, !law, !trans, !chess, !time, !dream, !r, !emergency, !worksheet, !test, !create, !guide, !diag, !therapy, !gen, !drunk, !rec, !techtrans, !proof, !spirit, !friend, !chat, !wiki, !kanji, !note, !enhance, !nav, !hypno, !critic, !comp, !journo, !pscoach, !makeup, !childcare, !writing, !syn, !shop, !dining<br>
|
|
|
|
<em>Each AI command uses specialized prompts optimized for different domains and interfaces with local AI models. Consult ai.json</em>
|
|
</p>
|
|
</details>
|
|
|
|
<details><summary>🌟 <strong>Funguy Bot Credits</strong></summary>
|
|
<p>
|
|
<strong>🧙♂️ Creator & Developer</strong>: HB is the author of 🍄Funguy Bot🍄. (@hashborgir:mozilla.org)<br>
|
|
<strong>🚀 Development Context</strong>: Created during recovery from two-level cervical spinal surgery (CDA Cervical Discectomy and Disc Arthroplasty)<br>
|
|
<br>
|
|
<strong>Join our Matrix Room</strong>: <a href="https://matrix.to/#/#selfhosting:mozilla.org">Self-hosting | Security | Sysadmin | Homelab | Programming</a>
|
|
</p>
|
|
</details>
|
|
"""
|
|
|
|
await bot.api.send_markdown_message(room.room_id, commands_message)
|
|
logging.info("Sent help documentation to the room")
|