jenkins-bot has submitted this change and it was merged. Change subject: Cache invalidation infrastructure for Parsoid varnishes, first cut ......................................................................
Cache invalidation infrastructure for Parsoid varnishes, first cut This patch develops a hook-based cache invalidation infrastructure for the Parsoid varnishes, according to http://www.mediawiki.org/wiki/User:GWicke/Minimal_performance_strategy_for_July_release. The deferred job is based on HTMLCacheUpdateJob so that the recursive batch splitting logic can be shared. A good amount of edit-related hooks are registered, mostly following the example of the FlaggedRevision extension. It looks like we'll get away without a need for any core modifications. Asynchronous refresh and PURGE functionality is implemented using curl_multi. Additional information about the predecessor revision id and the reason for the update (title triggering it and edit vs. template vs. image updates) are passed in an X-Parsoid header. TODO: - Test and refine with actual Varnish servers Change-Id: I47331bf638dc93cf444ceeecb89ef9f4c3f40ae3 --- A php/COPYING A php/CurlMultiClient.php A php/Parsoid.hooks.php A php/Parsoid.php A php/ParsoidCacheUpdateJob.php 5 files changed, 767 insertions(+), 0 deletions(-) Approvals: Subramanya Sastry: Looks good to me, approved Cscott: Looks good to me, but someone else must approve jenkins-bot: Verified diff --git a/php/COPYING b/php/COPYING new file mode 100644 index 0000000..019694a --- /dev/null +++ b/php/COPYING @@ -0,0 +1,342 @@ +== GNU GENERAL PUBLIC LICENSE == + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +=== Preamble === + +The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + +We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + +Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and +modification follow. + +== TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION == + +'''0.''' This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + +'''1.''' You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + +'''2.''' You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + '''a)''' You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + '''b)''' You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + '''c)''' If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + +'''3.''' You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + '''a)''' Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + '''b)''' Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + '''c)''' Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + +'''4.''' You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + +'''5.''' You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +'''6.''' Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + +'''7.''' If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + +'''8.''' If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + +'''9.''' The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + +'''10.''' If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + +=== NO WARRANTY === + +'''11.''' BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + +'''12.''' IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + '''END OF TERMS AND CONDITIONS''' + +== How to Apply These Terms to Your New Programs == + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + 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. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/php/CurlMultiClient.php b/php/CurlMultiClient.php new file mode 100644 index 0000000..0ad2619 --- /dev/null +++ b/php/CurlMultiClient.php @@ -0,0 +1,102 @@ +<?php +/** + * A simple parallel CURL client helper class + */ +class CurlMultiClient { + + /** + * Get the default CURL options used for each request + * + * @static + * @returns array default options + */ + public static function getDefaultOptions () { + return array( + CURLOPT_HEADER=>0, + CURLOPT_RETURNTRANSFER=>1 + ); + } + + /** + * Peform several CURL requests in parallel, and return the combined + * results. + * + * @static + * @param $requests array requests, each with an url and an optional + * 'headers' member: + * array( + * 'url' => 'http://server.com/foo', + * 'headers' => array( 'X-Foo: Bar' ) + * ) + * @param $options array curl options used for each request, default + * {CurlMultiClient::getDefaultOptions}. + * @returns array An array of arrays containing 'error' and 'data' + * members. If there are errors, data will be null. If there are no + * errors, the error member will be null and data will contain the + * response data as a string. + */ + public static function request($requests, $options=""){ + + + if( !count( $requests ) ) return false; + + $handles = array(); + + if( !$options ) // add default options + $options = CurlMultiClient::getDefaultOptions(); + + // add curl options to each handle + foreach( $requests as $k => $row ){ + $handle = curl_init(); + $options[CURLOPT_URL] = $row['url']; + wfDebug("adding url: " . $row['url']); + if ( array_key_exists( 'headers', $row ) ) { + $options[CURLOPT_HTTPHEADER] = $row['headers']; + } else if ( array_key_exists( CURLOPT_HTTPHEADER, $options ) ) { + unset( $options[CURLOPT_HTTPHEADER] ); + } + curl_setopt_array($handle, $options); + + $handles[$k] = $handle; + } + + $mh = curl_multi_init(); + + foreach( $handles as $handle ){ + curl_multi_add_handle($mh,$handle); + } + + $running_handles = null; + //execute the handles + do { + $status_cme = curl_multi_exec($mh, $running_handles); + } while ( $status_cme == CURLM_CALL_MULTI_PERFORM ); + + while ( $running_handles && $status_cme == CURLM_OK ) { + if ( curl_multi_select($mh) != -1 ) { + do { + $status_cme = curl_multi_exec( $mh, $running_handles ); + } while ( $status_cme == CURLM_CALL_MULTI_PERFORM ); + } + } + + $res = array(); + foreach( $requests as $k => $row ){ + $res[$k] = array(); + $res[$k]['error'] = curl_error( $handles[$k] ); + if( !empty( $res[$k]['error'] ) ) { + $res[$k]['data'] = null; + } else { + $res[$k]['error'] = null; + $res[$k]['data'] = curl_multi_getcontent( $handles[$k] ); // get results + } + + // close current handler + curl_multi_remove_handle( $mh, $handles[$k] ); + } + curl_multi_close( $mh ); + + #wfDebug(serialize($res)); + return $res; // return response + } +} diff --git a/php/Parsoid.hooks.php b/php/Parsoid.hooks.php new file mode 100644 index 0000000..0b41c23 --- /dev/null +++ b/php/Parsoid.hooks.php @@ -0,0 +1,98 @@ +<?php + +/** + * Hooks for events that should trigger Parsoid cache updates. + */ +class ParsoidHooks { + /** + * Schedule an async update job in the job queue. The params passed here + * are empty. They are dynamically created in ParsoidCacheUpdateJob + * depending on title namespace etc. + */ + private static function updateTitle ( $title, $action ) { + $jobs = array(); + $jobs[] = new ParsoidCacheUpdateJob( $title, array() ); + Job::batchInsert( $jobs ); + } + + /** + * Callback for regular article edits + * + * @param $article WikiPage the modified wiki page object + * @param $editInfo + * @param bool $changed + * @return bool + */ + public static function onArticleEditUpdates ( &$article, &$editInfo, $changed ) { + if ( $changed ) { + ParsoidHooks::updateTitle( $article->getTitle(), 'edit' ); + } + return true; + } + + /** + * Callback for article deletions + * + * @param $article WikiPage the modified wiki page object + * @param $user User the deleting user + * @param string $reason + * @param int $id the page id + * @return bool + */ + public static function onArticleDeleteComplete ( &$article, User &$user, $reason, $id ) + { + ParsoidHooks::updateTitle( $article->getTitle(), 'delete' ); + return true; + } + + /** + * Callback for article undeletion. See specials/SpecialUndelete.php. + */ + public static function onArticleUndelete ( $title, $created, $comment ) { + ParsoidHooks::updateTitle( $title, 'edit' ); + return true; + } + + /** + * Callback for article revision changes. See + * revisiondelete/RevisionDelete.php. + */ + public static function onArticleRevisionVisibilitySet ( &$title ) { + # We treat all visibility update as deletions for now. That is safe, + # as it will always clear the cache. VE requests might be slow after a + # restore, but they will return the correct result. + ParsoidHooks::updateTitle( $title, 'delete' ); + return true; + } + + /** + * Title move callback. See Title.php. + */ + public static function onTitleMoveComplete ( Title &$title, Title &$newtitle, + User &$user, $oldid, $newid ) + { + # Simply update both old and new title. ParsoidCacheUpdateJob will + # do the right thing for both. + ParsoidHooks::updateTitle( $title, $oldid, 'delete' ); + ParsoidHooks::updateTitle( $newtitle, $newid, 'edit' ); + return true; + } + + /** + * File upload hook. See filerepo/file/LocalFile.php. + * + * XXX gwicke: This tracks file uploads including re-uploads of a new + * version of an image. These will implicitly also trigger null edits on + * the associated WikiPage (which normally exists), which then triggers + * the onArticleEditUpdates hook. Maybe we should thus drop this hook and + * simply assume that all edits to the WikiPage also change the image + * data. Those edits tend to happen not long after an upload, at which + * point the image is likely not used in many pages. + */ + public static function onFileUpload ( $file ) { + $title = $file->getTitle(); + ParsoidHooks::updateTitle( $title, 'file' ); + return true; + } + +} diff --git a/php/Parsoid.php b/php/Parsoid.php new file mode 100644 index 0000000..efa06a7 --- /dev/null +++ b/php/Parsoid.php @@ -0,0 +1,51 @@ +<?php +/** + * Basic cache invalidation for Parsoid + */ + +if ( !defined( 'MEDIAWIKI' ) ) { + echo "Parsoid extension\n"; + exit( 1 ); +} + + +/** + * Class containing basic setup functions. + */ +class ParsoidSetup { + /** + * Register hook handlers. + * This function must NOT depend on any config vars. + * + * @return void + */ + public static function setUnconditionalHooks() { + global $wgHooks, $wgAutoloadClasses, $wgJobClasses; + + $dir = dirname( __FILE__ ); + + # Set up class autoloading + $wgAutoloadClasses['ParsoidHooks'] = "$dir/Parsoid.hooks.php"; + $wgAutoloadClasses['ParsoidCacheUpdateJob'] = "$dir/ParsoidCacheUpdateJob.php"; + $wgAutoloadClasses['CurlMultiClient'] = "$dir/CurlMultiClient.php"; + + # Add the ParsoidCacheUpdateJob to the job classes so it can be de-serialized + $wgJobClasses['ParsoidCacheUpdateJob'] = 'ParsoidCacheUpdateJob'; + + # Article edit/create + $wgHooks['ArticleEditUpdates'][] = 'ParsoidHooks::onArticleEditUpdates'; + # Article delete/restore + $wgHooks['ArticleDeleteComplete'][] = 'ParsoidHooks::onArticleDelete'; + $wgHooks['ArticleUndelete'][] = 'ParsoidHooks::onArticleUndelete'; + # Revision delete/restore + $wgHooks['ArticleRevisionVisibilitySet'][] = 'ParsoidHooks::onRevisionDelete'; + # Article move + $wgHooks['TitleMoveComplete'][] = 'ParsoidHooks::onTitleMoveComplete'; + # File upload + $wgHooks['FileUpload'][] = 'ParsoidHooks::onFileUpload'; + } +} + + +# Load hooks that are always set +ParsoidSetup::setUnconditionalHooks(); diff --git a/php/ParsoidCacheUpdateJob.php b/php/ParsoidCacheUpdateJob.php new file mode 100644 index 0000000..dc6f86b --- /dev/null +++ b/php/ParsoidCacheUpdateJob.php @@ -0,0 +1,174 @@ +<?php +/** + * HTML cache refreshing and -invalidation job for the Parsoid varnish caches. + * See + * http://www.mediawiki.org/wiki/Parsoid/Minimal_performance_strategy_for_July_release + */ +class ParsoidCacheUpdateJob extends HTMLCacheUpdateJob { + /** + * Construct a job + * @param $title Title: the title linked to + * @param array $params job parameters (table, start and end page_ids) + * @param $id Integer: job id + */ + function __construct( $title, $params, $id = 0 ) { + wfDebug("ParsoidCacheUpdateJob.__construct\n"); + global $wgUpdateRowsPerJob; + + Job::__construct( 'ParsoidCacheUpdateJob', $title, $params, $id ); + + # $this->rowsPerJob = $wgUpdateRowsPerJob; + # Parsoid re-parses will be slow, so set the number of titles per job + # to 10 for now. + $this->rowsPerJob = 10; + + $this->blCache = $title->getBacklinkCache(); + } + + public function run() { + if ( isset( $this->params['start'] ) && isset( $this->params['end'] ) ) { + # This is a child job working on a sub-range of a large number of + # titles. + return $this->doPartialUpdate(); + } else { + # The root job. + if ( $this->title->getNamespace() == NS_FILE ) { + # File. For now we assume the actual image or file has + # changed, not just the description page. + $this->params['table'] = 'imagelinks'; + $this->doFullUpdate(); + } else { + # Not a file: Refresh the Parsoid cache for the page itself + $this->invalidateTitle( $this->title ); + # and refresh expansions in pages transcluding this page. + $this->params['table'] = 'templatelinks'; + $this->doFullUpdate(); + } + } + return true; + } + + /** + * Construct a cache server URL + * + * @param $title Title + * @param string $server the server name + * @param bool $prev use previous revision id if true + * @return string an absolute URL for the article on the given server + */ + protected function getParsoidURL( $title, $server, $prev = false ) { + global $wgLanguageCode; + + $oldid = $prev ? $title->getPreviousRevisionID($title->getLatestRevID()) + : $title->getLatestRevID(); + + return 'http://' . $server . '/' . $wgLanguageCode . '/' . + $title->getPrefixedDBkey() . '?oldid=' . $oldid; + } + + + /** + * Invalidate a single title object + * @param $title Title + */ + protected function invalidateTitle( $title ) { + global $wgParsoidCacheServers; + if( !isset( $wgParsoidCacheServers ) ) { + $wgParsoidCacheServers = array( 'localhost' ); + } + + # First request the new version + $parsoidInfo = array(); + $parsoidInfo['prevID'] = $title->getPreviousRevisionID($title->getLatestRevID()); + $parsoidInfo['changedTitle'] = $this->title->getPrefixedDBkey(); + + $requests = array (); + foreach ( $wgParsoidCacheServers as $server ) { + $requests[] = array( + 'url' => $this->getParsoidURL( $title, $server ), + 'headers' => array('X-Parsoid: ' . json_encode( $parsoidInfo )) + ); + }; + wfDebug("ParsoidCacheUpdateJob::invalidateTitle: " . + serialize($requests) . "\n"); + CurlMultiClient::request( $requests ); + + # And now purge the previous revision + $requests = array (); + foreach ( $wgParsoidCacheServers as $server ) { + $requests[] = array( + 'url' => $this->getParsoidURL( $title, $server, true ) + ); + }; + $options = CurlMultiClient::getDefaultOptions(); + $options[CURLOPT_CUSTOMREQUEST] = "PURGE"; + CurlMultiClient::request( $requests, $options ); + } + + /** + * Invalidate an array (or iterator) of Title objects, right now + * @param $titleArray array + */ + protected function invalidateTitles( $titleArray ) { + global $wgParsoidCacheServers, $wgLanguageCode; + if( !isset( $wgParsoidCacheServers ) ) { + $wgParsoidCacheServers = array( 'localhost' ); + } + + + # Re-render + $parsoidInfo = array(); + + # Pass some useful info to Parsoid + $parsoidInfo['changedTitle'] = $this->title->getPrefixedDBkey(); + $parsoidInfo['mode'] = $this->params['table'] == 'templatelinks' ? + 'templates' : 'files'; + + # Build an array of update requests + $requests = array(); + foreach ( $wgParsoidCacheServers as $server ) { + foreach ( $titleArray as $title ) { + # TODO, but low prio: if getLatestRevID returns 0, only purge title (deletion). + # Low prio because VE would normally refuse to load the page + # anyway, and no private info is exposed. + $url = $this->getParsoidURL( $title, $server ); + + $parsoidInfo['prevID'] = $title->getPreviousRevisionID($title->getLatestRevID()); + + $requests[] = array( + 'url' => $url, + 'headers' => array( + 'X-Parsoid: ' . json_encode( $parsoidInfo ) + ) + ); + } + } + + // Now send off all those update requests + CurlMultiClient::request( $requests ); + + wfDebug('ParsoidCacheUpdateJob::invalidateTitles update: ' . + serialize($requests) . "\n" ); + + # PURGE + # Build an array of purge requests + $requests = array(); + foreach ( $wgParsoidCacheServers as $server ) { + foreach ( $titleArray as $title ) { + $url = $this->getParsoidURL( $title, $server, true ); + + $requests[] = array( + 'url' => $url + ); + } + } + + $options = CurlMultiClient::getDefaultOptions(); + $options[CURLOPT_CUSTOMREQUEST] = "PURGE"; + // Now send off all those purge requests + CurlMultiClient::request( $requests, $options ); + + wfDebug('ParsoidCacheUpdateJob::invalidateTitles purge: ' . + serialize($requests) . "\n" ); + } +} -- To view, visit https://gerrit.wikimedia.org/r/60941 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I47331bf638dc93cf444ceeecb89ef9f4c3f40ae3 Gerrit-PatchSet: 9 Gerrit-Project: mediawiki/extensions/Parsoid Gerrit-Branch: master Gerrit-Owner: GWicke <[email protected]> Gerrit-Reviewer: Cscott <[email protected]> Gerrit-Reviewer: GWicke <[email protected]> Gerrit-Reviewer: Subramanya Sastry <[email protected]> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
