MDL-11719 increased size of idnumber in user table - needed for some enrolment plugin...
[moodle.git] / search / README.txt
CommitLineData
0d46c846 12006/09/08
2----------
3Google Summer of Code is finished, spent a couple of weeks away from
4the project to think about it and also to take a break. Working on it
5now I discovered bugs in the query parser (now fixed), and I also
6un-convoluted the querylib logic (well slighlty).
7
8Updated ZFS files to latest SVN.
9
791a4cec 102006/08/21
11----------
12Fixed index document count, and created new config variable to store
13the size. (Search now has 3 global vars in $CFG, date, size and complete,
14see indexer.php for var names). Index size is cached to provide an always
15current value for the index - this is to take into account the fact that
16deleted documents are in fact not removed from the index, but instead just
17marked as deleted and not returned in search results. The actual document
18still features in the index, and skews sizes. When the index optimiser is
eef868d1 19completed in ZFS, then these deleted documents will be pruned, thus
791a4cec 20correctly modifying the index size.
21
22Additional commenting added.
23
24Query page logic very slightly modified to clean up GET string a bit (removed
25'p' variable).
26
27Add/delete functions added to other document types.
28
29A few TODO fields added to source, indicating changes still to come (or at
30least to be considered).
31
6f1b1da1 322006/08/16
33----------
34Add/delete/update cron functions finished - can be called seperately
35or all at once via cron.php.
36
37Document date field added to index and database summary.
38
39Some index db functionality abstracted out to indexlib.php - can
40use IndexDBControl class to add/del documents from database, and
41to make sure the db table is functioning.
42
43DB sql files changed to add some extra fields.
44
45Default 'simple' query modified to search title and author, as well
46as contents of document, to provide better results for users.
47
6e780562 482006/08/14
49----------
50First revision of the advanced search page completed. Functional,
51but needs a date search field still.
52
532006/08/02
54----------
55Added resource search type, and the ability to specify custom 'virtual'
56models to search - allowing for non-module specific information to be
57indexed. Specify the extra search types to use in lib.php.
58
592006/07/28
60----------
61Added delete logic to documents; the moodle database log is checked
62and any found delete events are used to remove the referenced documents
63from the database table and search index.
64
65Added database table name constant to lib.php, must change files using
66the static table name.
67
68Changed documents to use 'docid' instead of 'id' to reference the moodle
69instance id, since Zend Search adds it's own internal 'id' field. Noticed
70this whilst working on deletions.
71
72Added some additional fields to the permissions checking method, must still
73implement it though.
74
b585dc5f 752006/07/25
76----------
77Query logic moved into the SearchQuery class in querylib.php. Should be able
78to include this file in any page and run a query against the index (PHP 5
79checks must be added to those pages then, though).
80
81Index info can be retrieved using IndexInfo class in indexlib.php.
82
83Abstracted some stuff away, to reduce rendundancy and decrease the
84likelihood of errors. Improved the stats.php page to include some
85diagnostics for adminstrators.
86
87delete.php skeleton created for removing deleted documents from the
88index. cron.php will contain the logic for running delete.php,
89update.php and eventually add.php.
90
a25a3912 912006/07/11
92----------
93(Warning: It took me 1900 seconds to index the forum, go make coffee
b585dc5f 94whilst you wait.) [Moodle.org forum data]
a25a3912 95
96Forum search functions changed to use 'get_recordset' instead of
97'get_records', for speed reasons. This provides a significant improvement,
98but indexing is still slow - getting data from the database and Zend's
99tokenising _seem_ to be the prime suspects at the moment.
100
101/search/tests/ added - index.php can be used to see which modules are
102ready to be included in the search index, and it informs you of any
103errors - should be a prerequisite for indexing.
104
105Search result pagination added to query.php, will default to 20 until
106an admin page for the search module is written.
107
1082006/07/07
109----------
110Search-enabling functions moved out've the mod's lib.php files and into
111/search/documents/mod_document.php - this requires the search module to
112operate without requiring modification of lib files.
113
114SearchDocument base class improved, and the way module documents extend
115it. A custom-data field has been added to allow modules to add any custom
116data they wish to be stored in the index - this field is serialised into
117the index as a binary field.
118
119Database field 'type' renamed to 'doctype' to match the renaming in the
120index, 'type' seems to be a reserved word in Lucene. Several index field
121names change to be more descriptive (cid -> course_id). URLs are now
122stored in the index, and don't have to be generated on the fly during
123display of query results.
124
1252006/07/05
abb4ea20 126------
127Started cleaning and standardising things.
128
129cvs v1.1
130--------
682d4032 131This is the initial release (prototype) of Moodle's new search module -
132so basically watch out for sharp edges.
133
134The structure has not been finalised, but this is what is working at the
135moment, when I start looking at other content to index, it will most likely
136change. I don't recommend trying to make your own content modules indexable,
137at least not until the whole flow is finalised. I will be implementing the
138functions needed to index all of the default content modules on Moodle, so
139expect that around mid-August.
140
141Wiki pages were my goal for this release, they can be indexed and searched,
142but not updated or deleted at this stage (was waiting for ZF 0.14 actually).
143
144I need to check the PostgreSQL sql file, I don't have a PG7 install lying
145around to test on, so the script is untested.
146
147To index for the first time, login as an admin user and browse to /search/index.php
148or /search/stats.php - there will be a message and a link telling you to go index.
149
150-- Michael Champanis (mchampan)
6f1b1da1 151 email: cynnical@gmail.com
152 skype: mchampan
682d4032 153 Summer of Code 2006