├── LICENSE
├── README.md
├── notifier.xml
└── update-notifier.php


/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2011 João Araújo (http://themeforest.net/user/unisphere)
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | of this software and associated documentation files (the "Software"), to deal
 5 | in the Software without restriction, including without limitation the rights
 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | copies of the Software, and to permit persons to whom the Software is furnished
 8 | to do so, subject to the following conditions:
 9 | 
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 | 
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | THE SOFTWARE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # WordPress plugin Update Notifier
 2 | 
 3 | This is a simple WordPress plugin update notifier that will provide your plugin Buyers with a notification every time you issue a plugin update.
 4 | 
 5 | It's a very simple script that requires and assumes you have an XML file in your own server. This XML file serves as an endpoint for the script to check what the latest version of the plugin is, and compares it with the current version of the plugin installed in the Client's server.
 6 | 
 7 | One of the script **requirements** is that the version number are **floats**. Versions like 1.0, 1.1, 2.3 are acceptable and required.
 8 | 
 9 | ## Installation
10 | 
11 | Upload the **notifier.xml** file to your own server (the update notifier on the Client sites will check this file for the latest version)
12 | 
13 | Copy the **update-notifier.php** file to the root of the plugin.
14 | 
15 | Edit your plugin's main file and include the **update-notifier.php** file with the following code:
16 | 
17 | 	require('update-notifier.php');
18 | 	
19 | Edit the **update-notifier.php** file and make the appropriate changes to the following constants:
20 | 
21 | 	define( 'NOTIFIER_PLUGIN_NAME', 'Your Plugin Name' ); // The plugin name
22 | 	define( 'NOTIFIER_PLUGIN_SHORT_NAME', 'ABC' ); // The plugin short name. Use this if your plugin has a long name and messes up the menu items. Otherwise remove it.
23 | 	define( 'NOTIFIER_PLUGIN_FOLDER_NAME', 'name-of-your-plugin-folder' ); // The plugin folder name
24 | 	define( 'NOTIFIER_PLUGIN_FILE_NAME', 'main-plugin-file.php' ); // The plugin's main file name
25 | 	define( 'NOTIFIER_XML_FILE', 'http://yoururl.com/updates/notifier.xml' ); // The remote notifier XML file containing the latest version of the plugin and changelog
26 | 	define( 'NOTIFIER_CACHE_INTERVAL', 21600 ); // The time interval for the remote XML cache in the database (21600 seconds = 6 hours)
27 | 	
28 | Everything should be in place now. Every time you submit a plugin update you should edit the XML file in your server and change the following code to the latest version you've updated:
29 | 
30 | 	<latest>1.0</latest>
31 | 	
32 | This way, your Clients will see an update notification on the WordPress admin panel informing them that there's a new version available and they should update.
33 | 
34 | **NOTE:** when you submit plugin updates make sure to update the plugin Version number in the top of the main plugin file.
35 | 


--------------------------------------------------------------------------------
/notifier.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <notifier>
 3 | 	<latest>1.0</latest>
 4 | 	<changelog>
 5 | <![CDATA[
 6 | <h4>Version 1.0</h4>
 7 | <ul>
 8 | <li>This is a line in the changelog</li>
 9 | <li>This is another line in the changelog</li>
10 | </ul>
11 | ]]>
12 | 	</changelog>
13 | </notifier>


--------------------------------------------------------------------------------
/update-notifier.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**************************************************************
  3 |  *                                                            *
  4 |  *   Provides a notification to the user everytime            *
  5 |  *   your WordPress plugin is updated                         *
  6 |  *															  *
  7 |  *	 Based on the script by Unisphere:						  *
  8 |  *   https://github.com/unisphere/unisphere_notifier          *
  9 |  *                                                            *
 10 |  *   Author: Pippin Williamson                                *
 11 |  *   Profile: http://codecanyon.net/user/mordauk              *
 12 |  *   Follow me: http://twitter.com/pippinsplugins             *
 13 |  *                                                            *
 14 |  **************************************************************/
 15 |  
 16 | /*
 17 | 	Replace XXX and xxx by your plugin prefix to prevent conflicts between plugins using this script.
 18 | */
 19 | 
 20 | // Constants for the plugin name, folder and remote XML url
 21 | define( 'XXX_NOTIFIER_PLUGIN_NAME', 'Your Plugin Name' ); // The plugin name
 22 | define( 'XXX_NOTIFIER_PLUGIN_SHORT_NAME', 'ABC' ); // The plugin short name, only if needed to make the menu item fit. Remove this if not needed
 23 | define( 'XXX_NOTIFIER_PLUGIN_FOLDER_NAME', 'name-of-your-plugin-folder' ); // The plugin folder name
 24 | define( 'XXX_NOTIFIER_PLUGIN_FILE_NAME', 'main-plugin-file.php' ); // The plugin file name
 25 | define( 'XXX_NOTIFIER_PLUGIN_XML_FILE', 'http://yoururl.com/updates/notifier.xml' ); // The remote notifier XML file containing the latest version of the plugin and changelog
 26 | define( 'XXX_PLUGIN_NOTIFIER_CACHE_INTERVAL', 21600 ); // The time interval for the remote XML cache in the database (21600 seconds = 6 hours)
 27 | define( 'XXX_PLUGIN_NOTIFIER_CODECANYON_USERNAME', 'yourusername' ); // Your Codecanyon username
 28 | 
 29 | 
 30 | // Adds an update notification to the WordPress Dashboard menu
 31 | function xxx_update_plugin_notifier_menu() {  
 32 | 	if ( function_exists( 'simplexml_load_string' ) ) { // Stop if simplexml_load_string funtion isn't available
 33 | 	    $xml 			= xxx_get_latest_plugin_version( XXX_PLUGIN_NOTIFIER_CACHE_INTERVAL ); // Get the latest remote XML file on our server
 34 | 		$plugin_data 	= get_plugin_data( WP_PLUGIN_DIR . '/' . XXX_NOTIFIER_PLUGIN_FOLDER_NAME . '/' . XXX_NOTIFIER_PLUGIN_FILE_NAME ); // Read plugin current version from the style.css
 35 | 
 36 | 		if ( (string) $xml->latest > (string) $plugin_data['Version'] ) { // Compare current plugin version with the remote XML version
 37 | 			if ( defined( 'XXX_NOTIFIER_PLUGIN_SHORT_NAME' ) ) {
 38 | 				$menu_name = XXX_NOTIFIER_PLUGIN_SHORT_NAME;
 39 | 			} else {
 40 | 				$menu_name = XXX_NOTIFIER_PLUGIN_NAME;
 41 | 			}
 42 | 			add_dashboard_page( XXX_NOTIFIER_PLUGIN_NAME . ' Plugin Updates', $menu_name . ' <span class="update-plugins count-1"><span class="update-count">New Updates</span></span>', 'administrator', 'xxx-plugin-update-notifier', 'xxx_update_notifier');
 43 | 		}
 44 | 	}	
 45 | }
 46 | add_action('admin_menu', 'xxx_update_plugin_notifier_menu');  
 47 | 
 48 | 
 49 | 
 50 | // Adds an update notification to the WordPress 3.1+ Admin Bar
 51 | function xxx_update_notifier_bar_menu() {
 52 | 	if ( function_exists( 'simplexml_load_string' ) ) { // Stop if simplexml_load_string funtion isn't available
 53 | 		global $wp_admin_bar, $wpdb;
 54 | 
 55 | 		if ( ! is_super_admin() || ! is_admin_bar_showing() ) // Don't display notification in admin bar if it's disabled or the current user isn't an administrator
 56 | 		return;
 57 | 
 58 | 		$xml 		= xxx_get_latest_plugin_version( XXX_PLUGIN_NOTIFIER_CACHE_INTERVAL ); // Get the latest remote XML file on our server
 59 | 		$plugin_data 	= get_plugin_data( WP_PLUGIN_DIR . '/' . XXX_NOTIFIER_PLUGIN_FOLDER_NAME . '/' .XXX_NOTIFIER_PLUGIN_FILE_NAME ); // Read plugin current version from the main plugin file
 60 | 
 61 | 		if( (string) $xml->latest > (string) $plugin_data['Version'] ) { // Compare current plugin version with the remote XML version
 62 | 			$wp_admin_bar->add_menu( array( 'id' => 'plugin_update_notifier', 'title' => '<span>' . XXX_NOTIFIER_PLUGIN_NAME . ' <span id="ab-updates">New Updates</span></span>', 'href' => get_admin_url() . 'index.php?page=xxx-plugin-update-notifier' ) );
 63 | 		}
 64 | 	}
 65 | }
 66 | add_action( 'admin_bar_menu', 'xxx_update_notifier_bar_menu', 1000 );
 67 | 
 68 | 
 69 | 
 70 | // The notifier page
 71 | function xxx_update_notifier() { 
 72 | 	$xml 			= xxx_get_latest_plugin_version( XXX_PLUGIN_NOTIFIER_CACHE_INTERVAL ); // Get the latest remote XML file on our server
 73 | 	$plugin_data 	= get_plugin_data( WP_PLUGIN_DIR . '/' . XXX_NOTIFIER_PLUGIN_FOLDER_NAME . '/' .XXX_NOTIFIER_PLUGIN_FILE_NAME ); // Read plugin current version from the main plugin file ?>
 74 | 
 75 | 	<style>
 76 | 		.update-nag { display: none; }
 77 | 		#instructions {max-width: 670px;}
 78 | 		h3.title {margin: 30px 0 0 0; padding: 30px 0 0 0; border-top: 1px solid #ddd;}
 79 | 	</style>
 80 | 
 81 | 	<div class="wrap">
 82 | 
 83 | 		<div id="icon-tools" class="icon32"></div>
 84 | 		<h2><?php echo XXX_NOTIFIER_PLUGIN_NAME ?> Plugin Updates</h2>
 85 | 	    <div id="message" class="updated below-h2"><p><strong>There is a new version of the <?php echo XXX_NOTIFIER_PLUGIN_NAME; ?> plugin available.</strong> You have version <?php echo $plugin_data['Version']; ?> installed. Update to version <?php echo $xml->latest; ?>.</p></div>
 86 | 		
 87 | 		<div id="instructions">
 88 | 		    <h3>Update Download and Instructions</h3>
 89 | 		    <p><strong>Please note:</strong> make a <strong>backup</strong> of the Plugin inside your WordPress installation folder <strong>/wp-content/plugins/<?php echo XXX_NOTIFIER_PLUGIN_FOLDER_NAME; ?>/</strong></p>
 90 | 		    <p>To update the Plugin, login to <a href="http://www.codecanyon.net/?ref=<?php echo XXX_PLUGIN_NOTIFIER_CODECANYON_USERNAME; ?>">CodeCanyon</a>, head over to your <strong>downloads</strong> section and re-download the plugin like you did when you bought it.</p>
 91 | 		    <p>Extract the zip's contents, look for the extracted plugin folder, and after you have all the new files upload them using FTP to the <strong>/wp-content/plugins/<?php echo XXX_NOTIFIER_PLUGIN_FOLDER_NAME; ?>/</strong> folder overwriting the old ones (this is why it's important to backup any changes you've made to the plugin files).</p>
 92 | 		    <p>If you didn't make any changes to the plugin files, you are free to overwrite them with the new ones without the risk of losing any plugins settings, and backwards compatibility is guaranteed.</p>
 93 | 		</div>
 94 | 	    
 95 | 	    <h3 class="title">Changelog</h3>
 96 | 	    <?php echo $xml->changelog; ?>
 97 | 
 98 | 	</div>
 99 |     
100 | <?php } 
101 | 
102 | 
103 | 
104 | // Get the remote XML file contents and return its data (Version and Changelog)
105 | // Uses the cached version if available and inside the time interval defined
106 | function xxx_get_latest_plugin_version( $interval ) {
107 | 	$notifier_file_url = XXX_NOTIFIER_PLUGIN_XML_FILE;	
108 | 	$db_cache_field = 'notifier-cache';
109 | 	$db_cache_field_last_updated = 'notifier-cache-last-updated';
110 | 	$last = get_option( $db_cache_field_last_updated );
111 | 	$now = time();
112 | 	// check the cache
113 | 	if ( ! $last || ( ( $now - $last ) > $interval ) ) {
114 | 		// cache doesn't exist, or is old, so refresh it
115 | 		if( function_exists( 'curl_init' ) ) { // if cURL is available, use it...
116 | 			$ch = curl_init( $notifier_file_url );
117 | 			curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
118 | 			curl_setopt( $ch, CURLOPT_HEADER, 0 );
119 | 			curl_setopt( $ch, CURLOPT_TIMEOUT, 10 );
120 | 			$cache = curl_exec( $ch );
121 | 			curl_close( $ch );
122 | 		} else {
123 | 			$cache = file_get_contents( $notifier_file_url ); // ...if not, use the common file_get_contents()
124 | 		}
125 | 
126 | 		if ( $cache ) {			
127 | 			// we got good results	
128 | 			update_option( $db_cache_field, $cache );
129 | 			update_option( $db_cache_field_last_updated, time() );
130 | 		} 
131 | 		// read from the cache file
132 | 		$notifier_data = get_option( $db_cache_field );
133 | 	}
134 | 	else {
135 | 		// cache file is fresh enough, so read from it
136 | 		$notifier_data = get_option( $db_cache_field );
137 | 	}
138 | 
139 | 	// Let's see if the $xml data was returned as we expected it to.
140 | 	// If it didn't, use the default 1.0 as the latest version so that we don't have problems when the remote server hosting the XML file is down
141 | 	if( strpos( (string) $notifier_data, '<notifier>' ) === false ) {
142 | 		$notifier_data = '<?xml version="1.0" encoding="UTF-8"?><notifier><latest>1.0</latest><changelog></changelog></notifier>';
143 | 	}
144 | 
145 | 	// Load the remote XML data into a variable and return it
146 | 	$xml = simplexml_load_string( $notifier_data ); 
147 | 
148 | 	return $xml;
149 | }
150 | 


--------------------------------------------------------------------------------