simple-machines-forum/Sources/Subs-Notify.php

183 lines
5.4 KiB
PHP
Raw Permalink Normal View History

2024-07-22 14:45:07 +00:00
<?php
/**
* Simple Machines Forum (SMF)
*
* @package SMF
* @author Simple Machines https://www.simplemachines.org
* @copyright 2022 Simple Machines and individual contributors
* @license https://www.simplemachines.org/about/smf/license.php BSD
*
* @version 2.1.3
*/
if (!defined('SMF'))
die('No direct access...');
/**
* Fetches the list of preferences (or a single/subset of preferences) for
* notifications for one or more users.
*
* @param int|array $members A user id or an array of (integer) user ids to load preferences for
* @param string|array $prefs An empty string to load all preferences, or a string (or array) of preference name(s) to load
* @param bool $process_default Whether to apply the default values to the members' values or not.
* @return array An array of user ids => array (pref name -> value), with user id 0 representing the defaults
*/
function getNotifyPrefs($members, $prefs = '', $process_default = false)
{
global $smcFunc;
// We want this as an array whether it is or not.
$members = is_array($members) ? $members : (array) $members;
if (!empty($prefs))
$prefs = is_array($prefs) ? $prefs : (array) $prefs;
$result = array();
// We want to now load the default, which is stored with a member id of 0.
$members[] = 0;
$request = $smcFunc['db_query']('', '
SELECT id_member, alert_pref, alert_value
FROM {db_prefix}user_alerts_prefs
WHERE id_member IN ({array_int:members})' . (!empty($prefs) ? '
AND alert_pref IN ({array_string:prefs})' : ''),
array(
'members' => $members,
'prefs' => $prefs,
)
);
while ($row = $smcFunc['db_fetch_assoc']($request))
$result[$row['id_member']][$row['alert_pref']] = $row['alert_value'];
// We may want to keep the default values separate from a given user's. Or we might not.
if ($process_default && isset($result[0]))
{
foreach ($members as $member)
if (isset($result[$member]))
$result[$member] += $result[0];
else
$result[$member] = $result[0];
unset ($result[0]);
}
return $result;
}
/**
* Sets the list of preferences for a single user.
*
* @param int $memID The user whose preferences you are setting
* @param array $prefs An array key of pref -> value
*/
function setNotifyPrefs($memID, $prefs = array())
{
global $smcFunc;
if (empty($prefs) || !is_int($memID))
return;
$update_rows = array();
foreach ($prefs as $k => $v)
$update_rows[] = array($memID, $k, min(max((int) $v, -128), 127));
$smcFunc['db_insert']('replace',
'{db_prefix}user_alerts_prefs',
array('id_member' => 'int', 'alert_pref' => 'string', 'alert_value' => 'int'),
$update_rows,
array('id_member', 'alert_pref')
);
}
/**
* Deletes notification preference
*
* @param int $memID The user whose preference you're setting
* @param array $prefs The preferences to delete
*/
function deleteNotifyPrefs($memID, array $prefs)
{
global $smcFunc;
if (empty($prefs) || empty($memID))
return;
$smcFunc['db_query']('', '
DELETE FROM {db_prefix}user_alerts_prefs
WHERE id_member = {int:member}
AND alert_pref IN ({array_string:prefs})',
array(
'member' => $memID,
'prefs' => $prefs,
)
);
}
/**
* Verifies a member's unsubscribe token, then returns some member info
*
* @param string $type The type of notification the token is for (e.g. 'board', 'topic', etc.)
* @return array The id and email address of the specified member
*/
function getMemberWithToken($type)
{
global $smcFunc, $board, $topic, $modSettings;
// Keep it sanitary, folks
$id_member = !empty($_REQUEST['u']) ? (int) $_REQUEST['u'] : 0;
// We can't do anything without these
if (empty($id_member) || empty($_REQUEST['token']))
fatal_lang_error('unsubscribe_invalid', false);
// Get the user info we need
$request = $smcFunc['db_query']('', '
SELECT id_member AS id, email_address AS email
FROM {db_prefix}members
WHERE id_member = {int:id_member}',
array(
'id_member' => $id_member,
)
);
if ($smcFunc['db_num_rows']($request) == 0)
fatal_lang_error('unsubscribe_invalid', false);
$member_info = $smcFunc['db_fetch_assoc']($request);
$smcFunc['db_free_result']($request);
// What token are we expecting?
$expected_token = createUnsubscribeToken($member_info['id'], $member_info['email'], $type, in_array($type, array('board', 'topic')) && !empty($$type) ? $$type : 0);
// Don't do anything if the token they gave is wrong
if ($_REQUEST['token'] !== $expected_token)
fatal_lang_error('unsubscribe_invalid', false);
// At this point, we know we have a legitimate unsubscribe request
return $member_info;
}
/**
* Builds an unsubscribe token
*
* @param int $memID The id of the member that this token is for
* @param string $email The member's email address
* @param string $type The type of notification the token is for (e.g. 'board', 'topic', etc.)
* @param int $itemID The id of the notification item, if applicable.
* @return string The unsubscribe token
*/
function createUnsubscribeToken($memID, $email, $type = '', $itemID = 0)
{
$token_items = implode(' ', array($memID, $email, $type, $itemID));
// When the message is public and the key is secret, an HMAC is the appropriate tool.
$token = hash_hmac('sha256', $token_items, get_auth_secret(), true);
// When using an HMAC, 80 bits (10 bytes) is plenty for security.
$token = substr($token, 0, 10);
// Use base64 (with URL-friendly characters) to make the token shorter.
return strtr(base64_encode($token), array('+' => '_', '/' => '-', '=' => ''));
}
?>