Improvements to the code

pitbulk · pitbulk · commit 52d583d94039 · 2017-12-01T22:02:22.000+01:00
diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
 
 [![Build Status](https://api.travis-ci.org/onelogin/php-saml.png?branch=master)](http://travis-ci.org/onelogin/php-saml) [![Coverage Status](https://coveralls.io/repos/onelogin/php-saml/badge.png)](https://coveralls.io/r/onelogin/php-saml) [![License](https://poser.pugx.org/onelogin/php-saml/license.png)](https://packagist.org/packages/onelogin/php-saml)
 
-Add SAML support to your PHP softwares using this library.
-Forget those complicated libraries and use that open source library provided
+Add SAML support to your PHP software using this library.
+Forget those complicated libraries and use this open source library provided
 and supported by OneLogin Inc.
 
 
@@ -688,7 +688,7 @@ unset($_SESSION['AuthNRequestID']);
 $errors = $auth->getErrors();
 
 if (!empty($errors)) {
-    print_r('<p>'.implode(', ', $errors).'</p>');
+    echo '<p>' . implode(', ', $errors) . '</p>';
     exit();
 }
 
@@ -712,8 +712,8 @@ $nameId = $_SESSION['samlNameId'];
 echo '<h1>Identified user: '. htmlentities($nameId) .'</h1>';
 
 if (!empty($attributes)) {
-    echo '<h2>'._('User attributes:').'</h2>';
-    echo '<table><thead><th>'._('Name').'</th><th>'._('Values').'</th></thead><tbody>';
+    echo '<h2>' . _('User attributes:') . '</h2>';
+    echo '<table><thead><th>' . _('Name') . '</th><th>' . _('Values') . '</th></thead><tbody>';
     foreach ($attributes as $attributeName => $attributeValues) {
         echo '<tr><td>' . htmlentities($attributeName) . '</td><td><ul>';
         foreach ($attributeValues as $attributeValue) {
@@ -827,9 +827,9 @@ $auth->processSLO(false, $requestID);
 $errors = $auth->getErrors();
 
 if (empty($errors)) {
-    print_r('Sucessfully logged out');
+    echo 'Sucessfully logged out';
 } else {
-    print_r(implode(', ', $errors));
+    echo implode(', ', $errors);
 }
 ```
 
@@ -971,7 +971,7 @@ if (isset($_SESSION['samlNameIdFormat'])) {
     $nameIdFormat = $_SESSION['samlNameIdFormat'];
 }
 $auth->logout($returnTo, $paramters, $nameId, $sessionIndex, false, $nameIdFormat);
-``` 
+```
 
 If a match on the future LogoutResponse ID and the LogoutRequest ID to be sent is required, that LogoutRequest ID must to be extracted and stored.
 
@@ -999,8 +999,7 @@ session_start();    // Initialize the session, we do that because
                     // Note that processResponse and processSLO
                     // methods could manipulate/close that session
 
-require_once dirname(dirname(__FILE__)).'/_toolkit_loader.php'; // Load Saml2 and
-                                                                // external libs
+require_once dirname(__DIR__) . '/_toolkit_loader.php'; // Load Saml2 and xmlseclibs
 require_once 'settings.php';    // Load the setting info as an Array
 
 $auth = new OneLogin_Saml2_Auth($settingsInfo);  // Initialize the SP SAML instance
@@ -1021,11 +1020,11 @@ if (isset($_GET['sso'])) {    // SSO action.  Will send an AuthNRequest to the I
                                    // that could took place during the process
 
     if (!empty($errors)) {
-        print_r('<p>'.implode(', ', $errors).'</p>');
+        echo '<p>' . implode(', ', $errors) . '</p>';
     }
                                           // This check if the response was
     if (!$auth->isAuthenticated()) {      // sucessfully validated and the user
-        echo "<p>Not authenticated</p>";  // data retrieved or not
+        echo '<p>Not authenticated</p>';  // data retrieved or not
         exit();
     }
 
@@ -1037,9 +1036,9 @@ if (isset($_GET['sso'])) {    // SSO action.  Will send an AuthNRequest to the I
     $auth->processSLO();            // Process the Logout Request & Logout Response
     $errors = $auth->getErrors(); // Retrieves possible validation errors
     if (empty($errors)) {
-        print_r('<p>Sucessfully logged out</p>');
+        echo '<p>Sucessfully logged out</p>';
     } else {
-        print_r('<p>'.implode(', ', $errors).'</p>');
+        echo '<p>' . implode(', ', $errors) . '</p>';
     }
 }
 
diff --git a/_toolkit_loader.php b/_toolkit_loader.php
@@ -1,6 +1,6 @@
 <?php
 
-// Create an __autoload function 
+// Create an __autoload function
 // (can conflicts other autoloaders)
 // http://php.net/manual/en/language.oop5.autoload.php
 
@@ -21,7 +21,7 @@
 
 
 // Load php-saml
-$libDir = dirname(__FILE__) . '/lib/Saml2/';
+$libDir = __DIR__ . '/lib/Saml2/';
 
 $folderInfo = scandir($libDir);
 
diff --git a/composer.json b/composer.json
@@ -3,7 +3,7 @@
     "description": "OneLogin PHP SAML Toolkit",
     "license": "MIT",
     "version": "3.0.0",
-    "homepage": "https://onelogin.zendesk.com/hc/en-us/sections/200245634-SAML-Toolkits",
+    "homepage": "https://developers.onelogin.com/saml/php",
     "keywords": ["saml", "saml2", "onelogin"],
     "autoload": {
         "classmap": [
diff --git a/demo1/index.php b/demo1/index.php
@@ -6,7 +6,7 @@
 
 session_start();
 
-require_once dirname(dirname(__FILE__)).'/_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 require_once 'settings.php';
 
@@ -65,11 +65,11 @@
     $errors = $auth->getErrors();
 
     if (!empty($errors)) {
-        print_r('<p>'.implode(', ', $errors).'</p>');
+        echo '<p>' . implode(', ', $errors) . '</p>';
     }
 
     if (!$auth->isAuthenticated()) {
-        echo "<p>Not authenticated</p>";
+        echo '<p>Not authenticated</p>';
         exit();
     }
 
@@ -91,9 +91,9 @@
     $auth->processSLO(false, $requestID);
     $errors = $auth->getErrors();
     if (empty($errors)) {
-        print_r('<p>Sucessfully logged out</p>');
+        echo '<p>Sucessfully logged out</p>';
     } else {
-        print_r('<p>'.implode(', ', $errors).'</p>');
+        echo '<p>' . implode(', ', $errors) . '</p>';
     }
 }
 
diff --git a/demo1/metadata.php b/demo1/metadata.php
@@ -4,7 +4,7 @@
  *  SAML Metadata view
  */
 
-require_once dirname(dirname(__FILE__)).'/_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 require_once 'settings.php' ;
 
diff --git a/demo2/consume.php b/demo2/consume.php
@@ -9,7 +9,7 @@
 
 error_reporting(E_ALL);
 
-require_once '../_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 try {
     if (isset($_POST['SAMLResponse'])) {
diff --git a/demo2/index.php b/demo2/index.php
@@ -10,7 +10,7 @@
 
 session_start();
 
-require_once '../_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 if (!isset($_SESSION['samlUserdata'])) {
     $settings = new OneLogin_Saml2_Settings();
diff --git a/demo2/metadata.php b/demo2/metadata.php
@@ -8,7 +8,7 @@
 
 error_reporting(E_ALL);
 
-require_once '../_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 header('Content-Type: text/xml');
 
diff --git a/demo2/slo.php b/demo2/slo.php
@@ -8,7 +8,7 @@
 
 session_start();
 
-require_once '../_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 $samlSettings = new OneLogin_Saml2_Settings();
 
diff --git a/demo2/sso.php b/demo2/sso.php
@@ -10,7 +10,7 @@
 
 session_start();
 
-require_once '../_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 $auth = new OneLogin_Saml2_Auth();
 
diff --git a/endpoints/acs.php b/endpoints/acs.php
@@ -6,7 +6,7 @@
 
 session_start();
 
-require_once dirname(dirname(__FILE__)).'/_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 $auth = new OneLogin_Saml2_Auth();
 
@@ -15,12 +15,12 @@
 $errors = $auth->getErrors();
 
 if (!empty($errors)) {
-    print_r('<p>'.implode(', ', $errors).'</p>');
+    echo '<p>' . implode(', ', $errors) . '</p>';
     exit();
 }
 
 if (!$auth->isAuthenticated()) {
-    echo "<p>Not authenticated</p>";
+    echo '<p>Not authenticated</p>';
     exit();
 }
 
diff --git a/endpoints/metadata.php b/endpoints/metadata.php
@@ -4,7 +4,7 @@
  *  SP Metadata Endpoint
  */
 
-require_once dirname(dirname(__FILE__)).'/_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 try {
     $auth = new OneLogin_Saml2_Auth();
diff --git a/endpoints/sls.php b/endpoints/sls.php
@@ -6,7 +6,7 @@
 
 session_start();
 
-require_once dirname(dirname(__FILE__)).'/_toolkit_loader.php';
+require_once dirname(__DIR__).'/_toolkit_loader.php';
 
 $auth = new OneLogin_Saml2_Auth();
 
@@ -15,7 +15,7 @@
 $errors = $auth->getErrors();
 
 if (empty($errors)) {
-    print_r('Sucessfully logged out');
+    echo 'Sucessfully logged out';
 } else {
-    print_r(implode(', ', $errors));
+    echo implode(', ', $errors);
 }
diff --git a/lib/Saml2/Settings.php b/lib/Saml2/Settings.php
@@ -165,7 +165,7 @@ public function __construct($settings = null, $spValidationOnly = false)
      */
     private function _loadPaths()
     {
-        $basePath = dirname(dirname(dirname(__FILE__))).'/';
+        $basePath = dirname(dirname(__DIR__)) . '/';
         $this->_paths = array (
             'base' => $basePath,
             'config' => $basePath,
@@ -175,7 +175,7 @@ private function _loadPaths()
 
         if (defined('ONELOGIN_CUSTOMPATH')) {
             $this->_paths['config'] = ONELOGIN_CUSTOMPATH;
-            $this->_paths['cert'] = ONELOGIN_CUSTOMPATH.'certs/';
+            $this->_paths['cert'] = ONELOGIN_CUSTOMPATH . 'certs/';
         }
     }
 
diff --git a/lib/Saml2/Utils.php b/lib/Saml2/Utils.php
@@ -67,7 +67,7 @@ public static function t($msg, $args = array())
         assert(is_string($msg));
 
         if (extension_loaded('gettext')) {
-            bindtextdomain("phptoolkit", dirname(dirname(dirname(__FILE__))).'/locale');
+            bindtextdomain("phptoolkit", dirname(dirname(__DIR__)).'/locale');
             textdomain('phptoolkit');
 
             $translatedMsg = gettext($msg);
@@ -141,7 +141,7 @@ public static function validateXML($xml, $schema, $debug = false)
             }
         }
 
-        $schemaFile = dirname(__FILE__).'/schemas/' . $schema;
+        $schemaFile = __DIR__ . '/schemas/' . $schema;
         $oldEntityLoader = libxml_disable_entity_loader(false);
         $res = $dom->schemaValidate($schemaFile);
         libxml_disable_entity_loader($oldEntityLoader);
@@ -266,14 +266,13 @@ public static function redirect($url, $parameters = array(), $stay = false)
         }
 
         /* Verify that the URL is to a http or https site. */
-        if (!preg_match('@^https?:\/\/@i', $url)) {
+        if (!preg_match('@^https?://@i', $url)) {
             throw new OneLogin_Saml2_Error(
                 'Redirect to invalid URL: ' . $url,
                 OneLogin_Saml2_Error::REDIRECT_INVALID_URL
             );
         }
 
-
         /* Add encoded parameters */
         if (strpos($url, '?') === false) {
             $paramPrefix = '?';
@@ -322,7 +321,7 @@ public static function setBaseURL($baseurl)
         if (!empty($baseurl)) {
             $baseurlpath = '/';
             $matches = array();
-            if (preg_match('#^https?:\/\/([^\/]*)\/?(.*)#i', $baseurl, $matches)) {
+            if (preg_match('#^https?://([^/]*)/?(.*)#i', $baseurl, $matches)) {
                 if (strpos($baseurl, 'https://') === false) {
                     self::setSelfProtocol('http');
                     $port = '80';
@@ -604,7 +603,7 @@ public static function getSelfURL()
             $requestURI = $_SERVER['REQUEST_URI'];
             if ($requestURI[0] !== '/') {
                 $matches = array();
-                if (preg_match('#^https?:\/\/[^\/]*(\/.*)#i', $requestURI, $matches)) {
+                if (preg_match('#^https?://[^/]*(/.*)#i', $requestURI, $matches)) {
                     $requestURI = $matches[1];
                 }
             }
@@ -709,15 +708,15 @@ public static function parseSAML2Time($time)
         }
 
         /* Extract the different components of the time from the
-         * matches in the regex. intval will ignore leading zeroes
+         * matches in the regex. int cast will ignore leading zeroes
          * in the string.
          */
-        $year = intval($matches[1]);
-        $month = intval($matches[2]);
-        $day = intval($matches[3]);
-        $hour = intval($matches[4]);
-        $minute = intval($matches[5]);
-        $second = intval($matches[6]);
+        $year = (int) $matches[1];
+        $month = (int) $matches[2];
+        $day = (int) $matches[3];
+        $hour = (int) $matches[4];
+        $minute = (int) $matches[5];
+        $second = (int) $matches[6];
 
         /* We use gmmktime because the timestamp will always be given
          * in UTC.
@@ -883,7 +882,7 @@ public static function query($dom, $query, $context = null)
      */
     public static function isSessionStarted()
     {
-        if (version_compare(phpversion(), '5.4.0', '>=')) {
+        if (PHP_VERSION_ID >= 50400) {
             return session_status() === PHP_SESSION_ACTIVE ? true : false;
         } else {
             return session_id() === '' ? false : true;
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -4,16 +4,16 @@
 
 ob_start();
 
-$basePath = dirname(dirname(__FILE__));
+$basePath = dirname(__DIR__);
 
 require_once $basePath.'/_toolkit_loader.php';
 
 if (!defined('TEST_ROOT')) {
-    define('TEST_ROOT', dirname(__FILE__));
+    define('TEST_ROOT', __DIR__);
 }
 
 if (!defined('ONELOGIN_CUSTOMPATH')) {
-    define('ONELOGIN_CUSTOMPATH', dirname(__FILE__).'/data/customPath/');
+    define('ONELOGIN_CUSTOMPATH', __DIR__.'/data/customPath/');
 }
 
 date_default_timezone_set('America/Los_Angeles');
