NF_Extension_Updater

This class handles all the update-related stuff for extensions, including adding a license section to the license tab.

Defined (2)

The class is defined in the following location(s).

/deprecated/includes/class-extension-updater.php  
  1. class NF_Extension_Updater 
  2. { 
  3.      
  4.     /** 
  5.      * 
  6.      * Define our class variables 
  7.      */ 
  8.     public $product_nice_name = ''; 
  9.     public $product_name = ''; 
  10.     public $version = ''; 
  11.     public $store_url = 'https://ninjaforms.com/update-check/'; 
  12.     public $file = ''; 
  13.     public $author = ''; 
  14.     public $error = ''; 
  15.  
  16.     /** 
  17.      * 
  18.      * Constructor function 
  19.      * 
  20.      * @since 2.2.47 
  21.      * @return void 
  22.      */ 
  23.  
  24.     function __construct( $product_name, $version, $author, $file, $slug = '' ) { 
  25.         $this->product_nice_name = $product_name; 
  26.         if ( $slug == '' ) { 
  27.             $this->product_name = strtolower( $product_name ); 
  28.             $this->product_name = preg_replace( "/[^a-zA-Z]+/", "", $this->product_name );             
  29.         } else { 
  30.             $this->product_name = $slug; 
  31.         } 
  32.  
  33.         $this->version = $version; 
  34.         $this->file = str_replace( '/deprecated', '', $file ); 
  35.         $this->author = $author; 
  36.  
  37.         $this->add_license_fields(); 
  38.         $this->auto_update(); 
  39.  
  40.     } // function constructor 
  41.  
  42.     /** 
  43.      * 
  44.      * Function that adds the license entry fields to the license tab. 
  45.      * 
  46.      * @since 2.2.47 
  47.      * @return void 
  48.      */ 
  49.  
  50.     function add_license_fields() { 
  51.         $valid = $this->is_valid(); 
  52.         $error = $this->get_error(); 
  53.         $note = $valid ? '' : __( 'You will find this included with your purchase email.', 'ninja-forms' ); 
  54.         $desc = $error ? $error : $note; 
  55.         $args = array( 
  56.             'page' => 'ninja-forms-settings',  
  57.             'tab' => 'license_settings',  
  58.             'slug' => 'license_settings',  
  59.             'settings' => array( 
  60.                 array( 
  61.                     'name' => $this->product_name.'_license',  
  62.                     'type' => 'custom',  
  63.                     'label' => $this->product_nice_name.' '.__( 'Key', 'ninja-forms' ),  
  64.                     'desc' => $desc,  
  65.                     'save_function' => array( $this, 'check_license' ),  
  66.                     'class' => 'test',  
  67.                     'display_function' => array( $this, 'output_field' ),  
  68.  ),  
  69.  ),  
  70.  ); 
  71.         if( function_exists( 'ninja_forms_register_tab_metabox_options' ) ) { 
  72.             ninja_forms_register_tab_metabox_options( $args ); 
  73.         } 
  74.     } // function add_license_fields 
  75.  
  76.     /** 
  77.      * 
  78.      * Function that activates the license for this product 
  79.      * 
  80.      * @since 2.2.47 
  81.      * @return void 
  82.      */ 
  83.  
  84.     function check_license( $data ) { 
  85.         // Check to see if we've clicked the deactivate all button. 
  86.         if ( isset ( $data['deactivate_all'] ) ) { 
  87.             $this->deactivate_license(); 
  88.         } else if ( isset ( $data[ 'deactivate_license_' . $this->product_name ] ) ) { // Check to see if we've clicked a deactivation button. 
  89.             $this->deactivate_license(); 
  90.             return false; 
  91.         } else if ( isset ( $data[ $this->product_name . '_license' ] ) ) { 
  92.              $this->activate_license( $data ); 
  93.         } 
  94.  
  95.     } // function check_license 
  96.  
  97.     /** 
  98.      * 
  99.      * Function that activates our license 
  100.      * 
  101.      * @since 2.2.47 
  102.      * @return void 
  103.      */ 
  104.  
  105.     function activate_license( $data ) { 
  106.      
  107.         $plugin_settings = nf_get_settings(); 
  108.         // retrieve the license from the database 
  109.         $license = $data[ $this->product_name.'_license' ]; 
  110.  
  111.         // data to send in our API request 
  112.         $api_params = array(  
  113.             'edd_action'=> 'activate_license',  
  114.             'license' => $license,  
  115.             'item_name' => urlencode( $this->product_nice_name ) // the name of our product in EDD 
  116.  ); 
  117.   
  118.         // Call the custom API. 
  119.         $response = wp_remote_post( esc_url_raw( add_query_arg( $api_params, $this->store_url ) ) ); 
  120.  
  121.         if ( isset ( $_GET['debug'] ) && 'true' == $_GET['debug'] ) { 
  122.             echo '<pre>'; 
  123.             var_dump( $response ); 
  124.             echo '</pre>'; 
  125.             die(); 
  126.         } 
  127.  
  128.         // make sure the response came back okay 
  129.         if ( is_wp_error( $response ) ) 
  130.             return false; 
  131.   
  132.         // decode the license data 
  133.         $license_data = json_decode( wp_remote_retrieve_body( $response ) ); 
  134.  
  135.         // $license_data->license will be either "valid" or "invalid" 
  136.          $plugin_settings[  $this->product_name . '_license' ] = $license; 
  137.          $plugin_settings[  $this->product_name . '_license_status' ] = $license_data->license; 
  138.  
  139.         if ( 'invalid' == $license_data->license ) { 
  140.             $error = '<span style="color: red;">' . __( 'Could not activate license. Please verify your license key', 'ninja-forms' ) . '</span>'; 
  141.         } else { 
  142.             $error = ''; 
  143.         } 
  144.  
  145.         $plugin_settings[ $this->product_name . '_license_error' ] = $error; 
  146.  
  147.         update_option( 'ninja_forms_settings', $plugin_settings ); 
  148.     } 
  149.  
  150.     /** 
  151.      * 
  152.      * Function that deactivates our license if the user clicks the "Deactivate License" button. 
  153.      * 
  154.      * @since 2.2.47 
  155.      * @return void 
  156.      */ 
  157.  
  158.     function deactivate_license() { 
  159.         $plugin_settings = nf_get_settings(); 
  160.  
  161.         if( isset( $plugin_settings[ $this->product_name.'_license_status' ] ) ) { 
  162.             $status = $plugin_settings[ $this->product_name.'_license_status' ]; 
  163.         }else{ 
  164.             $status = 'invalid'; 
  165.         } 
  166.  
  167.         if( isset( $plugin_settings[ $this->product_name.'_license' ] ) ) { 
  168.             $license = $plugin_settings[ $this->product_name.'_license']; 
  169.         }else{ 
  170.             $license = ''; 
  171.         } 
  172.          
  173.         // data to send in our API request 
  174.         $api_params = array(  
  175.             'edd_action'=> 'deactivate_license',  
  176.             'license' => $license,  
  177.             'item_name' => urlencode( $this->product_nice_name ) // the name of our product in EDD 
  178.  ); 
  179.  
  180.         // Call the custom API. 
  181.         $response = wp_remote_post( esc_url_raw( add_query_arg( $api_params, $this->store_url ) ), array( 'timeout' => 15, 'sslverify' => false ) ); 
  182.          
  183.         if ( isset ( $_GET['debug'] ) && 'true' == $_GET['debug'] ) { 
  184.             echo '<pre>'; 
  185.             var_dump( $response ); 
  186.             echo '</pre>'; 
  187.             die(); 
  188.         } 
  189.  
  190.          // make sure the response came back okay 
  191.         if ( is_wp_error( $response ) ) 
  192.             return false; 
  193.  
  194.         // decode the license data 
  195.         $license_data = json_decode( wp_remote_retrieve_body( $response ) ); 
  196.  
  197.         $plugin_settings[  $this->product_name.'_license_error' ] = ''; 
  198.         // $license_data->license will be either "deactivated" or "failed" 
  199.         // if( 'deactivated' == $license_data->license ) { 
  200.             // $license_data->license will be either "valid" or "invalid" 
  201.             $plugin_settings[  $this->product_name.'_license_status' ] = 'invalid'; 
  202.              $plugin_settings[  $this->product_name.'_license' ] = ''; 
  203.         // } 
  204.         update_option( 'ninja_forms_settings', $plugin_settings ); 
  205.     } 
  206.  
  207.     /** 
  208.      * 
  209.      * Function that runs all of our auto-update functionality 
  210.      * 
  211.      * @since 2.2.47 
  212.      * @return void 
  213.      */ 
  214.  
  215.     function auto_update() { 
  216.         $plugin_settings = nf_get_settings(); 
  217.  
  218.         // retrieve our license key from the DB 
  219.         if( isset( $plugin_settings[ $this->product_name.'_license' ] ) ) { 
  220.           $license = $plugin_settings[ $this->product_name.'_license' ]; 
  221.         }else{ 
  222.           $license = ''; 
  223.         } 
  224.  
  225.         // setup the updater 
  226.         $edd_updater = new EDD_SL_Plugin_Updater( $this->store_url, $this->file, array( 
  227.             'version' => $this->version, // current version number 
  228.             'license' => $license, // license key (used get_option above to retrieve from DB) 
  229.             'item_name' => $this->product_nice_name, // name of this plugin 
  230.             'author' => $this->author, // author of this plugin 
  231.  ) 
  232.  ); 
  233.     } // function auto_update 
  234.  
  235.     /** 
  236.      * Return whether or not this license is valid. 
  237.      *  
  238.      * @access public 
  239.      * @since 2.9 
  240.      * @return bool 
  241.      */ 
  242.     public function is_valid() { 
  243.         $plugin_settings = nf_get_settings(); 
  244.         if( isset( $plugin_settings[ $this->product_name.'_license_status' ] ) && $plugin_settings[ $this->product_name.'_license_status' ] == 'valid' ) { 
  245.             return true; 
  246.         }else{ 
  247.             return false; 
  248.         } 
  249.     } 
  250.  
  251.     /** 
  252.      * Output our field for entering and deactivating a license. 
  253.      *  
  254.      * @access public 
  255.      * @since 2.9 
  256.      * @return void 
  257.      */ 
  258.     public function output_field( $form_id, $data, $field ) { 
  259.         $valid = $this->is_valid(); 
  260.         if ( $valid ) { 
  261.             $license = isset ( $data[ $this->product_name . '_license' ] ) ? $data[ $this->product_name . '_license' ] : ''; 
  262.             ?> 
  263.             <span class="nf-license"><?php echo $license; ?></span> 
  264.             <input type="submit" class="button-secondary" name="deactivate_license_<?php echo $this->product_name; ?>" value="<?php _e( 'Deactivate License', 'ninja-forms' ); ?>"> 
  265.             <?php 
  266.         } else { 
  267.             ?> 
  268.             <input type="text" style="width:55%" class="code" name="<?php echo $this->product_name . '_license'; ?>" id="" value="" /> 
  269.             <?php 
  270.         } 
  271.     } 
  272.  
  273.     /** 
  274.      * Get any error messages for this license field. 
  275.      *  
  276.      * @access public 
  277.      * @since 2.9 
  278.      * @return string $error 
  279.      */ 
  280.     public function get_error() { 
  281.         $plugin_settings = nf_get_settings(); 
  282.         $error = ! empty( $plugin_settings[ $this->product_name . '_license_error' ] ) ? $plugin_settings[ $this->product_name . '_license_error' ] : false; 
  283.         return $error; 
  284.     } 
  285.  
  286. } // class 
/includes/Integrations/EDD/class-extension-updater.php  
  1. class NF_Extension_Updater 
  2. { 
  3.     public $product_nice_name = ''; 
  4.     public $product_name = ''; 
  5.     public $version = ''; 
  6.     public $store_url = 'https://ninjaforms.com/update-check/'; 
  7.     public $file = ''; 
  8.     public $author = ''; 
  9.     public $error = ''; 
  10.  
  11.     /** 
  12.      * Constructor function 
  13.      * 
  14.      * @since 2.2.47 
  15.      * @updated 3.0 
  16.      * @return void 
  17.      */ 
  18.     public function __construct( $product_name, $version, $author, $file, $slug = '' ) 
  19.     { 
  20.         $this->product_nice_name = $product_name; 
  21.         if ( $slug == '' ) { 
  22.             $this->product_name = strtolower( $product_name ); 
  23.             $this->product_name = preg_replace( "/[^a-zA-Z]+/", "", $this->product_name ); 
  24.         } else { 
  25.             $this->product_name = $slug; 
  26.         } 
  27.  
  28.         $this->version = $version; 
  29.         $this->file = $file; 
  30.         $this->author = $author; 
  31.  
  32.         $this->auto_update(); 
  33.          
  34.         add_filter( 'ninja_forms_settings_licenses_addons', array( $this, 'register' ) ); 
  35.     } 
  36.  
  37.     /** 
  38.      * Function that adds the license entry fields to the license tab. 
  39.      * 
  40.      * @updated 3.0 
  41.      * @param array $licenses 
  42.      * @return array $licenses 
  43.      */ 
  44.     function register( $licenses ) { 
  45.         $licenses[] = $this; 
  46.         return $licenses; 
  47.     } 
  48.  
  49.     /** 
  50.      * 
  51.      * Function that activates our license 
  52.      * 
  53.      * @since 2.2.47 
  54.      * @return void 
  55.      */ 
  56.     function activate_license( $license_key ) { 
  57.  
  58.         // data to send in our API request 
  59.         $api_params = array( 
  60.             'edd_action'=> 'activate_license',  
  61.             'license' => $license_key,  
  62.             'item_name' => urlencode( $this->product_nice_name ), // the name of our product in EDD 
  63.             'url' => home_url() 
  64.  ); 
  65.  
  66.         // Call the custom API. 
  67.         $response = wp_remote_post( $this->store_url, array( 'timeout' => 15, 'sslverify' => false, 'body' => $api_params ) ); 
  68.  
  69.         $this->maybe_debug( $response ); 
  70.  
  71.         // make sure the response came back okay 
  72.         if ( is_wp_error( $response ) ) 
  73.             return false; 
  74.  
  75.         // decode the license data 
  76.         $license_data = json_decode( wp_remote_retrieve_body( $response ) ); 
  77.  
  78.         if ( 'invalid' == $license_data->license ) { 
  79.             $error = '<span style="color: red;">' . __( 'Could not activate license. Please verify your license key', 'ninja-forms' ) . '</span>'; 
  80.         } else { 
  81.             $error = ''; 
  82.         } 
  83.  
  84.         Ninja_Forms()->update_setting( $this->product_name . '_license', $license_key ); 
  85.         Ninja_Forms()->update_setting( $this->product_name . '_license_error', $error ); 
  86.         Ninja_Forms()->update_setting( $this->product_name . '_license_status', $license_data->license ); 
  87.     } 
  88.  
  89.     /** 
  90.      * 
  91.      * Function that deactivates our license if the user clicks the "Deactivate License" button. 
  92.      * 
  93.      * @since 2.2.47 
  94.      * @return void 
  95.      */ 
  96.  
  97.     function deactivate_license() { 
  98.  
  99.         $license = Ninja_Forms()->get_setting( $this->product_name . '_license' ); 
  100.  
  101.         // data to send in our API request 
  102.         $api_params = array( 
  103.             'edd_action'=> 'deactivate_license',  
  104.             'license' => $license,  
  105.             'item_name' => urlencode( $this->product_nice_name ), // the name of our product in EDD 
  106.             'url' => home_url() 
  107.  ); 
  108.  
  109.         // Call the custom API. 
  110.         $response = wp_remote_post( $this->store_url, array( 'timeout' => 15, 'sslverify' => false, 'body' => $api_params ) ); 
  111.  
  112.         $this->maybe_debug( $response ); 
  113.  
  114.         // make sure the response came back okay 
  115.         if ( is_wp_error( $response ) ) 
  116.             return false; 
  117.  
  118.         Ninja_Forms()->update_setting( $this->product_name.'_license_error', '' ); 
  119.         Ninja_Forms()->update_setting( $this->product_name.'_license_status', 'invalid' ); 
  120.         Ninja_Forms()->update_setting( $this->product_name.'_license', '' ); 
  121.     } 
  122.  
  123.     /** 
  124.      * Function that runs all of our auto-update functionality 
  125.      * 
  126.      * @since 2.2.47 
  127.      * @updates 3.0 
  128.      * @return void 
  129.      */ 
  130.     function auto_update() { 
  131.  
  132.         $edd_updater = new EDD_SL_Plugin_Updater( $this->store_url, $this->file, array( 
  133.                 'author' => $this->author, // author of this plugin 
  134.                 'version' => $this->version, // current version number 
  135.                 'item_name' => $this->product_nice_name, // name of this plugin 
  136.                 'license' => Ninja_Forms()->get_setting( $this->product_name.'_license' ), // license key 
  137.  ) 
  138.  ); 
  139.     } // function auto_update 
  140.  
  141.     /** 
  142.      * Return whether or not this license is valid. 
  143.      * 
  144.      * @access public 
  145.      * @since 2.9 
  146.      * @return bool 
  147.      */ 
  148.     public function is_valid() { 
  149.          return ( 'valid' == Ninja_Forms()->get_setting( $this->product_name.'_license_status' ) ); 
  150.     } 
  151.  
  152.     /** 
  153.      * Get any error messages for this license field. 
  154.      * 
  155.      * @access public 
  156.      * @since 2.9 
  157.      * @return string $error 
  158.      */ 
  159.     public function get_error() { 
  160.         return Ninja_Forms()->get_setting( $this->product_name . '_license_error' ); 
  161.     } 
  162.  
  163.     private function maybe_debug( $data, $key = 'debug' ) 
  164.     { 
  165.         if ( isset ( $_GET[ $key ] ) && 'true' == $_GET[ $key ] ) { 
  166.             echo '<pre>'; var_dump( $data ); echo '</pre>'; 
  167.             die(); 
  168.         } 
  169.     } 
  170.  
  171. } // End Class NF_Extension_Updater