MediaWiki-API-0.52/0000755000175000017500000000000013757457253012772 5ustar joolsjoolsMediaWiki-API-0.52/MANIFEST0000644000175000017500000000047713757457253014133 0ustar joolsjoolsChanges CONTRIBUTING.md LICENSE MANIFEST Makefile.PL README lib/MediaWiki/API.pm t/00-load.t t/10-api.t t/98-pod-coverage.t t/99-pod.t t/testimage.png META.yml Module YAML meta-data (added by MakeMaker) META.json Module JSON meta-data (added by MakeMaker) MediaWiki-API-0.52/Changes0000644000175000017500000002620713757457176014300 0ustar joolsjoolsRevision history for MediaWiki-API 0.52 2020-11-25 Fix version number in POD. 0.51 2020-11-22 Minor packaging changes. 0.50 2020-11-22 Rework and simplify the token code using the newer MW 1.24+ api.php?action=query&meta=tokens call. Use a token by default for the login function (by just calling edit with action=login). Updated Wikipedia URLs in examples to https:// Remove "Purge" from get_actions as it requires a POST method. Updated TestWiki / ExoticA URLs to https:// Thanks to Nataraj for the Wikipedia URL changes and Sebastian for the Purge info. 0.41 2015-11-13 When using the max_lag configuration, if max_lag_retries was reached - the reported number tries were incorrect. Fixed up the api->list function not continuing due to lack of rawcontinue parameter that is needed after MediaWiki 1.26. Thanks to Derbeth for the bug reports. 0.40 2014-09-13 Apologies for the lack of updates and the speed to implement some fixes but I have been busy on other projects. Edit token code has been reworked somewhat to make it simpler, and a bugfix applied for an issue with downloading images over https using the buildin Download() function. 0.39 2012-05-20 Added automatic support for handling tokens in the MediaWiki::API->Edit function for (Un)watch, Send e-mail and Patrol changes. (Un)watch already worked but wasn't documented. 0.38 2012-05-19 Allow the actions the API supports with an http GET request to be configurable. MediaWiki::API->{config}->{get_actions} defaults to { 'query' => 1, 'logout' => 1, purge' => 1, 'paraminfo' => 1 } but can be added to/ammended as needed for any extensions that add additional functions to the API that support a GET request. Make the version of Test::More required to be 0.98 to avoid an issue with older versions missing functionality (eg. on centos 5.x). 0.37 2011-08-10 The MediaWiki::API->Edit call was not getting a token correctly for an import action. Thanks to Mike Lifeguard for the report. 0.36 2011-08-07 Since 1.16 MediaWiki now supports uploading files via the API, we no longer need to post directly to Special:Upload. Although now the MediaWiki::API->Upload function will use the api to upload if using a recent mediawiki, it has also been deprecated, as uploads can be done directly via the MediaWiki::API->API call, or if you prefer MediaWiki::API->Edit (where it will automatically get a token for you). Thanks to Jeremy Muhlich for the original patch. Some details about uploading files via the API / Edit calls can be found in the API section of the pod documentation. There are now some tests included with the module. They run a few api functions against a test wiki - http://testwiki.exotica.org.uk to make sure everything is working correctly. Feel free to use this wiki for testing the module with your own code also. It is wiped/cleaned regularly. 0.35 2010-08-29 The module now is a little bit more intelligent about utf-8 strings. If you have the "use utf8" pragma set in your code and pass utf-8 strings in the query, you no longer need to set the skip_encoding config option. The option is only needed if you are passing utf-8 strings but the utf-8 flag is not set on the strings. Note that this may not work correctly if the version of URI module is less than 1.36, and in that case you may well need to specify skip_encoding still (The module does contains a workaround however for older URI versions). Thanks to Nikolay Shaplov for patches and testing relating to this new functionality. 0.34 2010-07-25 if skip_encoding encoding was used in conjuctions with use_http_get the querystring was not correctly encoded (parameters were not treated as utf8). Thanks to Nikolay Shaplov for reporting the problem. 0.33 2010-06-09 Download function checked for image description, instead of checking for imageinfo. This meant that some images were not downloaded. Thanks to "ke" for reporting this problem 0.32 2010-06-05 Config options passed when creating a new instance of the mediawiki api object were overwritten with default values. Now fixed. Thanks to Brian for reporting this problem. Note the version number has been bumped twice since I forgot to update this changes file for 0.31. oops. 0.30 2010-04-08 MediaWiki >= 1.15.3 and MediaWiki >= 1.16.0beta2 now require a login token to be sent when logging in. Please see https://bugzilla.wikimedia.org/show_bug.cgi?id=23076 for more details. The MediaWiki::API login method is now adjusted to handle this automatically. Thanks to Brent Garber for the heads up and the patch which I used with some minor modifications. 0.29 2010-01-10 Module will now use any proxy settings if set in the environment. To force the module not to use a proxy even if set there is a new configuration option MediaWiki::API->{config}->{noproxy} that can be set. Thanks to Andy Jenkinson for the suggestion and patch. 0.28 2009-09-09 The skip_encoding option was ignored for the list function. Thanks to Estelle for reporting the problem. 0.27 2009-05-14 Updated README installation instructions including some notes for building debian packages and dependencies. Fixed old reference to JSON::XS 0.26 2009-05-12 A new configuration option $mw->{config}->{use_http_get} to tell the module to use http GET requests for those API calls that allow it. By default the module will use POST for all API requests. Fixes bug #45974. Switched the module to ask for the JSON module and not specifically JSON::XS. If JSON::XS is available the JSON module will use it by default, but if not it will fallback to a pure perl JSON parser. 0.25 2009-03-19 Support the skip_encoding option in the list and edit calls. Thanks to Brent Garber for reporting this problem. 0.24 2009-01-13 MediaWiki::API->list was returning an array instead of arraref when no results/warning from api. 0.23 2008-12-09 Was passing parameter to Response->decoded_content as hashref instead of hash. Thanks to Dan Collins for the report. 0.22 2008-11-20 Reworked the http connection and errors handling code to be more resiliant (and removed some bugs). Fixed up some copy and paste documentation errors. Note that this version needs some testing. It should be more resialiant than the old version, which in some respects had slightly wrong error handling (I was cutting corners a bit). 0.21 2008-11-20 Fixed some errors in the documentation including one which caused the module to fail a POD check. 0.20 2008-11-19 The retry limit was reached whether or not the mediawiki api.php returned valid data. Oops. That's what I get for not testing new features properly. Now returns the response object as part of the MediaWiki::API object in case the user wants direct access to data returned by the mediawiki api.php such as cookies etc. Now the API doesn't try and encode undefined parameters sent to the API, which was causing the Encode module to spit out warnings. Small improvement to documentation including the new features. Thanks to Dan Collins and Dan Bolser for bug reports and feedback. 0.19 2008-11-01 Removed debug line. oops! 0.18 2008-11-01 Fixed small error with the on_error example. It showed to use $mw->{on_error} instead of $mw->{config}->{on_error}. Improved http error messages. 0.17 2008-10-30 My understanding on the way rollback worked was flawed. The rollback call always rolled back the last users edit for a page, whereas it should only rollback "the requested" users edits if they were the last editor for a page. This is now fixed. The timestamp code for editing was also broken. By default the edit call will not handle any conflicts for you. When you get the contents of a page, you should save the timestamp and pass this back to the edit call, which will give you an error if someone else had edited the page in the meantime (or at least if their edit has caused a conflict) Big thanks to Steve Sanbeg for help/support/patches and bringing these problems to my attention. 0.16 2008-10-16 Licensed the code under GPL v3. Added support for maxlag (see http://www.mediawiki.org/wiki/Manual:Maxlag_parameter). This is controlled with configuration options 'max_lag', 'max_lag_retries' and 'max_lag_delay'. There are two more configuration options to deal with http or connection problems. These are 'retries' and 'retry_delay'. There is an additional error field now {error}->{stacktrace) which contains a Carp stacktrace to aid with debugging. For help on using these new configuration parameters please see the documentation. Thanks to Dan Collins for the maxlag suggestion/report. 0.15 2008-10-12 Internal test release with some new options. 0.14 2008-09-21 Module now traps and reports errors with the JSON decoding. This helps if for some reason api.php returns an error (such as a PHP error) rather than JSON formatted data. Thanks to Steve Sanbeg for this patch. 0.13 2008-08-10 As requested by Kjell, an option has been added to the api call to skip encoding of parameters to utf-8. 0.12 2008-07-30 I shouldn't rush things. Removed a debug line I left in. 0.11 2008-07-30 Fixed a big bug where I was returning a failure when getting edit tokens if the page didn't exist. This certainly doesn't make sense when you are creating a page! The consequences were it was actually impossible to create a new page. Thanks to Stuart Caie for the patch. 0.10 2008-07-14 Some fixes to documentation examples (Were not updated after some changes in the interface). 0.09 2008-07-13 Automatically encode API parameter values to utf-8. 0.08 2008-06-30 A lot of releases for one day I know. Minor stuff again, but some dependencies had been left out of the makefile which mean't the module was failing some automatic testing. Also made the config options a bit more clear in the documentation. 0.07 2008-06-30 Fixed a bug in some of the example code which was written when using XML::Simple (which meant a lightly different returned hash structure). 0.06 2008-06-30 Fixed documentation to pass pod test. 0.05 2008-06-29 Various code cleanups and fixes. Documentation improvements. Addition of download function. 0.04 2008-06-27 Switched to json api and JSON::XS module. Faster than using XML. Added GZIP header/support. 0.03 2008-06-18 First version. Includes some documentation for functions and probably lots of bugs. MediaWiki-API-0.52/CONTRIBUTING.md0000644000175000017500000000035613756550025015215 0ustar joolsjoolsThe latest source/development version is available at https://github.com/joolswills/mediawikiapi Please submit any fixes/patches as Pull Requests. For large changes or feature additions please open an issue and start a discussion first.MediaWiki-API-0.52/META.json0000664000175000017500000000212113757457253014411 0ustar joolsjools{ "abstract" : "Provides a Perl interface to the MediaWiki API (https://www.mediawiki.org/wiki/API)", "author" : [ "Jools Wills " ], "dynamic_config" : 1, "generated_by" : "ExtUtils::MakeMaker version 7.34, CPAN::Meta::Converter version 2.150010", "license" : [ "gpl_3" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "MediaWiki-API", "no_index" : { "directory" : [ "t", "inc" ] }, "prereqs" : { "build" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "runtime" : { "requires" : { "Carp" : "0", "Encode" : "0", "JSON" : "0", "LWP::UserAgent" : "0", "Test::More" : "0.98" } } }, "release_status" : "stable", "version" : "0.52", "x_serialization_backend" : "JSON::PP version 4.02" } MediaWiki-API-0.52/README0000644000175000017500000000515613756547547013666 0ustar joolsjoolsMediaWiki-API This module provides an interface between perl and the MediaWiki API (https://www.mediawiki.org/wiki/API) allowing creation of scripts to automate editing and extraction of data from MediaWiki driven sites like Wikipedia. The latest source/development version is available at https://github.com/joolswills/mediawikiapi STANDARD INSTALLATION This module requires the following perl modules LWP::UserAgent URI::Escape JSON Encode Carp and optionally JSON::XS for faster JSON decoding. To install this module, run the following commands: perl Makefile.PL make make test make install Note: make test will make some edits on https://testwiki.exotica.org.uk/wiki/Main_Page to check that it is working correctly. This will leave some data (including ip address) on the wiki (which is cleaned regularly). If you do not want this, please skip the "make test". CREATING DEBIAN PACKAGE / INSTALLING ON DEBIAN Please note that Debian squeeze and Ubuntu Karmic already have a package with this module. Note that this module requires the packages libwww-perl, libjson-perl, and optionally libjson-xs-perl for faster JSON decoding. On a debian system, you can easily generate a debian package to install. To do this make sure you have the package "dh-make-perl" installed. Unpack the MediaWiki-API-x.xx.tar.gz and run dh-make-perl dpkg-buildpackage If everything works successfully you should have a deb file created in the parent folder. SUPPORT AND DOCUMENTATION After installing, you can find documentation for this module with the perldoc command. perldoc MediaWiki::API You can also look for information at: RT, CPAN's request tracker http://rt.cpan.org/NoAuth/Bugs.html?Dist=MediaWiki-API AnnoCPAN, Annotated CPAN documentation http://annocpan.org/dist/MediaWiki-API CPAN Ratings http://cpanratings.perl.org/d/MediaWiki-API Search CPAN http://search.cpan.org/dist/MediaWiki-API COPYRIGHT AND LICENCE Copyright (C) 2009 - 2014 Jools Wills 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 3 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, see . MediaWiki-API-0.52/META.yml0000664000175000017500000000124313757457253014245 0ustar joolsjools--- abstract: 'Provides a Perl interface to the MediaWiki API (https://www.mediawiki.org/wiki/API)' author: - 'Jools Wills ' build_requires: ExtUtils::MakeMaker: '0' configure_requires: ExtUtils::MakeMaker: '0' dynamic_config: 1 generated_by: 'ExtUtils::MakeMaker version 7.34, CPAN::Meta::Converter version 2.150010' license: gpl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: MediaWiki-API no_index: directory: - t - inc requires: Carp: '0' Encode: '0' JSON: '0' LWP::UserAgent: '0' Test::More: '0.98' version: '0.52' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' MediaWiki-API-0.52/t/0000755000175000017500000000000013757457253013235 5ustar joolsjoolsMediaWiki-API-0.52/t/99-pod.t0000644000175000017500000000035012344243631014421 0ustar joolsjools#!perl -T use strict; use warnings; use Test::More; # Ensure a recent version of Test::Pod my $min_tp = 1.22; eval "use Test::Pod $min_tp"; plan skip_all => "Test::Pod $min_tp required for testing POD" if $@; all_pod_files_ok(); MediaWiki-API-0.52/t/00-load.t0000644000175000017500000000023112344243631014532 0ustar joolsjools#!perl -T use Test::More tests => 1; BEGIN { use_ok( 'MediaWiki::API' ); } diag( "Testing MediaWiki::API $MediaWiki::API::VERSION, Perl $], $^X" ); MediaWiki-API-0.52/t/98-pod-coverage.t0000644000175000017500000000106212344243631016212 0ustar joolsjools#!perl -T use strict; use warnings; use Test::More; # Ensure a recent version of Test::Pod::Coverage my $min_tpc = 1.08; eval "use Test::Pod::Coverage $min_tpc"; plan skip_all => "Test::Pod::Coverage $min_tpc required for testing POD coverage" if $@; # Test::Pod::Coverage doesn't require a minimum Pod::Coverage version, # but older versions don't recognize some common documentation styles my $min_pc = 0.18; eval "use Pod::Coverage $min_pc"; plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage" if $@; all_pod_coverage_ok(); MediaWiki-API-0.52/t/testimage.png0000644000175000017500000000326312344243631015711 0ustar joolsjoolsPNG  IHDRL\sRGBmIDATx1k@/B)D pPph6)ŏСC>Pǀ-Z\LqPQptwXkjL<`uuuyy sV{yyi۶#Q BXv*p8Lp\VUt vb1'XLQn dYvx(ӓk V$!#IRZu{65ͱ`Pz{{;WEA@Q33@Ut:\D:)"Yor)www6jr9jr\rJaT*2y{G^K$Ri^4`2 d2ci("#i v : N"s>s2!/ЩsGSEIsS jͨJ5\!ZG< MySk pq~nю"yy\SU>:QYŁޖp; @Z v<t:!h1N/~b-/-0G_ *Ѕ|-|>@Z6 ,q -8c#AH$FQhyl<!hd2 B"LBQ&A[ 5!d@貳l6 rGEy<١=z{:lРvƦ S(@lP,A| TɳM&|ssҐpTyv*:HwXǷ[nEw`YF#Gvs>8> [ ڇу[# t_p|=\@38&Va tp , 24eWe&2OT,.t> [.t+ bz yzmd}"d29Uϓ k&( ӌznew; $ua->timeout(10); $ua->env_proxy; my $response = $ua->get($url); return $response; } my $api_url = 'https://testwiki.exotica.org.uk/w/api.php'; my $response = get_url($api_url); if ($response->is_success) { plan tests => 11; } else { plan skip_all => "Can't access $api_url to run tests"; } use_ok( 'MediaWiki::API' ); my $mw = MediaWiki::API->new( { api_url => $api_url } ); isa_ok( $mw, 'MediaWiki::API' ); $mw->{config}->{upload_url} = 'https://testwiki.exotica.org.uk/wiki/Special:Upload'; my $ref; ok ( $ref = $mw->api( { action => 'query', meta => 'siteinfo' } ), '->api siteinfo call' ); is ( $ref->{query}->{general}->{server}, 'https://testwiki.exotica.org.uk', '->api siteinfo server' ); ok ( $mw->api( { action => 'query', list => 'allcategories' } ), '->list allcategories' ); my $time = time; my $title = 'apitest/' . $time; my $content = "* Version: $MediaWiki::API::VERSION\n\nthe quick brown fox jumps over the lazy dog"; ok ( $mw->edit( { action => 'edit', title => $title, text => $content, summary => 'MediaWiki::API Test suite - edit page', bot => 1 } ), '->edit ' . $title ); ok ( $ref = $mw->get_page( { title => $title } ), "->get_page $title call" ); is ( $ref->{'*'}, $content, "->get_page $title content" ); ok ( $mw->edit( { action => 'move', from => $title, to => $title . '-moved', summary => 'MediaWiki::API Test suite - move page', bot => 1 } ), '->edit action=move ' . $title ); $title = $title . '-moved'; ok ( $mw->edit( { action => 'delete', title => $title, summary => 'MediaWiki::API Test suite - delete page', bot => 1 } ), '->edit action=delete ' . $title ); $title = "apitest - $time.png"; ok ( $mw->edit( { action => 'upload', filename => $title, comment => 'MediaWiki::API Test suite - upload image', file => [ 't/testimage.png'], ignorewarnings => 1, bot => 1 } ), "->edit action=upload $title" ); done_testing(); MediaWiki-API-0.52/Makefile.PL0000644000175000017500000000122613756547324014743 0ustar joolsjoolsuse strict; use warnings; use ExtUtils::MakeMaker; WriteMakefile( NAME => 'MediaWiki::API', AUTHOR => 'Jools Wills ', VERSION_FROM => 'lib/MediaWiki/API.pm', ABSTRACT_FROM => 'lib/MediaWiki/API.pm', LICENSE => 'gpl_3', PL_FILES => {}, PREREQ_PM => { 'Test::More' => 0.98, 'JSON' => 0, 'LWP::UserAgent' => 0, 'Encode' => 0, 'Carp' => 0 }, dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', }, clean => { FILES => 'MediaWiki-API-*' }, ); MediaWiki-API-0.52/lib/0000755000175000017500000000000013757457253013540 5ustar joolsjoolsMediaWiki-API-0.52/lib/MediaWiki/0000755000175000017500000000000013757457253015403 5ustar joolsjoolsMediaWiki-API-0.52/lib/MediaWiki/API.pm0000644000175000017500000010576413757456713016367 0ustar joolsjoolspackage MediaWiki::API; use warnings; use strict; # our required modules use LWP::UserAgent; use URI::Escape; use Encode; use JSON; use Carp; # just for debugging the module # use Data::Dumper; # use Devel::Peek; use constant { ERR_NO_ERROR => 0, ERR_CONFIG => 1, ERR_HTTP => 2, ERR_API => 3, ERR_LOGIN => 4, ERR_EDIT => 5, ERR_PARAMS => 6, ERR_UPLOAD => 7, ERR_DOWNLOAD => 8, DEF_RETRIES => 0, DEF_RETRY_DELAY => 0, DEF_MAX_LAG => undef, DEF_MAX_LAG_RETRIES => 4, DEF_MAX_LAG_DELAY => 5, USE_HTTP_GET => 0 }; =head1 NAME MediaWiki::API - Provides a Perl interface to the MediaWiki API (https://www.mediawiki.org/wiki/API) =head1 VERSION Version 0.52 =cut our $VERSION = "0.52"; =head1 SYNOPSIS This module provides an interface between Perl and the MediaWiki API (https://www.mediawiki.org/wiki/API) allowing creation of scripts to automate editing and extraction of data from MediaWiki driven sites like Wikipedia. use MediaWiki::API; my $mw = MediaWiki::API->new(); $mw->{config}->{api_url} = 'https://en.wikipedia.org/w/api.php'; # log in to the wiki $mw->login( { lgname => 'username', lgpassword => 'password' } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; # get a list of articles in category my $articles = $mw->list ( { action => 'query', list => 'categorymembers', cmtitle => 'Category:Perl', cmlimit => 'max' } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; # and print the article titles foreach (@{$articles}) { print "$_->{title}\n"; } # get user info my $userinfo = $mw->api( { action => 'query', meta => 'userinfo', uiprop => 'blockinfo|hasmsg|groups|rights|options|editcount|ratelimits' } ); ... =head1 FUNCTIONS =head2 MediaWiki::API->new( $config_hashref ) Returns a MediaWiki API object. You can pass a config as a hashref when calling new, or set the configuration later. When creating a new object, defaults for max lag and retries are set. my $mw = MediaWiki::API->new( { api_url => 'https://en.wikipedia.org/w/api.php' } ); Configuration options are =over =item * api_url = 'Path to mediawiki api.php'; =item * files_url = 'Base url for files'; (needed if the api returns a relative URL for images like /images/a/picture.jpg) =item * upload_url = 'https://en.wikipedia.org/wiki/Special:Upload'; (path to the upload special page which is required if you want to upload images) =item * on_error = Function reference to call if an error occurs in the module. =item * use_http_get = Boolean 0 or 1 (defaults to 0). If set to 1, the perl module will use http GET method for accessing the api. By default it uses the POST method. Note that the module will still use POST for the api calls that require POST no matter what the value of this configuration option. Currently the following actions will work with GET: query, logout, paraminfo - see get_actions configuration below. =item * get_actions = Hashref (defaults to { 'query' => 1, 'logout' => 1, 'paraminfo' => 1 } ). This contains the API actions that are supported by the http GET method if it is enabled. Some wikis may have extensions that add more functions that work with an http GET request. If so, you can add actions as needed. =item * retries = Integer value; The number of retries to send an API request if an http error or JSON decoding error occurs. Defaults to 0 (try only once - don't retry). If max_retries is set to 4, and the wiki is down, the error won't be reported until after the 5th connection attempt. =item * retry_delay = Integer value in seconds; The amount of time to wait before retrying a request if an HTTP error or JSON decoding error occurs. =item * max_lag = Integer value in seconds; Wikipedia runs on a database cluster and as such high edit rates cause the slave servers to lag. If this config option is set then if the lag is more then the value of max_lag, the api will wait before retrying the request. 5 is a recommended value. More information about this subject can be found at https://www.mediawiki.org/wiki/Manual:Maxlag_parameter. note the config option includes an underscore so match the naming scheme of the other configuration options. =item * max_lag_delay = Integer value in seconds; This configuration option specified the delay to wait before retrying a request when the server has reported a lag more than the value of max_lag. This defaults to 5 if using the max_lag configuration option. =item * max_lag_retries = Integer value; The number of retries to send an API request if the server has reported a lag more than the value of max_lag. If the maximum retries is reached, an error is returned. Setting this to a negative value like -1 will mean the request is resent until the servers max_lag is below the threshold or another error occurs. Defaults to 4. =item * no_proxy = Boolean; Set to 1 to Disable use of any proxy set in the environment. Note by default if you have proxy environment variables set, then the module will attempt to use them. This feature was added at version 0.29. Versions below this ignore any proxy settings, but you can set this yourself by doing MediaWiki::API->{ua}->env_proxy() after creating a new instance of the API class. More information about env_proxy can be found at http://search.cpan.org/~gaas/libwww-perl-5.834/lib/LWP/UserAgent.pm#Proxy_attributes =back An example for the on_error configuration could be something like: $mw->{config}->{on_error} = \&on_error; sub on_error { print "Error code: " . $mw->{error}->{code} . "\n"; print $mw->{error}->{stacktrace}."\n"; die; } Errors are stored in $mw->{error}->{code} with more information in $mw->{error}->{details}. $mw->{error}->{stacktrace} includes the details and a stacktrace to locate where any problems originated from (in some code which uses this module for example). The error codes are as follows =over =item * ERR_NO_ERROR = 0 (No error) =item * ERR_CONFIG = 1 (An error with the configuration) =item * ERR_HTTP = 2 (An http related connection error) =item * ERR_API = 3 (An error returned by the MediaWiki API) =item * ERR_LOGIN = 4 (An error logging in to the MediaWiki) =item * ERR_EDIT = 5 (An error with an editing function) =item * ERR_PARAMS = 6 (An error with parameters passed to a helper function) =item * ERR_UPLOAD = 7 (An error with the file upload facility) =item * ERR_DOWNLOAD = 8 (An error with downloading a file) =back Other useful parameters and objects in the MediaWiki::API object are =over =item * MediaWiki::API->{ua} = The LWP::UserAgent object. You could modify this to get or modify the cookies (MediaWiki::API->{ua}->cookie_jar) or to change the UserAgent string sent by this perl module (MediaWiki::API->{ua}->agent) =item * MediaWiki::API->{response} = the last response object returned by the LWP::UserAgent after an API request. =back =cut sub new { my ($class, $config) = @_; # if no config passed make a new hash reference and get the default configuration parameters $config = {} if ! defined $config; my $defconfig = _get_config_defaults(); $config = {%$defconfig, %$config}; my $self = { config => $config }; my $ua = LWP::UserAgent->new(); $ua->cookie_jar({}); $ua->agent(__PACKAGE__ . "/$VERSION"); $ua->default_header("Accept-Encoding" => "gzip, deflate"); $ua->env_proxy() unless ($config->{no_proxy}); $self->{ua} = $ua; my $json = JSON->new->utf8(1); $self->{json} = $json; # initialise error code values $self->{error}->{code} = 0; $self->{error}->{details} = ''; $self->{error}->{stacktrace} = ''; bless ($self, $class); return $self; } # returns a hashref with configuration defaults sub _get_config_defaults { my %config; $config{retries} = DEF_RETRIES; $config{retry_delay} = DEF_RETRY_DELAY; $config{max_lag} = DEF_MAX_LAG; $config{max_lag_retries} = DEF_MAX_LAG_RETRIES; $config{max_lag_delay} = DEF_MAX_LAG_DELAY; $config{use_http_get} = USE_HTTP_GET; $config{get_actions} = { 'query' => 1, 'logout' => 1, 'paraminfo' => 1 }; return \%config; } =head2 MediaWiki::API->login( $query_hashref ) Logs in to a MediaWiki. Parameters are those used by the MediaWiki API (https://www.mediawiki.org/wiki/API:Login). Returns a hashref with some login details, or undef on login failure. If Mediawiki sends requests a LoginToken the login is attempted again, but with the token sent from the initial login. Errors are stored in MediaWiki::API->{error}->{code} and MediaWiki::API->{error}->{details}. my $mw = MediaWiki::API->new( { api_url => 'https://en.wikipedia.org/w/api.php' } ); #log in to the wiki $mw->login( {lgname => 'username', lgpassword => 'password' } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; =cut sub login { my ($self, $query) = @_; $query->{action} = 'login'; # attempt to login, and return undef if there was an api failure return undef unless ( my $ref = $self->edit( $query ) ); # reassign hash reference to the login section my $login = $ref->{login}; # return error if the login was not successful return $self->_error( ERR_LOGIN, 'Login Failure - ' . $login->{result} ) unless ( $login->{result} eq 'Success' ); # everything was ok so return the reference return $login; } =head2 MediaWiki::API->api( $query_hashref, $options_hashref ) Call the MediaWiki API interface. Parameters are passed as a hashref which are described on the MediaWiki API page (https://www.mediawiki.org/wiki/API). returns a hashref with the results of the call or undef on failure with the error code and details stored in MediaWiki::API->{error}->{code} and MediaWiki::API->{error}->{details}. MediaWiki::API uses the LWP::UserAgent module to send the http requests to the MediaWiki API. After any API call, the response object returned by LWP::UserAgent is available in $mw->{response}. This function will NOT modify the input query_hashref in any way. binmode STDOUT, ':utf8'; # get the name of the site if ( my $ref = $mw->api( { action => 'query', meta => 'siteinfo' } ) ) { print $ref->{query}->{general}->{sitename}; } # list of titles for "Albert Einstein" in different languages. my $titles = $mw->api( { action => 'query', titles => 'Albert Einstein', prop => 'langlinks', lllimit => 'max' } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; my ($pageid,$langlinks) = each ( %{ $titles->{query}->{pages} } ); foreach ( @{ $langlinks->{langlinks} } ) { print "$_->{'*'}\n"; } MediaWiki's API uses UTF-8 and any 8 bit character string parameters are encoded automatically by the API call. If your parameters are already in UTF-8 this will be detected and the encoding will be skipped. If your parameters for some reason contain UTF-8 data but no UTF-8 flag is set (i.e. you did not use the "use utf8;" pragma) you should prevent re-encoding by passing an option skip_encoding => 1 in the $options_hash. For example: my $mw = MediaWiki::API->new(); $mw->{config}->{api_url} = 'https://fr.wiktionary.org/w/api.php'; my $query = {action => 'query', list => 'categorymembers', cmlimit => 'max'}; $query->{cmtitle} ="Cat\x{e9}gorie:moyen_fran\x{e7}ais"; # latin1 string $mw->list ( $query ); # ok $query->{cmtitle} = "Cat". pack("U", 0xe9)."gorie:moyen_fran".pack("U",0xe7)."ais"; # unicode string $mw->list ( $query ); # ok $query->{cmtitle} ="Cat\x{c3}\x{a9}gorie:moyen_fran\x{c3}\x{a7}ais"; # unicode data without utf-8 flag # $mw->list ( $query ); # NOT OK $mw->list ( $query, {skip_encoding => 1} ); # ok If you are calling an API function which requires a file upload, e.g. import or upload, specify the file to upload as an arrayref containing the local filename. The API may return a warning, for example to say the file is a duplicate. To ignore warnings and force an upload, use ignorewarnings => 1. All the parameters as with everything else can be found on the MediaWiki API page. $mw->api( { action => 'import', xml => ['wiki_dump.xml'] } ); $mw->api( { action => 'upload', filename => 'test.png', comment => 'a test image', file => ['test.png'], } ); You can also give the data to be uploaded directly, should you want to read the data in yourself. In this case, supply an arrayref with three parameters, starting with an "undef", followed by the filename, and then a Content => $data pair containing the data. $mw->api( { action => 'import', xml => [ undef, 'wiki_dump.xml', Content => $data ] } ); $mw->api( { action => 'upload', filename => 'test.png', comment => 'a test image', file => [ undef, 'test.png', Content => $data ], } ); =cut sub api { my ($self, $query, $options) = @_; return $self->_error(ERR_CONFIG, "You need to give the URL to the mediawiki API php.") unless $self->{config}->{api_url}; my $retries = $self->{config}->{retries}; my $maxlagretries = 1; $self->_encode_hashref_utf8($query, $options->{skip_encoding}); $query->{maxlag} = $self->{config}->{max_lag} if defined $self->{config}->{max_lag}; $query->{format}='json'; # if the config is set to use GET we need to contruct a querystring. some actions are "POST" only - # edit, move, action = rollback, action = undelete, action = my $querystring = ''; if ( $self->{config}->{use_http_get} && $self->{config}->{get_actions}->{$query->{action}} ) { $querystring = _make_querystring( $query ); } my $ref; while (1) { # connection retry loop. foreach my $try (0 .. $retries) { # if we are already retrying, then wait the specified delay if ( $try > 0 ) { sleep $self->{config}->{retry_delay}; } my $response; my %headers; # if we are using the get method ($querystring is set above) if ( $querystring ) { $response = $self->{ua}->get( $self->{config}->{api_url} . $querystring, %headers ); } else { $headers{'content-type'} = 'form-data' if $query->{action} eq 'upload' || $query->{action} eq 'import'; $response = $self->{ua}->post( $self->{config}->{api_url}, $query, %headers ); } $self->{response} = $response; # if the request was successful then check the returned content and decode. if ( $response->is_success ) { my $decontent = $response->decoded_content( charset => 'none' ); if ( ! defined $decontent ) { return $self->_error(ERR_HTTP,"Unable to decode content returned by $self->{config}->{api_url} - Unknown content encoding?") if ( $try == $retries ); next; } if ( length $decontent == 0 ) { return $self->_error(ERR_HTTP,"$self->{config}->{api_url} returned a zero length string") if ( $try == $retries ); next; } # decode the json trapping any errors eval { $ref = $self->{json}->decode($decontent); }; if ( $@) { # an error occurred, so we check if we need to retry and continue my $error = $@; return $self->_error(ERR_HTTP,"Failed to decode JSON returned by $self->{config}->{api_url}\nDecoding Error:\n$error\nReturned Data:\n$decontent") if ( $try == $retries ); next; } else { # no error so we want out of the retry loop last; } # if the request was not successful then we retry or return a failure if the maximum retries # have been reached, otherwise we try again } else { return $self->_error(ERR_HTTP, $response->status_line . " : error occurred when accessing $self->{config}->{api_url} after " . ($try+1) . " attempt(s)") if ( $try == $retries ); next; } } return $self->_error(ERR_API,"API has returned an empty array reference. Please check your parameters") if ( ref($ref) eq 'ARRAY' && scalar @{$ref} == 0); # check lag and wait if (ref($ref) eq 'HASH' && exists $ref->{error} && $ref->{error}->{code} eq 'maxlag' ) { if ($maxlagretries == $self->{config}->{max_lag_retries}) { return $self->_error(ERR_API,"Server has reported lag above the configured max_lag value of " . $self->{config}->{max_lag} . " value after " . $self->{config}->{max_lag_retries} . " attempt(s). Last reported lag was - ". $ref->{'error'}->{'info'}) } else { sleep $self->{config}->{max_lag_delay}; $maxlagretries++ if $maxlagretries < $self->{config}->{max_lag_retries}; # redo the request next; } } # if we got this far, then we have a hashref from the api and we want out of the while loop last; } return $self->_error(ERR_API,$ref->{error}->{code} . ": " . $ref->{error}->{info} ) if ( ref($ref) eq 'HASH' && exists $ref->{error} ); return $ref; } =head2 MediaWiki::API->logout() Log the current user out and clear associated cookies and edit tokens. =cut sub logout { my ($self) = @_; # clear login cookies $self->{ua}->{cookie_jar} = undef; # clear cached tokens $self->{config}->{tokens} = undef; } =head2 MediaWiki::API->edit( $query_hashref, $options_hashref ) A helper function for doing edits using the MediaWiki API. Parameters are passed as a hashref which are described on the MediaWiki API editing page (https://www.mediawiki.org/wiki/API:Changing_wiki_content). Note that you need $wgEnableWriteAPI = true in your LocalSettings.php to use these features. This function will modify the input hashref. Currently =over =item * Create/Edit pages (Mediawiki >= 1.13 ) =item * Move pages (Mediawiki >= 1.12 ) =item * Rollback (Mediawiki >= 1.12 ) =item * Delete pages (Mediawiki >= 1.12 ) =item * Upload images (Mediawiki >= 1.16 ) =item * Import pages (Mediawiki >= 1.15 ) =item * (Un)protect pages (Mediawiki >= 1.12 ) =item * (Un)block users (Mediawiki >= 1.12 ) =item * (Un)watch a page (Mediawiki >= 1.18 ) =item * Email user (Mediawiki >= 1.14 ) =item * Patrol changes (Mediawiki >= 1.14 ) =back are supported via this call. Use this call to edit pages without having to worry about getting an edit token from the API first. The function will cache edit tokens to speed up future edits. Returns a hashref with the results of the call or undef on failure with the error code and details stored in MediaWiki::API->{error}->{code} and MediaWiki::API->{error}->{details}. The options hashref currently has one optional parameter (skip_encoding => 1). This is described above in the MediaWiki::API->api call documentation. Here are some example snippets of code. The first example is for adding some text to an existing page (if the page doesn't exist nothing will happen). Note that the timestamp for the revision we are changing is saved. This allows us to avoid edit conflicts. The value is passed back to the edit function, and if someone had edited the page in the meantime, an error will be returned. my $pagename = "Wikipedia:Sandbox"; my $ref = $mw->get_page( { title => $pagename } ); unless ( $ref->{missing} ) { my $timestamp = $ref->{timestamp}; $mw->edit( { action => 'edit', title => $pagename, basetimestamp => $timestamp, # to avoid edit conflicts text => $ref->{'*'} . "\nAdditional text" } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; } The following code deletes a page with the name "DeleteMe". You can specify a reason for the deletion, otherwise a generated reason will be used. # delete a page $mw->edit( { action => 'delete', title => 'DeleteMe', reason => 'no longer needed' } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; This code moves a page from MoveMe to MoveMe2. # move a page $mw->edit( { action => 'move', from => 'MoveMe', to => 'MoveMe2' } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; The following scrippet rolls back one or more edits from user MrVandal. If the user is not the last editor of the page, an error will be returned. If no user is passed, the edits for whoever last changed the page will be rolled back. $mw->edit( { action => 'rollback', title => 'Sandbox', user => 'MrVandal' } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; =cut sub edit { my ($self, $query, $options) = @_; # choose token type and parameter name depending on action # token types are createaccount, csrf, login, patrol, rollback, userrights, watch my $action = $query->{action}; my $token_type = 'csrf'; my $token_param = 'token'; if ( $action eq 'createaccount' ) { $token_type = 'createaccount'; $token_param = 'createtoken'; } elsif ( $action eq 'login' ) { $token_type = 'login'; $token_param = 'lgtoken'; } elsif ( $action eq 'patrol' ) { $token_type = 'patrol'; } elsif ( $action eq 'rollback' ) { $token_type = 'rollback'; } elsif ( $action eq 'userrights' ) { $token_type = 'userrights'; } # get a token return undef unless ( my $token = $self->_get_token( $token_type ) ); # set the token $query->{$token_param} = $token; # do the edit return undef unless ( my $ref = $self->api( $query, $options ) ); return $ref; } =head2 MediaWiki::API->get_page( $params_hashref ) A helper function for getting the most recent page contents (and other metadata) for a page. It calls the lower level api function with a revisions query to get the most recent revision. # get some page contents my $page = $mw->get_page( { title => 'Main Page' } ); # print page contents print $page->{'*'}; Returns a hashref with the following keys or undef on an error. If the page is missing then the returned hashref will contain only ns, title and a key called "missing". =over =item * '*' - contents of page =item * 'pageid' - page id of page =item * 'revid' - revision id of page =item * 'timestamp' - timestamp of revision =item * 'user' - user who made revision =item * 'title' - the title of the page =item * 'ns' - the namespace the page is in =item * 'size' - size of page in bytes =back Full information about these can be read on (https://www.mediawiki.org/wiki/API:Query_-_Properties#revisions_.2F_rv) =cut sub get_page { my ($self, $params) = @_; return undef unless ( my $ref = $self->api( { action => 'query', prop => 'revisions', titles => $params->{title}, rvprop => 'ids|flags|timestamp|user|comment|size|content' } ) ); # get the page id and the page hashref with title and revisions my ($pageid, $pageref) = each %{ $ref->{query}->{pages} }; # get the first revision my $rev = @{ $pageref->{revisions } }[0]; # delete the revision from the hashref delete($pageref->{revisions}); # if the page is missing then return the pageref return $pageref if ( defined $pageref->{missing} ); # combine the pageid, the latest revision and the page title into one hash return { 'pageid'=>$pageid, %{ $rev }, %{ $pageref } }; } =head2 MediaWiki::API->list( $query_hashref, $options_hashref ) A helper function for getting lists using the MediaWiki API. Parameters are passed as a hashref which are described on the MediaWiki API editing page (https://www.mediawiki.org/wiki/API:Query_-_Lists). This function modifies the input query_hashref. This function will return a reference to an array of hashes or undef on failure. It handles getting lists of data from the MediaWiki api, continuing the request with another connection if needed. The options_hashref currently has three parameters: =over =item * max => value =item * hook => \&function_hook =item * skip_encoding => 1 =back The value of max specifies the maximum "queries" which will be used to pull data out. For example the default limit per query is 10 items, but this can be raised to 500 for normal users and higher for sysops and bots. If the limit is raised to 500 and max was set to 2, a maximum of 1000 results would be returned. If you wish to process large lists, for example the articles in a large category, you can pass a hook function, which will be passed a reference to an array of results for each query connection. The skip_encoding parameter works as described above in the MediaWiki::API->api call documentation. binmode STDOUT, ':utf8'; # process the first 400 articles in the main namespace in the category "Surnames". # get 100 at a time, with a max of 4 and pass each 100 to our hook. $mw->list ( { action => 'query', list => 'categorymembers', cmtitle => 'Category:Surnames', cmnamespace => 0, cmlimit=>'100' }, { max => 4, hook => \&print_articles } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; # print the name of each article sub print_articles { my ($ref) = @_; foreach (@$ref) { print "$_->{title}\n"; } } =cut sub list { my ($self, $query, $options) = @_; my ($ref, @results); my ($cont_key, $cont_value, $array_key); my $list = $query->{list}; $options->{max} = 0 if ( !defined $options->{max} ); $query->{'rawcontinue'} = ''; my $continue = 0; my $count = 0; do { return undef unless ( $ref = $self->api( $query, $options ) ); # return (empty) arrayref if there are no results return \@results unless ( $ref->{query}->{$list} ); # check if there are more results to be had if ( exists( $ref->{'query-continue'} ) ) { # get query-continue hashref and extract key and value (key will be used as from parameter to continue where we left off) ($cont_key, $cont_value) = each( %{ $ref->{'query-continue'}->{$list} } ); $query->{$cont_key} = $cont_value; $continue = 1; } else { $continue = 0; } if ( defined $options->{hook} ) { $options->{hook}( $ref->{query}->{$list} ); } else { push @results, @{ $ref->{query}->{$list} }; } $count += 1; } until ( ! $continue || $count >= $options->{max} && $options->{max} != 0 ); return 1 if ( defined $options->{hook} ); return \@results; } =head2 MediaWiki::API->upload( $params_hashref ) This function is deprecated. For uploading on mediawiki versions 1.16 or later, you are recommended to use MediaWiki::API->edit or MediaWiki::API->api directly, which has much better error handling, and supports uploading files by just passing a filename. A function to upload files to a MediaWiki. This function does not use the MediaWiki API currently as support for file uploading is not yet implemented. Instead it uploads using the Special:Upload page, and as such an additional configuration value is needed. my $mw = MediaWiki::API->new( { api_url => 'https://en.wikipedia.org/w/api.php' } ); # configure the special upload location. $mw->{config}->{upload_url} = 'https://en.wikipedia.org/wiki/Special:Upload'; The upload function is then called as follows # upload a file to MediaWiki open FILE, "myfile.jpg" or die $!; binmode FILE; my ($buffer, $data); while ( read(FILE, $buffer, 65536) ) { $data .= $buffer; } close(FILE); $mw->upload( { title => 'file.jpg', summary => 'This is the summary to go on the Image:file.jpg page', data => $data } ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; Error checking is limited. Also note that the module will force a file upload, ignoring any warning for file size or overwriting an old file. =cut sub upload { my ($self, $params) = @_; # get the version of mediawiki running, and if less than 1.16 use the old upload mechanism my $mwver = $self->_get_version; $mwver =~ /(\d+)\.(\d+)/; if ( $1 == 1 && $2 < 16 ) { return $self->_upload_old($params); } my $query; $query->{action} = 'upload'; $query->{filename} = $params->{title}; $query->{comment} = $params->{summary}; $query->{file} = [ undef, $params->{title}, Content => $params->{data} ]; $query->{ignorewarnings} = 1; return $self->edit($query); } sub _upload_old { my ($self, $params) = @_; return $self->_error(ERR_CONFIG,"You need to give the URL to the mediawiki Special:Upload page.") unless $self->{config}->{upload_url}; my $response = $self->{ua}->post( $self->{config}->{upload_url}, Content_Type => 'multipart/form-data', Content => [ wpUploadFile => [ undef, $params->{title}, Content => $params->{data} ], wpSourceType => 'file', wpDestFile => $params->{title}, wpUploadDescription => $params->{summary}, wpUpload => 'Upload file', wpIgnoreWarning => 'true', ] ); return $self->_error(ERR_UPLOAD,"There was a problem uploading the file - $params->{title}") unless ( $response->code == 302 ); return 1; } =head2 MediaWiki::API->download( $params_hashref ) A function to download images/files from a MediaWiki. A file url may need to be configured if the api returns a relative URL. my $mw = MediaWiki::API->new( { api_url => 'https://www.exotica.org.uk/mediawiki/api.php' } ); # configure the file url. Wikipedia doesn't need this but the ExoticA wiki does. $mw->{config}->{files_url} = 'https://www.exotica.org.uk'; The download function is then called as follows my $file = $mw->download( { title => 'Image:Mythic-Beasts_Logo.png'} ) || die $mw->{error}->{code} . ': ' . $mw->{error}->{details}; If the file does not exist (on the wiki) an empty string is returned. If the file is unable to be downloaded undef is returned. =cut sub download { my ($self, $params) = @_; return $self->_error(ERR_PARAMS,"You need to give a name for the Image page") unless ( defined $params->{title} ); return undef unless my $ref = $self->api( { action => 'query', titles => $params->{title}, prop => 'imageinfo', iiprop => 'url' } ); # get the page id and the page hashref with title and revisions my ( $pageid, $pageref ) = each %{ $ref->{query}->{pages} }; # if the image is missing then return an empty string return '' unless ( defined $pageref->{imageinfo} ); my $url = @{ $pageref->{imageinfo} }[0]->{url}; unless ( $url =~ /^https?\:\/\// ) { return $self->_error(ERR_PARAMS,'The API returned a relative path. You need to configure the url where files are stored in {config}->{files_url}') unless ( defined $self->{config}->{files_url} ); $url = $self->{config}->{files_url} . $url; } my $response = $self->{ua}->get($url); return $self->_error(ERR_DOWNLOAD,"The file '$url' was not found") unless ( $response->code == 200 ); return $response->decoded_content; } # returns the version of mediawiki being run sub _get_version { my ($self) = @_; return $self->{config}->{mw_ver} if exists( $self->{config}->{mw_ver} ); return undef unless my $ref = $self->api( { action => 'query', meta => 'siteinfo' } ); my $mwver = $ref->{query}->{general}->{generator}; $mwver =~ s/.+?(\d+\.\d+).*/$1/; $self->{config}->{mw_ver} = $mwver; return $mwver; } # returns a copy of a hash (passed by reference) encoded to utf-8 # used to encode parameters before being passed to the api sub _encode_hashref_utf8 { my $uriver = $URI::VERSION; my ($self, $ref, $skipenc) = @_; for my $key ( keys %{$ref} ) { # skip to next item if no value defined or the item is a ref (i.e. a file upload) next if ! defined $ref->{$key} || ref($ref->{$key}); # if we don't want to skip encoding and the item doesn't already have the utf8 flag set or we are using # an older version of URI.pm that doesn't handle the encoding correctly then we need to encode to utf8 if ( ! $skipenc && ( ! utf8::is_utf8($ref->{$key}) || $URI::VERSION < 1.36) ) { $ref->{$key} = Encode::encode_utf8($ref->{$key}); } # turn on the utf8 flag so the URI module knows what to do with it (and so we don't re-encode when we don't need to) # if we are using a new enough version of URI that will handle the encoding correctly. # so what you get is : # URI < 1.36 - utf8 encoded string without utf8 flag (works) # URI >= 1.36 - utf8 encoded string with utf8 flag (works) Encode::_utf8_on($ref->{$key}) if $URI::VERSION >= 1.36; } return $ref; } # creates a querystring from a utf-8 hashref sub _make_querystring { my ($ref) = @_; my @qs = (); my $keyval; for my $key ( keys %{$ref} ) { $keyval = uri_escape_utf8($key) . '=' . uri_escape_utf8($ref->{$key}); push(@qs, $keyval); } return '?' . join('&',@qs); } # gets a token from the API (https://www.mediawiki.org/wiki/API:Tokens) sub _get_token { my ($self, $type) = @_; # Check if we have this token cached my $token = $self->{config}->{tokens}->{$type}; return $token if defined $token; my $query = { action => 'query', meta => 'tokens', type => $type }; return undef unless ( my $ref = $self->api( $query ) ); $token = $ref->{query}->{tokens}->{$type . 'token'}; return $self->_error( ERR_EDIT, "Unable to get a $type token." ) unless ( defined $token ); # cache the token $self->{config}->{tokens}->{$type} = $token; return $token; } sub _error { my ($self, $code, $desc) = @_; $self->{error}->{code} = $code; $self->{error}->{details} = $desc; $self->{error}->{stacktrace} = Carp::longmess($desc); $self->{config}->{on_error}->() if (defined $self->{config}->{on_error}); return undef; } __END__ =head1 AUTHOR Jools 'BuZz' Wills, C<< >> =head1 BUGS Please report any bugs or feature requests to C, or through the web interface at L. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. =head1 SUPPORT You can find documentation for this module with the perldoc command. perldoc MediaWiki::API You can also look for information at: =over 4 =item * RT: CPAN's request tracker L =item * AnnoCPAN: Annotated CPAN documentation L =item * CPAN Ratings L =item * Search CPAN L =back =head1 ACKNOWLEDGEMENTS =over =item * Carl Beckhorn (cbeckhorn [at] fastmail.fm) for ideas and support =item * Stuart 'Kyzer' Caie (kyzer [at] 4u.net) for UnExoticA perl code and support =item * Edward Chernenko (edwardspec [at] gmail.com) for his earlier MediaWiki module =item * Dan Collins (EN.WP.ST47 [at] gmail.com) for bug reports and patches =item * Jonas 'Spectral' Nyren (spectral [at] ludd.luth.se) for hints and tips! =item * Jason 'XtC' Skelly (xtc [at] amigaguide.org) for moral support =item * Nikolay Shaplov (n [at] shaplov.ru) for utf-8 patches and testing =item * Jeremy Muhlich (jmuhlich [at] bitflood.org) for utf-8 patches and testing for api upload support patch =back =head1 COPYRIGHT & LICENSE Copyright 2008 - 2012 Jools Wills, all rights reserved. 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 3 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, see . =cut 1; # End of MediaWiki::API MediaWiki-API-0.52/LICENSE0000644000175000017500000010451312344243631013763 0ustar joolsjools GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. 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 them 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 prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. 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. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey 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; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If 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 convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU 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 that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. 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. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 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. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. 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 state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 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 3 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, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program 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, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU 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 Lesser General Public License instead of this License. But first, please read .