MDL-64417 message: allow processors to run their own cleanup tasks.
[moodle.git] / message / upgrade.txt
1 This files describes API changes in /message/ messaging system,
2 information provided here is intended especially for developers.
4 === 3.9 ===
6 * Removed the following deprecated functions:
7   - message_move_userfrom_unread2read
8   - message_get_blocked_users
9   - message_get_contacts
10   - message_mark_message_read
11   - message_can_delete_message
12   - message_delete_message
13   - mark_all_read_for_user()
14 * Message processors can implement the following methods which will be executed as part of the messaging cleanup task:
15   - cleanup_all_notifications
16   - cleanup_read_notifications
18 === 3.8 ===
20 * The following methods have been deprecated and should not be used any more:
21   - \core_message\api::get_individual_conversations_between_users()
22   - \core_message\api::can_post_message()
24 === 3.7 ===
26 * The message/index.php page used to support viewing another user's messages (if you had the right capabilities) by
27   altering the URL and adding the parameters 'user1' and 'user2'. There were only some very rare occurrences where you
28   could access a URL generated with these parameters (eg. log report). It was decided to stop supporting this
29   functionality and remove all the legacy code (see MDL-63915).
30   Note - It's still possible to view another user's messages if you have the right capabilities and are able to
31   'log-in as' them.
32 * A new parameter 'mergeself' has been added to the methods \core_message\api::get_conversations() and
33   core_message_external::get_conversations(), to decide whether the self-conversations should be included or not when the
34   private ones are requested, to display them together.
35 * A new 'customdata' field for both messages and notifications has been added. This new field can store any custom data
36   serialised using json_encode().
37   This new field can be used for storing any data not fitting in the current message structure. For example, it will be used
38   to store additional information for the "Mobile notifications" processor.
39   Existing external functions: core_message_get_messages and message_popup_get_popup_notifications has been udated to return the
40   new field.
41 * External function core_message_get_messages now returns the component and eventtype.
43 === 3.6 ===
45 * The following functions have been finally deprecated and can not be used anymore:
46   * message_get_course_contexts()
47   * message_remove_url_params()
48   * message_count_messages()
49   * message_count_blocked_users()
50   * message_contact_link()
51   * message_history_link()
52   * message_shorten_message()
53   * message_get_fragment()
54   * message_get_contact_add_remove_link()
55   * message_get_contact_block_link()
56   * message_mark_messages_read()
57   * message_page_type_list()
58   * message_can_post_message()
59   * message_is_user_non_contact_blocked()
60   * message_is_user_blocked()
61 * The following functions have been deprecated and should not be used any more:
62   - message_add_contact()
63   - message_remove_contact()
64   - message_unblock_contact()
65   - message_block_contact()
66   - message_get_contact()
67   Please see their declaration in lib/deprecatedlib.php to view their alternatives (if applicable).
68 * The following methods have been deprecated and should not be used any more:
69   - \core_message\api::is_user_blocked()
70   - \core_message\api::delete_conversation()
71   - \core_message\api::is_user_non_contact_blocked()
72   - \core_message\api::create_conversation_between_users()
73 * The method \core_message\api::can_delete_conversation() now expects a 'conversationid' to be passed
74   as the second parameter.
75 * The following web services have been deprecated. Please do not call these any more.
76   - core_message_external::block_contacts(), please use core_message_external::block_user() instead.
77   - core_message_external::unblock_contacts(), please use core_message_external::unblock_user() instead.
78   - core_message_external::create_contacts(), please use core_message_external::create_contact_request() instead.
79   - core_message_external::delete_conversation(), please use core_message_external::delete_conversations_by_id() instead.
80   - core_message_external::core_message_mark_all_messages_as_read(), please use
81     core_message_external::core_message_mark_all_conversation_messages_as_read() instead.
82   - core_message_external::data_for_messagearea_conversations(), please use core_message_external::get_conversations()
83     instead
84   - core_message_external::data_for_messagearea_search_users_in_course().
85   - core_message_external::data_for_messagearea_search_users(),
86     please use core_message_external::message_search_users() instead.
87   - core_message_external::data_for_messagearea_contacts().
88   - core_message_external::data_for_messagearea_messages().
89   - core_message_external::data_for_messagearea_get_most_recent_message().
90   - core_message_external::data_for_messagearea_get_profile().
91   - core_message_external::get_contacts().
92 * The following function has been added for getting the privacy messaging preference:
93   - get_user_privacy_messaging_preference()
95 === 3.5 ===
97 * Changed the database structure so there are no longer two tables for messages, with the only
98   difference being that one stores read messages. The 'message' and 'message_read' tables are
99   still present in core but will no longer be populated by core APIs. The data will be
100   transferred to the new database structure via an ad-hoc task. Please be patient. This can
101   take time.
102   The new database structure is as follows -
103   'messages' - Stores the messages with a 'useridfrom' field specifying the user who sent the
104                message and a 'conversationid' field specifying which conversation it is for.
105   'message_conversations' - The list of conversations.
106   'message_conversation_members' - The list of users in each conversation.
107   'message_user_actions' - The list of user actions against a message, eg. read/deleted.
108   'notifications' - This has a very similar structure to the old table 'message' and still
109                     has a one-to-one relation between users.
110   Due to these huge differences the events message_sent, message_deleted and message_viewed
111   have changed quite a lot. Please, if you have any observers or are triggering these events
112   in your code you will have to make some changes!
113 * The webservice external function 'core_message_mark_message_read' now only marks messages as
114   read, and not notifications. A new external function 'core_message_mark_notification_read' was
115   added to mark notifications as read.
116 * Deprecated the following functions.
117   - message_move_userfrom_unread2read
118   - message_get_blocked_users
119   - message_get_contacts
120   - message_mark_message_read
121   - message_can_delete_message
122   - message_delete_message
123   - \core_message\api::mark_all_read_for_user
124   Please see their declaration in lib/deprecatedlib.php to view their alternatives (if applicable).
125 * Final deprecation of the following functions.
126   - message_get_recent_notifications
127   - message_search
128   - message_get_history
129   - message_get_recent_conversations
130 * Added new events for when a notification is sent and viewed.
131 * Removed the database table 'message_working'. The 'message_working' table was introduced when
132   the messaging system was first introduced in Moodle, so, a long time ago. It was never necessary.
133 * Replaced the usage of the table 'message_popup' to a new table 'message_popup_notifications'.
135 === 3.2 ===
137 * Removed all message_print_* functions as well as the files search.html, search_advanced.html and
138   send_form.php due to messaging UI rehaul.
139 * Deprecated the following functions as they are no longer used.
140     - message_get_course_contexts
141     - message_remove_url_params
142     - message_count_messages
143     - message_count_blocked_users
144     - message_contact_link
145     - message_get_recent_notifications
146     - message_history_link
147     - message_search
148     - message_shorten_message
149     - message_get_fragment
150     - message_get_history
151     - message_get_contact_add_remove_link
152     - message_get_contact_block_link
153     - message_mark_messages_read
154     - message_page_type_list
155     - message_can_post_message
156     - message_is_user_non_contact_blocked
157     - message_is_user_blocked
159 === 3.1 ===
160 * get_message_processors accepts an addition parameter for testing, which will just reset processor and exit.
161 * Deprecated method message_current_user_is_involved() has been removed.
163 === 2.9 ===
164 * Renderer method \core_message_renderer::manage_messagingoptions now accepts a user id parameter as well.
166 === 2.6 ===
167 * Message processor extending message_output, should return true in can_send_to_any_users()
168   if it supports message sending to internal (noreply/support) users.
169 * Message API has been changed to allow attachments. Message processors that can support
170   attachments can now use additional parameter as a part of $eventdata. To send attachments,
171   $eventdata should contain properties called "attachment" (must be stored_file) and
172   "attachname" (string). Currently, email message processor is the only one to support
173   attachments.
175 === 2.2 ===
177 required changes:
178 * lib/messagelib.php message_send($eventdata)
179   $eventdata->userto should contain a property called "emailstop", $eventdata->userto->emailstop
180   If it is absent it will be retrieved from the user table causing an additional database query