aboutsummaryrefslogtreecommitdiff
path: root/mod/messages/start.php
blob: bca8d3a91b737212d8c3ed28831df63f9e431420 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<?php

/**
* Elgg internal messages plugin
* This plugin lets user send each other messages.
*
* @package ElggMessages
*/

/**
* Messages initialisation
*
* These parameters are required for the event API, but we won't use them:
*
* @param unknown_type $event
* @param unknown_type $object_type
* @param unknown_type $object
*/
function messages_init() {

	// Load system configuration
		global $CONFIG;

	//add submenu options
		if (elgg_get_context() == "messages") {
			add_submenu_item(elgg_echo('messages:inbox'), "pg/messages/" . get_loggedin_user()->username);
			add_submenu_item(elgg_echo('messages:sentmessages'), "mod/messages/sent.php");
		}

	// Extend system CSS with our own styles, which are defined in the shouts/css view
		elgg_extend_view('css','messages/css');

	// Extend the elgg topbar
		elgg_extend_view('elgg_topbar/extend','messages/topbar');

	// Register a page handler, so we can have nice URLs
		register_page_handler('messages','messages_page_handler');

	// Register a URL handler for shouts posts
		register_entity_url_handler('messages_url','object','messages');

	// Extend avatar user-menu
		elgg_extend_view('profile/menu/links','messages/menu');

	// Register a notification handler for site messages
		register_notification_handler("site", "messages_site_notify_handler");
		elgg_register_plugin_hook_handler('notify:entity:message','object','messages_notification_msg');
		register_notification_object('object','messages',elgg_echo('messages:new'));

	// Override metadata permissions
		elgg_register_plugin_hook_handler('permissions_check:metadata','object','messages_can_edit_metadata');

	// ecml
	elgg_register_plugin_hook_handler('get_views', 'ecml', 'messages_ecml_views_hook');

}

/**
 * Override the canEditMetadata function to return true for messages
 *
 */
function messages_can_edit_metadata($hook_name, $entity_type, $return_value, $parameters) {

	global $messagesendflag;

	if ($messagesendflag == 1) {
		$entity = $parameters['entity'];
		if ($entity->getSubtype() == "messages") {
			return true;
		}
	}

	return $return_value;

}

/**
 * Override the canEdit function to return true for messages within a particular context.
 *
 */
function messages_can_edit($hook_name, $entity_type, $return_value, $parameters) {

	global $messagesendflag;

	if ($messagesendflag == 1) {
		$entity = $parameters['entity'];
		if ($entity->getSubtype() == "messages") {
			return true;
		}
	}

	return $return_value;

}

/**
 * We really don't want to send a notification message when a message is sent, if the method is messages ...
 *
 */
function messages_notification_msg($hook_name, $entity_type, $return_value, $parameters) {

	global $CONFIG, $messages_pm;

	if ($parameters['entity'] instanceof ElggEntity) {

		if ($parameters['entity']->getSubtype() == 'messages') {

			return false;
		}
	}
	return null;

}

/**
 * Override the canEdit function to return true for messages within a particular context.
 *
 */
function messages_can_edit_container($hook_name, $entity_type, $return_value, $parameters) {

	global $messagesendflag;

	if ($messagesendflag == 1) {
		return true;
	}

	return $return_value;

}

/**
 * Send an internal message
 *
 * @param string $subject The subject line of the message
 * @param string $body The body of the mesage
 * @param int $send_to The GUID of the user to send to
 * @param int $from Optionally, the GUID of the user to send from
 * @param int $reply The GUID of the message to reply from (default: none)
 * @param true|false $notify Send a notification (default: true)
 * @param true|false $add_to_sent If true (default), will add a message to the sender's 'sent' tray
 * @return true|false Depending on success
 */
function messages_send($subject, $body, $send_to, $from = 0, $reply = 0, $notify = true, $add_to_sent = true) {

		global $messagesendflag;
		$messagesendflag = 1;

		global $messages_pm;
		if ($notify) {
			$messages_pm = 1;
		} else {
			$messages_pm = 0;
		}

	// If $from == 0, set to current user
			if ($from == 0)
				$from = (int) get_loggedin_userid();

	// Initialise a new ElggObject
			$message_to = new ElggObject();
			$message_sent = new ElggObject();
	// Tell the system it's a message
			$message_to->subtype = "messages";
			$message_sent->subtype = "messages";
	// Set its owner to the current user
			// $message_to->owner_guid = get_loggedin_userid();
			$message_to->owner_guid = $send_to;
			$message_to->container_guid = $send_to;
			$message_sent->owner_guid = $from;
			$message_sent->container_guid = $from;
	// For now, set its access to public (we'll add an access dropdown shortly)
			$message_to->access_id = ACCESS_PUBLIC;
			$message_sent->access_id = ACCESS_PUBLIC;
	// Set its description appropriately
			$message_to->title = $subject;
			$message_to->description = $body;
			$message_sent->title = $subject;
			$message_sent->description = $body;
	// set the metadata
			$message_to->toId = $send_to; // the user receiving the message
			$message_to->fromId = $from; // the user receiving the message
			$message_to->readYet = 0; // this is a toggle between 0 / 1 (1 = read)
			$message_to->hiddenFrom = 0; // this is used when a user deletes a message in their sentbox, it is a flag
			$message_to->hiddenTo = 0; // this is used when a user deletes a message in their inbox
			$message_sent->toId = $send_to; // the user receiving the message
			$message_sent->fromId = $from; // the user receiving the message
			$message_sent->readYet = 0; // this is a toggle between 0 / 1 (1 = read)
			$message_sent->hiddenFrom = 0; // this is used when a user deletes a message in their sentbox, it is a flag
			$message_sent->hiddenTo = 0; // this is used when a user deletes a message in their inbox

			$message_to->msg = 1;
			$message_sent->msg = 1;

		// Save the copy of the message that goes to the recipient
			$success = $message_to->save();

		// Save the copy of the message that goes to the sender
			if ($add_to_sent) $success2 = $message_sent->save();

			$message_to->access_id = ACCESS_PRIVATE;
			$message_to->save();

			if ($add_to_sent) {
				$message_sent->access_id = ACCESS_PRIVATE;
				$message_sent->save();
			}

		// if the new message is a reply then create a relationship link between the new message
		// and the message it is in reply to
			if($reply && $success){
				$create_relationship = add_entity_relationship($message_sent->guid, "reply", $reply);
			}


			global $CONFIG;
			$message_contents = strip_tags($body);
			if ($send_to != get_loggedin_user() && $notify)
			notify_user($send_to, get_loggedin_userid(), elgg_echo('messages:email:subject'),
				elgg_echo('messages:email:body', array(
						get_loggedin_user()->name,
						$message_contents,
						elgg_get_site_url() . "pg/messages/" . $user->username,
						get_loggedin_user()->name,
						elgg_get_site_url() . "mod/messages/send.php?send_to=" . get_loggedin_userid()
					))
			);

			$messagesendflag = 0;
			return $success;

}

/**
 * messages page handler; allows the use of fancy URLs
 *
 * @param array $page From the page_handler function
 * @return true|false Depending on success
 */
function messages_page_handler($page) {

	// The first component of a messages URL is the username
	if (isset($page[0])) {
		set_input('username',$page[0]);
	}

	// The second part dictates what we're doing
	if (isset($page[1])) {
		switch($page[1]) {
			case "read":		set_input('message',$page[2]);
								include(dirname(__FILE__) . "/read.php");
								return true;
								break;
		}
	// If the URL is just 'messages/username', or just 'messages/', load the standard messages index
	} else {
		include(dirname(__FILE__) . "/index.php");
		return true;
	}

	return false;

}

function messages_url($message) {
	return "pg/messages/" . $message->getOwnerEntity()->username . "/read/" . $message->getGUID();
}

// A simple function to count the number of messages that are unread in a user's inbox
function count_unread_messages() {

	//get the users inbox messages
	//$num_messages = get_entities_from_metadata("toId", get_loggedin_userid(), "object", "messages", 0, 10, 0, "", 0, false);
$num_messages = elgg_get_entities_from_metadata(array('metadata_name_value_pairs' => array(
								'toId' => get_loggedin_userid(),
								'readYet' => 0,
								'msg' => 1
							), 'owner_guid' => get_loggedin_userid()));

	if (is_array($num_messages))
		$counter = sizeof($num_messages);
	else
		$counter = 0;

	return $counter;

}

function messages_site_notify_handler(ElggEntity $from, ElggUser $to, $subject, $message, array $params = NULL)
{
	global $CONFIG;

	if (!$from)
		throw new NotificationException(elgg_echo('NotificationException:MissingParameter', array('from')));

	if (!$to)
		throw new NotificationException(elgg_echo('NotificationException:MissingParameter', array('to')));

	global $messages_pm;
	if (!$messages_pm)
		return messages_send($subject,$message,$to->guid,$from->guid,0,false,false);
	else return true;

}
/**
 * Register messages with ECML.
 *
 * @param unknown_type $hook
 * @param unknown_type $entity_type
 * @param unknown_type $return_value
 * @param unknown_type $params
 */
function messages_ecml_views_hook($hook, $entity_type, $return_value, $params) {
	$return_value['messages/messages'] = elgg_echo('messages');

	return $return_value;
}


// Make sure the messages initialisation function is called on initialisation
elgg_register_event_handler('init','system','messages_init');

elgg_register_plugin_hook_handler('permissions_check','object','messages_can_edit');
elgg_register_plugin_hook_handler('container_permissions_check','object','messages_can_edit_container');

// Register actions
global $CONFIG;
elgg_register_action("messages/send", $CONFIG->pluginspath . "messages/actions/send.php");
elgg_register_action("messages/delete", $CONFIG->pluginspath . "messages/actions/delete.php");