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
|
//
// FilterDocbook.cs
//
// Copyright (C) 2005 Novell, Inc.
//
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
using System;
using System.IO;
using System.Xml;
using System.Text;
using System.Collections;
using Beagle.Util;
using Beagle.Daemon;
namespace Beagle.Filters
{
public class FilterDocbook : Filter
{
protected XmlTextReader reader;
protected string base_path;
protected string base_title;
protected string base_language;
protected Stack entries_stack = new Stack ();
protected class DocbookEntry {
public string Id = null;
public string Title = null;
public string Language = null;
public int Depth = -1;
public StringBuilder Content = new StringBuilder ();
}
//////////////////////////////////////////////////
public FilterDocbook ()
{
SnippetMode = false;
SetVersion (4);
AddSupportedFlavor (FilterFlavor.NewFromMimeType ("application/docbook+xml"));
AddSupportedFlavor (FilterFlavor.NewFromExtension (".docbook"));
// FIXME: Uri/Extension mapping?
AddSupportedFlavor (new FilterFlavor ("file:///usr/share/doc/*", ".xml", null, 0));
}
///////////////////////////////////////////////////
override protected void DoOpen (FileInfo info)
{
base_path = info.FullName;
reader = new XmlTextReader (Stream);
reader.XmlResolver = null;
}
override protected void DoPullProperties ()
{
Stopwatch watch = new Stopwatch ();
watch.Start ();
while (reader.Read ()) {
switch (reader.NodeType) {
case XmlNodeType.Element:
if (reader.Name.StartsWith ("sect") || reader.Name.StartsWith ("chapter")) {
string id = reader.GetAttribute ("id");
if (id != null && id != "") {
DocbookEntry entry = new DocbookEntry ();
entry.Id = id;
entry.Depth = reader.Depth;
string language = reader.GetAttribute ("lang");
if (language != null && language != "")
entry.Language = language;
entries_stack.Push (entry);
}
} else if (reader.Name == "article" || reader.Name == "book") {
string language = reader.GetAttribute ("lang");
if (language != null && language != "")
base_language = language;
} else if (reader.Name == "title") {
reader.Read (); // Go to the text node
if (entries_stack.Count == 0 && base_title == null) {
// This is probably the book title
base_title = reader.Value;
} else if (entries_stack.Count > 0) {
DocbookEntry entry = (DocbookEntry) entries_stack.Peek ();
if (entry.Title == null)
entry.Title = reader.Value;
}
}
break;
case XmlNodeType.Text:
// Append text to the child indexable
if (entries_stack.Count > 0)
((DocbookEntry) entries_stack.Peek ()).Content.Append (reader.Value);
// Append text to the main indexable
AppendText (reader.Value);
break;
case XmlNodeType.EndElement:
if (entries_stack.Count > 0 && ((DocbookEntry) entries_stack.Peek ()).Depth == reader.Depth) {
DocbookEntry entry, parent_entry = null;
entry = (DocbookEntry) entries_stack.Pop ();
if (entries_stack.Count > 0)
parent_entry = (DocbookEntry) entries_stack.Peek ();
Indexable indexable = new Indexable (UriFu.PathToFileUri (String.Format ("{0}#{1}", base_path, entry.Id)));
indexable.HitType = "DocbookEntry";
indexable.MimeType = "text/x-docbook-entry";
indexable.Filtering = IndexableFiltering.AlreadyFiltered;
indexable.AddProperty (Property.NewUnsearched ("fixme:id", entry.Id));
if (entry.Title != null)
indexable.AddProperty (Property.New ("dc:title", entry.Title));
// Add the docbook book title
if (base_title != null)
indexable.AddProperty (Property.NewUnsearched ("fixme:base_title", base_title));
// Add the child language (or docbook language if none is specified)
if (entry.Language != null)
indexable.AddProperty (Property.NewUnsearched ("fixme:language", entry.Language));
else if (base_language != null)
indexable.AddProperty (Property.NewUnsearched ("fixme:language", base_language));
// Add any parent (as in docbook parent entry, not beagle) data if we have it
if (parent_entry != null) {
indexable.AddProperty (Property.NewUnsearched ("fixme:parent_id", parent_entry.Id));
if (parent_entry.Title != null)
indexable.AddProperty (Property.NewUnsearched ("fixme:parent_title", parent_entry.Title));
}
StringReader content_reader = new StringReader (entry.Content.ToString ());
indexable.SetTextReader (content_reader);
AddChildIndexable (indexable);
}
break;
}
}
// Add the common properties to the top-level
// file item such as Title, Language etc.
if (base_title != null)
AddProperty (Property.New ("dc:title", base_title));
if (base_language != null)
AddProperty (Property.NewUnsearched ("fixme:language", base_language));
watch.Stop ();
// If we've successfully crawled the file but haven't
// found any indexables, we shouldn't consider it
// successfull at all (unless we have a title, which
// means that it's actually a docbook file, just without
// sections.
if (ChildIndexables.Count == 0 && base_title == null) {
Error ();
return;
}
Logger.Log.Debug ("Parsed docbook file in {0}", watch);
Finished ();
}
}
}
|
