Elgg / Elgg

mod/notifications/start.php

<?php
/**
 * Elgg notifications plugin
 *
 * @package ElggNotifications
 */

/**
 * Notifications init
 *
 * @return void
 */
function notifications_plugin_init() {

	elgg_extend_view('elgg.css', 'notifications.css');

	elgg_register_page_handler('notifications', 'notifications_page_handler');

	elgg_register_plugin_hook_handler('register', 'menu:title', '_notification_groups_title_menu');

	elgg_register_plugin_hook_handler('register', 'menu:page', '_notifications_page_menu');

	// Unset the default notification settings
	elgg_unregister_plugin_hook_handler('usersettings:save', 'user', '_elgg_save_notification_user_settings');
	elgg_unextend_view('forms/account/settings', 'core/settings/account/notifications');

	// update notifications based on relationships changing
	elgg_register_event_handler('delete', 'relationship', 'notifications_relationship_remove');

	// update notifications when new friend or access collection membership
	elgg_register_event_handler('create', 'relationship', 'notifications_update_friend_notify');
	elgg_register_plugin_hook_handler('access:collections:add_user', 'collection', 'notifications_update_collection_notify');

	// register unit tests
	elgg_register_plugin_hook_handler('unit_test', 'system', 'notifications_register_tests');
}

/**
 * Route page requests
 *
 * @param array $page Array of url parameters
 * @return bool
 */
function notifications_page_handler($page) {

	elgg_gatekeeper();

	// Set the context to settings
	elgg_set_context('settings');

	$current_user = elgg_get_logged_in_user_entity();

	// default to personal notifications
	if (!isset($page[0])) {
		$page[0] = 'personal';
	}
	if (!isset($page[1])) {
		forward("notifications/{$page[0]}/{$current_user->username}");
	}

	$vars['username'] = $page[1];

$vars was never initialized. Although not strictly required by PHP, it is generally a good practice to add $vars = array(); before regardless.

	// note: $user passed in
	switch ($page[0]) {
		case 'group':
			echo elgg_view_resource('notifications/groups', $vars);
			break;
		case 'personal':
			echo elgg_view_resource('notifications/index', $vars);
			break;
		default:
			return false;
	}
	return true;
}

/**
 * Register menu items for the page menu
 *
 * @param string         $hook   'register'
 * @param string         $type   'menu:page'
 * @param ElggMenuItem[] $return current return value
 * @param array          $params supplied params
 *
 * @return void|ElggMenuItem[]
 *
 * @access private
 * @since 3.0
 */
function _notifications_page_menu($hook, $type, $return, $params) {

The parameter $type is not used and could be removed.

The parameter $hook is not used and could be removed.

The parameter $params is not used and could be removed.

	
	if (!elgg_in_context('settings') || !elgg_get_logged_in_user_guid()) {
		return;
	}

	$user = elgg_get_page_owner_entity();
	if (!$user) {
		$user = elgg_get_logged_in_user_entity();
	}
	
	$return[] = \ElggMenuItem::factory([
		'name' => '2_a_user_notify',
		'text' => elgg_echo('notifications:subscriptions:changesettings'),
		'href' => "notifications/personal/{$user->username}",
		'section' => 'notifications',
	]);
	
	if (elgg_is_active_plugin('groups')) {
		$return[] = \ElggMenuItem::factory([
			'name' => '2_group_notify',
			'text' => elgg_echo('notifications:subscriptions:changesettings:groups'),
			'href' => "notifications/group/{$user->username}",
			'section' => 'notifications',
		]);
	}
		
	return $return;
}

/**
 * Register menu items for the title menu on group profiles
 *
 * @param \Elgg\Hook $hook 'register' 'menu:title'
 *
 * @return void
 *
 * @access private
 * @since 3.0
 */
function _notification_groups_title_menu(\Elgg\Hook $hook) {
	if (!elgg_is_active_plugin('groups')) {
		return;
	}

	$user = elgg_get_logged_in_user_entity();
	if (!$user) {
		return;
	}

	$items = $hook->getValue();
	
	$group = $hook->getEntityParam();
	if (!($group instanceof \ElggGroup)) {
		return;
	}
	
	$subscribed = false;
	$methods = elgg_get_notification_methods();
	foreach ($methods as $method) {
		$subscribed = check_entity_relationship($user->guid, 'notify' . $method, $group->guid);
		if ($subscribed) {
			break;
		}
	}
		
	$items[] = \ElggMenuItem::factory([
		'name' => 'notifications',
		'parent_name' => 'group-dropdown',
		'text' => elgg_echo('notifications:subscriptions:changesettings:groups'),
		'href' => "notifications/group/{$user->username}",
		'badge' => $subscribed ? elgg_echo('on') : elgg_echo('off'),
		'icon' => $subscribed ? 'bell' : 'bell-slash',
	]);
	
	return $items;
}

/**
 * Update notifications when a relationship is deleted
 *
 * @param string            $event        "delete"
 * @param string            $object_type  "relationship"
 * @param \ElggRelationship $relationship Relationship obj
 *
 * @return void
 */
function notifications_relationship_remove($event, $object_type, $relationship) {

The parameter $object_type is not used and could be removed.

The parameter $event is not used and could be removed.

	
	if (!$relationship instanceof ElggRelationship) {
		return;
	}
	
	if (!in_array($relationship->relationship, ['member', 'friend'])) {
		return;
	}
	
	$methods = array_keys(_elgg_services()->notifications->getMethodsAsDeprecatedGlobal());
	foreach ($methods as $method) {
		elgg_remove_subscription($relationship->guid_one, $method, $relationship->guid_two);
	}
}

/**
 * Turn on notifications for new friends if all friend notifications is on
 *
 * @param string           $event        'create'
 * @param string           $type         'relationship'
 * @param ElggRelationship $relationship new relationship
 *
 * @return void
 */
function notifications_update_friend_notify($event, $type, $relationship) {

The parameter $event is not used and could be removed.

	
	if (!$relationship instanceof ElggRelationship) {
		return;
	}
	
	// The handler gets triggered regardless of which relationship was
	// created, so proceed only if dealing with a 'friend' relationship.
	if ($relationship->relationship != 'friend') {
		return;
	}

	$NOTIFICATION_HANDLERS = _elgg_services()->notifications->getMethodsAsDeprecatedGlobal();

	$user_guid = $relationship->guid_one;
	$friend_guid = $relationship->guid_two;

	$user = get_entity($user_guid);

	// loop through all notification types
	foreach ($NOTIFICATION_HANDLERS as $method => $foo) {
		$metaname = 'collections_notifications_preferences_' . $method;
		$collections_preferences = $user->$metaname;
		if ($collections_preferences) {
			if (!empty($collections_preferences) && !is_array($collections_preferences)) {
				$collections_preferences = [$collections_preferences];
			}
			if (is_array($collections_preferences)) {
				// -1 means all friends is on - should be a define
				if (in_array(-1, $collections_preferences)) {
					add_entity_relationship($user_guid, 'notify' . $method, $friend_guid);
				}
			}
		}
	}
}

/**
 * Update notifications for changes in access collection membership.
 *
 * This function assumes that only friends can belong to access collections.
 *
 * @param string $event       'access:collections:add_user'
 * @param string $type        'collection'
 * @param bool   $returnvalue current return value
 * @param array  $params      supplied params
 *
 * @return void
 */
function notifications_update_collection_notify($event, $type, $returnvalue, $params) {
	$NOTIFICATION_HANDLERS = _elgg_services()->notifications->getMethodsAsDeprecatedGlobal();

	// only update notifications for user owned collections
	$collection_id = elgg_extract('collection_id', $params);
	$collection = get_access_collection($collection_id);
	if (!$collection instanceof ElggAccessCollection) {
		return;
	}
	$user = get_entity($collection->owner_guid);
	if (!($user instanceof ElggUser)) {
		return;
	}

	$member_guid = (int) elgg_extract('user_guid', $params);
	if (empty($member_guid)) {
		return;
	}

	// loop through all notification types
	foreach ($NOTIFICATION_HANDLERS as $method => $foo) {
		$metaname = 'collections_notifications_preferences_' . $method;
		$collections_preferences = $user->$metaname;
		if (!$collections_preferences) {
			continue;
		}
		if (!is_array($collections_preferences)) {
			$collections_preferences = [$collections_preferences];
		}
		if (in_array(-1, $collections_preferences)) {
			// if "all friends" notify is on, we don't change any notifications
			// since must be a friend to be in an access collection
			continue;
		}
		if (in_array($collection_id, $collections_preferences)) {
			// notifications are on for this collection so we add/remove
			if ($event == 'access:collections:add_user') {
				add_entity_relationship($user->guid, "notify$method", $member_guid);
			} elseif ($event == 'access:collections:remove_user') {
				// removing someone from an access collection is not a guarantee
				// that they should be removed from notifications
				//remove_entity_relationship($user->guid, "notify$method", $member_guid);
			}
		}
	}
}

/**
 * Register unit tests
 *
 * @param string   $hook  "unit_test"
 * @param string   $type  "system"
 * @param string[] $tests Tests
 *
 * @return string[]
 */
function notifications_register_tests($hook, $type, $tests) {

The parameter $type is not used and could be removed.

The parameter $hook is not used and could be removed.

	$tests[] = __DIR__ . '/tests/ElggNotificationsPluginUnitTest.php';
	return $tests;
}

return function() {
	elgg_register_event_handler('init', 'system', 'notifications_plugin_init');
};