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
|
/*
* Copyright (C) 2021 Matthieu Gautier <mgautier@kymeria.fr>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* is provided AS IS, WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, and
* NON-INFRINGEMENT. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#define ZIM_PRIVATE
#include <zim/archive.h>
#include <zim/item.h>
#include <zim/search.h>
#include <zim/suggestion.h>
#include <zim/writer/item.h>
#include "tools.h"
#include "gtest/gtest.h"
namespace
{
using zim::unittests::TempZimArchive;
using zim::unittests::TestItem;
using zim::unittests::IsFrontArticle;
class TestIndexData : public zim::writer::IndexData {
public:
TestIndexData(const std::string& content)
: m_content(content)
{}
bool hasIndexData() const { return ! m_content.empty(); }
std::string getTitle() const { return ""; }
std::string getContent() const { return m_content; }
std::string getKeywords() const { return ""; }
uint32_t getWordCount() const { return 1; }
IndexData::GeoPosition getGeoPosition() const { return std::make_tuple(false, 0.0, 0.0); }
private:
std::string m_content;
};
class IndexDataItem : public TestItem {
public:
IndexDataItem(const std::string& path, const std::string& mimetype, const std::string& title, const std::string& content, std::shared_ptr<zim::writer::IndexData> indexData)
: TestItem(path, mimetype, title, content),
mp_indexData(indexData)
{}
std::shared_ptr<zim::writer::IndexData> getIndexData() const { return mp_indexData; }
private:
std::shared_ptr<zim::writer::IndexData> mp_indexData;
};
#if defined(ENABLE_XAPIAN)
TEST(IndexCriteria, defaultIndexingBaseOnMimeType)
{
TempZimArchive tza("testZim");
zim::writer::Creator creator;
creator.configIndexing(true, "en");
creator.startZimCreation(tza.getPath());
creator.addItem(
std::make_shared<TestItem>("HtmlTestPath", "text/html", "Test Article", "This is a test article")
);
creator.addItem(
std::make_shared<TestItem>("OtherTestPath", "text/plain", "Test Article", "This is a test article")
);
creator.finishZimCreation();
zim::Archive archive(tza.getPath());
zim::Searcher searcher(archive);
zim::Query query("test article");
auto search = searcher.search(query);
ASSERT_EQ(1, search.getEstimatedMatches());
auto result = search.getResults(0, archive.getEntryCount());
auto begin = result.begin();
ASSERT_EQ(begin.getPath(), "HtmlTestPath");
ASSERT_EQ(++begin, result.end());
}
TEST(IndexCriteria, specificIndexData)
{
TempZimArchive tza("testZim");
zim::writer::Creator creator;
creator.configIndexing(true, "en");
creator.startZimCreation(tza.getPath());
// Html content is indexed by default
creator.addItem(
std::make_shared<TestItem>("HtmlTestPath", "text/html", "Test Article", "This is a test article")
);
// Non html content is not indexed by default
creator.addItem(
std::make_shared<TestItem>("OtherTestPath", "text/plain", "Test Article", "This is a test article")
);
// Item without a IndexData is not indexed
creator.addItem(
std::make_shared<IndexDataItem>("HtmlTestPathNull", "text/html", "Test Article", "This is a test article", nullptr)
);
// Item with a IndexData but without data is not indexed
creator.addItem(
std::make_shared<IndexDataItem>("HtmlTestPathNodata", "text/html", "Test Article", "This is a test article",
std::make_shared<TestIndexData>(""))
);
// We index the content with the data of the indexdata if provided
creator.addItem(
std::make_shared<IndexDataItem>("OtherTestPathWithIndex", "text/plain", "Test Article", "This is content",
std::make_shared<TestIndexData>("test article"))
);
creator.finishZimCreation();
zim::Archive archive(tza.getPath());
zim::Searcher searcher(archive);
zim::Query query("test article");
auto search = searcher.search(query);
ASSERT_EQ(2, search.getEstimatedMatches());
auto result = search.getResults(0, archive.getEntryCount());
auto begin = result.begin();
ASSERT_EQ(begin.getPath(), "HtmlTestPath");
begin++;
ASSERT_EQ(begin.getPath(), "OtherTestPathWithIndex");
ASSERT_EQ(++begin, result.end());
}
#endif // ENABLE_XAPIAN
TEST(IndexCriteria, suggestion) {
TempZimArchive tza("testZim");
zim::writer::Creator creator;
creator.startZimCreation(tza.getPath());
// Default html is title indexed
creator.addItem(
std::make_shared<TestItem>("HtmlTestPath", "text/html", "Test Article", "This is a test article")
);
// Default not html is not title indexed
creator.addItem(
std::make_shared<TestItem>("OtherTestPath", "text/plain", "Test Article", "This is a test article")
);
// Default redirection is not indexed (even if pointing to html content)
creator.addRedirection("Aredirect", "Test Article Redirection", "HtmlTestPath");
// We can force a html content to not be title indexed
creator.addItem(
std::make_shared<TestItem>("HtmlTestPathForced", "text/html", "Test Article", "This is a test article", IsFrontArticle::NO)
);
// Default not html is not title indexed
creator.addItem(
std::make_shared<TestItem>("OtherTestPathForced", "text/plain", "Test Article", "This is a test article", IsFrontArticle::YES)
);
// Redirection need to point to something not already indexed.
// As we collapse the suggestion by target path, if we have a redirection to a indexed entry,
// the suggestion result will contain only one of them.
creator.addRedirection("AredirectForced", "Test Article Redirection", "OtherTestPath", {{zim::writer::FRONT_ARTICLE, 1}});
creator.finishZimCreation();
zim::Archive archive(tza.getPath());
zim::SuggestionSearcher suggestionSearcher(archive);
auto suggestion = suggestionSearcher.suggest("Test Article");
ASSERT_EQ(3, suggestion.getEstimatedMatches());
auto result = suggestion.getResults(0, archive.getEntryCount());
auto begin = result.begin();
ASSERT_EQ(begin->getPath(), "HtmlTestPath");
begin++;
ASSERT_EQ(begin->getPath(), "OtherTestPathForced");
begin++;
ASSERT_EQ(begin->getPath(), "AredirectForced");
ASSERT_EQ(++begin, result.end());
}
} // unnamed namespace
|
