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
|
<?php
/**
* Helper functions
*
* @package Elgg.Core.Plugin
* @subpackage UserValidationByEmail
*/
/**
* Generate an email activation code.
*
* @param int $user_guid The guid of the user
* @param string $email_address Email address
* @return string
*/
function uservalidationbyemail_generate_code($user_guid, $email_address) {
global $CONFIG;
// Note I bind to site URL, this is important on multisite!
return md5($user_guid . $email_address . $CONFIG->site->url . get_site_secret());
}
/**
* Request user validation email.
* Send email out to the address and request a confirmation.
*
* @param int $user_guid The user
* @return mixed
*/
function uservalidationbyemail_request_validation($user_guid) {
global $CONFIG;
$user_guid = (int)$user_guid;
$user = get_entity($user_guid);
if (($user) && ($user instanceof ElggUser)) {
// Work out validate link
$code = uservalidationbyemail_generate_code($user_guid, $user->email);
$link = "{$CONFIG->site->url}pg/uservalidationbyemail/confirm?u=$user_guid&c=$code";
$site = $CONFIG->site;
// Send validation email
$subject = sprintf(elgg_echo('email:validate:subject'), $user->name, $site->name);
$body = sprintf(elgg_echo('email:validate:body'), $user->name, $site->name, $link, $site->name, $site->url);
$result = notify_user($user->guid, $CONFIG->site->guid, $subject, $body, NULL, 'email');
if ($result) {
system_message(elgg_echo('uservalidationbyemail:registerok'));
}
return $result;
}
return FALSE;
}
/**
* Validate a user
*
* @param unknown_type $user_guid
* @param unknown_type $code
* @return unknown
*/
function uservalidationbyemail_validate_email($user_guid, $code) {
$user = get_entity($user_guid);
if ($code == uservalidationbyemail_generate_code($user_guid, $user->email)) {
return uservalidationbyemail_set_user_validation_status($user_guid, true, 'email');
}
return false;
}
/**
* Set the validation status for a user.
*
* @param bool $status Validated (true) or false
* @param string $method Optional method to say how a user was validated
* @return bool
*/
function uservalidationbyemail_set_user_validation_status($user_guid, $status, $method = '') {
if (!$status) {
$method = '';
}
if ($status) {
if (
(create_metadata($user_guid, 'validated', $status,'', 0, ACCESS_PUBLIC)) &&
(create_metadata($user_guid, 'validated_method', $method,'', 0, ACCESS_PUBLIC))
) {
return TRUE;
}
} else {
$validated = get_metadata_byname($user_guid, 'validated');
$validated_method = get_metadata_byname($user_guid, 'validated_method');
if (
($validated) &&
($validated_method) &&
(delete_metadata($validated->id)) &&
(delete_metadata($validated_method->id))
)
return TRUE;
}
return FALSE;
}
/**
* Returns the validation status of a user.
*
* @param unknown_type $user_guid
* @return int|null
*/
function uservalidationbyemail_get_user_validation_status($user_guid) {
$md = get_metadata_byname($user_guid, 'validated');
if ($md && $md->value) {
return TRUE;
}
return FALSE;
}
/**
* Returns all users who haven't been validated.
*
* "Unvalidated" means metadata of validated is not set or not truthy.
* We can't use the elgg_get_entities_from_metadata() because you can't say
* "where the entity has metadata set OR it's not equal to 1".
*
* This doesn't include any security, so should be called ONLY be admin users!
* @return array
*/
function uservalidationbyemail_get_unvalidated_users_sql_where() {
global $CONFIG;
$validated_id = get_metastring_id('validated');
$one_id = get_metastring_id(1);
// thanks to daveb@freenode for the SQL tips!
$where = "NOT EXISTS (
SELECT 1 FROM {$CONFIG->dbprefix}metadata md
WHERE md.entity_guid = e.guid
AND md.name_id = $validated_id
AND md.value_id = $one_id)";
return $where;
}
|
