[pumpio] Rename Item::delete to Item::markForDeletion
[friendica-addons.git/.git] / windowsphonepush / windowsphonepush.php
index ca61520..af68711 100644 (file)
@@ -10,7 +10,7 @@
  * 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
+ * When addon is installed, the system calls the addon
  * 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
  *        sets the counter back
  *        count only unseen elements which are not type=activity (likes and dislikes not seen as new elements)
  */
+
 use Friendica\App;
-use Friendica\Core\PConfig;
+use Friendica\Content\Text\BBCode;
+use Friendica\Content\Text\HTML;
+use Friendica\Core\Hook;
+use Friendica\Core\Logger;
+use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Model\Item;
 use Friendica\Model\User;
 
 function windowsphonepush_install()
 {
-       /* Our plugin will attach in three places.
+       /* Our addon 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');
+       Hook::register('cron', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_cron');
 
-       /* Then we'll attach into the plugin settings page, and also the
+       /* Then we'll attach into the addon 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
+        * user preferences. User shall be able to activate the addon 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');
+       Hook::register('addon_settings', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings');
+       Hook::register('addon_settings_post', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings_post');
 
-       logger("installed windowsphonepush");
+       Logger::log("installed windowsphonepush");
 }
 
 function windowsphonepush_uninstall()
@@ -53,11 +60,11 @@ 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');
+       Hook::unregister('cron', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_cron');
+       Hook::unregister('addon_settings', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings');
+       Hook::unregister('addon_settings_post', 'addon/windowsphonepush/windowsphonepush.php', 'windowsphonepush_settings_post');
 
-       logger("removed windowsphonepush");
+       Logger::log("removed windowsphonepush");
 }
 
 /* declare the windowsphonepush function so that /windowsphonepush url requests will land here */
@@ -73,22 +80,22 @@ function windowsphonepush_module()
  */
 function windowsphonepush_settings_post($a, $post)
 {
-       if (!local_user() || (!x($_POST, 'windowsphonepush-submit'))) {
+       if (!local_user() || empty($_POST['windowsphonepush-submit'])) {
                return;
        }
        $enable = intval($_POST['windowsphonepush']);
-       PConfig::set(local_user(), 'windowsphonepush', 'enable', $enable);
+       DI::pConfig()->set(local_user(), 'windowsphonepush', 'enable', $enable);
 
        if ($enable) {
-               PConfig::set(local_user(), 'windowsphonepush', 'counterunseen', 0);
+               DI::pConfig()->set(local_user(), 'windowsphonepush', 'counterunseen', 0);
        }
 
-       PConfig::set(local_user(), 'windowsphonepush', 'senditemtext', intval($_POST['windowsphonepush-senditemtext']));
+       DI::pConfig()->set(local_user(), 'windowsphonepush', 'senditemtext', intval($_POST['windowsphonepush-senditemtext']));
 
-       info(t('WindowsPhonePush settings updated.') . EOL);
+       info(DI::l10n()->t('WindowsPhonePush settings updated.') . EOL);
 }
 
-/* Called from the Plugin Setting form.
+/* Called from the Addon Setting form.
  * Add our own settings info to the page.
  */
 function windowsphonepush_settings(&$a, &$s)
@@ -98,33 +105,33 @@ function windowsphonepush_settings(&$a, &$s)
        }
 
        /* Add our stylesheet to the page so we can make our settings look nice */
-       $a->page['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . $a->get_baseurl() . '/addon/windowsphonepush/windowsphonepush.css' . '" media="all" />' . "\r\n";
+       DI::page()['htmlhead'] .= '<link rel="stylesheet"  type="text/css" href="' . DI::baseUrl()->get() . '/addon/windowsphonepush/windowsphonepush.css' . '" media="all" />' . "\r\n";
 
        /* Get the current state of our config variables */
-       $enabled = PConfig::get(local_user(), 'windowsphonepush', 'enable');
+       $enabled = DI::pConfig()->get(local_user(), 'windowsphonepush', 'enable');
        $checked_enabled = (($enabled) ? ' checked="checked" ' : '');
 
-       $senditemtext = PConfig::get(local_user(), 'windowsphonepush', 'senditemtext');
+       $senditemtext = DI::pConfig()->get(local_user(), 'windowsphonepush', 'senditemtext');
        $checked_senditemtext = (($senditemtext) ? ' checked="checked" ' : '');
 
-       $device_url = PConfig::get(local_user(), 'windowsphonepush', 'device_url');
+       $device_url = DI::pConfig()->get(local_user(), 'windowsphonepush', 'device_url');
 
        /* Add some HTML to the existing form */
        $s .= '<div class="settings-block">';
-       $s .= '<h3>' . t('WindowsPhonePush Settings') . '</h3>';
+       $s .= '<h3>' . DI::l10n()->t('WindowsPhonePush Settings') . '</h3>';
 
        $s .= '<div id="windowsphonepush-enable-wrapper">';
-       $s .= '<label id="windowsphonepush-enable-label" for="windowsphonepush-enable-chk">' . t('Enable WindowsPhonePush Plugin') . '</label>';
+       $s .= '<label id="windowsphonepush-enable-label" for="windowsphonepush-enable-chk">' . DI::l10n()->t('Enable WindowsPhonePush Addon') . '</label>';
        $s .= '<input id="windowsphonepush-enable-chk" type="checkbox" name="windowsphonepush" value="1" ' . $checked_enabled . '/>';
        $s .= '</div><div class="clear"></div>';
 
        $s .= '<div id="windowsphonepush-senditemtext-wrapper">';
-       $s .= '<label id="windowsphonepush-senditemtext-label" for="windowsphonepush-senditemtext-chk">' . t('Push text of new item') . '</label>';
+       $s .= '<label id="windowsphonepush-senditemtext-label" for="windowsphonepush-senditemtext-chk">' . DI::l10n()->t('Push text of new item') . '</label>';
        $s .= '<input id="windowsphonepush-senditemtext-chk" type="checkbox" name="windowsphonepush-senditemtext" value="1" ' . $checked_senditemtext . '/>';
        $s .= '</div><div class="clear"></div>';
 
        /* provide a submit button - enable und senditemtext can be changed by the user */
-       $s .= '<div class="settings-submit-wrapper" ><input type="submit" id="windowsphonepush-submit" name="windowsphonepush-submit" class="settings-submit" value="' . t('Save Settings') . '" /></div><div class="clear"></div>';
+       $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>';
 
        /* provide further read-only information concerning the addon (useful for */
        $s .= '<div id="windowsphonepush-device_url-wrapper">';
@@ -135,24 +142,24 @@ function windowsphonepush_settings(&$a, &$s)
        return;
 }
 
-/* Cron function used to regularly check all users on the server with active windowsphonepushplugin and send
+/* Cron function used to regularly check all users on the server with active windowsphonepushaddon 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
+       // retrieve all UID's for which the addon 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 = PConfig::get($rr['uid'], 'windowsphonepush', 'device_url');
-                       $lastpushid = PConfig::get($rr['uid'], 'windowsphonepush', 'lastpushid');
+                       $device_url = DI::pConfig()->get($rr['uid'], 'windowsphonepush', 'device_url');
+                       $lastpushid = DI::pConfig()->get($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.");
+                               // no Device-URL for the user availabe, but addon is enabled --> write info to Logger
+                               Logger::log("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)
@@ -165,15 +172,15 @@ function windowsphonepush_cron()
                                switch (trim($res_tile)) {
                                        case "Received":
                                                // ok, count has been pushed, let's save it in personal settings
-                                               PConfig::set($rr['uid'], 'windowsphonepush', 'counterunseen', $count[0]['count']);
+                                               DI::pConfig()->set($rr['uid'], 'windowsphonepush', 'counterunseen', $count[0]['count']);
                                                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.");
+                                               Logger::log("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?");
+                                               Logger::log("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)
@@ -181,36 +188,34 @@ function windowsphonepush_cron()
                                        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.");
+                                               Logger::log("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 = PConfig::get($rr['uid'], 'windowsphonepush', 'senditemtext');
+                                       $senditemtext = DI::pConfig()->get($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']));
+                                               $item = Item::selectFirst(['author-name', 'body'], ['id' => $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 = $item['author-name'];
                                                $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'];
+                                               $body = $item['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 = BBCode::convert($body, false, 2, true);
+                                                       $body = HTML::toPlaintext($body, 0);
                                                        $body = ((strlen($body) > 137) ? substr($body, 0, 137) . "..." : $body);
                                                }
                                        } else {
@@ -225,7 +230,7 @@ function windowsphonepush_cron()
                                        // 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') {
-                                               PConfig::set($rr['uid'], 'windowsphonepush', 'lastpushid', $count[0]['max']);
+                                               DI::pConfig()->set($rr['uid'], 'windowsphonepush', 'lastpushid', $count[0]['max']);
                                        }
                                }
                        }
@@ -247,10 +252,10 @@ function send_tile_update($device_url, $image_url, $count, $title, $priority = 1
                "</wp:Tile> " .
                "</wp:Notification>";
 
-       $result = send_push($device_url, array(
+       $result = send_push($device_url, [
                'X-WindowsPhone-Target: token',
                'X-NotificationClass: ' . $priority,
-               ), $msg);
+               ], $msg);
        return $result;
 }
 
@@ -269,10 +274,10 @@ function send_toast($device_url, $title, $message, $priority = 2)
                "</wp:Toast>" .
                "</wp:Notification>";
 
-       $result = send_push($device_url, array(
+       $result = send_push($device_url, [
                'X-WindowsPhone-Target: toast',
                'X-NotificationClass: ' . $priority,
-               ), $msg);
+               ], $msg);
        return $result;
 }
 
@@ -284,11 +289,11 @@ function send_push($device_url, $headers, $msg)
        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(
+       curl_setopt($ch, CURLOPT_HTTPHEADER, $headers + [
                'Content-Type: text/xml',
                'charset=utf-8',
                'Accept: application/*',
-               )
+               ]
        );
        curl_setopt($ch, CURLOPT_POSTFIELDS, $msg);
 
@@ -299,8 +304,8 @@ function send_push($device_url, $headers, $msg)
        // and log this fact
        $subscriptionStatus = get_header_value($output, 'X-SubscriptionStatus');
        if ($subscriptionStatus == "Expired") {
-               PConfig::set(local_user(), 'windowsphonepush', 'device_url', "");
-               logger("ERROR: the stored Device-URL " . $device_url . "returned an 'Expired' error, it has been deleted now.");
+               DI::pConfig()->set(local_user(), 'windowsphonepush', 'device_url', "");
+               Logger::log("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
@@ -331,19 +336,19 @@ function windowsphonepush_content(App $a)
                switch ($path2) {
                        case "show_settings":
                                windowsphonepush_showsettings($a);
-                               killme();
+                               exit();
                                break;
                        case "update_settings":
                                $ret = windowsphonepush_updatesettings($a);
                                header("Content-Type: application/json; charset=utf-8");
-                               echo json_encode(array('status' => $ret));
-                               killme();
+                               echo json_encode(['status' => $ret]);
+                               exit();
                                break;
                        case "update_counterunseen":
                                $ret = windowsphonepush_updatecounterunseen();
                                header("Content-Type: application/json; charset=utf-8");
-                               echo json_encode(array('status' => $ret));
-                               killme();
+                               echo json_encode(['status' => $ret]);
+                               exit();
                                break;
                        default:
                                echo "Fehler";
@@ -358,11 +363,11 @@ function windowsphonepush_showsettings()
                return;
        }
 
-       $enable = PConfig::get(local_user(), 'windowsphonepush', 'enable');
-       $device_url = PConfig::get(local_user(), 'windowsphonepush', 'device_url');
-       $senditemtext = PConfig::get(local_user(), 'windowsphonepush', 'senditemtext');
-       $lastpushid = PConfig::get(local_user(), 'windowsphonepush', 'lastpushid');
-       $counterunseen = PConfig::get(local_user(), 'windowsphonepush', 'counterunseen');
+       $enable = DI::pConfig()->get(local_user(), 'windowsphonepush', 'enable');
+       $device_url = DI::pConfig()->get(local_user(), 'windowsphonepush', 'device_url');
+       $senditemtext = DI::pConfig()->get(local_user(), 'windowsphonepush', 'senditemtext');
+       $lastpushid = DI::pConfig()->get(local_user(), 'windowsphonepush', 'lastpushid');
+       $counterunseen = DI::pConfig()->get(local_user(), 'windowsphonepush', 'counterunseen');
        $addonversion = "2.0";
 
        if (!$device_url) {
@@ -374,13 +379,13 @@ function windowsphonepush_showsettings()
        }
 
        header("Content-Type: application/json");
-       echo json_encode(array('uid' => local_user(),
+       echo json_encode(['uid' => local_user(),
                'enable' => $enable,
                'device_url' => $device_url,
                'senditemtext' => $senditemtext,
                'lastpushid' => $lastpushid,
                'counterunseen' => $counterunseen,
-               'addonversion' => $addonversion));
+               'addonversion' => $addonversion]);
 }
 
 /* update_settings is used to transfer the device_url from WP device to the Friendica server
@@ -392,8 +397,8 @@ function windowsphonepush_updatesettings()
                return "Not Authenticated";
        }
 
-       // no updating if user hasn't enabled the plugin
-       $enable = PConfig::get(local_user(), 'windowsphonepush', 'enable');
+       // no updating if user hasn't enabled the addon
+       $enable = DI::pConfig()->get(local_user(), 'windowsphonepush', 'enable');
        if (!$enable) {
                return "Plug-in not enabled";
        }
@@ -401,7 +406,7 @@ function windowsphonepush_updatesettings()
        // 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 . "'");
+               Logger::log("ERROR: no valid Device-URL specified - client transferred '" . $device_url . "'");
                return "No valid Device-URL specified";
        }
 
@@ -415,14 +420,14 @@ function windowsphonepush_updatesettings()
                                                `v` = '" . $device_url . "'");
        if (count($r)) {
                foreach ($r as $rr) {
-                       PConfig::set($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() . "'.");
+                       DI::pConfig()->set($rr['uid'], 'windowsphonepush', 'device_url', '');
+                       Logger::log("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() . "'.");
                }
        }
 
-       PConfig::set(local_user(), 'windowsphonepush', 'device_url', $device_url);
+       DI::pConfig()->set(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 . "'");
+       Logger::log("INFO: Device-URL for user '" . local_user() . "' has been updated with '" . $device_url . "'");
        return "Device-URL updated successfully!";
 }
 
@@ -433,13 +438,13 @@ function windowsphonepush_updatecounterunseen()
                return "Not Authenticated";
        }
 
-       // no updating if user hasn't enabled the plugin
-       $enable = PConfig::get(local_user(), 'windowsphonepush', 'enable');
+       // no updating if user hasn't enabled the addon
+       $enable = DI::pConfig()->get(local_user(), 'windowsphonepush', 'enable');
        if (!$enable) {
                return "Plug-in not enabled";
        }
 
-       PConfig::set(local_user(), 'windowsphonepush', 'counterunseen', 0);
+       DI::pConfig()->set(local_user(), 'windowsphonepush', 'counterunseen', 0);
        return "Counter set to zero";
 }
 
@@ -449,7 +454,7 @@ function windowsphonepush_updatecounterunseen()
 function windowsphonepush_login(App $a)
 {
        if (!isset($_SERVER['PHP_AUTH_USER'])) {
-               logger('API_login: ' . print_r($_SERVER, true), LOGGER_DEBUG);
+               Logger::log('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');
@@ -458,16 +463,15 @@ function windowsphonepush_login(App $a)
        $user_id = User::authenticate($_SERVER['PHP_AUTH_USER'], trim($_SERVER['PHP_AUTH_PW']));
 
        if ($user_id) {
-               $record = dba::selectFirst('user', [], ['uid' => $user_id]);
+               $record = DBA::selectFirst('user', [], ['uid' => $user_id]);
        } else {
-               logger('API_login failure: ' . print_r($_SERVER, true), LOGGER_DEBUG);
+               Logger::log('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);
+       DI::auth()->setForUser($a, $record);
+       DI::session()->set('allow_api', true);
+       Hook::callAll('logged_in', $a->user);
 }