Merge pull request #22 from JABirchall/Timers

Timers Implitation

Author: JABirchall

README.md

@@ -9,7 +9,7 @@ To install this bot all you need to do is download or clone the repository to yo
 First run the command to setup the autoloader
 
 ```
-php composer.phar dump-autoload
+php composer.phar dump-autoload -o
 ```
 
 Edit the Teamspeak and database configs in side the config folder then launch the bot with

app/Plugin.php

@@ -99,10 +99,6 @@ public function __construct($config, $teamSpeak3Bot)
                     $this->version = $value;
                     break;
 
-                case "level":
-                    $this->level = $value;
-                    break;
-
                 case "triggers":
                     $this->triggers = $this->sortByLengthDESC($value);
                     //$this->originalTriggers = $this->triggers;

app/TeamSpeak3Bot.php

@@ -74,6 +74,8 @@ class TeamSpeak3Bot
      */
     private $plugins;
 
+    private $timers;
+
     public static $config;
 
     private $timer;
@@ -137,7 +139,7 @@ public function __construct($username, $password, $host = "127.0.0.1", $port = 1
         $this->carbon = new Carbon;
 
        if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN' && posix_getuid() === 0 && !Self::$config['ignoreWarnings']) {
-           $this->printOutput("[WARNING] Running Nimda as root is bad!");
+           $this->printOutput("[WARNING] Running Nimda as root is dangerous!");
            $this->printOutput("Start anyway? Y/N:", false);
            $response = rtrim(fgets(STDIN));
            if (strcasecmp($response,'y')) {
@@ -147,7 +149,7 @@ public function __construct($username, $password, $host = "127.0.0.1", $port = 1
        }
 
        if($username === "serveradmin" && !Self::$config['ignoreWarnings']) {
-           $this->printOutput("[WARNING] Running Nimda logged in as serveradmin is bad!");
+           $this->printOutput("[WARNING] Running Nimda logged in as serveradmin is dangerous!");
            $this->printOutput("Start anyway? Y/N:", false);
            $response = rtrim(fgets(STDIN));
            if (strcasecmp($response,'y') ) {
@@ -186,6 +188,7 @@ public function run()
         $this->database = new Database;
         $this->setup();
         $this->initializePlugins();
+        $this->initializeTimers();
         $this->register();
         $this->timer->stop();
 
@@ -320,6 +323,13 @@ private function initializePlugins()
         }
     }
 
+    private function initializeTimers()
+    {
+        foreach (glob('./config/timers/*.json') as $file) {
+            $this->loadTimer($file);
+        }
+    }
+
     /**
      * @param $configFile
      *
@@ -388,6 +398,41 @@ private function loadPlugin($configFile)
         return true;
     }
 
+    private function loadTimer($configFile)
+    {
+        $config = $this->parseConfigFile($configFile);
+        $config['configFile'] = $configFile;
+
+        if (!$config) {
+            $this->printOutput("Timer with config file {$configFile} has not been loaded because it doesn't exist.");
+            return false;
+        } elseif (!isset($config['name'])) {
+            $this->printOutput("Timer with config file {$configFile} has not been loaded because it has no name.");
+
+            return false;
+        }
+
+        $this->printOutput(sprintf("%- 80s %s", "Loading Timer [{$config['name']}] by {$config['author']} ", "::"), false, false);
+
+        $config['class'] = \Timer::class . '\\' . $config['name'];
+
+        if (!class_exists($config['class'])) {
+            $this->printOutput("Loading failed because class {$config['class']} doesn't exist.");
+
+            return false;
+        } elseif (!is_a($config['class'], \Timer\TimerContract::class, true)) {
+            $this->printOutput("Loading failed because class {$config['class']} does not implement [TimerContract].");
+
+            return false;
+        }
+
+        $this->timers[$config['name']] = new $config['class']($config, $this);
+
+        $this->printOutput("Success.");
+
+        return true;
+    }
+
     /**
      * @param $file
      *
@@ -510,6 +555,9 @@ public function onTimeout($time, AbstractAdapter $adapter)
             $adapter->request("clientupdate");
             $this->updateList();
         }
+        foreach($this->timers as $timer){
+            $timer->handle();
+        }
 
         if(Self::$config['debug'] === true) {
             $this->printOutput("Nimda runtime: " . Convert::seconds($this->timer->getRuntime()) . ", Using " . Convert::bytes($this->timer->getMemUsage()) . " memory.");

app/Timer.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Jake
+ * Date: 14/02/2017
+ * Time: 14:21
+ */
+
+namespace App;
+
+use \Carbon\Carbon;
+
+
+class Timer
+{
+    protected $time;
+    protected $nextRunTime;
+    public $teamSpeak3Bot;
+
+    public function __construct($config, $teamSpeak3Bot)
+    {
+        $this->time = Carbon::now();
+        $this->nextRunTime = Carbon::now();
+        $this->teamSpeak3Bot = $teamSpeak3Bot;
+        foreach ($config as $name => $value) {
+            switch ($name) {
+                case "name":
+                    $this->name = $value;
+                    break;
+
+                case "author":
+                    $this->author = $value;
+                    break;
+
+                case "description":
+                    $this->description = $value;
+                    break;
+
+                case "version":
+                    $this->version = $value;
+                    break;
+
+                case "interval":
+                    $this->interval = $value;
+                    $this->setNextRunTime();
+                    break;
+
+                case "lastRunTime":
+                    $this->lastRunTime = $this->time->timestamp;
+                    break;
+
+                case "configFile":
+                    $this->configFile = $value;
+                    break;
+
+                default:
+                    $this->CONFIG[$name] = $value;
+                    break;
+            }
+        }
+    }
+
+    public function handle()
+    {
+        if($this->nextRunTime->timestamp <= $this->time->now()->timestamp) {
+            $this->isTriggered();
+            $this->setNextRunTime();
+        }
+    }
+
+    public function setNextRunTime()
+    {
+        $this->nextRunTime->addHours($this->interval['hours'])
+            ->addMinutes($this->interval['minutes'])
+            ->addSeconds($this->interval['seconds']);
+    }
+}

composer.json

@@ -11,7 +11,8 @@
     "psr-4": {
       "App\\": "app/",
       "Plugin\\": "plugins/",
-      "Config\\": "config/"
+      "Config\\": "config/",
+      "Timer\\": "timers/"
     }
   },
   "authors": [

composer.phar

@@ -12,7 +12,7 @@ class TeamSpeak
 
     public static $TS3config = [
         'username' => 'serveradmin',
-        'password' => 'password',
+        'password' => 'QPOcI2i3',
         'host' => '127.0.0.1',
         'port' => 10011,
         'name' => 'Nimda',

config/TeamSpeak.php

@@ -0,0 +1,13 @@
+{
+  "name": "Announcement",
+  "author": "JABirchall",
+  "description": "Sends a server announcement after X time has past",
+  "version": "1.0",
+  "interval": {
+    "hours": 0,
+    "minutes": 1,
+    "seconds": 5
+  },
+
+  "message": "Test"
+}

config/plugins/BadClass.json

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Jake
+ * Date: 14/02/2017
+ * Time: 15:24
+ */
+
+namespace Timer;
+
+use App\Timer;
+
+class Announcement extends Timer implements TimerContract
+{
+    public function isTriggered()
+    {
+        $this->teamSpeak3Bot->node->message('Current Server time is '.$this->time->now()->toTimeString());
+    }
+}

config/plugins/NoInterface.json

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Jake
+ * Date: 14/02/2017
+ * Time: 15:07
+ */
+
+namespace Timer;
+
+
+interface TimerContract
+{
+    public function isTriggered();
+}

config/timers/announcement.json

@@ -55,6 +55,7 @@ class ClassLoader
     private $classMap = array();
     private $classMapAuthoritative = false;
     private $missingClasses = array();
+    private $apcuPrefix;
 
     public function getPrefixes()
     {
@@ -271,6 +272,26 @@ public function isClassMapAuthoritative()
         return $this->classMapAuthoritative;
     }
 
+    /**
+     * APCu prefix to use to cache found/not-found classes, if the extension is enabled.
+     *
+     * @param string|null $apcuPrefix
+     */
+    public function setApcuPrefix($apcuPrefix)
+    {
+        $this->apcuPrefix = function_exists('apcu_fetch') && ini_get('apc.enabled') ? $apcuPrefix : null;
+    }
+
+    /**
+     * The APCu prefix in use, or null if APCu caching is not enabled.
+     *
+     * @return string|null
+     */
+    public function getApcuPrefix()
+    {
+        return $this->apcuPrefix;
+    }
+
     /**
      * Registers this instance as an autoloader.
      *
@@ -313,18 +334,19 @@ public function loadClass($class)
      */
     public function findFile($class)
     {
-        // work around for PHP 5.3.0 - 5.3.2 https://bugs.php.net/50731
-        if ('\\' == $class[0]) {
-            $class = substr($class, 1);
-        }
-
         // class map lookup
         if (isset($this->classMap[$class])) {
             return $this->classMap[$class];
         }
         if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) {
             return false;
         }
+        if (null !== $this->apcuPrefix) {
+            $file = apcu_fetch($this->apcuPrefix.$class, $hit);
+            if ($hit) {
+                return $file;
+            }
+        }
 
         $file = $this->findFileWithExtension($class, '.php');
 
@@ -333,6 +355,10 @@ public function findFile($class)
             $file = $this->findFileWithExtension($class, '.hh');
         }
 
+        if (null !== $this->apcuPrefix) {
+            apcu_add($this->apcuPrefix.$class, $file);
+        }
+
         if (false === $file) {
             // Remember that this class does not exist.
             $this->missingClasses[$class] = true;