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