jenkins-bot has submitted this change and it was merged.
Change subject: Initial commit.
......................................................................
Initial commit.
Initial commit of a PHP implementation of the Aho-Corasick string matching
algorithm, packaged for distribution as a standalone library. The motivation
behind this work is the desire to replace FastStringSearch with a pure-PHP
implementation with comparable performance and without the licensing issues
which encumber FastStringSearch.
The Aho-Corasick string matching algorithm is an efficient algorithm for
locating occurrences of multiple search keywords in a body of text. The time
it takes to construct the finite state machine is proportional to the sum of
the lengths of the search keywords. Once constructed, the machine can locate
all occurences of all search keywords in a body of text in a single pass.
The library is made up of three classes:
* MultiStringMatcher: the base implementation.
* DeterministicMultiStringMatcher: a variant implementation which uses a
deterministic finite automaton, as described in section 6 of the Aho-Corasick
paper ("Eliminating failure transitions"). This variant computes all possible
state transitions in advance, which then allows the automaton to make exactly
one state transition per input character. The cost is having to do more work
up-front.
* MultiStringReplacer: The MultiStringReplacer class extends
MultiStringMatcher, adding search-and-replace capabilities with an interface
similar to strtr() (when invoked with an array argument).
[1]: http://cr.yp.to/bib/1975/aho.pdf
Change-Id: I583e1c2f619fa2b3992ac0909164d8a1fe8dc4d2
---
A .gitattributes
A .gitignore
A .travis.yml
A LICENSE
A NOTICE
A README.md
A composer.json
A phpcs.xml
A phpunit.xml.dist
A src/DeterministicMultiStringMatcher.php
A src/MultiStringMatcher.php
A src/MultiStringReplacer.php
A tests/AhoCorasickTest.php
13 files changed, 943 insertions(+), 0 deletions(-)
Approvals:
Ori.livneh: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..6223ec7
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,8 @@
+.gitattributes export-ignore
+.gitignore export-ignore
+.gitreview export-ignore
+Doxyfile export-ignore
+composer.json export-ignore
+doc export-ignore
+phpunit.xml.dist export-ignore
+test export-ignore
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..f6f384e
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+/coverage
+/doc/html
+vendor/
+composer.lock
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..3d4019f
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,13 @@
+language: php
+php:
+ - "5.3.3"
+ - "5.3"
+ - "5.4"
+ - "5.5"
+ - "5.6"
+ - "hhvm"
+sudo: false
+install:
+ - composer install
+script:
+ - composer test
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..344d627
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,2 @@
+AhoCorasick PHP Library
+Copyright 2015 Ori Livneh <[email protected]>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0679d10
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+AhoCorasick
+===========
+
+AhoCorasick is a PHP implementation of the [Aho-Corasick][1] string search
+algorithm, which is an efficient way of searching a body of text for multiple
+search keywords.
+
+Here is how you use it:
+
+```php
+use AhoCorasick\MultiStringMatcher;
+
+$keywords = new MultiStringMatcher( array( 'ore', 'hell' ) );
+
+$keywords->searchIn( 'She sells sea shells by the sea shore.' );
+// Result: array( array( 15, 'hell' ), array( 34, 'ore' ) )
+
+$keywords->searchIn( 'Say hello to more text. MultiStringMatcher objects are
reusable!' );
+// Result: array( array( 4, 'hell' ), array( 14, 'ore' ) )
+
+```
+
+
+Features
+--------
+
+The algorithm works by constructing a finite-state machine out of the set of
+search keywords. The time it takes to construct the finite state machine is
+proportional to the sum of the lengths of the search keywords. Once
+constructed, the machine can locate all occurences of all search keywords in
+any body of text in a single pass, making exactly one state transition per
+input character.
+
+
+Contribute
+----------
+
+- Issue Tracker: https://phabricator.wikimedia.org/project/view/1295/
+- Source Code: https://github.com/wikimedia/AhoCorasick
+
+
+Support
+-------
+
+If you are having issues, [please let us know][2].
+
+
+License
+-------
+
+The project is licensed under the Apache license.
+
+
+
+[1]:
https://en.wikipedia.org/wiki/Aho%E2%80%93Corasick_string_matching_algorithm
+[2]:
https://phabricator.wikimedia.org/maniphest/task/create/?projects=PHID-PROJ-hs5ausnvlfs4e3n5gmzg
diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000..36459e9
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,30 @@
+{
+ "name": "wikimedia/aho-corasick",
+ "description": "An implementation of the Aho-Corasick string matching
algorithm.",
+ "license": "Apache-2.0",
+ "homepage": "https://www.mediawiki.org/wiki/AhoCorasick";,
+ "authors": [
+ {
+ "name": "Ori Livneh",
+ "email": "[email protected]"
+ }
+ ],
+ "autoload": {
+ "classmap": ["src/"]
+ },
+ "require": {
+ "php": ">=5.3.3"
+ },
+ "require-dev": {
+ "jakub-onderka/php-parallel-lint": "0.8.*",
+ "phpunit/phpunit": "4.6.*",
+ "mediawiki/mediawiki-codesniffer": "0.2.0"
+ },
+ "scripts": {
+ "test": [
+ "parallel-lint . --exclude vendor",
+ "phpunit $PHPUNIT_ARGS",
+ "phpcs -p"
+ ]
+ }
+}
diff --git a/phpcs.xml b/phpcs.xml
new file mode 100644
index 0000000..957e56c
--- /dev/null
+++ b/phpcs.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<ruleset name="AhoCorasick">
+ <rule ref="vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
+ <file>.</file>
+ <exclude-pattern>coverage</exclude-pattern>
+ <exclude-pattern>vendor</exclude-pattern>
+ <exclude-pattern>doc/html</exclude-pattern>
+</ruleset>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
new file mode 100644
index 0000000..a0d81b2
--- /dev/null
+++ b/phpunit.xml.dist
@@ -0,0 +1,14 @@
+<phpunit colors="true"
+ beStrictAboutTestsThatDoNotTestAnything="true"
+ beStrictAboutOutputDuringTests="true">
+ <testsuites>
+ <testsuite name="AhoCorasick Tests">
+ <directory>./tests</directory>
+ </testsuite>
+ </testsuites>
+ <filter>
+ <whitelist addUncoveredFilesFromWhitelist="true">
+ <directory suffix=".php">./src</directory>
+ </whitelist>
+ </filter>
+</phpunit>
diff --git a/src/DeterministicMultiStringMatcher.php
b/src/DeterministicMultiStringMatcher.php
new file mode 100644
index 0000000..922db6a
--- /dev/null
+++ b/src/DeterministicMultiStringMatcher.php
@@ -0,0 +1,88 @@
+<?php
+/**
+ * AhoCorasick PHP Library
+ *
+ * Copyright (C) 2015 Ori Livneh <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @file
+ * @author Ori Livneh <[email protected]>
+ */
+
+namespace AhoCorasick;
+
+use AhoCorasick\MultiStringMatcher;
+
+/**
+ * Represents a variant of the Aho-Corasick string matching algorithm
+ * which uses a deterministic finite automaton.
+ *
+ * The time it takes to construct the finite state machine is
+ * proportional to the sum of the lengths of the search keywords.
+ * Once constructed, the machine can locate all occurences of all
+ * search keywords in a body of text in a single pass, making exactly
+ * one state transition per input character.
+ */
+class DeterministicMultiStringMatcher extends MultiStringMatcher {
+
+ /** @var array[] Mapping of all possible state transitions. **/
+ protected $stateMachine = null;
+
+ /**
+ * Constructor.
+ *
+ * @param string[] $searchKeywords The set of keywords to be matched.
+ */
+ public function __construct( array $searchKeywords ) {
+ parent::__construct( $searchKeywords );
+ $this->computeFiniteStateMachine();
+ }
+
+
+ /**
+ * Map the current state and input character to the next state.
+ *
+ * @param int $currentState The current state of the string-matching
+ * automaton.
+ * @param string $inputChar The character the string-matching
+ * automaton is currently processing.
+ * @return int The state the automaton should transition to.
+ */
+ public function nextState( $state, $ch ) {
+ return isset( $this->stateMachine[$state][$ch] ) ?
+ $this->stateMachine[$state][$ch] : 0;
+ }
+
+ /**
+ * Construct the string-matching finite state machine.
+ *
+ * The machine will make one state transition per input symbol.
+ */
+ protected function computeFiniteStateMachine() {
+ for ( $r = 0; $r < $this->numStates; $r++ ) {
+ foreach ( $this->searchChars as $ch ) {
+ $state = $r;
+ while ( $state !== 0 && !isset(
$this->yesTransitions[$state][$ch] ) ) {
+ $state = $this->noTransitions[$state];
+ }
+ if ( isset( $this->yesTransitions[$state][$ch]
) ) {
+ $this->stateMachine[$r][$ch] =
$this->yesTransitions[$state][$ch];
+ } else {
+ $this->stateMachine[$r][$ch] = isset(
$this->noTransitions[$state] )
+ ? $this->noTransitions[$state]
: 0;
+ }
+ }
+ }
+ }
+}
diff --git a/src/MultiStringMatcher.php b/src/MultiStringMatcher.php
new file mode 100644
index 0000000..2083a97
--- /dev/null
+++ b/src/MultiStringMatcher.php
@@ -0,0 +1,240 @@
+<?php
+/**
+ * AhoCorasick PHP Library
+ *
+ * A PHP implementation of the Aho-Corasick string matching algorithm.
+ *
+ * Alfred V. Aho and Margaret J. Corasick, "Efficient string matching:
+ * an aid to bibliographic search", CACM, 18(6):333-340, June 1975.
+ *
+ * @link http://xlinux.nist.gov/dads//HTML/ahoCorasick.html
+ * @link https://en.wikipedia.org/wiki/Aho-Corasick_string_matching_algorithm
+ *
+ * Copyright (C) 2015 Ori Livneh <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @file
+ * @author Ori Livneh <[email protected]>
+ */
+
+namespace AhoCorasick;
+
+/**
+ * Represents a finite state machine that can find all occurrences
+ * of a set of search keywords in a body of text.
+ *
+ * The time it takes to construct the finite state machine is
+ * proportional to the sum of the lengths of the search keywords.
+ * Once constructed, the machine can locate all occurences of all
+ * search keywords in a body of text in a single pass, making exactly
+ * one state transition per input character.
+ *
+ * This is an implementation of the Aho-Corasick string matching
+ * algorithm.
+ *
+ * Alfred V. Aho and Margaret J. Corasick, "Efficient string matching:
+ * an aid to bibliographic search", CACM, 18(6):333-340, June 1975.
+ *
+ * @link http://xlinux.nist.gov/dads//HTML/ahoCorasick.html
+ *
+ * @param string $text The input string.
+ * @param array $keywords An array of strings to search for.
+ * @return array[] An array of (offset, substring) arrays.
+ */
+class MultiStringMatcher {
+
+ /** @var string[] The set of keywords to be searched for. **/
+ protected $searchKeywords = array();
+
+ /** @var array The set of unique characters that appear in the search
keywords. **/
+ protected $searchChars = array();
+
+ /** @var int The number of possible states of the string-matching
finite state machine. **/
+ protected $numStates = 1;
+
+ /** @var array Mapping of states to outputs. **/
+ protected $outputs = array();
+
+ protected $noTransitions = array();
+
+ protected $yesTransitions = array();
+
+
+ /**
+ * Constructor.
+ *
+ * @param string[] $searchKeywords The set of keywords to be matched.
+ */
+ public function __construct( array $searchKeywords ) {
+ foreach ( $searchKeywords as $keyword ) {
+ if ( $keyword !== '' && !in_array( $keyword,
$this->searchKeywords ) ) {
+ $this->searchKeywords[] = $keyword;
+ }
+ }
+
+ if ( !$this->searchKeywords ) {
+ trigger_error( __METHOD__ . ': The set of search
keywords is empty.', E_USER_WARNING );
+ return;
+ }
+
+ $this->computeSuccessTransitions();
+ $this->computeFailTransitions();
+ }
+
+
+ /**
+ * Accessor for the search keywords.
+ *
+ * @return string[] Search keywords.
+ */
+ public function getKeywords() {
+ return $this->searchKeywords;
+ }
+
+
+ /**
+ * Map the current state and input character to the next state.
+ *
+ * @param int $currentState The current state of the string-matching
+ * automaton.
+ * @param string $inputChar The character the string-matching
+ * automaton is currently processing.
+ * @return int The state the automaton should transition to.
+ */
+ public function nextState( $currentState, $inputChar ) {
+ while (
+ $currentState !== 0 &&
+ !isset(
$this->yesTransitions[$currentState][$inputChar] )
+ ) {
+ $currentState = $this->noTransitions[$currentState];
+ }
+ return isset( $this->yesTransitions[$currentState][$inputChar]
) ?
+ $this->yesTransitions[$currentState][$inputChar] : 0;
+ }
+
+
+ /**
+ * Locate the search keywords in some text.
+ *
+ * @param string $text The string to search in.
+ * @return array[] An array of matches. Each match is a vector
+ * containing an integer offset and the matched keyword.
+ *
+ * @par Example:
+ * @code
+ * $keywords = new MultiStringMatcher( array( 'ore', 'hell' ) );
+ * $keywords->searchIn( 'She sells sea shells by the sea shore.' );
+ * // result: array( array( 15, 'hell' ), array( 34, 'ore' ) )
+ * @endcode
+ */
+ public function searchIn( $text ) {
+ if ( !$this->searchKeywords || $text === '' ) {
+ return array(); // fast path
+ }
+
+ $state = 0;
+ $results = array();
+ $length = mb_strlen( $text );
+
+ for ( $i = 0; $i < $length; $i++ ) {
+ $ch = mb_substr( $text, $i, 1 );
+ $state = $this->nextState( $state, $ch );
+ if ( !empty( $this->outputs[$state] ) ) {
+ foreach ( $this->outputs[$state] as $match ) {
+ $offset = $i - mb_strlen( $match ) + 1;
+ $results[] = array( $offset, $match );
+ }
+ }
+ }
+
+ return $results;
+ }
+
+
+ /**
+ * Get the state transitions which the string-matching automaton
+ * shall make as it advances through input text.
+ *
+ * Constructs a directed tree with a root node which represents the
+ * initial state of the string-matching automaton and from which a
+ * path exists which spells out each search keyword.
+ *
+ * @return array[]
+ */
+ protected function computeSuccessTransitions() {
+ foreach ( $this->searchKeywords as $keyword ) {
+ $state = 0;
+ $length = mb_strlen( $keyword );
+
+ for ( $i = 0; $i < $length; $i++ ) {
+ $ch = mb_substr( $keyword, $i, 1 );
+ if ( !in_array( $ch, $this->searchChars ) ) {
+ $this->searchChars[] = $ch;
+ }
+ if ( !empty( $this->yesTransitions[$state][$ch]
) ) {
+ $state =
$this->yesTransitions[$state][$ch];
+ } else {
+ $this->yesTransitions[$state][$ch] =
$this->numStates;
+ $state = $this->numStates++;
+ }
+ }
+
+ $this->outputs[$state][] = $keyword;
+ }
+ }
+
+
+ /**
+ * Get the state transitions which the string-matching automaton
+ * shall make when a partial match proves false.
+ *
+ * @param array[] $this->yesTransitions The array created by
+ * MultiStringMatcher::computeSuccessTransitions.
+ * @return array[]
+ */
+ protected function computeFailTransitions() {
+ $queue = array();
+ foreach ( $this->yesTransitions[0] as $ch => $toState ) {
+ if ( $toState !== 0 ) {
+ $queue[] = $toState;
+ $this->noTransitions[$toState] = 0;
+ }
+ }
+
+ while ( ( $r = array_shift( $queue ) ) !== null ) {
+ if ( empty( $this->yesTransitions[$r] ) ) {
+ continue;
+ }
+ foreach ( $this->yesTransitions[$r] as $ch => $toState
) {
+ $queue[] = $toState;
+ $state = $this->noTransitions[$r];
+
+ while ( $state !== 0 && empty(
$this->yesTransitions[$state][$ch] ) ) {
+ $state = $this->noTransitions[$state];
+ }
+
+ $failState = isset(
$this->yesTransitions[$state][$ch] ) ?
+ $this->yesTransitions[$state][$ch] : 0;
+ $this->noTransitions[$toState] = $failState;
+ if ( isset( $this->outputs[$failState] ) ) {
+ $this->outputs[$toState] = empty(
$this->outputs[$toState] )
+ ? $this->outputs[$failState]
+ : array_merge(
$this->outputs[$toState], $this->outputs[$failState] );
+ }
+ }
+ }
+
+ return $this->noTransitions;
+ }
+}
diff --git a/src/MultiStringReplacer.php b/src/MultiStringReplacer.php
new file mode 100644
index 0000000..184d1b9
--- /dev/null
+++ b/src/MultiStringReplacer.php
@@ -0,0 +1,102 @@
+<?php
+/**
+ * AhoCorasick PHP Library
+ *
+ * A PHP implementation of the Aho-Corasick string matching algorithm.
+ *
+ * Alfred V. Aho and Margaret J. Corasick, "Efficient string matching:
+ * an aid to bibliographic search", CACM, 18(6):333-340, June 1975.
+ *
+ * @link http://xlinux.nist.gov/dads//HTML/ahoCorasick.html
+ * @link https://en.wikipedia.org/wiki/Aho-Corasick_string_matching_algorithm
+ *
+ * Copyright (C) 2015 Ori Livneh <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @file
+ * @author Ori Livneh <[email protected]>
+ */
+
+namespace AhoCorasick;
+
+use AhoCorasick\MultiStringMatcher;
+
+/**
+ * This class extends MultiStringMatcher, adding search and replace
+ * functionality.
+ */
+class MultiStringReplacer extends MultiStringMatcher {
+
+
+ /** @var array Mapping of states to outputs. **/
+ protected $replacePairs = array();
+
+
+ /**
+ * Constructor.
+ *
+ * @param array $replacePairs array of ( 'from' => 'to' ) replacement
pairs.
+ */
+ public function __construct( array $replacePairs ) {
+ foreach ( $replacePairs as $keyword => $replacement ) {
+ if ( $keyword !== '' ) {
+ $this->replacePairs[$keyword] = $replacement;
+ }
+ }
+ parent::__construct( array_keys( $this->replacePairs ) );
+ }
+
+
+ /**
+ * Search and replace a set of keywords in some text.
+ *
+ * @param string $text The string to search in.
+ * @return string The input text with replacements.
+ *
+ * @par Example:
+ * @code
+ * $replacer = new MultiStringReplacer( array( 'csh' => 'sea shells'
) );
+ * $replacer->searchAndReplace( 'She sells csh by the sea shore.' );
+ * // result: 'She sells sea shells by the sea shore.'
+ * @endcode
+ */
+ public function searchAndReplace( $text ) {
+ if ( !$this->searchKeywords || $text === '' ) {
+ return $text;
+ }
+
+ $matches = array();
+ foreach ( $this->searchIn( $text ) as $result ) {
+ list( $offset, $match ) = $result;
+ if ( !isset( $matches[$offset] ) ||
+ mb_strlen( $match ) > mb_strlen(
$matches[$offset] ) ) {
+ $matches[$offset] = $match;
+ }
+ }
+ ksort( $matches );
+
+ $buf = '';
+ $lastInsert = 0;
+ foreach ( $matches as $offset => $match ) {
+ if ( $offset >= $lastInsert ) {
+ $buf .= mb_substr( $text, $lastInsert, $offset
- $lastInsert );
+ $buf .= $this->replacePairs[$match];
+ $lastInsert = $offset + mb_strlen( $match );
+ }
+ }
+ $buf .= mb_substr( $text, $lastInsert );
+
+ return $buf;
+ }
+}
diff --git a/tests/AhoCorasickTest.php b/tests/AhoCorasickTest.php
new file mode 100644
index 0000000..0907b88
--- /dev/null
+++ b/tests/AhoCorasickTest.php
@@ -0,0 +1,176 @@
+<?php
+/**
+ * AhoCorasick PHP Library
+ *
+ * A PHP implementation of the Aho-Corasick string matching algorithm.
+ *
+ * Alfred V. Aho and Margaret J. Corasick, "Efficient string matching:
+ * an aid to bibliographic search", CACM, 18(6):333-340, June 1975.
+ *
+ * @link http://xlinux.nist.gov/dads//HTML/ahoCorasick.html
+ * @link https://en.wikipedia.org/wiki/Aho-Corasick_string_matching_algorithm
+ *
+ * Copyright (C) 2015 Ori Livneh <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @file
+ * @author Ori Livneh <[email protected]>
+ */
+
+namespace AhoCorasick\Test;
+
+use AhoCorasick\MultiStringMatcher;
+use AhoCorasick\DeterministicMultiStringMatcher;
+use AhoCorasick\MultiStringReplacer;
+
+/**
+ * A multiple-substring search using a naive algorithm.
+ * (Iterate through the entire body of input text for each search keyword.)
+ */
+class NaiveMultiStringMatcher extends MultiStringMatcher {
+
+ /** @param string $text The text to search in. */
+ public function searchIn( $text ) {
+ $matches = array();
+ foreach ( $this->searchKeywords as $keyword ) {
+ $length = mb_strlen( $keyword );
+ $offset = 0;
+ while ( ( $offset = mb_strpos( $text, $keyword, $offset
) ) !== false ) {
+ $matches[] = array( $offset, $keyword );
+ $offset = $offset + $length;
+ }
+ }
+ return $matches;
+ }
+}
+
+/**
+ * @covers AhoCorasick\MultiStringMatcher
+ */
+class AhoCorasickTest extends \PHPUnit_Framework_TestCase {
+
+ /**
+ * Sort results of NaiveMultiStringMatcher or MultiStringMatcher.
+ *
+ * Helps us assert equivalence.
+ *
+ * @param &$matches Results array.
+ */
+ public function sortMatcherResults( &$matches ) {
+ // Sort the results by match offset, then by match length,
+ // then by search keyword.
+ usort( $matches, function ( $a, $b ) {
+ return ( $a[0] - $b[0] )
+ ?: ( mb_strlen( $a[1] ) - mb_strlen( $b[1] ) )
+ ?: strcmp( $a[1], $b[1] );
+ } );
+ }
+
+ public function matcherCaseProvider() {
+ $testCases = array(
+ array(
+ 'She sells sea shells by the sea shore.',
+ array( 's', 'se', 'sea', 'ore', 'hell', 'eat' )
+ ),
+ array(
+ 'She sells sea shells by the sea shore.',
+ array( 's', 'ls', 'lls', 'hells', 'shell',
'she', 'he', 'h' ),
+ ),
+ array(
+ '井の中の蛙大海を知らず。',
+ array( 'の', '', '食', '小蓑' ),
+ ),
+ array(
+ 'Вдохновение — это умение приводить '
+ . 'себя в рабочее состояние.',
+ array( 'это умение приводить себя' ),
+ ),
+ array(
+ "初しぐれ猿も小蓑をほしげ也\nはつしぐれさるもこみのをほしげなり",
+ array( "しげ也\nはつし" ),
+ ),
+ array(
+ " (╯°□°）╯︵ ┻━┻ ",
+ array( '°□°' ),
+ ),
+ array(
+ '',
+ array( 'a' ),
+ ),
+ );
+
+ return $testCases;
+ }
+
+
+ /** @dataProvider matcherCaseProvider */
+ public function testMultiStringMatcher( $inputText, $searchKeywords ) {
+ $referenceMatcher = new NaiveMultiStringMatcher(
$searchKeywords );
+ $referenceResults = $referenceMatcher->searchIn( $inputText );
+ $this->sortMatcherResults( $referenceResults );
+
+ $actualMatcher = new MultiStringMatcher( $searchKeywords );
+ $actualResults = $actualMatcher->searchIn( $inputText );
+ $this->sortMatcherResults( $actualResults );
+
+ $this->assertEquals( $referenceResults, $actualResults );
+ }
+
+
+ /** @dataProvider matcherCaseProvider */
+ public function testDeterministicMultiStringMatcher( $inputText,
$searchKeywords ) {
+ $referenceMatcher = new NaiveMultiStringMatcher(
$searchKeywords );
+ $referenceResults = $referenceMatcher->searchIn( $inputText );
+ $this->sortMatcherResults( $referenceResults );
+
+ $actualMatcher = new DeterministicMultiStringMatcher(
$searchKeywords );
+ $actualResults = $actualMatcher->searchIn( $inputText );
+ $this->sortMatcherResults( $actualResults );
+
+ $this->assertEquals( $referenceResults, $actualResults );
+ }
+
+
+ public function replacerCaseProvider() {
+ return array(
+ array(
+ 'The quick brown fox jumps over the lazy dog.',
+ array( 'brown' => 'orange', 'brown fox' =>
'blue cat', 'brown fox jx' => 'x' )
+ ),
+ array(
+ "It's raining snakes and ladders here",
+ array( "It's" => 'It is', 'snake' => 'cat',
'ladder' => 'dog', 'here' => 'out there' ),
+ ),
+ array(
+ 'Now is the time for all good men to come to
the aid of the party',
+ array( 'USA' => 'United States' ),
+ ),
+ array(
+ "富士の風や扇にのせて江戸土産\n" .
+ "ふじのかぜやおうぎにのせてえどみやげ",
+ array( '江戸' => '東京' ),
+ ),
+ );
+ }
+
+
+ /** @dataProvider replacerCaseProvider */
+ public function testMultiStringReplacer( $inputText, $replacePairs ) {
+ $replacer = new MultiStringReplacer( $replacePairs );
+ $actual = $replacer->searchAndReplace( $inputText );
+ $expected = strtr( $inputText, $replacePairs );
+ $this->assertEquals( $expected, $actual );
+ }
+
+}
--
To view, visit https://gerrit.wikimedia.org/r/216594
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I583e1c2f619fa2b3992ac0909164d8a1fe8dc4d2
Gerrit-PatchSet: 5
Gerrit-Project: AhoCorasick
Gerrit-Branch: master
Gerrit-Owner: Ori.livneh <[email protected]>
Gerrit-Reviewer: Aaron Schulz <[email protected]>
Gerrit-Reviewer: Alex Monk <[email protected]>
Gerrit-Reviewer: BBlack <[email protected]>
Gerrit-Reviewer: BryanDavis <[email protected]>
Gerrit-Reviewer: Gilles <[email protected]>
Gerrit-Reviewer: Legoktm <[email protected]>
Gerrit-Reviewer: Ori.livneh <[email protected]>
Gerrit-Reviewer: Tim Starling <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
