php-extended/php-blocklist-catalog-builder

A library to construct the blocklist catalog based on multiple block lists

7.0.2 2024-04-08 19:23 UTC

Requires

• php: >=8.0
• php-extended/php-basic-console-logger: ^7
• php-extended/php-http-client-factory-object: ^7
• php-extended/php-tld-provider-mozilla: ^7

Requires (Dev)

• php-extended/placeholder-phpunit: ^9

MIT

• Anastaszor

• php
• catalog
• builder
• blocklist

README

A library to construct the blocklist catalog based on multiple block lists.

Last Updated Date : 2020-06-20

Installation

The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.

• Download composer.phar from their website.
• Then run the following command to install this library as dependency :
• php composer.phar php-extended/php-blocklist-catalog-builder ^7

Basic Usage

You may use this library the following way :

use PhpExtended\Blocklist\BlocklistCatalog;

/* @var $uri \Psr\Http\Message\UriInterface */
$catalog = new BlocklistCatalog();
$result = $catalog->isUriAllowed($uri);
if(!$result->isBlocked())
{
	// do something when the domain is blocked
}

License

The php code of the library is under MIT (See license file).

The lists that are given in this catalog are derived from the following lists :

• AdAway default blocklist
  • Contributions by Kicelo, Dominik Schuermann and contributors
  • LICENSE CC Attribution 3.0

• AdGuard Simplified Domain Names filter

  • Ad Guard Team
  • LICENSE GNU General Public License v3.0

• Coinhive Block lists

  • coinhive-block contributors
  • LICENSE MIT

• CoinBlockerLists

  • CoinBlockerLists contributors
  • LICENSE GNU AFFERO GENERAL PUBLIC LICENSE V3