diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
new file mode 100644
index 0000000..7089afc
--- /dev/null
+++ b/.github/workflows/documentation.yml
@@ -0,0 +1,32 @@
+name: Documentation
+
+on:
+ push:
+ branches: [ master, release-* ]
+ paths:
+ - '**.md'
+ pull_request:
+ branches: [ master, release-* ]
+ paths:
+ - '**.md'
+
+jobs:
+ quality:
+ name: Quality checks
+ runs-on: [ubuntu-latest]
+
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Lint markdown files
+ uses: nosborn/github-action-markdown-cli@v3.1.0
+ with:
+ files: .
+ ignore_path: .markdownlintignore
+
+ - name: Perform spell check
+ uses: codespell-project/actions-codespell@master
+ with:
+ path: '**/*.md'
+ check_filenames: true
+ ignore_words_list: tekst
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
new file mode 100644
index 0000000..0d3465e
--- /dev/null
+++ b/.github/workflows/php.yml
@@ -0,0 +1,203 @@
+name: CI
+
+on:
+ push:
+ branches: [ '**' ]
+ paths-ignore:
+ - '**.md'
+ pull_request:
+ branches: [ master, release-* ]
+ paths-ignore:
+ - '**.md'
+
+jobs:
+ basic-tests:
+ name: Syntax and unit tests, PHP ${{ matrix.php-versions }}, ${{ matrix.operating-system }}
+ runs-on: ${{ matrix.operating-system }}
+ strategy:
+ fail-fast: false
+ matrix:
+ operating-system: [ubuntu-latest, windows-latest]
+ php-versions: ['7.4', '8.0', '8.1', '8.2']
+
+ steps:
+ - name: Setup PHP, with composer and extensions
+ uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
+ with:
+ coverage: pcov
+ ini-values: error_reporting=E_ALL
+ extensions: intl, mbstring, pdo, xml
+ php-version: ${{ matrix.php-versions }}
+ tools: composer:v2
+
+ - name: Setup problem matchers for PHP
+ run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+ - name: Setup problem matchers for PHPUnit
+ run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+ - name: Set git to use LF
+ run: |
+ git config --global core.autocrlf false
+ git config --global core.eol lf
+
+ - uses: actions/checkout@v3
+
+ - name: Get composer cache directory (linux)
+ if: ${{ matrix.operating-system == 'ubuntu-latest' }}
+ run: echo "COMPOSER_CACHE=$(composer config cache-files-dir)" >> $GITHUB_ENV
+
+ - name: Get composer cache directory (windows)
+ if: ${{ matrix.operating-system == 'windows-latest' }}
+ run: echo "COMPOSER_CACHE=$(composer config cache-files-dir)" >> $env:GITHUB_ENV
+
+ - name: Cache composer dependencies
+ uses: actions/cache@v3
+ with:
+ path: $COMPOSER_CACHE
+ key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+ restore-keys: ${{ runner.os }}-composer-
+
+ - name: Validate composer.json and composer.lock
+ run: composer validate
+
+ - name: Install Composer dependencies
+ run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Syntax check PHP
+ run: bash vendor/bin/check-syntax-php.sh
+
+ - name: Decide whether to run code coverage or not
+ if: ${{ matrix.php-versions != '7.4' || matrix.operating-system != 'ubuntu-latest' }}
+ run: |
+ echo "NO_COVERAGE=--no-coverage" >> $GITHUB_ENV
+
+ - name: Run unit tests
+ run: |
+ ./vendor/bin/phpunit ${{ env.NO_COVERAGE }}
+
+ - name: Save coverage data
+ if: ${{ matrix.php-versions == '7.4' && matrix.operating-system == 'ubuntu-latest' }}
+ uses: actions/upload-artifact@v3
+ with:
+ name: build-data
+ path: ${{ github.workspace }}/build
+
+ security:
+ name: Security checks
+ runs-on: [ubuntu-latest]
+ steps:
+ - name: Setup PHP, with composer and extensions
+ uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
+ with:
+ php-version: '7.4'
+ extensions: mbstring, pdo, xml
+ tools: composer:v2
+ coverage: none
+
+ - name: Setup problem matchers for PHP
+ run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+ - uses: actions/checkout@v3
+
+ - name: Cache composer dependencies
+ uses: actions/cache@v3
+ with:
+ path: $COMPOSER_CACHE
+ key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+ restore-keys: ${{ runner.os }}-composer-
+
+ - name: Install Composer dependencies
+ run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Security check for locked dependencies
+ run: composer audit
+
+ - name: Update Composer dependencies
+ run: composer update --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Security check for updated dependencies
+ run: composer audit
+
+ sanity-check:
+ name: Sanity checks
+ runs-on: [ubuntu-latest]
+
+ steps:
+ - name: Setup PHP, with composer and extensions
+ uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
+ with:
+ php-version: '7.4'
+ extensions: mbstring, pdo, xml
+ tools: composer:v2
+ coverage: none
+
+ - name: Setup problem matchers for PHP
+ run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+ - uses: actions/checkout@v3
+
+ - name: Cache composer dependencies
+ uses: actions/cache@v3
+ with:
+ path: $COMPOSER_CACHE
+ key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+ restore-keys: ${{ runner.os }}-composer-
+
+ - name: Install Composer dependencies
+ run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+ - name: Syntax check YAML / XML / JSON
+ run: |
+ bash vendor/bin/check-syntax-yaml.sh
+ bash vendor/bin/check-syntax-xml.sh
+ bash vendor/bin/check-syntax-json.sh
+
+ quality:
+ name: Quality control
+ runs-on: [ubuntu-latest]
+ needs: [basic-tests]
+
+ steps:
+ - name: Setup PHP, with composer and extensions
+ id: setup-php
+ uses: shivammathur/setup-php@v2 #https://github.com/shivammathur/setup-php
+ with:
+ php-version: '7.4'
+ tools: composer:v2
+ extensions: mbstring, pdo, xml
+
+ - name: Setup problem matchers for PHP
+ run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+ - uses: actions/checkout@v3
+
+ - name: Cache composer dependencies
+ uses: actions/cache@v3
+ with:
+ path: $COMPOSER_CACHE
+ key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+ restore-keys: ${{ runner.os }}-composer-
+
+ - name: Install Composer dependencies
+ run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+ - uses: actions/download-artifact@v3
+ with:
+ name: build-data
+ path: ${{ github.workspace }}/build
+
+ - name: Codecov
+ uses: codecov/codecov-action@v3
+
+ - name: PHP Code Sniffer
+ continue-on-error: true
+ run: php vendor/bin/phpcs
+
+ - name: Psalm
+ continue-on-error: true
+ run: php vendor/bin/psalm --show-info=true --shepherd --php-version=${{ steps.setup-php.outputs.php-version }}
+
+ - name: Psalter
+ continue-on-error: true
+ run: php vendor/bin/psalter --issues=UnnecessaryVarAnnotation --dry-run --php-version=${{ steps.setup-php.outputs.php-version }}
diff --git a/.gitignore b/.gitignore
index 2ef2c18..ce45e20 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,9 +1,8 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-# git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-default-enable
+.phpunit.result.cache
+composer.lock
+composer.phar
+/vendor/
+# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
+# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
+# composer.lock
diff --git a/.markdownlintignore b/.markdownlintignore
new file mode 100644
index 0000000..140fada
--- /dev/null
+++ b/.markdownlintignore
@@ -0,0 +1 @@
+vendor/*
diff --git a/.markdownlintrc b/.markdownlintrc
new file mode 100644
index 0000000..b077f0e
--- /dev/null
+++ b/.markdownlintrc
@@ -0,0 +1,4 @@
+{
+ "default": true,
+ "MD013": false
+}
diff --git a/.php_cs.dist b/.php_cs.dist
new file mode 100644
index 0000000..b46e7f8
--- /dev/null
+++ b/.php_cs.dist
@@ -0,0 +1,15 @@
+in([
+ __DIR__ . '/src',
+ __DIR__ . '/tests',
+ ])
+;
+return PhpCsFixer\Config::create()
+ ->setRules([
+ '@PSR2' => true,
+ '@PSR4' => true,
+ '@PSR5' => true,
+ ])
+ ->setFinder($finder)
+;
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..a345e48
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,459 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+not price. Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
\ No newline at end of file
diff --git a/codecov.yml b/codecov.yml
new file mode 100644
index 0000000..d01dd7d
--- /dev/null
+++ b/codecov.yml
@@ -0,0 +1,17 @@
+coverage:
+ status:
+ project:
+ default:
+ target: 0%
+ threshold: 2%
+ patch: off
+comment:
+ layout: "diff"
+ behavior: once
+ require_changes: true
+ require_base: no
+ require_head: yes
+ branches: null
+
+github_checks:
+ annotations: false
diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000..c16905c
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,42 @@
+{
+ "name": "geant/simplesamlphp-module-accountlinker",
+ "description": "A module for linking accounts",
+ "type": "simplesamlphp-module",
+ "keywords": ["simplesamlphp", "accountlinker"],
+ "license": "LGPL-2.1-or-later",
+ "config": {
+ "preferred-install": {
+ "simplesamlphp/simplesamlphp": "source",
+ "*": "dist"
+ },
+ "allow-plugins": {
+ "composer/package-versions-deprecated": true,
+ "simplesamlphp/composer-module-installer": true
+ }
+ },
+ "autoload": {
+ "psr-4": {
+ "SimpleSAML\\Module\\accountlinker\\": "src/"
+ }
+ },
+ "autoload-dev": {
+ "psr-4": {
+ "SimpleSAML\\Test\\Utils\\": "vendor/simplesamlphp/simplesamlphp/tests/Utils"
+ }
+ },
+ "require": {
+ "php": ">=7.4 || ^8.0",
+ "ext-pdo": "*",
+
+ "simplesamlphp/assert": "~0.8",
+ "simplesamlphp/composer-module-installer": "^1.3.2",
+ "simplesamlphp/simplesamlphp": "^2.0.0"
+ },
+ "require-dev": {
+ "simplesamlphp/simplesamlphp-test-framework": "^1.2.1"
+ },
+ "support": {
+ "issues": "https://github.com/geant/simplesamlphp-module-accountlinker/issues",
+ "source": "https://github.com/geant/simplesamlphp-module-accountlinker"
+ }
+}
diff --git a/config-templates/module_accountlinker.php b/config-templates/module_accountlinker.php
index ed53830..ed09307 100644
--- a/config-templates/module_accountlinker.php
+++ b/config-templates/module_accountlinker.php
@@ -1,12 +1,11 @@
'pgsql:dbname=yourdbnamehere',
- 'username' => 'user',
- 'password' => '1234'
-);
-?>
+$config = [
+ 'dsn' => 'pgsql:dbname=yourdbnamehere',
+ 'username' => 'user',
+ 'password' => '1234',
+];
diff --git a/default-disable b/default-disable
deleted file mode 100644
index fa0bd82..0000000
--- a/default-disable
+++ /dev/null
@@ -1,3 +0,0 @@
-This file indicates that the default state of this module
-is disabled. To enable, create a file named enable in the
-same directory as this file.
diff --git a/lib/Admin/Store/SQLStore.php b/lib/Admin/Store/SQLStore.php
deleted file mode 100644
index 2239e17..0000000
--- a/lib/Admin/Store/SQLStore.php
+++ /dev/null
@@ -1,132 +0,0 @@
-_dsn = $config['dsn'];
- $this->_username = $config['username'];
- $this->_password = $config['password'];
- }
-
- public function getAccounts()
- {
- $dbh = $this->_getStore();
- $stmt = $dbh->prepare("SELECT account_id, user_id FROM accounts");
- $stmt->execute();
- return $stmt->fetchAll(PDO::FETCH_ASSOC);
- }
-
- public function searchAccount($type, $value, $accountIds)
- {
- $dbh = $this->_getStore();
- switch ($type) {
- case 'sp':
- $query = "select attr.account_id, attr.value, a.user_id, a.entityid_id, attr.attributeproperty_id
- from attributes attr left join accounts a ON (attr.account_id = a.account_id)
- where a.user_id IN (select user_id from groups_spentityids where spentityid ILIKE '%".$value."%')";
- if ($accountIds) {
- $query .= " AND a.account_id IN (".implode(',', $accountIds).")";
- }
- $stmt = $dbh->prepare($query);
- break;
- case 'idp':
- $query = "select attr.account_id, attr.value, a.user_id, a.entityid_id, attr.attributeproperty_id
- from attributes attr left join accounts a ON (attr.account_id = a.account_id)
- where a.entityid_id IN (select entityid_id from entityids where name ILIKE '%".$value."%')";
- if ($accountIds) {
- $query .= " AND a.account_id IN (".implode(',', $accountIds).")";
- }
- $stmt = $dbh->prepare($query);
- break;
- case 'attr':
- //$query = "select attr.account_id, attr.value, a.user_id, a.entityid_id, attr.attributeproperty_id
- //from accounts a left join attributes attr on (a.account_id = attr.account_id)
- //where attr.account_id IN (select account_id from attributes where value ILIKE '%".$value."%')";
- $query = "select e.name, attr.account_id, attr.value, a.user_id, a.entityid_id, attr.attributeproperty_id
- from entityids e left join accounts a on (e.entityid_id = a.entityid_id)
- left join attributes attr on (a.account_id = attr.account_id)
- where attr.account_id IN (select account_id from attributes where value ILIKE '%".$value."%')";
- if ($accountIds) {
- $query .= " AND a.account_id IN (".implode(',', $accountIds).")";
- }
- $stmt = $dbh->prepare($query);
- break;
-
- }
- //select * from accounts where user_id IN (select user_id from groups_spentityids where spentityid ILIKE '%chris%');
- //select * from accounts where entityid_id IN ( select entityid_id from entityids where name ILIKE '%terena%');
- $stmt->execute();
- $result = $stmt->fetchAll(PDO::FETCH_ASSOC);
- $grouped = array();
- // group by user_id and account_id
- foreach ($result as $key => $val) {
- $grouped[$val['user_id']][$val['account_id']]['attributes'][$val['attributeproperty_id']] = $val['value'];
- $grouped[$val['user_id']][$val['account_id']]['account_id'] = $val['account_id'];
- $grouped[$val['user_id']][$val['account_id']]['entityid_id'] = $val['entityid_id'];
- $grouped[$val['user_id']][$val['account_id']]['entityid_name'] = $val['name'];
- }
- return $grouped;
- }
-
- /**
- * Lazy load database handle
- *
- * @return mixed PDO Database handle, or false
- */
- private function _getStore()
- {
- if (null !== $this->_store) {
- return $this->_store;
- }
- try {
- $this->_store = new PDO($this->_dsn, $this->_username, $this->_password);
- } catch (PDOException $e) {
- throw new Exception('could not connect to database');
- }
- return $this->_store;
- }
-
-}
-
-?>
\ No newline at end of file
diff --git a/lib/Admin/admin.php b/lib/Admin/admin.php
deleted file mode 100644
index be0c43e..0000000
--- a/lib/Admin/admin.php
+++ /dev/null
@@ -1,77 +0,0 @@
-_store = $this->_getStore($config);
- $this->_namespace = 'accountlinker';
- }
-
- /**
- * Get Account Linking Store
- *
- * @param array $config Configuration array
- * @return sspmod_accountLinker_AccountLinker_Store
- */
- protected function _getStore($config)
- {
- if (!$config->getValue('class')) {
- throw new Exception('No store class specified in configuration');
- }
-
- $storeClassName = SimpleSAML_Module::resolveClass(
- $config->getValue('class'),
- 'Admin_Store'
- );
- return new $storeClassName($config->toArray());
- }
-
- public function getAccounts()
- {
- return $this->_store->getAccounts();
- }
-
- /**
- * @todo add parameter so you can clear ONE instance of the search
- *
- */
- public function resetSearch($session)
- {
- unset($_SESSION[$this->_namespace][$session]);
- }
-
- public function searchAccount($type, $value, $session)
- {
- assert('is_string($type)');
-
- $accountIds = null;
-
- if (isset($_SESSION[$this->_namespace][$session])) {
- #foreach ($_SESSION[$this->_namespace] as $k => $v) {
- # $accountIds = array_keys($v);
- #}
- $accountIds = array_keys($_SESSION[$this->_namespace][$session]);
- }
-
- $result = $this->_store->searchAccount($type, $value, $accountIds);
- #$_SESSION[$this->_namespace][$type] = $result;
- $_SESSION[$this->_namespace][$session] = $result;
-
-
- return $result;
- }
-
-}
\ No newline at end of file
diff --git a/lib/Auth/Process/AccountLinker.php b/lib/Auth/Process/AccountLinker.php
deleted file mode 100644
index 91caf68..0000000
--- a/lib/Auth/Process/AccountLinker.php
+++ /dev/null
@@ -1,108 +0,0 @@
-_store = $this->_getStore($config);
-
- $this->_accountIdPrefix = (isset($config['accountIdPrefix']))
- ? $config['accountIdPrefix']
- : 'TAL';
- }
-
- public static function test($state)
- {
- #$config = SimpleSAML_Configuration::getConfig();
- }
-
- /**
- * Get Account Linking Store
- *
- * @param array $config Configuration array
- * @return sspmod_accountLinker_AccountLinker_Store
- */
- protected function _getStore($config)
- {
- if (!array_key_exists('store', $config) || !array_key_exists("class", $config['store'])) {
- throw new Exception('No store class specified in configuration');
- }
-
- $storeConfig = $config['store'];
- $storeClassName = SimpleSAML_Module::resolveClass(
- $storeConfig['class'],
- 'AccountLinker_Store'
- );
- unset($storeConfig['class']);
- return new $storeClassName($storeConfig);
- }
-
- /**
- * Apply filter
- *
- * @param array &$request The current request
- */
- public function process(&$request)
- {
- assert('is_array($request)');
- assert('array_key_exists("Attributes", $request)');
-
- $this->_store->setRequest($request);
-
- SimpleSAML_Logger::stats('AccountLinker: === BEGIN === ');
-
- if ($this->_store->hasEntityId()) {
- SimpleSAML_Logger::stats('AccountLinker: entityid '.$this->_store->getEntityId().' is already known here');
- SimpleSAML_Logger::stats('AccountLinker: SP entityid '.$this->_store->getSpEntityId() );
- if (!$this->_store->matchIdentifiableAttributes()) {
- SimpleSAML_Logger::stats('AccountLinker: no account match found, adding account');
- $this->_store->addAccount();
- $newAccount = true;
- }
- } else {
- SimpleSAML_Logger::stats('AccountLinker: entityid does not exist, adding it');
- $this->_store->addEntityId();
- $this->_store->addIdentifiableAttributes();
- SimpleSAML_Logger::stats('AccountLinker: entityid does not exist, adding account');
- $this->_store->addAccount();
- }
-
- SimpleSAML_Logger::stats('AccountLinker: Inserting attributes');
-
- if ($this->_store->saveAttributes()) {
- $request['Attributes'][$this->_accountIdPrefix.':user_id'] = array(
- $this->_store->saveSpEntityId()
- );
-
- SimpleSAML_Logger::stats('AccountLinker: === END === ');
- }
-
- }
-}
-
-?>
diff --git a/phpcs.xml b/phpcs.xml
new file mode 100644
index 0000000..ed55ecd
--- /dev/null
+++ b/phpcs.xml
@@ -0,0 +1,16 @@
+
+
+
+ By default it is less stringent about long lines than other coding standards
+
+
+ src
+ tests
+
+
+
+
+
+
+
+
diff --git a/phpunit.xml b/phpunit.xml
new file mode 100644
index 0000000..7acc32e
--- /dev/null
+++ b/phpunit.xml
@@ -0,0 +1,20 @@
+
+
+
+
+ ./src
+
+
+
+
+
+
+
+
+
+ ./vendor/simplesamlphp/simplesamlphp-test-framework/src
+ ./tests
+
+
+
+
diff --git a/psalm.xml b/psalm.xml
new file mode 100644
index 0000000..e4189eb
--- /dev/null
+++ b/psalm.xml
@@ -0,0 +1,45 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/src/Auth/Process/AccountLinker.php b/src/Auth/Process/AccountLinker.php
new file mode 100644
index 0000000..344ec8d
--- /dev/null
+++ b/src/Auth/Process/AccountLinker.php
@@ -0,0 +1,110 @@
+store = $this->getStore($config);
+
+ $this->accountIdPrefix = (isset($config['accountIdPrefix']))
+ ? $config['accountIdPrefix'] : 'TAL';
+ }
+
+ /**
+ * Get Account Linking Store
+ *
+ * @param array $config Configuration array
+ * @return \SimpleSAML\Module\accountlinker\Store\SQLStore
+ */
+ protected function getStore(array $config): SQLStore
+ {
+ if (!array_key_exists('store', $config) || !array_key_exists("class", $config['store'])) {
+ throw new Error\Exception('No store class specified in configuration');
+ }
+
+ $storeConfig = $config['store'];
+ $storeClassName = Module::resolveClass($storeConfig['class'], 'Store');
+ unset($storeConfig['class']);
+
+ return new $storeClassName($storeConfig);
+ }
+
+ /**
+ * Apply filter
+ *
+ * @param array &$state The current request
+ */
+ public function process(array &$state): void
+ {
+ Assert::keyExists($state, 'Attributes');
+
+ $this->store->setRequest($state);
+
+ Logger::stats('AccountLinker: === BEGIN === ');
+
+ if ($this->store->hasEntityId()) {
+ Logger::stats('AccountLinker: entityid ' . $this->store->getEntityId() . ' is already known here');
+ Logger::stats('AccountLinker: SP entityid ' . $this->store->getSpEntityId());
+ if (!$this->store->matchIdentifiableAttributes()) {
+ Logger::stats('AccountLinker: no account match found, adding account');
+ $this->store->addAccount();
+ $newAccount = true;
+ }
+ } else {
+ Logger::stats('AccountLinker: entityid does not exist, adding it');
+ $this->store->addEntityId();
+ $this->store->addIdentifiableAttributes();
+ Logger::stats('AccountLinker: entityid does not exist, adding account');
+ $this->store->addAccount();
+ }
+
+ Logger::stats('AccountLinker: Inserting attributes');
+
+ if ($this->store->saveAttributes()) {
+ $state['Attributes'][$this->accountIdPrefix . ':user_id'] = [
+ $this->store->saveSpEntityId()
+ ];
+
+ Logger::stats('AccountLinker: === END ===');
+ }
+ }
+}
diff --git a/lib/AccountLinker/Store/SQLStore.php b/src/Store/SQLStore.php
similarity index 50%
rename from lib/AccountLinker/Store/SQLStore.php
rename to src/Store/SQLStore.php
index 18965bd..4da8a69 100644
--- a/lib/AccountLinker/Store/SQLStore.php
+++ b/src/Store/SQLStore.php
@@ -1,73 +1,96 @@
_accountLinkerConfig = SimpleSAML_Configuration::getConfig('module_accountlinker.php');
- foreach (array('dsn', 'username', 'password') as $param) {
- $config[$param] = $this->_accountLinkerConfig->getString($param, NULL);
- if ($config[$param] === NULL) {
- throw new Exception('AccountLinking - Missing required option \'' . $param . '\'.');
+ $this->accountLinkerConfig = Configuration::getConfig('module_accountlinker.php');
+ foreach (['dsn', 'username', 'password'] as $param) {
+ $config[$param] = $this->accountLinkerConfig->getOptionalString($param, null);
+ if ($config[$param] === null) {
+ throw new Error\Exception('AccountLinking - Missing required option \'' . $param . '\'.');
}
}
- $this->_dsn = $config['dsn'];
- $this->_ehsURL = "https://ds.incommon.org/FEH/sp-error.html";
- $this->_username = $config['username'];
- $this->_password = $config['password'];
+ $this->dsn = $config['dsn'];
+ $this->ehsURL = "https://ds.incommon.org/FEH/sp-error.html";
+ $this->username = $config['username'];
+ $this->password = $config['password'];
}
/**
* Set IdP attributes for the store
- *
*/
- public function setRequest(array $request)
+ public function setRequest(array $request): void
{
if (!array_key_exists('saml:sp:IdP', $request)) {
- throw new Exception('AccountLinking - Missing required attribute saml:sp:IdP');
+ throw new Error\Exception('AccountLinking - Missing required attribute saml:sp:IdP');
}
- $this->_entityId = $request['saml:sp:IdP'];
- $this->_spEntityId = $request['SPMetadata']['entityid'];
- $this->_attributes = $request['Attributes'];
+ $this->entityId = $request['saml:sp:IdP'];
+ $this->spEntityId = $request['SPMetadata']['entityid'];
+ $this->attributes = $request['Attributes'];
}
/**
* Lazy load entityid_id
*
- * @return integer entityid_id
+ * @return false|int|string entityid_id
*/
- protected function _getEntityidId()
+ protected function getEntityidId()
{
- if ($this->_entityidId) {
- return $this->_entityidId;
+ if ($this->entityidId) {
+ return $this->entityidId;
}
- $this->_entityidId = $this->hasEntityId();
- return $this->_entityidId;
+
+ $this->entityidId = $this->hasEntityId();
+ return $this->entityidId;
}
/**
* Check if entity_id exists
*
- * @return value of entity_id or false
+ * @return string|false value of entity_id or false
*/
public function hasEntityId()
{
- $dbh = $this->_getStore();
+ $dbh = $this->getStore();
$stmt = $dbh->prepare("SELECT entityid_id FROM entityids WHERE name=:entity_id");
- $stmt->bindParam(':entity_id', $this->_entityId, PDO::PARAM_INT);
+ $stmt->bindParam(':entity_id', $this->entityId, PDO::PARAM_INT);
$stmt->execute();
- $this->_entityidId = $stmt->fetchColumn();
- return $this->_entityidId;
+ $this->entityidId = $stmt->fetchColumn();
+ return $this->entityidId;
}
- public function getEntityId()
+ public function getEntityId(): string
{
- return $this->_entityId;
+ return $this->entityId;
}
+ /**
+ * @return false|int|string
+ */
public function getSpEntityId()
{
- return $this->_spEntityId;
+ return $this->spEntityId;
}
/**
* Insert entity_id
*
- * @return value of entity_id
+ * @return false|int|string value of entity_id
*/
public function addEntityId()
{
- $dbh = $this->_getStore();
+ $dbh = $this->getStore();
$stmt = $dbh->prepare("INSERT INTO entityids (name, type) VALUES (:entity_id,:type)");
- $stmt->execute(array(
- ':entity_id' => $this->_entityId,
+ $stmt->execute([
+ ':entity_id' => $this->entityId,
':type' => 'idp'
- ));
- return $this->_getEntityidId();
+ ]);
+ return $this->getEntityidId();
}
/**
* Getter for account_id
*
- * @return integer account_id
+ * @return integer|null account_id
*/
- protected function _getAccountId()
+ protected function getAccountId(): ?int
{
- return $this->_accountId;
+ return $this->accountId;
}
/**
* Try to match Identifiable attributes
*
- * @return mixed account_id or false
+ * @return int|false account_id or false
*/
public function matchIdentifiableAttributes()
{
- $dbh = $this->_getStore();
+ $dbh = $this->getStore();
// get identifiable attributes for this entity
$stmt = $dbh->prepare("SELECT ida.attribute_id, ap.name, ap.singlevalue FROM idattributes ida
LEFT JOIN attributeproperties ap ON (ida.attribute_id = ap.attributeproperty_id)
WHERE entity_id=:entity_id ORDER BY ida.aorder");
- $stmt->execute(
- array(':entity_id' => $this->_getEntityidId())
- );
+ $stmt->execute([':entity_id' => $this->getEntityidId()]);
// @note This only deals with single attribute value
// @todo this exception must only show if none of the identifiable attributes are in the metadata
// throw new Exception('AccountLinking - Missing required identifiable attribute '.$row['name']);
//only deal with single values (eg, take first element of array)
- // @todo Check if IDP gives identifiable attributes AT ALL (should be at least one!). Otherwise throw error back to IDP
+ // @todo Check if IDP gives identifiable attributes AT ALL (should be at least one!).
+ // Otherwise throw error back to IDP
$count = 0;
while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {
- SimpleSAML_Logger::stats('AccountLinker: Checking for attribute \''.$row['name'].'\'');
- if (isset($this->_attributes[$row['name']])) {
+ Logger::stats('AccountLinker: Checking for attribute \'' . $row['name'] . '\'');
+ if (isset($this->attributes[$row['name']])) {
$count++;
//$stmt2 = $dbh->prepare("SELECT a.account_id, a.attributeproperty_id
//FROM attributes a WHERE a.value=:attribute_value AND a.attributeproperty_id=:attribute_id");
- $stmt2 = $dbh->prepare("SELECT at.account_id, at.attributeproperty_id FROM attributes at LEFT JOIN accounts ac ON (at.account_id = ac.account_id) WHERE at.value=:attribute_value AND at.attributeproperty_id=:attribute_id AND ac.entityid_id=:entityid_id");
- $stmt2->execute(array(
- ':attribute_value' => $this->_attributes[$row['name']][0],
+ $stmt2 = $dbh->prepare("SELECT at.account_id, at.attributeproperty_id FROM attributes
+ at LEFT JOIN accounts ac ON (at.account_id = ac.account_id) WHERE at.value=:attribute_value
+ AND at.attributeproperty_id=:attribute_id AND ac.entityid_id=:entityid_id");
+ $stmt2->execute([
+ ':attribute_value' => $this->attributes[$row['name']][0],
':attribute_id' => $row['attribute_id'],
- ':entityid_id' => $this->_getEntityidId()
- ));
+ ':entityid_id' => $this->getEntityidId()
+ ]);
$return = $stmt2->fetch(PDO::FETCH_NUM);
if (!empty($return)) {
- $stmt3 = $dbh->prepare("SELECT name FROM attributeproperties WHERE attributeproperty_id=:attribute_id");
- $stmt3->execute(array(':attribute_id' => $return[1]));
+ $stmt3 = $dbh->prepare(
+ "SELECT name FROM attributeproperties WHERE attributeproperty_id=:attribute_id"
+ );
+ $stmt3->execute([':attribute_id' => $return[1]]);
$attribute_name = $stmt3->fetchColumn();
- SimpleSAML_Logger::stats('AccountLinker: Found match on attribute \''.$attribute_name .'\' for account id '. $return[0]);
- $this->_accountId = $return[0];
- return $this->_accountId;
+ Logger::stats(sprintf(
+ 'AccountLinker: Found match on attribute \'%s\' for account id %s',
+ $attribute_name,
+ $return[0],
+ ));
+ $this->accountId = $return[0];
+ return $this->accountId;
}
}
- SimpleSAML_Logger::stats('AccountLinker: Attribute \''.$row['name'].'\' not found in metadata/datastore');
+ Logger::stats('AccountLinker: Attribute \'' . $row['name'] . '\' not found in metadata/datastore');
}
if ($count === 0) {
$error = 'Could not find any of the attributes to determine who you are';
- SimpleSAML_Logger::stats('AccountLinker: EXCEPTION '.$error);
- #throw new Exception('AccountLinking '.$error );
- $this->_handleException();
+ Logger::stats('AccountLinker: EXCEPTION ' . $error);
+ #throw new Exception('AccountLinking ' . $error );
+ $this->handleException();
}
return false;
@@ -239,17 +272,17 @@ public function matchIdentifiableAttributes()
*
* @todo the RETURNING clause only works in PGSQL - add driver testing to add driver specific code
*/
- public function addAccount()
+ public function addAccount(): void
{
- $dbh = $this->_getStore();
+ $dbh = $this->getStore();
$stmt = $dbh->prepare("INSERT INTO accounts (account_id, user_id, entityid_id, priority)
SELECT max(account_id)+1, max(account_id)+1, :entity_id, 1 FROM accounts RETURNING account_id");
- $stmt->execute(array(
- ':entity_id' => $this->_getEntityidId()
- ));
+ $stmt->execute([
+ ':entity_id' => $this->getEntityidId()
+ ]);
$result = $stmt->fetch(PDO::FETCH_ASSOC);
- $this->_accountId = $result['account_id'];
- $this->_newAccount = true;
+ $this->accountId = $result['account_id'];
+ $this->newAccount = true;
}
/**
@@ -264,38 +297,38 @@ public function addAccount()
* @note the approach for inserting attribute properties could be prone to race conditions.
*
*/
- public function saveAttributes()
+ public function saveAttributes(): bool
{
- if (!$this->_getAccountId()) {
- throw new Exception("Can't save attributes, no account_id found");
+ if (!$this->getAccountId()) {
+ throw new Error\Exception("Can't save attributes, no account_id found");
}
// init dbh
- $dbh = $this->_getStore();
+ $dbh = $this->getStore();
$dbh->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
// define variables
$metadataAttributeString = null;
- $insertValues = $updateValues = array();
- $metadataAttributes = $this->_attributes;
+ $insertValues = $updateValues = [];
+ $metadataAttributes = $this->attributes;
// get stored attributes for this account
$stmt = $dbh->prepare("SELECT ap.name, a.value
FROM attributes a LEFT JOIN attributeproperties ap ON
(ap.attributeproperty_id = a.attributeproperty_id)
WHERE a.account_id=:account_id");
- $stmt->execute(array(
- ':account_id' => $this->_getAccountId()
- ));
- $storedAttributes = $stmt->fetchAll(PDO::FETCH_COLUMN|PDO::FETCH_GROUP);
+ $stmt->execute([
+ ':account_id' => $this->getAccountId()
+ ]);
+ $storedAttributes = $stmt->fetchAll(PDO::FETCH_COLUMN | PDO::FETCH_GROUP);
// Store Attribute Properties
// get stored attributes that are also metadata attributes
foreach ($metadataAttributes as $metadataAttribute => $value) {
- $metadataAttributeString .= $dbh->quote($metadataAttribute).",";
+ $metadataAttributeString .= $dbh->quote($metadataAttribute) . ",";
}
$metadataAttributeString = rtrim($metadataAttributeString, ',');
- $stmt = $dbh->prepare("SELECT name FROM attributeproperties WHERE name IN (".$metadataAttributeString.")");
+ $stmt = $dbh->prepare("SELECT name FROM attributeproperties WHERE name IN (" . $metadataAttributeString . ")");
$stmt->execute();
$return = $stmt->fetchAll(PDO::FETCH_COLUMN);
$diff = array_diff(array_keys($metadataAttributes), $return);
@@ -303,17 +336,20 @@ public function saveAttributes()
if (!empty($diff)) {
$stmt = $dbh->prepare("INSERT INTO attributeproperties (name) VALUES (:attribute)");
foreach ($diff as $key => $val) {
- $stmt->execute(array(':attribute' => $val));
+ $stmt->execute([':attribute' => $val]);
}
}
// Map attribute property Ids
// get stored attributes that are also metadata attributes (including newly inserted ones)
- $stmt = $dbh->prepare("SELECT attributeproperty_id, name FROM attributeproperties WHERE name IN (".$metadataAttributeString.")");
+ $stmt = $dbh->prepare(sprintf(
+ "SELECT attributeproperty_id, name FROM attributeproperties WHERE name IN (%s)",
+ $metadataAttributeString,
+ ));
$stmt->execute();
// used for debugging only
- $attributeMapping = array();
+ $attributeMapping = [];
while ($row = $stmt->fetch(PDO::FETCH_NUM)) {
$insertValues[$row[0]] = $metadataAttributes[$row[1]];
@@ -324,26 +360,34 @@ public function saveAttributes()
$dbh->beginTransaction();
// delete attributes
$stmt = $dbh->prepare("DELETE FROM attributes WHERE account_id=:account_id");
- $stmt->execute(array(
- ':account_id' => $this->_getAccountId()
- ));
+ $stmt->execute([
+ ':account_id' => $this->getAccountId()
+ ]);
// insert attributes
$query = "INSERT INTO attributes (account_id, attributeproperty_id, value) VALUES ";
- $accountId = $this->_getAccountId();
+ $accountId = $this->getAccountId();
foreach ($insertValues as $attributePropertyId => $value) {
if (count($value) === 1) {
- SimpleSAML_Logger::stats('AccountLinker: Inserting '.$attributeMapping[$attributePropertyId].' => \''.$value[0] . '\'');
- $query .= "(".$accountId.","
- .$attributePropertyId.","
- .$dbh->quote($value[0])."),";
+ Logger::stats(sprintf(
+ 'AccountLinker: Inserting %s => \'%s\'',
+ $attributeMapping[$attributePropertyId],
+ $value[0],
+ ));
+ $query .= "(" . $accountId . ","
+ . $attributePropertyId . ","
+ . $dbh->quote($value[0]) . "),";
} else {
// multivalue attribute
foreach ($value as $val) {
- SimpleSAML_Logger::stats('AccountLinker: Inserting '.$attributeMapping[$attributePropertyId].' => \''.$val.'\'');
- $query .= "(".$accountId.","
- .$attributePropertyId.","
- .$dbh->quote($val)."),";
+ Logger::stats(sprintf(
+ 'AccountLinker: Inserting %s => \'%s\'',
+ $attributeMapping[$attributePropertyId],
+ $val,
+ ));
+ $query .= "(" . $accountId . ","
+ . $attributePropertyId . ","
+ . $dbh->quote($val) . "),";
}
}
}
@@ -355,7 +399,7 @@ public function saveAttributes()
$dbh->commit();
} catch (Exception $e) {
$dbh->rollBack();
- throw new Exception('Failed to insert attributes');
+ throw new Error\Exception('Failed to insert attributes');
}
return true;
@@ -364,18 +408,18 @@ public function saveAttributes()
/**
* Getter for user_id
*
- * @return integer user_id
+ * @return integer user_id
*/
- public function getUserId()
+ public function getUserId(): int
{
- if (!$this->_getAccountId()) {
- throw new Exception('Can\'t get user_id, no account_id found');
+ if (!$this->getAccountId()) {
+ throw new Error\Exception('Can\'t get user_id, no account_id found');
}
- $dbh = $this->_getStore();
+ $dbh = $this->getStore();
$stmt = $dbh->prepare("SELECT user_id FROM accounts WHERE account_id=:account_id");
- $stmt->execute(array(
- ':account_id' => $this->_getAccountId()
- ));
+ $stmt->execute([
+ ':account_id' => $this->getAccountId()
+ ]);
$result = $stmt->fetch(PDO::FETCH_ASSOC);
return $result['user_id'];
}
@@ -383,12 +427,12 @@ public function getUserId()
/**
* Store sp entityid
*
- * @return integer user_id
+ * @return integer user_id
*/
- public function saveSpEntityId()
+ public function saveSpEntityId(): int
{
$userId = $this->getUserId();
- $dbh = $this->_getStore();
+ $dbh = $this->getStore();
$stmt = $dbh->prepare("INSERT INTO users_spentityids (
user_id,
account_id,
@@ -406,13 +450,13 @@ public function saveSpEntityId()
$stmt->execute(array(
':user_id' => $userId,
':idp_entityid' => $this->getEntityId(),
- ':account_id' => $this->_getAccountId(),
- ':spentityid' => $this->_spEntityId,
+ ':account_id' => $this->getAccountId(),
+ ':spentityid' => $this->spEntityId,
':ip_addr' => $_SERVER['REMOTE_ADDR'] ?? '::1',
':user_agent' => $_SERVER['HTTP_USER_AGENT'] ?? ''
));
- SimpleSAML_Logger::stats('AccountLinker: Returning user_id '.$userId);
+ Logger::stats('AccountLinker: Returning user_id ' . $userId);
return $userId;
}
@@ -420,45 +464,47 @@ public function saveSpEntityId()
/**
* Set default values for identifiable attributes
- *
*/
- public function addIdentifiableAttributes()
+ public function addIdentifiableAttributes(): self
{
- SimpleSAML_Logger::stats('AccountLinker: adding default id attributes for entityid_id: '. $this->_getEntityidId());
- $dbh = $this->_getStore();
- $stmt = $dbh->prepare("INSERT INTO idattributes (attribute_id, entity_id, aorder) VALUES (:attribute_id,:entity_id, :aorder)");
- $stmt->execute(array(
+ Logger::stats('AccountLinker: adding default id attributes for entityid_id: ' . $this->getEntityidId());
+ $dbh = $this->getStore();
+ $stmt = $dbh->prepare(
+ "INSERT INTO idattributes (attribute_id, entity_id, aorder) VALUES (:attribute_id,:entity_id, :aorder)"
+ );
+ $stmt->execute([
':attribute_id' => 1,
- ':entity_id' => $this->_getEntityidId(),
+ ':entity_id' => $this->getEntityidId(),
':aorder' => 1
- ));
- $stmt->execute(array(
+ ]);
+ $stmt->execute([
':attribute_id' => 2,
- ':entity_id' => $this->_getEntityidId(),
+ ':entity_id' => $this->getEntityidId(),
':aorder' => 2
- ));
- $stmt->execute(array(
+ ]);
+ $stmt->execute([
':attribute_id' => 81,
- ':entity_id' => $this->_getEntityidId(),
+ ':entity_id' => $this->getEntityidId(),
':aorder' => 3
- ));
- $stmt->execute(array(
+ ]);
+ $stmt->execute([
':attribute_id' => 259,
- ':entity_id' => $this->_getEntityidId(),
+ ':entity_id' => $this->getEntityidId(),
':aorder' => 4
- ));
+ ]);
return $this;
}
- private function _handleException()
+ private function handleException(): void
{
- $data = array(
- 'sp_entityID' => $this->_spEntityId,
+ $data = [
+ 'sp_entityID' => $this->spEntityId,
'idp_entityID' => $this->getEntityId()
- );
- $queryString = $this->_ehsURL.'?'.http_build_query($data);
- SimpleSAML_Logger::stats('TAL EHS:'.$queryString);
- SimpleSAML_Utilities::redirect($queryString);
+ ];
+ $queryString = $this->ehsURL . '?' . http_build_query($data);
+ Logger::stats('TAL EHS:' . $queryString);
+ $httpUtils = new Utils\HTTP();
+ $httpUtils->redirectTrustedURL($queryString);
}
@@ -467,18 +513,17 @@ private function _handleException()
*
* @return mixed PDO Database handle, or false
*/
- private function _getStore()
+ private function getStore()
{
- if (null !== $this->_store) {
- return $this->_store;
+ if (false !== $this->store) {
+ return $this->store;
}
+
try {
- $this->_store = new PDO($this->_dsn, $this->_username, $this->_password);
+ $this->store = new PDO($this->dsn, $this->username, $this->password);
} catch (PDOException $e) {
- throw new Exception('could not connect to database');
+ throw new Error\Exception('could not connect to database');
}
- return $this->_store;
+ return $this->store;
}
}
-
-?>
diff --git a/templates/admin.tpl.php b/templates/admin.tpl.php
deleted file mode 100644
index 893a8a4..0000000
--- a/templates/admin.tpl.php
+++ /dev/null
@@ -1,88 +0,0 @@
-
-
-
-
- TAL Admin
-
-
-';
-echo '
-
-';
-
-// todo: add option loading here by echoing out javascript, same as in discojuice module
-echo '
-';
-?>
-
-
-
-
-
Account admin
-
-
Legacy smart_id importer
-
-
-
-
-
-includeAtTemplateBase('includes/footer.php');
-?>
\ No newline at end of file
diff --git a/templates/linkerform.php b/templates/linkerform.php
deleted file mode 100644
index 953b2d1..0000000
--- a/templates/linkerform.php
+++ /dev/null
@@ -1,22 +0,0 @@
-includeAtTemplateBase('includes/header.php');
-?>
-
Hey there #accountId; ?> (idp; ?>)
-
Would you like to link your account?
-
-
-includeAtTemplateBase('includes/footer.php');
-?>
\ No newline at end of file
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
new file mode 100644
index 0000000..41f8f33
--- /dev/null
+++ b/tests/bootstrap.php
@@ -0,0 +1,13 @@
+getValue('logfile', '/var/simplesamlphp.log');
-
-$accountAdmin = new sspmod_accountLinker_Admin_admin($adminConfig);
-
-$tpl = new SimpleSAML_XHTML_Template($config, 'accountLinker:admin.tpl.php');
-$tpl->accounts = $accountAdmin->getAccounts();
-$tpl->show();
-?>
\ No newline at end of file
diff --git a/www/resources/admin.js b/www/resources/admin.js
deleted file mode 100644
index dbf2152..0000000
--- a/www/resources/admin.js
+++ /dev/null
@@ -1,152 +0,0 @@
-// Making sure that console.log does not throw errors on Firefox + IE etc.
-if (typeof console == "undefined") var console = { log: function() {} };
-
-if (typeof AccountLinker == "undefined") var AccountLinker = {};
-
-AccountLinker.Control = {
-
- "url" : "https://login.terena.org/wayf/module.php/accountLinker/search.php",
-
- "searchboxInit" : function() {
- var that = this;
- $("form.searchform input").change(function(e){
- that.load(e.target);
- });
- $("form.searchform a.reset").click(function(e){
- e.preventDefault();
- that.reset(e.target);
- });
-
- },
-
- "reset": function(elm) {
- var that = this;
- var formElm = $(elm).parent().parent().parent();
-
- $.ajax({
- url: that.url,
- data: {"reset": true, "session":formElm.attr('id')},
- success: function(){
- that.resetFormFields(formElm);
- formElm.next().empty();
- }
- });
-
- },
-
- "load": function(elm) {
- var that = this;
- var elmId = $(elm).parent().parent().attr('id');
-
- //var url = this.parent.Utils.options.get('url');
- var parameters = {
- "type": elm.name,
- "val": elm.value,
- "session": elmId
- };
-
- $.getJSON(that.url, parameters, function(data) {
- that.data = data;
- that.postLoad(elm, (elmId != 'c')?false:true);
- });
- },
-
- "postLoad": function(elm, search) {
- var that = this;
- if (!this.data) return;
-
- //number of hits
- //Object.keys(this.data).length
-
- var items = [];
- items.push('