Overview

Namespaces

  • Budabot
    • Core
      • Modules
    • User
      • Modules
  • None
  • Tyrence
    • Modules

Classes

  • AccessLevel
  • Budabot\Core\AccessManager
  • Budabot\Core\AdminManager
  • Budabot\Core\AOChat
  • Budabot\Core\AOChatPacket
  • Budabot\Core\AOChatQueue
  • Budabot\Core\AOExtMsg
  • Budabot\Core\AsyncHttp
  • Budabot\Core\AutoInject
  • Budabot\Core\BotRunner
  • Budabot\Core\Budabot
  • Budabot\Core\BuddylistManager
  • Budabot\Core\CacheManager
  • Budabot\Core\CacheResult
  • Budabot\Core\ClassLoader
  • Budabot\Core\ColorSettingHandler
  • Budabot\Core\CommandAlias
  • Budabot\Core\CommandManager
  • Budabot\Core\ConfigFile
  • Budabot\Core\DB
  • Budabot\Core\DBRow
  • Budabot\Core\EventLoop
  • Budabot\Core\EventManager
  • Budabot\Core\GuildChannelCommandReply
  • Budabot\Core\GuildManager
  • Budabot\Core\HelpManager
  • Budabot\Core\Http
  • Budabot\Core\HttpRequest
  • Budabot\Core\LegacyLogger
  • Budabot\Core\LimitsController
  • Budabot\Core\LoggerWrapper
  • Budabot\Core\MMDBParser
  • Budabot\Core\Modules\AdminController
  • Budabot\Core\Modules\AliasController
  • Budabot\Core\Modules\AltInfo
  • Budabot\Core\Modules\AltsController
  • Budabot\Core\Modules\BanController
  • Budabot\Core\Modules\BuddylistController
  • Budabot\Core\Modules\ColorsController
  • Budabot\Core\Modules\CommandlistController
  • Budabot\Core\Modules\CommandSearchController
  • Budabot\Core\Modules\ConfigController
  • Budabot\Core\Modules\EventlistController
  • Budabot\Core\Modules\HelpController
  • Budabot\Core\Modules\LogsController
  • Budabot\Core\Modules\PlayerLookupController
  • Budabot\Core\Modules\ProfileCommandReply
  • Budabot\Core\Modules\ProfileController
  • Budabot\Core\Modules\SettingsController
  • Budabot\Core\Modules\SQLController
  • Budabot\Core\Modules\SystemController
  • Budabot\Core\Modules\UsageController
  • Budabot\Core\Modules\WhitelistController
  • Budabot\Core\NumberSettingHandler
  • Budabot\Core\OptionsSettingHandler
  • Budabot\Core\PlayerHistory
  • Budabot\Core\PlayerHistoryManager
  • Budabot\Core\PlayerManager
  • Budabot\Core\Preferences
  • Budabot\Core\PrivateChannelCommandReply
  • Budabot\Core\PrivateMessageCommandReply
  • Budabot\Core\Registry
  • Budabot\Core\SettingHandler
  • Budabot\Core\SettingManager
  • Budabot\Core\SettingObject
  • Budabot\Core\SocketManager
  • Budabot\Core\SocketNotifier
  • Budabot\Core\SubcommandManager
  • Budabot\Core\Text
  • Budabot\Core\TextSettingHandler
  • Budabot\Core\Timer
  • Budabot\Core\TimerEvent
  • Budabot\Core\TimeSettingHandler
  • Budabot\Core\Util
  • Budabot\Core\xml
  • Budabot\User\Modules\AlienArmorController
  • Budabot\User\Modules\AlienBioController
  • Budabot\User\Modules\AlienMiscController
  • Budabot\User\Modules\AOSpeakController
  • Budabot\User\Modules\AOUController
  • Budabot\User\Modules\AXPController
  • Budabot\User\Modules\BankController
  • Budabot\User\Modules\BosslootController
  • Budabot\User\Modules\BroadcastController
  • Budabot\User\Modules\BuffPerksController
  • Budabot\User\Modules\CacheController
  • Budabot\User\Modules\ChatAssistController
  • Budabot\User\Modules\ChatCheckController
  • Budabot\User\Modules\ChatLeaderController
  • Budabot\User\Modules\ChatRallyController
  • Budabot\User\Modules\ChatSayController
  • Budabot\User\Modules\ChatTopicController
  • Budabot\User\Modules\CityWaveController
  • Budabot\User\Modules\CloakController
  • Budabot\User\Modules\ClusterController
  • Budabot\User\Modules\CountdownController
  • Budabot\User\Modules\DevController
  • Budabot\User\Modules\DingController
  • Budabot\User\Modules\EventsController
  • Budabot\User\Modules\FightController
  • Budabot\User\Modules\FindOrgController
  • Budabot\User\Modules\FindPlayerController
  • Budabot\User\Modules\FunController
  • Budabot\User\Modules\GitController
  • Budabot\User\Modules\GuideController
  • Budabot\User\Modules\GuildController
  • Budabot\User\Modules\HelpbotController
  • Budabot\User\Modules\HtmlDecodeController
  • Budabot\User\Modules\ImplantController
  • Budabot\User\Modules\ImplantDesignerController
  • Budabot\User\Modules\InactiveMemberController
  • Budabot\User\Modules\ItemsController
  • Budabot\User\Modules\KillOnSightController
  • Budabot\User\Modules\LevelController
  • Budabot\User\Modules\LinksController
  • Budabot\User\Modules\LootListsController
  • Budabot\User\Modules\MdbController
  • Budabot\User\Modules\MessageInfoCommandReply
  • Budabot\User\Modules\MockCommandReply
  • Budabot\User\Modules\NanoController
  • Budabot\User\Modules\NewsController
  • Budabot\User\Modules\NotesController
  • Budabot\User\Modules\OnlineController
  • Budabot\User\Modules\OrgHistoryController
  • Budabot\User\Modules\OrglistController
  • Budabot\User\Modules\OrgMembersController
  • Budabot\User\Modules\OSController
  • Budabot\User\Modules\PlayerHistoryController
  • Budabot\User\Modules\PlayfieldController
  • Budabot\User\Modules\PocketbossController
  • Budabot\User\Modules\PremadeImplantController
  • Budabot\User\Modules\PrivateChannelController
  • Budabot\User\Modules\QuoteController
  • Budabot\User\Modules\RaffleController
  • Budabot\User\Modules\RaidController
  • Budabot\User\Modules\RandomController
  • Budabot\User\Modules\RecipeController
  • Budabot\User\Modules\RelayController
  • Budabot\User\Modules\ReputationController
  • Budabot\User\Modules\ResearchController
  • Budabot\User\Modules\RunAsController
  • Budabot\User\Modules\SendTellController
  • Budabot\User\Modules\ShoppingController
  • Budabot\User\Modules\SilenceController
  • Budabot\User\Modules\SkillsController
  • Budabot\User\Modules\SpiritsController
  • Budabot\User\Modules\StopwatchController
  • Budabot\User\Modules\Teamspeak3
  • Budabot\User\Modules\TeamspeakController
  • Budabot\User\Modules\TestController
  • Budabot\User\Modules\TimeController
  • Budabot\User\Modules\TimerController
  • Budabot\User\Modules\TimezoneController
  • Budabot\User\Modules\TowerController
  • Budabot\User\Modules\TrackerController
  • Budabot\User\Modules\TrickleController
  • Budabot\User\Modules\UnixtimeController
  • Budabot\User\Modules\VoteController
  • Budabot\User\Modules\WeatherController
  • Budabot\User\Modules\WhatBuffsController
  • Budabot\User\Modules\WhereisController
  • Budabot\User\Modules\WhoisController
  • Budabot\User\Modules\WhoisOrgController
  • Budabot\User\Modules\WhompahController
  • Command
  • DefaultStatus
  • DefineCommand
  • Description
  • Event
  • HandlesCommand
  • Help
  • Inject
  • Instance
  • Intoptions
  • Matches
  • Options
  • Setting
  • Setup
  • Type
  • Tyrence\Modules\DemoResponseCommandReply
  • Tyrence\Modules\SameChannelResponseController
  • Visibility

Interfaces

  • Budabot\Core\CommandReply

Exceptions

  • Budabot\Core\InvalidHttpRequest
  • Budabot\Core\SQLException
  • Budabot\Core\StopExecutionException

Functions

  • Budabot\Core\isWindows
  • Budabot\Core\Modules\read_input
  • Overview
  • Namespace
  • Class
  1: <?php
  2: 
  3: namespace Budabot\User\Modules;
  4: 
  5: use Budabot\Core\StopExecutionException;
  6: 
  7: /**
  8:  * Authors: 
  9:  *  - Tyrence (RK2)
 10:  *
 11:  * @Instance
 12:  *
 13:  * Commands this controller contains:
 14:  *  @DefineCommand(
 15:  *      command     = 'broadcast', 
 16:  *      accessLevel = 'mod', 
 17:  *      description = 'View/edit the broadcast bots list', 
 18:  *      help        = 'broadcast.txt'
 19:  *  )
 20:  */
 21: class BroadcastController {
 22: 
 23:     /**
 24:      * Name of the module.
 25:      * Set automatically by module loader.
 26:      */
 27:     public $moduleName;
 28:     
 29:     /** @Logger */
 30:     public $logger;
 31:     
 32:     /** @Inject */
 33:     public $db;
 34:     
 35:     /** @Inject */
 36:     public $chatBot;
 37: 
 38:     /** @Inject */
 39:     public $settingManager;
 40:     
 41:     /** @Inject */
 42:     public $whitelistController;
 43:     
 44:     /** @Inject */
 45:     public $text;
 46:     
 47:     /** @Inject */
 48:     public $util;
 49:     
 50:     private $broadcastList = array();
 51:     
 52:     /**
 53:      * This handler is called on bot startup.
 54:      * @Setup
 55:      */
 56:     public function setup() {
 57:         $this->db->loadSQLFile($this->moduleName, 'broadcast');
 58:         
 59:         $this->loadBroadcastListIntoMemory();
 60:         
 61:         $this->settingManager->add($this->moduleName, "broadcast_to_guild", "Send broadcast message to guild channel", "edit", "options", "1", "true;false", "1;0");
 62:         $this->settingManager->add($this->moduleName, "broadcast_to_privchan", "Send broadcast message to private channel", "edit", "options", "0", "true;false", "1;0");
 63:     }
 64:     
 65:     private function loadBroadcastListIntoMemory() {
 66:         //Upload broadcast bots to memory
 67:         $data = $this->db->query("SELECT * FROM broadcast_<myname>");
 68:         $this->broadcastList = array();
 69:         forEach ($data as $row) {
 70:             $this->broadcastList[$row->name] = $row;
 71:         }
 72:     }
 73:     
 74:     /**
 75:      * @HandlesCommand("broadcast")
 76:      * @Matches("/^broadcast$/i")
 77:      */
 78:     public function broadcastListCommand($message, $channel, $sender, $sendto, $args) {
 79:         $blob = '';
 80: 
 81:         $sql = "SELECT * FROM broadcast_<myname> ORDER BY dt DESC";
 82:         $data = $this->db->query($sql);
 83:         forEach ($data as $row) {
 84:             $remove = $this->text->makeChatcmd('Remove', "/tell <myname> <symbol>broadcast rem $row->name");
 85:             $dt = $this->util->date($row->dt);
 86:             $blob .= "<highlight>{$row->name}<end> [added by {$row->added_by}] {$dt} {$remove}\n";
 87:         }
 88: 
 89:         if (count($data) == 0) {
 90:             $msg = "No bots are on the broadcast list.";
 91:         } else {
 92:             $msg = $this->text->makeBlob('Broadcast Bots', $blob);
 93:         }
 94: 
 95:         $sendto->reply($msg);
 96:     }
 97: 
 98:     /**
 99:      * @HandlesCommand("broadcast")
100:      * @Matches("/^broadcast add (.+)$/i")
101:      */
102:     public function broadcastAddCommand($message, $channel, $sender, $sendto, $args) {
103:         $name = ucfirst(strtolower($args[1]));
104: 
105:         $charid = $this->chatBot->get_uid($name);
106:         if ($charid == false) {
107:             $sendto->reply("'$name' is not a valid character name.");
108:             return;
109:         }
110: 
111:         if (isset($this->broadcastList[$name])) {
112:             $sendto->reply("'$name' is already on the broadcast bot list.");
113:             return;
114:         }
115: 
116:         $this->db->exec("INSERT INTO broadcast_<myname> (`name`, `added_by`, `dt`) VALUES (?, ?, ?)", $name, $sender, time());
117:         $msg = "Broadcast bot added successfully.";
118: 
119:         // reload broadcast bot list
120:         $this->loadBroadcastListIntoMemory();
121: 
122:         $this->whitelistController->add($name, $sender . " (bot)");
123: 
124:         $sendto->reply($msg);
125:     }
126:     
127:     /**
128:      * @HandlesCommand("broadcast")
129:      * @Matches("/^broadcast (rem|remove) (.+)$/i")
130:      */
131:     public function broadcastRemoveCommand($message, $channel, $sender, $sendto, $args) {
132:         $name = ucfirst(strtolower($args[2]));
133: 
134:         if (!isset($this->broadcastList[$name])) {
135:             $sendto->reply("'$name' is not on the broadcast bot list.");
136:             return;
137:         }
138: 
139:         $this->db->exec("DELETE FROM broadcast_<myname> WHERE name = ?", $name);
140:         $msg = "Broadcast bot removed successfully.";
141: 
142:         // reload broadcast bot list
143:         $this->loadBroadcastListIntoMemory();
144: 
145:         $this->whitelistController->remove($name);
146: 
147:         $sendto->reply($msg);
148:     }
149: 
150:     /**
151:      * @Event("msg")
152:      * @Description("Relays incoming messages to the guild/private channel")
153:      */
154:     public function incomingMessageEvent($eventObj) {
155:         if ($this->isValidBroadcastSender($eventObj->sender)) {
156:             $this->processIncomingMessage($eventObj->sender, $eventObj->message);
157:             
158:             // keeps the bot from sending a message back
159:             throw new StopExecutionException();
160:         }
161:     }
162:     
163:     public function isValidBroadcastSender($sender) {
164:         return isset($this->broadcastList[$sender]);
165:     }
166: 
167:     public function processIncomingMessage($sender, $message) {
168:         $msg = "[$sender]: $message";
169: 
170:         if ($this->settingManager->get('broadcast_to_guild')) {
171:             $this->chatBot->sendGuild($msg, true);
172:         }
173:         if ($this->settingManager->get('broadcast_to_privchan')) {
174:             $this->chatBot->sendPrivate($msg, true);
175:         }
176:     }
177: }
178: 
Budabot 4 Docs API documentation generated by ApiGen