├── .DS_Store
├── .gitignore
├── scripts
    ├── src
    │   ├── store
    │   │   ├── resolvers.js
    │   │   ├── controls.js
    │   │   ├── index.js
    │   │   ├── selectors.js
    │   │   ├── actions.js
    │   │   └── reducer.js
    │   ├── index.js
    │   ├── TestResults.js
    │   ├── App.js
    │   ├── ModuleOption.js
    │   └── ModuleCard.js
    └── package.json
├── styles
    └── settings.css
├── composer.json
├── src
    ├── Checkpoint.php
    ├── Runner.php
    ├── Utils.php
    ├── modules
    │   ├── Get_Posts.php
    │   ├── Abstract_Module.php
    │   └── Actions.php
    ├── Settings.php
    ├── Results.php
    └── Main.php
├── composer.lock
├── wp-benchy.php
├── README.md
└── LICENSE


/.DS_Store:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/pressable/wp-benchy/HEAD/.DS_Store


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | 
3 | /vendor/
4 | /scripts/build/
5 | /scripts/node_modules/
6 | 


--------------------------------------------------------------------------------
/scripts/src/store/resolvers.js:
--------------------------------------------------------------------------------
1 | import * as actions from './actions';
2 | 
3 | export function *getModules() {
4 |     const modules = yield actions.fetchModules();
5 |     return actions.setModules(modules);
6 | }


--------------------------------------------------------------------------------
/scripts/src/index.js:
--------------------------------------------------------------------------------
1 | const {render} = wp.element;
2 | import App from './App';
3 | 
4 | if (document.getElementById('wp-benchy-settings')) {
5 |     render(<App/>, document.getElementById('wp-benchy-settings'));
6 | }


--------------------------------------------------------------------------------
/styles/settings.css:
--------------------------------------------------------------------------------
 1 | h3.components-heading {
 2 |     margin-bottom: 0.5em;
 3 | }
 4 | 
 5 | .benchy-module-options {
 6 |     padding-bottom: 1em;
 7 |     padding-top: 1em;
 8 | }
 9 | 
10 | .run-test-button {
11 |     margin-left: auto;
12 | }


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "pressable/wp-benchy",
 3 |     "type": "wordpress-plugin",
 4 |     "autoload": {
 5 |         "psr-4": {
 6 |             "Pressable\\WP_Benchy\\": "src/"
 7 |         }
 8 |     },
 9 |     "require": {}
10 | }
11 | 


--------------------------------------------------------------------------------
/scripts/src/store/controls.js:
--------------------------------------------------------------------------------
 1 | import apiFetch from "@wordpress/api-fetch";
 2 | 
 3 | export function FETCH_MODULES(action) {
 4 |   return apiFetch({
 5 |     path: '/wp-benchy/v1/modules'
 6 |   });
 7 | }
 8 | 
 9 | export function RUN_MODULE(action) {
10 |   return apiFetch({
11 |     path: `/wp-benchy/v1/module/${action.moduleId}`
12 |   });
13 | }


--------------------------------------------------------------------------------
/scripts/src/store/index.js:
--------------------------------------------------------------------------------
 1 | import { createReduxStore, register } from '@wordpress/data';
 2 | 
 3 | import * as actions from './actions';
 4 | import * as selectors from './selectors';
 5 | import reducer from './reducer';
 6 | import * as resolvers from './resolvers';
 7 | import * as controls from './controls';
 8 | 
 9 | const store = createReduxStore('benchy', {
10 |     reducer,
11 |     actions,
12 |     selectors,
13 |     resolvers,
14 |     controls
15 | });
16 | 
17 | register(store);
18 | 
19 | export { store };


--------------------------------------------------------------------------------
/src/Checkpoint.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Pressable\WP_Benchy;
 4 | 
 5 | class Checkpoint {
 6 | 
 7 |     protected $id = null;
 8 | 
 9 |     protected $hits = array();
10 | 
11 |     public function set_id( $id ) {
12 |         $this->id = $id;
13 |     }
14 | 
15 |     public function get_id() {
16 |         return $this->id;
17 |     }
18 | 
19 |     public function hit() {
20 |         $this->hits[] = hrtime(true);
21 |     }
22 | 
23 |     public function get_hits() {
24 |         return $this->hits;
25 |     }
26 | 
27 | }


--------------------------------------------------------------------------------
/scripts/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "wp-benchy-settings",
 3 |   "version": "1.0.0",
 4 |   "description": "",
 5 |   "main": "index.js",
 6 |   "scripts": {
 7 |     "build": "wp-scripts build",
 8 |     "start": "wp-scripts start"
 9 |   },
10 |   "keywords": [],
11 |   "author": "",
12 |   "license": "ISC",
13 |   "devDependencies": {
14 |     "@wordpress/scripts": "^26.12.0"
15 |   },
16 |   "dependencies": {
17 |     "@wordpress/api-fetch": "^6.39.0",
18 |     "@wordpress/components": "^25.7.0",
19 |     "@wordpress/data": "^9.12.0"
20 |   }
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Runner.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Pressable\WP_Benchy;
 4 | 
 5 | class Runner {
 6 | 
 7 |     public $checkpoints = array();
 8 | 
 9 |     public $module;
10 | 
11 |     public function __construct( $module ) {
12 |         $this->module = $module;
13 |     }
14 | 
15 |     public function run() {
16 |         $this->module->set_runner($this);
17 |         $this->module->register_checkpoints();
18 |         $this->module->run();
19 |     }
20 | 
21 |     public function get_results() {
22 |         return $this->module->get_results();
23 |     }
24 | 
25 | }


--------------------------------------------------------------------------------
/src/Utils.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Pressable\WP_Benchy;
 4 | 
 5 | class Utils {
 6 | 
 7 |     public static function convert_nanoseconds( $val, $to, $precision = 5 ) {
 8 |         switch ($to) {
 9 |             case 's':
10 |                 $converted = $val / 1000000000;
11 |                 break;
12 |             case 'ms':
13 |                 $converted = $val / 1000000;
14 |                 break;
15 |             default:
16 |                 return null;
17 |         }
18 |         
19 |         $converted = round( $converted, $precision );
20 | 
21 |         return $converted;
22 |     }
23 | }


--------------------------------------------------------------------------------
/composer.lock:
--------------------------------------------------------------------------------
 1 | {
 2 |     "_readme": [
 3 |         "This file locks the dependencies of your project to a known state",
 4 |         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
 5 |         "This file is @generated automatically"
 6 |     ],
 7 |     "content-hash": "969393cc262fd368692dc9ae7665c4db",
 8 |     "packages": [],
 9 |     "packages-dev": [],
10 |     "aliases": [],
11 |     "minimum-stability": "stable",
12 |     "stability-flags": [],
13 |     "prefer-stable": false,
14 |     "prefer-lowest": false,
15 |     "platform": [],
16 |     "platform-dev": [],
17 |     "plugin-api-version": "2.2.0"
18 | }
19 | 


--------------------------------------------------------------------------------
/src/modules/Get_Posts.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Pressable\WP_Benchy\Modules;
 4 | 
 5 | class Get_Posts extends Abstract_Module {
 6 | 
 7 |     protected $id = 'get_posts';
 8 | 
 9 |     protected $title = 'Get Posts';
10 | 
11 |     protected $description = 'Tests a basic get_posts call';
12 | 
13 |     protected $options = array(
14 |         'iterations' => array(
15 |             'type'  => 'int',
16 |             'min'   => 1,
17 |             'max'   => 25,
18 |             'value' => 1
19 |         )
20 |     );
21 | 
22 |     protected $checkpoint_ids = array(
23 |         'get_posts_start',
24 |         'get_posts_end',
25 |     );
26 |     
27 |     public function run() {
28 |         $this->checkpoint_hit('get_posts_start');
29 | 
30 |         $posts = get_posts();
31 | 
32 |         $this->checkpoint_hit('get_posts_end');
33 |     }
34 | 
35 | }


--------------------------------------------------------------------------------
/scripts/src/TestResults.js:
--------------------------------------------------------------------------------
 1 | import { __experimentalHeading as Heading } from '@wordpress/components';
 2 | 
 3 | const TestResults = ({results}) => {
 4 | 
 5 |     if ( ! results.length > 0 ) {
 6 |         return null;
 7 |     }
 8 | 
 9 |     return (
10 |         <div className="test-results">
11 |             <Heading level={3}>Results</Heading>
12 |             <ul>
13 |                 {results.map((result, i) => {
14 |                     return (
15 |                         <li key={i}>
16 |                             Iteration {i}: {result.total}ms
17 |                         </li>
18 |                     );
19 |                 })}
20 |             </ul>
21 |             {results.length > 0 &&
22 |                 <p>Average: {results.reduce((a, b) => a + b.total, 0) / results.length}ms</p>
23 |             }
24 |             
25 |         </div>
26 |     );
27 | }
28 | 
29 | export default TestResults;


--------------------------------------------------------------------------------
/scripts/src/App.js:
--------------------------------------------------------------------------------
 1 | import {
 2 |     __experimentalGrid as Grid,
 3 |     __experimentalHeading as Heading,
 4 | } from '@wordpress/components';
 5 | 
 6 | import { useSelect } from '@wordpress/data';
 7 | import { store as benchyStore } from './store';
 8 | import ModuleCard from './ModuleCard.js';
 9 | 
10 | const App = () => {
11 | 
12 |     const { modules } = useSelect(select => ({
13 |         modules: select( benchyStore ).getModules(),
14 |     }));
15 | 
16 |     return (
17 |         <div>
18 |           <Heading level={1}>Pressable Benchy Test Suite</Heading>
19 | 
20 |           <Grid columns={2}>
21 | 
22 |             {Object.keys(modules).map((moduleId, i) => {
23 |                 return (
24 |                     <ModuleCard moduleId={moduleId} />
25 |                 );
26 |             })}
27 | 
28 |           </Grid>
29 |         </div>
30 |   
31 |     );
32 |   
33 |   };
34 | 
35 | export default App;


--------------------------------------------------------------------------------
/wp-benchy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * WP Benchy
 4 |  * 
 5 |  * @package Pressable\WP_Benchy
 6 |  * @author Pressable
 7 |  * @license GPL-3.0
 8 |  * @copyright 2023 Pressable
 9 |  * 
10 |  * @wordpress-plugin
11 |  * Plugin Name: WP Benchy
12 |  * Plugin URI: https://github.com/pressable/wp-benchy
13 |  * Description: An easy to extend, easy to use benchmarking plugin for WordPress.
14 |  * Version: 0.1.0
15 |  * Author: Pressable, JeffMatson
16 |  * Author URI: https://pressable.com
17 |  * License: GPL3
18 |  * License URI: https://www.gnu.org/licenses/gpl-3.0.html
19 |  * Text Domain: wp-benchy
20 |  * Domain Path: /languages
21 |  * Requires at least: 5.2
22 |  * Requires PHP: 7.4
23 |  */
24 | 
25 | require __DIR__ . '/vendor/autoload.php';
26 | 
27 | define('WP_BENCHY_DIR_URL', plugin_dir_url( __FILE__ ) );
28 | define('WP_BENCHY_DIR_PATH', plugin_dir_path( __FILE__ ) );
29 | 
30 | $main = new \Pressable\WP_Benchy\Main();
31 | $main->init();


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # WP Benchy
 2 | 
 3 | A plugin to assist with running benchmark tests. For more information about the approaches used here, see our article about [how to benchmark WordPress sites](https://pressable.com/benchmarking-wordpress).
 4 | 
 5 | *(Yes, sending you to this post isn't the best experience, but it's good enough for now. PRs open if you want to make this readme better.)*
 6 | 
 7 | ## Installing
 8 | 
 9 | **Don't try to just install this as-is from the repo - you'll be missing dependencies.**
10 | 
11 | For an installable plugin zip, download the latest release.
12 | 
13 | ## Building
14 | 
15 | You're going to need Composer and NPM.
16 | 
17 | 1. `cd wp-benchy`
18 | 2. `composer install`
19 | 3. `cd scripts`
20 | 4. `npm start` from dev. `npm run build` for prod.
21 | 
22 | ## Contributing
23 | 
24 | Contributions are wide open. Go wild.
25 | 
26 | A few things this could use:
27 | 
28 | - Write better docs
29 | - A UI that doesn't suck.
30 | - More tests
31 | 


--------------------------------------------------------------------------------
/scripts/src/ModuleOption.js:
--------------------------------------------------------------------------------
 1 | import { useSelect, useDispatch } from '@wordpress/data';
 2 | import { store as benchyStore } from './store';
 3 | import { RangeControl } from '@wordpress/components';
 4 | 
 5 | const ModuleOption = ({ moduleId, optionId }) => {
 6 | 
 7 |     const { moduleConfig } = useSelect(select => ({
 8 |         moduleConfig: select( benchyStore ).getModuleConfig(moduleId, optionId),
 9 |     }));
10 | 
11 |     const { setModuleConfig } = useDispatch( benchyStore );
12 | 
13 |     const onChange = (value) => {
14 |         setModuleConfig(moduleId, optionId, value);
15 |     };
16 | 
17 |     return (
18 |         <div className='benchy-module-option'>
19 |             {optionId === 'iterations' && (
20 |                 <RangeControl
21 |                     label='Iterations'
22 |                     onChange={onChange}
23 |                     min={moduleConfig.min}
24 |                     max={moduleConfig.max}
25 |                     resetFallbackValue={1}
26 |                     initialPosition={1}
27 |                 />
28 |             )}
29 | 
30 |         </div>
31 |     );
32 | };
33 | 
34 | export default ModuleOption;


--------------------------------------------------------------------------------
/scripts/src/store/selectors.js:
--------------------------------------------------------------------------------
 1 | export function getModules(state) {
 2 |     return state.modules;
 3 | }
 4 | 
 5 | export function getModule(state, moduleId) {
 6 |     return state.modules[moduleId];
 7 | }
 8 | 
 9 | export function getModuleConfig(state, moduleId, optionId) {
10 |     return state.modules[moduleId].options[optionId];
11 | }
12 | 
13 | export function getModuleConfigValue(state, moduleId, optionId) {
14 |     return state.modules[moduleId].options[optionId].value;
15 | }
16 | 
17 | export function getTestInProgress(state) {
18 |     return state.testInProgress;
19 | }
20 | 
21 | export function getTestResults(state) {
22 |     return state.testResults;
23 | }
24 | 
25 | export function getModuleTestResults(state, moduleId) {
26 |     if ( Array.isArray( state.testResults[moduleId] ) ) {
27 |         return state.testResults[moduleId];
28 |     }
29 | 
30 |     return [];
31 | }
32 | 
33 | export function getAverageResult(state, moduleId) {
34 |     console.log(state.testResults);
35 |     if (state.testResults[moduleId] && state.testResults[moduleId].length > 0) {
36 |         let total = 0;
37 |         state.testResults[moduleId].forEach((result) => {
38 |             total += result.total;
39 |         });
40 |         return total / state.testResults[moduleId].length;
41 |     }
42 |     return false;
43 | }


--------------------------------------------------------------------------------
/scripts/src/store/actions.js:
--------------------------------------------------------------------------------
 1 | export function setModules(modules) {
 2 |     return {
 3 |         type: 'SET_MODULES',
 4 |         modules,
 5 |     };
 6 | }
 7 | 
 8 | export function setModuleConfig(moduleId, optionId, optionValue) {
 9 |     return {
10 |         type: 'SET_MODULE_CONFIG',
11 |         moduleId,
12 |         optionId,
13 |         optionValue,
14 |     };
15 | }
16 | 
17 | export function setTestInProgress(testInProgress) {
18 |     return {
19 |         type: 'SET_TEST_IN_PROGRESS',
20 |         testInProgress,
21 |     };
22 | }
23 | 
24 | export function setTestResults(testResults) {
25 |     return {
26 |         type: 'SET_TEST_RESULTS',
27 |         testResults,
28 |     };
29 | }
30 | 
31 | export function addTestResult(moduleId, testResult) {
32 |     return {
33 |         type: 'ADD_TEST_RESULT',
34 |         moduleId,
35 |         testResult,
36 |     };
37 | }
38 | 
39 | export function setModuleTestResults(moduleId, testResults) {
40 |     return {
41 |         type: 'SET_MODULE_TEST_RESULTS',
42 |         moduleId,
43 |         testResults,
44 |     };
45 | }
46 | 
47 | export function fetchModules() {
48 |     return {
49 |         type: 'FETCH_MODULES',
50 |     };
51 | }
52 | 
53 | export function runModule(moduleId) {
54 |     return {
55 |         type: 'RUN_MODULE',
56 |         moduleId,
57 |     };
58 | }


--------------------------------------------------------------------------------
/src/Settings.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Pressable\WP_Benchy;
 4 | 
 5 | class Settings {
 6 | 
 7 |     public static function register_admin_menu() {
 8 |         add_submenu_page(
 9 |             'tools.php',
10 |             esc_html__( 'WP Benchy', 'wp-benchy' ),
11 |             esc_html__( 'WP Benchy', 'wp-benchy' ),
12 |             'manage_options',
13 |             'wp-benchy',
14 |             array( '\Pressable\WP_Benchy\Settings', 'render_admin_settings' )
15 |         );
16 |     }
17 | 
18 |     public static function enqueue_admin_scripts() {
19 |         $current_screen = get_current_screen()->id;
20 | 
21 |         if ( $current_screen === 'tools_page_wp-benchy' ) {
22 |             $asset_props = require_once( WP_BENCHY_DIR_PATH . '/scripts/build/index.asset.php' );
23 | 
24 |             wp_enqueue_script(
25 |                 'wp-benchy-settings',
26 |                 WP_BENCHY_DIR_URL . 'scripts/build/index.js',
27 |                 $asset_props['dependencies'],
28 |                 $asset_props['version'],
29 |                 true
30 |             );
31 | 
32 |             wp_enqueue_style('wp-benchy-settings', WP_BENCHY_DIR_URL . 'styles/settings.css', array('wp-components'), '1.0.0', 'all');
33 | 	    }
34 |     }
35 | 
36 |     public static function render_admin_settings() {
37 |         if ( ! current_user_can( 'manage_options' ) ) {
38 |             wp_die( esc_html__( 'You do not have sufficient capabilities to access this page.', 'wp-benchy' ) );
39 |         }
40 |          
41 |         ?>
42 | 
43 |         <div class="wrap">
44 |             <div id="wp-benchy-settings"></div>
45 |         </div>
46 |         
47 |         <?php
48 |     }
49 | 
50 | }


--------------------------------------------------------------------------------
/src/Results.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Pressable\WP_Benchy;
 4 | 
 5 | class Results {
 6 | 
 7 |     protected $checkpoints;
 8 | 
 9 |     protected $checkpoint_hits = array();
10 | 
11 |     public function __construct( $checkpoints ) {
12 |         $this->checkpoints = $checkpoints;
13 |     }
14 | 
15 |     public function get_checkpoints() {
16 |         return $this->checkpoints;
17 |     }
18 | 
19 |     public function flatten_checkpoint_hits() {
20 |         $flattened = array();
21 | 
22 |         foreach ( $this->checkpoints as $checkpoint_id => $checkpoint ) {
23 |             foreach ( $checkpoint->get_hits() as $hit_key => $hit ) {
24 |                 $flattened[ $checkpoint_id . '_' . $hit_key ] = $hit;
25 |             }
26 |         }
27 | 
28 |         return $flattened;
29 |     }
30 | 
31 |     public function get_checkpoint_hits() {
32 |         if ( empty( $this->checkpoint_hits ) ) {
33 |             $hits_flattened = $this->flatten_checkpoint_hits();
34 | 
35 |             asort( $hits_flattened );
36 | 
37 |             $this->checkpoint_hits = $hits_flattened;
38 |         }
39 | 
40 |         return $this->checkpoint_hits;
41 |     }
42 | 
43 |     public function get_first_hit_time() {
44 |         $hits = $this->get_checkpoint_hits();
45 | 
46 |         return $hits[ array_key_first( $hits ) ];
47 |     }
48 | 
49 |     public function get_last_hit_time() {
50 |         $hits = $this->get_checkpoint_hits();
51 | 
52 |         return $hits[ array_key_last( $hits ) ];
53 |     }
54 | 
55 |     public function get_total_time() {
56 |         $first = $this->get_first_hit_time();
57 |         $last = $this->get_last_hit_time();
58 | 
59 |         return $last - $first;
60 |     }
61 | 
62 | }


--------------------------------------------------------------------------------
/scripts/src/store/reducer.js:
--------------------------------------------------------------------------------
 1 | const DEFAULT_STATE = {
 2 |     modules: {},
 3 |     testInProgress: false,
 4 |     testResults: {},
 5 | };
 6 | 
 7 | export default function reducer(state = DEFAULT_STATE, action) {
 8 |     switch (action.type) {
 9 |         case 'SET_MODULES':
10 |             return {
11 |                 ...state,
12 |                 modules: action.modules,
13 |             };
14 |         case 'SET_MODULE_CONFIG':
15 |             state.modules[action.moduleId].options[action.optionId].value = action.optionValue;
16 |             return {
17 |                 ...state,
18 |                 modules: state.modules,
19 |             };
20 |         case 'SET_TEST_IN_PROGRESS':
21 |             return {
22 |                 ...state,
23 |                 testInProgress: action.testInProgress,
24 |             };
25 |         case 'SET_TEST_RESULTS':
26 |             return {
27 |                 ...state,
28 |                 testResults: action.testResults,
29 |             };
30 |         case 'ADD_TEST_RESULT':
31 |             const newState = state;
32 | 
33 |             if ( newState.testResults[action.moduleId] === undefined ) {
34 |                 newState.testResults[action.moduleId] = [];
35 |             }
36 | 
37 |             newState.testResults[action.moduleId].push(action.testResult);
38 |             return {
39 |                 ...state,
40 |                 testResults: newState.testResults,
41 |             };
42 |         case 'SET_MODULE_TEST_RESULTS':
43 |             return {
44 |                 ...state,
45 |                 testResults: {
46 |                     ...state.testResults,
47 |                     [action.moduleId]: action.testResults,
48 |                 },
49 |             };
50 |         default:
51 |             return state;
52 |     }
53 | }


--------------------------------------------------------------------------------
/src/modules/Abstract_Module.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Pressable\WP_Benchy\Modules;
 4 | use Pressable\WP_Benchy\Checkpoint;
 5 | use Pressable\WP_Benchy\Results;
 6 | 
 7 | abstract class Abstract_Module {
 8 | 
 9 |     protected $runner;
10 | 
11 |     protected $checkpoint_ids = array();
12 | 
13 |     protected $checkpoints = array();
14 | 
15 |     protected $results;
16 | 
17 |     protected $id;
18 | 
19 |     protected $title = '';
20 | 
21 |     protected $description = '';
22 | 
23 |     protected $options = array();
24 | 
25 |     public function get_id() {
26 |         return $this->id;
27 |     }
28 | 
29 |     public function get_title() {
30 |         return $this->title;
31 |     }
32 | 
33 |     public function get_description() {
34 |         return $this->description;
35 |     }
36 | 
37 |     public function get_options() {
38 |         return $this->options;
39 |     }
40 | 
41 |     public function set_runner( $runner ) {
42 |         $this->runner = $runner;
43 |     }
44 | 
45 |     public function get_checkpoints() {
46 |         return $this->checkpoints;
47 |     }
48 | 
49 |     public function register_checkpoint( $id ) {
50 |         if ( ! array_key_exists($id, $this->checkpoints) ) {
51 |             $this->checkpoints[ $id ] = new Checkpoint();
52 |         }
53 |     }
54 | 
55 |     public function register_checkpoints() {
56 |         foreach ( $this->checkpoint_ids as $id ) {
57 |             $this->register_checkpoint( $id );
58 |         }
59 |     }
60 | 
61 |     public function checkpoint_hit( $id ) {
62 |         if ( array_key_exists( $id, $this->checkpoints) ) {
63 |             $this->checkpoints[ $id ]->hit();
64 |         } else {
65 |             $this->register_checkpoint( $id );
66 |             $this->checkpoints[ $id ]->hit();
67 |         }
68 |     }
69 | 
70 |     abstract public function run();
71 | 
72 |     public function get_results() {
73 |         if ( empty( $this->results ) ) {
74 |             $this->results = new Results( $this->checkpoints );
75 |         }
76 | 
77 |         return $this->results;
78 |     }
79 | 
80 | }


--------------------------------------------------------------------------------
/scripts/src/ModuleCard.js:
--------------------------------------------------------------------------------
 1 | import {
 2 |     Card,
 3 |     CardHeader,
 4 |     CardBody,
 5 |     CardFooter,
 6 |     __experimentalSpacer as Spacer,
 7 |     __experimentalHeading as Heading,
 8 |     Button,
 9 |     CardDivider,
10 | } from '@wordpress/components';
11 | 
12 | import apiFetch from '@wordpress/api-fetch';
13 | import { useSelect } from '@wordpress/data';
14 | import { store as benchyStore } from './store';
15 | import ModuleOption from './ModuleOption.js';
16 | import React, { useState } from 'react';
17 | import TestResults from './TestResults';
18 | 
19 | const ModuleCard = ({ moduleId }) => {
20 | 
21 |     const { module } = useSelect(select => ({
22 |         module: select( benchyStore ).getModule(moduleId),
23 |     }));
24 | 
25 |     const [results, setResults] = useState([]);
26 | 
27 |     const runTest = (moduleId) => {
28 |         const moduleOptions = module.options;
29 | 
30 |         let res = [];
31 |         (async function () {
32 |             for ( let i = 0; i < moduleOptions.iterations.value; i++ ) {
33 |                 res.push( await sendRequest(moduleId));
34 |             }
35 | 
36 |             setResults(res);
37 |         })();
38 |     }
39 | 
40 |     const sendRequest = async (moduleId) => {
41 |         const response = await apiFetch({ path: `/wp-benchy/v1/module/${moduleId}` });
42 |         return response;
43 |     }
44 | 
45 |     return (
46 |         <Card className='benchy-module-card'>
47 |             <CardHeader>
48 |                 <Heading level={2}>{module.title}</Heading>
49 |             </CardHeader>
50 | 
51 |             <CardBody>
52 |                 <p className='benchy-module-description'>
53 |                     {module.description}
54 |                 </p>
55 | 
56 |                 <CardDivider />
57 | 
58 |                 <div className='benchy-module-options'>
59 |                     <Heading level={3}>Options</Heading>
60 | 
61 |                     {Object.keys(module.options).map((optionId, i) => {
62 |                         return (
63 |                             <ModuleOption moduleId={module.id} optionId={optionId} />
64 |                         );
65 |                     })}
66 |                 </div>
67 |             <Spacer>
68 |                 <TestResults results={results} />
69 |             </Spacer>
70 |             </CardBody>
71 | 
72 |             <CardFooter>
73 |                 <Button className='run-test-button' text='Run Test' variant='primary' onClick={() => runTest(moduleId)} />
74 |             </CardFooter>
75 |         </Card>
76 |     );
77 | }
78 | 
79 | export default ModuleCard;


--------------------------------------------------------------------------------
/src/modules/Actions.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Pressable\WP_Benchy\Modules;
 4 | 
 5 | class Actions extends Abstract_Module {
 6 | 
 7 |     protected $id = 'actions';
 8 | 
 9 |     protected $title = 'Actions';
10 | 
11 |     protected $description = 'Tests the time it takes to run all actions';
12 | 
13 |     private $action_checkpoints = array(
14 |         'muplugins_loaded',
15 |         'registered_taxonomy',
16 |         'registered_taxonomy_category',
17 |         'registered_taxonomy_post_tag',
18 |         'registered_taxonomy_nav_menu',
19 |         'registered_taxonomy_link_category',
20 |         'registered_taxonomy_post_format',
21 |         'registered_taxonomy_wp_theme',
22 |         'registered_taxonomy_wp_template_part_area',
23 |         'registered_post_type',
24 |         'registered_post_type_post',
25 |         'registered_post_type_page',
26 |         'registered_post_type_attachment',
27 |         'registered_post_type_revision',
28 |         'registered_post_type_nav_menu_item',
29 |         'registered_post_type_custom_css',
30 |         'registered_post_type_customize_changeset',
31 |         'registered_post_type_oembed_cache',
32 |         'registered_post_type_user_request',
33 |         'registered_post_type_wp_block',
34 |         'registered_post_type_wp_template',
35 |         'registered_post_type_wp_template_part',
36 |         'registered_post_type_wp_global_styles',
37 |         'registered_post_type_wp_navigation',
38 |         'parse_tax_query',
39 |         'parse_query',
40 |         'pre_get_posts',
41 |         'posts_selection',
42 |         'wp_cache_set_last_changed',
43 |         'parse_term_query',
44 |         'pre_get_terms',
45 |         'metadata_lazyloader_queued_objects',
46 |         'plugin_loaded',
47 |         'plugins_loaded',
48 |         'sanitize_comment_cookies',
49 |         'wp_roles_init',
50 |         'setup_theme',
51 |         'unload_textdomain',
52 |         'load_textdomain',
53 |         'after_setup_theme',
54 |         'auth_cookie_malformed',
55 |         'set_current_user',
56 |         'init',
57 |         'widgets_init',
58 |         'wp_register_sidebar_widget',
59 |         'wp_default_styles',
60 |         'wp_sitemaps_init',
61 |         'wp_default_scripts',
62 |         'wp_loaded',
63 |         'parse_request',
64 |         'send_headers',
65 |         'wp',
66 |         'template_redirect',
67 |         'loop_no_results',
68 |         'render_block_core_template_part_file',
69 |         'loop_start',
70 |         'the_post',
71 |         'begin_fetch_post_thumbnail_html',
72 |         'end_fetch_post_thumbnail_html',
73 |         'loop_end',
74 |         'wp_head',
75 |         'wp_enqueue_scripts',
76 |         'enqueue_block_assets',
77 |         'wp_print_styles',
78 |         'wp_print_scripts',
79 |         'wp_body_open',
80 |         'wp_footer',
81 |     );
82 | 
83 |     public function run() {
84 |         foreach ( $this->action_checkpoints as $action ) {
85 |             add_action( $action, function() use ( $action ) {
86 |                 $this->checkpoint_hit( $action );
87 |             });
88 |         }
89 |     }
90 | }


--------------------------------------------------------------------------------
/src/Main.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace Pressable\WP_Benchy;
  3 | 
  4 | use WP_Error;
  5 | use WP_REST_Request;
  6 | use WP_REST_Response;
  7 | use WP_REST_Server;
  8 | 
  9 | class Main {
 10 | 
 11 |     public $runners = array();
 12 | 
 13 |     public $modules = array();
 14 | 
 15 |     public function init() {
 16 |         add_action('rest_api_init', array( $this, 'init_rest_endpoints' ));
 17 |         add_action('admin_menu', array( '\Pressable\WP_Benchy\Settings', 'register_admin_menu' ));
 18 |         add_action('admin_enqueue_scripts', array( '\Pressable\WP_Benchy\Settings', 'enqueue_admin_scripts' ));
 19 | 
 20 |         $this->register_modules();
 21 | 
 22 |         foreach ( $this->modules as $module_id => $module ) {
 23 |             $module_runner = new Runner( $module );
 24 | 
 25 |             $this->runners[ $module_id ] = $module_runner;
 26 |             $this->runners[ $module_id ]->run();
 27 |         }
 28 | 
 29 |         add_action('shutdown', array( $this, 'get_results' ));
 30 |     }
 31 |     
 32 | 
 33 |     public function register_modules() {
 34 |         $modules = array(
 35 |             'get_posts' => new Modules\Get_Posts()
 36 |         );
 37 | 
 38 |         $modules = apply_filters( 'pressable_benchy_register_modules', $modules );
 39 | 
 40 |         $this->modules = $modules;
 41 |     }
 42 | 
 43 |     public function is_module_registered( $module_id ) {
 44 |         return array_key_exists( $module_id, $this->modules );
 45 |     }
 46 | 
 47 |     public function init_rest_endpoints() {
 48 | 
 49 |         register_rest_route(
 50 |             'wp-benchy/v1', '/modules', array(
 51 |                 'methods' => WP_REST_Server::READABLE,
 52 |                 'callback' => array(
 53 |                     $this,
 54 |                     'handle_rest_modules'
 55 |                 )
 56 |             )
 57 |         );
 58 | 
 59 |         register_rest_route(
 60 |             'wp-benchy/v1', '/module/(?P<id>\w+)', array(
 61 |                 'methods' => WP_REST_Server::READABLE,
 62 |                 'callback' => array(
 63 |                     $this,
 64 |                     'handle_rest_module'
 65 |                 ),
 66 |             )
 67 |         );
 68 |     }
 69 | 
 70 |     public function handle_rest_modules( WP_REST_Request $request ) {
 71 |         $modules = array();
 72 | 
 73 |         foreach ( $this->modules as $module_id => $module ) {
 74 |             $modules[ $module_id ] = array(
 75 |                 'id'          => $module->get_id(),
 76 |                 'title'       => $module->get_title(),
 77 |                 'description' => $module->get_description(),
 78 |                 'options'     => $module->get_options(),
 79 |             );
 80 |         }
 81 | 
 82 |         return $modules;
 83 |     }
 84 | 
 85 |     public function handle_rest_module( WP_REST_Request $request ) {
 86 |         $module_id = $request->get_param('id');
 87 | 
 88 |         if ( ! $this->is_module_registered( $module_id ) ) {
 89 |             return new WP_Error( 'wp_benchy_module_not_registered', 'WP Benchy module not registered', array( 'status' => 404 ));
 90 |         }
 91 | 
 92 |         $results = $this->runners[ $module_id ]->get_results();
 93 |         $data = array(
 94 |             'checkpoints' => $results->get_checkpoint_hits(),
 95 |             'first'       => $results->get_first_hit_time(),
 96 |             'last'        => $results->get_last_hit_time(),
 97 |             'total'       => Utils::convert_nanoseconds( $results->get_total_time(), 'ms', 5 )
 98 |         );
 99 | 
100 |         $response = new WP_REST_Response( $data, 200 );
101 |         $response->set_status( 201 );
102 | 
103 |         return $response;
104 |     }
105 | }


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  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 <https://www.gnu.org/licenses/>.
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 |     <program>  Copyright (C) <year>  <name of author>
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 | <https://www.gnu.org/licenses/>.
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 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


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