From Mahara Wiki
< Proposals | DoneRevision as of 16:43, 11 July 2020 by Anitsirk (Anitsirk moved page Developer Area/Specifications in Development/Done/Search 2.0 to Proposals/Done/Search 2.0: Shorter navigation, not always technical)
This is a proposal for improving the search experience in Mahara. It covers searching for users, groups and pages (views).
There are a few elements in here which aren't directly related to search but that are designed to provide more metadata and therefore improve the quality of searches.
Full text search
The main goal of this work is to add a universal search box to the home page which will search in:
- forums (title & description)
- forum threads (contents)
- views (title, description, tags)
- artefacts (tags, content)
- users (firstname, lastname, email)
- groups (name and description)
Note that searches will not pick up the content of blocks (e.g. Google Apps block, external feed block, etc.).
The universal search box will be done in a dashboard block. It can be removed by users but it's also visible for logged out users.
By default, it will appear above the "popular pages showcase" block, once that block is in core.
The types of results you will get depend on the search plugin you have enabled. For example, there will be no full text search in the content of artefacts if using the internal plugin.
Search result page
The page will also use facets so that users can easily hide results in the categories they don't want to see (e.g. hiding the user account and group matches).
Clicking on a result will take you as close as possible to the result. For example, if an artefact matches one of the search terms, then clicking on that result will take you to the artefact page (which has a link back to the containing view) if it exists.
New parameter on paginated artefact pages
For artefact pages that are displayed using the pager (e.g. blog, blogpost, feedback, plans), we'll need to add a new query string parameter to tell the pager to display a particular page. This will allow us to link to the right page from the search result page.
Mahara will only show results that a user is allowed to see. This means for example that the logged out page will only show content from public views and groups.
Otherwise, We will implement the access control checks in one of the following two ways:
- We will use the existing SQL queries to get a list of all of the view IDs that the current user has access to. Then we will query elasticsearch with a restriction on these view IDs. Should the SQL turn out to be too slow, we will cache that list for a certain period of time with the understanding that some content might be missing from the results or that some of the results returned may no longer be accessible.
- We will mirror the access control table inside the elasticsearch data structures and make sure that anything in Mahara that changes the database table gets refactored to use a function which updates both the database and the search server. The downside of this approach is that we will duplicate the data and that we will also duplicate the "query".
- documentation on how to setup elastic search will be provided
- Mahara will perform some sanity checks on your elastic search configuration to make sure everything is setup right (and display appropriate warnings if it's not)
- some debugging information will be available, along with a manual "reindex" button
The elasticsearch plugin will inherit from internal search and may in the future override methods that it can implement faster.
In order to get the universal search working, we'll add new methods to the internal search plugin which will only be implemented in elasticsearch. Search plugin writers may choose to implement them in their own plugins, but internal search is not going to have an implementation for it.
Thanks to the existing search plugins, we already have a few hooks in Mahara that can be used to trigger the reindexing of some of the content.
We will be adding more hooks, for example to detect changes in the contents of artefacts.
Other things that we could improve later but that are out of scope at the moment:
- making sure there's only ever 1 search box per page (usability issue)
- migrating all slow searches to elasticsearch (while retaining the implementation in internal)
- search inside the contents of uploaded files (e.g. PDF, ODF, Word documents, text files)