PW-349: Show message if not on latest version of the extension (#238)

* PW-349: Show message if not on latest version of the extension

* PW-349: Replaced with correct \Exception type

* PW-349: Changed wording to "extension", added "Adyen" in the di name.

* PW-349: Added Session to store the github info and call github only once, changed severity of the message to MAJOR(warning) since the messages are only displayed with CRITICAL(1) or MAJOR(2), the inbox message is still stored with severity NOTICE(4), added quotes to href.

* PW-349: Removed try/catch in getText, renamed session variable

AdminMessage/VersionMessage.php

+<?php
+/**
+ *                       ######
+ *                       ######
+ * ############    ####( ######  #####. ######  ############   ############
+ * #############  #####( ######  #####. ######  #############  #############
+ *        ######  #####( ######  #####. ######  #####  ######  #####  ######
+ * ###### ######  #####( ######  #####. ######  #####  #####   #####  ######
+ * ###### ######  #####( ######  #####. ######  #####          #####  ######
+ * #############  #############  #############  #############  #####  ######
+ *  ############   ############  #############   ############  #####  ######
+ *                                      ######
+ *                               #############
+ *                               ############
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2018 Adyen B.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <magento@adyen.com>
+ */
+
+namespace Adyen\Payment\AdminMessage;
+
+class VersionMessage implements \Magento\Framework\Notification\MessageInterface
+{
+    protected $_authSession;
+    protected $_adyenHelper;
+    protected $_inboxFactory;
+
+    public function __construct(
+        \Magento\Backend\Model\Auth\Session $authSession,
+        \Adyen\Payment\Helper\Data $adyenHelper,
+        \Magento\AdminNotification\Model\InboxFactory $inboxFactory
+    ) {
+        $this->_authSession = $authSession;
+        $this->_adyenHelper = $adyenHelper;
+        $this->_inboxFactory = $inboxFactory;
+    }
+
+    /**
+     * Message identity
+     */
+    const MESSAGE_IDENTITY = 'Adyen Version Control message';
+
+    /**
+     * Retrieve unique system message identity
+     *
+     * @return string
+     */
+    public function getIdentity()
+    {
+        return self::MESSAGE_IDENTITY;
+    }
+
+    /**
+     * Check whether the system message should be shown
+     *
+     * @return bool
+     */
+    public function isDisplayed()
+    {
+        // Only execute the query the first time you access the Admin page
+        if ($this->_authSession->isFirstPageAfterLogin()) {
+
+            try {
+                $githubContent = $this->getDecodedContentFromGithub();
+                $this->setSessionData("AdyenGithubVersion", $githubContent);
+                $title = "Adyen extension version " . $githubContent['tag_name'] . " available!";
+                $versionData[] = array(
+                    'severity' => self::SEVERITY_NOTICE,
+                    'date_added' => $githubContent['published_at'],
+                    'title' => $title,
+                    'description' => $githubContent['body'],
+                    'url' => $githubContent['html_url'],
+                );
+
+                /*
+                 * The parse function checks if the $versionData message exists in the inbox,
+                 * otherwise it will create it and add it to the inbox.
+                 */
+                $this->_inboxFactory->create()->parse(array_reverse($versionData));
+
+                /*
+                 * This will compare the currently installed version with the latest available one.
+                 * A message will appear after the login if the two are not matching.
+                 */
+                if ($this->_adyenHelper->getModuleVersion() != $githubContent['tag_name']) {
+                    return true;
+                }
+            } catch (\Exception $e) {
+                return false;
+            }
+        }
+        return false;
+
+    }
+
+    /**
+     * Retrieve system message text
+     *
+     * @return \Magento\Framework\Phrase
+     */
+    public function getText()
+    {
+        $githubContent = $this->getSessionData("AdyenGithubVersion");
+        $message = __("A new Adyen extension version is now available: ");
+        $message .= __("<a href= \"" . $githubContent['html_url'] . "\" target='_blank'> " . $githubContent['tag_name'] . "!</a>");
+        $message .= __(" You are running the " . $this->_adyenHelper->getModuleVersion() . " version. We advise to update your extension.");
+        return __($message);
+    }
+
+    /**
+     * Retrieve system message severity
+     *
+     * @return int
+     */
+    public function getSeverity()
+    {
+        return self::SEVERITY_MAJOR;
+    }
+
+    public function getDecodedContentFromGithub()
+    {
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL, 'https://api.github.com/repos/adyen/adyen-magento2/releases/latest');
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 1);
+        curl_setopt($ch, CURLOPT_USERAGENT, 'magento');
+        $content = curl_exec($ch);
+        curl_close($ch);
+        $json = json_decode($content, true);
+        return $json;
+    }
+
+    /**
+     * Set the current value for the backend session
+     */
+    public function setSessionData($key, $value)
+    {
+        return $this->_authSession->setData($key, $value);
+    }
+
+    /**
+     * Retrieve the session value
+     */
+    public function getSessionData($key, $remove = false)
+    {
+        return $this->_authSession->getData($key, $remove);
+    }
+
+}
+

etc/adminhtml/di.xml

@@ -3,7 +3,8 @@
     <type name="Magento\Framework\Notification\MessageList">
         <arguments>
             <argument name="messages" xsi:type="array">
-                <item name="cronMessage" xsi:type="string">Adyen\Payment\AdminMessage\CronMessage</item>
+                <item name="AdyenCronMessage" xsi:type="string">Adyen\Payment\AdminMessage\CronMessage</item>
+                <item name="AdyenVersionMessage" xsi:type="string">Adyen\Payment\AdminMessage\VersionMessage</item>
             </argument>
         </arguments>
     </type>