Update notifications

aad-sso-wordpress.php

@@ -741,6 +741,28 @@ function com_create_guid() {
 	}
 }
 
+	/**
+	 * Use the Plugin Update Checker add-on to receive automatic update notifications and one-click upgrades from GitHub.
+	 */
+	require 'plugin-update-checker/plugin-update-checker.php';
+	$myUpdateChecker = Puc_v4_Factory::buildUpdateChecker(
+		'https://github.com/psignoret/aad-sso-wordpress/',
+		__FILE__,
+		'aad-sso-wordpress'
+	);
+		/**
+		* Set the branch that contains the stable release to compair the update check to.
+		*/
+		$myUpdateChecker->setBranch('master');
+		/**
+		* Alternative: If you only want updates from release assets, call the enableReleaseAssets() method instead of the branch check above.
+		* $myUpdateChecker->getVcsApi()->enableReleaseAssets();
+		*/
+		/**
+		* Optional: If you're using a private repository, specify the access token like this:
+		* $myUpdateChecker->setAuthentication('cr-private-repo-token-here');
+		*/
+
 // Load settings JSON contents from DB and initialize the plugin
 $aadsso_settings_instance = AADSSO_Settings::init();
 $aadsso = AADSSO::get_instance( $aadsso_settings_instance, com_create_guid() );

plugin-update-checker/.editorconfig

@@ -0,0 +1,15 @@
+[*]
+charset=utf-8
+end_of_line=lf
+insert_final_newline=false
+indent_style=tab
+tab_width=4
+
+[{phpunit.xml.dist,*.jhm,*.xslt,*.xul,*.rng,*.xsl,*.xsd,*.ant,*.tld,*.fxml,*.jrxml,*.xml,*.jnlp,*.wsdl}]
+indent_style=space
+indent_size=4
+
+[*.svg]
+indent_style=space
+indent_size=4
+

plugin-update-checker/.gitignore

@@ -0,0 +1,40 @@
+# Created by .ignore support plugin (hsz.mobi)
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# The entire IDEA/PhpStorm directory
+.idea/
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser

plugin-update-checker/Puc/v4/Factory.php

@@ -0,0 +1,6 @@
+<?php
+if ( !class_exists('Puc_v4_Factory', false) ):
+
+	class Puc_v4_Factory extends Puc_v4p10_Factory { }
+
+endif;

plugin-update-checker/Puc/v4p10/Autoloader.php

@@ -0,0 +1,63 @@
+<?php
+
+if ( !class_exists('Puc_v4p10_Autoloader', false) ):
+
+	class Puc_v4p10_Autoloader {
+		private $prefix = '';
+		private $rootDir = '';
+		private $libraryDir = '';
+
+		private $staticMap;
+
+		public function __construct() {
+			$this->rootDir = dirname(__FILE__) . '/';
+			$nameParts = explode('_', __CLASS__, 3);
+			$this->prefix = $nameParts[0] . '_' . $nameParts[1] . '_';
+
+			$this->libraryDir = $this->rootDir . '../..';
+			if ( !self::isPhar() ) {
+				$this->libraryDir = realpath($this->libraryDir);
+			}
+			$this->libraryDir = $this->libraryDir . '/';
+
+			$this->staticMap = array(
+				'PucReadmeParser' => 'vendor/PucReadmeParser.php',
+				'Parsedown' => 'vendor/Parsedown.php',
+				'Puc_v4_Factory' => 'Puc/v4/Factory.php',
+			);
+
+			spl_autoload_register(array($this, 'autoload'));
+		}
+
+		/**
+		 * Determine if this file is running as part of a Phar archive.
+		 *
+		 * @return bool
+		 */
+		private static function isPhar() {
+			//Check if the current file path starts with "phar://".
+			static $pharProtocol = 'phar://';
+			return (substr(__FILE__, 0, strlen($pharProtocol)) === $pharProtocol);
+		}
+
+		public function autoload($className) {
+			if ( isset($this->staticMap[$className]) && file_exists($this->libraryDir . $this->staticMap[$className]) ) {
+				/** @noinspection PhpIncludeInspection */
+				include ($this->libraryDir . $this->staticMap[$className]);
+				return;
+			}
+
+			if (strpos($className, $this->prefix) === 0) {
+				$path = substr($className, strlen($this->prefix));
+				$path = str_replace('_', '/', $path);
+				$path = $this->rootDir . $path . '.php';
+
+				if (file_exists($path)) {
+					/** @noinspection PhpIncludeInspection */
+					include $path;
+				}
+			}
+		}
+	}
+
+endif;

plugin-update-checker/Puc/v4p10/DebugBar/Extension.php

@@ -0,0 +1,186 @@
+<?php
+if ( !class_exists('Puc_v4p10_DebugBar_Extension', false) ):
+
+	class Puc_v4p10_DebugBar_Extension {
+		const RESPONSE_BODY_LENGTH_LIMIT = 4000;
+
+		/** @var Puc_v4p10_UpdateChecker */
+		protected $updateChecker;
+		protected $panelClass = 'Puc_v4p10_DebugBar_Panel';
+
+		public function __construct($updateChecker, $panelClass = null) {
+			$this->updateChecker = $updateChecker;
+			if ( isset($panelClass) ) {
+				$this->panelClass = $panelClass;
+			}
+
+			add_filter('debug_bar_panels', array($this, 'addDebugBarPanel'));
+			add_action('debug_bar_enqueue_scripts', array($this, 'enqueuePanelDependencies'));
+
+			add_action('wp_ajax_puc_v4_debug_check_now', array($this, 'ajaxCheckNow'));
+		}
+
+		/**
+		 * Register the PUC Debug Bar panel.
+		 *
+		 * @param array $panels
+		 * @return array
+		 */
+		public function addDebugBarPanel($panels) {
+			if ( $this->updateChecker->userCanInstallUpdates() ) {
+				$panels[] = new $this->panelClass($this->updateChecker);
+			}
+			return $panels;
+		}
+
+		/**
+		 * Enqueue our Debug Bar scripts and styles.
+		 */
+		public function enqueuePanelDependencies() {
+			wp_enqueue_style(
+				'puc-debug-bar-style-v4',
+				$this->getLibraryUrl("/css/puc-debug-bar.css"),
+				array('debug-bar'),
+				'20171124'
+			);
+
+			wp_enqueue_script(
+				'puc-debug-bar-js-v4',
+				$this->getLibraryUrl("/js/debug-bar.js"),
+				array('jquery'),
+				'20170516'
+			);
+		}
+
+		/**
+		 * Run an update check and output the result. Useful for making sure that
+		 * the update checking process works as expected.
+		 */
+		public function ajaxCheckNow() {
+			if ( $_POST['uid'] !== $this->updateChecker->getUniqueName('uid') ) {
+				return;
+			}
+			$this->preAjaxRequest();
+			$update = $this->updateChecker->checkForUpdates();
+			if ( $update !== null ) {
+				echo "An update is available:";
+				echo '<pre>', htmlentities(print_r($update, true)), '</pre>';
+			} else {
+				echo 'No updates found.';
+			}
+
+			$errors = $this->updateChecker->getLastRequestApiErrors();
+			if ( !empty($errors) ) {
+				printf('<p>The update checker encountered %d API error%s.</p>', count($errors), (count($errors) > 1) ? 's' : '');
+
+				foreach (array_values($errors) as $num => $item) {
+					$wpError = $item['error'];
+					/** @var WP_Error $wpError */
+					printf('<h4>%d) %s</h4>', $num + 1, esc_html($wpError->get_error_message()));
+
+					echo '<dl>';
+					printf('<dt>Error code:</dt><dd><code>%s</code></dd>', esc_html($wpError->get_error_code()));
+
+					if ( isset($item['url']) ) {
+						printf('<dt>Requested URL:</dt><dd><code>%s</code></dd>', esc_html($item['url']));
+					}
+
+					if ( isset($item['httpResponse']) ) {
+						if ( is_wp_error($item['httpResponse']) ) {
+							$httpError = $item['httpResponse'];
+							/** @var WP_Error $httpError */
+							printf(
+								'<dt>WordPress HTTP API error:</dt><dd>%s (<code>%s</code>)</dd>',
+								esc_html($httpError->get_error_message()),
+								esc_html($httpError->get_error_code())
+							);
+						} else {
+							//Status code.
+							printf(
+								'<dt>HTTP status:</dt><dd><code>%d %s</code></dd>',
+								wp_remote_retrieve_response_code($item['httpResponse']),
+								wp_remote_retrieve_response_message($item['httpResponse'])
+							);
+
+							//Headers.
+							echo '<dt>Response headers:</dt><dd><pre>';
+							foreach (wp_remote_retrieve_headers($item['httpResponse']) as $name => $value) {
+								printf("%s: %s\n", esc_html($name), esc_html($value));
+							}
+							echo '</pre></dd>';
+
+							//Body.
+							$body = wp_remote_retrieve_body($item['httpResponse']);
+							if ( $body === '' ) {
+								$body = '(Empty response.)';
+							} else if ( strlen($body) > self::RESPONSE_BODY_LENGTH_LIMIT ) {
+								$length = strlen($body);
+								$body = substr($body, 0, self::RESPONSE_BODY_LENGTH_LIMIT)
+									. sprintf("\n(Long string truncated. Total length: %d bytes.)", $length);
+							}
+
+							printf('<dt>Response body:</dt><dd><pre>%s</pre></dd>', esc_html($body));
+						}
+					}
+					echo '<dl>';
+				}
+			}
+
+			exit;
+		}
+
+		/**
+		 * Check access permissions and enable error display (for debugging).
+		 */
+		protected function preAjaxRequest() {
+			if ( !$this->updateChecker->userCanInstallUpdates() ) {
+				die('Access denied');
+			}
+			check_ajax_referer('puc-ajax');
+
+			error_reporting(E_ALL);
+			@ini_set('display_errors', 'On');
+		}
+
+		/**
+		 * Remove hooks that were added by this extension.
+		 */
+		public function removeHooks() {
+			remove_filter('debug_bar_panels', array($this, 'addDebugBarPanel'));
+			remove_action('debug_bar_enqueue_scripts', array($this, 'enqueuePanelDependencies'));
+			remove_action('wp_ajax_puc_v4_debug_check_now', array($this, 'ajaxCheckNow'));
+		}
+
+		/**
+		 * @param string $filePath
+		 * @return string
+		 */
+		private function getLibraryUrl($filePath) {
+			$absolutePath = realpath(dirname(__FILE__) . '/../../../' . ltrim($filePath, '/'));
+
+			//Where is the library located inside the WordPress directory structure?
+			$absolutePath = Puc_v4p10_Factory::normalizePath($absolutePath);
+
+			$pluginDir = Puc_v4p10_Factory::normalizePath(WP_PLUGIN_DIR);
+			$muPluginDir = Puc_v4p10_Factory::normalizePath(WPMU_PLUGIN_DIR);
+			$themeDir = Puc_v4p10_Factory::normalizePath(get_theme_root());
+
+			if ( (strpos($absolutePath, $pluginDir) === 0) || (strpos($absolutePath, $muPluginDir) === 0) ) {
+				//It's part of a plugin.
+				return plugins_url(basename($absolutePath), $absolutePath);
+			} else if ( strpos($absolutePath, $themeDir) === 0 ) {
+				//It's part of a theme.
+				$relativePath = substr($absolutePath, strlen($themeDir) + 1);
+				$template = substr($relativePath, 0, strpos($relativePath, '/'));
+				$baseUrl = get_theme_root_uri($template);
+
+				if ( !empty($baseUrl) && $relativePath ) {
+					return $baseUrl . '/' . $relativePath;
+				}
+			}
+
+			return '';
+		}
+	}
+
+endif;