Merge pull request #45 from SuperPWA/branch-1.8.1

arunbasillal · web-flow · commit 6fe95304c84c · 2018-06-05T17:03:17.000+05:30
Branch 1.8.1
diff --git a/3rd-party/onesignal.php b/3rd-party/onesignal.php
@@ -11,6 +11,7 @@
  * @function 	superpwa_onesignal_sw() 						Import OneSignal service worker in SuperPWA
  * @function	superpwa_onesignal_activation()					OneSignal activation todo
  * @function	superpwa_onesignal_deactivation()				OneSignal deactivation todo
+ * @function 	superpwa_onesignal_admin_notices()				Admin notices for OneSignal compatibility
  */
 
 // Exit if accessed directly
@@ -19,14 +20,22 @@
 // If OneSignal is installed and active
 if ( class_exists( 'OneSignal' ) ) {
 	
-	// Add gcm_sender_id to SuperPWA manifest
-	add_filter( 'superpwa_manifest', 'superpwa_onesignal_add_gcm_sender_id' );
-	
-	// Change service worker filename to match OneSignal's service worker
-	add_filter( 'superpwa_sw_filename', 'superpwa_onesignal_sw_filename' );
-	
-	// Import OneSignal service worker in SuperPWA
-	add_filter( 'superpwa_sw_template', 'superpwa_onesignal_sw' );
+	// Filter manifest and service worker for singe websites and not for multisites.
+	if ( ! is_multisite() ) {
+	
+		// Add gcm_sender_id to SuperPWA manifest
+		add_filter( 'superpwa_manifest', 'superpwa_onesignal_add_gcm_sender_id' );
+		
+		// Change service worker filename to match OneSignal's service worker
+		add_filter( 'superpwa_sw_filename', 'superpwa_onesignal_sw_filename' );
+		
+		// Import OneSignal service worker in SuperPWA
+		add_filter( 'superpwa_sw_template', 'superpwa_onesignal_sw' );
+	}
+	
+	// Show admin notice.
+	add_action( 'admin_notices', 'superpwa_onesignal_admin_notices', 9 );
+	add_action( 'network_admin_notices', 'superpwa_onesignal_admin_notices', 9 );
 }
 
 /**
@@ -93,9 +102,15 @@ function superpwa_onesignal_sw( $sw ) {
  * Regenerate SuperPWA service worker with the new filename.
  * 
  * @since 1.8
+ * @since 1.8.1 Excluded multisites. No OneSignal compatibility on multisites yet. In 1.8 onesignal.php was not loaded for multisites. 
  */
 function superpwa_onesignal_activation() {
 	
+	// Do not do anything for multisites
+	if ( is_multisite() ) {
+		return;
+	}
+	
 	// Filter in gcm_sender_id to SuperPWA manifest
 	add_filter( 'superpwa_manifest', 'superpwa_onesignal_add_gcm_sender_id' );
 	
@@ -124,9 +139,15 @@ function superpwa_onesignal_activation() {
  * Regenerate SuperPWA service worker.
  * 
  * @since 1.8
+ * @since 1.8.1 Excluded multisites. No OneSignal compatibility on multisites yet. In 1.8 onesignal.php was not loaded for multisites. 
  */
 function superpwa_onesignal_deactivation() {
 	
+	// Do not do anything for multisites
+	if ( is_multisite() ) {
+		return;
+	}
+	
 	// Remove gcm_sender_id from SuperPWA manifest
 	remove_filter( 'superpwa_manifest', 'superpwa_onesignal_add_gcm_sender_id' );
 	
@@ -145,4 +166,56 @@ function superpwa_onesignal_deactivation() {
 	// Regenerate SuperPWA service worker
 	superpwa_generate_sw();
 }
-add_action( 'deactivate_onesignal-free-web-push-notifications/onesignal.php', 'superpwa_onesignal_deactivation', 11 );
+add_action( 'deactivate_onesignal-free-web-push-notifications/onesignal.php', 'superpwa_onesignal_deactivation', 11 );
+
+/**
+ * Admin notices for OneSignal compatibility
+ * 
+ * One Single installs, warn users to add SuperPWA manifest as custom manifest in OneSignal settings.
+ * One multisites, warn users that SuperPWA and OneSignal cannot work together. 
+ * 
+ * @since 1.8.1
+ */
+function superpwa_onesignal_admin_notices() {
+	
+	// Notices only for admins.
+	if ( ! current_user_can( 'manage_options' ) ) {
+		return;
+	}
+	
+	// Incompatibility notice for Multisites
+	if ( is_multisite() ) {
+		echo '<div class="notice notice-warning"><p>' . 
+		sprintf( 
+			__( '<strong>SuperPWA</strong> is not compatible with OneSignal on multisites yet. Disable one of these plugins until the compatibility is available.<br>Please refer to the <a href="%s" target="_blank">OneSignal integration documentation</a> for more info. ', 'super-progressive-web-apps' ), 
+			'https://superpwa.com/doc/setup-onesignal-with-superpwa/?utm_source=superpwa-plugin&utm_medium=onesignal-multisite-admin-notice#multisites'
+		) . '</p></div>';
+		
+		// Filter PWA status since PWA is not ready yet. 
+		add_filter( 'superpwa_is_pwa_ready', '__return_false' );
+		
+		return;
+	}
+	
+	// Get OneSignal settings.
+	$onesignal_wp_settings = get_option( 'OneSignalWPSetting' );
+	
+	// Show notice if OneSignal custom manifest is disabled or if the custom manifest is not the SuperPWA manifest.
+	if ( 
+		! isset( $onesignal_wp_settings['use_custom_manifest'] ) 			|| 
+		! ( (int) $onesignal_wp_settings['use_custom_manifest'] === 1 )		||
+		! isset( $onesignal_wp_settings['custom_manifest_url'] ) 			|| 
+		! ( strcasecmp( trim( $onesignal_wp_settings['custom_manifest_url'] ), superpwa_manifest( 'src' ) ) === 0  )
+	) {
+		echo '<div class="notice notice-warning"><p>' . 
+		sprintf( 
+			__( '<strong>Action Required to integrate SuperPWA with OneSignal:</strong><br>1. Go to <a href="%s" target="_blank">OneSignal Configuration > Scroll down to Advanced Settings &rarr;</a><br>2. Enable <strong>Use my own manifest.json</strong><br>3. Set <code>%s</code>as <strong>Custom manifest.json URL</strong> and Save Settings.<br>Please refer the <a href="%s" target="_blank">OneSignal integration documentation</a> for more info. ', 'super-progressive-web-apps' ), 
+			admin_url( 'admin.php?page=onesignal-push#configuration' ), 
+			superpwa_manifest( 'src' ),
+			'https://superpwa.com/doc/setup-onesignal-with-superpwa/?utm_source=superpwa-plugin&utm_medium=onesignal-admin-notice'
+		) . '</p></div>';
+		
+		// Filter PWA status since PWA is not ready yet. 
+		add_filter( 'superpwa_is_pwa_ready', '__return_false' );
+	}
+}
diff --git a/admin/basic-setup.php b/admin/basic-setup.php
@@ -68,7 +68,7 @@ function superpwa_admin_notices() {
     // Admin notice on plugin activation
 	if ( get_transient( 'superpwa_admin_notice_activation' ) ) {
 	
-		$superpwa_is_ready = is_ssl() && superpwa_get_contents( superpwa_manifest( 'abs' ) ) && superpwa_get_contents( superpwa_sw( 'abs' ) ) ? 'Your app is ready with the default settings. ' : '';
+		$superpwa_is_ready = superpwa_is_pwa_ready() ? 'Your app is ready with the default settings. ' : '';
 		
 		echo '<div class="updated notice is-dismissible"><p>' . sprintf( __( 'Thank you for installing <strong>Super Progressive Web Apps!</strong> '. $superpwa_is_ready .'<a href="%s">Customize your app &rarr;</a>', 'super-progressive-web-apps' ), admin_url( 'admin.php?page=superpwa' ) ) . '</p></div>';
 		
@@ -102,7 +102,7 @@ function superpwa_network_admin_notices() {
     // Network admin notice on multisite network activation
 	if ( get_transient( 'superpwa_network_admin_notice_activation' ) ) {
 	
-		$superpwa_is_ready = is_ssl() && superpwa_get_contents( superpwa_manifest( 'abs' ) ) && superpwa_get_contents( superpwa_sw( 'abs' ) ) ? 'Your app is ready on the main website with the default settings. ' : '';
+		$superpwa_is_ready = superpwa_is_pwa_ready() ? 'Your app is ready on the main website with the default settings. ' : '';
 		
 		echo '<div class="updated notice is-dismissible"><p>' . sprintf( __( 'Thank you for installing <strong>Super Progressive Web Apps!</strong> '. $superpwa_is_ready .'<a href="%s">Customize your app &rarr;</a><br/>Note: manifest and service worker for the individual websites will be generated on the first visit to the respective WordPress admin.', 'super-progressive-web-apps' ), admin_url( 'admin.php?page=superpwa' ) ) . '</p></div>';
 		
@@ -113,7 +113,7 @@ function superpwa_network_admin_notices() {
 	// Network admin notice on plugin upgrade
 	if ( get_transient( 'superpwa_admin_notice_upgrade_complete' ) ) {
 		
-		echo '<div class="updated notice is-dismissible"><p>' . sprintf( __( '<strong>SuperPWA</strong>: Successfully updated to version %s. Thank you! <a href="%s" target="_blank">Discover new features and read the story &rarr;</a>', 'super-progressive-web-apps' ), SUPERPWA_VERSION, 'https://superpwa.com/category/release-notes/latest/?utm_source=superpwa-plugin&utm_medium=update-success-notice-mu' ) . '</p></div>';
+		echo '<div class="updated notice is-dismissible"><p>' . sprintf( __( '<strong>SuperPWA</strong>: Successfully updated to version %s. Thank you! <a href="%s" target="_blank">Discover new features and read the story &rarr;</a>', 'super-progressive-web-apps' ), SUPERPWA_VERSION, 'https://superpwa.com/category/release-notes/latest/?utm_source=superpwa-plugin&utm_medium=update-success-notice-multisite' ) . '</p></div>';
 		
 		// Delete transient
 		delete_transient( 'superpwa_admin_notice_upgrade_complete' );
diff --git a/functions/common.php b/functions/common.php
@@ -7,6 +7,7 @@
  * @function	superpwa_is_amp()				Check if any AMP plugin is installed
  * @function 	superpwa_get_start_url()		Return Start Page URL
  * @function	superpwa_httpsify()				Convert http URL to https
+ * @function	superpwa_is_pwa_ready()			Check if PWA is ready
  */
 
 // Exit if accessed directly
@@ -101,4 +102,28 @@ function superpwa_get_start_url( $rel = false ) {
  */
 function superpwa_httpsify( $url ) {
 	return str_replace( 'http://', 'https://', $url );
+}
+
+/**
+ * Check if PWA is ready
+ * 
+ * Check for HTTPS.
+ * Check if manifest is generated.
+ * Check if service worker is generated. 
+ * 
+ * @return (bool) True if PWA is ready. False otherwise
+ * 
+ * @since 1.8.1
+ */
+function superpwa_is_pwa_ready() {
+	
+	if ( 
+		is_ssl() && 
+		superpwa_get_contents( superpwa_manifest( 'abs' ) ) && 
+		superpwa_get_contents( superpwa_sw( 'abs' ) ) 
+	) {
+		return apply_filters( 'superpwa_is_pwa_ready', true );
+	}
+	
+	return false; 
 }
diff --git a/languages/super-progressive-web-apps.pot b/languages/super-progressive-web-apps.pot
@@ -2,18 +2,36 @@
 # This file is distributed under the same license as the Super Progressive Web Apps package.
 msgid ""
 msgstr ""
-"Project-Id-Version: Super Progressive Web Apps 1.8\n"
+"Project-Id-Version: Super Progressive Web Apps 1.8.1\n"
 "Report-Msgid-Bugs-To: https://wordpress.org/support/plugin/super-progressive-"
 "web-apps\n"
-"POT-Creation-Date: 2018-05-30 17:29:08+00:00\n"
+"POT-Creation-Date: 2018-06-05 11:24:28+00:00\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "PO-Revision-Date: 2018-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
 
-#. #-#-#-#-#  super-progressive-web-apps.pot (Super Progressive Web Apps 1.8)  #-#-#-#-#
+#: 3rd-party/onesignal.php:190
+msgid ""
+"<strong>SuperPWA</strong> is not compatible with OneSignal on multisites "
+"yet. Disable one of these plugins until the compatibility is available."
+"<br>Please refer to the <a href=\"%s\" target=\"_blank\">OneSignal "
+"integration documentation</a> for more info. "
+msgstr ""
+
+#: 3rd-party/onesignal.php:212
+msgid ""
+"<strong>Action Required to integrate SuperPWA with OneSignal:</strong><br>1. "
+"Go to <a href=\"%s\" target=\"_blank\">OneSignal Configuration > Scroll down "
+"to Advanced Settings &rarr;</a><br>2. Enable <strong>Use my own manifest."
+"json</strong><br>3. Set <code>%s</code>as <strong>Custom manifest.json URL</"
+"strong> and Save Settings.<br>Please refer the <a href=\"%s\" target=\"_blank"
+"\">OneSignal integration documentation</a> for more info. "
+msgstr ""
+
+#. #-#-#-#-#  super-progressive-web-apps.pot (Super Progressive Web Apps 1.8.1)  #-#-#-#-#
 #. Plugin Name of the plugin/theme
 #: addons/utm-tracking.php:35 admin/admin-ui-setup.php:28
 #: admin/admin-ui-setup.php:31 admin/admin-ui-setup.php:34
@@ -293,7 +311,7 @@ msgid ""
 "contact your host to add a SSL certificate to your domain."
 msgstr ""
 
-#. #-#-#-#-#  super-progressive-web-apps.pot (Super Progressive Web Apps 1.8)  #-#-#-#-#
+#. #-#-#-#-#  super-progressive-web-apps.pot (Super Progressive Web Apps 1.8.1)  #-#-#-#-#
 #. Author of the plugin/theme
 #: admin/admin-ui-setup.php:28
 msgid "SuperPWA"
diff --git a/loader.php b/loader.php
@@ -15,7 +15,7 @@
 require_once( SUPERPWA_PATH_ABS . 'admin/admin-ui-render-addons.php' );
 
 // 3rd party compatibility
-if ( ! is_multisite() ) require_once( SUPERPWA_PATH_ABS . '3rd-party/onesignal.php' );
+require_once( SUPERPWA_PATH_ABS . '3rd-party/onesignal.php' );
 
 // Load functions
 require_once( SUPERPWA_PATH_ABS . 'functions/common.php' );
diff --git a/public/manifest.php b/public/manifest.php
@@ -120,7 +120,7 @@ function superpwa_add_manifest_to_wp_head() {
 	
 	$tags  = apply_filters( 'superpwa_wp_head_tags', $tags );
 	
-	$tags .= '<!-- / SuperPWA.com -->' . PHP_EOL . PHP_EOL; 
+	$tags .= '<!-- / SuperPWA.com -->' . PHP_EOL; 
 	
 	echo $tags;
 }
diff --git a/public/sw.php b/public/sw.php
@@ -140,7 +140,7 @@ function superpwa_sw_template() {
 	
 	// Return if the current request url is in the never cache list
 	if ( ! neverCacheUrls.every(checkNeverCacheList, e.request.url) ) {
-	  console.log('SuperPWA: Current page is excluded from cache');
+	  console.log( 'SuperPWA: Current request is excluded from cache.' );
 	  return;
 	}
 	
diff --git a/readme.txt b/readme.txt
@@ -176,6 +176,11 @@ Feel free to get in touch if you have any questions.
 
 == Changelog ==
 
+= 1.8.1 =
+* Date: [05.June.2018](https://superpwa.com/push-notifications-are-here-again/?utm_source=wordpress.org&utm_medium=changelog#1.8.1)
+* Enhancement: Added an admin notice with [instructions for OneSignal integration](https://superpwa.com/doc/setup-onesignal-with-superpwa/?utm_source=wordpress.org&utm_medium=changelog). 
+* Enhancement: Updated console log message for URLs excluded from cache for better clarity. 
+
 = 1.8 =
 * Date: [31.May.2018](https://superpwa.com/push-notifications-are-here-again/?utm_source=wordpress.org&utm_medium=changelog)
 * Tested with WordPress 4.9.6. 
@@ -266,6 +271,10 @@ Feel free to get in touch if you have any questions.
 
 == Upgrade Notice ==
 
+= 1.8.1 =
+* Enhancement: Added an admin notice with instructions for OneSignal integration. 
+* Enhancement: Updated console log message for URLs excluded from cache for better clarity. 
+
 = 1.8 =
 * Tested with WordPress 4.9.6. 
 * New Add-On: Apple Touch Icons. Set the Application Icon and Splash Screen Icon as Apple Touch Icons for compatibility with iOS devices. 
diff --git a/superpwa.php b/superpwa.php
@@ -6,7 +6,7 @@
  * Author: SuperPWA
  * Author URI: https://superpwa.com/?utm_source=superpwa-plugin&utm_medium=author-uri
  * Contributors: Arun Basil Lal, Jose Varghese
- * Version: 1.8
+ * Version: 1.8.1
  * Text Domain: super-progressive-web-apps
  * Domain Path: /languages
  * License: GPL v2 - http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
@@ -43,7 +43,7 @@
  * @since 1.6 Depreciated constants for multisite compatibility: SUPERPWA_MANIFEST_FILENAME, SUPERPWA_MANIFEST_ABS, SUPERPWA_MANIFEST_SRC
  * @since 1.6 Depreciated constants for multisite compatibility: SUPERPWA_SW_FILENAME, SUPERPWA_SW_ABS, SUPERPWA_SW_SRC
  */
-if ( ! defined( 'SUPERPWA_VERSION' ) )		define( 'SUPERPWA_VERSION'	, '1.8' ); // SuperPWA current version
+if ( ! defined( 'SUPERPWA_VERSION' ) )		define( 'SUPERPWA_VERSION'	, '1.8.1' ); // SuperPWA current version
 if ( ! defined( 'SUPERPWA_PATH_ABS' ) ) 	define( 'SUPERPWA_PATH_ABS'	, plugin_dir_path( __FILE__ ) ); // Absolute path to the plugin directory. eg - /var/www/html/wp-content/plugins/super-progressive-web-apps/
 if ( ! defined( 'SUPERPWA_PATH_SRC' ) ) 	define( 'SUPERPWA_PATH_SRC'	, plugin_dir_url( __FILE__ ) ); // Link to the plugin folder. eg - http://example.com/wp/wp-content/plugins/super-progressive-web-apps/
 

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ function superpwa_add_manifest_to_wp_head() {`
`120`	`120`
`121`	`121`	`$tags = apply_filters( 'superpwa_wp_head_tags', $tags );`
`122`	`122`
`123`		`- $tags .= '<!-- / SuperPWA.com -->' . PHP_EOL . PHP_EOL;`
	`123`	`+ $tags .= '<!-- / SuperPWA.com -->' . PHP_EOL;`
`124`	`124`
`125`	`125`	`echo $tags;`
`126`	`126`	`}`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ function superpwa_sw_template() {`
`140`	`140`
`141`	`141`	`// Return if the current request url is in the never cache list`
`142`	`142`	`if ( ! neverCacheUrls.every(checkNeverCacheList, e.request.url) ) {`
`143`		`- console.log('SuperPWA: Current page is excluded from cache');`
	`143`	`+ console.log( 'SuperPWA: Current request is excluded from cache.' );`
`144`	`144`	`return;`
`145`	`145`	`}`
`146`	`146`