From 1c8eba5ea20ef071b256eba5b6e6d0fef20d939d Mon Sep 17 00:00:00 2001 From: gerhard6380 Date: Fri, 17 Oct 2014 13:32:34 +0200 Subject: [PATCH 1/2] Addon WindowsPhonePush Addon serves 3 tasks: 1) deliver settings in json format 2) update settings with the device URL 3) cron-hook to regularly check and push new entries --- windowsphonepush/lang/de/messages.po | 30 ++ windowsphonepush/lang/de/strings.php | 13 + windowsphonepush/windowsphonepush.css | 36 ++ windowsphonepush/windowsphonepush.php | 473 ++++++++++++++++++++++++++ 4 files changed, 552 insertions(+) create mode 100644 windowsphonepush/lang/de/messages.po create mode 100644 windowsphonepush/lang/de/strings.php create mode 100644 windowsphonepush/windowsphonepush.css create mode 100644 windowsphonepush/windowsphonepush.php diff --git a/windowsphonepush/lang/de/messages.po b/windowsphonepush/lang/de/messages.po new file mode 100644 index 000000000..543df1cc6 --- /dev/null +++ b/windowsphonepush/lang/de/messages.po @@ -0,0 +1,30 @@ +# ADDON windowsphonepush +# Copyright (C) +# This file is distributed under the same license as the Friendica windowsphonepush addon package. +# +# +# Translators: +# Gerhard Seeber , 2014 +msgid "" +msgstr "" + +#: windowsphonepush.php:85 +msgid "WindowsPhonePush settings updated." +msgstr "WindowsPhonePush Einstellungen aktualisiert" + +#: geonames.php:114 +msgid "WindowsPhonePush Settings" +msgstr "WindowsPhonePush Einstellungen" + +#: geonames.php:117 +msgid "Enable WindowsPhonePush Plugin" +msgstr "WindowsPhonePush Plugin aktivieren" + +#: windowspushphone.php: 122 +msgid "Push text of new item" +msgstr "Sende Text aus neuem Eintrag" + +#: geonames.php:127 +msgid "Save Settings" +msgstr "Einstellungen speichern" + diff --git a/windowsphonepush/lang/de/strings.php b/windowsphonepush/lang/de/strings.php new file mode 100644 index 000000000..e6cb72aa2 --- /dev/null +++ b/windowsphonepush/lang/de/strings.php @@ -0,0 +1,13 @@ +strings["WindowsPhonePush settings updated."] = "WindowsPhonePush Einstellungen aktualisiert"; +$a->strings["WindowsPhonePush Settings"] = "WindowsPhonePush Einstellungen"; +$a->strings["Enable WindowsPhonePush Plugin"] = "WindowsPhonePush Plugin aktivieren"; +$a->strings["Push text of new item"] = "Sende Text aus neuem Eintrag"; +$a->strings["Save Settings"] = "Einstellungen speichern"; + diff --git a/windowsphonepush/windowsphonepush.css b/windowsphonepush/windowsphonepush.css new file mode 100644 index 000000000..95ba6d2c5 --- /dev/null +++ b/windowsphonepush/windowsphonepush.css @@ -0,0 +1,36 @@ +#windowsphonepush-device_url-wrapper { + margin-top: 25px; +} + + +#windowsphonepush-enable-label { + float: left; + width: 200px; + margin-bottom: 25px; +} + +#windowsphonepush-enable-chk { + float: left; +} + +#windowsphonepush-device_url-label { + float: left; + width: 200px; + margin-bottom: 25px; +} + +#windowsphonepush-device_url-text { + float: left; + background-color: #C0C0C0; + width: 500px; +} + +#windowsphonepush-senditemtext-label { + float: left; + width: 200px; + margin-bottom: 25px; +} + +#windowsphonepush-senditemtext-chk { + float: left; +} diff --git a/windowsphonepush/windowsphonepush.php b/windowsphonepush/windowsphonepush.php new file mode 100644 index 000000000..77b0b4678 --- /dev/null +++ b/windowsphonepush/windowsphonepush.php @@ -0,0 +1,473 @@ + + * + * + * Pre-requisite: Windows Phone mobile device (at least WP 7.0) + * Friendica mobile app on Windows Phone + * + * When plugin is installed, the system calls the plugin + * name_install() function, located in 'addon/name/name.php', + * where 'name' is the name of the addon. + * If the addon is removed from the configuration list, the + * system will call the name_uninstall() function. + * + */ + + +function windowsphonepush_install() { + + /** + * + * Our plugin will attach in three places. + * The first is within cron - so the push notifications will be + * sent every 10 minutes (or whatever is set in crontab). + * + */ + + register_hook('cron', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_cron'); + + /** + * + * Then we'll attach into the plugin settings page, and also the + * settings post hook so that we can create and update + * user preferences. User shall be able to activate the plugin and + * define whether he allows pushing first characters of item text + * + */ + + register_hook('plugin_settings', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings'); + register_hook('plugin_settings_post', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings_post'); + + logger("installed windowsphonepush"); +} + + +function windowsphonepush_uninstall() { + + /** + * + * uninstall unregisters any hooks created with register_hook + * during install. Don't delete data in table `pconfig`. + * + */ + + unregister_hook('cron', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_cron'); + unregister_hook('plugin_settings', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings'); + unregister_hook('plugin_settings_post', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings_post'); + + logger("removed windowsphonepush"); +} + + +/* declare the windowsphonepush function so that /windowsphonepush url requests will land here */ +function windowsphonepush_module() {} + + +/** + * + * Callback from the settings post function. + * $post contains the $_POST array. + * We will make sure we've got a valid user account + * and if so set our configuration setting for this person. + * + */ +function windowsphonepush_settings_post($a,$post) { + if(! local_user() || (! x($_POST,'windowsphonepush-submit'))) + return; + + set_pconfig(local_user(),'windowsphonepush','enable',intval($_POST['windowsphonepush'])); + set_pconfig(local_user(),'windowsphonepush','senditemtext',intval($_POST['windowsphonepush-senditemtext'])); + + info( t('WindowsPhonePush settings updated.') . EOL); +} + + +/** + * + * Called from the Plugin Setting form. + * Add our own settings info to the page. + * + */ +function windowsphonepush_settings(&$a,&$s) { + + if(! local_user()) + return; + + /* Add our stylesheet to the page so we can make our settings look nice */ + $a->page['htmlhead'] .= '' . "\r\n"; + + /* Get the current state of our config variables */ + $enabled = get_pconfig(local_user(),'windowsphonepush','enable'); + $checked_enabled = (($enabled) ? ' checked="checked" ' : ''); + + $senditemtext = get_pconfig(local_user(), 'windowsphonepush', 'senditemtext'); + $checked_senditemtext = (($senditemtext) ? ' checked="checked" ' : ''); + + $device_url = get_pconfig(local_user(), 'windowsphonepush', 'device_url'); + + /* Add some HTML to the existing form */ + $s .= '
'; + $s .= '

' . t('WindowsPhonePush Settings') . '

'; + + $s .= '
'; + $s .= ''; + $s .= ''; + $s .= '
'; + + $s .= '
'; + $s .= ''; + $s .= ''; + $s .= '
'; + + /* provide a submit button - enable und senditemtext can be changed by the user*/ + $s .= '
'; + + /* provide further read-only information concerning the addon (useful for */ + $s .= '
'; + $s .= ''; + $s .= ''; + $s .= '
'; + + return; + +} + + +/** + * + * Cron function used to regularly check all users on the server with active windowsphonepushplugin and send + * notifications to the Microsoft servers and consequently to the Windows Phone device + * + */ + +function windowsphonepush_cron() { + // retrieve all UID's for which the plugin windowsphonepush is enabled and loop through every user + $r = q("SELECT * FROM `pconfig` WHERE `cat` = 'windowsphonepush' AND `k` = 'enable' AND `v` = 1"); + if(count($r)) { + foreach($r as $rr) { + // load stored information for the user-id of the current loop + $device_url = get_pconfig($rr['uid'], 'windowsphonepush', 'device_url'); + $lastpushid = get_pconfig($rr['uid'], 'windowsphonepush', 'lastpushid'); + + // pushing only possible if device_url (the URI on Microsoft server) is available or not "NA" (which will be sent + // by app if user has switched the server setting in app - sending blank not possible as this would return an update error) + if ( ( $device_url == "" ) || ( $device_url == "NA" ) ) { + // no Device-URL for the user availabe, but plugin is enabled --> write info to Logger + logger("WARN: windowsphonepush is enable for user " . $rr['uid'] . ", but no Device-URL is specified for the user."); + } else { + // retrieve the number of unseen items and the id of the latest one (if there are more than + // one new entries since last poller run, only the latest one will be pushed) + $count = q("SELECT count(`id`) as count, max(`id`) as max FROM `item` WHERE `unseen` = 1 AND `uid` = %d", + intval($rr['uid']) + ); + + // send number of unseen items to the device (the number will be displayed on Start screen until + // App will be started by user) - this update will be sent every 10 minutes to update the number to 0 if + // user has loaded the timeline through app or website + $res_tile = send_tile_update($device_url, "", $count[0]['count'], ""); + switch (trim($res_tile)) { + case "Received": + // ok, count has been pushed + break; + case "QueueFull": + // maximum of 30 messages reached, server rejects any further push notification until device reconnects + logger("INFO: Device-URL '" . $device_url . "' returns a QueueFull."); + break; + case "Suppressed": + // notification received and dropped as something in app was not enabled + logger("WARN. Device-URL '" . $device_url . "' returns a Suppressed. Unexpected error in Mobile App?"); + break; + case "Dropped": + // mostly combines with Expired, in that case Device-URL will be deleted from pconfig (function send_push) + break; + default: + // error, mostly called by "" which means that the url (not "" which has been checked) + // didn't not received Microsoft Notification Server -> wrong url + logger("ERROR: specified Device-URL '" . $device_url . "' didn't produced any response."); + } + + // additionally user receives the text of the newest item (function checks against last successfully pushed item) + if (intval($count[0]['max']) > intval($lastpushid)) { + // user can define if he wants to see the text of the item in the push notification + // this has been implemented as the device_url is not a https uri (not so secure) + $senditemtext = get_pconfig($rr['uid'], 'windowsphonepush', 'senditemtext'); + if ($senditemtext == 1) { + // load item with the max id + $item = q("SELECT `author-name` as author, `body` as body FROM `item` where `id` = %d", + intval($count[0]['max']) + ); + + // as user allows to send the item, we want to show the sender of the item in the toast + // toasts are limited to one line, therefore place is limited - author shall be in + // max. 15 chars (incl. dots); author is displayed in bold font + $author = $item[0]['author']; + $author = ((strlen($author) > 12) ? substr($author, 0, 12) . "..." : $author); + + // normally we show the body of the item, however if it is an url or an image we cannot + // show this in the toast (only test), therefore changing to an alternate text + // Otherwise BBcode-Tags will be eliminated and plain text cutted to 140 chars (incl. dots) + // BTW: information only possible in English + $body = $item[0]['body']; + if (substr($body, 0, 4) == "[url") + $body = "URL/Image ..."; + else { + require_once('include/bbcode.php'); + require_once("include/html2plain.php"); + $body = bbcode($body, false, false, 2, true); + $body = html2plain($body, 0); + $body = ((strlen($body) > 137) ? substr($body, 0, 137) . "..." : $body); + } + } else { + // if user wishes higher privacy, we only display "Friendica - New timeline entry arrived" + $author = "Friendica"; + $body = "New timeline entry arrived ..."; + } + // only if toast push notification returns the Notification status "Received" we will update th settings with the + // new indicator max-id is checked against (QueueFull, Suppressed, N/A, Dropped shall qualify to resend + // the push notification some minutes later (BTW: if resulting in Expired for subscription status the + // device_url will be deleted (no further try on this url, see send_push) + // further log information done on count pushing with send_tile (see above) + $res_toast = send_toast($device_url, $author, $body); + if (trim($res_toast) === 'Received') { + set_pconfig($rr['uid'], 'windowsphonepush', 'lastpushid', $count[0]['max']); + } + } + } + } + } +} + + +/* + * + * Tile push notification change the number in the icon of the App in Start Screen of + * a Windows Phone Device, Image could be changed, not used for App "Friendica Mobile" + * + */ +function send_tile_update($device_url, $image_url, $count, $title, $priority = 1) { + $msg = "" . + "" . + "". + "" . $image_url . "" . + "" . $count . "" . + "" . $title . "" . + " " . + ""; + + $result = send_push($device_url, array( + 'X-WindowsPhone-Target: token', + 'X-NotificationClass: ' . $priority, + ), $msg); + return $result; +} + +/* + * + * Toast push notification send information to the top of the display + * if the user is not currently using the Friendica Mobile App, however + * there is only one line for displaying the information + * + */ +function send_toast($device_url, $title, $message, $priority = 2) { + $msg = "" . + "" . + "" . + "" . $title . "" . + "" . $message . "" . + "" . + "" . + ""; + + $result = send_push($device_url, array( + 'X-WindowsPhone-Target: toast', + 'X-NotificationClass: ' . $priority, + ), $msg); + return $result; +} + +/* + * + * General function to send the push notification via cURL + * + */ +function send_push($device_url, $headers, $msg) { + $ch = curl_init(); + curl_setopt($ch, CURLOPT_URL, $device_url); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); + curl_setopt($ch, CURLOPT_POST, true); + curl_setopt($ch, CURLOPT_HEADER, true); + curl_setopt($ch, CURLOPT_HTTPHEADER, + $headers + array( + 'Content-Type: text/xml', + 'charset=utf-8', + 'Accept: application/*', + ) + ); + curl_setopt($ch, CURLOPT_POSTFIELDS, $msg); + + $output = curl_exec($ch); + curl_close($ch); + + // if we received "Expired" from Novartis server we will delete the obsolete device-URL + // and log this fact + $subscriptionStatus = get_header_value($output, 'X-SubscriptionStatus'); + if ($subscriptionStatus == "Expired") { + set_pconfig(local_user(),'windowsphonepush','device_url', ""); + logger("ERROR: the stored Device-URL " . $device_url . "returned an 'Expired' error, it has been deleted now."); + } + + // the notification status shall be returned to windowsphonepush_cron (will + // update settings if 'Received' otherwise keep old value in settings (on QueuedFull. Suppressed, N/A, Dropped) + $notificationStatus = get_header_value($output, 'X-NotificationStatus'); + return $notificationStatus; + } + +/* + * helper function to receive statuses from webresponse of Microsoft server + */ +function get_header_value($content, $header) { + return preg_match_all("/$header: (.*)/i", $content, $match) ? $match[1][0] : ""; +} + + +/* + * + * reading information from url and deciding which function to start + * show_settings = delivering settings to check + * update_settings = set the device_url + * + */ +function windowsphonepush_content(&$a) { + // Login with the specified Network credentials (like in api.php) + windowsphonepush_login(); + + $path = $a->argv[0]; + $path2 = $a->argv[1]; + if ($path == "windowsphonepush") { + switch ($path2) { + case "show_settings": + windowsphonepush_showsettings(&$a); + killme(); + break; + case "update_settings": + $ret = windowsphonepush_updatesettings(&$a); + header("Content-Type: application/json; charset=utf-8"); + echo json_encode(array('status' => $ret)); + killme(); + break; + default: + echo "Fehler"; + } + } +} + +/* + * return settings for windowsphonepush addon to be able to check them in WP app + */ +function windowsphonepush_showsettings(&$a) { + if(! local_user()) + return; + + $enable = get_pconfig(local_user(), 'windowsphonepush', 'enable'); + $device_url = get_pconfig(local_user(), 'windowsphonepush', 'device_url'); + $senditemtext = get_pconfig(local_user(), 'windowsphonepush', 'senditemtext'); + $lastpushid = get_pconfig(local_user(), 'windowsphonepush', 'lastpushid'); + + if (!$device_url) + $device_url = ""; + + if (!$lastpushid) + $lastpushid = 0; + + header ("Content-Type: application/json"); + echo json_encode(array('uid' => local_user(), + 'enable' => $enable, + 'device_url' => $device_url, + 'senditemtext' => $senditemtext, + 'lastpushid' => $lastpushid)); +} + +/* + * update_settings is used to transfer the device_url from WP device to the Friendica server + * return the status of the operation to the server + */ +function windowsphonepush_updatesettings(&$a) { + if(! local_user()) { + return "Not Authenticated"; + } + + // no updating if user hasn't enabled the plugin + $enable = get_pconfig(local_user(), 'windowsphonepush', 'enable'); + if(! $enable) { + return "Plug-in not enabled"; + } + + // check if sent url is empty - don't save and send return code to app + $device_url = $_POST['deviceurl']; + if ($device_url == "") { + logger("ERROR: no valid Device-URL specified - client transferred '" . $device_url . "'"); + return "No valid Device-URL specified"; + } + + // check if sent url is already stored in database for another user, we assume that there was a change of + // the user on the Windows Phone device and that device url is no longer true for the other user, so we + // et the device_url for the OTHER user blank (should normally not occur as App should include User/server + // in url request to Microsoft Push Notification server) + $r = q("SELECT * FROM `pconfig` WHERE `uid` <> " . local_user() . " AND + `cat` = 'windowsphonepush' AND + `k` = 'device_url' AND + `v` = '" . $device_url . "'"); + if(count($r)) { + foreach($r as $rr) { + set_pconfig($rr['uid'], 'windowsphonepush', 'device_url', ''); + 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() . "'."); + } + } + + set_pconfig(local_user(),'windowsphonepush','device_url', $device_url); + // output the successfull update of the device URL to the logger for error analysis if necessary + logger("INFO: Device-URL for user '" . local_user() . "' has been updated with '" . $device_url . "'"); + return "Device-URL updated successfully!"; +} + +/* + * helper function to login to the server with the specified Network credentials + * (mainly copied from api.php) + */ +function windowsphonepush_login() { + if (!isset($_SERVER['PHP_AUTH_USER'])) { + logger('API_login: ' . print_r($_SERVER, true), LOGGER_DEBUG); + header('WWW-Authenticate: Basic realm="Friendica"'); + header('HTTP/1.0 401 Unauthorized'); + die('This api requires login'); + } + + $user = $_SERVER['PHP_AUTH_USER']; + $encrypted = hash('whirlpool',trim($_SERVER['PHP_AUTH_PW'])); + + // check if user specified by app is available in the user table + $r = q("SELECT * FROM `user` WHERE ( `email` = '%s' OR `nickname` = '%s' ) + AND `password` = '%s' AND `blocked` = 0 AND `account_expired` = 0 AND `account_removed` = 0 AND `verified` = 1 LIMIT 1", + dbesc(trim($user)), + dbesc(trim($user)), + dbesc($encrypted) + ); + + if(count($r)){ + $record = $r[0]; + } else { + logger('API_login failure: ' . print_r($_SERVER,true), LOGGER_DEBUG); + header('WWW-Authenticate: Basic realm="Friendica"'); + header('HTTP/1.0 401 Unauthorized'); + die('This api requires login'); + } + + require_once('include/security.php'); + authenticate_success($record); $_SESSION["allow_api"] = true; + call_hooks('logged_in', $a->user); +} + From 10be52ed853d7835bcc8050bd50153c93081f08e Mon Sep 17 00:00:00 2001 From: gerhard6380 Date: Sun, 26 Oct 2014 15:33:49 +0100 Subject: [PATCH 2/2] messages.po created messages.po file created by run_xgettext.sh as instructed by fabrixxm. --- windowsphonepush/lang/C/messages.po | 38 ++++++++++++++++++++++++++++ windowsphonepush/lang/de/messages.po | 30 ---------------------- windowsphonepush/lang/de/strings.php | 13 ---------- 3 files changed, 38 insertions(+), 43 deletions(-) create mode 100644 windowsphonepush/lang/C/messages.po delete mode 100644 windowsphonepush/lang/de/messages.po delete mode 100644 windowsphonepush/lang/de/strings.php diff --git a/windowsphonepush/lang/C/messages.po b/windowsphonepush/lang/C/messages.po new file mode 100644 index 000000000..b6a10a743 --- /dev/null +++ b/windowsphonepush/lang/C/messages.po @@ -0,0 +1,38 @@ +# ADDON windowsphonepush +# Copyright (C) +# This file is distributed under the same license as the Friendica windowsphonepush addon package. +# +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2014-10-26 15:02+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: windowsphonepush.php:85 +msgid "WindowsPhonePush settings updated." +msgstr "" + +#: windowsphonepush.php:114 +msgid "WindowsPhonePush Settings" +msgstr "" + +#: windowsphonepush.php:117 +msgid "Enable WindowsPhonePush Plugin" +msgstr "" + +#: windowsphonepush.php:122 +msgid "Push text of new item" +msgstr "" + +#: windowsphonepush.php:127 +msgid "Save Settings" +msgstr "" diff --git a/windowsphonepush/lang/de/messages.po b/windowsphonepush/lang/de/messages.po deleted file mode 100644 index 543df1cc6..000000000 --- a/windowsphonepush/lang/de/messages.po +++ /dev/null @@ -1,30 +0,0 @@ -# ADDON windowsphonepush -# Copyright (C) -# This file is distributed under the same license as the Friendica windowsphonepush addon package. -# -# -# Translators: -# Gerhard Seeber , 2014 -msgid "" -msgstr "" - -#: windowsphonepush.php:85 -msgid "WindowsPhonePush settings updated." -msgstr "WindowsPhonePush Einstellungen aktualisiert" - -#: geonames.php:114 -msgid "WindowsPhonePush Settings" -msgstr "WindowsPhonePush Einstellungen" - -#: geonames.php:117 -msgid "Enable WindowsPhonePush Plugin" -msgstr "WindowsPhonePush Plugin aktivieren" - -#: windowspushphone.php: 122 -msgid "Push text of new item" -msgstr "Sende Text aus neuem Eintrag" - -#: geonames.php:127 -msgid "Save Settings" -msgstr "Einstellungen speichern" - diff --git a/windowsphonepush/lang/de/strings.php b/windowsphonepush/lang/de/strings.php deleted file mode 100644 index e6cb72aa2..000000000 --- a/windowsphonepush/lang/de/strings.php +++ /dev/null @@ -1,13 +0,0 @@ -strings["WindowsPhonePush settings updated."] = "WindowsPhonePush Einstellungen aktualisiert"; -$a->strings["WindowsPhonePush Settings"] = "WindowsPhonePush Einstellungen"; -$a->strings["Enable WindowsPhonePush Plugin"] = "WindowsPhonePush Plugin aktivieren"; -$a->strings["Push text of new item"] = "Sende Text aus neuem Eintrag"; -$a->strings["Save Settings"] = "Einstellungen speichern"; -