Merge pull request #1136 from esl/feature/free-text-search

Feature/full text search
esl · Feb 20, 2017 · 0ddc72a · 0ddc72a
2 parents ef7e431 + 9569e6d
commit 0ddc72a
Show file tree

Hide file tree

Showing 23 changed files with 1,266 additions and 775 deletions.
diff --git a/apps/ejabberd/priv/mysql-part-muc.sql b/apps/ejabberd/priv/mysql-part-muc.sql
@@ -6,7 +6,8 @@ CREATE TABLE mam_muc_message_00(
   -- A nick of the message's originator
   nick_name varchar(250) NOT NULL,
   -- Term-encoded message packet
-  message blob NOT NULL
+  message blob NOT NULL,
+  search_body text
 )  ENGINE=InnoDB;
 CREATE INDEX i_mam_muc_message_room_name_added_at USING BTREE ON mam_muc_message_00(room_id, id);
 

diff --git a/apps/ejabberd/priv/mysql-part.sql b/apps/ejabberd/priv/mysql-part.sql
@@ -16,6 +16,7 @@ CREATE TABLE mam_message_00(
   direction ENUM('I','O') NOT NULL,
   -- Term-encoded message packet
   message blob NOT NULL,
+  search_body text,
   PRIMARY KEY (user_id, id),
   INDEX i_mam_message_rem USING BTREE (user_id, remote_bare_jid, id)
 )  ENGINE=InnoDB;

diff --git a/apps/ejabberd/priv/mysql.sql b/apps/ejabberd/priv/mysql.sql
@@ -161,6 +161,10 @@ CREATE TABLE roster_version (
 -- UPDATE rosterusers SET askmessage = '';
 -- ALTER TABLE rosterusers ALTER COLUMN askmessage SET NOT NULL;
 --
+-- To update from 2.0.0:
+-- ALTER TABLE mam_message ADD COLUMN search_body text;
+-- ALTER TABLE mam_muc_message ADD COLUMN search_body text;
+--
 -- NOTE: A "minified" JID is an encoded form of JID storing only
 --       the difference between a user's JID and the real JID.
 --       Consult with mod_mam_utils:jid_to_opt_binary/2
@@ -205,6 +209,7 @@ CREATE TABLE mam_message(
   -- Term-encoded message packet
   -- Don't try to decode it using MySQL tools
   message blob NOT NULL,
+  search_body text,
   PRIMARY KEY (user_id, id),
   INDEX i_mam_message_rem USING BTREE (user_id, remote_bare_jid, id)
 )  ENGINE=InnoDB
@@ -243,6 +248,7 @@ CREATE TABLE mam_muc_message(
   nick_name varchar(250) NOT NULL,
   -- Term-encoded message packet
   message blob NOT NULL,
+  search_body text,
   PRIMARY KEY (room_id, id)
 );
 

diff --git a/apps/ejabberd/priv/pg.sql b/apps/ejabberd/priv/pg.sql
@@ -165,6 +165,10 @@ CREATE TABLE roster_version (
 -- UPDATE rosterusers SET askmessage = '';
 -- ALTER TABLE rosterusers ALTER COLUMN askmessage SET NOT NULL;
 
+-- To update from 2.0.0:
+-- ALTER TABLE mam_message ADD COLUMN search_body text;
+-- ALTER TABLE mam_muc_message ADD COLUMN search_body text;
+
 CREATE TYPE mam_behaviour AS ENUM('A', 'N', 'R');
 CREATE TYPE mam_direction AS ENUM('I','O');
 
@@ -186,6 +190,7 @@ CREATE TABLE mam_message(
   direction mam_direction NOT NULL,
   -- Term-encoded message packet
   message bytea NOT NULL,
+  search_body text,
   PRIMARY KEY(user_id, id)
 );
 CREATE INDEX i_mam_message_username_jid_id
@@ -224,6 +229,7 @@ CREATE TABLE mam_muc_message(
   nick_name varchar(250) NOT NULL,
   -- Term-encoded message packet
   message bytea NOT NULL,
+  search_body text,
   PRIMARY KEY (room_id, id)
 );
 

diff --git a/apps/ejabberd/src/ejabberd_gen_mam_archive.erl b/apps/ejabberd/src/ejabberd_gen_mam_archive.erl
@@ -1,39 +1,44 @@
 -module(ejabberd_gen_mam_archive).
 
 -callback archive_size(Size :: integer(), Host :: ejabberd:server(),
-        ArchiveID :: mod_mam:archive_id(), ArchiveJID :: ejabberd:jid())
-            -> integer().
+                       ArchiveID :: mod_mam:archive_id(), ArchiveJID :: ejabberd:jid())
+                      -> integer().
 
 -callback archive_message(_Result, ejabberd:server(),
-        MessID :: mod_mam:message_id(), ArchiveID :: mod_mam:archive_id(),
-        LocJID :: ejabberd:jid(), RemJID :: ejabberd:jid(),
-        SrcJID :: ejabberd:jid(), Dir :: atom(), Packet :: any()) -> ok | {error, timeout}.
+                          MessID :: mod_mam:message_id(), ArchiveID :: mod_mam:archive_id(),
+                          LocJID :: ejabberd:jid(), RemJID :: ejabberd:jid(),
+                          SrcJID :: ejabberd:jid(), Dir :: atom(), Packet :: any()) ->
+    ok | {error, timeout}.
 
 -callback lookup_messages(Result :: any(), Host :: ejabberd:server(),
-        ArchiveID :: mod_mam:archive_id(), ArchiveJID :: ejabberd:jid(),
-        RSM :: jlib:rsm_in() | undefined, Borders :: mod_mam:borders() | undefined,
-        Start :: mod_mam:unix_timestamp() | undefined,
-        End :: mod_mam:unix_timestamp() | undefined, Now :: mod_mam:unix_timestamp(),
-        WithJID :: ejabberd:jid() | undefined, PageSize :: integer(),
-        LimitPassed :: boolean() | opt_count, MaxResultLimit :: integer(),
-        IsSimple :: boolean()) -> {ok, mod_mam:lookup_result()}
-                                | {error, 'policy-violation'}.
+                          ArchiveID :: mod_mam:archive_id(), ArchiveJID :: ejabberd:jid(),
+                          RSM :: jlib:rsm_in() | undefined,
+                          Borders :: mod_mam:borders() | undefined,
+                          Start :: mod_mam:unix_timestamp() | undefined,
+                          End :: mod_mam:unix_timestamp() | undefined,
+                          Now :: mod_mam:unix_timestamp(),
+                          WithJID :: ejabberd:jid() | undefined,
+                          SearchText :: binary() | undefined, PageSize :: integer(),
+                          LimitPassed :: boolean() | opt_count, MaxResultLimit :: integer(),
+                          IsSimple :: boolean()) -> {ok, mod_mam:lookup_result()}
+                                                        | {error, 'policy-violation'}.
 
 -callback remove_archive(Acc :: map(), Host :: ejabberd:server(),
     ArchiveID :: mod_mam:archive_id(), ArchiveJID :: ejabberd:jid()) -> map().
 
 -callback purge_single_message(Result :: purge_single_message_result(), Host :: ejabberd:server(),
-        MessID :: mod_mam:message_id(), ArchiveID :: mod_mam:archive_id(),
-        ArchiveJID :: ejabberd:jid(), Now :: mod_mam:unix_timestamp())
-            -> purge_single_message_result().
+                               MessID :: mod_mam:message_id(), ArchiveID :: mod_mam:archive_id(),
+                               ArchiveJID :: ejabberd:jid(), Now :: mod_mam:unix_timestamp())
+                              -> purge_single_message_result().
 
 -callback purge_multiple_messages(Result :: any(), Host :: ejabberd:server(),
-        ArchiveID :: mod_mam:archive_id(), ArchiveJID :: ejabberd:jid(),
-        Borders :: mod_mam:borders() | undefined,
-        Start :: mod_mam:unix_timestamp() | undefined,
-        End :: mod_mam:unix_timestamp() | undefined,
-        Now :: mod_mam:unix_timestamp(),
-        WithJID :: ejabberd:jid() | undefined) -> ok | {error, 'not-allowed'}.
+                                  ArchiveID :: mod_mam:archive_id(), ArchiveJID :: ejabberd:jid(),
+                                  Borders :: mod_mam:borders() | undefined,
+                                  Start :: mod_mam:unix_timestamp() | undefined,
+                                  End :: mod_mam:unix_timestamp() | undefined,
+                                  Now :: mod_mam:unix_timestamp(),
+                                  WithJID :: ejabberd:jid() | undefined) ->
+    ok | {error, 'not-allowed'}.
 
 -type purge_single_message_result() :: ok | {error, 'not-allowed' | 'not-found' | term()}.
 

diff --git a/apps/ejabberd/src/mod_commands.erl b/apps/ejabberd/src/mod_commands.erl
@@ -186,7 +186,7 @@ send_message(From, To, Body) ->
     ejabberd_hooks:run(user_send_packet,
                        F#jid.lserver,
                        [F, T, Packet]),
-    % privacy check is missing, but is it needed?
+    %% privacy check is missing, but is it needed?
     ejabberd_router:route(F, T, Packet),
     ok.
 
@@ -242,15 +242,16 @@ lookup_recent_messages(ArcJID, WithJID, Before, Limit) ->
     RSM = #rsm_in{direction = before, id = undefined}, % last msgs
     Start = undefined,
     End = Before * 1000000,
-    Now = mod_mam_utils:now_to_microseconds(os:timestamp()),
+    Now = p1_time_compat:os_system_time(micro_seconds),
     WithJID = WithJID,
+    SearchText = undefined,
     PageSize = Limit,
     LimitPassed = false,
     MaxResultLimit = 1,
     IsSimple = true,
     R = ejabberd_hooks:run_fold(mam_lookup_messages, Host, {ok, {0, 0, []}},
                                 [Host, ArcID, ArcJID, RSM, Borders,
-                                 Start, End, Now, WithJID,
+                                 Start, End, Now, WithJID, SearchText,
                                  PageSize, LimitPassed, MaxResultLimit, IsSimple]),
     {ok, {_, _, L}} = R,
     L.