├── .styleci.yml
├── scripts
    ├── php-cs-fixer
    │   └── php-cs-fixer
    ├── install.sh
    └── post-install.sh
├── README.md
├── src
    ├── EncryptorInterface.php
    ├── PasswordGeneratorInterface.php
    ├── Encryptor.php
    ├── OtpRoutes.php
    ├── PasswordGenerators
    │   ├── StringPasswordGenerator.php
    │   ├── NumericNo0PasswordGenerator.php
    │   └── NumericPasswordGenerator.php
    ├── PasswordGeneratorManagerInterface.php
    ├── TemporaryAccessFacade.php
    ├── TokenNotification.php
    ├── Http
    │   ├── Middleware
    │   │   └── OtpAccess.php
    │   └── Controllers
    │   │   └── OtpController.php
    ├── PasswordGeneratorManager.php
    ├── TokenInterface.php
    ├── TemporaryAccessServiceProvider.php
    ├── TemporaryAccessService.php
    └── Token.php
├── .editorconfig
├── contrib
    ├── commit-msg
    ├── pre-commit
    └── commit-template
├── config
    └── temporary_access.php
├── database
    └── migrations
    │   └── 2016_12_30_000001_create_temporary_access_tokens_table.php
├── LICENSE.md
├── composer.json
├── CHANGELOG.md
├── views
    └── otp
    │   └── create.blade.php
├── CONTRIBUTING.md
├── .php_cs
└── package.xml


/.styleci.yml:
--------------------------------------------------------------------------------
1 | preset: laravel
2 | 


--------------------------------------------------------------------------------
/scripts/php-cs-fixer/php-cs-fixer:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fg/temporary-access/master/scripts/php-cs-fixer/php-cs-fixer


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Temporary Access
2 | 
3 | **[Abandoned]**
4 | 
5 | Moved to [erdemkeren/laravel-otp](https://github.com/erdemkeren/laravel-otp). Please use it instead.
6 | 


--------------------------------------------------------------------------------
/src/EncryptorInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess;
 9 | 
10 | interface EncryptorInterface
11 | {
12 |     public function encrypt(string $plainText): string;
13 | }
14 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | charset = utf-8
 5 | end_of_line = lf
 6 | insert_final_newline = true
 7 | indent_style = space
 8 | indent_size = 4
 9 | trim_trailing_whitespace = true
10 | 
11 | [*.md]
12 | trim_trailing_whitespace = false
13 | 
14 | [*.yml]
15 | indent_style = space
16 | indent_size = 2
17 | 


--------------------------------------------------------------------------------
/scripts/install.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | SOURCE="${BASH_SOURCE[0]}"
 4 | DIR="$( cd -P "$( dirname "$SOURCE" )/.." && pwd )"
 5 | 
 6 | source $(dirname $0)/colors.sh
 7 | 
 8 | /usr/local/bin/composer install --no-interaction --prefer-dist --no-scripts
 9 | /usr/local/bin/composer install --no-interaction --prefer-dist
10 | 
11 | chmod +x $DIR/scripts/post-install.sh
12 | sh $DIR/scripts/post-install.sh
13 | 


--------------------------------------------------------------------------------
/contrib/commit-msg:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | 
 3 | COMMIT_FILE=$1
 4 | COMMIT_MSG=$(cat $1)
 5 | CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
 6 | ISSUE_ID=$(echo "$CURRENT_BRANCH" | grep -Eo "[A-Z0-9]{1,10}-?[A-Z0-9]+-\d+")
 7 | 
 8 | if [ ! -z "$ISSUE_ID" ]; then
 9 | 	COMMIT_MSG="${COMMIT_MSG/_issue_id_/$ISSUE_ID}"
10 | 
11 | 	echo "$COMMIT_MSG" > $COMMIT_FILE
12 | 	echo "The _issue_id_ placeholder has been replaced the one which matches the current branches' issue id: $ISSUE_ID"
13 | fi
14 | 


--------------------------------------------------------------------------------
/src/PasswordGeneratorInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess;
 9 | 
10 | /**
11 |  * Interface PasswordGeneratorInterface.
12 |  */
13 | interface PasswordGeneratorInterface
14 | {
15 |     /**
16 |      * Generate a new password.
17 |      *
18 |      * @param int $length
19 |      *
20 |      * @return string
21 |      */
22 |     public function generate(int $length);
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Encryptor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess;
 9 | 
10 | class Encryptor implements EncryptorInterface
11 | {
12 |     private $key;
13 | 
14 |     public function __construct($key)
15 |     {
16 |         $this->key = $key;
17 |     }
18 | 
19 |     public function encrypt(string $plainText): string
20 |     {
21 |         return hash_hmac('sha256', $plainText, $this->key);
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/src/OtpRoutes.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess;
 9 | 
10 | use Illuminate\Support\Facades\Route;
11 | use Erdemkeren\TemporaryAccess\Http\Controllers\OtpController;
12 | 
13 | class OtpRoutes
14 | {
15 |     /**
16 |      * Binds the Passport routes into the controller.
17 |      */
18 |     public static function register(): void
19 |     {
20 |         Route::resource('otp', OtpController::class, [
21 |             'only'       => ['create', 'store'],
22 |             'prefix'     => 'otp',
23 |         ])->middleware(['web', 'auth']);
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/src/PasswordGenerators/StringPasswordGenerator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess\PasswordGenerators;
 9 | 
10 | use Erdemkeren\TemporaryAccess\PasswordGeneratorInterface;
11 | 
12 | /**
13 |  * Class StringPasswordGenerator.
14 |  */
15 | class StringPasswordGenerator implements PasswordGeneratorInterface
16 | {
17 |     /**
18 |      * Generate a string password with the given length.
19 |      *
20 |      * @param int $length
21 |      *
22 |      * @return string
23 |      */
24 |     public function generate(int $length): string
25 |     {
26 |         return str_random($length);
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/contrib/pre-commit:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | #
 3 | # The hook script to verify what is about to be committed.
 4 | # Called by "git commit" with no arguments.  The hook should
 5 | # exit with non-zero status after issuing an appropriate message if
 6 | # it wants to stop the commit.
 7 | #
 8 | # This file is automatically enabled by post-install-cmd composer
 9 | # scripts. If you disabled executing scripts when installing
10 | # simply move this file under .git/hooks/pre-commit
11 | echo "Checking PHP Lint..."
12 | git status --porcelain | grep -e '^[AM]\(.*\).php$' | cut -c 3- | while read line; do
13 |     echo "$line"
14 | 	php -l -d display_errors=0 $line 1> /dev/null
15 | 
16 | 	if [ $? != 0 ];
17 | 	then
18 | 		echo "Fix the error before commit."
19 | 		exit 1
20 | 	fi
21 | 
22 |     ./scripts/php-cs-fixer/php-cs-fixer fix -q "$line";
23 |     git add "$line";
24 | done
25 | 
26 | exit $?
27 | 


--------------------------------------------------------------------------------
/src/PasswordGeneratorManagerInterface.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess;
 9 | 
10 | /**
11 |  * Class PasswordGeneratorManager.
12 |  */
13 | interface PasswordGeneratorManagerInterface
14 | {
15 |     /**
16 |      * Registers the given password generator with the given name.
17 |      *
18 |      * @param string                                     $name
19 |      * @param callable|PasswordGeneratorInterface|string $generator
20 |      */
21 |     public function register(string $name, $generator): void;
22 | 
23 |     /**
24 |      * Get the previously registered generator by the given name.
25 |      *
26 |      * @param null|string $generatorName
27 |      *
28 |      * @return callable
29 |      */
30 |     public function get(?string $generatorName = null): callable;
31 | }
32 | 


--------------------------------------------------------------------------------
/config/temporary_access.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | return [
 9 |     /*
10 |      * The password generator option allows you to decide
11 |      * which generator implementation to be used when
12 |      * generating new passwords.
13 |      *
14 |      * Here are the options:
15 |      *  - string
16 |      *  - numeric
17 |      *  - numeric-no-0
18 |      */
19 | 
20 |     'password_generator' => 'string',
21 | 
22 |     /*
23 |      * The name of the table to be used to store
24 |      * the temporary access tokens.
25 |      */
26 | 
27 |     'table'   => 'temporary_access_tokens',
28 | 
29 |     /*
30 |      * The expiry time of the tokens in minutes.
31 |      */
32 | 
33 |     'expires' => 15, // in minutes.
34 | 
35 |     /*
36 |      * The default notification channels of the
37 |      * token notification.
38 |      *
39 |      * Accepts:
40 |      * array
41 |      * comma separated string
42 |      */
43 | 
44 |     'default_channels' => 'mail',
45 | ];
46 | 


--------------------------------------------------------------------------------
/src/TemporaryAccessFacade.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess;
 9 | 
10 | use Illuminate\Support\Facades\Facade;
11 | 
12 | /**
13 |  * Class TemporaryAccessFacade.
14 |  *
15 |  * @method static setPasswordGenerator(string $name): void
16 |  * @method static check($authenticableId, string $token): bool
17 |  * @method static addPasswordGenerator(string $name, $generator): void
18 |  * @method static create($authenticatableId, ?int $length = null): TokenInterface
19 |  * @method static retrieveByPlainText($authenticableId, string $plainText): ?TokenInterface
20 |  * @method static retrieveByCipherText($authenticableId, string $cipherText): ?TokenInterface
21 |  */
22 | class TemporaryAccessFacade extends Facade
23 | {
24 |     /**
25 |      * Get the registered name of the component.
26 |      *
27 |      * @return string
28 |      */
29 |     protected static function getFacadeAccessor()
30 |     {
31 |         return 'temporary-access';
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/database/migrations/2016_12_30_000001_create_temporary_access_tokens_table.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | use Illuminate\Support\Facades\Schema;
 9 | use Illuminate\Database\Schema\Blueprint;
10 | use Illuminate\Database\Migrations\Migration;
11 | 
12 | class CreateTemporaryAccessTokensTable extends Migration
13 | {
14 |     /**
15 |      * Run the migrations.
16 |      */
17 |     public function up()
18 |     {
19 |         Schema::create('temporary_access_tokens', function (Blueprint $table) {
20 |             $table->unsignedInteger('authenticable_id');
21 |             $table->string('cipher_text', 64);
22 |             $table->timestamp('created_at')->useCurrent();
23 |             $table->timestamp('updated_at')->useCurrent();
24 |             $table->unsignedSmallInteger('expiry_time')->nullable();
25 | 
26 |             $table->unique(['authenticatable_id', 'cipher_text']);
27 |         });
28 |     }
29 | 
30 |     /**
31 |      * Reverse the migrations.
32 |      */
33 |     public function down()
34 |     {
35 |         Schema::drop('temporary_access_tokens');
36 |     }
37 | }
38 | 


--------------------------------------------------------------------------------
/src/PasswordGenerators/NumericNo0PasswordGenerator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess\PasswordGenerators;
 9 | 
10 | use Exception;
11 | use Erdemkeren\TemporaryAccess\PasswordGeneratorInterface;
12 | 
13 | /**
14 |  * Class NumericNo0PasswordGenerator.
15 |  */
16 | class NumericNo0PasswordGenerator extends NumericPasswordGenerator implements PasswordGeneratorInterface
17 | {
18 |     /**
19 |      * Generate a numeric password with no zeroes.
20 |      *
21 |      * @param int $length
22 |      *
23 |      * @return string
24 |      */
25 |     public function generate(int $length): string
26 |     {
27 |         return (string) str_replace(0, $this->getRandomDigitWithNo0(), (string) parent::generate($length));
28 |     }
29 | 
30 |     /**
31 |      * Generate a random digit with no zeroes.
32 |      *
33 |      * @return int
34 |      */
35 |     private function getRandomDigitWithNo0()
36 |     {
37 |         try {
38 |             $int = random_int(1, 9);
39 |         } catch (Exception $e) {
40 |             $int = rand(1, 9);
41 |         }
42 | 
43 |         return $int;
44 |     }
45 | }
46 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | # The MIT License (MIT)
 2 | 
 3 | Copyright (c) Hilmi Erdem KEREN <erdemkeren@gmail.com>
 4 | 
 5 | > Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | > of this software and associated documentation files (the "Software"), to deal
 7 | > in the Software without restriction, including without limitation the rights
 8 | > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | > copies of the Software, and to permit persons to whom the Software is
10 | > furnished to do so, subject to the following conditions:
11 | >
12 | > The above copyright notice and this permission notice shall be included in
13 | > all copies or substantial portions of the Software.
14 | >
15 | > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | > THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/scripts/post-install.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | CURRPHP=$(which php)
 4 | SOURCE="${BASH_SOURCE[0]}"
 5 | DIR="$( cd -P "$( dirname "$SOURCE" )/.." && pwd )"
 6 | 
 7 | # Make sure the php-cs-fixer package is installed. Otherwise, install it.
 8 | if ! [ -x ./scripts/php-cs-fixer/php-cs-fixer ]
 9 | then
10 |     echo "php-cs-fixer package is not detected in your scripts folder."
11 |     echo ""
12 |     echo "Installing php-cs-fixer package."
13 |     mkdir ./scripts/php-cs-fixer
14 |     echo ""
15 |     wget -nv http://cs.sensiolabs.org/download/php-cs-fixer-v2.phar -O ./scripts/php-cs-fixer/php-cs-fixer
16 |     echo ""
17 |     echo "Set executable flag for the binary."
18 |     chmod +x ./scripts/php-cs-fixer/php-cs-fixer
19 |     echo ""
20 |     echo "php-cs-fixer package has been successfully installed."
21 | fi
22 | 
23 | # Copy the pre-commit hook to git hooks directory.
24 | # Also make sure that it is executable.
25 | cp $DIR/contrib/pre-commit $DIR/.git/hooks/pre-commit
26 | chmod +x $DIR/.git/hooks/pre-commit
27 | 
28 | # Add the config template to the project.
29 | git config commit.template $DIR/contrib/commit-template
30 | 
31 | # Copy the commit-msg hook to git hooks directory.
32 | # Also make sure that it is executable.
33 | cp $DIR/contrib/commit-msg $DIR/.git/hooks/commit-msg
34 | chmod +x $DIR/.git/hooks/commit-msg
35 | 


--------------------------------------------------------------------------------
/src/PasswordGenerators/NumericPasswordGenerator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess\PasswordGenerators;
 9 | 
10 | use Exception;
11 | use Erdemkeren\TemporaryAccess\PasswordGeneratorInterface;
12 | 
13 | /**
14 |  * Class NumericPasswordGenerator.
15 |  */
16 | class NumericPasswordGenerator implements PasswordGeneratorInterface
17 | {
18 |     /**
19 |      * Generate a numeric password.
20 |      *
21 |      * @param int $length
22 |      *
23 |      * @return string
24 |      */
25 |     public function generate(int $length): string
26 |     {
27 |         $range = $this->generateRangeForLength($length);
28 | 
29 |         try {
30 |             $int = random_int($range[0], $range[1]);
31 |         } catch (Exception $e) {
32 |             $int = rand($range[0], $range[1]);
33 |         }
34 | 
35 |         return (string) $int;
36 |     }
37 | 
38 |     /**
39 |      * Generate the required range for the given length.
40 |      *
41 |      * @param int $length
42 |      *
43 |      * @return array
44 |      */
45 |     protected function generateRangeForLength(int $length): array
46 |     {
47 |         $min = 1;
48 |         $max = 9;
49 | 
50 |         while ($length > 1) {
51 |             $min .= 0;
52 |             $max .= 9;
53 | 
54 |             $length--;
55 |         }
56 | 
57 |         return [
58 |             $min, $max,
59 |         ];
60 |     }
61 | }
62 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "erdemkeren/temporary-access",
 3 |     "description": "This package allows you to secure your routes with one-time passwords (otp).",
 4 |     "homepage": "https://github.com/erdemkeren/temporary-access",
 5 |     "keywords": ["temporary", "access", "grant", "otp"],
 6 |     "license": "MIT",
 7 |     "authors": [
 8 |         {
 9 |             "name": "Hilmi Erdem KEREN",
10 |             "email": "erdemkeren@gmail.com"
11 |         },
12 |         {
13 |             "name": "Berkay Güre",
14 |             "email": "bgure@hotmail.com.tr"
15 |         }
16 |     ],
17 |     "require": {
18 |         "php": ">=7.1",
19 |         "illuminate/database": "^5.5|^6.0|^7.0",
20 |         "illuminate/http": "^5.5|^6.0|^7.0",
21 |         "illuminate/notifications": "^5.5|^6.0|^7.0",
22 |         "illuminate/routing": "^5.5|^6.0|^7.0",
23 |         "illuminate/support": "^5.5|^6.0|^7.0",
24 |         "nesbot/carbon": " ~2.0"
25 |     },
26 |     "require-dev": {
27 |         "illuminate/config": "^5.5",
28 |         "mockery/mockery": "~1.0",
29 |         "phpunit/phpunit": "7.*"
30 |     },
31 |     "autoload": {
32 |         "psr-4": {
33 |             "Erdemkeren\\TemporaryAccess\\": "src"
34 |         }
35 |     },
36 |     "autoload-dev": {
37 |         "psr-4": {
38 |             "Erdemkeren\\TemporaryAccess\\Test\\": "tests"
39 |         }
40 |     },
41 |     "scripts": {
42 |         "test": "vendor/bin/phpunit"
43 |     },
44 |     "config": {
45 |         "sort-packages": true
46 |     },
47 |     "minimum-stability": "dev",
48 |     "prefer-stable": true,
49 |     "extra": {
50 |         "laravel": {
51 |             "providers": [
52 |                 "Erdemkeren\\TemporaryAccess\\TemporaryAccessServiceProvider"
53 |             ],
54 |             "aliases": {
55 |                 "TemporaryAccess": "Erdemkeren\\TemporaryAccess\\TemporaryAccessFacade"
56 |             }
57 |         }
58 |     }
59 | }
60 | 


--------------------------------------------------------------------------------
/contrib/commit-template:
--------------------------------------------------------------------------------
 1 | _type_: _subject_
 2 | 
 3 | # _body_
 4 | 
 5 | Resolves: _issue_id_
 6 | # See also:
 7 | 
 8 | ########################################################################################
 9 | # A) Type: The type is contained within the title and can be one of these types:
10 | ########################################################################################
11 | # feat: a new feature
12 | # fix: a bug fix
13 | # docs: changes to documentation
14 | # style: formatting, missing semi colons, etc; no code change
15 | # refactor: refactoring production code
16 | # test: adding tests, refactoring test; no production code change
17 | # chore: updating build tasks, package manager configs, etc; no production code change
18 | ########################################################################################
19 | # B) Subject: Subjects should be no greater than 50 characters,
20 | #          (!) Should begin with a capital letter and do not end with a period.
21 | ########################################################################################
22 | # Describe what exactly the issue does, rather than what it did.
23 | # Example: Adds bla bla.
24 | ########################################################################################
25 | # C) Body
26 | ########################################################################################
27 | # Not all commits are complex enough to warrant a body,
28 | # therefore it is optional and only used when a commit requires a bit of
29 | # explanation and context.
30 | #
31 | # Use the body to explain the what and why of a commit, not the how.
32 | #
33 | # When writing a body, the blank line between the title and the body is required
34 | # and you should limit the length of each line to no more than 72 characters.
35 | ########################################################################################
36 | # D) Footer
37 | ########################################################################################
38 | # The footer is used to reference issue tracker IDs.
39 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | All notable changes to `erdemkeren/temporary-access` will be documented in this file.
 4 | 
 5 | ## 3.0.0 - 2018-11-08
 6 | 
 7 | - OtpController and OtpAccess middleware are introduced
 8 | - Token generators are now password generators
 9 | - Token creation is now being handled by Encryptor implementations
10 | - Repository pattern is not used anymore. Token persistence is a part of token itself
11 | 
12 | ### v2 to v3 service method mapping:
13 | 
14 | - retrieve -> retrieveByCipherText
15 | - retrieveUsingPlainText -> retrieveByPlainText
16 | - check -> check
17 | - checkUsingPlainText -> none. Token should be retrieved and then checked like `TemporaryAccess::retrieveByPlainText()->expired()`
18 | - checkAndProlong -> none. Token should be retrieved and then extended like `TemporaryAccess::retrieveByPlainText()->extend(10)`
19 | - checkUsingPlainTextAndProlong -> none. Above usages applies as well
20 | - generate -> create
21 | - update -> none. Use token methods to modify token state (`Token::extend()`, `Token::invalidate()` etc.)
22 | - makeTokenFromPlainText -> no need anymore
23 | - makeTokenFromEncryptedText -> no need anymore
24 | - retrieveByAttributes -> no need anymore. But moved to `Token::retrieveByAttributes()
25 | - delete -> will be implemented later. Not really needed since `Token::invalidate()` does the job
26 | - deleteExpired -> will be implemented later
27 | 
28 | ## 2.1.0 - 2018-02-06
29 | 
30 | - Adds token generator options:
31 |     - String
32 |     - Numeric
33 |     - Numeric No 0
34 |   which is configurable from config file.
35 | - Moves the token & generators and interfaces to a common directory and namespace.
36 | 
37 | ## 2.0.0 - 2017-01-04
38 | 
39 | - The code and token discrimination removed from the package. Plain text and encrypted text used instead.
40 | - Totally separated token is now a part of access token.
41 | - Interface names were changed after 1.0.0 but never released. This version includes new interface names.
42 | - Most of the public service method signatures were changed due to removal of 'code'.
43 | 
44 | ## 1.0.0 - 2016-12-30
45 | 
46 | - First release of the package.
47 | 


--------------------------------------------------------------------------------
/src/TokenNotification.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess;
 9 | 
10 | use Illuminate\Bus\Queueable;
11 | use Illuminate\Support\Traits\Macroable;
12 | use Illuminate\Notifications\Notification;
13 | use Illuminate\Contracts\Queue\ShouldQueue;
14 | use Illuminate\Notifications\Messages\MailMessage;
15 | 
16 | /**
17 |  * Class TokenNotification.
18 |  */
19 | class TokenNotification extends Notification implements ShouldQueue
20 | {
21 |     use Queueable, Macroable;
22 | 
23 |     /**
24 |      * The token implementation.
25 |      *
26 |      * @var TokenInterface
27 |      */
28 |     public $token;
29 | 
30 |     /**
31 |      * TokenGenerated constructor.
32 |      *
33 |      * @param TokenInterface $token
34 |      */
35 |     public function __construct(TokenInterface $token)
36 |     {
37 |         $this->token = $token;
38 |     }
39 | 
40 |     /**
41 |      * Get the notification's delivery channels.
42 |      *
43 |      * @param mixed $notifiable
44 |      *
45 |      * @return array
46 |      */
47 |     public function via($notifiable)
48 |     {
49 |         $channels = method_exists($notifiable, 'otpChannels') && ! empty($notifiable->otpChannels())
50 |             ? $notifiable->otpChannels()
51 |             : config('temporary_access.default_channels');
52 | 
53 |         return \is_array($channels)
54 |             ? $channels
55 |             : array_map('trim', explode(',', $channels));
56 |     }
57 | 
58 |     /**
59 |      * Get the mail presentation of the notification.
60 |      *
61 |      * @return MailMessage
62 |      */
63 |     public function toMail(): MailMessage
64 |     {
65 |         return (new MailMessage())
66 |             ->subject(config('app.name').' One Time Password')
67 |             ->greeting('Hello!')
68 |             ->line('Somebody recently requested for a one-time password in behalf of you.')
69 |             ->line('You can enter the following reset code: '.$this->token->plainText())
70 |             ->line('If you didn\'t request the password, simply ignore this message.');
71 |     }
72 | 
73 |     /**
74 |      * Get the sms presentation of the notification.
75 |      *
76 |      * @return string
77 |      */
78 |     public function toSms(): string
79 |     {
80 |         return 'Somebody recently requested a one-time password.'
81 |         ." You can enter the following reset code: {$this->token->plainText()}"
82 |         .' If you didn\'t request the password, simply ignore this message.';
83 |     }
84 | }
85 | 


--------------------------------------------------------------------------------
/views/otp/create.blade.php:
--------------------------------------------------------------------------------
 1 | @extends('layouts.app')
 2 | 
 3 | @section('content')
 4 |     <div class="container be-detail-container">
 5 |         <div class="row justify-content-center">
 6 |             <div class="col-md-8">
 7 |                 <div class="card">
 8 | 
 9 |                     <div class="card-header">
10 |                         OTP Required
11 |                     </div><!-- Card Header-->
12 | 
13 |                     <div class="card-body">
14 |                         <form method="POST" id="otp-verification-form" action="{{ route('otp.store') }}">
15 |                         @csrf
16 | 
17 |                         <!-- Input -->
18 |                             <div class="form-group row">
19 |                                 <label for="email" class="col-sm-4 col-form-label text-md-right">One Time Password:</label>
20 | 
21 |                                 <!-- Error handling -->
22 |                                 <div class="col-md-6">
23 |                                     <input
24 |                                             id="password"
25 |                                             type="password"
26 |                                             class="form-control{{ $errors->has('password') ? ' is-invalid' : '' }}"
27 |                                             name="password"
28 |                                             required autofocus
29 |                                     >
30 | 
31 |                                     @if ($errors->has('password'))
32 |                                         <span class="invalid-feedback">
33 |                                         <strong>{{ $errors->first('password') }}</strong>
34 |                                     </span>
35 |                                     @endif
36 |                                 </div>
37 |                             </div>
38 | 
39 |                             <!-- Buttons -->
40 |                             <div class="form-group row mb-0">
41 |                                 <div class="col-md-8 offset-md-4">
42 |                                     <button type="submit" class="btn btn-primary">
43 |                                         Verify
44 |                                     </button>
45 |                                     <a class="btn btn-link" href="">
46 |                                         Need a new password?
47 |                                     </a>
48 |                                 </div>
49 |                             </div>
50 | 
51 |                         </form>
52 |                     </div><!-- Card Body -->
53 | 
54 |                 </div><!-- Card -->
55 |             </div><!-- Column -->
56 |         </div><!-- Row -->
57 |     </div><!-- Container -->
58 | @endsection
59 | 


--------------------------------------------------------------------------------
/src/Http/Middleware/OtpAccess.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess\Http\Middleware;
 9 | 
10 | use Closure;
11 | use Illuminate\Http\Request;
12 | use Illuminate\Http\RedirectResponse;
13 | use Erdemkeren\TemporaryAccess\TokenInterface;
14 | use Illuminate\Contracts\Auth\Authenticatable;
15 | use Erdemkeren\TemporaryAccess\TemporaryAccessFacade as TemporaryAccess;
16 | 
17 | class OtpAccess
18 | {
19 |     /**
20 |      * Handle an incoming request.
21 |      *
22 |      * @param \Illuminate\Http\Request $request
23 |      * @param \Closure                 $next
24 |      * @param null|string              $guard
25 |      *
26 |      * @return mixed
27 |      */
28 |     public function handle(Request $request, Closure $next, $guard = null)
29 |     {
30 |         if (! $user = $request->user($guard)) {
31 |             throw new \LogicException(
32 |                 'The otp access control middleware requires user authentication via laravel guards.'
33 |             );
34 |         }
35 | 
36 |         if (! $request->hasCookie('otp_token')) {
37 |             $this->sendNewOtpToUser($user);
38 | 
39 |             return $this->redirectToOtpPage();
40 |         }
41 | 
42 |         $token = TemporaryAccess::retrieveByCipherText(
43 |             $user->getAuthIdentifier(),
44 |             $request->cookie('otp_token')
45 |         );
46 | 
47 |         if (! $token || $token->expired()) {
48 |             $this->sendNewOtpToUser($user);
49 | 
50 |             return $this->redirectToOtpPage();
51 |         }
52 | 
53 |         $request->macro('otpToken', function () use ($token): TokenInterface {
54 |             return $token;
55 |         });
56 | 
57 |         return $next($request);
58 |     }
59 | 
60 |     /**
61 |      * Get the redirect url if check do not pass.
62 |      *
63 |      * @return RedirectResponse
64 |      */
65 |     protected function redirectToOtpPage(): RedirectResponse
66 |     {
67 |         session([
68 |             'otp_requested'    => true,
69 |             'otp_redirect_url' => url()->current(),
70 |         ]);
71 | 
72 |         return redirect()->route('otp.create');
73 |     }
74 | 
75 |     /**
76 |      * Create a new otp and notify the user.
77 |      *
78 |      * @param Authenticatable $user
79 |      */
80 |     private function sendNewOtpToUser(Authenticatable $user): void
81 |     {
82 |         $token = TemporaryAccess::create($user, 6);
83 | 
84 |         if (! method_exists($user, 'notify')) {
85 |             throw new \UnexpectedValueException(
86 |                 'The otp owner should be an instance of notifiable or implement the notify method.'
87 |             );
88 |         }
89 | 
90 |         $user->notify($token->toNotification());
91 |     }
92 | }
93 | 


--------------------------------------------------------------------------------
/src/PasswordGeneratorManager.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * @copyright 2018 Hilmi Erdem KEREN
 5 |  * @license MIT
 6 |  */
 7 | 
 8 | namespace Erdemkeren\TemporaryAccess;
 9 | 
10 | /**
11 |  * Class PasswordGeneratorManager.
12 |  */
13 | final class PasswordGeneratorManager implements PasswordGeneratorManagerInterface
14 | {
15 |     /**
16 |      * The password generator registry.
17 |      *
18 |      * @var array
19 |      */
20 |     private static $generators = [];
21 | 
22 |     /**
23 |      * Registers the given password generator with the given name.
24 |      *
25 |      * @param string                                     $name
26 |      * @param callable|PasswordGeneratorInterface|string $generator
27 |      */
28 |     public function register(string $name, $generator): void
29 |     {
30 |         if (\is_string($generator)) {
31 |             $generator = $this->createGeneratorFromString($generator);
32 |         }
33 | 
34 |         if (! \is_callable($generator) && ! $generator instanceof PasswordGeneratorInterface) {
35 |             $msg = 'The generators should either be callable or an instance of '.PasswordGeneratorInterface::class;
36 | 
37 |             throw new \UnexpectedValueException($msg);
38 |         }
39 | 
40 |         static::$generators[$name] = \is_callable($generator)
41 |             ? $generator
42 |             : function (int $length) use ($generator): string {
43 |                 return $generator->generate($length);
44 |             };
45 |     }
46 | 
47 |     /**
48 |      * Get the previously registered generator by the given name.
49 |      *
50 |      * @param null|string $generatorName
51 |      *
52 |      * @return callable
53 |      */
54 |     public function get(?string $generatorName = null): callable
55 |     {
56 |         if (! \in_array($generatorName, array_keys(static::$generators), true)) {
57 |             throw new \UnexpectedValueException(
58 |                 'The '.$generatorName.' password generator is not registered.'
59 |             );
60 |         }
61 | 
62 |         return static::$generators[$generatorName];
63 |     }
64 | 
65 |     /**
66 |      * Create a new password generator instance using the given
67 |      * fully qualified password generator class name.
68 |      *
69 |      * @param string $className
70 |      *
71 |      * @return PasswordGeneratorInterface
72 |      */
73 |     private function createGeneratorFromString(string $className): PasswordGeneratorInterface
74 |     {
75 |         if (! class_exists($className)) {
76 |             throw new \RuntimeException(
77 |                 "The generator [{$className}] could not be found."
78 |             );
79 |         }
80 | 
81 |         $generatorReflection = new \ReflectionClass($className);
82 |         if (! $generatorReflection->isInstantiable()) {
83 |             throw new \RuntimeException(
84 |                 "The generator [{$className}] is not instantiable."
85 |             );
86 |         }
87 | 
88 |         return new $className();
89 |     }
90 | }
91 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | Contributions are **welcome** and will be fully **credited**.
 4 | 
 5 | Please read and understand the contribution guide before creating an issue or pull request.
 6 | 
 7 | ## Etiquette
 8 | 
 9 | This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10 | held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11 | extremely unfair for them to suffer abuse or anger for their hard work.
12 | 
13 | Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14 | world that developers are civilized and selfless people.
15 | 
16 | It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17 | quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
18 | 
19 | ## Viability
20 | 
21 | When requesting or submitting new features, first consider whether it might be useful to others. Open
22 | source projects are used by many developers, who may have entirely different needs to your own. Think about
23 | whether or not your feature is likely to be used by other users of the project.
24 | 
25 | ## Procedure
26 | 
27 | Before filing an issue:
28 | 
29 | - Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30 | - Check to make sure your feature suggestion isn't already present within the project.
31 | - Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32 | - Check the pull requests tab to ensure that the feature isn't already in progress.
33 | 
34 | Before submitting a pull request:
35 | 
36 | - Check the codebase to ensure that your feature doesn't already exist.
37 | - Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38 | 
39 | ## Requirements
40 | 
41 | If the project maintainer has any additional requirements, you will find them listed here.
42 | 
43 | - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
44 | 
45 | - **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46 | 
47 | - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48 | 
49 | - **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
50 | 
51 | - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52 | 
53 | - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54 | 
55 | **Happy coding**!
56 | 


--------------------------------------------------------------------------------
/src/TokenInterface.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * @copyright 2018 Hilmi Erdem KEREN
  5 |  * @license MIT
  6 |  */
  7 | 
  8 | namespace Erdemkeren\TemporaryAccess;
  9 | 
 10 | use Carbon\Carbon;
 11 | use Illuminate\Notifications\Notification;
 12 | 
 13 | interface TokenInterface
 14 | {
 15 |     /**
 16 |      * Get the unique identifier of the authenticable
 17 |      * who owns the token.
 18 |      *
 19 |      * @return mixed
 20 |      */
 21 |     public function authenticableId();
 22 | 
 23 |     /**
 24 |      * Get the token as cipher text.
 25 |      *
 26 |      * @return string
 27 |      */
 28 |     public function cipherText(): string;
 29 | 
 30 |     /**
 31 |      * Get the token as plain text.
 32 |      *
 33 |      * @return null|string
 34 |      */
 35 |     public function plainText(): ?string;
 36 | 
 37 |     /**
 38 |      * Get the date token created.
 39 |      *
 40 |      * @return Carbon
 41 |      */
 42 |     public function createdAt(): Carbon;
 43 | 
 44 |     /**
 45 |      * Get the last update date of the token.
 46 |      *
 47 |      * @return Carbon
 48 |      */
 49 |     public function updatedAt(): Carbon;
 50 | 
 51 |     /**
 52 |      * Get the expiry time of the token in seconds.
 53 |      *
 54 |      * @return int
 55 |      */
 56 |     public function expiryTime(): int;
 57 | 
 58 |     /**
 59 |      * Get the date time the token will expire.
 60 |      *
 61 |      * @return Carbon
 62 |      */
 63 |     public function expiresAt(): Carbon;
 64 | 
 65 |     /**
 66 |      * Get the validity time left for the token.
 67 |      *
 68 |      * @return int
 69 |      */
 70 |     public function timeLeft(): int;
 71 | 
 72 |     /**
 73 |      * Determine if the token is expired or not.
 74 |      *
 75 |      * @return bool
 76 |      */
 77 |     public function expired(): bool;
 78 | 
 79 |     /**
 80 |      * Alias for invalidate.
 81 |      */
 82 |     public function revoke(): void;
 83 | 
 84 |     /**
 85 |      * Invalidate the token.
 86 |      */
 87 |     public function invalidate(): void;
 88 | 
 89 |     /**
 90 |      * Refresh the token.
 91 |      *
 92 |      * @return bool
 93 |      */
 94 |     public function refresh(): bool;
 95 | 
 96 |     /**
 97 |      * Extend the validity of the token.
 98 |      *
 99 |      * @param null|int $seconds
100 |      *
101 |      * @return bool
102 |      */
103 |     public function extend(?int $seconds = null): bool;
104 | 
105 |     /**
106 |      * Convert the token to a token notification.
107 |      *
108 |      * @return Notification
109 |      */
110 |     public function toNotification(): Notification;
111 | 
112 |     /**
113 |      * Create a new token.
114 |      *
115 |      * @param $authenticableId
116 |      * @param string      $cipherText
117 |      * @param null|string $plainText
118 |      *
119 |      * @return TokenInterface
120 |      */
121 |     public static function create(
122 |         $authenticableId,
123 |         string $cipherText,
124 |         ?string $plainText = null
125 |     ): self;
126 | 
127 |     /**
128 |      * Retrieve a token by the given attributes from the storage.
129 |      *
130 |      * @param array $attributes
131 |      *
132 |      * @return null|TokenInterface
133 |      */
134 |     public static function retrieveByAttributes(array $attributes): ?self;
135 | }
136 | 


--------------------------------------------------------------------------------
/src/TemporaryAccessServiceProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * @copyright 2018 Hilmi Erdem KEREN
  5 |  * @license MIT
  6 |  */
  7 | 
  8 | namespace Erdemkeren\TemporaryAccess;
  9 | 
 10 | use Illuminate\Routing\Router;
 11 | use Illuminate\Support\ServiceProvider;
 12 | use Erdemkeren\TemporaryAccess\Http\Middleware\OtpAccess;
 13 | use Erdemkeren\TemporaryAccess\PasswordGenerators as Generators;
 14 | 
 15 | class TemporaryAccessServiceProvider extends ServiceProvider
 16 | {
 17 |     /**
 18 |      * Indicates if loading of the provider is deferred.
 19 |      *
 20 |      * @var bool
 21 |      */
 22 |     protected $defer = true;
 23 | 
 24 |     public function boot(): void
 25 |     {
 26 |         $this->publishes([$this->configPath() => config_path('temporary_access.php')]);
 27 |         $this->publishes([$this->migrationPath() => database_path('migrations')]);
 28 |         $this->publishes([$this->viewPath() => resource_path('views')]);
 29 |     }
 30 | 
 31 |     /**
 32 |      * Register the temporary access service.
 33 |      */
 34 |     public function register(): void
 35 |     {
 36 |         $service = $this->createServiceInstance();
 37 |         $this->registerDefaultPasswordGenerators($service);
 38 | 
 39 |         $this->app->singleton('temporary-access', function () use ($service) {
 40 |             return $service;
 41 |         });
 42 | 
 43 |         /** @var Router $router */
 44 |         $router = $this->app['router'];
 45 |         $router->aliasMiddleware('otp-access', OtpAccess::class);
 46 |     }
 47 | 
 48 |     /**
 49 |      * Get the services provided by the provider.
 50 |      *
 51 |      * @return array
 52 |      */
 53 |     public function provides(): array
 54 |     {
 55 |         return [
 56 |             'temporary-access',
 57 |         ];
 58 |     }
 59 | 
 60 |     /**
 61 |      * Create a new temporary access service instance.
 62 |      *
 63 |      * @return TemporaryAccessService
 64 |      */
 65 |     private function createServiceInstance(): TemporaryAccessService
 66 |     {
 67 |         return new TemporaryAccessService(
 68 |             new PasswordGeneratorManager(),
 69 |             new Encryptor(config('app.secret')),
 70 |             config('temporary_access.password_generator', 'string'),
 71 |             6,
 72 |             Token::class
 73 |         );
 74 |     }
 75 | 
 76 |     /**
 77 |      * Register default password generators to the
 78 |      * given temporary access service instance.
 79 |      *
 80 |      * @param TemporaryAccessService $service
 81 |      */
 82 |     private function registerDefaultPasswordGenerators($service): void
 83 |     {
 84 |         $service->addPasswordGenerator('string', Generators\StringPasswordGenerator::class);
 85 |         $service->addPasswordGenerator('numeric', Generators\NumericPasswordGenerator::class);
 86 |         $service->addPasswordGenerator('numeric-no-0', Generators\NumericNo0PasswordGenerator::class);
 87 |     }
 88 | 
 89 |     /**
 90 |      * Get the project config path.
 91 |      *
 92 |      * @return string
 93 |      */
 94 |     private function configPath()
 95 |     {
 96 |         return __DIR__.'/../config/temporary_access.php';
 97 |     }
 98 | 
 99 |     /**
100 |      * Get the migration path.
101 |      *
102 |      * @return string
103 |      */
104 |     private function migrationPath()
105 |     {
106 |         return __DIR__.'/../database/migrations/';
107 |     }
108 | 
109 |     /**
110 |      * Get the view path.
111 |      *
112 |      * @return string
113 |      */
114 |     private function viewPath()
115 |     {
116 |         return __DIR__.'/../views/';
117 |     }
118 | }
119 | 


--------------------------------------------------------------------------------
/src/Http/Controllers/OtpController.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * @copyright 2018 Hilmi Erdem KEREN
  5 |  * @license MIT
  6 |  */
  7 | 
  8 | namespace Erdemkeren\TemporaryAccess\Http\Controllers;
  9 | 
 10 | use Illuminate\Http\Request;
 11 | use Illuminate\Contracts\View\View;
 12 | use Illuminate\Http\RedirectResponse;
 13 | use Erdemkeren\TemporaryAccess\TokenInterface;
 14 | use Illuminate\Contracts\Auth\Authenticatable;
 15 | use Illuminate\Support\Facades\Validator as ValidatorFacade;
 16 | use Illuminate\Contracts\Validation\Validator as ValidatorInterface;
 17 | use Erdemkeren\TemporaryAccess\TemporaryAccessFacade as TemporaryAccess;
 18 | 
 19 | /**
 20 |  * Class OtpController.
 21 |  */
 22 | class OtpController
 23 | {
 24 |     /**
 25 |      * * Show the form for the otp submission.
 26 |      *
 27 |      * @return RedirectResponse|View
 28 |      */
 29 |     public function create()
 30 |     {
 31 |         if (! $this->otpHasBeenRequested()) {
 32 |             return redirect('/');
 33 |         }
 34 | 
 35 |         return view('otp.create');
 36 |     }
 37 | 
 38 |     /**
 39 |      * Store the otp in cookies and redirect user
 40 |      * to their original path.
 41 |      *
 42 |      * @param Request $request
 43 |      *
 44 |      * @return RedirectResponse
 45 |      */
 46 |     public function store(Request $request): RedirectResponse
 47 |     {
 48 |         if (! $this->otpHasBeenRequested()) {
 49 |             return redirect('/');
 50 |         }
 51 | 
 52 |         $validator = $this->getOtpSubmissionRequestValidator($request);
 53 | 
 54 |         if ($validator->fails()) {
 55 |             return redirect()->back()->withErrors($validator);
 56 |         }
 57 | 
 58 |         if (! $token = $this->retrieveOtpTokenByPlainText(
 59 |             $request->user(),
 60 |             $request->input('password')
 61 |         )) {
 62 |             $validator->getMessageBag()->add(
 63 |                 'password',
 64 |                 'The password is not valid.'
 65 |             );
 66 | 
 67 |             return redirect()->back()->withErrors($validator);
 68 |         }
 69 | 
 70 |         if ($token->expired()) {
 71 |             $validator->getMessageBag()->add(
 72 |                 'password',
 73 |                 'The password is expired.'
 74 |             );
 75 | 
 76 |             return redirect()->back()->withErrors($validator);
 77 |         }
 78 | 
 79 |         session()->forget('otp_requested');
 80 | 
 81 |         return redirect()
 82 |             ->to(session()->pull('otp_redirect_url'))
 83 |             ->withCookie(
 84 |                 cookie()->make('otp_token', (string) $token, $token->expiryTime() / 60)
 85 |             );
 86 |     }
 87 | 
 88 |     /**
 89 |      * Validate the given otp submission request.
 90 |      *
 91 |      * @param Request $request
 92 |      *
 93 |      * @return ValidatorInterface
 94 |      */
 95 |     private function getOtpSubmissionRequestValidator(Request $request): ValidatorInterface
 96 |     {
 97 |         return ValidatorFacade::make($request->all(), [
 98 |             'password' => 'required|string',
 99 |         ]);
100 |     }
101 | 
102 |     /**
103 |      * Retrieve a token by the given user and password.
104 |      *
105 |      * @param Authenticatable $user
106 |      * @param string          $password
107 |      *
108 |      * @return mixed
109 |      */
110 |     private function retrieveOtpTokenByPlainText(Authenticatable $user, string $password): ?TokenInterface
111 |     {
112 |         return TemporaryAccess::retrieveByPlainText($user, $password);
113 |     }
114 | 
115 |     /**
116 |      * Determine if an otp requested or not.
117 |      *
118 |      * @return mixed
119 |      */
120 |     private function otpHasBeenRequested()
121 |     {
122 |         return session('otp_requested', false);
123 |     }
124 | }
125 | 


--------------------------------------------------------------------------------
/src/TemporaryAccessService.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * @copyright 2018 Hilmi Erdem KEREN
  5 |  * @license MIT
  6 |  */
  7 | 
  8 | namespace Erdemkeren\TemporaryAccess;
  9 | 
 10 | use Illuminate\Contracts\Auth\Authenticatable;
 11 | 
 12 | /**
 13 |  * Class TemporaryAccessService.
 14 |  */
 15 | class TemporaryAccessService
 16 | {
 17 |     /**
 18 |      * The password generator manager.
 19 |      *
 20 |      * @var PasswordGeneratorManagerInterface
 21 |      */
 22 |     private $manager;
 23 | 
 24 |     /**
 25 |      * The encryptor implementation.
 26 |      *
 27 |      * @var EncryptorInterface
 28 |      */
 29 |     private $encryptor;
 30 | 
 31 |     /**
 32 |      * The password length.
 33 |      *
 34 |      * @var int
 35 |      */
 36 |     private $passwordLength;
 37 | 
 38 |     /**
 39 |      * The default temporary access password generator.
 40 |      *
 41 |      * @var string
 42 |      */
 43 |     private $defaultGenerator;
 44 | 
 45 |     /**
 46 |      * The password generator.
 47 |      *
 48 |      * @var callable
 49 |      */
 50 |     private $passwordGenerator;
 51 | 
 52 |     /**
 53 |      * The name of the token class being used
 54 |      * by the temporary access service.
 55 |      *
 56 |      * @var string
 57 |      */
 58 |     private $tokenClass;
 59 | 
 60 |     /**
 61 |      * TemporaryAccessService constructor.
 62 |      *
 63 |      * @param PasswordGeneratorManagerInterface $manager
 64 |      * @param EncryptorInterface                $encryptor
 65 |      * @param string                            $defaultGenerator
 66 |      * @param int                               $passwordLength
 67 |      * @param string                            $tokenClass
 68 |      */
 69 |     public function __construct(
 70 |         PasswordGeneratorManagerInterface $manager,
 71 |         EncryptorInterface $encryptor,
 72 |         string $defaultGenerator,
 73 |         int $passwordLength,
 74 |         string $tokenClass
 75 |     ) {
 76 |         $this->manager = $manager;
 77 |         $this->encryptor = $encryptor;
 78 |         $this->passwordLength = $passwordLength;
 79 |         $this->defaultGenerator = $defaultGenerator;
 80 | 
 81 |         if (! class_exists($tokenClass)) {
 82 |             throw new \RuntimeException(
 83 |                 "The token implementation [{$tokenClass}] could not be found."
 84 |             );
 85 |         }
 86 | 
 87 |         $generatorReflection = new \ReflectionClass($tokenClass);
 88 |         if (! $generatorReflection->isInstantiable()) {
 89 |             throw new \RuntimeException(
 90 |                 "The token implementation [{$tokenClass}] is not instantiable."
 91 |             );
 92 |         }
 93 | 
 94 |         if (! is_subclass_of($tokenClass, TokenInterface::class)) {
 95 |             throw new \TypeError(
 96 |                 'The token class should be an instance of '.TokenInterface::class
 97 |             );
 98 |         }
 99 | 
100 |         $this->tokenClass = $tokenClass;
101 |     }
102 | 
103 |     /**
104 |      * Check the temporary access of the authenticable
105 |      * with the given cipher text.
106 |      *
107 |      * @param mixed  $authenticableId
108 |      * @param string $token
109 |      *
110 |      * @return bool
111 |      */
112 |     public function check($authenticableId, string $token): bool
113 |     {
114 |         $token = $this->retrieveByCipherText($authenticableId, $token);
115 | 
116 |         return (bool) $token && ! $token->expired();
117 |     }
118 | 
119 |     /**
120 |      * Set the active password generator of the temporary access service.
121 |      *
122 |      * @param string $name
123 |      */
124 |     public function setPasswordGenerator(string $name): void
125 |     {
126 |         $this->passwordGenerator = $this->manager->get($name);
127 |     }
128 | 
129 |     /**
130 |      * Create a new temporary access token.
131 |      *
132 |      * @param Authenticatable|mixed $authenticatableId
133 |      * @param int                   $length
134 |      *
135 |      * @return Token
136 |      */
137 |     public function create($authenticatableId, ?int $length = null): TokenInterface
138 |     {
139 |         $plainText = $this->getPasswordGenerator()($length ?: $this->passwordLength);
140 |         $cipherText = $this->encryptor->encrypt($plainText);
141 | 
142 |         if ($authenticatableId instanceof Authenticatable) {
143 |             $authenticatableId = $authenticatableId->getAuthIdentifier();
144 |         }
145 | 
146 |         return $this->tokenClass::create($authenticatableId, $cipherText, $plainText);
147 |     }
148 | 
149 |     /**
150 |      * Retrieve the token of the authenticable
151 |      * by the given plain text.
152 |      *
153 |      * @param mixed  $authenticableId
154 |      * @param string $plainText
155 |      *
156 |      * @return null|TokenInterface
157 |      */
158 |     public function retrieveByPlainText($authenticableId, string $plainText): ?TokenInterface
159 |     {
160 |         return $this->retrieveByCipherText($authenticableId, $this->encryptor->encrypt($plainText));
161 |     }
162 | 
163 |     /**
164 |      * Retrieve the token of the authenticable
165 |      * by the given cipher text.
166 |      *
167 |      * @param mixed  $authenticableId
168 |      * @param string $cipherText
169 |      *
170 |      * @return null|TokenInterface
171 |      */
172 |     public function retrieveByCipherText($authenticableId, string $cipherText): ?TokenInterface
173 |     {
174 |         if ($authenticableId instanceof Authenticatable) {
175 |             $authenticableId = $authenticableId->getAuthIdentifier();
176 |         }
177 | 
178 |         return $this->tokenClass::retrieveByAttributes([
179 |             'authenticable_id' => $authenticableId,
180 |             'cipher_text'      => $cipherText,
181 |         ]);
182 |     }
183 | 
184 |     /**
185 |      * Add a new password generator implementation.
186 |      *
187 |      * @param string                                     $name
188 |      * @param callable|PasswordGeneratorInterface|string $generator
189 |      */
190 |     public function addPasswordGenerator(string $name, $generator): void
191 |     {
192 |         $this->manager->register($name, $generator);
193 |     }
194 | 
195 |     /**
196 |      * Get the active password generator.
197 |      *
198 |      * @return callable
199 |      */
200 |     private function getPasswordGenerator(): callable
201 |     {
202 |         return $this->passwordGenerator ?: $this->passwordGenerator = $this->manager->get($this->defaultGenerator);
203 |     }
204 | }
205 | 


--------------------------------------------------------------------------------
/.php_cs:
--------------------------------------------------------------------------------
  1 | <?php
  2 | $header = <<<'EOF'
  3 | @copyright 2018 Hilmi Erdem KEREN
  4 | @license MIT
  5 | EOF;
  6 | $excludedFolders = [
  7 |     'scripts',
  8 |     'vendor',
  9 |     'config',
 10 | ];
 11 | 
 12 | $config = PhpCsFixer\Config::create()
 13 |     ->setRiskyAllowed(true)
 14 |     ->setRules([
 15 |         // Migration and Presets
 16 |         '@PHP56Migration' => true,
 17 |         '@PHPUnit60Migration:risky' => true,
 18 |         '@Symfony' => true,
 19 |         '@Symfony:risky' => true,
 20 | 
 21 |         // Laravel
 22 |         'phpdoc_align' => true,
 23 |         'binary_operator_spaces' => [
 24 |             'align_double_arrow' => true,
 25 |             'align_equals' => false,
 26 |         ],
 27 |         'blank_line_after_namespace' => true,
 28 |         'blank_line_after_opening_tag' => true,
 29 |         'blank_line_before_return' => true,
 30 |         'braces' => true,
 31 |         'cast_spaces' => [
 32 |              'space' => 'single',
 33 |          ],
 34 |         'class_definition' => [
 35 |             'single_line' => true,
 36 |         ],
 37 |         'concat_space' => [
 38 |             'spacing' => 'none',
 39 |         ],
 40 |         'declare_equal_normalize' => true,
 41 |         'elseif' => true,
 42 |         'encoding' => true,
 43 |         'full_opening_tag' => true,
 44 |         'function_declaration' => true,
 45 |         'function_typehint_space' => true,
 46 |         'hash_to_slash_comment' => true,
 47 |         'heredoc_to_nowdoc' => true,
 48 |         'include' => true,
 49 |         'indentation_type' => true,
 50 |         'ordered_imports' => [
 51 |             'sortAlgorithm' => 'length',
 52 |         ],
 53 |         'lowercase_cast' => true,
 54 |         'lowercase_constants' => true,
 55 |         'lowercase_keywords' => true,
 56 |         'magic_constant_casing' => true,
 57 |         'method_argument_space' => true,
 58 |         'class_attributes_separation' => [
 59 |             'elements' => ['method', 'property'],
 60 |         ],
 61 |         'visibility_required' => true,
 62 |         'native_function_casing' => true,
 63 |         'no_alias_functions' => true,
 64 |         'no_blank_lines_after_class_opening' => true,
 65 |         'no_blank_lines_after_phpdoc' => true,
 66 |         'no_closing_tag' => true,
 67 |         'no_empty_phpdoc' => true,
 68 |         'no_empty_statement' => true,
 69 |         'no_extra_consecutive_blank_lines' => true,
 70 |         'no_leading_import_slash' => true,
 71 |         'no_leading_namespace_whitespace' => true,
 72 |         'no_multiline_whitespace_around_double_arrow' => true,
 73 |         'no_multiline_whitespace_before_semicolons' => true,
 74 |         'no_short_bool_cast' => true,
 75 |         'no_singleline_whitespace_before_semicolons' => true,
 76 |         'no_spaces_after_function_name' => true,
 77 |         'no_spaces_around_offset' => [
 78 |             'positions' => ['inside', 'outside'],
 79 |         ],
 80 |         'no_spaces_inside_parenthesis' => true,
 81 |         'no_trailing_comma_in_list_call' => true,
 82 |         'no_trailing_comma_in_singleline_array' => true,
 83 |         'no_trailing_whitespace' => true,
 84 |         'no_trailing_whitespace_in_comment' => true,
 85 |         'no_unneeded_control_parentheses' => true,
 86 |         'no_unused_imports' => true,
 87 |         'no_useless_return' => true,
 88 |         'no_whitespace_before_comma_in_array' => true,
 89 |         'no_whitespace_in_blank_line' => true,
 90 |         'normalize_index_brace' => true,
 91 |         'object_operator_without_whitespace' => true,
 92 |         'phpdoc_indent' => true,
 93 |         'phpdoc_inline_tag' => true,
 94 |         'phpdoc_no_access' => true,
 95 |         'phpdoc_no_package' => true,
 96 |         'phpdoc_no_useless_inheritdoc' => true,
 97 |         'phpdoc_scalar' => true,
 98 |         'phpdoc_single_line_var_spacing' => true,
 99 |         'phpdoc_summary' => true,
100 |         'phpdoc_to_comment' => true,
101 |         'phpdoc_trim' => true,
102 |         'phpdoc_no_alias_tag' => [
103 |             'replacements' => [
104 |                 'property-read' => 'property',
105 |                 'property-write' => 'property',
106 |                 'type' => 'var',
107 |                 'link' => 'see',
108 |             ]
109 |         ],
110 |         'phpdoc_types' => true,
111 |         'phpdoc_var_without_name' => true,
112 |         'no_mixed_echo_print' => true,
113 |         'psr4' => true, // risky!
114 |         'self_accessor' => true,
115 |         'array_syntax' => ['syntax' => 'short'],
116 |         'short_scalar_cast' => true,
117 |         'simplified_null_return' => true,
118 |         'single_blank_line_at_eof' => true,
119 |         'single_blank_line_before_namespace' => true,
120 |         'single_class_element_per_statement' => true,
121 |         'single_import_per_statement' => true,
122 |         'single_line_after_imports' => true,
123 |         'single_quote' => true,
124 |         'space_after_semicolon' => true,
125 |         'standardize_not_equals' => true,
126 |         'switch_case_semicolon_to_colon' => true,
127 |         'switch_case_space' => true,
128 |         'ternary_operator_spaces' => true,
129 |         'trailing_comma_in_multiline_array' => true,
130 |         'no_trailing_comma_in_singleline_array' => true,
131 |         'trim_array_spaces' => true,
132 |         'unary_operator_spaces' => false,
133 |         'line_ending' => true,
134 |         'whitespace_after_comma_in_array' => true,
135 | 
136 |         // Customization
137 |         'align_multiline_comment' => [
138 |             'comment_type' => 'phpdocs_like'
139 |         ],
140 |         'combine_consecutive_issets' => true,
141 |         'combine_consecutive_unsets' => true,
142 |         'compact_nullable_typehint' => true,
143 |         'escape_implicit_backslashes' => true,
144 |         'explicit_indirect_variable' => true,
145 |         'explicit_string_variable' => true,
146 | 
147 |         'final_internal_class' => true,
148 |         'list_syntax' => ['syntax' => 'long'],
149 |         'method_chaining_indentation' => true,
150 |         'no_extra_blank_lines' => [
151 |             'tokens' => [
152 |                 'break', 'continue', 'extra', 'return', 'throw', 'use', 'use_trait',
153 |                 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'
154 |             ]
155 |         ],
156 |         'no_null_property_initialization' => true,
157 |         'no_short_echo_tag' => true,
158 |         'no_superfluous_elseif' => true,
159 |         'no_unneeded_curly_braces' => true,
160 |         'no_unneeded_final_method' => true,
161 |         'no_unreachable_default_argument_value' => true,
162 |         'no_useless_else' => true,
163 |         'no_useless_return' => true,
164 |         'ordered_class_elements' => true,
165 |         'php_unit_strict' => true,
166 |         'php_unit_test_annotation' => true,
167 |         'php_unit_test_class_requires_covers' => true,
168 |         'phpdoc_add_missing_param_annotation' => true,
169 |         'phpdoc_order' => true,
170 |         'phpdoc_types_order' => true,
171 |         'semicolon_after_instruction' => true,
172 |         'strict_comparison' => true,
173 |         'strict_param' => true,
174 |         'yoda_style' => true,
175 | 
176 |         // Customization
177 |         'header_comment' => ['header' => $header],
178 |     ])
179 |     ->setFinder(
180 |         PhpCsFixer\Finder::create()
181 |             ->exclude($excludedFolders)
182 |             ->notName('server.php')
183 |             ->in(__DIR__)
184 |     )
185 | ;
186 | 
187 | try {
188 |     PhpCsFixer\FixerFactory::create()
189 |         ->registerBuiltInFixers()
190 |         ->registerCustomFixers($config->getCustomFixers())
191 |         ->useRuleSet(new PhpCsFixer\RuleSet($config->getRules()));
192 | } catch (PhpCsFixer\ConfigurationException\InvalidConfigurationException $e) {
193 |     $config->setRules([]);
194 | } catch (UnexpectedValueException $e) {
195 |     $config->setRules([]);
196 | } catch (InvalidArgumentException $e) {
197 |     $config->setRules([]);
198 | }
199 | 
200 | return $config;
201 | 


--------------------------------------------------------------------------------
/src/Token.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * @copyright 2018 Hilmi Erdem KEREN
  5 |  * @license MIT
  6 |  */
  7 | 
  8 | namespace Erdemkeren\TemporaryAccess;
  9 | 
 10 | use Carbon\Carbon;
 11 | use Illuminate\Support\Facades\DB;
 12 | use Illuminate\Notifications\Notification;
 13 | 
 14 | /**
 15 |  * Class Token.
 16 |  */
 17 | class Token implements TokenInterface
 18 | {
 19 |     /**
 20 |      * The attributes of the token.
 21 |      *
 22 |      * @var array
 23 |      */
 24 |     public $attributes = [
 25 |         'authenticable_id' => null,
 26 |         'plain_text'       => null,
 27 |         'expiry_time'      => null,
 28 |         'cipher_text'      => null,
 29 |         'created_at'       => null,
 30 |         'updated_at'       => null,
 31 |     ];
 32 | 
 33 |     /**
 34 |      * Token constructor.
 35 |      *
 36 |      * @param int|mixed|string $authenticableId
 37 |      * @param string           $cipherText
 38 |      * @param null|string      $plainText
 39 |      * @param null|int         $expiryTime
 40 |      * @param null|Carbon      $createdAt
 41 |      * @param null|Carbon      $updatedAt
 42 |      */
 43 |     public function __construct(
 44 |         $authenticableId,
 45 |         string $cipherText,
 46 |         ?string $plainText = null,
 47 |         ?int    $expiryTime = null,
 48 |         ?Carbon $createdAt = null,
 49 |         ?Carbon $updatedAt = null
 50 |     ) {
 51 |         $now = $this->getNow();
 52 | 
 53 |         if (null === $authenticableId) {
 54 |             throw new \LogicException(
 55 |                 'The unique identifier of token owner shall not be null.'
 56 |             );
 57 |         }
 58 | 
 59 |         $this->attributes['authenticable_id'] = $authenticableId;
 60 |         $this->attributes['plain_text'] = $plainText;
 61 |         $this->attributes['cipher_text'] = $cipherText;
 62 |         $this->attributes['created_at'] = $createdAt ?: $now;
 63 |         $this->attributes['updated_at'] = $updatedAt ?: $now;
 64 |         $this->attributes['expiry_time'] = null === $expiryTime ? $this->getDefaultExpiryTime() : $expiryTime;
 65 |     }
 66 | 
 67 |     /**
 68 |      * Convert the token to string.
 69 |      *
 70 |      * @return string
 71 |      */
 72 |     public function __toString(): string
 73 |     {
 74 |         return $this->cipherText();
 75 |     }
 76 | 
 77 |     /**
 78 |      * Get the unique identifier of the authenticable
 79 |      * who owns the token.
 80 |      *
 81 |      * @return mixed
 82 |      */
 83 |     public function authenticableId()
 84 |     {
 85 |         return $this->attributes['authenticable_id'];
 86 |     }
 87 | 
 88 |     /**
 89 |      * Get the token as cipher text.
 90 |      *
 91 |      * @return string
 92 |      */
 93 |     public function cipherText(): string
 94 |     {
 95 |         return $this->attributes['cipher_text'];
 96 |     }
 97 | 
 98 |     /**
 99 |      * Get the token as plain text.
100 |      *
101 |      * @return null|string
102 |      */
103 |     public function plainText(): ?string
104 |     {
105 |         return $this->attributes['plain_text'];
106 |     }
107 | 
108 |     /**
109 |      * Get the date token created.
110 |      *
111 |      * @return Carbon
112 |      */
113 |     public function createdAt(): Carbon
114 |     {
115 |         return clone $this->attributes['created_at'];
116 |     }
117 | 
118 |     /**
119 |      * Get the last update date of the token.
120 |      *
121 |      * @return Carbon
122 |      */
123 |     public function updatedAt(): Carbon
124 |     {
125 |         return clone $this->attributes['updated_at'];
126 |     }
127 | 
128 |     /**
129 |      * Get the expiry time of the token in seconds.
130 |      *
131 |      * @return int
132 |      */
133 |     public function expiryTime(): int
134 |     {
135 |         return $this->attributes['expiry_time'];
136 |     }
137 | 
138 |     /**
139 |      * Get the date time the token will expire.
140 |      *
141 |      * @return Carbon
142 |      */
143 |     public function expiresAt(): Carbon
144 |     {
145 |         return (clone $this->createdAt())->addSeconds($this->expiryTime());
146 |     }
147 | 
148 |     /**
149 |      * Get the validity time left for the token.
150 |      *
151 |      * @return int
152 |      */
153 |     public function timeLeft(): int
154 |     {
155 |         return $this->getNow()->diffInSeconds($this->expiresAt(), false);
156 |     }
157 | 
158 |     /**
159 |      * Determine if the token is expired or not.
160 |      *
161 |      * @return bool
162 |      */
163 |     public function expired(): bool
164 |     {
165 |         return $this->timeLeft() <= 0;
166 |     }
167 | 
168 |     /**
169 |      * Alias for invalidate.
170 |      */
171 |     public function revoke(): void
172 |     {
173 |         $this->invalidate();
174 |     }
175 | 
176 |     /**
177 |      * Invalidate the token.
178 |      */
179 |     public function invalidate(): void
180 |     {
181 |         $this->attributes['expiry_time'] = 0;
182 | 
183 |         $this->persist();
184 |     }
185 | 
186 |     /**
187 |      * Extend the validity of the token.
188 |      *
189 |      * @param null|int $seconds
190 |      *
191 |      * @return bool
192 |      */
193 |     public function extend(?int $seconds = null): bool
194 |     {
195 |         $seconds = null === $seconds ? $this->getDefaultExpiryTime() : $seconds;
196 | 
197 |         $this->attributes['expiry_time'] += $seconds;
198 | 
199 |         return $this->persist();
200 |     }
201 | 
202 |     /**
203 |      * Refresh the token.
204 |      *
205 |      * @return bool
206 |      */
207 |     public function refresh(): bool
208 |     {
209 |         return $this->extend(
210 |             $this->getNow()->diffInSeconds($this->updatedAt())
211 |         );
212 |     }
213 | 
214 |     /**
215 |      * Create a new token.
216 |      *
217 |      * @param $authenticableId
218 |      * @param string      $cipherText
219 |      * @param null|string $plainText
220 |      *
221 |      * @return TokenInterface
222 |      */
223 |     public static function create(
224 |         $authenticableId,
225 |         string $cipherText,
226 |         ?string $plainText = null
227 |     ): TokenInterface {
228 |         $token = new self($authenticableId, $cipherText, $plainText);
229 | 
230 |         $token->persist();
231 | 
232 |         return $token;
233 |     }
234 | 
235 |     /**
236 |      * Retrieve a token by the given attributes from the storage.
237 |      *
238 |      * @param array $attributes
239 |      *
240 |      * @return null|TokenInterface
241 |      */
242 |     public static function retrieveByAttributes(array $attributes): ?TokenInterface
243 |     {
244 |         $query = DB::table(self::getTable());
245 | 
246 |         foreach ($attributes as $key => $value) {
247 |             $query->where($key, $value);
248 |         }
249 | 
250 |         if (! $entity = $query->first()) {
251 |             return null;
252 |         }
253 | 
254 |         return new static(
255 |             $entity->authenticable_id,
256 |             $entity->cipher_text,
257 |             null,
258 |             $entity->expiry_time,
259 |             new Carbon($entity->created_at),
260 |             new Carbon($entity->updated_at)
261 |         );
262 |     }
263 | 
264 |     /**
265 |      * Convert the token to a token notification.
266 |      *
267 |      * @return Notification
268 |      */
269 |     public function toNotification(): Notification
270 |     {
271 |         return new TokenNotification($this);
272 |     }
273 | 
274 |     /**
275 |      * Persist the token in the storage.
276 |      *
277 |      * @return bool
278 |      */
279 |     protected function persist(): bool
280 |     {
281 |         $this->attributes['created_at'] = $this->attributes['created_at']->toDateTimeString();
282 |         $this->attributes['updated_at'] = $this->getNow()->toDateTimeString();
283 | 
284 |         $attributes = $this->attributes;
285 | 
286 |         if (array_key_exists('plain_text', $attributes)) {
287 |             unset($attributes['plain_text']);
288 |         }
289 | 
290 |         try {
291 |             DB::beginTransaction();
292 | 
293 |             DB::table(self::getTable())->updateOrInsert([
294 |                 'authenticable_id' => $this->authenticableId(),
295 |                 'cipher_text'      => $this->cipherText(),
296 |             ], $attributes);
297 | 
298 |             DB::commit();
299 |         } catch (\Exception $e) {
300 |             DB::rollBack();
301 | 
302 |             throw new \RuntimeException(
303 |                 'Something went wrong while saving the access token.',
304 |                 0,
305 |                 $e
306 |             );
307 |         }
308 | 
309 |         return true;
310 |     }
311 | 
312 |     /**
313 |      * Get the date time at the moment.
314 |      *
315 |      * @return Carbon
316 |      */
317 |     private function getNow(): Carbon
318 |     {
319 |         return Carbon::now();
320 |     }
321 | 
322 |     /**
323 |      * Get the name of the table token will be persisted.
324 |      *
325 |      * @return string
326 |      */
327 |     private static function getTable(): string
328 |     {
329 |         return config('temporary_access.table');
330 |     }
331 | 
332 |     /**
333 |      * Get the default expiry time in seconds.
334 |      *
335 |      * @return int
336 |      */
337 |     private function getDefaultExpiryTime(): int
338 |     {
339 |         return config('temporary_access.expires') * 60;
340 |     }
341 | }
342 | 


--------------------------------------------------------------------------------
/package.xml:
--------------------------------------------------------------------------------
   1 | <?xml version="1.0" encoding="UTF-8"?>
   2 | <package packagerversion="1.10.5" version="2.0" xmlns="http://pear.php.net/dtd/package-2.0" xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0 http://pear.php.net/dtd/tasks-1.0.xsd http://pear.php.net/dtd/package-2.0 http://pear.php.net/dtd/package-2.0.xsd">
   3 |  <name>xdebug</name>
   4 |  <channel>pecl.php.net</channel>
   5 |  <summary>Provides functions for function traces and profiling</summary>
   6 |  <description>The Xdebug extension helps you debugging your script by providing a lot of
   7 | valuable debug information. The debug information that Xdebug can provide
   8 | includes the following:
   9 | 
  10 |     * stack and function traces in error messages with:
  11 |           o full parameter display for user defined functions
  12 |           o function name, file name and line indications
  13 |           o support for member functions
  14 |     * memory allocation
  15 |     * protection for infinite recursions
  16 | 
  17 | Xdebug also provides:
  18 | 
  19 |     * profiling information for PHP scripts
  20 |     * code coverage analysis
  21 |     * capabilities to debug your scripts interactively with a debug client</description>
  22 |  <lead>
  23 |   <name>Derick Rethans</name>
  24 |   <user>derick</user>
  25 |   <email>derick@xdebug.org</email>
  26 |   <active>yes</active>
  27 |  </lead>
  28 |  <date>2018-01-29</date>
  29 |  <time>20:08:11</time>
  30 |  <version>
  31 |   <release>2.6.0</release>
  32 |   <api>2.6.0</api>
  33 |  </version>
  34 |  <stability>
  35 |   <release>stable</release>
  36 |   <api>stable</api>
  37 |  </stability>
  38 |  <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
  39 |  <notes>
  40 | Mon, Jan 29, 2018 - xdebug 2.6.0
  41 | 
  42 | = Fixed bugs:
  43 | 
  44 |   - Fixed issue #1522: Remote debugging test failures on s390 (Big Endian).
  45 |  </notes>
  46 |  <contents>
  47 |   <dir name="/">
  48 |    <file md5sum="f1a8add55b2a30dea5f6769a84846908" name="contrib/tracefile-analyser.php" role="doc" />
  49 |    <file md5sum="ed01d7b0936a39822cd5c9144852e1b9" name="contrib/xt.vim" role="doc" />
  50 |    <file md5sum="8c6f306c33bfaf9acfbda6d2f976b8e3" name="debugclient/build/buildcheck.sh" role="src" />
  51 |    <file md5sum="e796e364148aee1796320b90431bed9b" name="debugclient/build/buildconf1.mk" role="src" />
  52 |    <file md5sum="4d4b8c43b0c0a5570e31761f05685a5d" name="debugclient/build/buildconf2.mk" role="src" />
  53 |    <file md5sum="fa89e547ca74aa76eee82ed9c4d2daeb" name="debugclient/build/clean.mk" role="src" />
  54 |    <file md5sum="306c941e88a71fd3522fd82228563ec9" name="debugclient/build/config-stubs" role="src" />
  55 |    <file md5sum="b10bdc5308cfa1bfadf88477759e8612" name="debugclient/acinclude.m4" role="src" />
  56 |    <file md5sum="fda34bdcb4283930f9055a263e3ddb28" name="debugclient/buildconf" role="src" />
  57 |    <file md5sum="253fc424977def9dd5b58f7a4b42612a" name="debugclient/config.guess" role="src" />
  58 |    <file md5sum="15aa53ae3adcec232c145a3fa8590c23" name="debugclient/config.h.in" role="src" />
  59 |    <file md5sum="c31eb7b68f55a62a2223734c80c18d1f" name="debugclient/config.sub" role="src" />
  60 |    <file md5sum="b7b1d0ee2305fa83a823b38fb4f15dc8" name="debugclient/configure" role="src" />
  61 |    <file md5sum="d4e618720c6c1c92fb16ddb19e77db42" name="debugclient/configure.in" role="src" />
  62 |    <file md5sum="cee6647ceb4340358991d5e65cdf5c43" name="debugclient/cvsclean" role="src" />
  63 |    <file md5sum="fd5909387a0942054c5fe0ca2c233cc7" name="debugclient/debugclient.dsp" role="src" />
  64 |    <file md5sum="636e2d2075c5ec88671ae84f3e69d6dd" name="debugclient/depcomp" role="src" />
  65 |    <file md5sum="05f2f7acf75122094a96ac9670251f9d" name="debugclient/INSTALL" role="src" />
  66 |    <file md5sum="5afe8eb5573965dfb58378e4e46f3813" name="debugclient/install-sh" role="src" />
  67 |    <file md5sum="a18aadbac8e9327d347421eaf10334ee" name="debugclient/LICENSE" role="src" />
  68 |    <file md5sum="d6b4129d1b30e56415d267e320c00c02" name="debugclient/ltmain.sh" role="src" />
  69 |    <file md5sum="c1a7ddee47f20584e39e91da03f5cbc2" name="debugclient/main.c" role="src" />
  70 |    <file md5sum="542c07a45706363be2d822fd107fca3d" name="debugclient/Makefile.in" role="src" />
  71 |    <file md5sum="d41d8cd98f00b204e9800998ecf8427e" name="debugclient/missing" role="src" />
  72 |    <file md5sum="20af8d0d8c9b4478a446c1dee0a0c0f0" name="debugclient/mkinstalldirs" role="src" />
  73 |    <file md5sum="d0718f626f54d3171168ab3ca2a2cbe4" name="debugclient/usefulstuff.c" role="src" />
  74 |    <file md5sum="557a75cfa12cf8ca6ba47537bd2c1902" name="debugclient/usefulstuff.h" role="src" />
  75 |    <file md5sum="7647e99980824f9fda779a9c26e4a7d2" name="config.m4" role="src" />
  76 |    <file md5sum="96ff6898eb3caf282dd2b1aae530d0ab" name="config.w32" role="src" />
  77 |    <file md5sum="8f9a93feba6ff23c4bc1bc2929babcc4" name="CREDITS" role="doc" />
  78 |    <file md5sum="34df3a274aa12b795417c65634c07f16" name="LICENSE" role="doc" />
  79 |    <file md5sum="c1355136765e8f65a2e69e7b8cafbba1" name="xdebug.ini" role="doc" />
  80 |    <file md5sum="a88bc3039991574186377fc15dd85ea3" name="Makefile.frag" role="src" />
  81 |    <file md5sum="6227c9cc183b9a976781039e69d9830d" name="php_xdebug.h" role="src" />
  82 |    <file md5sum="9769d3f718a107de05100932d7bde942" name="README.rst" role="doc" />
  83 |    <file md5sum="f58641fb97f53152a39630065eb253bd" name="usefulstuff.c" role="src" />
  84 |    <file md5sum="67701ce549cdaa17f98920fec6c47461" name="usefulstuff.h" role="src" />
  85 |    <file md5sum="5e9777c93827cc9b38fca2982b2f5cfb" name="xdebug.c" role="src" />
  86 |    <file md5sum="5922c9c9fc7eb29bfe0feb1f2ca0397a" name="xdebug_branch_info.c" role="src" />
  87 |    <file md5sum="2c75441d726918ee6f3c99e93a7ce5a9" name="xdebug_branch_info.h" role="src" />
  88 |    <file md5sum="2cc02d94b76c2c46937614b0196cb1fe" name="xdebug_code_coverage.c" role="src" />
  89 |    <file md5sum="463b0f12b62ef908b90a9bd58b9ffe8d" name="xdebug_code_coverage.h" role="src" />
  90 |    <file md5sum="caffc113b3a56fcb454660eafe33c884" name="xdebug_com.c" role="src" />
  91 |    <file md5sum="3e7f58c8ea664c6a2e61f707fbbfc1eb" name="xdebug_com.h" role="src" />
  92 |    <file md5sum="cf1ccd8e66bae07237b511ff4062dc63" name="xdebug_compat.c" role="src" />
  93 |    <file md5sum="19afae5ef959a8c3386d5df1b4e1a4df" name="xdebug_compat.h" role="src" />
  94 |    <file md5sum="c2e8fba62c9bf5768c885ff8d97aa49c" name="xdebug_filter.c" role="src" />
  95 |    <file md5sum="717bffa4e021a691577d48b7745b4098" name="xdebug_filter.h" role="src" />
  96 |    <file md5sum="179c1358dbe4b71c1176ae1627b2a5ca" name="xdebug_gc_stats.c" role="src" />
  97 |    <file md5sum="61fe27e1a685b9b29617660a0f595738" name="xdebug_gc_stats.h" role="src" />
  98 |    <file md5sum="9d722d13e2962648b66c379a5568b870" name="xdebug_handlers.c" role="src" />
  99 |    <file md5sum="b302bd61d729c19fce066122b93cd545" name="xdebug_handlers.h" role="src" />
 100 |    <file md5sum="e7187ef2a3c2c66f7643c2b2d17a533b" name="xdebug_handler_dbgp.c" role="src" />
 101 |    <file md5sum="c37c555b3233e3f9726f3b89cd31a07b" name="xdebug_handler_dbgp.h" role="src" />
 102 |    <file md5sum="158306c53552b364ced8c3bcda2a870a" name="xdebug_hash.c" role="src" />
 103 |    <file md5sum="670a7d93c80269233f41b1d712398c96" name="xdebug_hash.h" role="src" />
 104 |    <file md5sum="8ae6ed4d4c8d1102066ef316c2335cda" name="xdebug_llist.c" role="src" />
 105 |    <file md5sum="a69e87a4c16849b1c0a8903477760aa8" name="xdebug_llist.h" role="src" />
 106 |    <file md5sum="0730bde249d76ea2308a714cad580320" name="xdebug_mm.h" role="src" />
 107 |    <file md5sum="d8d28efe19ab45b8808fb15d9e5fa700" name="xdebug_monitor.c" role="src" />
 108 |    <file md5sum="5445ed96893d1df7ccc7e7376b49acca" name="xdebug_monitor.h" role="src" />
 109 |    <file md5sum="05a3e76f23b63a934fdba398bdc715f3" name="xdebug_private.c" role="src" />
 110 |    <file md5sum="5e6850e95f0ca3e08d56f1d7ce7cd4ba" name="xdebug_private.h" role="src" />
 111 |    <file md5sum="7ef3b08952cb7d3a5d885a95a2290b05" name="xdebug_profiler.c" role="src" />
 112 |    <file md5sum="151a0f0dc7c13fade5ca5f8e61f15303" name="xdebug_profiler.h" role="src" />
 113 |    <file md5sum="7d214f9e5a8d1c9e7df97e6ba77ca417" name="xdebug_set.c" role="src" />
 114 |    <file md5sum="a39ec14fa1d39c09554a0937ddbc4a75" name="xdebug_set.h" role="src" />
 115 |    <file md5sum="2a55a4e8e309b0936391f647582f7394" name="xdebug_stack.c" role="src" />
 116 |    <file md5sum="24992fede78292239e1efe4cb35ba89d" name="xdebug_stack.h" role="src" />
 117 |    <file md5sum="255af3f46dd24487ea8b074b5e2c2c4d" name="xdebug_str.c" role="src" />
 118 |    <file md5sum="707aa5d6c657e53a6b2f4946a795a8a9" name="xdebug_str.h" role="src" />
 119 |    <file md5sum="6f380a1f6795773d7475f9f3a047e6ca" name="xdebug_superglobals.c" role="src" />
 120 |    <file md5sum="e80de525309454b0ea33b1d685d88484" name="xdebug_superglobals.h" role="src" />
 121 |    <file md5sum="349e444a9adef5864d44c76347a10db6" name="xdebug_tracing.c" role="src" />
 122 |    <file md5sum="d14ce6837820660304d6938fee92a1b2" name="xdebug_tracing.h" role="src" />
 123 |    <file md5sum="ec1c46f4ef0393b798e06d31be800b22" name="xdebug_trace_textual.c" role="src" />
 124 |    <file md5sum="aee34ab3cc8d470cb1b1df0a919ca865" name="xdebug_trace_textual.h" role="src" />
 125 |    <file md5sum="d325bb07ff7e7ad0ae0c939f736f42ab" name="xdebug_trace_computerized.c" role="src" />
 126 |    <file md5sum="dcda87fed3082627729a014c2dc45fe0" name="xdebug_trace_computerized.h" role="src" />
 127 |    <file md5sum="add3fef400a55cb262478b2728bab5d2" name="xdebug_trace_html.c" role="src" />
 128 |    <file md5sum="dc37d31e5e35f6951540ddecdbdb47d0" name="xdebug_trace_html.h" role="src" />
 129 |    <file md5sum="416e2d8666ab66fcf794785b2b6556db" name="xdebug_var.c" role="src" />
 130 |    <file md5sum="fc3352eac15fafd59af36247d1beb319" name="xdebug_var.h" role="src" />
 131 |    <file md5sum="af973c93175b2ad81eb164a849f711b8" name="xdebug_xml.c" role="src" />
 132 |    <file md5sum="e0b12e7423e6b32d5cb55f87799b32b8" name="xdebug_xml.h" role="src" />
 133 |   </dir>
 134 |  </contents>
 135 |  <dependencies>
 136 |   <required>
 137 |    <php>
 138 |     <min>7.0.0</min>
 139 |    </php>
 140 |    <pearinstaller>
 141 |     <min>1.9.1</min>
 142 |    </pearinstaller>
 143 |   </required>
 144 |  </dependencies>
 145 |  <providesextension>xdebug</providesextension>
 146 |  <zendextsrcrelease />
 147 |  <changelog>
 148 |   <release>
 149 |    <date>2018-01-23</date>
 150 |    <time>12:53:32</time>
 151 |    <version>
 152 |     <release>2.6.0RC2</release>
 153 |     <api>2.6.0RC2</api>
 154 |    </version>
 155 |    <stability>
 156 |     <release>beta</release>
 157 |     <api>beta</api>
 158 |    </stability>
 159 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 160 |    <notes>
 161 | Tue, Jan 23, 2018 - xdebug 2.6.0RC2
 162 | 
 163 | = Fixed bugs:
 164 | 
 165 |   - Fixed issue #1521: xdebug_gc_stats.* missing from 2.6.0RC1 tarball
 166 |    </notes>
 167 |   </release>
 168 |   <release>
 169 |    <date>2018-01-22</date>
 170 |    <time>18:19:32</time>
 171 |    <version>
 172 |     <release>2.6.0RC1</release>
 173 |     <api>2.6.0RC1</api>
 174 |    </version>
 175 |    <stability>
 176 |     <release>beta</release>
 177 |     <api>beta</api>
 178 |    </stability>
 179 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 180 |    <notes>
 181 | Mon, Jan 22, 2018 - xdebug 2.6.0RC1
 182 | 
 183 | + Added features:
 184 | 
 185 |   - Fixed issue #1506: Add garbage collection statistics feature (Benjamin Eberlei).
 186 |   - Fixed issue #1507: Add functions to access Zend Engine garbage collection metrics (Benjamin Eberlei).
 187 | 
 188 | + Improvements:
 189 | 
 190 |   - Fixed issue #1510: Change switch/case &quot;break intentionally missing&quot; comments to use GCC 7&apos;s new &quot;fallthrough&quot; attribute.
 191 |   - Fixed issue #1511: Detect and use compiler flags through new configure option.
 192 | 
 193 | = Fixed bugs:
 194 | 
 195 |   - Fixed issue #1335: Debugging with PhpStorm sometimes gives &quot;can not get property&quot;.
 196 |   - Fixed issue #1454: Invalid memory read or segfaults from a __call() method.
 197 |   - Fixed issue #1508: Code coverage filter not checked in xdebug_common_assign_dim handler.
 198 |   - Fixed issue #1509: Code coverage missing for case inside switch with PHP 7.2.
 199 |   - Fixed issue #1512: Xdebug does not properly encode and escape properties with quotes and \0 characters.
 200 |   - Fixed issue #1514: Variable names with a NULL char are cut off at NULL char.
 201 |   - Fixed issue #1515: Object property names with a NULL char are cut off at NULL char.
 202 |   - Fixed issue #1516: Can&apos;t fetch variables or object properties which have \0 characters in them.
 203 |   - Fixed issue #1517: Notifications incorrectly specify the error type in &quot;type_string&quot; instead of &quot;type&quot;.
 204 |    </notes>
 205 |   </release>
 206 |   <release>
 207 |    <date>2017-12-28</date>
 208 |    <time>19:18:21</time>
 209 |    <version>
 210 |     <release>2.6.0beta1</release>
 211 |     <api>2.6.0beta1</api>
 212 |    </version>
 213 |    <stability>
 214 |     <release>beta</release>
 215 |     <api>beta</api>
 216 |    </stability>
 217 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 218 |    <notes>
 219 | Thu, Dec 28, 2017 - xdebug 2.6.0beta1
 220 | 
 221 | + Added features:
 222 | 
 223 |   - Fixed issue #1059: Add filter capabilities to tracing, stack traces, and code coverage.
 224 |   - Fixed issue #1437: Add X-Profile-File-Name header when a profile file has been generated.
 225 | 
 226 | + Improvements:
 227 | 
 228 |   - Fixed issue #1493: Run test suite in AppVeyor for Windows CI.
 229 |   - Fixed issue #1498: Use new ZEND_EXTENSION API in config.w32 build scripts. (Kalle)
 230 | 
 231 | = Fixed bugs:
 232 | 
 233 |   - Fixed issue #702: Check whether variables tracing also works with =&amp;.
 234 |   - Fixed issue #1501: Xdebug var dump tries casting properties.
 235 |   - Fixed issue #1502: SEND_REF lines are not marked as covered.
 236 |    </notes>
 237 |   </release>
 238 |   <release>
 239 |    <date>2017-12-02</date>
 240 |    <time>18:53:29</time>
 241 |    <version>
 242 |     <release>2.6.0alpha1</release>
 243 |     <api>2.6.0alpha1</api>
 244 |    </version>
 245 |    <stability>
 246 |     <release>beta</release>
 247 |     <api>beta</api>
 248 |    </stability>
 249 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 250 |    <notes>
 251 | Sat, Dec  2, 2017 - xdebug 2.6.0alpha1
 252 | 
 253 | + Added features:
 254 | 
 255 |   - Implemented issue #474: Added &quot;memory&quot; output to profiling files, to find out where memory is allocated.
 256 |   - Implemented issue #575: Dump super globals contents to error log upon errors, just like when this would happen for stack traces.
 257 |   - Implemented issue #964: Parse X-Forwarded-For for the first IP address when selecting the remote_connect_back host (Steve Easley).
 258 |   - Implemented issue #990: Add DBGp: notifications for notices and warnings to be shown in IDEs.
 259 |   - Implemented issue #1312: Implement extended_properties feature to remote debugging to support names and values with low ASCII values.
 260 |   - Implemented issue #1323: Added xdebug.filename_format setting to configure the formatting of filenames when tracing.
 261 |   - Implemented issue #1379: Added support for Unix domain sockets to xdebug.remote_host (Sara Golemon).
 262 |   - Implemented issue #1380: Added xdebug_is_debugger_active() that returns true when debugger is connected.
 263 |   - Implemented issue #1391: Added support for earlier stack frames through new argument for xdebug_call_* functions.
 264 |   - Implemented issue #1420: Handle PHP 7.2&apos;s new methods for switch/case
 265 |   - Implemented issue #1470: Added xdebug.remote_timeout to make connect timeout configurable.
 266 |   - Implemented issue #1495: Make var_dump() also use the new xdebug.filename_format when formatting filenames.
 267 | 
 268 | + Improvements:
 269 | 
 270 |   - Implemented issue #847: Added support for &quot;%s&quot; specifier for xdebug.trace_output_name.
 271 |   - Implemented issue #1384: Compile warning on Ubuntu 16.04 with GCC 5.4.x.
 272 |   - Implemented issue #1401: Improved error message in case the connection breaks.
 273 |   - Implemented issue #1430: Change DBGp tests to use TEST_PHP_EXECUTABLE instead of hard coded &apos;php&apos;
 274 |   - Implemented issue #1484: Use FD_CLOEXEC with debugging sockets to prevent FDs from leaking to forked processes (Chris Wright).
 275 |   - Improve the foldexpr in xt.vim to fold lines correctly (Donie Leigh).
 276 | 
 277 | = Fixed bugs:
 278 | 
 279 |   - Fixed issue #1272: property_get doesn&apos;t return @attributes for SimpleXMLElement.
 280 |   - Fixed issue #1305: Property names with quotes can not be fetch while debugging.
 281 |   - Fixed issue #1431: Fix &quot;use after free&quot; with in add_name_attribute_or_element.
 282 |   - Fixed issue #1432: Fixed memory leak with xdebug_path_info_dtor.
 283 |   - Fixed issue #1449: Debugging breaks with array element keys containing low-ASCII variables.
 284 |   - Fixed issue #1471: Tracing crashes with return_assignments and ternairy operator.
 285 |   - Fixed issue #1474: Crashes due to variable resolving/reading mechanism not taking care of temporary hash tables correctly (Nikita Popov, Derick).
 286 |   - Fixed issue #1481: Fixed s390x and ppc64 builds (Remi Collet).
 287 |   - Fixed issue #1486: Crash on ZEND_SWITCH_LONG / ZEND_SWITCH_STRING with more than 32 cases.
 288 |   - Fixed issue #1496: Rewrite README.rst to be more clear on how to install and build Xdebug.
 289 | 
 290 | ~ Changes:
 291 | 
 292 |   - Fixed issue #1411: Use Error (Throwable) instead of fatal error when maximum nesting level is reached.
 293 | 
 294 | - Removed features:
 295 | 
 296 |   - Implemented issue #1377: Drop support for PHP 5.5 and 5.6, only PHP 7 is now supported
 297 |    </notes>
 298 |   </release>
 299 |   <release>
 300 |    <date>2017-06-21</date>
 301 |    <time>12:08:11</time>
 302 |    <version>
 303 |     <release>2.5.5</release>
 304 |     <api>2.5.5</api>
 305 |    </version>
 306 |    <stability>
 307 |     <release>stable</release>
 308 |     <api>stable</api>
 309 |    </stability>
 310 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 311 |    <notes>
 312 | = Fixed bugs:
 313 | 
 314 |   - Fixed issue #1439: TYPE_CHECK needs overloading due to smart branches
 315 |   - Fixed issue #1444: Code Coverage misses a variable in a multi-line function
 316 |     call
 317 |   - Fixed issue #1446: Code Coverage misses elseif if it uses an isset with a
 318 |     property
 319 |    </notes>
 320 |   </release>
 321 |   <release>
 322 |    <date>2017-05-15</date>
 323 |    <time>12:08:11</time>
 324 |    <version>
 325 |     <release>2.5.4</release>
 326 |     <api>2.5.4</api>
 327 |    </version>
 328 |    <stability>
 329 |     <release>stable</release>
 330 |     <api>stable</api>
 331 |    </stability>
 332 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 333 |    <notes>
 334 | Mon, May 15, 2017 - xdebug 2.5.4
 335 | 
 336 | = Fixed bugs:
 337 | 
 338 |   - Fixed issue #799: Function traces report base class instead of object name
 339 |   - Fixed issue #1421: Fix set_time_limit hanging on PHP 5.6 when pcntl_exec
 340 |     does not exist (Frode E. Moe)
 341 |   - Fixed issue #1429: Code coverage does not cover null coalesce
 342 |   - Fixed issue #1434: Code coverage segfaults on 32-bit arch
 343 |    </notes>
 344 |   </release>
 345 |   <release>
 346 |    <date>2017-04-18</date>
 347 |    <time>19:31:21</time>
 348 |    <version>
 349 |     <release>2.5.3</release>
 350 |     <api>2.5.3</api>
 351 |    </version>
 352 |    <stability>
 353 |     <release>stable</release>
 354 |     <api>stable</api>
 355 |    </stability>
 356 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 357 |    <notes>
 358 | Mon, Apr 18, 2017 - xdebug 2.5.3
 359 | 
 360 | = Fixed bugs:
 361 | 
 362 |   - Fixed issue #1421: Xdebug crashes when it is loaded without pcntl being
 363 |     present
 364 |    </notes>
 365 |   </release>
 366 |   <release>
 367 |    <date>2017-04-17</date>
 368 |    <time>18:42:26</time>
 369 |    <version>
 370 |     <release>2.5.2</release>
 371 |     <api>2.5.2</api>
 372 |    </version>
 373 |    <stability>
 374 |     <release>stable</release>
 375 |     <api>stable</api>
 376 |    </stability>
 377 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 378 |    <notes>
 379 | Mon, Apr 17, 2017 - xdebug 2.5.2
 380 | 
 381 | = Fixed bugs:
 382 | 
 383 |   - Fixed issue #701: Functions as array indexes show ??? in trace
 384 |   - Fixed issue #1403: Code coverage does not cover BIND_STATIC
 385 |   - Fixed issue #1404: Execution time is calculated incorrectly
 386 |   - Fixed issue #1413: Code coverage mishap with PHP 7.1.3
 387 |   - Fixed issue #1414: Missing variable assignment in traces with OPcache
 388 |     loaded
 389 |   - Fixed issue #1415: Crash with multiple catch constructs with OPcache loaded
 390 |   - Fixed issue #1416: Trace files should not include the first result of a
 391 |     generator if it hasn&apos;t started yet
 392 |   - Fixed issue #1417: Fetching properties of static class contexts fails due
 393 |     to incorrect fetch mode
 394 |   - Fixed issue #1419: Summary not written when script ended with
 395 |     &quot;pcntl_exec()&quot;
 396 |    </notes>
 397 |   </release>
 398 |   <release>
 399 |    <date>2017-04-17</date>
 400 |    <time>18:42:26</time>
 401 |    <version>
 402 |     <release>2.5.2</release>
 403 |     <api>2.5.2</api>
 404 |    </version>
 405 |    <stability>
 406 |     <release>stable</release>
 407 |     <api>stable</api>
 408 |    </stability>
 409 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 410 |    <notes>
 411 | Sun, Feb 26, 2017 - xdebug 2.5.1
 412 | 
 413 | = Fixed bugs:
 414 | 
 415 |   - Fixed issue #1057: Add xdebug.ini of all settings to package
 416 |   - Fixed issue #1165: DBGp: step_out skips subsequent function calls
 417 |   - Fixed issue #1180: Code coverage crashes with non-standard start/stops
 418 |   - Fixed issue #1278: Xdebug with PHP 7 does not handle prefill-from-oparray
 419 |     for XDEBUG_CC_UNUSED
 420 |   - Fixed issue #1300: Xdebug functions are not exposing their signature to
 421 |     Reflection
 422 |   - Fixed issue #1313: Arguments to __call() trampoline picked from the wrong
 423 |     memory location
 424 |   - Fixed issue #1329: While printing out a stack with and function parameters,
 425 |     XDebug reads uninitialized zvals or free()d memory
 426 |   - Fixed issue #1381: Code Coverage misses line due to missing FETCH_DIM_W
 427 |     overload
 428 |   - Fixed issue #1385: can not fetch IS_INDIRECT properties
 429 |   - Fixed issue #1386: Executable code not shown as executed/executable
 430 |   - Fixed issue #1392: Unable to compile on FreeBSD due to missing struct
 431 |     definition
 432 |   - Fixed issue #1394: Code coverage does not cover instanceof (in elseif)
 433 |    </notes>
 434 |   </release>
 435 |   <release>
 436 |    <date>2016-12-04</date>
 437 |    <time>18:55:08</time>
 438 |    <version>
 439 |     <release>2.5.0</release>
 440 |     <api>2.5.0</api>
 441 |    </version>
 442 |    <stability>
 443 |     <release>stable</release>
 444 |     <api>stable</api>
 445 |    </stability>
 446 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 447 |    <notes>
 448 | Sun, Dec  4, 2016 - xdebug 2.5.0
 449 | 
 450 | + Added features:
 451 | 
 452 |   - Implemented issue #1232: add memory delta to HTML traces
 453 |   - Implemented issue #1365: Allow remote_connect_back to be set through
 454 |     XDEBUG_CONFIG
 455 | 
 456 | = Fixed bugs:
 457 | 
 458 |   - Fixed issue #1168: Added defensive check to prevent infinite loop
 459 |   - Fixed issue #1242: Xdebug on Windows with Eclipse has issues with
 460 |     breakpoint IDs
 461 |   - Fixed issue #1343: Wrong values of numerical keys outside 32bit range
 462 |   - Fixed issue #1357: Function signature using variadics is reported as being
 463 |     not executed
 464 |   - Fixed issue #1361: Remote debugging connection issues with Windows (Anatol
 465 |     Belski)
 466 |   - Fixed issue #1373: Crash in zend_hash_apply_with_arguments when debugging,
 467 |     due to unset symbol table
 468 |    </notes>
 469 |   </release>
 470 |   <release>
 471 |    <date>2016-11-12</date>
 472 |    <time>14:28:08</time>
 473 |    <version>
 474 |     <release>2.5.0RC1</release>
 475 |     <api>2.5.0RC1</api>
 476 |    </version>
 477 |    <stability>
 478 |     <release>stable</release>
 479 |     <api>stable</api>
 480 |    </stability>
 481 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 482 |    <notes>
 483 | Sat, Nov 12, 2016 - xdebug 2.5.0RC1
 484 | 
 485 | + Added features:
 486 | 
 487 |   - Implemented issue #998: Added support for IPv6 (Thomas Vanhaniemi)
 488 |   - Implemented issue #1297: Initial PHP 7.1 support
 489 | 
 490 | = Fixed bugs:
 491 | 
 492 |   - Fixed issue #1295: Apache crashes (SIGSEGV) when trying to establish
 493 |     connection when sockfd is large
 494 |   - Fixed issue #1303: POLLRDHUP is not supported outside of Gnu/Linux
 495 |   - Fixed issue #1331: Segfault in code coverage
 496 | 
 497 | - Removed features:
 498 | 
 499 |   - Support for PHP versions lower than PHP 5.5 has been dropped
 500 |    </notes>
 501 |   </release>
 502 |   <release>
 503 |    <date>2016-08-02</date>
 504 |    <time>11:47:08</time>
 505 |    <version>
 506 |     <release>2.4.1</release>
 507 |     <api>2.4.1</api>
 508 |    </version>
 509 |    <stability>
 510 |     <release>stable</release>
 511 |     <api>stable</api>
 512 |    </stability>
 513 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 514 |    <notes>
 515 | Tue, Aug 02, 2016 - xdebug 2.4.1
 516 | 
 517 | = Fixed bugs:
 518 | 
 519 |   - Fixed issue #1106: A thrown Exception after a class with __debugInfo gives
 520 |     2 errors
 521 |   - Fixed issue #1241: FAST_CALL/FAST_RET take #2
 522 |   - Fixed issue #1246: Path and branch coverage should be initialised per
 523 |     request, not globally
 524 |   - Fixed issue #1263: Code coverage segmentation fault with opcache enabled
 525 |   - Fixed issue #1277: Crash when using a userland function from RSHUTDOWN with
 526 |     profiling enabled
 527 |   - Fixed issue #1282: var_dump() of integers &gt; 32 bit is broken on Windows
 528 |   - Fixed issue #1288: Segfault when uncaught exception message does not
 529 |     contain &quot; in &quot;
 530 |   - Fixed issue #1291: Debugclient installation fails on Mac OS X
 531 |   - Fixed issue #1326: Tracing and generators crashes with PHP 7.x
 532 |   - Fixed issue #1333: Profiler accesses memory structures after freeing
 533 |    </notes>
 534 |   </release>
 535 |   <release>
 536 |    <date>2016-01-25</date>
 537 |    <time>20:48:33</time>
 538 |    <version>
 539 |     <release>2.4.0RC4</release>
 540 |     <api>2.4.0RC4</api>
 541 |    </version>
 542 |    <stability>
 543 |     <release>beta</release>
 544 |     <api>beta</api>
 545 |    </stability>
 546 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 547 |    <notes>
 548 | Mon, Jan 25, 2016 - xdebug 2.4.0RC4
 549 | 
 550 | = Fixed bugs:
 551 | 
 552 |   - Fixed issue #1220: Segmentation fault if var_dump() output is too large.
 553 |   - Fixed issue #1223: Xdebug crashes on PHP 7 when doing a DBGp eval command.
 554 |   - Fixed issue #1229: Issues with GCC 4.8, which in -O2 move removes some
 555 |     required code.
 556 |   - Fixed issue #1235: Xdebug does not compile against PHP 7.1-dev due to
 557 |     ZEND_FETCH_STATIC_PROP*.
 558 |   - Fixed issue #1236: Can&apos;t remove breakpoints with negative IDs.
 559 |   - Fixed issue #1238: Xdebug crashes with SIGSEGV while enumerating references
 560 |     in variables.
 561 |   - Fixed issue #1239: Crash due to changes with the CATCH opcode&apos;s jump
 562 |     mechanism in 7.1
 563 |   - Fixed issue #1241: Xdebug doesn&apos;t handle FAST_RET and FAST_CALL opcodes for
 564 |     branch/dead code analysis, and path coverage.
 565 |   - Fixed issue #1245: xdebug_dump_superglobals dumps *uninitialized* with PHP
 566 |     7.
 567 |   - Fixed issue #1250: Add PHP version descriptors to debugging log and profile
 568 |     files.
 569 |    </notes>
 570 |   </release>
 571 |   <release>
 572 |    <date>2016-03-03</date>
 573 |    <time>08:47:08</time>
 574 |    <version>
 575 |     <release>2.4.0</release>
 576 |     <api>2.4.0</api>
 577 |    </version>
 578 |    <stability>
 579 |     <release>stable</release>
 580 |     <api>stable</api>
 581 |    </stability>
 582 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 583 |    <notes>
 584 | Thu, Mar 03, 2016 - xdebug 2.4.0
 585 | 
 586 | = Fixed bugs:
 587 | 
 588 |   - Fixed issue #1258: Case in PHP 7.0 and code coverage
 589 |   - Fixed issue #1261: segmentation fault in xdebug.so with PHP 7.0 version of
 590 |     &apos;pkgtools&apos; due to spl_autoload()
 591 |   - Fixed issue #1262: overload_var_dump=0 messes with xdebug_var_dump()
 592 |   - Fixed issue #1266: xdebug_dump_superglobals() always dumps empty  stack on
 593 |     PHP 7
 594 |   - Fixed issue #1267: AIX build issues
 595 |   - Fixed issue #1270: String parsing marked not covered with PHP 7
 596 |    </notes>
 597 |   </release>
 598 |   <release>
 599 |    <date>2015-12-12</date>
 600 |    <time>20:42:33</time>
 601 |    <version>
 602 |     <release>2.4.0RC3</release>
 603 |     <api>2.4.0RC3</api>
 604 |    </version>
 605 |    <stability>
 606 |     <release>beta</release>
 607 |     <api>beta</api>
 608 |    </stability>
 609 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 610 |    <notes>
 611 | Wed, Dec 12, 2015 - xdebug 2.4.0RC3
 612 | 
 613 | = Fixed bugs:
 614 | 
 615 |   - Fixed issue #1221: Sort out Windows x64 PHP 7 support
 616 |   - Fixed issue #1229: Detect GCC 4.8 and disable optimisations when it is found
 617 | 
 618 | = Others:
 619 | 
 620 |   - Made the test suite work for Windows too. Finally, after 13 years.
 621 |    </notes>
 622 |   </release>
 623 |   <release>
 624 |    <date>2015-12-02</date>
 625 |    <time>23:31:49</time>
 626 |    <version>
 627 |     <release>2.4.0RC2</release>
 628 |     <api>2.4.0RC2</api>
 629 |    </version>
 630 |    <stability>
 631 |     <release>beta</release>
 632 |     <api>beta</api>
 633 |    </stability>
 634 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 635 |    <notes>
 636 | Wed, Dec 02, 2015 - xdebug 2.4.0RC2
 637 | 
 638 | = Fixed bugs:
 639 | 
 640 |   - Fixed issue #1181: Remote debugging does not handle exceptions after using
 641 |     zend_read_property
 642 |   - Fixed issue #1189: Remove address attribute from remote debugging responses
 643 |   - Fixed issue #1194: The error message is doubly HTML-encoded with assert()
 644 |   - Fixed issue #1210: Segfault with code coverage dead code analysis and
 645 |     foreach on PHP 7
 646 |   - Fixed issue #1215: SIGSEGV if xdebug.trace_output_dir directory does not
 647 |     exist
 648 |   - Fixed issue #1217: xdebug.show_error_trace should not be enabled by default
 649 |   - Fixed issue #1218: Xdebug messes with the exception code, by casting it to
 650 |     int
 651 |   - Fixed issue #1219: Set default value for xdebug.overload_var_dump to 2 to
 652 |     include file / line numbers by default
 653 |   - Use long for PHP 5, and zend_long for PHP 7 for ini settings in the globals
 654 |    </notes>
 655 |   </release>
 656 |   <release>
 657 |    <date>2015-11-21</date>
 658 |    <time>23:24:57</time>
 659 |    <version>
 660 |     <release>2.4.0RC1</release>
 661 |     <api>2.4.0RC1</api>
 662 |    </version>
 663 |    <stability>
 664 |     <release>beta</release>
 665 |     <api>beta</api>
 666 |    </stability>
 667 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 668 |    <notes>
 669 | Sat, Nov 21, 2015 - xdebug 2.4.0RC1
 670 | 
 671 | = Fixed bugs:
 672 | 
 673 |   - Fixed issue #1195: Segfault with code coverage and foreach
 674 |   - Fixed issue #1200: Additional opcodes need to be overloaded for PHP 7
 675 |   - Fixed issue #1202: Anonymous classes are not handled properly while remote debugging
 676 |   - Fixed issue #1203: Accessing static property of a class that has no static properties crashes while remote debugging
 677 |   - Fixed issue #1209: Segfault with building a function name for create_function
 678 |   - Restored Windows support (Includes patches by Jan Ehrhardt)
 679 |    </notes>
 680 |   </release>
 681 |   <release>
 682 |    <date>2015-11-05</date>
 683 |    <time>12:42:57</time>
 684 |    <version>
 685 |     <release>2.4.0beta1</release>
 686 |     <api>2.4.0beta1</api>
 687 |    </version>
 688 |    <stability>
 689 |     <release>beta</release>
 690 |     <api>beta</api>
 691 |    </stability>
 692 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 693 |    <notes>
 694 | Thu, Sep 05, 2015 - xdebug 2.4.0beta1
 695 | 
 696 | + Added features:
 697 | 
 698 |   - Implemented issue #1109: Added support for PHP 7.
 699 |   - Implemented issue #1153: Add function monitor functionality.
 700 |   - Implemented issue #1183: Add xdebug.show_error_trace setting to
 701 |     allow/disallow to show a stack trace for every Error (throwable)
 702 | 
 703 | = Fixed bugs:
 704 | 
 705 |   - Fixed issue #1070: Too many open files error with php-fpm: connections not
 706 |     closed. (Patch by Sean Dubois)
 707 |   - Fixed issue #1123: With Xdebug 2.3.1, PHPUnit with coverage is
 708 |     exponentially slower than without
 709 |   - Fixed issue #1166: Using $this in __debugInfo() causes infinite recursion
 710 |   - Fixed issue #1173: Segmentation fault in xdebug_get_monitored_functions()
 711 |   - Fixed issue #1182: Using PHPStorm with PHP 7 RC1 and xdebug 2.4-dev break
 712 |     points are passed by including setting break point at start of script
 713 |   - Fixed issue #1192: Dead code analysis does not work for generators with
 714 |     &apos;return;&apos;
 715 |    </notes>
 716 |   </release>
 717 |   <release>
 718 |    <date>2015-06-19</date>
 719 |    <time>16:15:00</time>
 720 |    <version>
 721 |     <release>2.3.3</release>
 722 |     <api>2.3.3</api>
 723 |    </version>
 724 |    <stability>
 725 |     <release>stable</release>
 726 |     <api>stable</api>
 727 |    </stability>
 728 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 729 |    <notes>
 730 | Fri, Jun 19, 2015 - xdebug 2.3.3
 731 | 
 732 | = Fixed bugs:
 733 | 
 734 |   - Fixed issue #1130: Escaping issues with docrefs and HTML characters in
 735 |     error messages
 736 |   - Fixed issue #1133: PDO exception code value type is changed
 737 |   - Fixed issue #1137: Windows does not support %zu formatting for sprintf
 738 |   - Fixed issue #1140: Tracing with __debugInfo() crashes Xdebug due to a stack
 739 |     overflow
 740 |   - Fixed issue #1148: Can&apos;t disable max_nesting_function
 741 |   - Fixed issue #1151: Crash when another extension calls call_user_function()
 742 |     during RINIT
 743 | 
 744 |   - Fixed crash with code coverage (Antony Dovgal)
 745 |   - Fixed usage of virtual_file_ex and STR_FREE (Remi Collet)
 746 |   - Reset overloaded opcodes at the end of each request (Eran Ifrah)
 747 | 
 748 | = Improvements:
 749 | 
 750 |   - Fixed issue #686: Not possible to inspect SplObjectStorage instances with
 751 |     Xdebug
 752 |   - Fixed issue #864: No attributes are shown if an object extends
 753 |     ArrayIterator
 754 |   - Fixed issue #996: Can&apos;t evaluate property of class that extends ArrayObject
 755 |   - Fixed issue #1134: Allow introspection of ArrayObject implementation&apos;s
 756 |     internal storage
 757 |   - Get rid of setlocale hack, by using %F instead of %f (and speed up tracing
 758 |     by 15-20%)
 759 |    </notes>
 760 |   </release>
 761 |   <release>
 762 |    <date>2015-03-22</date>
 763 |    <time>12:34:56</time>
 764 |    <version>
 765 |     <release>2.3.2</release>
 766 |     <api>2.3.2</api>
 767 |    </version>
 768 |    <stability>
 769 |     <release>stable</release>
 770 |     <api>stable</api>
 771 |    </stability>
 772 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 773 |    <notes>
 774 | Sun, Mar 22, 2015 - xdebug 2.3.2
 775 | 
 776 | = Fixed bugs:
 777 | 
 778 |   - Fixed issue #1117: Path/branch coverage sometimes crashes
 779 |   - Fixed issue #1121: Segfaults with path/branch coverage
 780 |    </notes>
 781 |   </release>
 782 |   <release>
 783 |    <date>2015-02-24</date>
 784 |    <time>22:02:00</time>
 785 |    <version>
 786 |     <release>2.3.1</release>
 787 |     <api>2.3.1</api>
 788 |    </version>
 789 |    <stability>
 790 |     <release>stable</release>
 791 |     <api>stable</api>
 792 |    </stability>
 793 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 794 |    <notes>
 795 | Tue, Feb 24, 2015 - xdebug 2.3.1
 796 | 
 797 | = Fixed bugs:
 798 | 
 799 |   - Fixed issue #1112: Setting an invalid xdebug.trace_format causes Xdebug to
 800 |     crash
 801 |   - Fixed issue #1113: xdebug.*_trigger do no longer work, due to NULL not
 802 |     being an empty string
 803 |    </notes>
 804 |   </release>
 805 |   <release>
 806 |    <date>2015-02-22</date>
 807 |    <time>14:48:00</time>
 808 |    <version>
 809 |     <release>2.3.0</release>
 810 |     <api>2.3.0</api>
 811 |    </version>
 812 |    <stability>
 813 |     <release>stable</release>
 814 |     <api>stable</api>
 815 |    </stability>
 816 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 817 |    <notes>
 818 | Sun, Feb 22, 2015 - xdebug 2.3.0
 819 | 
 820 | = Fixed bugs:
 821 | 
 822 |   - Fixed bug #932: Added an error message in case the remote debug log
 823 |     couldn&apos;t be opened
 824 |   - Fixed bug #982: Incorrect file paths in exception stack trace
 825 |   - Fixed bug #1094: Segmentation fault when attempting to use branch/path
 826 |     coverage
 827 |   - Fixed bug #1101: Debugger is not triggered on xdebug_break() in JIT mode
 828 |   - Fixed bug #1102: Stop Xdebug from crashing when debugging PHP Code with
 829 |     &quot;php -r&quot;.
 830 |   - Fixed bug #1103: XDEBUG_SESSION_STOP_NO_EXEC only stops first script
 831 |     executed with auto_prepend|append_files
 832 |   - Fixed bug #1104: One character non-public properties cause issues with
 833 |     debugging
 834 |   - Fixed bug #1105: Setting properties without specifying a type only works in
 835 |     topmost frame (Dominik del Bondio)
 836 |   - Fixed bug #1095: Crash when using a non-associate array key in GLOBALS
 837 |   - Fixed bug #1111: eval does not work when debugger is stopped in
 838 |     xdebug_throw_exception_hook (Dominik del Bondio)
 839 | 
 840 | + Added features:
 841 | 
 842 |   - General
 843 | 
 844 |     - Implemented issue #304: File name and line number info for overloaded
 845 |       var_dump()
 846 |     - Implemented issue #310: Allow class vars and array keys with
 847 |       xdebug_debug_zval()
 848 |     - Implemented issue #722: Add stack trace limit setting.
 849 |     - Implemented issue #1003: Add option to xdebug_print_function_stack() to
 850 |       suppress filename and line number
 851 |     - Implemented issue #1004: Ability to halt on warning/notice
 852 |     - Implemented issue #1023: Add support for PHP 5.6 variadics
 853 |     - Implemented issue #1024: Add support for PHP 5.6&apos;s ASSIGN_POW
 854 | 
 855 |   - Debugging
 856 | 
 857 |     - Implemented issue #406: Added support for remote debugging user-defined
 858 |       constants
 859 |     - Implemented issue #495: Added support for the wildcard exception name &apos;*&apos;
 860 |     - Implemented issue #1066: Better error message for SELinux preventing
 861 |       debugging connections
 862 |     - Implemented issue #1084: Added support for extended classes to trigger
 863 |       exception breakpoints
 864 |     - Implemented issue #1084: Added exception code as extra element to
 865 |       debugger XML
 866 | 
 867 |   - Tracing
 868 | 
 869 |     - Implemented issue #341: Added the time index and memory usage for
 870 |       function returns in normal tracefiles
 871 |     - Implemented issue #644: Shared secret for profiler_enable_trigger and
 872 |       trace_enable_trigger with *_value option
 873 |     - Implemented issue #971: Added the trace file option
 874 |       &quot;XDEBUG_TRACE_NAKED_FILENAME&quot; to xdebug_start_trace() to prevent the
 875 |       &quot;.xt&quot; extension from being added
 876 |     - Implemented issue #1021: Added support for return values to computerized
 877 |       trace files
 878 |     - Implemented issue #1022: Added support for serialized variables as format
 879 |       in trace files in the form of option &quot;5&quot; for &quot;xdebug.collect_params&quot;
 880 | 
 881 |   - Code coverage
 882 | 
 883 |     - Implemented issue #380: Added xdebug_code_coverage_started()
 884 |     - Implemented issue #1034: Add collected path and branch information to
 885 |       xdebug_get_code_coverage() output
 886 | 
 887 |   - Profiling
 888 | 
 889 |     - Implement issue #1054: Support for filename and function name compression
 890 |       in cachegrind files
 891 | 
 892 | + Changes:
 893 | 
 894 |     - Implemented issue #863: Support xdebug.overload_var_dump through
 895 |       ini_set()
 896 |     - Implemented issue #973: Use case-insensitive filename comparison on all
 897 |       systems (Galen Wright-Watson)
 898 |     - Implemented issue #1015: Added the xdebug.force_display_errors and
 899 |       xdebug.force_error_reporting php.ini-only settings to always override
 900 |       PHP&apos;s settings for display_errors and error_reporting
 901 |     - Implemented issue #1057: Removed trailing whitespace from example
 902 |       xdebug.ini
 903 |     - Implemented issue #1096: Improve performance improvement for handling
 904 |       breakpoints by ignoring locales (Daniel Sloof)
 905 |     - Implemented issue #1100: Raise default max_nesting_level to 256
 906 | 
 907 | - Removed features:
 908 | 
 909 |     - Support for PHP versions lower than PHP 5.4 have been dropped.
 910 |    </notes>
 911 |   </release>
 912 |   <release>
 913 |    <date>2015-01-21</date>
 914 |    <time>21:59:00</time>
 915 |    <version>
 916 |     <release>2.2.7</release>
 917 |     <api>2.2.7</api>
 918 |    </version>
 919 |    <stability>
 920 |     <release>stable</release>
 921 |     <api>stable</api>
 922 |    </stability>
 923 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 924 |    <notes>
 925 | Thu, Jan 22, 2014 - xdebug 2.2.7
 926 | 
 927 | = Fixed bugs:
 928 | 
 929 |  - Fixed bug #1083: Segfault when requesting a variable for a context that did
 930 |    not have them.
 931 |  - Fixed bug #1087: zend_execute_script or zend_eval_string in RINIT segfaults.
 932 |  - Fixed bug #1088: Xdebug won&apos;t show dead and not executed lines at the second
 933 |    time.
 934 |  - Fixed bug #1098: Xdebug doesn&apos;t make use of __debugInfo.
 935 |  - Fixed segfaults with ZTS on PHP 5.6.
 936 |    </notes>
 937 |   </release>
 938 |   <release>
 939 |    <date>2014-11-14</date>
 940 |    <time>15:13:00</time>
 941 |    <version>
 942 |     <release>2.2.6</release>
 943 |     <api>2.2.6</api>
 944 |    </version>
 945 |    <stability>
 946 |     <release>stable</release>
 947 |     <api>stable</api>
 948 |    </stability>
 949 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 950 |    <notes>
 951 | Fri, Nov 14, 2014 - xdebug 2.2.6
 952 | 
 953 | = Fixed bugs:
 954 | 
 955 |  - Fixed bug #1048: Can not get $GLOBAL variable by property_value on function
 956 |    context.
 957 |  - Fixed bug #1073 and #1075: Segmentation fault with internal functions
 958 |    calling internal functions.
 959 |  - Fixed bug #1085: Fixed the tracefile analyser as the format version had been
 960 |    bumbed.
 961 |  - Fixed memory leaks
 962 |    </notes>
 963 |   </release>
 964 |   <release>
 965 |    <date>2014-04-29</date>
 966 |    <time>20:44:00</time>
 967 |    <version>
 968 |     <release>2.2.5</release>
 969 |     <api>2.2.5</api>
 970 |    </version>
 971 |    <stability>
 972 |     <release>stable</release>
 973 |     <api>stable</api>
 974 |    </stability>
 975 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 976 |    <notes>
 977 | Tue, Apr 29, 2014 - xdebug 2.2.5
 978 | 
 979 | = Fixed bugs:
 980 | 
 981 |  - Fixed bug #1040: Fixed uninitialized sa value.
 982 |  - Fixed building on hurd-i386.
 983 |    </notes>
 984 |   </release>
 985 |   <release>
 986 |    <date>2014-02-28</date>
 987 |    <time>10:33:00</time>
 988 |    <version>
 989 |     <release>2.2.4</release>
 990 |     <api>2.2.4</api>
 991 |    </version>
 992 |    <stability>
 993 |     <release>stable</release>
 994 |     <api>stable</api>
 995 |    </stability>
 996 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
 997 |    <notes>
 998 | Fri, Feb 28, 2014 - xdebug 2.2.4
 999 | 
1000 | = Fixed bugs:
1001 | 
1002 |  - Fixed bug #785: Profiler does not handle closures and call_user_func_array well.
1003 |  - Fixed bug #963: Xdebug waits too long for response from remote client
1004 |  - Fixed bug #976: XDebug crashes if current varibles scope contains COM object.
1005 |  - Fixed bug #978: Inspection of array with negative keys fails
1006 |  - Fixed bug #979: property_value -m 0 should mean all bytes, not 0 bytes
1007 |  - Fixed bug #987: Hidden property names not shown.
1008 |    </notes>
1009 |   </release>
1010 |   <release>
1011 |    <date>2013-05-22</date>
1012 |    <time>08:54:00</time>
1013 |    <version>
1014 |     <release>2.2.3</release>
1015 |     <api>2.2.3</api>
1016 |    </version>
1017 |    <stability>
1018 |     <release>stable</release>
1019 |     <api>stable</api>
1020 |    </stability>
1021 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1022 |    <notes>
1023 | Tue, May 21, 2013 - xdebug 2.2.3
1024 | 
1025 | + Added features:
1026 | 
1027 |  - Support for PHP 5.5.
1028 | 
1029 | = Fixed bugs:
1030 | 
1031 |  - Fixed bug #923: Xdebug + Netbeans + ext/MongoDB crash on MongoCursor instance
1032 |  - Fixed bug #929: Directory name management in xdebug.profiler_output_dir
1033 |  - Fixed bug #931: xdebug_str_add does not check for NULL str before calling strlen on it
1034 |  - Fixed bug #935: Document the return value from xdebug_get_code_coverage()
1035 |  - Fixed bug #947: Newlines converted when html_errors = 0
1036 |    </notes>
1037 |   </release>
1038 |   <release>
1039 |    <date>2013-03-23</date>
1040 |    <time>12:00:00</time>
1041 |    <version>
1042 |     <release>2.2.2</release>
1043 |     <api>2.2.2</api>
1044 |    </version>
1045 |    <stability>
1046 |     <release>stable</release>
1047 |     <api>stable</api>
1048 |    </stability>
1049 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1050 |    <notes>
1051 | Sat, Mar 23, 2013 - xdebug 2.2.2
1052 | 
1053 | + Added features:
1054 | 
1055 | 	- Support for PHP 5.5.
1056 | 
1057 | = Fixed bugs:
1058 | 
1059 | 	- Fixed bug #598: Use HTTP_X_FORWARDED_FOR to determine remote debugger.
1060 | 	- Fixed bug #625: xdebug_get_headers() -&gt; Headers are reset unexpectedly.
1061 | 	- Fixed bug #811: PHP Documentation Link.
1062 | 	- Fixed bug #818: Require a php script in the PHP_RINIT causes Xdebug to crash.
1063 | 	- Fixed bug #903: xdebug_get_headers() returns replaced headers.
1064 | 	- Fixed bug #905: Support PHP 5.5 and generators.
1065 | 	- Fixed bug #920: AM_CONFIG_HEADER is depreciated.
1066 |    </notes>
1067 |   </release>
1068 |   <release>
1069 |    <version>
1070 |     <release>2.2.1</release>
1071 |     <api>2.2.1</api>
1072 |    </version>
1073 |    <stability>
1074 |     <release>stable</release>
1075 |     <api>stable</api>
1076 |    </stability>
1077 |    <date>2012-07-14</date>
1078 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1079 |    <notes>
1080 | = Fixed bugs:
1081 | 
1082 | 	- Fixed bug #843: Text output depends on php locale.
1083 | 	- Fixed bug #838/#839/#840: Debugging static properties crashes Xdebug.
1084 | 	- Fixed bug #821: Variable assignments (beginning with =&gt;) should be
1085 | 	  indented one more scope.
1086 | 	- Fixed bug #811: PHP Documentation Link.
1087 | 	- Fixed bug #800: var_dump(get_class(new foo\bar&apos;)) add an extra &quot;\&quot; in
1088 | 	  class name.
1089 |    </notes>
1090 |   </release>
1091 |   <release>
1092 |    <version>
1093 |     <release>2.2.0</release>
1094 |     <api>2.2.0</api>
1095 |    </version>
1096 |    <stability>
1097 |     <release>stable</release>
1098 |     <api>stable</api>
1099 |    </stability>
1100 |    <date>2012-05-08</date>
1101 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1102 |    <notes>
1103 | Tue, May 08, 2012 - xdebug 2.2.0
1104 | 
1105 | + Added features:
1106 | 
1107 | 	- Support for PHP 5.4.
1108 | 
1109 | 	- Added ANSI colour output for the shell. (Including patches by Michael
1110 | 	  Maclean)
1111 | 	- Added var_dump() overloading on the command line (issue #457).
1112 | 
1113 | 	- Added better support for closures in stack and function traces.
1114 | 	- Added the size of arrays to the overloaded variable output, so that you
1115 | 	  know how many elements there are.
1116 | 	- Added support for X-HTTP-FORWARDED-FOR before falling back to REMOTE_ADDR
1117 | 	  (issue #660). (Patch by Hannes Magnusson)
1118 | 	- Added the method call type to xdebug_get_function_stack() (issue #695).
1119 | 	- Added extra information to error printouts to tell that the error
1120 | 	  suppression operator has been ignored due to xdebug.scream.
1121 | 	- Added a error-specific CSS class to stack traces.
1122 | 
1123 | + New settings:
1124 | 
1125 | 	- xdebug.cli_color for colouring output on the command line (Unix only).
1126 | 	- Added xdebug.trace_enable_trigger to triger function traces through a
1127 | 	  GET/POST/COOKIE parameter (issue #517). (Patch by Patrick Allaert)
1128 | 	- Added support for the &apos;U&apos; format specifier for function trace and
1129 | 	  profiler filenames.
1130 | 
1131 | + Changes:
1132 | 
1133 | 	- Improved performance by lazy-initializing data structures.
1134 | 	- Improved code coverage performance. (Including some patches by Taavi
1135 | 	  Burns)
1136 | 	- Improved compatibility with KCacheGrind.
1137 | 	- Improved logging of remote debugging connections, by added connection
1138 | 	  success/failure logging to the xdebug.remote_log functionality.
1139 | 
1140 | = Fixed bugs:
1141 | 
1142 | 	- Fixed bug #827: Enabling Xdebug causes phpt tests to fail because of
1143 | 	  var_dump() formatting issues.
1144 | 	- Fixed bug #823: Single quotes are escaped in var_dumped string output.
1145 | 	- Fixed issue #819: Xdebug 2.2.0RC2 can&apos;t stand on a breakpoint more than 30 seconds.
1146 | 	- Fixed bug #801: Segfault with streamwrapper and unclosed $fp on
1147 | 	  destruction.
1148 | 	- Fixed issue #797: Xdebug crashes when fetching static properties.
1149 | 	- Fixed bug #794: Allow coloured output on Windows.
1150 | 	- Fixed bug #784: Unlimited feature for var_display_max_data and
1151 | 	  var_display_max_depth is undocumented.
1152 | 	- Fixed bug #774: Apache crashes on header() calls.
1153 | 	- Fixed bug #764: Tailored Installation instructions do not work.
1154 | 	- Fixed bug #758: php_value xdebug.idekey is ignored in .htaccess files
1155 | 	- Fixed bug #728: Profiler reports __call() invocations confusingly/wrongly.
1156 | 	- Fixed bug #687: Xdebug does not show dynamically defined variable.
1157 | 	- Fixed bug #662: idekey is set to running user.
1158 | 	- Fixed bug #627: Added the realpath check.
1159 |    </notes>
1160 |   </release>
1161 |   <release>
1162 |    <version>
1163 |     <release>2.2.0RC2</release>
1164 |     <api>2.2.0RC2</api>
1165 |    </version>
1166 |    <stability>
1167 |     <release>stable</release>
1168 |     <api>stable</api>
1169 |    </stability>
1170 |    <date>2012-04-22</date>
1171 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1172 |    <notes>
1173 | Tue, Apr 22, 2012 - xdebug 2.2.0rc2
1174 | 
1175 | = Fixed bugs:
1176 | 
1177 | 	- Fixed bug #801: Segfault with streamwrapper and unclosed $fp on
1178 | 	  destruction.
1179 | 	- Fixed bug #794: Allow coloured output on Windows.
1180 | 	- Fixed bug #784: Unlimited feature for var_display_max_data and
1181 | 	  var_display_max_depth is undocumented.
1182 | 	- Fixed bug #774: Apache crashes on header() calls.
1183 | 	- Fixed bug #764: Tailored Installation instructions do not work.
1184 | 	- Fixed bug #758: php_value xdebug.idekey is ignored in .htaccess files
1185 | 	- Fixed bug #662: idekey is set to running user.
1186 |    </notes>
1187 |   </release>
1188 |   <release>
1189 |    <version>
1190 |     <release>2.2.0RC1</release>
1191 |     <api>2.2.0RC1</api>
1192 |    </version>
1193 |    <stability>
1194 |     <release>stable</release>
1195 |     <api>stable</api>
1196 |    </stability>
1197 |    <date>2012-03-12</date>
1198 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1199 |    <notes>
1200 | Tue, Mar 13, 2012 - xdebug 2.2.0rc1
1201 | 
1202 | + Added features:
1203 | 
1204 | 	- Support for PHP 5.4.
1205 | 
1206 | 	- Added ANSI colour output for the shell. (Including patches by Michael
1207 | 	  Maclean)
1208 | 	- Added var_dump() overloading on the command line (issue #457).
1209 | 
1210 | 	- Added better support for closures in stack and function traces.
1211 | 	- Added the size of arrays to the overloaded variable output, so that you
1212 | 	  know how many elements there are.
1213 | 	- Added support for X-HTTP-FORWARDED-FOR before falling back to REMOTE_ADDR
1214 | 	  (issue #660). (Patch by Hannes Magnusson)
1215 | 	- Added the method call type to xdebug_get_function_stack() (issue #695).
1216 | 	- Added extra information to error printouts to tell that the error
1217 | 	  suppression operator has been ignored due to xdebug.scream.
1218 | 	- Added a error-specific CSS class to stack traces.
1219 | 
1220 | 
1221 | + New settings:
1222 | 
1223 | 	- xdebug.cli_color for colouring output on the command line (Unix only).
1224 | 	- Added xdebug.trace_enable_trigger to triger function traces through a
1225 | 	  GET/POST/COOKIE parameter (issue #517). (Patch by Patrick Allaert)
1226 | 	- Added support for the &apos;U&apos; format specifier for function trace and
1227 | 	  profiler filenames.
1228 | 
1229 | + Changes:
1230 | 
1231 | 	- Improved performance by lazy-initializing data structures.
1232 | 	- Improved code coverage performance. (Including some patches by Taavi
1233 | 	  Burns)
1234 | 	- Improved compatibility with KCacheGrind.
1235 | 	- Improved logging of remote debugging connections, by added connection
1236 | 	  success/failure logging to the xdebug.remote_log functionality.
1237 | 
1238 | = Fixed bugs:
1239 | 
1240 | 	- No additional bug fixes besides the ones from the 2.1 branch up til
1241 | 	  Xdebug 2.1.4.
1242 |    </notes>
1243 |   </release>
1244 |   <release>
1245 |    <version>
1246 |     <release>2.1.4</release>
1247 |     <api>2.1.4</api>
1248 |    </version>
1249 |    <stability>
1250 |     <release>stable</release>
1251 |     <api>stable</api>
1252 |    </stability>
1253 |    <date>2012-03-12</date>
1254 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1255 |    <notes>
1256 | = Fixed bugs:
1257 | 
1258 | 	- Fixed bug #788: Collect errors eats fatal errors.
1259 | 	- Fixed bug #787: Segmentation Fault with PHP header_remove().
1260 | 	- Fixed bug #778: Xdebug session in Eclipse crash whenever it run into
1261 | 	  simplexml_load_string call.
1262 | 	- Fixed bug #756: Added support for ZEND_*_*_OBJ and self::*.
1263 | 	- Fixed bug #747: Still problem with error message and soap client / soap
1264 | 	  server.
1265 | 	- Fixed bug #744: new lines in a PHP file from Windows are displayed with
1266 | 	  an extra white line with var_dump().
1267 | 	- Fixed an issue with debugging and the eval command.
1268 | 	- Fixed compilation with ZTS on PHP &lt; 5.3
1269 |    </notes>
1270 |   </release>
1271 |   <release>
1272 |    <version>
1273 |     <release>2.1.3</release>
1274 |     <api>2.1.3</api>
1275 |    </version>
1276 |    <stability>
1277 |     <release>stable</release>
1278 |     <api>stable</api>
1279 |    </stability>
1280 |    <date>2012-01-25</date>
1281 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1282 |    <notes>
1283 | = Fixed bugs:
1284 | 
1285 | 	- Fixed bug #725: EG(current_execute_data) is not checked in xdebug.c,
1286 | 	  xdebug_statement_call.
1287 | 	- Fixed bug #723: xdebug is stricter than PHP regarding Exception property
1288 | 	  types.
1289 | 	- Fixed bug #714: Cachegrind files have huge (wrong) numbers in some lines.
1290 | 	- Fixed bug #709: Xdebug doesn&apos;t understand E_USER_DEPRECATED.
1291 | 	- Fixed bug #698: Allow xdebug.remote_connect_back to be set in .htaccess.
1292 | 	- Fixed bug #690: Function traces are not appended to file with
1293 | 	  xdebug_start_trace() and xdebug.trace_options=1.
1294 | 	- Fixed bug #623: Static properties of a class can be evaluated only with
1295 | 	  difficulty.
1296 | 	- Fixed bug #614/#619: Viewing private variables in base classes through
1297 | 	  the debugger.
1298 | 	- Fixed bug #609: Xdebug and SOAP extension&apos;s error handlers conflict.
1299 | 	- Fixed bug #606/#678/#688/#689/#704: crash after using eval on an
1300 | 	  unparsable, or un-executable statement.
1301 | 	- Fixed bug #305: xdebug exception handler doesn&apos;t properly handle special
1302 | 	  chars.
1303 | 
1304 | + Changes:
1305 | 
1306 | 	- Changed xdebug_break() to hint to the statement execution trap instead of
1307 | 	  breaking forcefully adding an extra stackframe.
1308 | 	- Prevent Xdebug 2.1.x to build with PHP 5.4.
1309 |    </notes>
1310 |   </release>
1311 |   <release>
1312 |    <version>
1313 |     <release>2.1.2</release>
1314 |     <api>2.1.2</api>
1315 |    </version>
1316 |    <stability>
1317 |     <release>stable</release>
1318 |     <api>stable</api>
1319 |    </stability>
1320 |    <date>2011-07-28</date>
1321 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1322 |    <notes>
1323 | = Fixed bugs:
1324 | 
1325 | 	- Fixed bug #622: Working with eval() code is inconvenient and difficult.
1326 | 	- Fixed bug #684: xdebug_var_dump - IE does not support &amp;.
1327 | 	- Fixed bug #693: Cachegrind files not written when filename is very long.
1328 | 	- Fixed bug #697: Incorrect code coverage of function arguments when using
1329 | 	  XDEBUG_CC_UNUSED.
1330 | 	- Fixed bug #699: Xdebug gets the filename wrong for the countable
1331 | 	  interface.
1332 | 	- Fixed bug #703 by adding another opcode to the list that needs to be
1333 | 	  overridden.
1334 |    </notes>
1335 |   </release>
1336 |   <release>
1337 |    <version>
1338 |     <release>2.1.2</release>
1339 |     <api>2.1.2</api>
1340 |    </version>
1341 |    <stability>
1342 |     <release>stable</release>
1343 |     <api>stable</api>
1344 |    </stability>
1345 |    <date>2011-07-28</date>
1346 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1347 |    <notes>
1348 | = Fixed bugs:
1349 | 
1350 | 	- Fixed bug #622: Working with eval() code is inconvenient and difficult.
1351 | 	- Fixed bug #684: xdebug_var_dump - IE does not support &amp;.
1352 | 	- Fixed bug #693: Cachegrind files not written when filename is very long.
1353 | 	- Fixed bug #697: Incorrect code coverage of function arguments when using
1354 | 	  XDEBUG_CC_UNUSED.
1355 | 	- Fixed bug #699: Xdebug gets the filename wrong for the countable
1356 | 	  interface.
1357 | 	- Fixed bug #703 by adding another opcode to the list that needs to be
1358 | 	  overridden.
1359 |    </notes>
1360 |   </release>
1361 |   <release>
1362 |    <version>
1363 |     <release>2.1.1</release>
1364 |     <api>2.1.1</api>
1365 |    </version>
1366 |    <stability>
1367 |     <release>stable</release>
1368 |     <api>stable</api>
1369 |    </stability>
1370 |    <date>2011-03-28</date>
1371 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1372 |    <notes>
1373 | Mon, Mar 28, 2011 - xdebug 2.1.1
1374 | 
1375 | = Fixed bugs:
1376 | 
1377 |   - Fixed ZTS compilation.
1378 |    </notes>
1379 |   </release>
1380 |   <release>
1381 |    <version>
1382 |     <release>2.1.1RC1</release>
1383 |     <api>2.1.1RC1</api>
1384 |    </version>
1385 |    <stability>
1386 |     <release>beta</release>
1387 |     <api>beta</api>
1388 |    </stability>
1389 |    <date>2011-03-22</date>
1390 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1391 |    <notes>
1392 | Tue, Mar 22, 2011 - xdebug 2.1.1rc1
1393 | 
1394 | = Fixed bugs:
1395 | 
1396 |   = Debugger
1397 | 	- Fixed bug #518: Removed CLASSNAME pseudo-property optional.
1398 | 	- Fixed bug #592: Xdebug crashes with run after detach.
1399 | 	- Fixed bug #596: Call breakpoint never works with instance methods, only
1400 | 	  static methods.
1401 | 	- Fixed JIT mode in the debugger so that it works for xdebug_break() too.
1402 | 
1403 |   = Profiler
1404 | 	- Fixed bug #631: Summary not written when script ended with &quot;exit()&quot;.
1405 | 	- Fixed bug #639: Xdebug profiling: output not correct - missing &apos;cfl=&apos;.
1406 | 	- Fixed bug #642: Fixed line numbers for offsetGet, offsetSet,
1407 | 	  __get/__set/__isset/__unset and __call in profile files and stack
1408 | 	  traces/function traces.
1409 | 	- Fixed bug #643: Profiler gets line numbers wrong.
1410 | 	- Fixed bug #653: XDebug profiler crashes with %H in file name and non
1411 | 	  standard port.
1412 | 
1413 |   = Others
1414 | 	- Fixed bug #651: Incorrect code coverage after empty() in conditional.
1415 | 	- Fixed bug #654: Xdebug hides error message in CLI.
1416 | 	- Fixed bug #665: Xdebug does not respect display_errors=stderr.
1417 | 	  Patch by Ben Spencer &lt;dangerous.ben@gmail.com&gt;
1418 | 	- Fixed bug #670: Xdebug crashes with broken &quot;break x&quot; code.
1419 |    </notes>
1420 |   </release>
1421 |   <release>
1422 |    <version>
1423 |     <release>2.1.0</release>
1424 |     <api>2.1.0</api>
1425 |    </version>
1426 |    <stability>
1427 |     <release>stable</release>
1428 |     <api>stable</api>
1429 |    </stability>
1430 |    <date>2010-06-29</date>
1431 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1432 |    <notes>
1433 | Tue, Jun 29, 2010 - xdebug 2.1.0
1434 | 
1435 | = Fixed bugs:
1436 | 	- Fixed bug #562: Incorrect coverage information for closure function
1437 | 	  headers.
1438 | 	- Fixed bug #566: Xdebug crashes when using conditional breakpoints.
1439 | 	- Fixed bug #567: xdebug_debug_zval and xdebug_debug_zval_stdout don&apos;t work
1440 | 	  with PHP 5.3. (Patch by Endo Hiroaki).
1441 | 	- Fixed bug #570: undefined symbol: zend_memrchr.
1442 |    </notes>
1443 |   </release>
1444 |   <release>
1445 |    <version>
1446 |     <release>2.1.0RC1</release>
1447 |     <api>2.1.0RC1</api>
1448 |    </version>
1449 |    <stability>
1450 |     <release>beta</release>
1451 |     <api>beta</api>
1452 |    </stability>
1453 |    <date>2010-02-27</date>
1454 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1455 |    <notes>
1456 | Thu, Apr 06, 2010 - xdebug 2.1.0rc1
1457 | 
1458 | = Fixed bugs:
1459 | 	- Fixed bug #494: Private attributes of parent class unavailable when
1460 | 	  inheriting.
1461 | 	- Fixed bug #400: Xdebug shows errors, even when PHP is request startup
1462 | 	  mode.
1463 | 	- Fixed bug #421: xdebug sends back invalid characters in xml sometimes.
1464 | 	- Fixed bug #475: Property names with null chars are not sent fully to the
1465 | 	  client.
1466 | 	- Fixed bug #480: Issues with the reserved resource in multi threaded
1467 | 	  environments (Patch by Francis.Grolemund@netapp.com).
1468 | 	- Fixed bug #558: PHP segfaults when running a nested eval.
1469 |    </notes>
1470 |   </release>
1471 |   <release>
1472 |    <version>
1473 |     <release>2.1.0beta3</release>
1474 |     <api>2.1.0beta3</api>
1475 |    </version>
1476 |    <stability>
1477 |     <release>beta</release>
1478 |     <api>beta</api>
1479 |    </stability>
1480 |    <date>2010-02-27</date>
1481 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1482 |    <notes>
1483 | Sat, Feb 27, 2010 - xdebug 2.1.0beta3
1484 | 
1485 | = Fixed bugs:
1486 | 	- Fixed memory corruption issues.
1487 | 	- Fixed a threading related issue for code-coverage.
1488 | 	- Fixed bug #532: XDebug breaks header() function.
1489 | 	- DBGP: Prevent Xdebug from returning properties when a too high page number
1490 | 	  has been requested.
1491 |    </notes>
1492 |   </release>
1493 |   <release>
1494 |    <version>
1495 |     <release>2.1.0beta2</release>
1496 |     <api>2.1.0beta2</api>
1497 |    </version>
1498 |    <stability>
1499 |     <release>beta</release>
1500 |     <api>beta</api>
1501 |    </stability>
1502 |    <date>2010-02-03</date>
1503 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1504 |    <notes>
1505 | Wed, Feb 03, 2010 - xdebug 2.1.0beta2
1506 | 
1507 | = Fixed bugs:
1508 | 	- Fixed memory leak in breakpoint handling.
1509 | 	- Fixed bug #528: Core dump generated with remote_connect_back option set
1510 | 	  and CLI usage.
1511 | 	- Fixed bug #515: declare(ticks) statement confuses code coverage.
1512 | 	- Fixed bug #512: DBGP: breakpoint_get doesn&apos;t return conditions in its
1513 | 	  response.
1514 | 	- Possible fix for bug #507/#517: Crashes because of uninitalised header
1515 | 	  globals.
1516 | 	- Fixed bug #501: Xdebug&apos;s variable tracing misses POST_INC and variants.
1517 |    </notes>
1518 |   </release>
1519 |   <release>
1520 |    <version>
1521 |     <release>2.1.0beta1</release>
1522 |     <api>2.1.0beta1</api>
1523 |    </version>
1524 |    <stability>
1525 |     <release>beta</release>
1526 |     <api>beta</api>
1527 |    </stability>
1528 |    <date>2010-01-03</date>
1529 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1530 |    <notes>
1531 | Sun, Jan 03, 2010 - xdebug 2.1.0beta1
1532 | 
1533 | + Added features:
1534 | 	- Added error display collection and suppressions.
1535 | 	- Added the recording of headers being set in scripts.
1536 | 	- Added variable assignment tracing.
1537 | 	- Added the ability to turn of the default overriding of var_dump().
1538 | 	- Added &quot;Scream&quot; support, which disables the @ operator.
1539 | 	- Added a trace-file analysing script.
1540 | 	- Added support for debugging into phars.
1541 | 	- Added a default xdebug.ini. (Patch by Martin Schuhfu
1542 | 	  &lt;martins@spot-media.de&gt;)
1543 | 	- Added function parameters in computerized function traces.
1544 | 	- PHP 5.3 compatibility.
1545 | 	- Improved code coverage accuracy.
1546 | 
1547 |   + New functions:
1548 | 	- xdebug_get_formatted_function_stack(), which returns a formatted function
1549 | 	  stack instead of displaying it.
1550 | 	- xdebug_get_headers(), which returns all headers that have been set in a
1551 | 	  script, both explicitly with things like header(), but also implicitly
1552 | 	  for things like setcookie().
1553 | 	- xdebug_start_error_collection(), xdebug_stop_error_collection() and
1554 | 	  xdebug_get_collected_errors(), which allow you to collect all notices,
1555 | 	  warnings and error messages that Xdebug generates from PHP&apos;s
1556 | 	  error_reporting functionality so that you can output them at a later
1557 | 	  point in your script by hand.
1558 | 
1559 |   + New settings:
1560 | 	- xdebug.collect_assignments, which enables the emitting of variable
1561 | 	  assignments in function traces.
1562 | 	- xdebug.file_line_format, to generate a link with a specific format for 
1563 | 	  every filename that Xdebug outputs.
1564 | 	- xdebug.overload_var_dump, which allows you to turn off Xdebug&apos;s version
1565 | 	  of var_dump().
1566 | 	- xdebug.remote_cookie_expire_time, that controls the length of a
1567 | 	  remote debugging session. (Patch by Rick Pannen &lt;pannen@gmail.com&gt;)
1568 | 	- xdebug.scream, which makes the @ operator to be ignored.
1569 | 
1570 | + Changes:
1571 | 	- Added return values for xdebug_start_code_coverage() and
1572 | 	  xdebug_stop_code_coverage() to indicate whether the action was
1573 | 	  successful.  xdebug_start_code_coverage() will return TRUE if the call
1574 | 	  enabled code coverage, and FALSE if it was already enabled.
1575 | 	  xdebug_stop_code_coverage() will return FALSE when code coverage wasn&apos;t
1576 | 	  started yet and TRUE if it was turned on.
1577 | 	- Added an optional argument to xdebug_print_function_stack() to display
1578 | 	  your own message. (Patch by Mikko Koppanen).
1579 | 	- All HTML output as generated by Xdebug now has a HTML &quot;class&quot; attribute
1580 | 	  for easy CSS formatting.
1581 | 
1582 | - Removed features:
1583 | 	- Support for PHP versions lower than PHP 5.1 have been dropped.
1584 | 	- The PHP3 and GDB debugger engines have been removed.
1585 | 
1586 | = Fixed bugs:
1587 | 	- Fixed support for showing $this in remote debugging sessions.
1588 | 	- Fixed bug in formatting the display of &quot;Variables in the local scope&quot;.
1589 | 	- Possible fix for a threading issue where the headers gathering function
1590 | 	  would create stack overflows.
1591 | 	- Possible fix for #324: xdebug_dump_superglobals() only dumps superglobals
1592 | 	  that were accessed before, and #478: XDebug 2.0.x can&apos;t use %R in
1593 | 	  xdebug.profiler_output_name if register_long_arrays is off.
1594 | 
1595 | 	- Fixed bug #505: %s in xdebug.trace_output_name breaks functions traces.
1596 | 	- Fixed bug #494: Private attributes of parent class unavailable when
1597 | 	  inheriting.
1598 | 	- Fixed bug #486: feature_get -n breakpoint_types returns out of date list.
1599 | 	- Fixed bug #476: Xdebug doesn&apos;t support PHP 5.3&apos;s exception chaining.
1600 | 	- Fixed bug #472: Dead Code Analysis for code coverage messed up after goto.
1601 | 	- Fixed bug #470: Catch blocks marked as dead code unless executed.
1602 | 	- Fixed bug #469: context_get for function variables always appear as
1603 | 	  &quot;uninitialized&quot;.
1604 | 	- Fixed bug #468: Property_get on $GLOBALS works only at top-level, by
1605 | 	  adding GLOBALS to the super globals context.
1606 | 	- Fixed bug #453: Memory leaks.
1607 | 	- Fixed bug #445: error_prepend_string and error_append_string are ignored
1608 | 	  by xdebug_error_cb. (Patch by Kent Davidson &lt;kent@marketruler.com&gt;)
1609 | 	- Fixed bug #442: configure: error: &quot;you have strange libedit&quot;.
1610 | 	- Fixed bug #439: Xdebug crash in xdebug_header_handler.
1611 | 	- Fixed bug #423: Conflicts with funcall.
1612 | 	- Fixed bug #419: Make use of P_tmpdir if defined instead of hard coded
1613 | 	  &apos;/tmp&apos;.
1614 | 	- Fixed bug #417: Response of context_get may lack page and pagesize
1615 | 	  attributes.
1616 | 	- Fixed bug #411: Class/function breakpoint setting does not follow the
1617 | 	  specs.
1618 | 	- Fixed bug #393: eval returns array data at the previous page request.
1619 | 	- Fixed bug #391: Xdebug doesn&apos;t stop executing script on catchable fatal
1620 | 	  errors.
1621 | 	- Fixed bug #389: Destructors called on fatal error.
1622 | 	- Fixed bug #368: Xdebug&apos;s debugger bails out on a parse error with the
1623 | 	  eval command.
1624 | 	- Fixed bug #356: Temporary breakpoints persist.
1625 | 	- Fixed bug #355: Function numbers in trace files weren&apos;t unique.
1626 | 	- Fixed bug #340: Segfault while throwing an Exception.
1627 | 	- Fixed bug #328: Private properties are incorrectly enumerated in case of
1628 | 	  extended classes.
1629 | 	- Fixed bug #249: Xdebug&apos;s error handler messes up with the SOAP
1630 | 	  extension&apos;s error handler.
1631 | 
1632 | + DBGP:
1633 | 	- Fixed cases where private properties where shown for objects, but not
1634 | 	  accessible.
1635 | 	- Added a patch by Lucas Nealan (lucas@php.net) and Brian Shire
1636 | 	  (shire@php.net) of Facebook to allow connections to the initiating
1637 | 	  request&apos;s IP address for remote debugging.
1638 | 	- Added the -p argument to the eval command as well, pending inclusion into
1639 | 	  DBGP.
1640 | 	- Added the retrieval of a file&apos;s execution lines. I added a new
1641 | 	  un-official method called xcmd_get_executable_lines which requires the
1642 | 	  stack depth as argument (-d). You can only fetch this information for
1643 | 	  stack frames as it needs an available op-array which is only available
1644 | 	  when a function is executed.
1645 | 	- Added a fake &quot;CLASSNAME&quot; property to objects that are returned in debug
1646 | 	  requests to facilitate deficiencies in IDEs that fail to show the &quot;classname&quot;
1647 | 	  XML attribute.
1648 |    </notes>
1649 |   </release>
1650 |   <release>
1651 |    <version>
1652 |     <release>2.0.5</release>
1653 |     <api>2.0.5</api>
1654 |    </version>
1655 |    <stability>
1656 |     <release>stable</release>
1657 |     <api>stable</api>
1658 |    </stability>
1659 |    <date>2009-07-03</date>
1660 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1661 |    <notes>
1662 | Fri, Jul 03, 2009 - xdebug 2.0.5
1663 | 
1664 | = Fixed bugs:
1665 | 	- Fixed bug #425: memory leak (around 40MB for each request) when using
1666 | 	  xdebug_start_trace.
1667 | 	- Fixed bug #422: Segfaults when using code coverage with a parse error in
1668 | 	  the script.
1669 | 	- Fixed bug #418: compilation breaks with CodeWarrior for NetWare.
1670 | 	- Fixed bug #403: &apos;call&apos; and &apos;return&apos; breakpoints triggers both on call and
1671 | 	  return for class method breakpoints.
1672 | 	- Fixed TSRM issues for PHP 5.2 and PHP 5.3. (Original patch by Elizabeth
1673 | 	  M. Smith).
1674 | 	- Fixed odd crash bugs, due to GCC 4 sensitivity.
1675 |    </notes>
1676 |   </release>
1677 |   <release>
1678 |    <version>
1679 |     <release>2.0.4</release>
1680 |     <api>2.0.4</api>
1681 |    </version>
1682 |    <stability>
1683 |     <release>stable</release>
1684 |     <api>stable</api>
1685 |    </stability>
1686 |    <date>2008-12-30</date>
1687 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1688 |    <notes>
1689 | Tue, Dec 30, 2008 - xdebug 2.0.4
1690 | 
1691 | = Fixed bugs:
1692 | 	- Fixed for strange jump positions in path analysis.
1693 | 	- Fixed issues with code coverage crashing on parse errors.
1694 | 	- Fixed code code coverage by overriding more opcodes.
1695 | 	- Fixed issues with Xdebug stalling/crashing when detaching from remote
1696 | 	  debugging.
1697 | 	- Fixed crash on Vista where memory was freed with routines from a different
1698 | 	  standard-C library than it was allocated with. (Patch by Eric Promislow
1699 | 	  &lt;ericp@activestate.com&gt;).
1700 | 	- Link against the correct CRT library. (Patch by Eric Promislow
1701 | 	  &lt;ericp@activestate.com&gt;).
1702 | 	- Sort the symbol elements according to name. (Patch by Eric Promislow
1703 | 	  &lt;ericp@activestate.com&gt;).
1704 | 	- Fixed support for mapped-drive UNC paths for Windows. (Patch by Eric
1705 | 	  Promislow &lt;ericp@activestate.com&gt;).
1706 | 	- Fixed a segfault in interactive mode while including a file.
1707 | 	- Fixed a crash in super global dumping in case somebody was strange enough
1708 | 	  to reassign them to a value type other than an Array.
1709 | 	- Simplify version checking for libtool. (Patch by PGNet
1710 | 	  &lt;pgnet.trash@gmail.com&gt;).
1711 | 	- Fixed display of unused returned variables from functions in PHP 5.3.
1712 | 	- Include config.w32 in the packages as well.
1713 | 	- Fixed .dsp for building with PHP 4.
1714 | 
1715 | + Added features:
1716 | 	- Support debugging into phars.
1717 | 	- Basic PHP 5.3 support.
1718 |    </notes>
1719 |   </release>
1720 |   <release>
1721 |    <version>
1722 |     <release>2.0.3</release>
1723 |     <api>2.0.3</api>
1724 |    </version>
1725 |    <stability>
1726 |     <release>stable</release>
1727 |     <api>stable</api>
1728 |    </stability>
1729 |    <date>2008-04-09</date>
1730 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1731 |    <notes>
1732 | Wed, Apr 09, 2008 - xdebug 2.0.3
1733 | 
1734 | = Fixed bugs:
1735 | 	- Fixed bug #338: Crash with: xdebug.remote_handler=req.
1736 | 	- Fixed bug #334: Code Coverage Regressions.
1737 | 	- Fixed abstract method detection for PHP 5.3.
1738 | 	- Fixed code coverage dead-code detection.
1739 | 	- Ignore ZEND_ADD_INTERFACE, which is on a different line in PHP &gt;= 5.3 for
1740 | 	  some weird reason.
1741 | 
1742 | + Changes:
1743 | 	- Added a CSS-class for xdebug&apos;s var_dump().
1744 | 	- Added support for the new E_DEPRECATED.
1745 |    </notes>
1746 |   </release>
1747 |   <release>
1748 |    <version>
1749 |     <release>2.0.2</release>
1750 |     <api>2.0.2</api>
1751 |    </version>
1752 |    <stability>
1753 |     <release>stable</release>
1754 |     <api>stable</api>
1755 |    </stability>
1756 |    <date>2007-11-11</date>
1757 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1758 |    <notes>
1759 | Sun, Nov 11, 2007 - xdebug 2.0.2
1760 | 
1761 | = Fixed bugs:
1762 | 	- Fixed bug #325: DBGP: &quot;detach&quot; stops further sessions being established
1763 | 	  from Apache.
1764 | 	- Fixed bug #321: Code coverage crashes on empty PHP files.
1765 | 	- Fixed bug #318: Segmentation Fault in code coverage analysis.
1766 | 	- Fixed bug #315: Xdebug crashes when including a file that doesn&apos;t exist.
1767 | 	- Fixed bug #314: PHP CLI Error Logging thwarted when XDebug Loaded.
1768 | 	- Fixed bug #300: Direction of var_dump().
1769 | 	- Always set the transaction_id and command. (Related to bug #313).
1770 |    </notes>
1771 |   </release>
1772 |   <release>
1773 |    <version>
1774 |     <release>2.0.1</release>
1775 |     <api>2.0.1</api>
1776 |    </version>
1777 |    <stability>
1778 |     <release>stable</release>
1779 |     <api>stable</api>
1780 |    </stability>
1781 |    <date>2007-10-29</date>
1782 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1783 |    <notes>
1784 | Sat, Oct 20, 2007 - xdebug 2.0.1
1785 | 
1786 | + Changes:
1787 | 	- Improved code coverage performance dramatically.
1788 | 	- PHP 5.3 compatibility (no namespaces yet though).
1789 | 	
1790 | = Fixed bugs:
1791 | 	- Fixed bug #301: Loading would cause SIGBUS on Solaris 10 SPARC. (Patch by
1792 | 	  Sean Chalmers)
1793 | 	- Fixed bug #300: Xdebug does not force LTR rendering for its tables.
1794 | 	- Fixed bug #299: Computerized traces don&apos;t have a newline for return
1795 | 	  entries if memory limit is not enabled.
1796 | 	- Fixed bug #298: xdebug_var_dump() doesn&apos;t handle entity replacements
1797 | 	  correctly concerning string length.
1798 | 	- Fixed a memory free error related to remote debugging conditions.
1799 | 	  (Related to bug #297).
1800 |    </notes>
1801 |   </release>
1802 |   <release>
1803 |    <version>
1804 |     <release>2.0.0</release>
1805 |     <api>2.0.0</api>
1806 |    </version>
1807 |    <stability>
1808 |     <release>stable</release>
1809 |     <api>stable</api>
1810 |    </stability>
1811 |    <date>2007-07-18</date>
1812 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1813 |    <notes>
1814 | Wed, Jul 18, 2007 - xdebug 2.0.0
1815 | 
1816 | + Changes:
1817 | 	- Put back the disabling of stack traces - apperently people were relying
1818 | 	  on this. This brings back xdebug_enable(), xdebug_disable() and
1819 | 	  xdebug_is_enabled().
1820 | 	- xdebug.collect_params is no longer a boolean setting. Although it worked
1821 | 	  fine, phpinfo() showed only just On or Off here.
1822 | 	- Fixed the Xdebug version of raw_url_encode to not encode : and \. This is
1823 | 	  not necessary according to the RFCs and it makes debug breakpoints work
1824 | 	  on Windows.
1825 | 
1826 | = Fixed bugs:
1827 | 	- Fixed bug #291: Tests that use SPL do not skip when SPL is not available.
1828 | 	- Fixed bug #290: Function calls leak memory.
1829 | 	- Fixed bug #289: Xdebug terminates connection when eval() is run in the
1830 | 	  init stage.
1831 | 	- Fixed bug #284: Step_over on breakpointed line made Xdebug break twice.
1832 | 	- Fixed bug #283: Xdebug always returns $this with the value of last stack
1833 | 	  frame.
1834 | 	- Fixed bug #282: %s is not usable for xdebug.profiler_output_name on
1835 | 	  Windows in all stack frames.
1836 | 	- Fixed bug #280: var_dump() doesn&apos;t display key of array as expected.
1837 | 	- Fixed bug #278: Code Coverage Issue.
1838 | 	- Fixed bug #273: Remote debugging: context_get does not return context id.
1839 | 	- Fixed bug #270: Debugger aborts when PHP&apos;s eval() is encountered. 
1840 | 	- Fixed bug #265: XDebug breaks error_get_last() .
1841 | 	- Fixed bug #261: Code coverage issues by overloading zend_assign_dim.
1842 | 
1843 | + DBGP:
1844 | 	- Added support for &quot;breakpoint_languages&quot;.
1845 |    </notes>
1846 |   </release>
1847 |   <release>
1848 |    <version>
1849 |     <release>2.0.0RC4</release>
1850 |     <api>2.0.0RC4</api>
1851 |    </version>
1852 |    <stability>
1853 |     <release>beta</release>
1854 |     <api>beta</api>
1855 |    </stability>
1856 |    <date>2007-05-17</date>
1857 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1858 |    <notes>
1859 | Wed, May 17, 2007 - xdebug 2.0.0rc4
1860 | + Changes:
1861 | 	- Use µ seconds instead of a tenths of µ seconds to avoid confusion in
1862 | 	  profile information.
1863 | 	- Changed xdebug.profiler_output_name and xdebug.trace_output_name to use
1864 | 	  modifier tags:
1865 | 	  %c = crc32 of the current working directory
1866 | 	  %p = pid
1867 | 	  %r = random number
1868 | 	  %s = script name
1869 | 	  %t = timestamp (seconds)
1870 | 	  %u = timestamp (microseconds)
1871 | 	  %H = $_SERVER[&apos;HTTP_HOST&apos;]
1872 | 	  %R = $_SERVER[&apos;REQUEST_URI&apos;]
1873 | 	  %S = session_id (from $_COOKIE if set)
1874 | 	  %% = literal %
1875 | 
1876 | = Fixed bugs:
1877 | 	- Fixed bug #255: Call Stack Table doesn&apos;t show Location on Windows.
1878 | 	- Fixed bug #251: Using the source command with an invalid filename returns
1879 | 	  unexpected result.
1880 | 	- Fixed bug #243: show_exception_trace=&quot;0&quot; ignored.
1881 | 	- Fixed bug #241: Crash in xdebug_get_function_stack().
1882 | 	- Fixed bug #240: Crash with xdebug.remote_log on Windows.
1883 | 	- Fixed a segfault in rendering stack traces to error logs.
1884 | 	- Fixed a bug that prevented variable names from being recorded for remote
1885 | 	  debug session while xdebug.collect_vars was turned off.
1886 | 	- Fixed xdebug_dump_superglobals() in case no super globals were
1887 | 	  configured.
1888 | 
1889 | - Removed functions:
1890 | 	- Removed support for Memory profiling as that didn&apos;t work properly.
1891 | 	- Get rid of xdebug.default_enable setting and associated functions:
1892 | 	  xdebug_disable() and xdebug_enable().
1893 | 
1894 | + Added features:
1895 | 	- Implemented support for four different xdebug.collect_params settings for
1896 | 	  stack traces and function traces.
1897 | 	- Allow to trigger profiling by the XDEBUG_PROFILE cookie.
1898 | 
1899 | + DBGP:
1900 | 	- Correctly add namespace definitions to XML.
1901 | 	- Added the xdebug namespace that adds extra information to breakpoints if
1902 | 	  available.
1903 | 	- Stopped the use of &gt;error&gt; elements for exception breakpoints, as that
1904 | 	  violates the protocol.
1905 |    </notes>
1906 |   </release>
1907 |   <release>
1908 |    <version>
1909 |     <release>2.0.0RC3</release>
1910 |     <api>2.0.0RC3</api>
1911 |    </version>
1912 |    <stability>
1913 |     <release>beta</release>
1914 |     <api>beta</api>
1915 |    </stability>
1916 |    <date>2007-01-31</date>
1917 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1918 |    <notes>
1919 | Wed, Jan 31, 2007 - xdebug 2.0.0rc3
1920 | + Changes:
1921 | 	- Removed the bogus &quot;xdebug.allowed_clients&quot; setting - it was not
1922 | 	  implemented.
1923 | 	- Optimized used variable collection by switching to a linked list instead
1924 | 	  of a hash. This is about 30% faster, but it needed a quick conversion to
1925 | 	  hash in the case the information had to be shown to remove duplicate
1926 | 	  variable names.
1927 | 
1928 | = Fixed bugs:
1929 | 	- Fixed bug #232: PHP log_errors functionality lost after enabling xdebug
1930 | 	  error handler when CLI is used.
1931 | 	- Fixed problems with opening files - the filename could cause double free
1932 | 	  issues.
1933 | 	- Fixed memory tracking as memory_limit is always enabled in PHP 5.2.1 and
1934 | 	  later.
1935 | 	- Fixed a segfault that occurred when creating printable stack traces and
1936 | 	  collect_params was turned off.
1937 |    </notes>
1938 |   </release>
1939 |   <release>
1940 |    <version>
1941 |     <release>2.0.0RC2</release>
1942 |     <api>2.0.0RC2</api>
1943 |    </version>
1944 |    <stability>
1945 |     <release>beta</release>
1946 |     <api>beta</api>
1947 |    </stability>
1948 |    <date>2006-12-24</date>
1949 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
1950 |    <notes>
1951 | Sun, Dec 24, 2006 - xdebug 2.0.0rc2
1952 | + Added new features:
1953 | 	- Implemented the &quot;xdebug.var_display_max_children&quot; setting. The default is
1954 | 	  set to 128 children.
1955 | 	- Added types to fancy var dumping function.
1956 | 	- Implemented FR #210: Add a way to stop the debug session without having
1957 | 	  to execute a script. The GET/POST parameter &quot;XDEBUG_SESSION_STOP_NO_EXEC&quot;
1958 | 	  works in the same way as XDEBUG_SESSION_STOP, except that the script will
1959 | 	  not be executed.
1960 | 	- DBGP: Allow postmortem analysis.
1961 | 	- DBGP: Added the non-standard function xcmd_profiler_name_get.
1962 | 
1963 | + Changes:
1964 | 	- Fixed the issue where xdebug_get_declared_vars() did not know about
1965 | 	  variables there are in the declared function header, but were not used in
1966 | 	  the code. Due to this change expected arguments that were not send to a
1967 | 	  function will now show up as ??? in stack and function traces in PHP 5.1
1968 | 	  and PHP 5.2.
1969 | 	- Allow xdebug.var_display_max_data and xdebug.var_display_max_depth
1970 | 	  settings of -1 which will unlimit those settings.
1971 | 	- DBGP: Sort super globals in Globals overview.
1972 | 	- DBGP: Fixed a bug where error messages where not added upon errors in the
1973 | 	  protocol.
1974 | 	- DBGP: Change context 1 from globals (superglobals + vars in bottom most
1975 | 	  stack frame) to just superglobals.
1976 | 
1977 | = Fixed bugs:
1978 | 	- Fixed linking error on AIX by adding libm.
1979 | 	- Fixed dead code analysis for THROW.
1980 | 	- Fixed oparray prefill caching for code coverage.
1981 | 	- Fixed the xdebug.remote_log feature work.
1982 | 	- DBGP: Fixed a bug where $this did not appear in the local scoped context.
1983 | 	- DBGP: Reimplemented property_set to use the same symbol fetching function
1984 | 	  as property_get. We now only use eval in case no type (-t) argument was
1985 | 	  given.
1986 | 	- DBGP: Fixed some issues with finding out the classname, which is
1987 | 	  important for fetching private properties.
1988 | 	- DBGP: Fixed usage of uninitialized memory that prevented looking up
1989 | 	  numerical array keys while fetching array elements not work properly.
1990 | 	- Fixed bug #228: Binary safety for stream output and property fetches.
1991 | 	- Fixed bug #227: The SESSION super global does not show up in the Globals
1992 | 	  scope.
1993 | 	- Fixed bug #225: xdebug dumps core when protocol is GDB.
1994 | 	- Fixed bug #224: Compile failure on Solaris.
1995 | 	- Fixed bug #219: Memory usage delta in traces don&apos;t work on PHP 5.2.0.
1996 | 	- Fixed bug #215: Cannot retrieve nested arrays when the array key is a
1997 | 	  numeric index.
1998 | 	- Fixed bug #214: The depth level of arrays was incorrectly checked so it
1999 | 	  would show the first page of a level too deep as well.
2000 | 	- Fixed bug #213: Dead code analysis doesn&apos;t take catches for throws into
2001 | 	  account.
2002 | 	- Fixed bug #211: When starting a new session with a different idekey, the
2003 | 	  cookie is not updated.
2004 | 	- Fixed bug #209: Additional remote debugging session started when
2005 | 	  triggering shutdown function.
2006 | 	- Fixed bug #208: Socket connection attempted when XDEBUG_SESSION_STOP.
2007 | 	- Fixed PECL bug #8989: Compile error with PHP 5 and GCC 2.95.
2008 |    </notes>
2009 |   </release>
2010 |   <release>
2011 |    <version>
2012 |     <release>2.0.0rc1</release>
2013 |     <api>2.0.0rc1</api>
2014 |    </version>
2015 |    <stability>
2016 |     <release>beta</release>
2017 |     <api>beta</api>
2018 |    </stability>
2019 |    <date>2006-10-08</date>
2020 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2021 |    <notes>
2022 | + Added new features:
2023 |     - Implemented FR #70: Provide optional depth on xdebug_call_* functions.
2024 |     - Partially implemented FR #50: Resource limiting for variable display. By
2025 |       default only two levels of nested variables and max string lengths of 512
2026 |       are shown. This can be changed by setting the ini settings
2027 |       xdebug.var_display_max_depth and xdebug.var_display_max_data.
2028 |     - Implemented breakpoints for different types of PHP errors. You can now
2029 |       set an &apos;exception&apos; breakpoint on &quot;Fatal error&quot;, &quot;Warning&quot;, &quot;Notice&quot; etc.
2030 |       This is related to bug #187.
2031 |     - Added the xdebug_print_function_trace() function to display a stack trace on
2032 |       demand.
2033 |     - Reintroduce HTML tracing by adding a new tracing option &quot;XDEBUG_TRACE_HTML&quot;
2034 |       (4).
2035 |     - Made xdebug_stop_trace() return the trace file name, so that the
2036 |       following works: &lt;?php echo file_get_contents( xdebug_stop_trace() ); ?&gt;
2037 |     - Added the xdebug.collect_vars setting to tell Xdebug to collect
2038 |       information about which variables are used in a scope. Now you don&apos;t need
2039 |       to show variables with xdebug.show_local_vars anymore for
2040 |       xdebug_get_declared_vars() to work.
2041 |     - Make the filename parameter to the xdebug_start_trace() function
2042 |       optional. If left empty it will use the same algorithm to pick a filename
2043 |       as when you are using the xdebug.auto_trace setting.
2044 | 
2045 | + Changes:
2046 |     - Implemented dead code analysis during code coverage for:
2047 |       * abstract methods.
2048 |       * dead code after return, throw and exit.
2049 |       * implicit returns when a normal return is present.
2050 |     - Improved readability of stack traces.
2051 |     - Use PG(html_errors) instead of checking whether we run with CLI when
2052 |       deciding when to use HTML messages or plain text messages.
2053 | 
2054 | = Fixed bugs:
2055 |     - Fixed bug #203: PHP errors with HTML content processed incorrectly. This
2056 |       patch backs out the change that was made to fix bug #182.
2057 |     - Fixed bug #198: Segfault when trying to use a non-existing debug handler.
2058 |     - Fixed bug #197: Race condition fixes created too many files.
2059 |     - Fixed bug #196: Profile timing on Windows does not work.
2060 |     - Fixed bug #195: CLI Error after debugging session.
2061 |     - Fixed bug #193: Compile problems with PHP 5.2.
2062 |     - Fixed bug #191: File/line breakpoints are case-sensitive on Windows.
2063 |     - Fixed bug #181: Xdebug doesn&apos;t handle uncaught exception output
2064 |       correctly.
2065 |     - Fixed bug #173: Coverage produces wrong coverage.
2066 |     - Fixed a typo that prevented the XDEBUG_CONFIG option &quot;profiler_enable&quot;
2067 |       from working.
2068 |    </notes>
2069 |   </release>
2070 |   <release>
2071 |    <version>
2072 |     <release>2.0.0beta6</release>
2073 |     <api>2.0.0beta6</api>
2074 |    </version>
2075 |    <stability>
2076 |     <release>beta</release>
2077 |     <api>beta</api>
2078 |    </stability>
2079 |    <date>2006-06-30</date>
2080 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2081 |    <notes>
2082 | + Added new features:
2083 |     - Implemented FR #137: feature_get for general commands doesn&apos;t have a text field.
2084 |     - Implemented FR #131: XDebug needs to implement paged child object requests.
2085 |     - Implemented FR #124: Add backtrace dumping information when exception thrown.
2086 |     - Implemented FR #70: Add feature_get breakpoint_types.
2087 |     - Added profiling aggregation functions (patch by Andrei Zmievski)
2088 |     - Implemented the &quot;timestamp&quot; option for the xdebug.trace_output_name and
2089 |       xdebug.profiler_output_name settings.
2090 |     - Added the xdebug.remote_log setting that allows you to log debugger
2091 |       communication to a log file for debugging. This can also be set through
2092 |       the &quot;remote_log&quot; element in the XDEBUG_CONFIG environment variable.
2093 |     - Added a &quot;script&quot; value to the profiler_output_name option.  This will write
2094 |       the profiler output to a filename that consists of the script&apos;s full path
2095 |       (using underscores). ie: /var/www/index.php becomes
2096 |       var_www_index_php_cachegrind.out. (Patch by Brian Shire).
2097 |     - DBGp: Implemented support for hit conditions for breakpoints.
2098 |     - DBGp: Added support for conditions for file/line breakpoints.
2099 |     - DBGp: Added support for hit value checking to file/line breakpoints.
2100 |     - DBGp: Added support for &quot;exception&quot; breakpoints.
2101 | + Performance improvements:
2102 |     - Added a cache that prevents the code coverage functionality from running a
2103 |       &quot;which code is executable check&quot; on every function call, even if they
2104 |       were executed multiple times. This should speed up code coverage a lot.
2105 |     - Speedup Xdebug but only gathering information about variables in scopes when
2106 |       either remote debugging is used, or show_local_vars is enabled.
2107 | = Fixed bugs:
2108 |     - Fixed bug #184: problem with control chars in code traces
2109 |     - Fixed bug #183: property_get -n $this-&gt;somethingnonexistent crashes the
2110 |       debugger.
2111 |     - Fixed bug #182: Errors are not html escaped when being displayed.
2112 |     - Fixed bug #180: collected includes not shown in trace files. (Patch by
2113 |       Cristian Rodriguez)
2114 |     - Fixed bug #178: $php_errormsg and Track errors unavailable.
2115 |     - Fixed bug #177: debugclient fails to compile due to Bison.
2116 |     - Fixed bug #176: Segfault using SplTempFileObject.
2117 |     - Fixed bug #173: Xdebug segfaults using SPL ArrayIterator.
2118 |     - Fixed bug #171: set_time_limit stack overflow on 2nd request.
2119 |     - Fixed bug #168: Xdebug&apos;s DBGp crashes on an eval command where the
2120 |       result is an array.
2121 |     - Fixed bug #125: show_mem_delta does not calculate correct negative values on
2122 |       64bit machines.
2123 |     - Fixed bug #121: property_get -n $r[2] returns the whole hash.
2124 |     - Fixed bug #111: xdebug does not ignore set_time_limit() function during debug
2125 |       session.
2126 |     - Fixed bug #87: Warning about headers when &quot;register_shutdown_function&quot; used.
2127 |     - Fixed PECL bug #6940 (XDebug ignores set_time_limit)
2128 |     - Fixed Komodo bug 45484: no member data for objects in PHP debugger.
2129 |     - Suppress NOP/EXT_NOP from being marked as executable code with Code
2130 |       Coverage.
2131 |    </notes>
2132 |   </release>
2133 |   <release>
2134 |    <version>
2135 |     <release>2.0.0beta5</release>
2136 |     <api>2.0.0beta5</api>
2137 |    </version>
2138 |    <stability>
2139 |     <release>beta</release>
2140 |     <api>beta</api>
2141 |    </stability>
2142 |    <date>2005-12-31</date>
2143 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2144 |    <notes>
2145 | + Added new features:
2146 |     - Implemented FR #161: var_dump doesn&apos;t show lengths for strings.
2147 |     - Implemented FR #158: Function calls from the {main} scope always have the
2148 |       line number 0. 
2149 |     - Implemented FR #156: it&apos;s impossible to know the time taken by the last
2150 |       func call in xdebug trace mode 0.
2151 |     - Implemented FR #153: xdebug_get_declared_vars().
2152 |     
2153 | = Fixed bugs:
2154 |     - Fixed shutdown crash with ZTS on Win32
2155 |     - Fixed bad memory leak when a E_ERROR of exceeding memory_limit was
2156 |       thrown.
2157 |     - Fixed bug #154: GCC 4.0.2 optimizes too much out with -O2.
2158 |     - Fixed bug #141: Remote context_get causes segfault.
2159 |    </notes>
2160 |   </release>
2161 |   <release>
2162 |    <version>
2163 |     <release>2.0.0beta4</release>
2164 |     <api>2.0.0beta4</api>
2165 |    </version>
2166 |    <stability>
2167 |     <release>beta</release>
2168 |     <api>beta</api>
2169 |    </stability>
2170 |    <date>2005-09-24</date>
2171 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2172 |    <notes>
2173 | + Added new features:
2174 |     - Added xdebug_debug_zval_stdout().
2175 |     - Added xdebug_get_profile_filename() function which returns the current
2176 |       profiler dump file.
2177 |     - Updated for latest 5.1 and 6.0 CVS versions of PHP.
2178 |     - Added FR #148: Option to append to cachegrind files, instead of
2179 |       overwriting.
2180 |     - Implemented FR #114: Rename tests/*.php to tests/*.inc
2181 | 
2182 | - Changed features:
2183 |     - Allow &quot;xdebug.default_enable&quot; to be set everywhere.
2184 | 
2185 | = Fixed bugs:
2186 |     - DBGP: Xdebug should return &quot;array&quot; with property get, which is defined
2187 |       in the typemap to the common type &quot;hash&quot;.
2188 |     - Fixed bug #142: xdebug crashes with implicit destructor calls.
2189 |     - Fixed bug #136: The &quot;type&quot; attribute is missing from stack_get returns.
2190 |     - Fixed bug #133: PHP scripts exits with 0 on PHP error.
2191 |     - Fixed bug #132: use of eval causes a segmentation fault.
2192 |    </notes>
2193 |   </release>
2194 |   <release>
2195 |    <version>
2196 |     <release>2.0.0beta3</release>
2197 |     <api>2.0.0beta3</api>
2198 |    </version>
2199 |    <stability>
2200 |     <release>beta</release>
2201 |     <api>beta</api>
2202 |    </stability>
2203 |    <date>2005-05-12</date>
2204 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2205 |    <notes>
2206 | + Added new features:
2207 |     - Added the possibility to trigger the profiler by setting
2208 |       &quot;xdebug.profiler_enable_trigger&quot; to 1 and using XDEBUG_PROFILE as a get
2209 |       parameter.
2210 | 
2211 | = Fixed bugs:
2212 |     - Fixed a segfault for when an attribute value is NULL on XML string
2213 |       generation.
2214 |     - Fixed bug #118: Segfault with exception when remote debugging.
2215 |     - Fixed bug #117: var_dump dows not work with &quot;private&quot;.
2216 |     - Fixed bug #109: DBGP&apos;s eval will abort the script when the eval statement
2217 |       is invalid.
2218 |     - Fixed bug #108: log_only still displays some text for errors in included
2219 |       files.
2220 |     - Fixed bug #107: Code Coverage only detects executable code in used
2221 |       functions and classes.
2222 |     - Fixed bug #103: crash when running the DBGp command &apos;eval&apos; on a global
2223 |       variable
2224 |     - Fixed bug #95: Segfault when deinitializing Xdebug module.
2225 |       (Patch by Maxim Poltarak &lt;demiurg@gmail.com&gt;)
2226 |    </notes>
2227 |   </release>
2228 |   <release>
2229 |    <version>
2230 |     <release>2.0.0beta2</release>
2231 |     <api>2.0.0beta2</api>
2232 |    </version>
2233 |    <stability>
2234 |     <release>beta</release>
2235 |     <api>beta</api>
2236 |    </stability>
2237 |    <date>2004-11-28</date>
2238 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2239 |    <notes>
2240 | + Added new features:
2241 |     - DBGP: Added error messages to returned errors (in most cases)
2242 |   
2243 | + Added new functions:
2244 |     - xdebug_debug_zval() to debug zvals by printing its refcounts and is_ref
2245 |       values.
2246 |   
2247 | = Changed features:
2248 |     - xdebug_code_coverage_stop() will now clean up the code coverage array,
2249 |       unless you specify FALSE as parameter.
2250 |     - The proper Xdebug type is &quot;hash&quot; for associative arrays.
2251 |     - Extended the code-coverage functionality by returning lines with
2252 |       executable code on them, but where not executed with a count value of -1.
2253 | 
2254 | = Fixed bugs:
2255 |     - DBGP: Make property_get and property_value finally work as they should,
2256 |       including retrieving information from different depths then the most top
2257 |       stack frame.
2258 |     - DBGP: Fix eval&apos;ed $varnames in property_get.
2259 |     - DBGP: Support the -d option for property_get.
2260 |     - Fixed the exit handler hook to use the new &quot;5.1&quot; way of handling it;
2261 |       which fortunately also works with PHP 5.0.
2262 |     - Fixed bug #102: Problems with configure for automake 1.8.
2263 |     - Fixed bug #101: crash with set_exeception_handler() and uncatched exceptions.
2264 |     - Fixed bug #99: unset variables return the name as a string with property_get.
2265 |     - Fixed bug #98: &apos;longname&apos; attribute not returned for uninitialized
2266 |       property in context_get request.
2267 |     - Fixed bug #94: xdebug_sprintf misbehaves with x86_64/glibc-2.3.3
2268 |     - Fixed bug #93: Crash in lookup_hostname on x86_64
2269 |     - Fixed bug #92: xdebug_disable() doesn&apos;t disable the exception handler.
2270 |     - Fixed bug #68: Summary not written when script ended with &quot;exit()&quot;.
2271 |    </notes>
2272 |   </release>
2273 |   <release>
2274 |    <version>
2275 |     <release>2.0.0beta1</release>
2276 |     <api>2.0.0beta1</api>
2277 |    </version>
2278 |    <stability>
2279 |     <release>beta</release>
2280 |     <api>beta</api>
2281 |    </stability>
2282 |    <date>2004-09-15</date>
2283 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2284 |    <notes>
2285 | + Added new features:
2286 |     - Added support for the new DBGp protocol for communicating with the debug
2287 |       engine.
2288 |     - A computerized trace format for easier parsing by external programs.
2289 |     - The ability to set remote debugging features via the environment.  This
2290 |       allows an IDE to emulate CGI and still pass the configuration through to
2291 |       the debugger.  In CGI mode, PHP does not allow -d arguments.
2292 |     - Reimplementation of the tracing code, you can now only trace to file; this greatly
2293 |       enhances performance as no string representation of variables need to be
2294 |       kept in memory any more.
2295 |     - Re-implemented profiling support. Xdebug outputs information the same way
2296 |       that cachegrind does so it is possible to use Kcachegrind as front-end.
2297 |     - Xdebug emits warnings when it was not loaded as a Zend extension.
2298 |     - Added showing private, protected and public to the fancy var_dump()
2299 |       replacement function.
2300 |     - Added the setting of the TCP_NODELAY socket option to stop delays in
2301 |       transferring data to the remote debugger client. (Patch by Christof J.  Reetz)
2302 |     + DebugClient: Added setting for port to listen on and implemented running
2303 |       the previous command when pressing just enter.
2304 | 
2305 | + Added new functions:
2306 |     - xdebug_get_stack_depth() to return the current stack depth level.
2307 |     - xdebug_get_tracefile_name() to retrieve the name of the tracefile. This
2308 |       is useful in case auto trace is enabled and you want to clean the trace
2309 |       file.
2310 |     - xdebug_peak_memory_usage() which returns the peak memory
2311 |       used in a script. (Only works when --enable-memory-limit was enabled)
2312 | 
2313 | + Added feature requests:
2314 |     - FR #5: xdebug_break() function which interupts the script for the debug
2315 |       engine.
2316 |     - FR #30: Dump current scope information in stack traces on error.
2317 |     - FR #88: Make the url parameter XDEBUG_SESSION_START optional. So it can
2318 |       be disabled and the user does not need to add it.
2319 | 
2320 | + Added new php.ini settings:
2321 |     - xdebug.auto_trace_file: to configure a trace file to write to as addition
2322 |       to the xdebug.auto_trace setting which just turns on tracing.
2323 |     - xdebug.collect_includes: separates collecting
2324 |       names of include files from the xdebug.collect_params setting.
2325 |     - xdebug.collect_return: showing return values in traces.
2326 |     - xdebug.dump_global: with which you can turn off dumping of super globals
2327 |       even in you have that configured.
2328 |     - xdebug.extended_info: turns off the generation of extended opcodes that
2329 |       are needed for stepping and breakpoints for the remote debugger. This is
2330 |       useful incase you want to profile memory usage as the generation of this
2331 |       extended info increases memory usage of oparrrays by about 33%. 
2332 |     - xdebug.profiler_output_dir: profiler output directory.
2333 |     - xdebug.profiler_enable: enable the profiler.
2334 |     - xdebug.show_local_vars: turn off the showing of local variables in the
2335 |       top most stack frame on errors.
2336 |     - xdebug.show_mem_delta: show differences between current and previous
2337 |       memory usage on a function call level.
2338 |     - xdebug.trace_options: to configure extra
2339 |       options for trace dumping:
2340 |         o XDEBUG_TRACE_APPEND option (1)
2341 | 
2342 | = Changed features:
2343 |     - xdebug_start_trace() now returns the filename of the tracefile (.xt is
2344 |       added to the requested name).
2345 |     - Changed default debugging protocol to dbgp instead of gdb.
2346 |     - Changed default debugger port from 17869 to 9000.
2347 |     - Changed trace file naming: xdebug.trace_output_dir is now used to
2348 |       configure a directory to dump automatic traces; the trace file name now
2349 |       also includes the pid (xdebug.trace_output_name=pid) or a crc32 checksum
2350 |       of the current working dir (xdebug.trace_output_name=crc32) and traces
2351 |       are not being appended to an existing file anymore, but simply
2352 |       overwritten.
2353 |     - Removed $this and $GLOBALS from showing variables in the local scope.
2354 | 
2355 | - Removed functions:
2356 |     - xdebug_get_function_trace/xdebug_dump_function_trace() because of the new
2357 |       idea of tracing.
2358 | 
2359 | = Fixed bugs:
2360 |     - Fixed bug #89: var_dump shows empty strings garbled.
2361 |     - Fixed bug #85: Xdebug segfaults when no idekey is set.
2362 |     - Fixed bug #83: More than 32 parameters functions make xdebug crash.
2363 |     - Fixed bug #75: xdebug&apos;s var_dump implementation is not binary safe.
2364 |     - Fixed bug #73: komodo beta 4.3.7 crash.
2365 |     - Fixed bug #72: breakpoint_get returns wrong structure.
2366 |     - Fixed bug #69: Integer overflow in cachegrind summary.
2367 |     - Fixed bug #67: Filenames in Xdebug break URI RFC with spaces.
2368 |     - Fixed bug #64: Missing include of xdebug_compat.h.
2369 |     - Fixed bug #57: Crash with overloading functions.
2370 |     - Fixed bug #54: source command did not except missing -f parameter.
2371 |     - Fixed bug #53: Feature get misusing the supported attribute.
2372 |     - Fixed bug #51: Only start a debug session if XDEBUG_SESSION_START is
2373 |       passed as GET or POST parameter, or the DBGP_COOKIE is send to the server.
2374 |       Passing XDEBUG_SESSION_STOP as GET/POST parameter will end the debug
2375 |       session and removes the cookie again. The cookie is also passed to the
2376 |       remote handler backends; for DBGp it is added to the &lt;init&gt; packet.
2377 |     - Fixed bug #49: Included file&apos;s names should not be stored by address.
2378 |     - Fixed bug #44: Script time-outs should be disabled when debugging.
2379 |     = Fixed bug #36: GDB handler using print causes segfault with wrong syntax
2380 |     - Fixed bug #33: Implemented the use of the ZEND_POST_DEACTIVATE hook. Now we
2381 |       can handle destructors safely too.
2382 |     - Fixed bug #32: Unusual dynamic variables cause xdebug to crash.
2383 |    </notes>
2384 |   </release>
2385 |   <release>
2386 |    <version>
2387 |     <release>1.3.1</release>
2388 |     <api>1.3.1</api>
2389 |    </version>
2390 |    <stability>
2391 |     <release>stable</release>
2392 |     <api>stable</api>
2393 |    </stability>
2394 |    <date>2004-04-06</date>
2395 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2396 |    <notes>
2397 | = Fixed profiler to aggregate class/method calls correctly. (Robert Beenen)
2398 | = Fixed debugclient to initialize socket structure correctly. (Brandon Philips
2399 |   and David Sklar)
2400 | = GDB: Fixed bug where the source file wasn&apos;t closed after a &quot;source&quot; command.
2401 |   (Derick)
2402 |    </notes>
2403 |   </release>
2404 |   <release>
2405 |    <version>
2406 |     <release>1.3.0</release>
2407 |     <api>1.3.0</api>
2408 |    </version>
2409 |    <stability>
2410 |     <release>stable</release>
2411 |     <api>stable</api>
2412 |    </stability>
2413 |    <date>2003-09-17</date>
2414 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2415 |    <notes>
2416 | = Fixed segfault where a function name didn&apos;t exist in case of a
2417 |  &quot;call_user_function&quot;. (Derick)
2418 | = Fixed reading a filename in case of an callback to a PHP function from an
2419 |   internal function (like &quot;array_map()&quot;). (Derick)
2420 |    </notes>
2421 |   </release>
2422 |   <release>
2423 |    <version>
2424 |     <release>1.3.0rc1</release>
2425 |     <api>1.3.0rc1</api>
2426 |    </version>
2427 |    <stability>
2428 |     <release>beta</release>
2429 |     <api>beta</api>
2430 |    </stability>
2431 |    <date>2003-09-17</date>
2432 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2433 |    <notes>
2434 | = Fixed bug with wrong file names for functions called from call_user_*().
2435 |   (Derick)
2436 | + Added the option &quot;dump_superglobals&quot; to the remote debugger. If you set this
2437 |   option to 0 the &quot;show-local&quot; and similar commands will not return any data
2438 |   from superglobals anymore. (Derick)
2439 | = Fixed bug #2: &quot;pear package&quot; triggers a segfault. (Derick)
2440 | = Fixed crash bug when a function had sprintf style parameters (ie.
2441 |   strftime()). (Derick)
2442 | + Added &quot;id&quot; attribute to &lt;var /&gt; elements in responses from the remove
2443 |   debugger when the response method is XML. This makes it possible to
2444 |   distinguish between unique elements by use of recursion for example. (Derick)
2445 | = Improved performance greatly by doing lazy folding of variables outside
2446 |   trace mode. (Derick)
2447 | = Fixed a bug with &quot;quit&quot;, if it was used it disabled the extension for the
2448 |   current process. (Derick)
2449 | + Added the &quot;full&quot; argument to the remote command &quot;backtrace&quot;. When this
2450 |   argument is passed, the local variables will be returned to for each frame in
2451 |   the stack. (Derick)
2452 | + Implemented xdebug_time_index() which returns the time passed since the
2453 |   start of the script. This change also changes the output of the tracing
2454 |   functions as the start time will no longer be the first function call, but
2455 |   the real start time of the script. (Derick)
2456 | + Implemented the &quot;show-local&quot; command (shows all local variables in the
2457 |   current scope including all contents). (Derick)
2458 | + Implemented conditions for breakpoints in the &quot;break&quot; command. (Derick)
2459 |    </notes>
2460 |   </release>
2461 |   <release>
2462 |    <version>
2463 |     <release>1.2.0</release>
2464 |     <api>1.2.0</api>
2465 |    </version>
2466 |    <stability>
2467 |     <release>stable</release>
2468 |     <api>stable</api>
2469 |    </stability>
2470 |    <date>2003-04-21</date>
2471 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2472 |    <notes>
2473 | = Fixed compilation on MacOSX. (Derick)
2474 |    </notes>
2475 |   </release>
2476 |   <release>
2477 |    <version>
2478 |     <release>1.2.0rc2</release>
2479 |     <api>1.2.0rc2</api>
2480 |    </version>
2481 |    <stability>
2482 |     <release>beta</release>
2483 |     <api>beta</api>
2484 |    </stability>
2485 |    <date>2003-04-15</date>
2486 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2487 |    <notes>
2488 | = Fixed handling Windows paths in the debugger. (Derick)
2489 | = Fixed getting zvals out of Zend Engine 2. (Derick)
2490 |    </notes>
2491 |   </release>
2492 |   <release>
2493 |    <version>
2494 |     <release>1.2.0rc1</release>
2495 |     <api>1.2.0rc1</api>
2496 |    </version>
2497 |    <stability>
2498 |     <release>beta</release>
2499 |     <api>beta</api>
2500 |    </stability>
2501 |    <date>2003-04-06</date>
2502 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2503 |    <notes>
2504 | + Added code coverage functions to check which lines and how often they were
2505 |   touched during execution. (Derick)
2506 | + Made Xdebug compatible with Zend Engine 2. (Derick)
2507 | + Added dumping of super globals on errors. (Harald Radi)
2508 | + Added XML protocol for the debugger client. (Derick)
2509 | = Fixed handling of &quot;continue&quot; (so that it also continues with the script).
2510 |   (Derick)
2511 | + Additions to the remote debugger: &quot;eval&quot; (evaluate any PHP code from the
2512 |   debugger client). (Derick)
2513 | + Added profiling support to xdebug. This introduces 3 new functions,
2514 |   xdebug_start_profiling() that begins profiling process, 
2515 |   xdebug_stop_profiling() that ends the profiling process and
2516 |   xdebug_dump_function_trace() that dumps the profiling data. (Ilia)
2517 | + Implemented the &quot;kill&quot; (kills the running script) and &quot;delete&quot; (removes
2518 |   a breakpoint on a specified element) command. (Derick)
2519 |    </notes>
2520 |   </release>
2521 |   <release>
2522 |    <version>
2523 |     <release>1.1.0</release>
2524 |     <api>1.1.0</api>
2525 |    </version>
2526 |    <stability>
2527 |     <release>stable</release>
2528 |     <api>stable</api>
2529 |    </stability>
2530 |    <date>2002-11-11</date>
2531 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2532 |    <notes>
2533 | + Implemented the &quot;list&quot; (source listing), &quot;print&quot; (printing variable
2534 |   contents), &quot;show&quot; (show all variables in the scope), &quot;step&quot; (step through
2535 |   execution), &quot;pwd&quot; (print working directory), &quot;next&quot; (step over) and &quot;finish&quot;
2536 |   (step out) commands for the remote debugger. (Derick)
2537 | = Fixed lots of small bugs, under them memory leaks and crash bugs. (Derick)
2538 |    </notes>
2539 |   </release>
2540 |   <release>
2541 |    <version>
2542 |     <release>1.1.0pre2</release>
2543 |     <api>1.1.0pre2</api>
2544 |    </version>
2545 |    <stability>
2546 |     <release>beta</release>
2547 |     <api>beta</api>
2548 |    </stability>
2549 |    <date>2002-10-29</date>
2550 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2551 |    <notes>
2552 | + Implemented class::method, object-&gt;method and file.ext:line style
2553 |   breakpoints. (Derick)
2554 | + Added xdebug.collect_params setting. If this setting is on (the default)
2555 |   then Xdebug collects all parameters passed to functions, otherwise they
2556 |   are not collected at all. (Derick)
2557 | + Implemented correct handling of include/require and eval. (Derick)
2558 |    </notes>
2559 |   </release>
2560 |   <release>
2561 |    <version>
2562 |     <release>1.1.0pre1</release>
2563 |     <api>1.1.0pre1</api>
2564 |    </version>
2565 |    <stability>
2566 |     <release>beta</release>
2567 |     <api>beta</api>
2568 |    </stability>
2569 |    <date>2002-10-22</date>
2570 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2571 |    <notes>
2572 | + Added automatic starting of function traces (xdebug.auto_trace, defaulting to
2573 |   &quot;off&quot;). (Derick)
2574 | - Xdebug no longer supports PHP versions below PHP 4.3.0pre1. (Derick)
2575 | + Added gdb compatible debugger handler with support for simple (function only)
2576 |   breakpoints. (Derick)
2577 | = Implemented a new way to get class names and file names. (Derick, Thies C.
2578 |   Arntzen &lt;thies@thieso.net&gt;)
2579 | + Added time-index and memory footprint to CLI dumps. (Derick)
2580 | + Implemented remote debugger handler abstraction. (Derick)
2581 | + Added a php3 compatible debugger handler. (Derick)
2582 |    </notes>
2583 |   </release>
2584 |   <release>
2585 |    <version>
2586 |     <release>1.0.0rc1</release>
2587 |     <api>1.0.0rc1</api>
2588 |    </version>
2589 |    <stability>
2590 |     <release>beta</release>
2591 |     <api>beta</api>
2592 |    </stability>
2593 |    <date>2002-09-01</date>
2594 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2595 |    <notes>
2596 | + Implemented gathering of parameters to internal functions (only available
2597 |   in combination with PHP 4.3.0-dev). (Derick)
2598 | = Implemented a new way to get class names and file names. (Derick, Thies C.
2599 |   Arntzen &gt;thies@thieso.net&lt;)
2600 | + Added support for error messages with stack trace in syslog. (Sergio
2601 |   Ballestrero &gt;s.ballestrero@planetweb.it&lt;)
2602 | = Windows compilation fixes. (Derick)
2603 |    </notes>
2604 |   </release>
2605 |   <release>
2606 |    <version>
2607 |     <release>0.9.0</release>
2608 |     <api>0.9.0</api>
2609 |    </version>
2610 |    <stability>
2611 |     <release>beta</release>
2612 |     <api>beta</api>
2613 |    </stability>
2614 |    <date>2002-06-16</date>
2615 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2616 |    <notes>
2617 | = Fixed a memory leak in delayed included files. (Derick)
2618 | - Added support for PHP 4.1.2. (Derick)
2619 | = Rewrote xdebug_get_function_stack() and xdebug_get_function_trace() to return
2620 |   data in multidimensional arrays. (Derick)
2621 | = Fixed compiling without memory limit enabled (Sander Roobol, Derick)
2622 | - Add support for classnames, variable include files and variable
2623 |   function names. (Derick)
2624 | - Implemented links to the PHP Manual in traces. (Derick)
2625 | - Added timestamps and memory usage to function traces. (Derick)
2626 | = Fixed crash when using an user defined session handler. (Derick)
2627 | + Implemented variable function names ($a = &apos;foo&apos;; $f();) for use in
2628 |   traces. (Derick)
2629 |    </notes>
2630 |   </release>
2631 |   <release>
2632 |    <version>
2633 |     <release>0.8.0</release>
2634 |     <api>0.8.0</api>
2635 |    </version>
2636 |    <stability>
2637 |     <release>beta</release>
2638 |     <api>beta</api>
2639 |    </stability>
2640 |    <date>2002-05-26</date>
2641 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2642 |    <notes>
2643 | + Implemented much better parameter tracing for user defined
2644 |   functions. (Derick)
2645 | = Renamed xdebug_get_function_trace() to xdebug_dump_function_trace().
2646 |   (Derick)
2647 | = Implemented new xdebug_get_function_trace() to return the function trace in
2648 |   an array. (Derick)
2649 | + Added a parameter to xdebug_start_trace(). When this parameter is used,
2650 |   xdebug will dump a function trace to the filename which this parameter
2651 |   speficies. (Derick)
2652 | - Fix a problem with nested member functions. (Derick)
2653 | = Make configure scripts work with PHP 4.2.x. (Derick)
2654 | + Implemented handling single-dimensional constant arrays passed to a
2655 |   function. (Derick)
2656 | = Fix function traces in windows. (Derick)
2657 | + Implemented function traces, which you can start and stop with
2658 |   xdebug_start_trace() and xdebug_stop_trace(). You can view the trace by using
2659 |   the return array from xdebug_get_function_trace(). (Derick)
2660 | = Fixed segfaults with xdebug_call_*(). (Derick)
2661 |    </notes>
2662 |   </release>
2663 |   <release>
2664 |    <version>
2665 |     <release>0.7.0</release>
2666 |     <api>0.7.0</api>
2667 |    </version>
2668 |    <stability>
2669 |     <release>beta</release>
2670 |     <api>beta</api>
2671 |    </stability>
2672 |    <date>2002-05-08</date>
2673 |    <license uri="http://www.opensource.org/licenses/bsd-license.php">BSD style</license>
2674 |    <notes>
2675 | + Implemented handling of static method calls (foo::bar). (Derick)
2676 | + Added correct handling of include(_once)/require(_once) and eval().
2677 |   (Derick)
2678 | + Added ini setting to change the default setting for enabling showing
2679 |   enhanced error messages. (Defaults to &quot;On&quot;). (Derick)
2680 | + Added the functions xdebug_enable() and xdebug_disable() to change the
2681 |   showing of stack traces from within your code. (Derick)
2682 | = Fixed the extension to show all errors. (Derick)
2683 | + Implemented xdebug_memory_usage() which returns the memory in use by PHPs
2684 |   engine. (Derick)
2685 |    </notes>
2686 |   </release>
2687 |  </changelog>
2688 | </package>
2689 | 


--------------------------------------------------------------------------------