├── .gitignore ├── grunt └── configs │ ├── addtextdomain.js │ └── makepot.js ├── package.json ├── Gruntfile.js ├── includes ├── Ajax.php ├── Integrations │ ├── Memberships.php │ └── Subscriptions.php ├── Functions.php ├── Forwarded_URLs.php └── Bogus_Gateway.php ├── i18n └── languages │ └── woocommerce-dev-helper.pot ├── README.md ├── woocommerce-dev-helper.php └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | *.zip 3 | .DS_Store 4 | 5 | # NPM packages used by Grunt.js 6 | /node_modules 7 | 8 | # NPM debug log 9 | npm-debug.log 10 | 11 | # Composer 12 | /vendor 13 | composer.lock 14 | -------------------------------------------------------------------------------- /grunt/configs/addtextdomain.js: -------------------------------------------------------------------------------- 1 | /* jshint node:true */ 2 | module.exports = function( grunt ) { 3 | 'use strict'; 4 | 5 | var config = {}; 6 | 7 | // Makepot 8 | config.addtextdomain = { 9 | addtextdomain: { 10 | options: { 11 | updateDomains: true 12 | }, 13 | files: [{ 14 | expand: true, 15 | cwd: '', 16 | src: [ '*.php', '**/*.php', '!node_modules/**' ], 17 | //dest: 'build/' 18 | }], 19 | // files: { 20 | // // expand: true, 21 | // // cwd: process.cwd(), 22 | // src: [ 23 | // '*.php', 24 | // '**/*.php', 25 | // '!node_modules/**' 26 | // ] 27 | // } 28 | } 29 | }; 30 | 31 | return config; 32 | }; 33 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "a-woocommerce-dev-helper", 3 | "author": "SkyVerge Team", 4 | "homepage": "http://www.skyverge.com", 5 | "repository": { 6 | "type": "git", 7 | "url": "https://github.com/skyverge/woocommerce-dev-helper.git" 8 | }, 9 | "bugs": { 10 | "url": "https://github.com/skyverge/woocommerce-dev-helper/issues" 11 | }, 12 | "engines": { 13 | "node": ">= 0.10.0" 14 | }, 15 | "devDependencies": { 16 | "grunt": "~1.3.0", 17 | "grunt-newer": "~1.1.1", 18 | "grunt-notify": "~0.4.1", 19 | "grunt-wp-i18n": "~0.5.2", 20 | "load-grunt-tasks": "~3.2.0", 21 | "time-grunt": "~1.2.1", 22 | "underscore": "~1.8.3", 23 | "underscore.string": "~3.1.1" 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /grunt/configs/makepot.js: -------------------------------------------------------------------------------- 1 | /* jshint node:true */ 2 | module.exports = function( grunt ) { 3 | 'use strict'; 4 | 5 | var config = {}; 6 | 7 | // Makepot 8 | config.makepot = { 9 | makepot: { 10 | options: { 11 | cwd: '', 12 | domainPath: 'i18n/languages', 13 | potFilename: grunt.option( 'plugin-slug' ) + '.pot', 14 | potHeaders: { 'report-msgid-bugs-to': 'https://github.com/skyverge/' + grunt.option( 'plugin-slug' ) + '/issues' }, 15 | processPot: function( pot ) { 16 | delete pot.headers['x-generator']; 17 | return pot; 18 | }, // jshint ignore:line 19 | type: 'wp-plugin', 20 | updateTimestamp: false 21 | } 22 | } 23 | }; 24 | 25 | 26 | return config; 27 | }; 28 | -------------------------------------------------------------------------------- /Gruntfile.js: -------------------------------------------------------------------------------- 1 | /* jshint node:true */ 2 | module.exports = function( grunt ) { 3 | 'use strict'; 4 | 5 | // load all grunt tasks matching the `grunt-*` pattern 6 | require( 'load-grunt-tasks' )( grunt ); 7 | 8 | // Show elapsed time 9 | require( 'time-grunt' )( grunt ); 10 | 11 | var _ = require( 'underscore' ); 12 | var path = require( 'path' ); 13 | 14 | // Set plugin slug option 15 | grunt.option( 'plugin-slug', path.basename( process.cwd() ) ); 16 | 17 | var gruntConfig = {}; 18 | 19 | // options 20 | gruntConfig.options = {}; 21 | 22 | // Set folder templates 23 | gruntConfig.dirs = { 24 | css: 'assets/css', 25 | js: 'assets/js', 26 | images: 'assets/images', 27 | fonts: 'assets/fonts', 28 | build: 'build' 29 | }; 30 | 31 | function loadConfig( filepath ) { 32 | var object = {}; 33 | var key; 34 | 35 | filepath = path.normalize( path.resolve( process.cwd(), filepath ) + '/' ) 36 | 37 | var files = grunt.file.glob.sync( '*', { cwd: filepath } ); 38 | 39 | files.forEach( function( option ) { 40 | key = option.replace(/\.js$/,''); 41 | object = _.extend( object, require( filepath + option )( grunt ) ); 42 | }); 43 | 44 | return object; 45 | }; 46 | 47 | // load task configs 48 | gruntConfig = _.extend( gruntConfig, loadConfig( './grunt/configs/' ) ); 49 | 50 | // Init Grunt 51 | grunt.initConfig( gruntConfig ); 52 | 53 | // Register Tasks 54 | grunt.registerTask( 'default', [ 55 | 'addtextdomain', 56 | 'makepot' 57 | ] ); 58 | }; 59 | -------------------------------------------------------------------------------- /includes/Ajax.php: -------------------------------------------------------------------------------- 1 | session; 47 | 48 | wp_send_json( $session_handler->get_session_data() ); 49 | } 50 | 51 | 52 | } 53 | -------------------------------------------------------------------------------- /includes/Integrations/Memberships.php: -------------------------------------------------------------------------------- 1 | __( 'minute(s)', 'woocommerce-dev-helper' ), 59 | 'hours' => __( 'hour(s)', 'woocommerce-dev-helper' ), 60 | ); 61 | 62 | return array_merge( $new_periods, $periods ); 63 | } 64 | 65 | 66 | /** 67 | * Display a human friendly format for the access length when it's minutes or hours-long 68 | * 69 | * @since 0.4.2 70 | * @param string $human_length The human length 71 | * @param string $standard_length The length in the standard machine-friendly format 72 | * @return string 73 | */ 74 | public function filter_membership_human_access_length( $human_length, $standard_length ) { 75 | 76 | $has_minutes = strpos( $standard_length, 'minute' ) !== false; 77 | $has_hours = strpos( $standard_length, 'hour' ) !== false; 78 | 79 | if ( $has_minutes || $has_hours ) { 80 | 81 | $human_length = $standard_length; 82 | } 83 | 84 | return $human_length; 85 | } 86 | 87 | 88 | } 89 | -------------------------------------------------------------------------------- /i18n/languages/woocommerce-dev-helper.pot: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2017 SkyVerge 2 | # This file is distributed under the GNU General Public License v3.0. 3 | msgid "" 4 | msgstr "" 5 | "Project-Id-Version: A WooCommerce Dev Helper 0.8.0\n" 6 | "Report-Msgid-Bugs-To: " 7 | "https://github.com/skyverge/woocommerce-dev-helper/issues\n" 8 | "POT-Creation-Date: 2015-07-26 19:51:27+00:00\n" 9 | "MIME-Version: 1.0\n" 10 | "Content-Type: text/plain; charset=utf-8\n" 11 | "Content-Transfer-Encoding: 8bit\n" 12 | "PO-Revision-Date: 2017-MO-DA HO:MI+ZONE\n" 13 | "Last-Translator: FULL NAME \n" 14 | "Language-Team: LANGUAGE \n" 15 | 16 | #: includes/class-wc-dev-helper-bogus-gateway.php:42 17 | msgid "Bogus" 18 | msgstr "" 19 | 20 | #: includes/class-wc-dev-helper-bogus-gateway.php:43 21 | msgid "" 22 | "A testing gateway that calls \"payment complete\" to simulate credit card " 23 | "transactions." 24 | msgstr "" 25 | 26 | #: includes/class-wc-dev-helper-bogus-gateway.php:92 27 | msgid "Enable/Disable" 28 | msgstr "" 29 | 30 | #: includes/class-wc-dev-helper-bogus-gateway.php:94 31 | msgid "Enable Bogus Gateway" 32 | msgstr "" 33 | 34 | #: includes/class-wc-dev-helper-bogus-gateway.php:99 35 | msgid "Title" 36 | msgstr "" 37 | 38 | #: includes/class-wc-dev-helper-bogus-gateway.php:101 39 | msgid "" 40 | "This controls the title for the payment method the customer sees during " 41 | "checkout." 42 | msgstr "" 43 | 44 | #: includes/class-wc-dev-helper-bogus-gateway.php:102 45 | msgid "Bogus (Test)" 46 | msgstr "" 47 | 48 | #: includes/class-wc-dev-helper-bogus-gateway.php:107 49 | msgid "Description" 50 | msgstr "" 51 | 52 | #: includes/class-wc-dev-helper-bogus-gateway.php:109 53 | msgid "Payment method description that the customer will see on your checkout." 54 | msgstr "" 55 | 56 | #: includes/class-wc-dev-helper-bogus-gateway.php:110 57 | msgid "Nothingtodohere 🚀" 58 | msgstr "" 59 | 60 | #: includes/class-wc-dev-helper-bogus-gateway.php:115 61 | msgid "Enable Subscriptions support?" 62 | msgstr "" 63 | 64 | #: includes/class-wc-dev-helper-bogus-gateway.php:117 65 | msgid "Makes the gateway available for subscriptions purchases" 66 | msgstr "" 67 | 68 | #: includes/class-wc-dev-helper-bogus-gateway.php:150 69 | msgid "Bogus is always approved 😎" 70 | msgstr "" 71 | 72 | #: includes/class-wc-dev-helper-bogus-gateway.php:175 73 | msgid "Renewal order processed. Bogus is always approved 😎" 74 | msgstr "" 75 | 76 | #: includes/class-wc-dev-helper-memberships.php:55 77 | msgid "minute(s)" 78 | msgstr "" 79 | 80 | #: includes/class-wc-dev-helper-memberships.php:56 81 | msgid "hour(s)" 82 | msgstr "" 83 | 84 | #: includes/class-wc-dev-helper-subscriptions.php:98 85 | msgid "Renew" 86 | msgstr "" 87 | 88 | #: includes/class-wc-dev-helper-subscriptions.php:151 89 | msgid "Subscription renewal processed. %sView Renewal Order%s" 90 | msgstr "" 91 | 92 | #: includes/class-wc-dev-helper-subscriptions.php:174 93 | msgid "Action Failed, Invalid Nonce" 94 | msgstr "" 95 | 96 | #: includes/class-wc-dev-helper-subscriptions.php:203 97 | msgid "Subscription Renewal Processed" 98 | msgstr "" 99 | 100 | #: woocommerce-dev-helper.php:373 101 | msgid "You cannot clone instances of WooCommerce Dev Helper." 102 | msgstr "" 103 | 104 | #: woocommerce-dev-helper.php:383 105 | msgid "You cannot unserialize instances of WooCommerce Dev Helper." 106 | msgstr "" 107 | 108 | #. Plugin Name of the plugin/theme 109 | msgid "A WooCommerce Dev Helper" 110 | msgstr "" 111 | 112 | #. Plugin URI of the plugin/theme 113 | msgid "https://github.com/skyverge/woocommerce-dev-helper/" 114 | msgstr "" 115 | 116 | #. Description of the plugin/theme 117 | msgid "A simple plugin for helping develop/debug WooCommerce & extensions" 118 | msgstr "" 119 | 120 | #. Author of the plugin/theme 121 | msgid "SkyVerge" 122 | msgstr "" 123 | 124 | #. Author URI of the plugin/theme 125 | msgid "http://www.skyverge.com" 126 | msgstr "" -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | WooCommerce Dev Helper 2 | ====================== 3 | 4 | This is a simple and opinionated plugin for helping develop/debug WooCommerce & extensions. DO NOT USE ON A PRODUCTION SERVER. 5 | 6 | ### Use Forwarded URLs 7 | 8 | Once activated, this plugin will make WordPress use `HTTP_X_FORWARDED_FOR` for all your links instead of your site URL. No configuration needed. 9 | 10 | We like to use [NGrok](http://ngrok.com/) for this. 11 | 12 | ### Subscriptions 13 | 14 | Adds a "renew" link to each subscription under WooCommerce > Subscriptions for easy renewal processing. This is particularly useful for testing 15 | payment gateways that supports subscriptions. 16 | 17 | Allows for minutes and hours-long Subscription periods for quicker testing. 18 | 19 | ### Memberships 20 | 21 | Allows for minutes and hours-long Membership lengths for quicker testing. 22 | 23 | ### Bogus Gateway 24 | 25 | Adds a testing payment gateway that will call the `$order->payment_complete()` method to simulate a credit card payment. Can also be used for Subscriptions automatic renewals. 26 | 27 | ### Global Functions 28 | 29 | * `wp_debug_backtrace()` - helper for using the `debug_backtrace()` function with a bit more sanity 30 | * `wp_var_dump()` - helper for `var_dump`, allowing you to return the output instead of printing 31 | * `wp_var_log()` - helper for `error_log` that uses `print_r()` or optionally `wp_var_dump()` 32 | * `wp_print_r()` - helper for `print_r` that wraps the output in `
` HTML tags
33 | * `wc_dev_session` - JS helper to get all the current session data in console
34 | 
35 | ### Misc
36 | 
37 | * Removes the WooCommmerce Updater notice
38 | * Removes the strong password requirement for customer accounts
39 | * Helper for logging actions/filters fired during a page load -- simply add `?wcdh_hooks=actions|filters|all`, reload the page, and your desired hooks will be printed to the error log, along with the fired count
40 | 
41 | ## Installation
42 | 
43 | Download and install just like any other WordPress plugin. If you want to be really fancy, symlink it into your installs instead.
44 | 
45 | ## Changelog
46 | 
47 | ### 1.0.1 - 2023.08.02
48 |   * Tweak - Add a field at checkout when selecting the bogus payment gateway to specify the desired payment result
49 |   * Fix - Fix support for ngrok.io
50 |   * Misc - Remove support for ForwardHQ
51 | 
52 | ### 1.0.0 - 2018.11.06
53 |  * Refactor - Use namespaces and rename classes
54 |  * Tweak - Add support for ngrok
55 |  * Fix - Ensure images load for products when using an https tunnel
56 |  * Misc - Require PHP 5.3+
57 | 
58 | ### 0.8.1 - 2017.12.13
59 |  * Fix - Remove WC 3.3+ "Connect to WooCommerce" notice when official plugins are active
60 | 
61 | ### 0.8.0 - 2017.07.22
62 |  * Tweak - Remove dependency on WooCommerce
63 |  * Tweak - Add support for domain forwarding as early as possible
64 | 
65 | ### 0.7.0 - 2017.04.12
66 |  * Feature - Use the Bogus gateway for Subscriptions automatic renewals
67 |  * Fix - Subscriptions integration throwing a warning in WooCommerce 3.0+
68 | 
69 | ### 0.6.0 - 2017.02.18
70 |  * Feature - Adds a bogus gateway that calls `$order->payment_complete()` when used
71 | 
72 | ### 0.5.0 - 2017.01.19
73 |  * Feature - Dump the current session in AJAX to display in browser console
74 | 
75 | ### 0.4.2 - 2016.10.21
76 |  * Tweak - Filter the human access length for membership plans that have a length in minutes or hours set via this helper plugin (Memberships 1.7.2+)
77 | 
78 | ### 0.4.1 - 2016.10.18
79 |  * Fix - Minutes and hours-long periods in membership plans did not work properly or when creating a user membership in admin and setting the length from the membership plan default
80 | 
81 | ### 0.4.0 - 2016.06.06
82 |  * Feature - Added minutes and hours Subscription periods for quicker Subscriptions testing
83 |  * Feature - Added Memberships support with minutes and hours Memberships periods for quicker access and dripping testing
84 |  * Feature - Added `wp_print_r()` helper function
85 | 
86 | ### 0.3.0 - 2015.12.28
87 |  * Feature - Removes WooCommerce 2.5+ strong password requirement for customer registration
88 | 
89 | ### 0.2.0 - 2015.09.04
90 |  * Feature - Subscriptions 2.0 Compatibility
91 |  * Fix - Fix is_ssl() when using Forward
92 | 
93 | ### 0.1.0 - 2015.07.25
94 |  * Initial Release
95 | 


--------------------------------------------------------------------------------
/includes/Functions.php:
--------------------------------------------------------------------------------
  1 | ";
 43 | 		}
 44 | 		foreach ( $d as $i => $r ) {
 45 | 			if ( ! $show_first && $i == 0 ) {
 46 | 				continue;
 47 | 			}
 48 | 			// sometimes there is undefined index 'file'
 49 | 			@$out .= "[$i] {$r['file']}:{$r['line']}\n";
 50 | 		}
 51 | 		if ( $html ) {
 52 | 			$out .= "
"; 53 | } 54 | if ( $return ) { 55 | return $out; 56 | } else { 57 | echo $out; 58 | } 59 | } 60 | 61 | endif; 62 | 63 | 64 | if ( ! function_exists( 'wp_var_dump' ) ) : 65 | 66 | /** 67 | * Helper function for the PHP var_dump() function, allowing you to return 68 | * the output, rather than printing. Useful for logging. 69 | * 70 | * Example usage: error_log( wp_var_dump( $foo ) ); 71 | * 72 | * @since 0.1.0 73 | * @param mixed $var the variable to dump 74 | * @param bool $return if true, returns the vardump; defaults to true 75 | * @param bool $html_errors true or false enables or disables the html_errors 76 | * directive, null leaves it untouched. Useful when dumping variables 77 | * to the command line with Xdebug installed and html formatting is 78 | * not desired. 79 | * @return void|string Returns a string if $return is true, void otherwise 80 | */ 81 | function wp_var_dump( $var, $return = true, $html_errors = false ) { 82 | 83 | if ( is_bool( $html_errors ) && extension_loaded( 'xdebug' ) ) { 84 | // disable html_errors and save the current setting 85 | $old_html_errors = ini_set( 'html_errors', $html_errors ); 86 | } 87 | 88 | ob_start(); 89 | var_dump( $var ); 90 | $output = ob_get_clean(); 91 | 92 | if ( is_bool( $html_errors ) && extension_loaded( 'xdebug' ) ) { 93 | // return html_errors to its original setting 94 | ini_set( 'html_errors', $old_html_errors ); 95 | } 96 | 97 | if ( $return ) { 98 | return $output; 99 | } else { 100 | echo $output; 101 | } 102 | } 103 | 104 | endif; 105 | 106 | 107 | if ( ! function_exists( 'wp_var_log' ) ) : 108 | 109 | /** 110 | * print_r or var_dump a variable to the error log, useful for logging. 111 | * 112 | * example usage: wp_var_log( $var ); 113 | * 114 | * @since 0.1.0 115 | * @param mixed $var variable to log 116 | * @param bool $dump use wp_var_dump() instead of print_r(), default false 117 | * @return string 118 | */ 119 | function wp_var_log( $var, $dump = false ) { 120 | 121 | if ( $dump ) { 122 | error_log( wp_var_dump( $var ) ); 123 | } else { 124 | error_log( print_r( $var, true ) ); 125 | } 126 | } 127 | 128 | endif; 129 | 130 | 131 | if ( ! function_exists( 'wp_print_r' ) ) : 132 | 133 | /** 134 | * Print human-readable information about a variable 135 | * wrapping it in pre-formatted HTML tags 136 | * 137 | * example usage: wp_print_r( $var ); 138 | * 139 | * @since 0.4.0 140 | * @param $var 141 | */ 142 | function wp_print_r( $var ) { 143 | 144 | echo '
'; print_r( $var ); echo '
'; 145 | } 146 | 147 | endif; 148 | -------------------------------------------------------------------------------- /includes/Forwarded_URLs.php: -------------------------------------------------------------------------------- 1 | has_forwarded_host() ) { 50 | return; 51 | } 52 | 53 | // save for URL replacement 54 | $host = parse_url( get_option( 'siteurl' ), PHP_URL_HOST ); 55 | $port = parse_url( get_option( 'siteurl' ), PHP_URL_PORT ); 56 | $this->non_forwarded_host = $host . ($port ? ':' . $port : null); 57 | 58 | // from https://github.com/50east/wp-forwarded-host-urls/ 59 | $filters = array( 60 | 'post_link', 61 | 'post_type_link', 62 | 'page_link', 63 | 'attachment_link', 64 | 'get_shortlink', 65 | 'post_type_archive_link', 66 | 'get_pagenum_link', 67 | 'get_comments_pagenum_link', 68 | 'term_link', 69 | 'search_link', 70 | 'day_link', 71 | 'month_link', 72 | 'year_link', 73 | 'option_siteurl', 74 | 'blog_option_siteurl', 75 | 'option_home', 76 | 'admin_url', 77 | 'home_url', 78 | 'includes_url', 79 | 'plugins_url', 80 | 'site_url', 81 | 'site_option_siteurl', 82 | 'network_home_url', 83 | 'network_site_url', 84 | 'get_the_author_url', 85 | 'get_comment_link', 86 | 'wp_get_attachment_image_src', 87 | 'wp_get_attachment_thumb_url', 88 | 'wp_get_attachment_url', 89 | 'wp_login_url', 90 | 'wp_logout_url', 91 | 'wp_lostpassword_url', 92 | 'get_stylesheet_uri', 93 | 'get_locale_stylesheet_uri', 94 | 'script_loader_src', 95 | 'style_loader_src', 96 | 'get_theme_root_uri', 97 | 'stylesheet_uri', 98 | 'template_directory_uri', 99 | 'stylesheet_directory_uri', 100 | 'the_content', 101 | 'the_content_pre', 102 | 'wp_calculate_image_srcset', 103 | ); 104 | 105 | foreach ( $filters as $filter ) { 106 | add_filter( $filter, array( $this, 'replace_with_forwarded_url' ) ); 107 | } 108 | 109 | // prevent redirection 110 | add_filter( 'redirect_canonical', '__return_false' ); 111 | 112 | // if accessing via SSL, let WP know (see notes under https://codex.wordpress.org/Function_Reference/is_ssl) 113 | if ( isset( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) && 'https' === $_SERVER['HTTP_X_FORWARDED_PROTO'] ) { 114 | $_SERVER['HTTPS'] = 'on'; 115 | } 116 | } 117 | 118 | 119 | /** 120 | * Returns true if forwarding URLs 121 | * 122 | * @since 0.1.0 123 | * @return bool 124 | */ 125 | private function has_forwarded_host() { 126 | 127 | return array_key_exists( 'HTTP_X_FORWARDED_FOR', $_SERVER ); 128 | } 129 | 130 | 131 | /** 132 | * Returns the forwarded host 133 | * 134 | * @since 0.1.0 135 | * @return string 136 | */ 137 | public function get_forwarded_host() { 138 | 139 | return $_SERVER['HTTP_HOST']; 140 | } 141 | 142 | 143 | /** 144 | * Replace incoming content with non-forwarded URLs converted to 145 | * the forwarded URL 146 | * 147 | * Note this does not attempt to convert protocols, instead it relies on 148 | * WordPress handling protocol changes properly 149 | * 150 | * @since 0.1.0 151 | * @param mixed $content 152 | * @return mixed 153 | */ 154 | public function replace_with_forwarded_url( $content ) { 155 | 156 | $non_forwarded_host = $this->non_forwarded_host; 157 | $forwarded_host = $this->get_forwarded_host(); 158 | 159 | // http, https, and protocol-less URLs 160 | $this->find_replace = array( 161 | "http://{$non_forwarded_host}" => "http://{$forwarded_host}", 162 | "https://{$non_forwarded_host}" => "https://{$forwarded_host}", 163 | "//{$non_forwarded_host}" => "//{$forwarded_host}", 164 | ); 165 | 166 | if ( is_array( $content ) ) { 167 | // array_walk_recursive() takes the input array by reference 168 | array_walk_recursive( $content, [ $this, 'replace_url' ] ); 169 | } else { 170 | $content = str_replace( array_keys( $this->find_replace ), array_values( $this->find_replace ), $content ); 171 | } 172 | 173 | return $content; 174 | } 175 | 176 | 177 | /** 178 | * Replaces URL host within strings recursively. 179 | * 180 | * Required because the image srcset will use upload dir, which we don't filter 181 | * (as we filter site URL), but does so before we filter site_URL. 182 | * BUT we can't filter upload dir directly, because then WP won't auto-detect protocol 183 | * for us, as we'd be replacing the URL too soon. 184 | * So, we filter the srcset at the last minute. 185 | * 186 | * @since 1.0.0 187 | * 188 | * @param array $element the array to operate on 189 | * @param int $index the internal pointer for array_walk_recursive 190 | * @return array the updated array 191 | */ 192 | private function replace_url( &$element, $index ) { 193 | return str_replace( array_keys( $this->find_replace ), array_values( $this->find_replace ), $element ); 194 | } 195 | 196 | 197 | } 198 | -------------------------------------------------------------------------------- /includes/Bogus_Gateway.php: -------------------------------------------------------------------------------- 1 | id = 'bogus_gateway'; 57 | $this->icon = apply_filters( 'woocommerce_bogus_icon', '' ); 58 | $this->has_fields = false; 59 | $this->method_title = __( 'Bogus', 'woocommerce-dev-helper' ); 60 | $this->method_description = __( 'A testing gateway that calls "payment complete" to simulate credit card transactions.', 'woocommerce-dev-helper' ); 61 | 62 | // load the settings 63 | $this->init_form_fields(); 64 | $this->init_settings(); 65 | 66 | // define user set variables 67 | $this->title = $this->get_option( 'title' ); 68 | $this->description = $this->get_option( 'description' ); 69 | $this->subscriptions = $this->get_option( 'subscriptions' ); 70 | 71 | if ( $this->subscriptions_available() ) { 72 | 73 | // Subscriptions support 74 | $this->supports = array_merge( $this->supports, 75 | array( 76 | 'subscriptions', 77 | 'subscription_suspension', 78 | 'subscription_cancellation', 79 | 'subscription_reactivation', 80 | 'subscription_amount_changes', 81 | 'subscription_date_changes', 82 | 'subscription_payment_method_change_customer', 83 | 'subscription_payment_method_change_admin', 84 | 'multiple_subscriptions', 85 | ) 86 | ); 87 | } 88 | 89 | // Save settings 90 | add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) ); 91 | 92 | // Process renewal orders 93 | if ( ! has_action( 'woocommerce_scheduled_subscription_payment_' . $this->id, array( $this, 'process_renewal_payment' ) ) ) { 94 | add_action( 'woocommerce_scheduled_subscription_payment_' . $this->id, array( $this, 'process_renewal_payment' ), 10, 2 ); 95 | } 96 | } 97 | 98 | 99 | /** 100 | * Initialize gateway settings form fields. 101 | * 102 | * @since 0.6.0 103 | */ 104 | public function init_form_fields() { 105 | 106 | $this->form_fields = apply_filters( 'wc_offline_form_fields', array( 107 | 108 | 'enabled' => array( 109 | 'title' => __( 'Enable/Disable', 'woocommerce-dev-helper' ), 110 | 'type' => 'checkbox', 111 | 'label' => __( 'Enable Bogus Gateway', 'woocommerce-dev-helper' ), 112 | 'default' => 'yes' 113 | ), 114 | 115 | 'title' => array( 116 | 'title' => __( 'Title', 'woocommerce-dev-helper' ), 117 | 'type' => 'text', 118 | 'description' => __( 'This controls the title for the payment method the customer sees during checkout.', 'woocommerce-dev-helper' ), 119 | 'default' => __( 'Bogus (Test)', 'woocommerce-dev-helper' ), 120 | 'desc_tip' => true, 121 | ), 122 | 123 | 'description' => array( 124 | 'title' => __( 'Description', 'woocommerce-dev-helper' ), 125 | 'type' => 'textarea', 126 | 'description' => __( 'Payment method description that the customer will see on your checkout.', 'woocommerce-dev-helper' ), 127 | 'default' => __( 'Nothingtodohere 🚀', 'woocommerce-dev-helper' ), 128 | 'desc_tip' => true, 129 | ), 130 | 131 | 'subscriptions' => array( 132 | 'title' => __( 'Enable Subscriptions support?', 'woocommerce-dev-helper' ), 133 | 'type' => 'checkbox', 134 | 'description' => __( 'Makes the gateway available for subscriptions purchases', 'woocommerce-dev-helper' ), 135 | 'default' => 'yes', 136 | 'desc_tip' => true, 137 | ), 138 | 139 | ) ); 140 | } 141 | 142 | 143 | /** 144 | * Renders the gateway payment fields. 145 | * 146 | * @since x.y.z 147 | */ 148 | public function payment_fields() { 149 | 150 | parent::payment_fields(); 151 | 152 | woocommerce_form_field( "{$this->id}_payment_result", [ 153 | 'type' => 'select', 154 | 'label' => __( 'Result', 'woocommerce-dev-helper' ), 155 | 'required' => true, 156 | 'options' => [ 157 | self::PAYMENT_RESULT_APPROVED => __( 'Approved', 'woocommerce-dev-helper' ), 158 | self::PAYMENT_RESULT_HELD => __( 'Held', 'woocommerce-dev-helper' ), 159 | self::PAYMENT_RESULT_DECLINED => __( 'Declined', 'woocommerce-dev-helper' ), 160 | ], 161 | ] ); 162 | } 163 | 164 | 165 | /** 166 | * Returns true if Subscriptions support is enabled. 167 | * 168 | * @since 0.7.0 169 | * @return bool 170 | */ 171 | public function subscriptions_available() { 172 | return 'yes' === $this->subscriptions; 173 | } 174 | 175 | 176 | /** 177 | * Process the payment and return the result. 178 | * 179 | * @since 0.6.0 180 | * @param int $order_id 181 | * @return array 182 | */ 183 | public function process_payment( $order_id ) { 184 | 185 | $order = wc_get_order( $order_id ); 186 | 187 | $result = ! empty( $_POST[ "{$this->id}_payment_result" ] ) ? $_POST[ "{$this->id}_payment_result" ] : self::PAYMENT_RESULT_APPROVED; 188 | 189 | // halt on decline 190 | if ( self::PAYMENT_RESULT_DECLINED === $result ) { 191 | 192 | $message = __( 'Sorry, the payment was bogus 😳', 'woocommerce-dev-helper' ); 193 | 194 | if ( ! $order->has_status( 'failed' ) ) { 195 | $order->update_status( 'failed', $message ); 196 | } else { 197 | $order->add_order_note( $message ); 198 | } 199 | 200 | throw new \Exception( $message ); 201 | } 202 | 203 | // update the order status accordingly 204 | if ( self::PAYMENT_RESULT_HELD === $result ) { 205 | 206 | $order->update_status( 'on-hold', __( 'The payment may be bogus, holding the order 🤔', 'woocommerce-dev-helper' ) ); 207 | 208 | } else { 209 | 210 | $order->payment_complete(); 211 | $order->add_order_note( __( 'Payment approved 😎', 'woocommerce-dev-helper' ) ); 212 | } 213 | 214 | // Remove cart 215 | WC()->cart->empty_cart(); 216 | 217 | // Return thank you redirect 218 | return array( 219 | 'result' => 'success', 220 | 'redirect' => $this->get_return_url( $order ), 221 | ); 222 | } 223 | 224 | 225 | /** 226 | * Processes a renewal payment automatically. 227 | * 228 | * @since 0.7.0 229 | * @param float $amount_to_charge subscription amount to charge, could include 230 | * multiple renewals if they've previously failed and the admin 231 | * has enabled it 232 | * @param \WC_Order $order original order containing the subscription 233 | */ 234 | public function process_renewal_payment( $amount_to_charge, $order ) { 235 | 236 | $order->payment_complete(); 237 | $order->add_order_note( __( 'Renewal order processed. Bogus is always approved 😎', 'woocommerce-dev-helper' ) ); 238 | } 239 | 240 | 241 | } 242 | -------------------------------------------------------------------------------- /includes/Integrations/Subscriptions.php: -------------------------------------------------------------------------------- 1 | is_subs_gte_2_0() ) { 46 | add_filter( 'woocommerce_subscription_list_table_actions', array( $this, 'add_renew_action' ), 10, 2 ); 47 | } else { 48 | add_filter( 'woocommerce_subscriptions_list_table_actions', array( $this, 'add_renew_action' ), 10, 2 ); 49 | } 50 | 51 | // process the renewal action 52 | if ( $this->is_subs_gte_2_0() ) { 53 | add_action( 'load-edit.php', array( $this, 'process_renew_action' ) ); 54 | add_action( 'admin_notices', array( $this, 'maybe_render_renewal_success_message' ) ); 55 | } else { 56 | add_action( 'load-woocommerce_page_subscriptions', array( $this, 'process_pre_subs_2_0_renew_action' ) ); 57 | } 58 | 59 | // add support for minutes and hours-long Subscription period for quicker testing 60 | add_filter( 'woocommerce_subscription_available_time_periods', array( $this, 'new_subscription_periods' ) ); 61 | add_filter( 'woocommerce_subscription_periods', array( $this, 'new_subscription_periods' ) ); 62 | add_filter( 'woocommerce_subscription_trial_periods', array( $this, 'new_subscription_periods' ) ); 63 | add_filter( 'woocommerce_subscription_lengths', array( $this, 'new_subscription_lengths' ) ); 64 | } 65 | 66 | 67 | /** 68 | * Add the "renew" action link to the Subscriptions list table 69 | * 70 | * @since 0.1.0 71 | * @param array $actions subscription actions 72 | * @param array|\WC_Subscription $subscription item 73 | * @return mixed 74 | */ 75 | public function add_renew_action( $actions, $subscription ) { 76 | 77 | if ( $this->is_subs_gte_2_0() ) { 78 | 79 | $renew_url = add_query_arg( 80 | array( 81 | 'post' => is_callable( array( $subscription, 'get_id' ) ) ? $subscription->get_id() : $subscription->id, 82 | 'action' => 'renew', 83 | '_wpnonce' => wp_create_nonce( 'bulk-posts' ), 84 | ) 85 | ); 86 | 87 | } else { 88 | 89 | $renew_url = add_query_arg( 90 | array( 91 | 'page' => $_REQUEST['page'], 92 | 'user' => $subscription['user_id'], 93 | 'subscription' => $subscription['subscription_key'], 94 | 'action' => 'renew', 95 | '_wpnonce' => wp_create_nonce( $subscription['subscription_key'] ), 96 | ) 97 | ); 98 | } 99 | 100 | $actions['renew'] = sprintf( '%s', esc_url( $renew_url ), __( 'Renew', 'woocommerce-dev-helper' ) ); 101 | 102 | return $actions; 103 | } 104 | 105 | 106 | /** 107 | * Process the renewal action from the Subscriptions list table 108 | * 109 | * @since 0.1.0 110 | */ 111 | public function process_renew_action() { 112 | 113 | // only subscriptions 114 | if ( ! isset( $_REQUEST['post_type'] ) || 'shop_subscription' !== $_REQUEST['post_type'] ) { 115 | return; 116 | } 117 | 118 | $wp_list_table = _get_list_table( 'WP_Posts_List_Table' ); 119 | 120 | if ( 'renew' !== $wp_list_table->current_action() ) { 121 | return; 122 | } 123 | 124 | // load gateways 125 | WC()->payment_gateways(); 126 | 127 | $subscription_id = absint( $_REQUEST['post'] ); 128 | 129 | // trigger the renewal 130 | do_action( 'woocommerce_scheduled_subscription_payment', $subscription_id ); 131 | 132 | wp_redirect( remove_query_arg( 'action', add_query_arg( array( 'post_type' => 'shop_subscription', 'wcdh_subs_renew' => true, 'id' => $subscription_id ) ) ) ); 133 | 134 | exit(); 135 | } 136 | 137 | 138 | /** 139 | * Maybe render a renewal success message 140 | * 141 | * @since 0.2.0 142 | */ 143 | public function maybe_render_renewal_success_message() { 144 | global $post_type, $pagenow; 145 | 146 | if ( 'edit.php' !== $pagenow || 'shop_subscription' !== $post_type || empty( $_REQUEST['wcdh_subs_renew'] ) || empty( $_REQUEST['id'] ) ) { 147 | return; 148 | } 149 | 150 | $subscription = wcs_get_subscription( absint( $_REQUEST['id'] ) ); 151 | 152 | if ( $subscription instanceof \WC_Subscription ) { 153 | echo '

' . sprintf( esc_html__( 'Subscription renewal processed. %sView Renewal Order%s', 'woocommerce-dev-helper' ), '', ' →' ) . '

'; 154 | } 155 | } 156 | 157 | 158 | /** Pre Subs 2.0 **********************************************************/ 159 | 160 | 161 | /** 162 | * Process the renewal action from the Subscriptions list table for 163 | * 1.5.x 164 | * 165 | * @since 0.2.0 166 | */ 167 | public function process_pre_subs_2_0_renew_action() { 168 | 169 | // data check 170 | if ( empty( $_GET['action'] ) || empty( $_GET['_wpnonce'] ) || 'renew' !== $_GET['action'] || empty( $_GET['user'] ) || empty( $_GET['subscription'] ) ) { 171 | return; 172 | } 173 | 174 | // nonce check 175 | if ( ! wp_verify_nonce( $_REQUEST['_wpnonce'], $_GET['subscription'] ) ) { 176 | wp_die( __( 'Action Failed, Invalid Nonce', 'woocommerce-dev-helper' ) ); 177 | } 178 | 179 | // load gateways 180 | WC()->payment_gateways(); 181 | 182 | // trigger the renewal payment 183 | \WC_Subscriptions_Payment_Gateways::gateway_scheduled_subscription_payment( absint( $_GET['user'] ), $_GET['subscription'] ); 184 | 185 | // success message 186 | add_filter( 'woocommerce_subscriptions_list_table_pre_process_actions', array( $this, 'maybe_render_pre_subs_2_0_renewal_success_message' ) ); 187 | } 188 | 189 | 190 | /** 191 | * Render a success message when the subscription renewal action has been 192 | * processed 193 | * 194 | * @since 0.1.0 195 | * @param array $args 196 | * @return mixed 197 | */ 198 | public function maybe_render_pre_subs_2_0_renewal_success_message( $args ) { 199 | 200 | if ( empty( $_GET['action'] ) || 'renew' !== $_GET['action'] ) { 201 | return $args; 202 | } 203 | 204 | $args['custom_action'] = true; 205 | $args['messages'] = array( __( 'Subscription Renewal Processed', 'woocommerce-dev-helper' ) ); 206 | 207 | return $args; 208 | } 209 | 210 | 211 | /** 212 | * Returns true if the active version of Subscriptions is 2.0+ 213 | * 214 | * @since 0.2.0 215 | * @return mixed 216 | */ 217 | protected function is_subs_gte_2_0() { 218 | 219 | return version_compare( \WC_Subscriptions::$version, '2.0.0', '>=' ); 220 | } 221 | 222 | 223 | /** 224 | * Add the minute / hour into available subscription period options 225 | * 226 | * @since 0.4.0 227 | * @param array $subscription_periods associative array of available periods 228 | * @return array with updated periods 229 | */ 230 | public function new_subscription_periods( $subscription_periods ) { 231 | 232 | $new_periods = array( 233 | 'minute' => 'minute', 234 | 'hour' => 'hour', 235 | ); 236 | 237 | return array_merge( $new_periods, $subscription_periods); 238 | } 239 | 240 | 241 | /** 242 | * Add subscription lengths for our new "minute" and "hour" period 243 | * 244 | * @since 0.4.0 245 | * @param array $lengths associative array of available lengths 246 | * @return array - updated lengths 247 | */ 248 | public function new_subscription_lengths( $lengths ) { 249 | 250 | // start range with 0 => all time 251 | $minute_durations = array( 'all time', '1 minute' ); 252 | $minute_steps = range( 5, 60, 5 ); 253 | 254 | // add possible steps for subscription duration 255 | foreach( $minute_steps as $number ) { 256 | $minute_durations[ $number ] = $number . ' minutes'; 257 | } 258 | 259 | $hour_durations = array( 'all time', '1 hour' ); 260 | $hour_steps = range( 2, 6 ); 261 | 262 | foreach ( $hour_steps as $number ) { 263 | $hour_durations[ $number ] = $number . ' hours'; 264 | } 265 | 266 | $lengths['minute'] = $minute_durations; 267 | $lengths['hour'] = $hour_durations; 268 | 269 | return $lengths; 270 | } 271 | 272 | 273 | } 274 | -------------------------------------------------------------------------------- /woocommerce-dev-helper.php: -------------------------------------------------------------------------------- 1 | get_plugin_path() . '/includes/Functions.php' ); 59 | 60 | // remove woo updater notice 61 | add_action( 'admin_init', array( $this, 'muzzle_woo_updater' ) ); 62 | 63 | // class includes 64 | add_action( 'plugins_loaded', array( $this, 'includes' ) ); 65 | 66 | // maybe log actions/filters 67 | add_action( 'shutdown', array( $this, 'maybe_log_hooks' ) ); 68 | 69 | // remove WC strong password script 70 | add_action( 'wp_print_scripts', array( $this, 'remove_wc_password_meter' ), 100 ); 71 | 72 | // add some inline JS 73 | add_action( 'wp_footer', array( $this, 'enqueue_scripts' ) ); 74 | 75 | if ( $this->is_plugin_active( 'woocommerce.php' ) ) { 76 | add_action( 'wp_head', array( $this, 'bogus_gateway_styles' ) ); 77 | } 78 | 79 | // add the testing gateway 80 | add_filter( 'woocommerce_payment_gateways', array( $this, 'add_bogus_gateway' ) ); 81 | 82 | // filter default Elavon test card 83 | add_filter( 'woocommerce_elavon_credit_card_default_values', array( $this, 'change_elavon_test_values' ), 10, 2 ); 84 | 85 | // use forwarded URLs: this needs to be done as early as possible in order to set the $_SERVER['HTTPS'] var 86 | require_once( $this->get_plugin_path() . '/includes/Forwarded_URLs.php' ); 87 | $this->use_forwarded_urls = new Forwarded_URLs(); 88 | } 89 | 90 | 91 | /** 92 | * Removes the "Please install Woo Updater" notice when an official WC extension 93 | * is active but the Woo Updater plugin is not. 94 | * 95 | * Also removes the WC 3.3+ "Connect to WooCommerce.com" notice. 96 | * 97 | * @since 0.1.0 98 | */ 99 | public function muzzle_woo_updater() { 100 | remove_action( 'admin_notices', 'woothemes_updater_notice' ); 101 | add_filter( 'woocommerce_helper_suppress_admin_notices', '__return_true' ); 102 | } 103 | 104 | 105 | /** 106 | * Removes the strong password meter / requirement from WC 2.5+ 107 | * because these are dev shop passwords, not vodka drinks -- we like them weak 108 | * 109 | * @since 0.3.0 110 | */ 111 | public function remove_wc_password_meter() { 112 | wp_dequeue_script( 'wc-password-strength-meter' ); 113 | } 114 | 115 | 116 | /** 117 | * Add inline JavaScript. 118 | * 119 | * @since 0.5.0 120 | */ 121 | public function enqueue_scripts() { 122 | 123 | ?> 124 | 131 | is_test_environment() ) { 162 | 163 | $defaults['expiry'] = '12/' . ( date("y") + 1 ); 164 | $defaults['account-number'] = '4124939999999990'; 165 | } 166 | 167 | return $defaults; 168 | } 169 | 170 | 171 | /** 172 | * Include required files 173 | * 174 | * @since 0.1.0 175 | */ 176 | public function includes() { 177 | 178 | require_once( $this->get_plugin_path() . '/includes/Ajax.php' ); 179 | if ( $this->is_plugin_active( 'woocommerce.php' ) && wp_doing_ajax() ) { 180 | $this->ajax = new Ajax(); 181 | } 182 | 183 | if ( $this->is_plugin_active( 'woocommerce.php' ) ) { 184 | require_once( $this->get_plugin_path() . '/includes/Bogus_Gateway.php' ); 185 | $this->gateway = new Bogus_Gateway(); 186 | } 187 | 188 | if ( $this->is_plugin_active( 'woocommerce-subscriptions.php' ) ) { 189 | 190 | // Subscriptions helper 191 | require_once( $this->get_plugin_path() . '/includes/Integrations/Subscriptions.php' ); 192 | $this->subscriptions = new Integrations\Subscriptions(); 193 | } 194 | 195 | if ( $this->is_plugin_active( 'woocommerce-memberships.php' ) ) { 196 | 197 | // Memberships helper 198 | require_once( $this->get_plugin_path() . '/includes/Integrations/Memberships.php' ); 199 | $this->memberships = new Integrations\Memberships(); 200 | } 201 | } 202 | 203 | 204 | /** 205 | * A simple way to log the actions/filers fired, simply add this query string: 206 | * 207 | * ?wcdh_hooks=actions|filters|all 208 | * 209 | * And the desired hook names will be saved to the error log along with a fired count 210 | * 211 | * If you want more advanced hook logging, use https://wordpress.org/plugins/debug-bar-actions-and-filters-addon/ 212 | * 213 | * @since 0.1.0 214 | */ 215 | public function maybe_log_hooks() { 216 | 217 | $hooks = array(); 218 | 219 | if ( empty( $_GET['wcdh_hooks'] ) ) { 220 | return; 221 | } 222 | 223 | switch( $_GET['wcdh_hooks'] ) { 224 | 225 | case 'actions': 226 | $hooks = $GLOBALS['wp_actions']; 227 | break; 228 | 229 | case 'filters': 230 | $hooks = $GLOBALS['wp_filter']; 231 | break; 232 | 233 | case 'all': 234 | $hooks = array_merge( $GLOBALS['wp_actions'], $GLOBALS['wp_filter'] ); 235 | break; 236 | } 237 | 238 | foreach ( $hooks as $hook => $count ) { 239 | error_log( sprintf( '%s (%d)' . PHP_EOL, $hook, $count ) ); 240 | } 241 | } 242 | 243 | 244 | /** 245 | * Return the plugin path 246 | * 247 | * @since 0.1.0 248 | * 249 | * @return string 250 | */ 251 | public function get_plugin_path() { 252 | 253 | return untrailingslashit( plugin_dir_path( __FILE__ ) ); 254 | } 255 | 256 | 257 | /** 258 | * Helper function to determine whether a plugin is active 259 | * 260 | * @since 0.4.0 261 | * 262 | * @param string $plugin_name plugin name, as the plugin-filename.php 263 | * @return bool 264 | */ 265 | public function is_plugin_active( $plugin_name ) { 266 | 267 | $active_plugins = (array) get_option( 'active_plugins', array() ); 268 | 269 | if ( is_multisite() ) { 270 | $active_plugins = array_merge( $active_plugins, get_site_option( 'active_sitewide_plugins', array() ) ); 271 | } 272 | 273 | $plugin_filenames = array(); 274 | 275 | foreach ( $active_plugins as $plugin ) { 276 | 277 | if ( strpos( $plugin, '/' ) ) { 278 | // normal plugin name (plugin-dir/plugin-filename.php) 279 | list( , $filename ) = explode( '/', $plugin ); 280 | } else { 281 | // no directory, just plugin file 282 | $filename = $plugin; 283 | } 284 | 285 | $plugin_filenames[] = $filename; 286 | } 287 | 288 | return in_array( $plugin_name, $plugin_filenames, true ); 289 | } 290 | 291 | 292 | /** 293 | * Adjust Bogus Gateway styles 294 | * 295 | * @since 0.6.0 296 | */ 297 | public function bogus_gateway_styles() { 298 | 299 | if ( is_checkout() || is_checkout_pay_page() ) { 300 | echo ''; 305 | } 306 | } 307 | 308 | 309 | /** Instance Getters ******************************************************/ 310 | 311 | 312 | /** 313 | * Return the Forwarded_URLs class instance 314 | * 315 | * @since 0.1.0 316 | * @return Forwarded_URLs 317 | */ 318 | public function use_forwarded_urls() { 319 | return $this->use_forwarded_urls; 320 | } 321 | 322 | 323 | /** 324 | * Return the Subscriptions class instance 325 | * 326 | * @since 0.1.0 327 | * @return Integrations\Subscriptions 328 | */ 329 | public function subscriptions() { 330 | return $this->subscriptions; 331 | } 332 | 333 | 334 | /** 335 | * Return the Memberships class instance 336 | * 337 | * @since 0.4.0 338 | * @return Integrations\Memberships 339 | */ 340 | public function memberships() { 341 | return $this->memberships; 342 | } 343 | 344 | 345 | /** 346 | * Return the gateway class instance 347 | * 348 | * @since 0.6.0 349 | * @return Bogus_Gateway 350 | */ 351 | public function gateway() { 352 | return $this->gateway(); 353 | } 354 | 355 | 356 | /** Housekeeping **********************************************************/ 357 | 358 | 359 | /** 360 | * Main WC Dev Helper Instance, ensures only one instance is/can be loaded 361 | * 362 | * @since 0.1.0 363 | * 364 | * @see wc_dev_helper() 365 | * @return Plugin 366 | */ 367 | public static function instance() { 368 | 369 | if ( is_null( self::$instance ) ) { 370 | self::$instance = new self(); 371 | } 372 | 373 | return self::$instance; 374 | } 375 | 376 | 377 | /** 378 | * Cloning instances is forbidden due to singleton pattern. 379 | * 380 | * @since 0.1.0 381 | */ 382 | public function __clone() { 383 | _doing_it_wrong( __FUNCTION__, __( 'You cannot clone instances of WooCommerce Dev Helper.', 'woocommerce-dev-helper' ), '0.1.0' ); 384 | } 385 | 386 | 387 | /** 388 | * Unserializing instances is forbidden due to singleton pattern. 389 | * 390 | * @since 0.1.0 391 | */ 392 | public function __wakeup() { 393 | _doing_it_wrong( __FUNCTION__, __( 'You cannot unserialize instances of WooCommerce Dev Helper.', 'woocommerce-dev-helper' ), '0.1.0' ); 394 | } 395 | 396 | 397 | } 398 | 399 | 400 | /** 401 | * Returns the One True Instance of WC Dev Helper 402 | * 403 | * @since 0.1.0 404 | * @return Plugin instance 405 | */ 406 | function wc_dev_helper() { 407 | return Plugin::instance(); 408 | } 409 | 410 | // fire it up! 411 | wc_dev_helper(); 412 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------