com.bitplan.mediawiki.japi

Class Mediawiki

java.lang.Object

com.bitplan.mediawiki.japi.MediaWikiApiImpl

com.bitplan.mediawiki.japi.Mediawiki

All Implemented Interfaces:

MediawikiApi

Direct Known Subclasses:

SSLWiki

public class Mediawiki
extends MediaWikiApiImpl
implements MediawikiApi

access to Mediawiki api

Author:

wf

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mediawiki.Method

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiPath
protected boolean	debug set to true for debugging
static String	DEFAULT_SCRIPTPATH default script path
protected String	format
protected String	scriptPath
protected String	siteurl
static boolean	testMode if true main can be called without calling system.exit() when finished
protected static String	USER_AGENT see Iden t i f y i n g your client:User-Agent
protected String	userid
protected static String	VERSION current Version

Fields inherited from class com.bitplan.mediawiki.japi.MediaWikiApiImpl

LOGGER, protectionMarker, throwExceptionOnError

Constructor Summary

Constructors

Constructor and Description
Mediawiki() construct me with no siteurl set
Mediawiki(String siteurl) construct a Mediawiki for the given url using the default Script path
Mediawiki(String siteurl, String pScriptPath) construct a Mediawiki for the given url and scriptpath

Method Summary

Modifier and Type	Method and Description
Api	createAccount(String name, String eMail, String realname, boolean mailpassword, String reason, String language) create the given user account
String	dateToMWTimeStamp(Date date) convert a data to a MediaWiki API timestamp
Delete	delete(String pageTitle, String reason) https://www.mediawiki.org/wiki/API:Delete/de
Edit	edit(String pageTitle, String text, String summary) https://www.mediawiki.org/wiki/API:Edit
Edit	edit(String pageTitle, String text, String summary, boolean minor, boolean bot, int sectionNumber, String sectionTitle, Calendar basetime) edit
Api	getActionResult(String action, String params) get the result for the given action and query
Api	getActionResult(String action, String params, com.bitplan.mediawiki.japi.Mediawiki.TokenResult token, Object pFormData) get the action result for the default format
Api	getActionResult(String action, String params, com.bitplan.mediawiki.japi.Mediawiki.TokenResult token, Object pFormData, String format) get the result for the given action and params
String	getActionResultText(String action, String params, com.bitplan.mediawiki.japi.Mediawiki.TokenResult token, Object pFormData, String format) get the action result for the given parameters
List<Img>	getAllImagesByTimeStamp(String aistart, String aiend, int ailimit) get all Images by the given time stamps
List<P>	getAllPages(String apfrom, int aplimit) getAllPages
List<Bl>	getBacklinks(String pageTitle, String params, int bllimit) get the backlinks for the given pagetitle
com.bitplan.mediawiki.japi.Mediawiki.TokenResult	getEditToken(String pageTitle, String type) get an edit token for the given page Title see API:Tokens
String	getFormat()
Ii	getImageInfo(String pageTitle) get the Image Info for the given pageTitle
List<Ii>	getImageInfosForPage(String pageTitle, int imLimit) get the imageInfos for all images on the given page Title
List<Im>	getImagesOnPage(String pageTitle, int imLimit) get the Images on the given page
List<Iu>	getImageUsage(String imageTitle, String params, int limit) get the imageusage for the given imageTitle
String	getIsoTimeStamp() get a current IsoTimeStamp
List<Rc>	getMostRecentChanges(int days, int rcLimit) get the most recent changes
String	getPageContent(String pageTitle) get the page Content for the given page Title
String	getPageContent(String pageTitle, String queryParams, boolean checkNotNull) get the page Content for the given page Title
String	getPageHtml(String pageTitle) get the html rendered version of a page
List<Page>	getPages(List<String> titleList) get a list of pages for the given titles see API:Query
List<Page>	getPages(List<String> titleList, String rvprop) get a list of pages for the given titles see API:Query
Map<String,String>	getParamMap(String params) get a Map of parameter from a & delimited parameter list
Parse	getParse(String params) get the parse Result for the given params
com.sun.jersey.api.client.ClientResponse	getPostResponse(String queryUrl, String params, com.bitplan.mediawiki.japi.Mediawiki.TokenResult token, Object pFormDataObject) get a Post response
Api	getQueryResult(String query) get the Result for the given query
List<Rc>	getRecentChanges(String rcstart, String rcend, Integer rclimit) get the recent changes see https://www.mediawiki.org/wiki/API:RecentChanges
com.sun.jersey.api.client.WebResource.Builder	getResource(String queryUrl) get the given Builder for the given queryUrl this is a wrapper to be able to debug all QueryUrl
com.sun.jersey.api.client.ClientResponse	getResponse(String url, Mediawiki.Method method) get a response for the given url and method
String	getResponseString(com.sun.jersey.api.client.ClientResponse response) get the Response string
String	getScriptPath() get the script Path
List<S>	getSections(String pageTitle) get the sections for the given pageTitle
String	getSectionText(String pageTitle, int sectionNumber) get the text for the given section
SiteInfo	getSiteInfo() get the siteinfo
String	getSiteurl()
static String	getStringFromUrl(String urlString) get a String from a given URL
String	getTitles(List<String> titleList) get a normalized | delimited (encoded as %7C) string of titles
void	handle(Throwable t) handle the given Throwable (in commandline mode)
void	init(String siteurl, String scriptpath) overrideable e.g for SSL configuration
boolean	isDebug() get the state of the debug mode
boolean	isLoggedIn() check whether there is a User logged In
boolean	isVersion128() check whether this is MediaWiki 1.28 or higher but make sure getVersion calls with readapidenied are ignored see https://github.com/WolfgangFahl/Mediawiki-Japi/issues/32
Login	login(com.bitplan.mediawiki.japi.Mediawiki.TokenResult token, String username, String password) second step of login process
Login	login(com.bitplan.mediawiki.japi.Mediawiki.TokenResult token, String username, String password, String domain) second step of login process
Login	login(String username, String password) login with the given username and password
Login	login(String username, String password, String domain) login with the given username, password and domain
void	logout() end the session
static void	main(String[] args) entry point e.g. for java -jar called provides a command line interface
protected int	maininstance(String[] args) main instance - this is the non-static version of main - it will run as a static main would but return it's exitCode to the static main the static main will then decide whether to do a System.exit(exitCode) or not.
com.bitplan.mediawiki.japi.Mediawiki.TokenResult	prepareLogin(String username) prepare the login by getting the login token
void	setDebug(boolean debug) enable debugging
void	setFormat(String format)
void	setScriptPath(String scriptPath) set the scriptPath of this Wiki
void	setSiteurl(String siteurl) set the siteurl
void	setUpSiteInfo(Query query) setup siteinfo for a query (e.g. for testing)
void	showHelp() show Help
static void	showVersion() show the Version
List<Rc>	sortByTitleAndFilterDoubles(List<Rc> rcList) sort the given List by title and filter double titles
void	upload(File fileToUpload, String filename, String contents, String comment) https://www.mediawiki.org/wiki/API:Upload
void	upload(Ii ii, String fileName, String pageContent) upload the image described in the given imageinfo
void	upload(InputStream fileToUpload, String filename, String contents, String comment) upload from the given inputstream
void	usage(String msg) show a usage

Methods inherited from class com.bitplan.mediawiki.japi.MediaWikiApiImpl

copyToWiki, decode, encode, fromXML, getProtectionMarker, getVersion, handleError, handleError, handleError, isThrowExceptionOnError, normalizeTitle, setProtectionMarker, setThrowExceptionOnError, setVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.bitplan.mediawiki.japi.MediawikiApi

copyToWiki, getVersion, isThrowExceptionOnError, normalizeTitle, setProtectionMarker, setThrowExceptionOnError

Field Detail

VERSION

protected static final String VERSION

current Version

See Also:

Constant Field Values

testMode

public static boolean testMode

if true main can be called without calling system.exit() when finished

USER_AGENT

protected static final String USER_AGENT

see Iden t i f y i n g your client:User-Agent

See Also:

Constant Field Values

DEFAULT_SCRIPTPATH

public static final String DEFAULT_SCRIPTPATH

default script path

See Also:

Constant Field Values

siteurl

protected String siteurl

scriptPath

protected String scriptPath

format

protected String format

apiPath

protected String apiPath

userid

protected String userid

debug

protected boolean debug

set to true for debugging

Constructor Detail

Mediawiki

public Mediawiki()
          throws Exception

construct me with no siteurl set

Throws:

Exception

Mediawiki

public Mediawiki(String siteurl)
          throws Exception

construct a Mediawiki for the given url using the default Script path

Parameters:

siteurl - - the url to use

Throws:

Exception

Mediawiki

public Mediawiki(String siteurl,
                 String pScriptPath)
          throws Exception

construct a Mediawiki for the given url and scriptpath

Parameters:

siteurl - - the url to use

pScriptPath - - the scriptpath to use

Throws:

Exception

Method Detail

setDebug

public void setDebug(boolean debug)

enable debugging

Specified by:

setDebug in interface MediawikiApi

Parameters:

debug -

isDebug

public boolean isDebug()

Description copied from interface: MediawikiApi

get the state of the debug mode

Specified by:

isDebug in interface MediawikiApi

Returns:

- true if debugging is activated

getSiteurl

public String getSiteurl()

Specified by:

getSiteurl in interface MediawikiApi

Returns:

the siteurl

setSiteurl

public void setSiteurl(String siteurl)

Description copied from interface: MediawikiApi

set the siteurl

Specified by:

setSiteurl in interface MediawikiApi

Parameters:

siteurl - the siteurl to set

getScriptPath

public String getScriptPath()

Description copied from interface: MediawikiApi

get the script Path

Specified by:

getScriptPath in interface MediawikiApi

Returns:

the scriptPath

setScriptPath

public void setScriptPath(String scriptPath)

Description copied from interface: MediawikiApi

set the scriptPath of this Wiki

Specified by:

setScriptPath in interface MediawikiApi

Parameters:

scriptPath - the scriptPath to set

getFormat

public String getFormat()

setFormat

public void setFormat(String format)

init

public void init(String siteurl,
                 String scriptpath)
          throws Exception

overrideable e.g for SSL configuration

Specified by:

init in interface MediawikiApi

Parameters:

siteurl - - the url to use

scriptpath - - the script path to use

Throws:

Exception

getIsoTimeStamp

public String getIsoTimeStamp()

get a current IsoTimeStamp

Specified by:

getIsoTimeStamp in interface MediawikiApi

Returns:

- the current timestamp

getStringFromUrl

public static String getStringFromUrl(String urlString)

get a String from a given URL

Parameters:

urlString -

Returns:

getResource

public com.sun.jersey.api.client.WebResource.Builder getResource(String queryUrl)
                                                          throws Exception

get the given Builder for the given queryUrl this is a wrapper to be able to debug all QueryUrl

Parameters:

queryUrl - - either a relative or absolute path

Returns:

Throws:

Exception

getPostResponse

public com.sun.jersey.api.client.ClientResponse getPostResponse(String queryUrl,
                                                                String params,
                                                                com.bitplan.mediawiki.japi.Mediawiki.TokenResult token,
                                                                Object pFormDataObject)
                                                         throws Exception

get a Post response

Parameters:

queryUrl -

params - - direct query parameters

token - - a token if any

pFormData - - the form data - either as multipart of urlencoded

Returns:

- the client Response

Throws:

Exception

getResponse

public com.sun.jersey.api.client.ClientResponse getResponse(String url,
                                                            Mediawiki.Method method)
                                                     throws Exception

get a response for the given url and method

Parameters:

url -

method -

Returns:

Throws:

Exception

getResponseString

public String getResponseString(com.sun.jersey.api.client.ClientResponse response)
                         throws Exception

get the Response string

Parameters:

response -

Returns:

the String representation of a response

Throws:

Exception

getParamMap

public Map<String,String> getParamMap(String params)

get a Map of parameter from a & delimited parameter list

Parameters:

params - - the list of parameters

Returns:

the map FIXME - should check that split creates and even number of entries - add test case for this

getActionResultText

public String getActionResultText(String action,
                                  String params,
                                  com.bitplan.mediawiki.japi.Mediawiki.TokenResult token,
                                  Object pFormData,
                                  String format)
                           throws Exception

get the action result for the given parameters

Parameters:

action -

params -

token -

pFormData -

format - - json or xml

Returns:

the String e.g. xml or json

Throws:

Exception

getActionResult

public Api getActionResult(String action,
                           String params,
                           com.bitplan.mediawiki.japi.Mediawiki.TokenResult token,
                           Object pFormData,
                           String format)
                    throws Exception

get the result for the given action and params

Parameters:

action -

params -

token - (may be null)

formData - (may be null)

Returns:

the API result for the action

Throws:

Exception

getActionResult

public Api getActionResult(String action,
                           String params,
                           com.bitplan.mediawiki.japi.Mediawiki.TokenResult token,
                           Object pFormData)
                    throws Exception

get the action result for the default format

Parameters:

action -

params -

token -

pFormData -

Returns:

- the action result

Throws:

Exception

getActionResult

public Api getActionResult(String action,
                           String params)
                    throws Exception

get the result for the given action and query

Parameters:

action -

params -

Returns:

the API result for the action

Throws:

Exception

getQueryResult

public Api getQueryResult(String query)
                   throws Exception

get the Result for the given query

Parameters:

query -

Returns:

the API result for the query

Throws:

Exception

getTitles

public String getTitles(List<String> titleList)
                 throws Exception

get a normalized | delimited (encoded as %7C) string of titles

Parameters:

examplePages - - the list of pages to get the titles for

Returns:

a string with all the titles e.g. Main%20Page%7CSome%20Page

Throws:

Exception

getSiteInfo

public SiteInfo getSiteInfo()
                     throws Exception

get the siteinfo

Specified by:

getSiteInfo in interface MediawikiApi

Specified by:

getSiteInfo in class MediaWikiApiImpl

Returns:

the siteinfo

Throws:

Exception

setUpSiteInfo

public void setUpSiteInfo(Query query)

setup siteinfo for a query (e.g. for testing)

Parameters:

query -

isVersion128

public boolean isVersion128()

check whether this is MediaWiki 1.28 or higher but make sure getVersion calls with readapidenied are ignored see https://github.com/WolfgangFahl/Mediawiki-Japi/issues/32

Returns:

prepareLogin

public com.bitplan.mediawiki.japi.Mediawiki.TokenResult prepareLogin(String username)
                                                              throws Exception

prepare the login by getting the login token

Parameters:

username -

Returns:

the ApiResult

Throws:

Exception

login

public Login login(com.bitplan.mediawiki.japi.Mediawiki.TokenResult token,
                   String username,
                   String password)
            throws Exception

second step of login process

Parameters:

token -

username -

password -

Returns:

Throws:

Exception

login

public Login login(com.bitplan.mediawiki.japi.Mediawiki.TokenResult token,
                   String username,
                   String password,
                   String domain)
            throws Exception

second step of login process

Parameters:

token -

username -

password -

domain -

Returns:

Throws:

Exception

login

public Login login(String username,
                   String password,
                   String domain)
            throws Exception

login with the given username, password and domain

Parameters:

username -

password -

domain -

Returns:

Login

Throws:

Exception

login

public Login login(String username,
                   String password)
            throws Exception

login with the given username and password

Specified by:

login in interface MediawikiApi

Parameters:

username -

password -

Returns:

Login

Throws:

Exception

isLoggedIn

public boolean isLoggedIn()

Description copied from interface: MediawikiApi

check whether there is a User logged In

Specified by:

isLoggedIn in interface MediawikiApi

Returns:

logout

public void logout()
            throws Exception

end the session

Specified by:

logout in interface MediawikiApi

Throws:

Exception

getPageContent

public String getPageContent(String pageTitle,
                             String queryParams,
                             boolean checkNotNull)
                      throws Exception

get the page Content for the given page Title

Parameters:

pageTitle -

queryParams - - extra query params e.g. for sections

checkNotNull - - check if the content should not be null

Returns:

the page Content

Throws:

Exception

getPageContent

public String getPageContent(String pageTitle)
                      throws Exception

get the page Content for the given page Title

Specified by:

getPageContent in interface MediawikiApi

Parameters:

pageTitle -

Returns:

the page Content

Throws:

Exception

getSectionText

public String getSectionText(String pageTitle,
                             int sectionNumber)
                      throws Exception

get the text for the given section

Specified by:

getSectionText in interface MediawikiApi

Parameters:

pageTitle -

sectionNumber -

Returns:

Throws:

Exception

getSections

public List<S> getSections(String pageTitle)
                    throws Exception

Description copied from interface: MediawikiApi

get the sections for the given pageTitle

Specified by:

getSections in interface MediawikiApi

Returns:

Throws:

Exception

getPageHtml

public String getPageHtml(String pageTitle)
                   throws Exception

Description copied from interface: MediawikiApi

get the html rendered version of a page

Specified by:

getPageHtml in interface MediawikiApi

Returns:

the html for a page

Throws:

Exception

getParse

public Parse getParse(String params)
               throws Exception

get the parse Result for the given params

Parameters:

params -

Returns:

the Parse Result

Throws:

Exception

getPages

public List<Page> getPages(List<String> titleList,
                           String rvprop)
                    throws Exception

get a list of pages for the given titles see API:Query

Parameters:

titleList -

rvprop - - the revision properties

Returns:

the list of pages retrieved

Throws:

Exception - FIXME should be part of the Java Interface

getPages

public List<Page> getPages(List<String> titleList)
                    throws Exception

get a list of pages for the given titles see API:Query

Parameters:

titleList -

Returns:

Throws:

Exception

getEditToken

public com.bitplan.mediawiki.japi.Mediawiki.TokenResult getEditToken(String pageTitle,
                                                                     String type)
                                                              throws Exception

get an edit token for the given page Title see API:Tokens

Parameters:

pageTitle -

type - e.g. edit or delete

Returns:

the edit token for the page title

Throws:

Exception

edit

public Edit edit(String pageTitle,
                 String text,
                 String summary)
          throws Exception

https://www.mediawiki.org/wiki/API:Edit

Specified by:

edit in interface MediawikiApi

Parameters:

pageTitle - the title of the page

text - the text of the page

summary - the edit summary. Summaries longer than 200 characters are truncated server-side.

Returns:

the edit stage as a wrapped Edit API response

Throws:

Exception - - if the edit fails

See Also:

MediawikiApi.getPageContent(java.lang.String)

delete

public Delete delete(String pageTitle,
                     String reason)
              throws Exception

https://www.mediawiki.org/wiki/API:Delete/de

Specified by:

delete in interface MediawikiApi

Returns:

info

Throws:

Exception

edit

public Edit edit(String pageTitle,
                 String text,
                 String summary,
                 boolean minor,
                 boolean bot,
                 int sectionNumber,
                 String sectionTitle,
                 Calendar basetime)
          throws Exception

Description copied from interface: MediawikiApi

edit

Specified by:

edit in interface MediawikiApi

minor - - true if this is a minor edit

bot - whether to mark the edit as a bot edit (ignored if one does not have the necessary permissions)

sectionNumber - the section to edit. Use -1 to specify a new section and -2 to disable section editing.

sectionTitle - the title of a new section

basetime - the timestamp of the revision on which text is based, used to check for edit conflicts. null disables this.

Returns:

the edit stage as a wrapped Edit API response * @throws Exception - if the edit fails

Throws:

Exception

See Also:

MediawikiApi.getPageContent(java.lang.String)

upload

public void upload(File fileToUpload,
                   String filename,
                   String contents,
                   String comment)
            throws Exception

https://www.mediawiki.org/wiki/API:Upload

Specified by:

upload in interface MediawikiApi

Parameters:

fileToUpload - the image file

filename - the target file name (may contain File)

contents - the contents of the image description page, set to "" if overwriting an existing file

comment - an upload summary (defaults to contents, use "" to not specify one)

Throws:

Exception - - if the upload fails

upload

public void upload(InputStream fileToUpload,
                   String filename,
                   String contents,
                   String comment)
            throws Exception

upload from the given inputstream

Parameters:

fileToUpload -

filename -

contents -

comment -

Throws:

Exception

upload

public void upload(Ii ii,
                   String fileName,
                   String pageContent)
            throws Exception

Description copied from interface: MediawikiApi

upload the image described in the given imageinfo

Specified by:

upload in interface MediawikiApi

pageContent - the contents of the image description page, set to "" if overwriting an existing file

Throws:

Exception

getAllPages

public List<P> getAllPages(String apfrom,
                           int aplimit)
                    throws Exception

getAllPages

Specified by:

getAllPages in interface MediawikiApi

Parameters:

apfrom - - may be null or empty

aplimit -

Returns:

Throws:

Exception

getAllImagesByTimeStamp

public List<Img> getAllImagesByTimeStamp(String aistart,
                                         String aiend,
                                         int ailimit)
                                  throws Exception

Description copied from interface: MediawikiApi

get all Images by the given time stamps

Specified by:

getAllImagesByTimeStamp in interface MediawikiApi

Parameters:

aistart - - start time stamp

aiend - - end time stamp

ailimit - - how many images to get

Throws:

Exception

getBacklinks

public List<Bl> getBacklinks(String pageTitle,
                             String params,
                             int bllimit)
                      throws Exception

Description copied from interface: MediawikiApi

get the backlinks for the given pagetitle

Specified by:

getBacklinks in interface MediawikiApi

params - - extra params

Throws:

Exception

getImageUsage

public List<Iu> getImageUsage(String imageTitle,
                              String params,
                              int limit)
                       throws Exception

Description copied from interface: MediawikiApi

get the imageusage for the given imageTitle

Specified by:

getImageUsage in interface MediawikiApi

params - - extra params

Throws:

Exception

handle

public void handle(Throwable t)

handle the given Throwable (in commandline mode)

Parameters:

t -

showVersion

public static void showVersion()

show the Version

usage

public void usage(String msg)

show a usage

showHelp

public void showHelp()

show Help

maininstance

protected int maininstance(String[] args)

main instance - this is the non-static version of main - it will run as a static main would but return it's exitCode to the static main the static main will then decide whether to do a System.exit(exitCode) or not.

Parameters:

args - - command line arguments

Returns:

- the exit Code to be used by the static main program

main

public static void main(String[] args)

entry point e.g. for java -jar called provides a command line interface

Parameters:

args -

createAccount

public Api createAccount(String name,
                         String eMail,
                         String realname,
                         boolean mailpassword,
                         String reason,
                         String language)
                  throws Exception

create the given user account

Parameters:

name -

eMail -

realname -

mailpassword -

reason -

language -

Throws:

Exception

getImageInfo

public Ii getImageInfo(String pageTitle)
                throws Exception

Description copied from interface: MediawikiApi

get the Image Info for the given pageTitle

Specified by:

getImageInfo in interface MediawikiApi

Parameters:

pageTitle - - the pageTitle to get the ImageInfo for

Returns:

- the Image Info

Throws:

Exception

getImagesOnPage

public List<Im> getImagesOnPage(String pageTitle,
                                int imLimit)
                         throws Exception

Description copied from interface: MediawikiApi

get the Images on the given page

Specified by:

getImagesOnPage in interface MediawikiApi

Returns:

Throws:

Exception

getImageInfosForPage

public List<Ii> getImageInfosForPage(String pageTitle,
                                     int imLimit)
                              throws Exception

Description copied from interface: MediawikiApi

get the imageInfos for all images on the given page Title

Specified by:

getImageInfosForPage in interface MediawikiApi

Returns:

the list of ImageInfos

Throws:

Exception

getRecentChanges

public List<Rc> getRecentChanges(String rcstart,
                                 String rcend,
                                 Integer rclimit)
                          throws Exception

get the recent changes see https://www.mediawiki.org/wiki/API:RecentChanges

Parameters:

rcstart - The timestamp to start listing from (May not be more than $wgRCMaxAge into the past, which on Wikimedia wikis is 30 days[1])

rcend -

rclimit -

Returns:

- the list of recent changes

Throws:

Exception

sortByTitleAndFilterDoubles

public List<Rc> sortByTitleAndFilterDoubles(List<Rc> rcList)

sort the given List by title and filter double titles

Parameters:

rcList -

Returns:

dateToMWTimeStamp

public String dateToMWTimeStamp(Date date)

convert a data to a MediaWiki API timestamp

Parameters:

date -

Returns:

getMostRecentChanges

public List<Rc> getMostRecentChanges(int days,
                                     int rcLimit)
                              throws Exception

get the most recent changes

Parameters:

days -

rcLimit -

Returns:

Throws:

Exception