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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugins\MobileMessaging;
use Piwik\Common;
use Piwik\Option;
use Piwik\Piwik;
use Piwik\Plugins\MobileMessaging\SMSProvider;
/**
* The MobileMessaging API lets you manage and access all the MobileMessaging plugin features including :
* - manage SMS API credential
* - activate phone numbers
* - check remaining credits
* - send SMS
* @method static \Piwik\Plugins\MobileMessaging\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
const VERIFICATION_CODE_LENGTH = 5;
const SMS_FROM = 'Piwik';
/**
* @param string $provider
* @return SMSProvider
*/
private static function getSMSProviderInstance($provider)
{
return SMSProvider::factory($provider);
}
/**
* determine if SMS API credential are available for the current user
*
* @return bool true if SMS API credential are available for the current user
*/
public function areSMSAPICredentialProvided()
{
Piwik::checkUserHasSomeViewAccess();
$credential = $this->getSMSAPICredential();
return isset($credential[MobileMessaging::API_KEY_OPTION]);
}
private function getSMSAPICredential()
{
$settings = $this->getCredentialManagerSettings();
return array(
MobileMessaging::PROVIDER_OPTION =>
isset($settings[MobileMessaging::PROVIDER_OPTION]) ? $settings[MobileMessaging::PROVIDER_OPTION] : null,
MobileMessaging::API_KEY_OPTION =>
isset($settings[MobileMessaging::API_KEY_OPTION]) ? $settings[MobileMessaging::API_KEY_OPTION] : null,
);
}
/**
* return the SMS API Provider for the current user
*
* @return string SMS API Provider
*/
public function getSMSProvider()
{
$this->checkCredentialManagementRights();
$credential = $this->getSMSAPICredential();
return $credential[MobileMessaging::PROVIDER_OPTION];
}
/**
* set the SMS API credential
*
* @param string $provider SMS API provider
* @param string $apiKey API Key
*
* @return bool true if SMS API credential were validated and saved, false otherwise
*/
public function setSMSAPICredential($provider, $apiKey)
{
$this->checkCredentialManagementRights();
$smsProviderInstance = self::getSMSProviderInstance($provider);
$smsProviderInstance->verifyCredential($apiKey);
$settings = $this->getCredentialManagerSettings();
$settings[MobileMessaging::PROVIDER_OPTION] = $provider;
$settings[MobileMessaging::API_KEY_OPTION] = $apiKey;
$this->setCredentialManagerSettings($settings);
return true;
}
/**
* add phone number
*
* @param string $phoneNumber
*
* @return bool true
*/
public function addPhoneNumber($phoneNumber)
{
Piwik::checkUserIsNotAnonymous();
$phoneNumber = self::sanitizePhoneNumber($phoneNumber);
$verificationCode = "";
for ($i = 0; $i < self::VERIFICATION_CODE_LENGTH; $i++) {
$verificationCode .= mt_rand(0, 9);
}
$smsText = Piwik::translate(
'MobileMessaging_VerificationText',
array(
$verificationCode,
Piwik::translate('General_Settings'),
Piwik::translate('MobileMessaging_SettingsMenu')
)
);
$this->sendSMS($smsText, $phoneNumber, self::SMS_FROM);
$phoneNumbers = $this->retrievePhoneNumbers();
$phoneNumbers[$phoneNumber] = $verificationCode;
$this->savePhoneNumbers($phoneNumbers);
$this->increaseCount(MobileMessaging::PHONE_NUMBER_VALIDATION_REQUEST_COUNT_OPTION, $phoneNumber);
return true;
}
/**
* sanitize phone number
*
* @ignore
* @param string $phoneNumber
* @return string sanitized phone number
*/
public static function sanitizePhoneNumber($phoneNumber)
{
return str_replace(' ', '', $phoneNumber);
}
/**
* send a SMS
*
* @param string $content
* @param string $phoneNumber
* @param string $from
* @return bool true
* @ignore
*/
public function sendSMS($content, $phoneNumber, $from)
{
Piwik::checkUserIsNotAnonymous();
$credential = $this->getSMSAPICredential();
$SMSProvider = self::getSMSProviderInstance($credential[MobileMessaging::PROVIDER_OPTION]);
$SMSProvider->sendSMS(
$credential[MobileMessaging::API_KEY_OPTION],
$content,
$phoneNumber,
$from
);
$this->increaseCount(MobileMessaging::SMS_SENT_COUNT_OPTION, $phoneNumber);
return true;
}
/**
* get remaining credit
*
* @return string remaining credit
*/
public function getCreditLeft()
{
$this->checkCredentialManagementRights();
$credential = $this->getSMSAPICredential();
$SMSProvider = self::getSMSProviderInstance($credential[MobileMessaging::PROVIDER_OPTION]);
return $SMSProvider->getCreditLeft(
$credential[MobileMessaging::API_KEY_OPTION]
);
}
/**
* remove phone number
*
* @param string $phoneNumber
*
* @return bool true
*/
public function removePhoneNumber($phoneNumber)
{
Piwik::checkUserIsNotAnonymous();
$phoneNumbers = $this->retrievePhoneNumbers();
unset($phoneNumbers[$phoneNumber]);
$this->savePhoneNumbers($phoneNumbers);
/**
* Triggered after a phone number has been deleted. This event should be used to clean up any data that is
* related to the now deleted phone number. The ScheduledReports plugin, for example, uses this event to remove
* the phone number from all reports to make sure no text message will be sent to this phone number.
*
* **Example**
*
* public function deletePhoneNumber($phoneNumber)
* {
* $this->unsubscribePhoneNumberFromScheduledReport($phoneNumber);
* }
*
* @param string $phoneNumber The phone number that was just deleted.
*/
Piwik::postEvent('MobileMessaging.deletePhoneNumber', array($phoneNumber));
return true;
}
private function retrievePhoneNumbers()
{
$settings = $this->getCurrentUserSettings();
$phoneNumbers = array();
if (isset($settings[MobileMessaging::PHONE_NUMBERS_OPTION])) {
$phoneNumbers = $settings[MobileMessaging::PHONE_NUMBERS_OPTION];
}
return $phoneNumbers;
}
private function savePhoneNumbers($phoneNumbers)
{
$settings = $this->getCurrentUserSettings();
$settings[MobileMessaging::PHONE_NUMBERS_OPTION] = $phoneNumbers;
$this->setCurrentUserSettings($settings);
}
private function increaseCount($option, $phoneNumber)
{
$settings = $this->getCurrentUserSettings();
$counts = array();
if (isset($settings[$option])) {
$counts = $settings[$option];
}
$countToUpdate = 0;
if (isset($counts[$phoneNumber])) {
$countToUpdate = $counts[$phoneNumber];
}
$counts[$phoneNumber] = $countToUpdate + 1;
$settings[$option] = $counts;
$this->setCurrentUserSettings($settings);
}
/**
* validate phone number
*
* @param string $phoneNumber
* @param string $verificationCode
*
* @return bool true if validation code is correct, false otherwise
*/
public function validatePhoneNumber($phoneNumber, $verificationCode)
{
Piwik::checkUserIsNotAnonymous();
$phoneNumbers = $this->retrievePhoneNumbers();
if (isset($phoneNumbers[$phoneNumber])) {
if ($verificationCode == $phoneNumbers[$phoneNumber]) {
$phoneNumbers[$phoneNumber] = null;
$this->savePhoneNumbers($phoneNumbers);
return true;
}
}
return false;
}
/**
* get phone number list
*
* @return array $phoneNumber => $isValidated
* @ignore
*/
public function getPhoneNumbers()
{
Piwik::checkUserIsNotAnonymous();
$rawPhoneNumbers = $this->retrievePhoneNumbers();
$phoneNumbers = array();
foreach ($rawPhoneNumbers as $phoneNumber => $verificationCode) {
$phoneNumbers[$phoneNumber] = self::isActivated($verificationCode);
}
return $phoneNumbers;
}
/**
* get activated phone number list
*
* @return array $phoneNumber
* @ignore
*/
public function getActivatedPhoneNumbers()
{
Piwik::checkUserIsNotAnonymous();
$phoneNumbers = $this->retrievePhoneNumbers();
$activatedPhoneNumbers = array();
foreach ($phoneNumbers as $phoneNumber => $verificationCode) {
if (self::isActivated($verificationCode)) {
$activatedPhoneNumbers[] = $phoneNumber;
}
}
return $activatedPhoneNumbers;
}
private static function isActivated($verificationCode)
{
return $verificationCode === null;
}
/**
* delete the SMS API credential
*
* @return bool true
*/
public function deleteSMSAPICredential()
{
$this->checkCredentialManagementRights();
$settings = $this->getCredentialManagerSettings();
$settings[MobileMessaging::API_KEY_OPTION] = null;
$this->setCredentialManagerSettings($settings);
return true;
}
private function checkCredentialManagementRights()
{
$this->getDelegatedManagement() ? Piwik::checkUserIsNotAnonymous() : Piwik::checkUserHasSuperUserAccess();
}
private function setUserSettings($user, $settings)
{
Option::set(
$user . MobileMessaging::USER_SETTINGS_POSTFIX_OPTION,
json_encode($settings)
);
}
private function setCurrentUserSettings($settings)
{
$this->setUserSettings(Piwik::getCurrentUserLogin(), $settings);
}
private function setCredentialManagerSettings($settings)
{
$this->setUserSettings($this->getCredentialManagerLogin(), $settings);
}
private function getCredentialManagerLogin()
{
return $this->getDelegatedManagement() ? Piwik::getCurrentUserLogin() : '';
}
private function getUserSettings($user)
{
$optionIndex = $user . MobileMessaging::USER_SETTINGS_POSTFIX_OPTION;
$userSettings = Option::get($optionIndex);
if (empty($userSettings)) {
$userSettings = array();
} else {
$userSettings = json_decode($userSettings, true);
}
return $userSettings;
}
private function getCredentialManagerSettings()
{
return $this->getUserSettings($this->getCredentialManagerLogin());
}
private function getCurrentUserSettings()
{
return $this->getUserSettings(Piwik::getCurrentUserLogin());
}
/**
* Specify if normal users can manage their own SMS API credential
*
* @param bool $delegatedManagement false if SMS API credential only manageable by super admin, true otherwise
*/
public function setDelegatedManagement($delegatedManagement)
{
Piwik::checkUserHasSuperUserAccess();
Option::set(MobileMessaging::DELEGATED_MANAGEMENT_OPTION, $delegatedManagement);
}
/**
* Determine if normal users can manage their own SMS API credential
*
* @return bool false if SMS API credential only manageable by super admin, true otherwise
*/
public function getDelegatedManagement()
{
Piwik::checkUserHasSomeViewAccess();
return Option::get(MobileMessaging::DELEGATED_MANAGEMENT_OPTION) == 'true';
}
}
|