├── LICENSE ├── README.md ├── inc ├── class-browse-output.php ├── class-collector.php ├── class-dispatcher.php ├── class-profile.php ├── namespace.php ├── qm-overrides │ └── class-qm_collectors.php └── storage │ └── class-filestorage.php └── plugin.php /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {{description}} 294 | Copyright (C) {{year}} {{fullname}} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Query Monitor Persist 2 | 3 | Ever wished you could save a request in Query Monitor for later? Or share it with a teammate? Now you can. 4 | 5 | Simply activate this plugin, and you're done. 6 | 7 | **Important Note**: this should only be activated for local development, as data specific to your user may leak in the request. 8 | 9 | ## License 10 | 11 | Copyright 2019 Human Made. Licensed under the GPL v2 or later. 12 | 13 | Incorporates code from Symfony's [HttpKernel](https://github.com/symfony/http-kernel), copyright 2004-2019 Fabien Potencier. Used under the [MIT license](https://github.com/symfony/http-kernel/blob/master/LICENSE). 14 | 15 | -------------------------------------------------------------------------------- /inc/class-browse-output.php: -------------------------------------------------------------------------------- 1 | collector->id() . '-browse'; 32 | $menu[ $id ] = $this->menu( array( 33 | 'title' => esc_html__( 'History', 'qmpersist' ), 34 | 'href' => esc_attr( '#' . $id ), 35 | ) ); 36 | 37 | return $menu; 38 | 39 | } 40 | 41 | /** 42 | * Move menu item under "Overview" 43 | */ 44 | public function panel_menu( array $menu ) { 45 | $id = $this->collector->id() . '-browse'; 46 | if ( isset( $menu[ $id ] ) ) { 47 | $menu[ $id ]['title'] = '└ ' . $menu[ $id ]['title']; 48 | } 49 | 50 | return $menu; 51 | } 52 | 53 | /** 54 | * Get the URL for a request. 55 | * 56 | * @param string $id Request ID 57 | * @return string URL to view the request 58 | */ 59 | protected function get_url( string $id ) : string { 60 | return add_query_arg( 'qm_id', urlencode( $id ), home_url() ); 61 | } 62 | 63 | /** 64 | * Output the browse panel. 65 | */ 66 | public function output() { 67 | $id = $this->collector->id() . '-browse'; 68 | $this->before_tabular_output( $id, __( 'History', 'qmpersist' ) ); 69 | 70 | $data = $this->collector->get_data(); 71 | $overview_data = QM_Collectors::get( 'overview' )->get_data(); 72 | 73 | echo ''; 74 | echo ''; 75 | echo '' . esc_html__( 'Status', 'qmpersist' ) . ''; 76 | echo '' . esc_html__( 'Method', 'qmpersist' ) . ''; 77 | echo '' . esc_html__( 'URL', 'qmpersist' ) . ''; 78 | echo '' . esc_html__( 'IP', 'qmpersist' ) . ''; 79 | echo '' . esc_html__( 'Time', 'qmpersist' ) . ''; 80 | echo '' . esc_html__( 'Request ID', 'qmpersist' ) . ''; 81 | echo ''; 82 | echo ''; 83 | echo ''; 84 | 85 | $rows = get_storage()->find(); 86 | 87 | // Add current request to the rows. 88 | if ( ! is_qmpersist_request() ) { 89 | array_unshift( $rows, [ 90 | 'status_code' => $data['response']['status'], 91 | 'method' => $data['request']['method'], 92 | 'url' => $data['request']['url'], 93 | 'ip' => $data['request']['ip'], 94 | 'time' => $overview_data['time_start'], 95 | 'id' => $data['request']['id'], 96 | ] ); 97 | } 98 | 99 | foreach ( $rows as $row ) { 100 | echo ''; 101 | echo '' . esc_html( $row['status_code'] ) . ''; 102 | echo '' . esc_html( $row['method'] ) . ''; 103 | echo '' . esc_html( $row['url'] ) . ''; 104 | echo '' . esc_html( $row['ip'] ) . ''; 105 | echo '' . esc_html( date( 'r', $row['time'] ) ); 106 | if ( $row['id'] === $data['request']['id'] ) { 107 | echo ' (Current request)'; 108 | } 109 | echo ''; 110 | printf( 111 | '%s', 112 | esc_url( $this->get_url( $row['id'] ) ), 113 | esc_html( $row['id'] ) 114 | ); 115 | echo ''; 116 | } 117 | echo ''; 118 | 119 | $this->after_tabular_output(); 120 | } 121 | } 122 | -------------------------------------------------------------------------------- /inc/class-collector.php: -------------------------------------------------------------------------------- 1 | substr( hash( 'sha256', uniqid( mt_rand(), true ) ), 0, 6 ), 18 | 'ip' => $_SERVER['REMOTE_ADDR'], 19 | 'method' => strtoupper( wp_unslash( $_SERVER['REQUEST_METHOD'] ) ), 20 | 'scheme' => is_ssl() ? 'https' : 'http', 21 | 'host' => wp_unslash( $_SERVER['HTTP_HOST'] ), 22 | 'path' => wp_unslash( $_SERVER['REQUEST_URI'] ) ?? '/', 23 | 'query' => wp_unslash( $_SERVER['QUERY_STRING'] ), 24 | ]; 25 | 26 | $request['url'] = sprintf( '%s://%s%s', $request['scheme'], $request['host'], $request['path'] ); 27 | if ( ! empty( $request['query'] ) ) { 28 | $request['url'] .= '?' . $request['query']; 29 | } 30 | 31 | $this->data['request'] = $request; 32 | 33 | $response = [ 34 | 'status' => http_response_code(), 35 | ]; 36 | $this->data['response'] = $response; 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /inc/class-dispatcher.php: -------------------------------------------------------------------------------- 1 | storage = $storage; 33 | 34 | add_action( 'shutdown', [ $this, 'dispatch' ], 100 ); 35 | } 36 | 37 | /** 38 | * Mark the dispatcher as always active. 39 | */ 40 | public function is_active() { 41 | return true; 42 | } 43 | 44 | /** 45 | * Dispatch. 46 | */ 47 | public function dispatch() { 48 | $collectors = QM_Collectors::init(); 49 | $overview = QM_Collectors::get( 'overview' )->get_data(); 50 | $data = QM_Collectors::get( COLLECTOR_ID )->get_data(); 51 | 52 | // header( sprintf( 'X-QMPersist-ID: %s', $data['request']['id'] ) ); 53 | 54 | $profile = new Profile( $data['request']['id'] ); 55 | $profile->set_data( $collectors ); 56 | $profile->ip = $data['request']['ip']; 57 | $profile->method = $data['request']['method']; 58 | $profile->url = $data['request']['url']; 59 | $profile->time = $overview['time_start']; 60 | $profile->status_code = $data['response']['status']; 61 | 62 | $this->storage->save( $profile ); 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /inc/class-profile.php: -------------------------------------------------------------------------------- 1 | id = $id; 45 | } 46 | 47 | public function get_id() : string { 48 | return $this->id; 49 | } 50 | 51 | public function get_data() : QM_Collectors { 52 | return $this->data; 53 | } 54 | 55 | public function set_data( QM_Collectors $data ) { 56 | $this->data = $data; 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /inc/namespace.php: -------------------------------------------------------------------------------- 1 | load( wp_unslash( $_GET['qm_id'] ) ); 87 | 88 | // Replace QM's data with the profile's. 89 | QM_Collectors::replace_instance( $profile->get_data() ); 90 | 91 | // Disable all collectors for this request. 92 | return []; 93 | } 94 | 95 | function render_panel_only() { 96 | // Force HTML output to render. 97 | $html_dispatcher = QM_Dispatchers::get( 'html' ); 98 | $html_dispatcher->did_footer = true; 99 | 100 | // Render basic page. 101 | echo ''; 102 | echo ''; 111 | wp_head(); 112 | 113 | echo ''; 114 | 115 | exit; 116 | } 117 | -------------------------------------------------------------------------------- /inc/qm-overrides/class-qm_collectors.php: -------------------------------------------------------------------------------- 1 | items ); 11 | } 12 | 13 | public static function add( QM_Collector $collector ) { 14 | $collectors = self::init(); 15 | 16 | $collectors->items[ $collector->id ] = $collector; 17 | } 18 | 19 | public static function get( $id ) { 20 | $collectors = self::init(); 21 | if ( isset( $collectors->items[ $id ] ) ) { 22 | return $collectors->items[ $id ]; 23 | } 24 | return false; 25 | } 26 | 27 | /* added/modified: */ 28 | public static function init() { 29 | if ( ! static::$instance ) { 30 | static::$instance = new QM_Collectors(); 31 | } 32 | 33 | return static::$instance; 34 | 35 | } 36 | 37 | public static function replace_instance( QM_Collectors $instance ) { 38 | static::$instance = $instance; 39 | } 40 | /* end added/modified */ 41 | 42 | public function process() { 43 | if ( $this->processed ) { 44 | return; 45 | } 46 | 47 | foreach ( $this as $collector ) { 48 | $collector->tear_down(); 49 | 50 | $timer = new QM_Timer(); 51 | $timer->start(); 52 | 53 | $collector->process(); 54 | $collector->process_concerns(); 55 | 56 | $collector->set_timer( $timer->stop() ); 57 | } 58 | 59 | foreach ( $this as $collector ) { 60 | $collector->post_process(); 61 | } 62 | 63 | $this->processed = true; 64 | } 65 | 66 | } 67 | -------------------------------------------------------------------------------- /inc/storage/class-filestorage.php: -------------------------------------------------------------------------------- 1 | directory = $directory; 11 | } 12 | 13 | /** 14 | * Search for matching profiles. 15 | */ 16 | public function find( $ip = null, $url = null, $limit = 10, $method = null, $start = null, $end = null, $status_code = null ) { 17 | $file = $this->get_index_path(); 18 | 19 | if ( ! file_exists( $file ) ) { 20 | return []; 21 | } 22 | 23 | $file = fopen( $file, 'r' ); 24 | fseek( $file, 0, SEEK_END ); 25 | 26 | $result = []; 27 | while ( count( $result ) < $limit ) { 28 | $line = $this->get_next_row( $file ); 29 | if ( empty( $line ) ) { 30 | break; 31 | } 32 | 33 | $values = str_getcsv( $line ); 34 | list( $row_id, $row_ip, $row_method, $row_url, $row_time, $row_status ) = $values; 35 | $row_time = (int) $row_time; 36 | 37 | $conds = [ 38 | $ip && false === strpos( $row_ip, $ip ), 39 | $url && false === strpos( $row_url, $url ), 40 | $method && false === strpos( $row_method, $method ), 41 | $status_code && false === strpos( $row_status, $status_code ), 42 | ! empty( $start ) && $row_time < $start, 43 | ! empty( $end ) && $row_time > $end, 44 | ]; 45 | if ( count( array_filter( $conds ) ) > 0 ) { 46 | continue; 47 | } 48 | 49 | $result[ $row_id ] = [ 50 | 'id' => $row_id, 51 | 'ip' => $row_ip, 52 | 'method' => $row_method, 53 | 'url' => $row_url, 54 | 'time' => $row_time, 55 | 'status_code' => $row_status, 56 | ]; 57 | } 58 | 59 | fclose( $file ); 60 | 61 | return array_values( $result ); 62 | } 63 | 64 | /** 65 | * Reads a line in the file, backward. 66 | * 67 | * This function automatically skips the empty lines and do not include the line return in result value. 68 | * 69 | * @param resource $file The file resource, with the pointer placed at the end of the line to read 70 | * 71 | * @return mixed A string representing the line or null if beginning of file is reached 72 | */ 73 | protected function get_next_row( $file ) { 74 | $line = ''; 75 | $position = ftell( $file ); 76 | 77 | if ( 0 === $position ) { 78 | return; 79 | } 80 | 81 | while ( true ) { 82 | $chunk = min( $position, 1024 ); 83 | $position -= $chunk; 84 | fseek( $file, $position ); 85 | 86 | if ( $chunk === 0 ) { 87 | // bof reached 88 | break; 89 | } 90 | 91 | $buffer = fread( $file, $chunk ); 92 | 93 | $rest_length = strrpos( $buffer, "\n" ); 94 | if ( $rest_length === false ) { 95 | $line = $buffer . $line; 96 | continue; 97 | } 98 | 99 | $position += $rest_length; 100 | $line = substr( $buffer, $rest_length + 1 ) . $line; 101 | fseek( $file, max( 0, $position ), SEEK_SET ); 102 | 103 | if ( $line !== '' ) { 104 | break; 105 | } 106 | } 107 | 108 | if ( $line === '' ) { 109 | return null; 110 | } 111 | 112 | return $line; 113 | } 114 | 115 | /** 116 | * Load a profile by ID. 117 | * 118 | * @param string $id 119 | * @return Profile|null 120 | */ 121 | public function load( string $id ) : ?Profile { 122 | $path = $this->directory . DIRECTORY_SEPARATOR . $id; 123 | if ( ! file_exists( $path ) ) { 124 | return null; 125 | } 126 | 127 | $contents = file_get_contents( $path ); 128 | return unserialize( $contents ); 129 | } 130 | 131 | /** 132 | * Save a profile. 133 | * 134 | * @param Profile $profile 135 | */ 136 | public function save( Profile $profile ) { 137 | if ( ! is_dir( $this->directory ) ) { 138 | $status = @mkdir( $this->directory, 0777, true ); 139 | if ( $status === false && ! is_dir( $this->directory ) ) { 140 | return new WP_Error( 141 | 'qmpersist.storage.cannot_create', 142 | sprintf( 'Cannot create the storage directory (%s)', $this->directory ) 143 | ); 144 | } 145 | } 146 | 147 | $id = $profile->get_id(); 148 | $filename = wp_unique_filename( $this->directory, $id ); 149 | $path = $this->directory . DIRECTORY_SEPARATOR . $filename; 150 | 151 | $result = file_put_contents( $path, serialize( $profile ) ); 152 | if ( $result === false ) { 153 | var_dump( $result ); 154 | return false; 155 | } 156 | 157 | $this->save_to_index( $profile ); 158 | 159 | return $result; 160 | } 161 | 162 | /** 163 | * Get path to the index file. 164 | * 165 | * @return string Path for the index CSV file 166 | */ 167 | protected function get_index_path() : string { 168 | return $this->directory . DIRECTORY_SEPARATOR . 'index.csv'; 169 | } 170 | 171 | /** 172 | * Add a profile to the index. 173 | * 174 | * @param Profile $profile Profile to add. 175 | */ 176 | protected function save_to_index( Profile $profile ) { 177 | $file = fopen( $this->get_index_path(), 'a' ); 178 | if ( $file === false ) { 179 | return false; 180 | } 181 | 182 | $data = [ 183 | $profile->get_id(), 184 | $profile->ip, 185 | $profile->method, 186 | $profile->url, 187 | $profile->time, 188 | $profile->status_code, 189 | ]; 190 | fputcsv( $file, $data ); 191 | 192 | fclose( $file ); 193 | } 194 | } 195 | -------------------------------------------------------------------------------- /plugin.php: -------------------------------------------------------------------------------- 1 |