6 # This index implementation uses Xapian for searching and GDBM for storage. It
7 # tends to be slightly faster than Ferret for indexing and significantly faster
8 # for searching due to precomputing thread membership.
9 class XapianIndex < BaseIndex
10 STEM_LANGUAGE = "english"
13 ## dates are converted to integers for xapian, and are used for document ids,
14 ## so we must ensure they're reasonably valid. this typically only affect
17 MAX_DATE = Time.at(2**31-1)
19 HookManager.register "custom-search", <<EOS
20 Executes before a string search is applied to the index,
21 returning a new search string.
23 subs: The string being searched.
26 def initialize dir=BASE_DIR
29 @index_mutex = Monitor.new
33 path = File.join(@dir, 'xapian')
35 @xapian = Xapian::WritableDatabase.new(path, Xapian::DB_OPEN)
36 db_version = @xapian.get_metadata 'version'
37 db_version = '0' if db_version.empty?
38 if db_version != INDEX_VERSION
39 fail "This Sup version expects a v#{INDEX_VERSION} index, but you have an existing v#{db_version} index. Please downgrade to your previous version and dump your labels before upgrading to this version (then run sup-sync --restore)."
42 @xapian = Xapian::WritableDatabase.new(path, Xapian::DB_CREATE)
43 @xapian.set_metadata 'version', INDEX_VERSION
45 @term_generator = Xapian::TermGenerator.new()
46 @term_generator.stemmer = Xapian::Stem.new(STEM_LANGUAGE)
47 @enquire = Xapian::Enquire.new @xapian
48 @enquire.weighting_scheme = Xapian::BoolWeight.new
49 @enquire.docid_order = Xapian::Enquire::ASCENDING
59 synchronize { @xapian.doccount }
63 synchronize { find_docid(id) && true }
67 synchronize { get_entry(id)[:source_id] }
71 synchronize { @xapian.delete_document mkterm(:msgid, id) }
75 entry = synchronize { get_entry id }
78 source = SourceManager[entry[:source_id]]
79 raise "invalid source #{entry[:source_id]}" unless source
81 m = Message.new :source => source, :source_info => entry[:source_info],
82 :labels => entry[:labels], :snippet => entry[:snippet]
84 mk_person = lambda { |x| Person.new(*x.reverse!) }
85 entry[:from] = mk_person[entry[:from]]
86 entry[:to].map!(&mk_person)
87 entry[:cc].map!(&mk_person)
88 entry[:bcc].map!(&mk_person)
90 m.load_from_index! entry
94 def add_message m; sync_message m end
95 def update_message m; sync_message m end
96 def update_message_state m; sync_message m end
98 def sync_message m, opts={}
99 entry = synchronize { get_entry m.id }
103 entry = {} if opts[:force_overwrite]
107 :source_id => m.source.id,
108 :source_info => m.source_info,
109 :date => (entry[:date] || m.date),
112 :from => (entry[:from] || [m.from.email, m.from.name]),
113 :to => (entry[:to] || m.to.map { |p| [p.email, p.name] }),
114 :cc => (entry[:cc] || m.cc.map { |p| [p.email, p.name] }),
115 :bcc => (entry[:bcc] || m.bcc.map { |p| [p.email, p.name] }),
117 :refs => (entry[:refs] || m.refs),
118 :replytos => (entry[:replytos] || m.replytos),
121 labels.each { |l| LabelManager << l }
124 index_message m, d, opts
128 private :sync_message
130 def num_results_for query={}
131 xapian_query = build_xapian_query query
132 matchset = run_query xapian_query, 0, 0, 100
133 matchset.matches_estimated
141 xapian_query = build_xapian_query query
143 ids = run_query_ids xapian_query, offset, (offset+page)
144 ids.each { |id| yield id }
145 break if ids.size < page
150 def each_id_by_date query={}
151 each_id(query) { |id| yield id, lambda { build_message id } }
154 def each_message_in_thread_for m, opts={}
155 # TODO thread by subject
156 # TODO handle killed threads
157 return unless doc = find_doc(m.id)
158 queue = doc.value(THREAD_VALUENO).split(',')
160 seen_threads = Set.new
161 seen_messages = Set.new [m.id]
162 while not queue.empty?
163 thread_id = queue.pop
164 next if seen_threads.member? thread_id
165 return false if thread_killed? thread_id
166 seen_threads << thread_id
167 docs = term_docids(mkterm(:thread, thread_id)).map { |x| @xapian.document x }
169 msgid = doc.value MSGID_VALUENO
170 next if seen_messages.member? msgid
172 seen_messages << msgid
173 queue.concat doc.value(THREAD_VALUENO).split(',')
176 msgids.each { |id| yield id, lambda { build_message id } }
180 def load_contacts emails, opts={}
182 num = opts[:num] || 20
183 each_id_by_date :participants => emails do |id,b|
184 break if contacts.size >= num
186 ([m.from]+m.to+m.cc+m.bcc).compact.each { |p| contacts << [p.name, p.email] }
188 contacts.to_a.compact.map { |n,e| Person.new n, e }[0...num]
191 # TODO share code with the Ferret index
195 subs = HookManager.run("custom-search", :subs => s) || s
196 subs = subs.gsub(/\b(to|from):(\S+)\b/) do
198 if(p = ContactManager.contact_for(name))
201 [field, "(" + AccountManager.user_emails.join("||") + ")"]
207 ## if we see a label:deleted or a label:spam term anywhere in the query
208 ## string, we set the extra load_spam or load_deleted options to true.
209 ## bizarre? well, because the query allows arbitrary parenthesized boolean
210 ## expressions, without fully parsing the query, we can't tell whether
211 ## the user is explicitly directing us to search spam messages or not.
212 ## e.g. if the string is -(-(-(-(-label:spam)))), does the user want to
213 ## search spam messages or not?
215 ## so, we rely on the fact that turning these extra options ON turns OFF
216 ## the adding of "-label:deleted" or "-label:spam" terms at the very
217 ## final stage of query processing. if the user wants to search spam
218 ## messages, not adding that is the right thing; if he doesn't want to
219 ## search spam messages, then not adding it won't have any effect.
220 query[:load_spam] = true if subs =~ /\blabel:spam\b/
221 query[:load_deleted] = true if subs =~ /\blabel:deleted\b/
223 ## gmail style "is" operator
224 subs = subs.gsub(/\b(is|has):(\S+)\b/) do
225 field, label = $1, $2
230 query[:load_spam] = true
233 query[:load_deleted] = true
240 ## gmail style attachments "filename" and "filetype" searches
241 subs = subs.gsub(/\b(filename|filetype):(\((.+?)\)\B|(\S+)\b)/) do
242 field, name = $1, ($3 || $4)
245 debug "filename: translated #{field}:#{name} to attachment:\"#{name.downcase}\""
246 "attachment:\"#{name.downcase}\""
248 debug "filetype: translated #{field}:#{name} to attachment_extension:#{name.downcase}"
249 "attachment_extension:#{name.downcase}"
256 subs = subs.gsub(/\b(before|on|in|during|after):(\((.+?)\)\B|(\S+)\b)/) do
257 field, datestr = $1, ($3 || $4)
258 realdate = Chronic.parse datestr, :guess => false, :context => :past
262 debug "chronic: translated #{field}:#{datestr} to #{realdate.end}"
263 "date:#{realdate.end.to_i}..#{lastdate}"
265 debug "chronic: translated #{field}:#{datestr} to #{realdate.begin}"
266 "date:#{firstdate}..#{realdate.end.to_i}"
268 debug "chronic: translated #{field}:#{datestr} to #{realdate}"
269 "date:#{realdate.begin.to_i}..#{realdate.end.to_i}"
272 raise ParseError, "can't understand date #{datestr.inspect}"
277 ## limit:42 restrict the search to 42 results
278 subs = subs.gsub(/\blimit:(\S+)\b/) do
281 query[:limit] = lim.to_i
284 raise ParseError, "non-numeric limit #{lim.inspect}"
288 qp = Xapian::QueryParser.new
289 qp.database = @xapian
290 qp.stemmer = Xapian::Stem.new(STEM_LANGUAGE)
291 qp.stemming_strategy = Xapian::QueryParser::STEM_SOME
292 qp.default_op = Xapian::Query::OP_AND
293 qp.add_valuerangeprocessor(Xapian::NumberValueRangeProcessor.new(DATE_VALUENO, 'date:', true))
294 NORMAL_PREFIX.each { |k,v| qp.add_prefix k, v }
295 BOOLEAN_PREFIX.each { |k,v| qp.add_boolean_prefix k, v }
296 xapian_query = qp.parse_query(subs, Xapian::QueryParser::FLAG_PHRASE|Xapian::QueryParser::FLAG_BOOLEAN|Xapian::QueryParser::FLAG_LOVEHATE|Xapian::QueryParser::FLAG_WILDCARD, PREFIX['body'])
298 raise ParseError if xapian_query.nil? or xapian_query.empty?
299 query[:qobj] = xapian_query
319 'from_email' => 'FE',
325 'attachment_extension' => 'O',
331 PREFIX = NORMAL_PREFIX.merge BOOLEAN_PREFIX
337 MAX_TERM_LENGTH = 245
339 # Xapian can very efficiently sort in ascending docid order. Sup always wants
340 # to sort by descending date, so this method maps between them. In order to
341 # handle multiple messages per second, we use a logistic curve centered
342 # around MIDDLE_DATE so that the slope (docid/s) is greatest in this time
343 # period. A docid collision is not an error - the code will pick the next
344 # smallest unused one.
345 DOCID_SCALE = 2.0**32
347 MIDDLE_DATE = Time.gm(2011)
348 def assign_docid m, truncated_date
349 t = (truncated_date.to_i - MIDDLE_DATE.to_i).to_f
350 docid = (DOCID_SCALE - DOCID_SCALE/(Math::E**(-(t/TIME_SCALE)) + 1)).to_i
351 while docid > 0 and docid_exists? docid
354 docid > 0 ? docid : nil
357 # XXX is there a better way?
358 def docid_exists? docid
360 @xapian.doclength docid
362 rescue RuntimeError #Xapian::DocNotFoundError
363 raise unless $!.message =~ /DocNotFoundError/
369 @xapian.postlist(term).map { |x| x.docid }
373 docids = term_docids(mkterm(:msgid,id))
374 fail unless docids.size <= 1
379 return unless docid = find_docid(id)
380 @xapian.document docid
384 return unless doc = @xapian.document(docid)
385 doc.value MSGID_VALUENO
389 return unless doc = find_doc(id)
390 Marshal.load doc.data
393 def thread_killed? thread_id
394 not run_query(Q.new(Q::OP_AND, mkterm(:thread, thread_id), mkterm(:label, :Killed)), 0, 1).empty?
398 @index_mutex.synchronize &b
401 def run_query xapian_query, offset, limit, checkatleast=0
403 @enquire.query = xapian_query
404 @enquire.mset(offset, limit-offset, checkatleast)
408 def run_query_ids xapian_query, offset, limit
409 matchset = run_query xapian_query, offset, limit
410 matchset.matches.map { |r| r.document.value MSGID_VALUENO }
414 def build_xapian_query opts
415 labels = ([opts[:label]] + (opts[:labels] || [])).compact
416 neglabels = [:spam, :deleted, :killed].reject { |l| (labels.include? l) || opts.member?("load_#{l}".intern) }
417 pos_terms, neg_terms = [], []
419 pos_terms << mkterm(:type, 'mail')
420 pos_terms.concat(labels.map { |l| mkterm(:label,l) })
421 pos_terms << opts[:qobj] if opts[:qobj]
422 pos_terms << mkterm(:source_id, opts[:source_id]) if opts[:source_id]
424 if opts[:participants]
425 participant_terms = opts[:participants].map { |p| mkterm(:email,:any, (Redwood::Person === p) ? p.email : p) }
426 pos_terms << Q.new(Q::OP_OR, participant_terms)
429 neg_terms.concat(neglabels.map { |l| mkterm(:label,l) })
431 pos_query = Q.new(Q::OP_AND, pos_terms)
432 neg_query = Q.new(Q::OP_OR, neg_terms)
437 Q.new(Q::OP_AND_NOT, [pos_query, neg_query])
441 def index_message m, entry, opts
445 subject_text = m.indexable_subject
446 body_text = m.indexable_body
448 # Person names are indexed with several prefixes
449 person_termer = lambda do |d|
451 ["#{d}_name", "name", "body"].each do |x|
452 text << [p.name, PREFIX[x]]
454 [d, :any].each { |x| terms << mkterm(:email, x, p.email) }
458 person_termer[:from][m.from] if m.from
459 (m.to+m.cc+m.bcc).each(&(person_termer[:to]))
461 terms << mkterm(:date,m.date) if m.date
462 m.labels.each { |t| terms << mkterm(:label,t) }
463 terms << mkterm(:type, 'mail')
464 terms << mkterm(:msgid, m.id)
465 terms << mkterm(:source_id, m.source.id)
466 m.attachments.each do |a|
467 a =~ /\.(\w+)$/ or next
468 t = mkterm(:attachment_extension, $1)
473 children = term_docids(mkterm(:ref, m.id)).map { |docid| @xapian.document docid }
474 parent_ids = m.refs + m.replytos
475 parents = parent_ids.map { |id| find_doc id }.compact
476 thread_members = SavingHash.new { [] }
477 (children + parents).each do |doc2|
478 thread_ids = doc2.value(THREAD_VALUENO).split ','
479 thread_ids.each { |thread_id| thread_members[thread_id] << doc2 }
482 thread_ids = thread_members.empty? ? [m.id] : thread_members.keys
484 thread_ids.each { |thread_id| terms << mkterm(:thread, thread_id) }
485 parent_ids.each do |ref|
486 terms << mkterm(:ref, ref)
489 # Full text search content
490 text << [subject_text, PREFIX['subject']]
491 text << [subject_text, PREFIX['body']]
492 text << [body_text, PREFIX['body']]
493 m.attachments.each { |a| text << [a, PREFIX['attachment']] }
495 truncated_date = if m.date < MIN_DATE
496 debug "warning: adjusting too-low date #{m.date} for indexing"
498 elsif m.date > MAX_DATE
499 debug "warning: adjusting too-high date #{m.date} for indexing"
505 # Date value for range queries
507 Xapian.sortable_serialise truncated_date.to_i
509 Xapian.sortable_serialise 0
513 unless doc = find_doc(m.id)
514 doc = Xapian::Document.new
515 if not docid = assign_docid(m, truncated_date)
516 # Could be triggered by spam
517 Redwood::log "warning: docid underflow, dropping #{m.id.inspect}"
526 @term_generator.document = doc
527 text.each { |text,prefix| @term_generator.index_text text, 1, prefix }
528 terms.each { |term| doc.add_term term if term.length <= MAX_TERM_LENGTH }
529 doc.add_value MSGID_VALUENO, m.id
530 doc.add_value THREAD_VALUENO, (thread_ids * ',')
531 doc.add_value DATE_VALUENO, date_value
532 doc.data = Marshal.dump entry
534 @xapian.replace_document docid, doc
537 # Construct a Xapian term
538 def mkterm type, *args
541 PREFIX['label'] + args[0].to_s.downcase
543 PREFIX['type'] + args[0].to_s.downcase
545 PREFIX['date'] + args[0].getutc.strftime("%Y%m%d%H%M%S")
548 when :from then PREFIX['from_email']
549 when :to then PREFIX['to_email']
550 when :any then PREFIX['email']
551 else raise "Invalid email term type #{args[0]}"
552 end + args[1].to_s.downcase
554 PREFIX['source_id'] + args[0].to_s.downcase
555 when :attachment_extension
556 PREFIX['attachment_extension'] + args[0].to_s.downcase
557 when :msgid, :ref, :thread
558 PREFIX[type.to_s] + args[0][0...(MAX_TERM_LENGTH-1)]
560 raise "Invalid term type #{type}"