force language = english
[GitHub/Stricted/speedport-hybrid-php-api.git] / SpeedportHybrid.class.php
index 319b97d13172b6717a8b4463af0a384c722c80f5..cd68051d11d7da8623791e2396270b2c7e2c987f 100644 (file)
@@ -5,6 +5,12 @@
  * @copyright   2015 Jan Altensen (Stricted)
  */
 class SpeedportHybrid {
+       /**
+        *
+        *
+        */
+       const VERSION = '1.0.2';
+       
        /**
         * password-challenge
         * @var string
@@ -41,25 +47,14 @@ class SpeedportHybrid {
         */
        private $derivedk = '';
        
-       public function __construct ($password, $url = 'http://speedport.ip/') {
+       public function __construct ($url = 'http://speedport.ip/') {
                $this->url = $url;
-               $this->getChallenge();
-               
-               if (empty($this->challenge)) {
-                       throw new Exception('unable to get the challenge from the router');
-               }
-               
-               $login = $this->login($password);
-               
-               if ($login === false) {
-                       throw new Exception('unable to login');
-               }
        }
        
        /**
         * Requests the password-challenge from the router.
         */
-       public function getChallenge () {
+       private function getChallenge () {
                $path = 'data/Login.json';
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'challengev' => 'null');
                $data = $this->sentRequest($path, $fields);
@@ -78,6 +73,12 @@ class SpeedportHybrid {
         * @return      boolean
         */
        public function login ($password) {
+               $this->getChallenge();
+               
+               if (empty($this->challenge)) {
+                       throw new Exception('unable to get the challenge from the router');
+               }
+               
                $path = 'data/Login.json';
                $this->hash = hash('sha256', $this->challenge.':'.$password);
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash);
@@ -95,10 +96,11 @@ class SpeedportHybrid {
                                }
                                
                                // calculate derivedk
-                               if (version_compare(phpversion(), '5.5.0', '<')) {
+                               if (!function_exists("hash_pbkdf2")) {
                                        require_once 'CryptLib/CryptLib.php';
-                                       $pbkdf2 = new CryptLib\Key\Derivation\PBKDF\PBKDF2();
-                                       $this->derivedk = $pbkdf2->derive(hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32);
+                                       $pbkdf2 = new CryptLib\Key\Derivation\PBKDF\PBKDF2(array('hash' => 'sha1'));
+                                       $this->derivedk = bin2hex($pbkdf2->derive(hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32));
+                                       $this->derivedk = substr($this->derivedk, 0, 32);
                                }
                                else {
                                        $this->derivedk = hash_pbkdf2('sha1', hash('sha256', $password), substr($this->challenge, 0, 16), 1000, 32);
@@ -107,30 +109,67 @@ class SpeedportHybrid {
                                // get the csrf_token
                                $this->token = $this->getToken();
                                
-                               return true;
+                               if ($this->checkLogin() === true) {
+                                       return true;
+                               }
                        }
                }
                
                return false;
        }
        
+       /**
+        * check if we are logged in
+        *
+        * @return boolean
+        */
+       public function checkLogin () {
+               if (empty($this->challenge) && empty($this->session)) {
+                       return false;
+               }
+               
+               $path = 'data/SecureStatus.json';
+               $fields = array();
+               $data = $this->sentRequest($path, $fields, true);
+               
+               if (empty($data['body'])) {
+                       throw new Exception('unable to get SecureStatus data');
+               }
+               
+               $json = json_decode($data['body'], true);
+               $json = $this->getValues($json);
+               
+               if ($json['loginstate'] != 1) {
+                       return false;
+               }
+               
+               return true;
+       }
+       
        /**
         * logout
         * 
         * @return      array
         */
        public function logout () {
-               $path = 'data/Login.json';
-               $fields = array('logout' => 'byby');
-               $data = $this->sentRequest($path, $fields);
-               // reset challenge and session
-               $this->challenge = '';
-               $this->session = '';
-               $this->token = "";
+               if ($this->checkLogin() !== true) throw new Exception('you musst be logged in to use this method');
                
-               $json = json_decode($data['body'], true);
-               
-               return $json;
+               $path = 'data/Login.json';
+               $fields = array('csrf_token' =>  $this->token, 'logout' => 'byby');
+               $data = $this->sentRequest($path, $fields, true);
+               if ($this->checkLogin() === false) {
+                       // reset challenge and session
+                       $this->challenge = '';
+                       $this->session = '';
+                       $this->token = "";
+                       
+                       $json = json_decode($data['body'], true);
+                       
+                       return $json;
+               }
+               else {
+                       throw new Exception('logout failed');
+               }
        }
        
        /**
@@ -139,10 +178,11 @@ class SpeedportHybrid {
         * @return      array
         */
        public function reboot () {
+               if ($this->checkLogin() !== true) throw new Exception('you musst be logged in to use this method');
+               
                $path = 'data/Reboot.json';
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'reboot_device' => 'true');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, true);
                
                $json = json_decode($data['body'], true);
                
@@ -155,12 +195,13 @@ class SpeedportHybrid {
         * @param       string  $status
         */
        public function changeConnectionStatus ($status) {
+               if ($this->checkLogin() !== true) throw new Exception('you musst be logged in to use this method');
+               
                $path = 'data/Connect.json';
                
                if ($status == 'online' || $status == 'offline') {
                        $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'req_connect' => $status);
-                       $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-                       $data = $this->sentRequest($path, $fields, $cookie);
+                       $data = $this->sentRequest($path, $fields, true);
                        
                        $json = json_decode($this->decrypt($data['body']), true);
                        
@@ -178,10 +219,11 @@ class SpeedportHybrid {
         * @return      array
         */
        public function getData ($file) {
+               if ($this->checkLogin() !== true && $file != "Status") throw new Exception('you musst be logged in to use this method');
+               
                $path = 'data/'.$file.'.json';
                $fields = array();
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, true);
                
                if (empty($data['body'])) {
                        throw new Exception('unable to get '.$file.' data');
@@ -198,16 +240,7 @@ class SpeedportHybrid {
         * @return      array
         */
        public function getSyslog() {
-               $path = 'data/Syslog.json';
-               $fields = array('exporttype' => '0');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get syslog data');
-               }
-               
-               return explode("\n", $data['body']);
+               return $this->exportData('0');
        }
        
        /**
@@ -216,16 +249,7 @@ class SpeedportHybrid {
         * @return      array
         */
        public function getMissedCalls() {
-               $path = 'data/ExportMissedCalls.json';
-               $fields = array('exporttype' => '1');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get syslog data');
-               }
-               
-               return explode("\n", $data['body']);
+               return $this->exportData('1');
        }
        
        /**
@@ -234,16 +258,7 @@ class SpeedportHybrid {
         * @return      array
         */
        public function getTakenCalls() {
-               $path = 'data/ExportTakenCalls.json';
-               $fields = array('exporttype' => '2');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
-               
-               if (empty($data['body'])) {
-                       throw new Exception('unable to get syslog data');
-               }
-               
-               return explode("\n", $data['body']);
+               return $this->exportData('2');
        }
        
        /**
@@ -252,13 +267,23 @@ class SpeedportHybrid {
         * @return      array
         */
        public function getDialedCalls() {
+               return $this->exportData('3');
+       }
+       
+       /**
+        * export data from router
+        * 
+        * @return      array
+        */
+       private function exportData ($type) {
+               if ($this->checkLogin() !== true) throw new Exception('you musst be logged in to use this method');
+               
                $path = 'data/ExportDialedCalls.json';
-               $fields = array('exporttype' => '3');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $fields = array('exporttype' => $type);
+               $data = $this->sentRequest($path, $fields, true);
                
                if (empty($data['body'])) {
-                       throw new Exception('unable to get syslog data');
+                       throw new Exception('unable to get export data');
                }
                
                return explode("\n", $data['body']);
@@ -270,11 +295,12 @@ class SpeedportHybrid {
         * @return      array
         */
        public function reconnectLte () {
+               if ($this->checkLogin() !== true) throw new Exception('you musst be logged in to use this method');
+               
                $path = 'data/modules.json';
                $fields = array('csrf_token' => $this->token, 'lte_reconn' => '1');
                $fields = $this->encrypt($fields);
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie, 2);
+               $data = $this->sentRequest($path, $fields, true, 2);
                $json = json_decode($data['body'], true);
                
                return $json;
@@ -287,10 +313,11 @@ class SpeedportHybrid {
         * @return      array
         */
        public function resetToFactoryDefault () {
+               if ($this->checkLogin() !== true) throw new Exception('you musst be logged in to use this method');
+               
                $path = 'data/resetAllSetting.json';
                $fields = array('csrf_token' => 'nulltoken', 'showpw' => 0, 'password' => $this->hash, 'reset_all' => 'true');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, true);
                $json = json_decode($data['body'], true);
                
                return $json;
@@ -303,10 +330,11 @@ class SpeedportHybrid {
         * @return      array
         */
        public function checkFirmware () {
+               if ($this->checkLogin() !== true) throw new Exception('you musst be logged in to use this method');
+               
                $path = 'data/checkfirmware.json';
                $fields = array('checkfirmware' => 'true');
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, true);
                
                if (empty($data['body'])) {
                        throw new Exception('unable to get checkfirmware data');
@@ -387,8 +415,8 @@ class SpeedportHybrid {
         * @param       integer $count
         * @return      array
         */
-       private function sentRequest ($path, $fields, $cookie = '', $count = 0) {
-               $url = $this->url.$path;
+       private function sentRequest ($path, $fields, $cookie = false, $count = 0) {
+               $url = $this->url.$path.'?lang=en';
                $ch = curl_init();
                curl_setopt($ch, CURLOPT_URL, $url);
                
@@ -403,8 +431,8 @@ class SpeedportHybrid {
                        }
                }
                
-               if (!empty($cookie)) {
-                       curl_setopt($ch, CURLOPT_COOKIE, $cookie);
+               if ($cookie === true) {
+                       curl_setopt($ch, CURLOPT_COOKIE, 'challengev='.$this->challenge.'; '.$this->session);
                }
                
                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
@@ -422,7 +450,6 @@ class SpeedportHybrid {
                curl_close($ch);
                
                // fix invalid json
-               
                $body = preg_replace("/(\r\n)|(\r)/", "\n", $body);
                $body = preg_replace('/\'/i', '"', $body);
                $body = preg_replace("/\[\s+\]/i", '[ {} ]', $body);
@@ -437,10 +464,11 @@ class SpeedportHybrid {
         * @return      string
         */
        private function getToken () {
-               $path = 'html/content/overview/index.html?lang=de';
+               if ($this->checkLogin() !== true) throw new Exception('you musst be logged in to use this method');
+               
+               $path = 'html/content/overview/index.html';
                $fields = array();
-               $cookie = 'challengev='.$this->challenge.'; '.$this->session;
-               $data = $this->sentRequest($path, $fields, $cookie);
+               $data = $this->sentRequest($path, $fields, true);
                
                if (empty($data['body'])) {
                        throw new Exception('unable to get csrf_token');