Repository navigation
Expand file tree
/
Copy pathsphinxrlp.cpp
More file actions
629 lines (499 loc) · 16.1 KB
/
Copy pathsphinxrlp.cpp
File metadata and controls
629 lines (499 loc) · 16.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
//
// $Id$
//
//
// Copyright (c) 2001-2016, Andrew Aksyonoff
// Copyright (c) 2008-2016, Sphinx Technologies Inc
// All rights reserved
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License. You should have
// received a copy of the GPL license along with this program; if you
// did not, you can find it at http://www.gnu.org/
//
#include "sphinx.h"
#include "sphinxint.h"
#include "sphinxrlp.h"
#if USE_RLP
#include "bt_rlp_c.h"
#include <bt_xwchar.h>
#if ( USE_WINDOWS )
#pragma comment(linker, "/defaultlib:btrlpc.lib")
#pragma message("Automatically linking with btrlpc.lib")
#pragma comment(linker, "/defaultlib:btutils.lib")
#pragma message("Automatically linking with btutils.lib")
#endif
#ifndef SHAREDIR
#define SHAREDIR "."
#endif
CSphString g_sRLPRoot = SHAREDIR;
CSphString g_sRLPEnv = SHAREDIR"/rlp-environment.xml";
int g_iRLPMaxBatchSize = 51200;
int g_iRLPMaxBatchDocs = 50;
BT_RLP_EnvironmentC * g_pRLPEnv = NULL;
static void RLPLog ( void *, int iChannel, const char * szMessage )
{
switch ( iChannel )
{
case 0:
sphWarning ( "%s", szMessage );
break;
case 1:
sphLogFatal ( "%s", szMessage );
break;
default:
sphInfo ( "%s", szMessage );
break;
}
}
static bool sphRLPInit ( const char * szRootPath, const char * szEnvPath, CSphString & sError )
{
if ( !g_pRLPEnv )
{
if ( !BT_RLP_CLibrary_VersionIsCompatible ( BT_RLP_CLIBRARY_INTERFACE_VERSION ) )
{
sError.SetSprintf ( "RLP library mismatch: have %ld expect %d", BT_RLP_CLibrary_VersionNumber(), BT_RLP_CLIBRARY_INTERFACE_VERSION );
return false;
}
BT_RLP_Environment_SetBTRootDirectory ( szRootPath );
BT_RLP_Environment_SetLogCallbackFunction ( NULL, RLPLog );
BT_RLP_Environment_SetLogLevel ( "error" );
g_pRLPEnv = BT_RLP_Environment_Create();
if ( !g_pRLPEnv )
{
sError = "Unable to initialize RLP environment";
return false;
}
BT_Result iRes = BT_RLP_Environment_InitializeFromFile ( g_pRLPEnv, szEnvPath );
if ( iRes!=BT_OK )
{
sError = "Unable to initialize the RLP environment";
BT_RLP_Environment_Destroy ( g_pRLPEnv );
g_pRLPEnv = NULL;
return false;
}
}
return true;
}
void sphRLPDone ()
{
assert ( g_pRLPEnv );
BT_RLP_Environment_Destroy ( g_pRLPEnv );
g_pRLPEnv = NULL;
}
class CSphRLPPreprocessor
{
public:
CSphRLPPreprocessor ( const char * szRootPath, const char * szEnvPath, const char * szCtxPath )
: m_sRootPath ( szRootPath )
, m_sEnvPath ( szEnvPath )
, m_sCtxPath ( szCtxPath )
, m_pContext ( NULL )
, m_pFactory ( NULL )
, m_pTokenIterator ( NULL )
, m_iNextCompoundComponent ( -1 )
, m_bInitialized ( false )
{
sphUTF8Encode ( m_pMarkerChunkSeparator, PROXY_CHUNK_SEPARATOR );
}
virtual ~CSphRLPPreprocessor()
{
if ( m_pTokenIterator )
BT_RLP_TokenIterator_Destroy ( m_pTokenIterator );
if ( m_pFactory )
BT_RLP_TokenIteratorFactory_Destroy ( m_pFactory );
if ( m_pContext )
BT_RLP_Environment_DestroyContext ( g_pRLPEnv, m_pContext );
}
bool Init ( CSphString & sError )
{
assert ( !m_bInitialized );
if ( !sphRLPInit ( m_sRootPath.cstr(), m_sEnvPath.cstr(), sError ) )
return false;
assert ( g_pRLPEnv );
BT_Result iRes = BT_RLP_Environment_GetContextFromFile ( g_pRLPEnv, m_sCtxPath.cstr(), &m_pContext );
if ( iRes!=BT_OK )
{
sError = "Unable to create RLP context";
return false;
}
m_pFactory = BT_RLP_TokenIteratorFactory_Create();
if ( !m_pFactory )
{
sError = "Unable to create RLP token iterator factory";
return false;
}
BT_RLP_TokenIteratorFactory_SetReturnCompoundComponents ( m_pFactory, true );
m_bInitialized = true;
return true;
}
bool Process ( const BYTE * pBuffer, int iLength, CSphVector<BYTE> & dOut, bool bQuery )
{
if ( !pBuffer || !iLength )
return false;
if ( !sphDetectChinese ( pBuffer, iLength ) )
return false;
dOut.Resize(0);
const BYTE * pSegment = pBuffer;
int iLengthLeft = iLength;
while ( iLengthLeft )
{
int iSegmentLength = GetNextLengthToSegment ( pSegment, iLengthLeft );
if ( iSegmentLength )
ProcessSegment ( pSegment, iSegmentLength, dOut, bQuery );
pSegment += iSegmentLength;
iLengthLeft -= iSegmentLength;
}
return true;
}
bool SetBlendChars ( const char * szBlendChars, CSphString & sError )
{
m_sBlendChars = szBlendChars;
CSphCharsetDefinitionParser tParser;
if ( !tParser.Parse ( szBlendChars, m_dBlendChars ) )
{
sError = tParser.GetLastError();
return false;
}
return true;
}
protected:
CSphString m_sBlendChars;
CSphString m_sRootPath;
CSphString m_sEnvPath;
CSphString m_sCtxPath;
private:
struct TextChunk_t
{
int m_iStart;
int m_iLength;
};
static const int MAX_TOKEN_LEN = 1024;
static const int MAX_CHUNK_SIZE = 10485760;
BT_RLP_ContextC * m_pContext;
BT_RLP_TokenIteratorFactoryC * m_pFactory;
BT_RLP_TokenIteratorC * m_pTokenIterator;
int m_iNextCompoundComponent;
bool m_bInitialized;
CSphTightVector<BYTE> m_dCJKBuffer;
CSphTightVector<BYTE> m_dNonCJKBuffer;
CSphTightVector<TextChunk_t> m_dNonCJKChunks;
BYTE m_dUTF8Buffer[MAX_TOKEN_LEN];
BYTE m_pMarkerChunkSeparator[PROXY_MARKER_LEN];
CSphVector<CSphRemapRange> m_dBlendChars;
void ProcessSegment ( const BYTE * pIn, int iLen, CSphVector<BYTE> & dOut, bool bQuery )
{
assert ( pIn && iLen );
m_dCJKBuffer.Resize(0);
m_dNonCJKBuffer.Resize(0);
m_dNonCJKChunks.Resize(0);
const BYTE * pBuffer = pIn;
const BYTE * pBufferMax = pIn+iLen;
bool bWasChineseCode = false;
const BYTE * pChunkStart = pBuffer;
bool bFirstCode = true;
while ( pBuffer<pBufferMax )
{
const BYTE * pTmp = pBuffer;
int iCode = sphUTF8Decode ( pBuffer );
bool bIsChineseCode = sphIsChineseCode(iCode);
if ( !bFirstCode && bWasChineseCode!=bIsChineseCode )
{
AddTextChunk ( pChunkStart, pTmp-pChunkStart, bWasChineseCode );
pChunkStart = pTmp;
}
bWasChineseCode = bIsChineseCode;
bFirstCode = false;
}
AddTextChunk ( pChunkStart, pBuffer-pChunkStart, bWasChineseCode );
ProcessBufferRLP ( m_dCJKBuffer.Begin(), m_dCJKBuffer.GetLength() );
dOut.Reserve ( m_dCJKBuffer.GetLength() + m_dNonCJKBuffer.GetLength() );
// reconstruct the buffer
BYTE * pToken;
int iCurNonCJKToken = 0;
while ( (pToken = GetNextTokenRLP())!=NULL )
{
int iResLen = dOut.GetLength();
int iTokenLen = strlen ( (const char *)pToken );
bool bAddSpace = iResLen && !sphIsSpace ( dOut[iResLen-1] );
if ( iTokenLen==PROXY_MARKER_LEN && CMP_MARKER ( pToken, m_pMarkerChunkSeparator ) )
{
const TextChunk_t & tChunk = m_dNonCJKChunks[iCurNonCJKToken++];
BYTE * pChunkStart = m_dNonCJKBuffer.Begin()+tChunk.m_iStart;
bAddSpace &= !sphIsSpace( *pChunkStart ) && ( !bQuery || !IsSpecialQueryCode ( *pChunkStart ) ) && !IsBlendChar( *pChunkStart );
dOut.Resize ( iResLen + tChunk.m_iLength + ( bAddSpace ? 1 : 0 ) );
BYTE * pOut = dOut.Begin()+iResLen;
if ( bAddSpace )
*pOut++ = ' ';
memcpy ( pOut, pChunkStart, tChunk.m_iLength );
} else
{
dOut.Resize ( iResLen + iTokenLen + ( bAddSpace ? 1 : 0 ) );
BYTE * pOut = dOut.Begin()+iResLen;
if ( iResLen )
bAddSpace &= ( !bQuery || !IsSpecialQueryCode ( pOut[-1] ) ) && !IsBlendChar( pOut[-1] );
if ( bAddSpace )
*pOut++ = ' ';
memcpy ( pOut, pToken, iTokenLen );
}
}
}
void AddTextChunk ( const BYTE * pStart, int iLen, bool bChinese )
{
if ( bChinese )
{
// fixme! maybe surround these chinese text chunks by spaces?
int iOldBufferLen = m_dCJKBuffer.GetLength();
m_dCJKBuffer.Resize ( iOldBufferLen+iLen );
BYTE * pCurDocPtr = &(m_dCJKBuffer[iOldBufferLen]);
memcpy ( pCurDocPtr, pStart, iLen );
} else
{
// store non-chinese content
int iOldBufferLen = m_dNonCJKBuffer.GetLength();
TextChunk_t & tChunk = m_dNonCJKChunks.Add();
tChunk.m_iStart = iOldBufferLen;
tChunk.m_iLength = iLen;
m_dNonCJKBuffer.Resize ( iOldBufferLen+iLen );
BYTE * pNonChinesePtr = &(m_dNonCJKBuffer[iOldBufferLen]);
memcpy ( pNonChinesePtr, pStart, iLen );
// copy marker to chinese buffer
iOldBufferLen = m_dCJKBuffer.GetLength();
m_dCJKBuffer.Resize ( iOldBufferLen+PROXY_MARKER_LEN+2 ); // marker+2 spaces around it
BYTE * pCurDocPtr = &(m_dCJKBuffer[iOldBufferLen]);
COPY_MARKER ( pCurDocPtr, m_pMarkerChunkSeparator );
}
}
int GetNextLengthToSegment ( const BYTE * pBuffer, int iLength ) const
{
if ( iLength <= MAX_CHUNK_SIZE )
return iLength;
const BYTE * pCurBuf = pBuffer;
const BYTE * pLastSeparator = NULL;
int iLengthLeft = Min ( iLength, MAX_CHUNK_SIZE );
while ( pCurBuf<pBuffer+iLengthLeft )
{
int iCode = sphUTF8Decode ( pCurBuf );
if ( IsChineseSeparator ( iCode ) )
pLastSeparator = pCurBuf;
}
return pLastSeparator ? pLastSeparator-pBuffer : iLengthLeft;
}
void ProcessBufferRLP ( const BYTE * pBuffer, int iLength )
{
assert ( !m_pTokenIterator );
BT_Result iRes = BT_RLP_Context_ProcessBuffer ( m_pContext, pBuffer, iLength, BT_LANGUAGE_SIMPLIFIED_CHINESE, "UTF-8", NULL );
// iteration should still work ok in this case
if ( iRes!=BT_OK )
sphWarning ( "BT_RLP_Context_ProcessBuffer error" );
m_pTokenIterator = BT_RLP_TokenIteratorFactory_CreateIterator ( m_pFactory, m_pContext );
if ( !m_pTokenIterator )
sphWarning ( "BT_RLP_TokenIteratorFactory_CreateIterator error" );
}
BYTE * GetNextTokenRLP()
{
static const char * RPL_SPECIAL_STOPWORD = "rlpspecialstopword";
if ( !m_pTokenIterator )
return NULL;
if ( m_iNextCompoundComponent!=-1 )
{
if ( m_iNextCompoundComponent>=(int)BT_RLP_TokenIterator_GetNumberOfCompoundComponents ( m_pTokenIterator ) )
m_iNextCompoundComponent = -1;
else
{
const BT_Char16 * pToken = BT_RLP_TokenIterator_GetCompoundComponent ( m_pTokenIterator, m_iNextCompoundComponent++ );
if ( BT_RLP_TokenIterator_IsStopword ( m_pTokenIterator ) )
strncpy ( (char*)m_dUTF8Buffer, RPL_SPECIAL_STOPWORD, MAX_TOKEN_LEN );
else
{
assert ( pToken );
bt_xutf16toutf8 ( (char*)m_dUTF8Buffer, pToken, sizeof(m_dUTF8Buffer) );
}
return &(m_dUTF8Buffer[0]);
}
}
while ( BT_RLP_TokenIterator_Next ( m_pTokenIterator ) )
{
const char * szPartOfSpeech = BT_RLP_TokenIterator_GetPartOfSpeech ( m_pTokenIterator );
if ( IsJunkPOS ( szPartOfSpeech ) )
continue;
const BT_Char16 * pToken;
int nCC = BT_RLP_TokenIterator_GetNumberOfCompoundComponents ( m_pTokenIterator );
if ( nCC>0 )
{
m_iNextCompoundComponent = 0;
pToken = BT_RLP_TokenIterator_GetCompoundComponent ( m_pTokenIterator, m_iNextCompoundComponent++ );
} else
pToken = BT_RLP_TokenIterator_GetToken ( m_pTokenIterator );
if ( BT_RLP_TokenIterator_IsStopword ( m_pTokenIterator ) )
strncpy ( (char*)m_dUTF8Buffer, RPL_SPECIAL_STOPWORD, MAX_TOKEN_LEN );
else
{
assert ( pToken );
bt_xutf16toutf8 ( (char*)m_dUTF8Buffer, pToken, sizeof(m_dUTF8Buffer) );
}
return &(m_dUTF8Buffer[0]);
}
DestroyIteratorRLP();
return NULL;
}
void DestroyIteratorRLP()
{
if ( m_pTokenIterator )
{
BT_RLP_TokenIterator_Destroy ( m_pTokenIterator );
m_pTokenIterator = NULL;
}
if ( m_pContext )
BT_RLP_Context_DestroyResultStorage ( m_pContext );
}
bool IsJunkPOS ( const char * szPOS )
{
// drop EOS and PUNCT
return !szPOS || !*szPOS || ( *szPOS=='E' && *(szPOS+1)=='O' ) || ( *szPOS=='P' && *(szPOS+1)=='U' );
}
bool IsSpecialCode ( int iCode ) const
{
return iCode==PROXY_DOCUMENT_START || iCode==PROXY_FIELD_START;
}
bool IsChineseSeparator ( int iCode ) const
{
return ( iCode>=0x3000 && iCode<=0x303F ) || sphIsSpace(iCode) || IsSpecialCode(iCode);
}
bool IsSpecialQueryCode ( int iCode ) const
{
return iCode=='!' || iCode=='^' || iCode=='$' || iCode=='*' || iCode=='=';
}
bool IsBlendChar ( int iCode ) const
{
ARRAY_FOREACH ( i, m_dBlendChars )
if ( iCode>=m_dBlendChars[i].m_iStart && iCode<=m_dBlendChars[i].m_iEnd )
return true;
return false;
}
};
class CSphFieldFilterRLP : public ISphFieldFilter, public CSphRLPPreprocessor
{
public:
CSphFieldFilterRLP ( const char * szRLPRoot, const char * szRLPEnv, const char * szRLPCtx );
virtual int Apply ( const BYTE * sField, int iLength, CSphVector<BYTE> & dStorage, bool bQuery );
virtual void GetSettings ( CSphFieldFilterSettings & tSettings ) const;
virtual ISphFieldFilter * Clone();
};
CSphFieldFilterRLP::CSphFieldFilterRLP ( const char * szRLPRoot, const char * szRLPEnv, const char * szRLPCtx )
: CSphRLPPreprocessor ( szRLPRoot, szRLPEnv, szRLPCtx )
{
}
int CSphFieldFilterRLP::Apply ( const BYTE * sField, int iLength, CSphVector<BYTE> & dStorage, bool bQuery )
{
if ( m_pParent )
{
int iResultLength = m_pParent->Apply ( sField, iLength, dStorage, bQuery );
if ( iResultLength ) // can't use dStorage.GetLength() because of the safety gap
{
CSphFixedVector<BYTE> dTmp ( iResultLength );
memcpy ( dTmp.Begin(), dStorage.Begin(), dStorage.GetLength() );
if ( !Process ( dTmp.Begin(), iLength, dStorage, bQuery ) )
return iResultLength;
// add safety gap
int iStorageLength = dStorage.GetLength();
if ( iStorageLength )
{
dStorage.Resize ( iStorageLength+4 );
dStorage[iStorageLength]='\0';
}
return iStorageLength;
}
}
if ( !Process ( sField, iLength, dStorage, bQuery ) )
return 0;
int iStorageLength = dStorage.GetLength();
dStorage.Resize ( iStorageLength+4 );
dStorage[iStorageLength]='\0';
return iStorageLength;
}
void CSphFieldFilterRLP::GetSettings ( CSphFieldFilterSettings & tSettings ) const
{
if ( m_pParent )
m_pParent->GetSettings ( tSettings );
}
ISphFieldFilter * CSphFieldFilterRLP::Clone()
{
ISphFieldFilter * pClonedParent = NULL;
if ( m_pParent )
pClonedParent = m_pParent->Clone();
CSphString sError;
ISphFieldFilter * pFilter = sphCreateRLPFilter ( pClonedParent, m_sRootPath.cstr(), m_sEnvPath.cstr(), m_sCtxPath.cstr(), m_sBlendChars.cstr(), sError );
if ( !pFilter )
sphWarning ( "RLP filter clone error '%s'", sError.cstr() );
return pFilter;
}
ISphFieldFilter * sphCreateRLPFilter ( ISphFieldFilter * pParent, const char * szRLPRoot, const char * szRLPEnv, const char * szRLPCtx, const char * szBlendChars, CSphString & sError )
{
CSphFieldFilterRLP * pFilter = new CSphFieldFilterRLP ( szRLPRoot, szRLPEnv, szRLPCtx );
if ( !pFilter->Init ( sError ) )
{
SafeDelete ( pFilter );
return pParent;
}
if ( szBlendChars && *szBlendChars && !pFilter->SetBlendChars ( szBlendChars, sError ) )
{
SafeDelete ( pFilter );
return pParent;
}
pFilter->SetParent ( pParent );
return pFilter;
}
bool sphRLPCheckConfig ( CSphIndexSettings &, CSphString & )
{
return true;
}
bool sphSpawnRLPFilter ( ISphFieldFilter * & pFieldFilter, const CSphIndexSettings & m_tSettings, const CSphTokenizerSettings & tTokSettings, const char * szIndex, CSphString & sError )
{
if ( m_tSettings.m_eChineseRLP==SPH_RLP_NONE )
return true;
ISphFieldFilter * pRLPFilter = sphCreateRLPFilter ( pFieldFilter, g_sRLPRoot.cstr(), g_sRLPEnv.cstr(), m_tSettings.m_sRLPContext.cstr(), tTokSettings.m_sBlendChars.cstr(), sError );
if ( pRLPFilter==pFieldFilter && m_tSettings.m_eChineseRLP==SPH_RLP_BATCHED )
{
sError.SetSprintf ( "index '%s': Error initializing RLP: %s", szIndex, sError.cstr() );
return false;
}
pFieldFilter = pRLPFilter;
return true;
}
void sphConfigureRLP ( CSphConfigSection & hCommon )
{
g_sRLPRoot = hCommon.GetStr ( "rlp_root" );
g_sRLPEnv = hCommon.GetStr ( "rlp_environment" );
g_iRLPMaxBatchSize = hCommon.GetSize ( "rlp_max_batch_size", 51200 );
g_iRLPMaxBatchDocs = hCommon.GetInt ( "rlp_max_batch_docs", 50 );
}
#else
ISphFieldFilter * sphCreateRLPFilter ( ISphFieldFilter * pParent, CSphString & )
{
return pParent;
}
bool sphRLPCheckConfig ( CSphIndexSettings & tSettings, CSphString & sError )
{
if ( tSettings.m_eChineseRLP!=SPH_RLP_NONE || !tSettings.m_sRLPContext.IsEmpty() )
{
tSettings.m_eChineseRLP = SPH_RLP_NONE;
sError.SetSprintf ( "RLP options specified, but no RLP support compiled; ignoring\n" );
return false;
}
return true;
}
bool sphSpawnRLPFilter ( ISphFieldFilter * &, const CSphIndexSettings &, const CSphTokenizerSettings &, const char *, CSphString & )
{
return true;
}
void sphConfigureRLP ( CSphConfigSection & )
{
}
void sphRLPDone()
{
}
#endif
//
// $Id$
//