From a25bbc1dcab43c3a1cea4f59478e89bafc06f78c Mon Sep 17 00:00:00 2001
From: epriestley <git@epriestley.com>
Date: Thu, 7 Sep 2017 12:38:11 -0700
Subject: [PATCH] Support Ferret engine in Phriction

Summary: Ref T12819. Adds Ferret engine support.

Test Plan: Indexed and searched for documents.

Reviewers: chad

Reviewed By: chad

Maniphest Tasks: T12819

Differential Revision: https://secure.phabricator.com/D18567
---
 .../20170907.ferret.22.phriction.doc.sql       |  9 +++++++++
 .../20170907.ferret.23.phriction.field.sql     |  8 ++++++++
 .../20170907.ferret.24.phriction.ngrams.sql    |  5 +++++
 src/__phutil_library_map__.php                 |  3 +++
 .../search/PhrictionDocumentFerretEngine.php   | 18 ++++++++++++++++++
 .../phriction/storage/PhrictionDocument.php    |  9 +++++++++
 6 files changed, 52 insertions(+)
 create mode 100644 resources/sql/autopatches/20170907.ferret.22.phriction.doc.sql
 create mode 100644 resources/sql/autopatches/20170907.ferret.23.phriction.field.sql
 create mode 100644 resources/sql/autopatches/20170907.ferret.24.phriction.ngrams.sql
 create mode 100644 src/applications/phriction/search/PhrictionDocumentFerretEngine.php

diff --git a/resources/sql/autopatches/20170907.ferret.22.phriction.doc.sql b/resources/sql/autopatches/20170907.ferret.22.phriction.doc.sql
new file mode 100644
index 0000000000..9de7124255
--- /dev/null
+++ b/resources/sql/autopatches/20170907.ferret.22.phriction.doc.sql
@@ -0,0 +1,9 @@
+CREATE TABLE {$NAMESPACE}_phriction.phriction_document_fdocument (
+  id INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  objectPHID VARBINARY(64) NOT NULL,
+  isClosed BOOL NOT NULL,
+  authorPHID VARBINARY(64),
+  ownerPHID VARBINARY(64),
+  epochCreated INT UNSIGNED NOT NULL,
+  epochModified INT UNSIGNED NOT NULL
+) ENGINE=InnoDB, COLLATE {$COLLATE_TEXT};
diff --git a/resources/sql/autopatches/20170907.ferret.23.phriction.field.sql b/resources/sql/autopatches/20170907.ferret.23.phriction.field.sql
new file mode 100644
index 0000000000..0fc5b959d1
--- /dev/null
+++ b/resources/sql/autopatches/20170907.ferret.23.phriction.field.sql
@@ -0,0 +1,8 @@
+CREATE TABLE {$NAMESPACE}_phriction.phriction_document_ffield (
+  id INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  documentID INT UNSIGNED NOT NULL,
+  fieldKey VARCHAR(4) NOT NULL COLLATE {$COLLATE_TEXT},
+  rawCorpus LONGTEXT NOT NULL COLLATE {$COLLATE_SORT},
+  termCorpus LONGTEXT NOT NULL COLLATE {$COLLATE_SORT},
+  normalCorpus LONGTEXT NOT NULL COLLATE {$COLLATE_SORT}
+) ENGINE=InnoDB, COLLATE {$COLLATE_TEXT};
diff --git a/resources/sql/autopatches/20170907.ferret.24.phriction.ngrams.sql b/resources/sql/autopatches/20170907.ferret.24.phriction.ngrams.sql
new file mode 100644
index 0000000000..abbb90a1e4
--- /dev/null
+++ b/resources/sql/autopatches/20170907.ferret.24.phriction.ngrams.sql
@@ -0,0 +1,5 @@
+CREATE TABLE {$NAMESPACE}_phriction.phriction_document_fngrams (
+  id INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  documentID INT UNSIGNED NOT NULL,
+  ngram CHAR(3) NOT NULL COLLATE {$COLLATE_TEXT}
+) ENGINE=InnoDB, COLLATE {$COLLATE_TEXT};
diff --git a/src/__phutil_library_map__.php b/src/__phutil_library_map__.php
index 2513480fa3..c22e4314c0 100644
--- a/src/__phutil_library_map__.php
+++ b/src/__phutil_library_map__.php
@@ -4694,6 +4694,7 @@ phutil_register_library_map(array(
     'PhrictionDocumentContentTransaction' => 'applications/phriction/xaction/PhrictionDocumentContentTransaction.php',
     'PhrictionDocumentController' => 'applications/phriction/controller/PhrictionDocumentController.php',
     'PhrictionDocumentDeleteTransaction' => 'applications/phriction/xaction/PhrictionDocumentDeleteTransaction.php',
+    'PhrictionDocumentFerretEngine' => 'applications/phriction/search/PhrictionDocumentFerretEngine.php',
     'PhrictionDocumentFulltextEngine' => 'applications/phriction/search/PhrictionDocumentFulltextEngine.php',
     'PhrictionDocumentHeraldAdapter' => 'applications/phriction/herald/PhrictionDocumentHeraldAdapter.php',
     'PhrictionDocumentHeraldField' => 'applications/phriction/herald/PhrictionDocumentHeraldField.php',
@@ -10420,6 +10421,7 @@ phutil_register_library_map(array(
       'PhabricatorTokenReceiverInterface',
       'PhabricatorDestructibleInterface',
       'PhabricatorFulltextInterface',
+      'PhabricatorFerretInterface',
       'PhabricatorProjectInterface',
       'PhabricatorApplicationTransactionInterface',
     ),
@@ -10428,6 +10430,7 @@ phutil_register_library_map(array(
     'PhrictionDocumentContentTransaction' => 'PhrictionDocumentTransactionType',
     'PhrictionDocumentController' => 'PhrictionController',
     'PhrictionDocumentDeleteTransaction' => 'PhrictionDocumentTransactionType',
+    'PhrictionDocumentFerretEngine' => 'PhabricatorFerretEngine',
     'PhrictionDocumentFulltextEngine' => 'PhabricatorFulltextEngine',
     'PhrictionDocumentHeraldAdapter' => 'HeraldAdapter',
     'PhrictionDocumentHeraldField' => 'HeraldField',
diff --git a/src/applications/phriction/search/PhrictionDocumentFerretEngine.php b/src/applications/phriction/search/PhrictionDocumentFerretEngine.php
new file mode 100644
index 0000000000..76802391e7
--- /dev/null
+++ b/src/applications/phriction/search/PhrictionDocumentFerretEngine.php
@@ -0,0 +1,18 @@
+<?php
+
+final class PhrictionDocumentFerretEngine
+  extends PhabricatorFerretEngine {
+
+  public function getApplicationName() {
+    return 'phriction';
+  }
+
+  public function getScopeName() {
+    return 'document';
+  }
+
+  public function newSearchEngine() {
+    return new PhrictionSearchEngine();
+  }
+
+}
diff --git a/src/applications/phriction/storage/PhrictionDocument.php b/src/applications/phriction/storage/PhrictionDocument.php
index b18f6bab9e..7a3e178882 100644
--- a/src/applications/phriction/storage/PhrictionDocument.php
+++ b/src/applications/phriction/storage/PhrictionDocument.php
@@ -8,6 +8,7 @@ final class PhrictionDocument extends PhrictionDAO
     PhabricatorTokenReceiverInterface,
     PhabricatorDestructibleInterface,
     PhabricatorFulltextInterface,
+    PhabricatorFerretInterface,
     PhabricatorProjectInterface,
     PhabricatorApplicationTransactionInterface {
 
@@ -255,4 +256,12 @@ final class PhrictionDocument extends PhrictionDAO
     return new PhrictionDocumentFulltextEngine();
   }
 
+
+/* -(  PhabricatorFerretInterface  )----------------------------------------- */
+
+
+  public function newFerretEngine() {
+    return new PhrictionDocumentFerretEngine();
+  }
+
 }