SC 289, small, but non-exploitable hole in backup permissions checking. Merged from...
[moodle.git] / search / README.txt
b585dc5f 12006/07/25
3Query logic moved into the SearchQuery class in querylib.php. Should be able
4to include this file in any page and run a query against the index (PHP 5
5checks must be added to those pages then, though).
7Index info can be retrieved using IndexInfo class in indexlib.php.
9Abstracted some stuff away, to reduce rendundancy and decrease the
10likelihood of errors. Improved the stats.php page to include some
11diagnostics for adminstrators.
13delete.php skeleton created for removing deleted documents from the
14index. cron.php will contain the logic for running delete.php,
15update.php and eventually add.php.
a25a3912 172006/07/11
19(Warning: It took me 1900 seconds to index the forum, go make coffee
b585dc5f 20whilst you wait.) [ forum data]
a25a3912 21
22Forum search functions changed to use 'get_recordset' instead of
23'get_records', for speed reasons. This provides a significant improvement,
24but indexing is still slow - getting data from the database and Zend's
25tokenising _seem_ to be the prime suspects at the moment.
27/search/tests/ added - index.php can be used to see which modules are
28ready to be included in the search index, and it informs you of any
29errors - should be a prerequisite for indexing.
31Search result pagination added to query.php, will default to 20 until
32an admin page for the search module is written.
36Search-enabling functions moved out've the mod's lib.php files and into
37/search/documents/mod_document.php - this requires the search module to
38operate without requiring modification of lib files.
40SearchDocument base class improved, and the way module documents extend
41it. A custom-data field has been added to allow modules to add any custom
42data they wish to be stored in the index - this field is serialised into
43the index as a binary field.
45Database field 'type' renamed to 'doctype' to match the renaming in the
46index, 'type' seems to be a reserved word in Lucene. Several index field
47names change to be more descriptive (cid -> course_id). URLs are now
48stored in the index, and don't have to be generated on the fly during
49display of query results.
abb4ea20 52------
53Started cleaning and standardising things.
55cvs v1.1
682d4032 57This is the initial release (prototype) of Moodle's new search module -
58so basically watch out for sharp edges.
60The structure has not been finalised, but this is what is working at the
61moment, when I start looking at other content to index, it will most likely
62change. I don't recommend trying to make your own content modules indexable,
63at least not until the whole flow is finalised. I will be implementing the
64functions needed to index all of the default content modules on Moodle, so
65expect that around mid-August.
67Wiki pages were my goal for this release, they can be indexed and searched,
68but not updated or deleted at this stage (was waiting for ZF 0.14 actually).
70I need to check the PostgreSQL sql file, I don't have a PG7 install lying
71around to test on, so the script is untested.
73To index for the first time, login as an admin user and browse to /search/index.php
74or /search/stats.php - there will be a message and a link telling you to go index.
76-- Michael Champanis (mchampan)
78 Summer of Code 2006