[[TOC]]

Allow person entities (people, groups, organisations) to save a search and be notified when the results change.

* ~~[wiki:DeveloperGuidelines/SaveSearchAndSubscription Developer Guidelines]~~
* ~~[wiki:Projects/Advanced/SaveSearch Save Search Project]~~
* ~~[wiki:Projects/Advanced/Subscription Subscription Project]~~
 
=== Overview ===
In an event of disaster, this functionality would help a lot in terms of providing information (take the example of dissemination of information related to availability of food, shelter, hospitals etc.). The project's essential capability is to disseminate information about various aspects through various means such as email/twitter/sms. Integrating this service into a Sahana Eden system will add to the platforms' capability of tackling various issues faced in emergency/disaster management.

=== Models ===
A single model for holding information about the search query and the parameters that are saved by the user. This will be in `/modules/eden/pr.py` as a component of `pr_entity`.

==== Saved Search ====
 name::
  Name of the saved search as specified by the user.
 pe_id::
  The person entity to be notified when the search results change. Defaults to the pe_id record associated with the current user account.
 query::
  The query string for the search.
 notification_format::
  Format for the notification, either a list (default), map, report, graph (this is a report).
 notification_method::
  Subscription mode, e.g., email (default), Twitter, SMS.
 notification_frequency::
  How often the search is checked for changes, e.g., never (default), every 15 minutes (not hourly?), daily, weekly and monthly.
 last_executed::
  The date and time the search was last executed by the subscription method. Set to match `modified_on` when record is first created.

==== Public Saved Searches ====
 saved_search::
  The saved search to make public.
 

=== Views ===

==== Search ====
Each search page will have a widget the user can activate to save the current search. They will be directed to a new page where they can type a name for the search.

==== Saved Search List ====
Each person entity has a component for saved searches. This page will list all searches saved for this person entity, displaying the name of the search (as defined by the user when it was saved) and the query parameters.

(The any/all option will require special extraction)

Query parameters will be displayed as human-readable definition lists, e.g.:
 Page::
  Search Organisations (?)
 Search::
  search strings
 Type::
  Any of
  * Red Cross / Red Crescent
 Sector::
  Any of
  * DRR
  * Food Security
 Home Country::
  Any of
  * New Zealand

The user will have three options for each search record:
* ''run'' executes the search
* ''edit'' allows the user to edit the saved search record
* ''delete'' deletes the saved search record

==== Saved Search Edit ====
A page to edit a saved search. The `name`, `pe_id`, `notification_format`, `notification_method` and `notification_frequency` can be changed here.

=== Workflow ===
1. User executes search
1. Activate Save Search widget
1. Redirected to Save Search add form
1. Name search
1. Request is sent to `/msg/search_notifications/`, with the first query string argument specifying what period this applies to, e.g., daily, monthly, etc.
1. Records with a `modified_on` value greater than `last_executed` are returned.
1. `last_executed` field updated to when the request was made.
1. If the pr_entity is a group, fetch the appropriate contact details from each member. Recursively?
1. Format the response for special media, e.g., Twitter, SMS.

=== Tasks ===
* Implement model
* Implement representation functions for query string
* Implement or update controllers
* Extend OAuth implementation for Twitter and Facebook to allow posting to users account.

=== Tests ===
* Save a search without any filters.
* Save a search after performing a search with filters.
* Attempt to save a search with empty name; must fail.
* Edit and save a saved search.
* Executing a search from the saved search list page.
* Sending the notification email