Changes between Version 3 and Version 4 of SearchAttachmentsPlugin

Timestamp:

May 9, 2007, 10:10:57 AM (17 years ago)

Author:

deltroo

Comment:

--

SearchAttachmentsPlugin

@@ -1 @@
-= Search wiki and ticket attachments (.pdf, .doc,.ppt,...) =
+= SEAT plugin: SEarch wiki and ticket ATtachments =
 
 == Description ==
 
-This plugin allows text integral search in attachments.
- * adds a new '''Attachments''' source to the search page
- * presents an excerpt of the documents in the result page
- * supports any format with a command line tool for plain text conversion (filter command)
+This plugin allows text integral search in wiki and ticket attachments (.pdf, .doc,.ppt,...).
+The SEAT plugin has the following features:
+ * new '''Attachments''' source to the search page
+ * an excerpt of the matching documents is presented in the result page
+ * any format is supported as long as there is a command line tool for plain text conversion (filter command)
 
 == Bugs/Feature Requests == 
@@ -24 +25 @@
 You can check out SearchAttachmentsPlugin from [http://trac-hacks.org/svn/searchattachmentsplugin here] using Subversion, or [source:searchattachmentsplugin browse the source] with Trac.
 
-== Example ==
+==   How to install?   ==
+
+  * Install swish-e, http://swish-e.org/
+
+  * Install filter tools for the formats you want to index, for instance
+    * `catdoc` and `catppt`, http://www.45.free.net/~vitus/software/catdoc/
+    * `pdftotext`, http://www.foolabs.com/xpdf/
+
+  * Download the plugin from xxxx
+
+  * Install the plugin
+{{{
+    python set-up bdist_egg
+    cp searchattachmpents.egg YOUR_TRAC_ENV/plugins
+}}}
+
+  * Configure the [attachment] section of trac.ini
 
 `[components]`[[BR]]
@@ -42 +59 @@
 
 
+  There is no need to declare a filter command for .txt or .text. Text files are handled
+  natively. To index a new non-text format, just add a filter.* entry using the appropriate
+  command line tool for this format.
+{{{
+   filter.myEXT = my_command -infile "%s" -outfile "%s"
+}}}
+
+  * Trac 10.x and 11.x source code must be manually modified for SEAT plugin to work.
+    The file to modify is '''attachment.py'''. On a Linux Fedora system, it is located in
+    /usr/lib/python2.4/site-packages/trac
+
+{{{
+
+162     def insert(self, filename, fileobj, size, t=None, db=None):
+...
+...
+184         try:
+185             # Note: `path` is an unicode string because `self.path` was one.
+186             # As it contains only quoted chars and numbers, we can use `ascii`
+187             basename = os.path.basename(path).encode('ascii')
+188             filename = unicode_unquote(basename)
+189
+190             cursor = db.cursor()
+191             cursor.execute("INSERT INTO attachment "
+192                            "VALUES (%s,%s,%s,%s,%s,%s,%s,%s)",
+193                            (self.parent_type, self.parent_id, filename,
+194                             self.size, self.time, self.description, self.author,
+195                             self.ipnr))
+196             shutil.copyfileobj(fileobj, targetfile)
+197             self.filename = filename
+198
+199             self.env.log.info('New attachment: %s by %s', self.title,
+200                               self.author)
+201
+202             if handle_ta:
+203                 db.commit()
+204
+   205             targetfile.close() # << Line to add for SEAT plugin
+206
+207             for listener in AttachmentModule(self.env).change_listeners:
+208                 listener.attachment_added(self)
+209         finally:
+210             targetfile.close()
+
+}}}
+
+
+  * Add the trac-seat utility to your path. For instance, copy trac-seat to /usr/local/bin.
+  * Use trac-seat to convert existing attachments to text files and index these.
+{{{
+trac-seat /path/to/your/env meta
+trac-seat /path/to/your/env index -c
+}}}
+
+  * '''restart''' the trac server ( /etc/init.d/httpd restart)
+
+
 == Recent Changes ==