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
|
<?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\Container\StaticContainer;
use Piwik\Plugin;
use Piwik\Piwik;
/**
* The SMSProvider abstract class is used as a base class for SMS provider implementations. To create your own custom
* SMSProvider extend this class and implement the methods to send text messages. The class needs to be placed in a
* `SMSProvider` directory of your plugin.
*
* @api
*/
abstract class SMSProvider
{
const MAX_GSM_CHARS_IN_ONE_UNIQUE_SMS = 160;
const MAX_GSM_CHARS_IN_ONE_CONCATENATED_SMS = 153;
const MAX_UCS2_CHARS_IN_ONE_UNIQUE_SMS = 70;
const MAX_UCS2_CHARS_IN_ONE_CONCATENATED_SMS = 67;
/**
* Get the ID of the SMS Provider. Eg 'Clockwork' or 'FreeMobile'
* @return string
*/
abstract public function getId();
/**
* Get a description about the SMS Provider. For example who the SMS Provider is, instructions how the API Key
* needs to be set, and more. You may return HTML here for better formatting.
*
* @return string
*/
abstract public function getDescription();
/**
* Verify the SMS API credential.
*
* @param array $credentials contains credentials (eg. like API key, user name, ...)
* @return bool true if credentials are valid, false otherwise
*/
abstract public function verifyCredential($credentials);
/**
* Get the amount of remaining credits.
*
* @param array $credentials contains credentials (eg. like API key, user name, ...)
* @return string remaining credits
*/
abstract public function getCreditLeft($credentials);
/**
* Actually send the given text message. This method should only send the text message, it should not trigger
* any notifications etc.
*
* @param array $credentials contains credentials (eg. like API key, user name, ...)
* @param string $smsText
* @param string $phoneNumber
* @param string $from
* @return bool true
*/
abstract public function sendSMS($credentials, $smsText, $phoneNumber, $from);
/**
* Defines the fields that needs to be filled up to provide credentials
*
* Example:
* array (
* array(
* 'type' => 'text',
* 'name' => 'apiKey',
* 'title' => 'Translation_Key_To_Use'
* )
* )
*
* @return array
*/
public function getCredentialFields()
{
return array(
array(
'type' => 'text',
'name' => 'apiKey',
'title' => 'MobileMessaging_Settings_APIKey'
)
);
}
/**
* Defines whether the SMS Provider is available. If a certain provider should be used only be a limited
* range of users you can restrict the provider here. For example there is a Development SMS Provider that is only
* available when the development is actually enabled. You could also create a SMS Provider that is only available
* to Super Users etc. Usually this method does not have to be implemented by a SMS Provider.
*
* @return bool
*/
public function isAvailable()
{
return true;
}
/**
* @param string $provider The name of the string
* @return SMSProvider
* @throws \Exception
* @ignore
*/
public static function factory($provider)
{
$providers = self::findAvailableSmsProviders();
if (!array_key_exists($provider, $providers)) {
throw new \Exception(Piwik::translate('MobileMessaging_Exception_UnknownProvider',
array($provider, implode(', ', array_keys($providers)))
));
}
return $providers[$provider];
}
/**
* Returns all available SMS Providers
*
* @return SMSProvider[]
* @ignore
*/
public static function findAvailableSmsProviders()
{
/** @var SMSProvider[] $smsProviders */
$smsProviders = Plugin\Manager::getInstance()->findMultipleComponents('SMSProvider', 'Piwik\Plugins\MobileMessaging\SMSProvider');
$providers = array();
foreach ($smsProviders as $provider) {
/** @var SMSProvider $provider */
$provider = StaticContainer::get($provider);
if ($provider->isAvailable()) {
$providers[$provider->getId()] = $provider;
}
}
return $providers;
}
/**
* Assert whether a given String contains UCS2 characters
*
* @param string $string
* @return bool true if $string contains UCS2 characters
* @ignore
*/
public static function containsUCS2Characters($string)
{
$GSMCharsetAsString = implode(array_keys(GSMCharset::$GSMCharset));
foreach (self::mb_str_split($string) as $char) {
if (mb_strpos($GSMCharsetAsString, $char) === false) {
return true;
}
}
return false;
}
/**
* Truncate $string and append $appendedString at the end if $string can not fit the
* the $maximumNumberOfConcatenatedSMS.
*
* @param string $string String to truncate
* @param int $maximumNumberOfConcatenatedSMS
* @param string $appendedString
* @return string original $string or truncated $string appended with $appendedString
* @ignore
*/
public static function truncate($string, $maximumNumberOfConcatenatedSMS, $appendedString = 'MobileMessaging_SMS_Content_Too_Long')
{
$appendedString = Piwik::translate($appendedString);
$smsContentContainsUCS2Chars = self::containsUCS2Characters($string);
$maxCharsAllowed = self::maxCharsAllowed($maximumNumberOfConcatenatedSMS, $smsContentContainsUCS2Chars);
$sizeOfSMSContent = self::sizeOfSMSContent($string, $smsContentContainsUCS2Chars);
if ($sizeOfSMSContent <= $maxCharsAllowed) return $string;
$smsContentContainsUCS2Chars = $smsContentContainsUCS2Chars || self::containsUCS2Characters($appendedString);
$maxCharsAllowed = self::maxCharsAllowed($maximumNumberOfConcatenatedSMS, $smsContentContainsUCS2Chars);
$sizeOfSMSContent = self::sizeOfSMSContent($string . $appendedString, $smsContentContainsUCS2Chars);
$sizeToTruncate = $sizeOfSMSContent - $maxCharsAllowed;
$subStrToTruncate = '';
$subStrSize = 0;
$reversedStringChars = array_reverse(self::mb_str_split($string));
for ($i = 0; $subStrSize < $sizeToTruncate; $i++) {
$subStrToTruncate = $reversedStringChars[$i] . $subStrToTruncate;
$subStrSize = self::sizeOfSMSContent($subStrToTruncate, $smsContentContainsUCS2Chars);
}
return preg_replace('/' . preg_quote($subStrToTruncate, '/') . '$/', $appendedString, $string);
}
private static function mb_str_split($string)
{
return preg_split('//u', $string, -1, PREG_SPLIT_NO_EMPTY);
}
private static function sizeOfSMSContent($smsContent, $containsUCS2Chars)
{
if ($containsUCS2Chars) return Common::mb_strlen($smsContent);
$sizeOfSMSContent = 0;
foreach (self::mb_str_split($smsContent) as $char) {
$sizeOfSMSContent += GSMCharset::$GSMCharset[$char];
}
return $sizeOfSMSContent;
}
private static function maxCharsAllowed($maximumNumberOfConcatenatedSMS, $containsUCS2Chars)
{
$maxCharsInOneUniqueSMS = $containsUCS2Chars ? self::MAX_UCS2_CHARS_IN_ONE_UNIQUE_SMS : self::MAX_GSM_CHARS_IN_ONE_UNIQUE_SMS;
$maxCharsInOneConcatenatedSMS = $containsUCS2Chars ? self::MAX_UCS2_CHARS_IN_ONE_CONCATENATED_SMS : self::MAX_GSM_CHARS_IN_ONE_CONCATENATED_SMS;
$uniqueSMS = $maximumNumberOfConcatenatedSMS == 1;
return $uniqueSMS ?
$maxCharsInOneUniqueSMS :
$maxCharsInOneConcatenatedSMS * $maximumNumberOfConcatenatedSMS;
}
}
|