windowsphonepush/windowsphonepush.php

   1 <?php
   2
   3 /**
   4  * Name: WindowsPhonePush
   5  * Description: Enable push notification to send information to Friendica Mobile app on Windows phone (count of unread timeline entries, text of last posting - if wished by user)
   6  * Version: 2.0
   7  * Author: Gerhard Seeber <http://friendica.seeber.at/profile/admin>
   8  *
   9  *
  10  * Pre-requisite: Windows Phone mobile device (at least WP 7.0)
  11  *                Friendica mobile app on Windows Phone
  12  *
  13  * When addon is installed, the system calls the addon
  14  * name_install() function, located in 'addon/name/name.php',
  15  * where 'name' is the name of the addon.
  16  * If the addon is removed from the configuration list, the
  17  * system will call the name_uninstall() function.
  18  *
  19  * Version history:
  20  * 1.1  : addon crashed on php versions >= 5.4 as of removed deprecated call-time
  21  *        pass-by-reference used in function calls within function windowsphonepush_content
  22  * 2.0  : adaption for supporting emphasizing new entries in app (count on tile cannot be read out,
  23  *        so we need to retrieve counter through show_settings secondly). Provide new function for
  24  *        calling from app to set the counter back after start (if user starts again before cronjob
  25  *        sets the counter back
  26  *        count only unseen elements which are not type=activity (likes and dislikes not seen as new elements)
  27  */
  28
  29 use Friendica\App;
  30 use Friendica\Content\Text\BBCode;
  31 use Friendica\Content\Text\HTML;
  32 use Friendica\Core\Hook;
  33 use Friendica\Core\Logger;
  34 use Friendica\Database\DBA;
  35 use Friendica\DI;
  36 use Friendica\Model\Item;
  37 use Friendica\Model\Post;
  38 use Friendica\Model\User;
  39 use Friendica\Network\HTTPException\UnauthorizedException;
  40
  41 function windowsphonepush_install()
  42 {
  43         /* Our addon will attach in three places.
  44          * The first is within cron - so the push notifications will be
  45          * sent every 10 minutes (or whatever is set in crontab).
  46          */
  47         Hook::register('cron', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_cron');
  48
  49         /* Then we'll attach into the addon settings page, and also the
  50          * settings post hook so that we can create and update
  51          * user preferences. User shall be able to activate the addon and
  52          * define whether he allows pushing first characters of item text
  53          */
  54         Hook::register('addon_settings', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings');
  55         Hook::register('addon_settings_post', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings_post');
  56
  57         Logger::notice("installed windowsphonepush");
  58 }
  59
  60 /* declare the windowsphonepush function so that /windowsphonepush url requests will land here */
  61 function windowsphonepush_module()
  62 {
  63
  64 }
  65
  66 /* Callback from the settings post function.
  67  * $post contains the $_POST array.
  68  * We will make sure we've got a valid user account
  69  * and if so set our configuration setting for this person.
  70  */
  71 function windowsphonepush_settings_post($a, $post)
  72 {
  73         if (!local_user() || empty($_POST['windowsphonepush-submit'])) {
  74                 return;
  75         }
  76         $enable = intval($_POST['windowsphonepush']);
  77         DI::pConfig()->set(local_user(), 'windowsphonepush', 'enable', $enable);
  78
  79         if ($enable) {
  80                 DI::pConfig()->set(local_user(), 'windowsphonepush', 'counterunseen', 0);
  81         }
  82
  83         DI::pConfig()->set(local_user(), 'windowsphonepush', 'senditemtext', intval($_POST['windowsphonepush-senditemtext']));
  84 }
  85
  86 /* Called from the Addon Setting form.
  87  * Add our own settings info to the page.
  88  */
  89 function windowsphonepush_settings(&$a, &$s)
  90 {
  91         if (!local_user()) {
  92                 return;
  93         }
  94
  95         /* Add our stylesheet to the page so we can make our settings look nice */
  96         DI::page()['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . DI::baseUrl()->get() . '/addon/windowsphonepush/windowsphonepush.css' . '" media="all" />' . "\r\n";
  97
  98         /* Get the current state of our config variables */
  99         $enabled = DI::pConfig()->get(local_user(), 'windowsphonepush', 'enable');
 100         $checked_enabled = (($enabled) ? ' checked="checked" ' : '');
 101
 102         $senditemtext = DI::pConfig()->get(local_user(), 'windowsphonepush', 'senditemtext');
 103         $checked_senditemtext = (($senditemtext) ? ' checked="checked" ' : '');
 104
 105         $device_url = DI::pConfig()->get(local_user(), 'windowsphonepush', 'device_url');
 106
 107         /* Add some HTML to the existing form */
 108         $s .= '<div class="settings-block">';
 109         $s .= '<h3>' . DI::l10n()->t('WindowsPhonePush Settings') . '</h3>';
 110
 111         $s .= '<div id="windowsphonepush-enable-wrapper">';
 112         $s .= '<label id="windowsphonepush-enable-label" for="windowsphonepush-enable-chk">' . DI::l10n()->t('Enable WindowsPhonePush Addon') . '</label>';
 113         $s .= '<input id="windowsphonepush-enable-chk" type="checkbox" name="windowsphonepush" value="1" ' . $checked_enabled . '/>';
 114         $s .= '</div><div class="clear"></div>';
 115
 116         $s .= '<div id="windowsphonepush-senditemtext-wrapper">';
 117         $s .= '<label id="windowsphonepush-senditemtext-label" for="windowsphonepush-senditemtext-chk">' . DI::l10n()->t('Push text of new item') . '</label>';
 118         $s .= '<input id="windowsphonepush-senditemtext-chk" type="checkbox" name="windowsphonepush-senditemtext" value="1" ' . $checked_senditemtext . '/>';
 119         $s .= '</div><div class="clear"></div>';
 120
 121         /* provide a submit button - enable und senditemtext can be changed by the user */
 122         $s .= '<div class="settings-submit-wrapper" ><input type="submit" id="windowsphonepush-submit" name="windowsphonepush-submit" class="settings-submit" value="' . DI::l10n()->t('Save Settings') . '" /></div><div class="clear"></div>';
 123
 124         /* provide further read-only information concerning the addon (useful for */
 125         $s .= '<div id="windowsphonepush-device_url-wrapper">';
 126         $s .= '<label id="windowsphonepush-device_url-label" for="windowsphonepush-device_url-text">Device-URL</label>';
 127         $s .= '<input id="windowsphonepush-device_url-text" type="text" readonly value=' . $device_url . '/>';
 128         $s .= '</div><div class="clear"></div></div>';
 129
 130         return;
 131 }
 132
 133 /* Cron function used to regularly check all users on the server with active windowsphonepushaddon and send
 134  * notifications to the Microsoft servers and consequently to the Windows Phone device
 135  */
 136 function windowsphonepush_cron()
 137 {
 138         // retrieve all UID's for which the addon windowsphonepush is enabled and loop through every user
 139         $pconfigs = DBA::selectToArray('pconfig', ['uid'], ['cat' => 'windowsphonepush', 'k' => 'enable', 'v' => true]);
 140         foreach ($pconfigs as $rr) {
 141                 // load stored information for the user-id of the current loop
 142                 $device_url = DI::pConfig()->get($rr['uid'], 'windowsphonepush', 'device_url');
 143                 $lastpushid = DI::pConfig()->get($rr['uid'], 'windowsphonepush', 'lastpushid');
 144
 145                 // pushing only possible if device_url (the URI on Microsoft server) is available or not "NA" (which will be sent
 146                 // by app if user has switched the server setting in app - sending blank not possible as this would return an update error)
 147                 if (( $device_url == "" ) || ( $device_url == "NA" )) {
 148                         // no Device-URL for the user availabe, but addon is enabled --> write info to Logger
 149                         Logger::notice("WARN: windowsphonepush is enable for user " . $rr['uid'] . ", but no Device-URL is specified for the user.");
 150                 } else {
 151                         // retrieve the number of unseen items and the id of the latest one (if there are more than
 152                         // one new entries since last poller run, only the latest one will be pushed)
 153                         $count = DBA::fetchFirst("SELECT count(`id`) AS count, max(`id`) AS max FROM `post-view` WHERE `unseen` AND `type` != ? AND `uid` = ?", 'activity', $rr['uid']);
 154
 155                         // send number of unseen items to the device (the number will be displayed on Start screen until
 156                         // App will be started by user) - this update will be sent every 10 minutes to update the number to 0 if
 157                         // user has loaded the timeline through app or website
 158                         $res_tile = send_tile_update($device_url, "", $count['count'], "");
 159                         switch (trim($res_tile)) {
 160                                 case "Received":
 161                                         // ok, count has been pushed, let's save it in personal settings
 162                                         DI::pConfig()->set($rr['uid'], 'windowsphonepush', 'counterunseen', $count['count']);
 163                                         break;
 164                                 case "QueueFull":
 165                                         // maximum of 30 messages reached, server rejects any further push notification until device reconnects
 166                                         Logger::notice("INFO: Device-URL '" . $device_url . "' returns a QueueFull.");
 167                                         break;
 168                                 case "Suppressed":
 169                                         // notification received and dropped as something in app was not enabled
 170                                         Logger::notice("WARN. Device-URL '" . $device_url . "' returns a Suppressed. Unexpected error in Mobile App?");
 171                                         break;
 172                                 case "Dropped":
 173                                         // mostly combines with Expired, in that case Device-URL will be deleted from pconfig (function send_push)
 174                                         break;
 175                                 default:
 176                                         // error, mostly called by "" which means that the url (not "" which has been checked)
 177                                         // didn't not received Microsoft Notification Server -> wrong url
 178                                         Logger::notice("ERROR: specified Device-URL '" . $device_url . "' didn't produced any response.");
 179                         }
 180
 181                         // additionally user receives the text of the newest item (function checks against last successfully pushed item)
 182                         if (intval($count['max']) > intval($lastpushid)) {
 183                                 // user can define if he wants to see the text of the item in the push notification
 184                                 // this has been implemented as the device_url is not a https uri (not so secure)
 185                                 $senditemtext = DI::pConfig()->get($rr['uid'], 'windowsphonepush', 'senditemtext');
 186                                 if ($senditemtext == 1) {
 187                                         // load item with the max id
 188                                         $item = Post::selectFirst(['author-name', 'body', 'uri-id'], ['id' => $count['max']]);
 189
 190                                         // as user allows to send the item, we want to show the sender of the item in the toast
 191                                         // toasts are limited to one line, therefore place is limited - author shall be in
 192                                         // max. 15 chars (incl. dots); author is displayed in bold font
 193                                         $author = $item['author-name'];
 194                                         $author = ((strlen($author) > 12) ? substr($author, 0, 12) . "..." : $author);
 195
 196                                         // normally we show the body of the item, however if it is an url or an image we cannot
 197                                         // show this in the toast (only test), therefore changing to an alternate text
 198                                         // Otherwise BBcode-Tags will be eliminated and plain text cutted to 140 chars (incl. dots)
 199                                         // BTW: information only possible in English
 200                                         $body = $item['body'];
 201                                         if (substr($body, 0, 4) == "[url") {
 202                                                 $body = "URL/Image ...";
 203                                         } else {
 204                                                 $body = BBCode::convertForUriId($item['uri-id'], $body, BBCode::API);
 205                                                 $body = HTML::toPlaintext($body, 0);
 206                                                 $body = ((strlen($body) > 137) ? substr($body, 0, 137) . "..." : $body);
 207                                         }
 208                                 } else {
 209                                         // if user wishes higher privacy, we only display "Friendica - New timeline entry arrived"
 210                                         $author = "Friendica";
 211                                         $body = "New timeline entry arrived ...";
 212                                 }
 213                                 // only if toast push notification returns the Notification status "Received" we will update th settings with the
 214                                 // new indicator max-id is checked against (QueueFull, Suppressed, N/A, Dropped shall qualify to resend
 215                                 // the push notification some minutes later (BTW: if resulting in Expired for subscription status the
 216                                 // device_url will be deleted (no further try on this url, see send_push)
 217                                 // further log information done on count pushing with send_tile (see above)
 218                                 $res_toast = send_toast($device_url, $author, $body);
 219                                 if (trim($res_toast) === 'Received') {
 220                                         DI::pConfig()->set($rr['uid'], 'windowsphonepush', 'lastpushid', $count['max']);
 221                                 }
 222                         }
 223                 }
 224         }
 225 }
 226
 227 /* Tile push notification change the number in the icon of the App in Start Screen of
 228  * a Windows Phone Device, Image could be changed, not used for App "Friendica Mobile"
 229  */
 230 function send_tile_update($device_url, $image_url, $count, $title, $priority = 1)
 231 {
 232         $msg = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" .
 233                 "<wp:Notification xmlns:wp=\"WPNotification\">" .
 234                 "<wp:Tile>" .
 235                 "<wp:BackgroundImage>" . $image_url . "</wp:BackgroundImage>" .
 236                 "<wp:Count>" . $count . "</wp:Count>" .
 237                 "<wp:Title>" . $title . "</wp:Title>" .
 238                 "</wp:Tile> " .
 239                 "</wp:Notification>";
 240
 241         $result = send_push($device_url, [
 242                 'X-WindowsPhone-Target: token',
 243                 'X-NotificationClass: ' . $priority,
 244                 ], $msg);
 245         return $result;
 246 }
 247
 248 /* Toast push notification send information to the top of the display
 249  * if the user is not currently using the Friendica Mobile App, however
 250  * there is only one line for displaying the information
 251  */
 252 function send_toast($device_url, $title, $message, $priority = 2)
 253 {
 254         $msg = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" .
 255                 "<wp:Notification xmlns:wp=\"WPNotification\">" .
 256                 "<wp:Toast>" .
 257                 "<wp:Text1>" . $title . "</wp:Text1>" .
 258                 "<wp:Text2>" . $message . "</wp:Text2>" .
 259                 "<wp:Param></wp:Param>" .
 260                 "</wp:Toast>" .
 261                 "</wp:Notification>";
 262
 263         $result = send_push($device_url, [
 264                 'X-WindowsPhone-Target: toast',
 265                 'X-NotificationClass: ' . $priority,
 266                 ], $msg);
 267         return $result;
 268 }
 269
 270 // General function to send the push notification via cURL
 271 function send_push($device_url, $headers, $msg)
 272 {
 273         $ch = curl_init();
 274         curl_setopt($ch, CURLOPT_URL, $device_url);
 275         curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
 276         curl_setopt($ch, CURLOPT_POST, true);
 277         curl_setopt($ch, CURLOPT_HEADER, true);
 278         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers + [
 279                 'Content-Type: text/xml',
 280                 'charset=utf-8',
 281                 'Accept: application/*',
 282                 ]
 283         );
 284         curl_setopt($ch, CURLOPT_POSTFIELDS, $msg);
 285
 286         $output = curl_exec($ch);
 287         curl_close($ch);
 288
 289         // if we received "Expired" from Microsoft server we will delete the obsolete device-URL
 290         // and log this fact
 291         $subscriptionStatus = get_header_value($output, 'X-SubscriptionStatus');
 292         if ($subscriptionStatus == "Expired") {
 293                 DI::pConfig()->set(local_user(), 'windowsphonepush', 'device_url', "");
 294                 Logger::notice("ERROR: the stored Device-URL " . $device_url . "returned an 'Expired' error, it has been deleted now.");
 295         }
 296
 297         // the notification status shall be returned to windowsphonepush_cron (will
 298         // update settings if 'Received' otherwise keep old value in settings (on QueuedFull. Suppressed, N/A, Dropped)
 299         $notificationStatus = get_header_value($output, 'X-NotificationStatus');
 300         return $notificationStatus;
 301 }
 302
 303 // helper function to receive statuses from webresponse of Microsoft server
 304 function get_header_value($content, $header)
 305 {
 306         return preg_match_all("/$header: (.*)/i", $content, $match) ? $match[1][0] : "";
 307 }
 308
 309 /* reading information from url and deciding which function to start
 310  * show_settings = delivering settings to check
 311  * update_settings = set the device_url
 312  * update_counterunseen = set counter for unseen elements to zero
 313  */
 314 function windowsphonepush_content(App $a)
 315 {
 316         // Login with the specified Network credentials (like in api.php)
 317         windowsphonepush_login($a);
 318
 319         $path = DI::args()->getArgv()[0];
 320         $path2 = DI::args()->getArgv()[1];
 321         if ($path == "windowsphonepush") {
 322                 switch ($path2) {
 323                         case "show_settings":
 324                                 windowsphonepush_showsettings($a);
 325                                 exit();
 326                                 break;
 327                         case "update_settings":
 328                                 $ret = windowsphonepush_updatesettings($a);
 329                                 header("Content-Type: application/json; charset=utf-8");
 330                                 echo json_encode(['status' => $ret]);
 331                                 exit();
 332                                 break;
 333                         case "update_counterunseen":
 334                                 $ret = windowsphonepush_updatecounterunseen();
 335                                 header("Content-Type: application/json; charset=utf-8");
 336                                 echo json_encode(['status' => $ret]);
 337                                 exit();
 338                                 break;
 339                         default:
 340                                 echo "Fehler";
 341                 }
 342         }
 343 }
 344
 345 // return settings for windowsphonepush addon to be able to check them in WP app
 346 function windowsphonepush_showsettings()
 347 {
 348         if (!local_user()) {
 349                 return;
 350         }
 351
 352         $enable = DI::pConfig()->get(local_user(), 'windowsphonepush', 'enable');
 353         $device_url = DI::pConfig()->get(local_user(), 'windowsphonepush', 'device_url');
 354         $senditemtext = DI::pConfig()->get(local_user(), 'windowsphonepush', 'senditemtext');
 355         $lastpushid = DI::pConfig()->get(local_user(), 'windowsphonepush', 'lastpushid');
 356         $counterunseen = DI::pConfig()->get(local_user(), 'windowsphonepush', 'counterunseen');
 357         $addonversion = "2.0";
 358
 359         if (!$device_url) {
 360                 $device_url = "";
 361         }
 362
 363         if (!$lastpushid) {
 364                 $lastpushid = 0;
 365         }
 366
 367         header("Content-Type: application/json");
 368         echo json_encode(['uid' => local_user(),
 369                 'enable' => $enable,
 370                 'device_url' => $device_url,
 371                 'senditemtext' => $senditemtext,
 372                 'lastpushid' => $lastpushid,
 373                 'counterunseen' => $counterunseen,
 374                 'addonversion' => $addonversion]);
 375 }
 376
 377 /* update_settings is used to transfer the device_url from WP device to the Friendica server
 378  * return the status of the operation to the server
 379  */
 380 function windowsphonepush_updatesettings()
 381 {
 382         if (!local_user()) {
 383                 return "Not Authenticated";
 384         }
 385
 386         // no updating if user hasn't enabled the addon
 387         $enable = DI::pConfig()->get(local_user(), 'windowsphonepush', 'enable');
 388         if (!$enable) {
 389                 return "Plug-in not enabled";
 390         }
 391
 392         // check if sent url is empty - don't save and send return code to app
 393         $device_url = $_POST['deviceurl'];
 394         if ($device_url == "") {
 395                 Logger::notice("ERROR: no valid Device-URL specified - client transferred '" . $device_url . "'");
 396                 return "No valid Device-URL specified";
 397         }
 398
 399         // check if sent url is already stored in database for another user, we assume that there was a change of
 400         // the user on the Windows Phone device and that device url is no longer true for the other user, so we
 401         // et the device_url for the OTHER user blank (should normally not occur as App should include User/server
 402         // in url request to Microsoft Push Notification server)
 403         $pconfigs = DBA::selectToArray('pconfig', ['uid'], ["`uid` != ? AND `cat` = ? AND `k` = ? AND `v` = ?", local_user(), 'windowsphonepush', 'device_url', $device_url]);
 404         foreach ($pconfigs as $rr) {
 405                 DI::pConfig()->set($rr['uid'], 'windowsphonepush', 'device_url', '');
 406                 Logger::notice("WARN: the sent URL was already registered with user '" . $rr['uid'] . "'. Deleted for this user as we expect to be correct now for user '" . local_user() . "'.");
 407         }
 408
 409         DI::pConfig()->set(local_user(), 'windowsphonepush', 'device_url', $device_url);
 410         // output the successfull update of the device URL to the logger for error analysis if necessary
 411         Logger::notice("INFO: Device-URL for user '" . local_user() . "' has been updated with '" . $device_url . "'");
 412         return "Device-URL updated successfully!";
 413 }
 414
 415 // update_counterunseen is used to reset the counter to zero from Windows Phone app
 416 function windowsphonepush_updatecounterunseen()
 417 {
 418         if (!local_user()) {
 419                 return "Not Authenticated";
 420         }
 421
 422         // no updating if user hasn't enabled the addon
 423         $enable = DI::pConfig()->get(local_user(), 'windowsphonepush', 'enable');
 424         if (!$enable) {
 425                 return "Plug-in not enabled";
 426         }
 427
 428         DI::pConfig()->set(local_user(), 'windowsphonepush', 'counterunseen', 0);
 429         return "Counter set to zero";
 430 }
 431
 432 /* helper function to login to the server with the specified Network credentials
 433  * (mainly copied from api.php)
 434  */
 435 function windowsphonepush_login(App $a)
 436 {
 437         if (!isset($_SERVER['PHP_AUTH_USER'])) {
 438                 Logger::info('API_login: ' . print_r($_SERVER, true));
 439                 header('WWW-Authenticate: Basic realm="Friendica"');
 440                 throw new UnauthorizedException('This api requires login');
 441         }
 442
 443         $user_id = User::authenticate($_SERVER['PHP_AUTH_USER'], trim($_SERVER['PHP_AUTH_PW']));
 444
 445         if ($user_id) {
 446                 $record = DBA::selectFirst('user', [], ['uid' => $user_id]);
 447         } else {
 448                 Logger::info('API_login failure: ' . print_r($_SERVER, true));
 449                 header('WWW-Authenticate: Basic realm="Friendica"');
 450                 throw new UnauthorizedException('This api requires login');
 451         }
 452
 453         DI::auth()->setForUser($a, $record);
 454         DI::session()->set('allow_api', true);
 455         Hook::callAll('logged_in', $record);
 456 }