-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue #60 - rename .inc files so that translatable strings can be found
- Loading branch information
1 parent
6c1040c
commit f25aa16
Showing
5 changed files
with
481 additions
and
337 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,337 +1,5 @@ | ||
| <?php | ||
| /* | ||
| Copyright 2012-2016 Bobbing Wide (email : [email protected] ) | ||
| This program is free software; you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License version 2, | ||
| as published by the Free Software Foundation. | ||
| You may NOT assume that you can use any other version of the GPL. | ||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
| The license for this software can likely be found here: | ||
| http://www.gnu.org/licenses/gpl-2.0.html | ||
| */ | ||
|
|
||
|
|
||
| /** | ||
| * Register bw_trace_options | ||
| * | ||
| * Init plugin options to white list our options | ||
| * | ||
| */ | ||
| function bw_trace_options_init(){ | ||
| register_setting( 'bw_trace_options_options', 'bw_trace_options', 'bw_trace_options_validate' ); | ||
|
|
||
| add_action( "activated_plugin", "bw_this_plugin_first", 10, 2 ); | ||
| <?php // (C) Copyright Bobbing Wide 2011-2017 | ||
| if ( function_exists( "_deprecated_file" ) ) { | ||
| _deprecated_file( __FILE__, "2.1.1", "admin/oik-bwtrace.php", 'Please use oik_require( "admin/oik-bwtrace.php", "oik-bwtrace");' ); | ||
| } | ||
|
|
||
| /** | ||
| * Register bw_action_options | ||
| * | ||
| */ | ||
| function bw_action_options_init(){ | ||
| register_setting( 'bw_action_options_options', 'bw_action_options', 'bw_action_options_validate' ); | ||
| } | ||
|
|
||
| /** | ||
| * Register the trace options page | ||
| * | ||
| * Only available if the "oik-admin" library is available. | ||
| * | ||
| */ | ||
| function bw_trace_options_add_page() { | ||
| if ( oik_require_lib( "oik-admin" ) ) { | ||
| add_options_page( __('oik trace options', 'oik-bwtrace' ), __( 'oik trace options', 'oik-bwtrace' ), 'manage_options', 'bw_trace_options', 'bw_trace_options_do_page'); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Register the action options page | ||
| * | ||
| */ | ||
| function bw_action_options_add_page() { | ||
| add_options_page( __('oik action options', 'oik-bwtrace') , __( 'oik action options', 'oik-bwtrace' ), 'manage_options', 'bw_action_options', 'bw_action_options_do_page'); | ||
| } | ||
|
|
||
| /** | ||
| * Settings page for oik actions logging | ||
| * | ||
| * | ||
| * Also includes the Information block | ||
| * | ||
| */ | ||
| function bw_action_options_do_page() { | ||
| oik_menu_header( "action options", "w70pc" ); | ||
| oik_box( null, null, "Options", "oik_action_options" ); | ||
| oik_box( null, null, "Information", "oik_trace_info" ); | ||
| oik_menu_footer(); | ||
| bw_flush(); | ||
| } | ||
|
|
||
| /** | ||
| * Display the action options form | ||
| * | ||
| * 2015/05/23 Disabled 'immediate' tracing | ||
| * Relabelled 'Count immediate actions' to 'Count action hooks and filters' | ||
| * | ||
| */ | ||
| function oik_action_options() { | ||
| bw_form( "options.php" ); | ||
| $options = get_option('bw_action_options'); | ||
| stag( 'table class="form-table"' ); | ||
| bw_flush(); | ||
| settings_fields('bw_action_options_options'); | ||
|
|
||
| //bw_textfield_arr( "bw_action_options", "Action file", $options, 'file', 60 ); | ||
| //bw_checkbox_arr( "bw_action_options", "Trace actions", $options, 'actions' ); | ||
| //bw_checkbox_arr( "bw_action_options", "Trace immediate actions", $options, 'immediate' ); | ||
| bw_checkbox_arr( "bw_action_options", "Count action hooks and filters", $options, 'count' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace deprecated messages", $options, 'trace_deprecated' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace Error, Warning and Notice messages", $options, 'trace_errors' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace 'wp' action", $options, 'trace_wp_action' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace 'wp' global wp_rewrite ", $options, 'trace_wp_rewrite' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace 'shutdown' included files", $options, 'trace_included_files' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace 'shutdown' saved queries", $options, 'trace_saved_queries' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace 'shutdown' output buffer", $options, 'trace_output_buffer' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace 'shutdown' trace functions count", $options, 'trace_functions' ); | ||
| bw_checkbox_arr( "bw_action_options", "Trace 'shutdown' status report and log in summary file", $options, 'trace_status_report' ); | ||
|
|
||
| bw_textarea_arr( "bw_action_options", "Other hooks to trace", $options, "hooks", 80 ); | ||
| bw_textarea_arr( "bw_action_options", "Filter results to trace", $options, "results", 80 ); | ||
| bw_textarea_arr( "bw_action_options", "Trace the global post object", $options, "post_hooks", 80 ); | ||
| bw_textarea_arr( "bw_action_options", "Trace attached hook functions", $options, "hook_funcs", 80 ); | ||
| bw_textarea_arr( "bw_action_options", "Hooks to debug backtrace", $options, "backtrace", 80 ); | ||
| bw_textarea_arr( "bw_action_options", "'String watch' for this string", $options, "stringwatch", 80 ); | ||
|
|
||
| //bw_tablerow( array( "", "<input type=\"submit\" name=\"ok\" value=\"Save changes\" class=\"button-primary\"/>") ); | ||
| etag( "table" ); | ||
| p( isubmit( "ok", "Save changes", null, "button-primary" ) ); | ||
| etag( "form" ); | ||
| } | ||
|
|
||
| function oik_action_notes() { | ||
| p( "The actions output produced by " .bw_oik(). " actions can be used to find the sequence that actions are performed." ); | ||
| p( "It needs to be used in conjunction with the trace facility."); | ||
| //p( "The oik actions should <b>not</b> need to be activated on a live site."); | ||
| //p( "If you do need to activate it, only do so for a short period of time." ); | ||
|
|
||
| //p( "You will need to specify the action file name (e.g. bwaction.loh )" ); | ||
| //p( "Set actions to 'on' when you want to trace action processing, 'off' otherwise."); | ||
| p( "Set Count action hooks and filters to count the number of times each action or filter hook is invoked" ); | ||
| //p( "Set immediate actions to 'on' when you want to trace ALL actions and filters." ); | ||
| //p( "Note: Immediate action tracing will replace the current version of wp-includes/plugin.php with one that has been modified to include tracing." ); | ||
| //p( "When you deselect the check box then the original file is restored." ); | ||
| //p( "The code should not break your site after a WordPress upgrade." ); | ||
|
|
||
| p( "You may find the most recent trace action output at..." ); | ||
| $bw_action_url = bw_trace_url( 'bw_action_options' ); | ||
|
|
||
| alink( NULL, $bw_action_url, $bw_action_url, "View action output in your browser."); | ||
| p( "The trace action log is reset at the same time as the trace log." ); | ||
|
|
||
| bw_flush(); | ||
| } | ||
|
|
||
| /** | ||
| * Display the oik trace options page | ||
| * | ||
| */ | ||
| function bw_trace_options_do_page() { | ||
| oik_menu_header( "trace options" ); | ||
| oik_box( null, null, "Options", "oik_trace_options" ); | ||
| oik_box( null, null, "Information", "oik_trace_info" ); | ||
| oik_box( null, null, "Notes about oik trace", "oik_trace_notes" ); | ||
| oik_box( null, null, "Trace options and reset button", "oik_trace_reset_notes" ); | ||
| oik_menu_footer(); | ||
| bw_flush(); | ||
| } | ||
|
|
||
| /** | ||
| * Display the trace options box | ||
| * | ||
| * Note: The fields suffixed _ajax apply when the DOING_AJAX constant is true. | ||
| * | ||
| */ | ||
| function oik_trace_options() { | ||
| bw_form( "options.php" ); | ||
|
|
||
| $options = get_option('bw_trace_options'); | ||
|
|
||
| stag( 'table class="form-table"' ); | ||
| bw_flush(); | ||
| settings_fields('bw_trace_options_options'); | ||
|
|
||
| bw_textfield_arr( "bw_trace_options", "Trace file", $options, 'file', 60 ); | ||
| bw_checkbox_arr( "bw_trace_options", "Reset trace file every transaction", $options, 'reset' ); | ||
| bw_checkbox_arr( "bw_trace_options", "Trace enabled", $options, 'trace' ); | ||
|
|
||
| bw_textfield_arr( "bw_trace_options", "AJAX Trace file", $options, 'file_ajax', 60 ); | ||
| bw_checkbox_arr( "bw_trace_options", "Reset AJAX trace file every AJAX transaction", $options, 'reset_ajax' ); | ||
| bw_checkbox_arr( "bw_trace_options", "AJAX Trace enabled", $options, 'trace_ajax' ); | ||
|
|
||
| // Does this need includes/bwtrace.php? | ||
| $trace_levels = bw_list_trace_levels(); | ||
| // Do we need to default this after upgrade? | ||
| //$options['level'] = bw_trace_level(); | ||
| bw_select_arr( "bw_trace_options", "Trace level", $options, 'level', array( "#options" => $trace_levels ) ); | ||
| bw_checkbox_arr( "bw_trace_options", "Fully qualified file names", $options, 'qualified' ); | ||
| bw_checkbox_arr( "bw_trace_options", "Include trace record count", $options, 'count' ); | ||
| bw_checkbox_arr( "bw_trace_options", "Include timestamp", $options, 'date' ); | ||
| bw_checkbox_arr( "bw_trace_options", "Include current filter", $options, 'filters' ); | ||
| bw_checkbox_arr( "bw_trace_options", "Include number of queries", $options, "num_queries" ); | ||
| bw_checkbox_arr( "bw_trace_options", "Include post ID", $options, "post_id" ); | ||
| $memory_limit = ini_get( "memory_limit" ); | ||
| bw_trace( $memory_limit, "memory_limit", false, BW_TRACE_DEBUG ); | ||
| bw_checkbox_arr( "bw_trace_options", "Include memory/peak usage ( limit $memory_limit )", $options, 'memory' ); | ||
| bw_checkbox_arr( "bw_trace_options", "Include files loaded count", $options, 'files' ); | ||
| $current_ip = "<br />Current IP: "; | ||
| $current_ip .= bw_array_get( $_SERVER, "REMOTE_ADDR", null ); | ||
| bw_textfield_arr( "bw_trace_options", "Trace specific IP $current_ip", $options, 'ip', 20 ); | ||
|
|
||
| // Trace error processing is not yet enabled. | ||
| // textfield( "bw_trace_options[errors]", 1 ,"Trace errors (0=no,-1=all,1=E_ERROR,2=E_WARNING,4=E_PARSE, etc)", $options['errors'] ); | ||
| // bw_tablerow( array( "", "<input type=\"submit\" name=\"ok\" value=\"Save changes\" class=\"button-primary\"/>") ); | ||
|
|
||
| etag( "table" ); | ||
| p( isubmit( "ok", __( "Save changes", 'oik-bwtrace' ), null, "button-primary" ) ); | ||
| etag( "form" ); | ||
|
|
||
| bw_flush(); | ||
| } | ||
|
|
||
| /** | ||
| * Display trace notes | ||
| */ | ||
| function oik_trace_notes() { | ||
| p( "The tracing output produced by oik-bwtrace can be used for problem determination."); | ||
| p( "It's not for the faint hearted."); | ||
| p( "The oik-bwtrace plugin should <b>not</b> need to be activated on a live site."); | ||
| p( "If you do need to activate it, only do so for a short period of time." ); | ||
|
|
||
| p( "You will need to specify the trace file name (e.g. bwtrace.loh )" ); | ||
| p( "When you want to trace processing check 'Trace enabled'" ); | ||
| p( "Check 'Reset trace file every transaction' to cause the trace file to be cleared for every request, including AJAX requests." ); | ||
|
|
||
|
|
||
| p("You may find the most recent trace output at..." ); | ||
| $bw_trace_url = bw_trace_url(); | ||
|
|
||
| alink( NULL, $bw_trace_url, $bw_trace_url, "View trace output in your browser."); | ||
|
|
||
| p("If you want to trace processing within some content you can use two shortcodes: [bwtron] to turn trace on and [bwtroff] to turn it off" ); | ||
|
|
||
| bw_flush(); | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Display trace reset | ||
| * | ||
| */ | ||
| function oik_trace_reset_notes() { | ||
| $oik_sc_help = oik_require_lib( "oik-sc-help" ); | ||
| if ( $oik_sc_help && !is_wp_error( $oik_sc_help ) ) { | ||
| bw_trace2( $oik_sc_help, "oik-sc-help", false, BW_TRACE_DEBUG ); | ||
| if ( function_exists( "bw_invoke_shortcode" ) ) { | ||
| bw_invoke_shortcode( "bwtrace", null, "Use the [bwtrace] shortcode in a widget to provide an instant trace reset and page reload." ); | ||
| } else { | ||
| bw_trace_included_files(); | ||
| } | ||
| } else { | ||
| bw_trace2( $oik_sc_help, "oik-sc-help" ); | ||
| p( "Activate the oik base plugin to enable the [bwtrace] shortcode" ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Display Trace info | ||
| * | ||
| * This displays lots of useful information about the site configuration and settings | ||
| * Similar to PHPinfo but more aligned to WordPress and problem determination thereof. | ||
| */ | ||
| function oik_trace_info() { | ||
| oik_require( "admin/class-oik-trace-info.php", "oik-bwtrace" ); | ||
| $oik_trace_info = new OIK_trace_info(); | ||
| $oik_trace_info->display_info(); | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Sanitize and validate trace options input | ||
| * | ||
| * @param $input array Accepts an array, | ||
| * @return array sanitized array. | ||
| */ | ||
| function bw_trace_options_validate($input) { | ||
| $input['ip'] = trim( $input['ip']); | ||
| return $input; | ||
| } | ||
|
|
||
| /** | ||
| * Validate the bw_action_options | ||
| * | ||
| * Note: If the validation function does not exist then no value is returned and the options don't get saved. | ||
| * WordPress does not produce a warning message. | ||
| * | ||
| * @param array $input the options to be saved | ||
| * @return array validated input | ||
| */ | ||
| function bw_action_options_validate( $input ) { | ||
| bw_trace2( $input ); | ||
| // oik_require( "admin/oik-replace.inc", "oik-bwtrace" ); | ||
| // $immediate = bw_array_get( $input, "immediate", false ); | ||
| // $result = bw_enable_action_trace( $immediate ) ; | ||
| return $input; | ||
| } | ||
|
|
||
| /** | ||
| * Return the trace file URL | ||
| * | ||
| * May not return the correct URL for WordPress MultiSite | ||
| * | ||
| * @param string $option the option set. | ||
| * @return string the trace file URL | ||
| */ | ||
| function bw_trace_url( $option='bw_trace_options', $ajax=false ) { | ||
| $options = get_option( $option ); | ||
| $file = bw_trace_file_name( $options, $ajax ); | ||
| $bw_trace_url = get_site_url( NULL, $file ); | ||
| return( $bw_trace_url ); | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * Implement "activated_plugin" action for oik-bwtrace | ||
| * | ||
| * Arrange for the "oik-bwtrace/oik-bwtrace.php" plugin to be loaded first | ||
| * regardless of which plugin has been activated. | ||
| * | ||
| * @TODO If it's network activated this should be first in "active_sitewide_plugins" | ||
| * | ||
| * | ||
| * @param string $plugin path to main plugin file | ||
| * @param bool $network_wide true if network activated | ||
| */ | ||
| function bw_this_plugin_first( $plugin, $network_wide ) { | ||
| if ( false == $network_wide ) { | ||
| $this_plugin = "oik-bwtrace/oik-bwtrace.php"; | ||
| $active_plugins = get_option( 'active_plugins' ); | ||
| $this_plugin_key = array_search( $this_plugin, $active_plugins ); | ||
| if ( $this_plugin_key ) { // if it's 0 it's the first plugin already, no need to continue | ||
| array_splice( $active_plugins, $this_plugin_key, 1 ); | ||
| array_unshift( $active_plugins, $this_plugin ); | ||
| update_option( 'active_plugins', $active_plugins ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| require_once( __DIR__ . '/oik-bwtrace.php' ); |
Oops, something went wrong.