net.sourceforge.jwbf.mediawiki.bots

Class MediaWikiBot

java.lang.Object

net.sourceforge.jwbf.mediawiki.bots.MediaWikiBot

All Implemented Interfaces:

WikiBot

Direct Known Subclasses:

MediaWikiThreadBot

public class MediaWikiBot
extends Object
implements WikiBot

This class helps you to interact with each MediaWiki. This class offers a basic set of methods which are defined in the package net.sourceforge.jwbf.actions.mw.* How to use:

 MediaWikiBot b = new MediaWikiBot("http://yourwiki.org");
 b.login("Username", "Password");
 System.out.println(b.readContent("Main Page").getText());
 

How to find the correct wikiurl

The correct wikiurl is sometimes not easy to find, because some wikiadmis uses url rewriting rules. In this cases the correct url is the one, which gives you access to api.php. E.g. Compare

 http://www.mediawiki.org/wiki/api.php
 http://www.mediawiki.org/w/api.php
 

Thus the correct wikiurl is: http://www.mediawiki.org/w/

Author:

Thomas Stock, Tobias Knerr, Justus Bisser

Field Summary

Fields

Modifier and Type	Field and Description
static char[]	INVALID_LABEL_CHARS These chars are not allowed in article names.

Constructor Summary

Constructors

Constructor and Description
MediaWikiBot() use this constructor, if you want to work with IoC.
MediaWikiBot(HttpActionClient client)
MediaWikiBot(String url)
MediaWikiBot(URL u)
MediaWikiBot(URL url, boolean testHostReachable)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(String title)
void	delete(String title, String reason) deletes an article with a reason
Article	getArticle(String name)
Article	getArticle(String name, int properties)
String	getHostUrl()
Siteinfo	getSiteinfo()
Userinfo	getUserinfo()
MediaWiki.Version	getVersion()
String	getWikiType()
boolean	isEditApi()
boolean	isLoggedIn()
void	login(String username, String passwd) Performs a Login.
void	login(String username, String passwd, String domain) Performs a Login.
String	performAction(ContentProcessable a)
SimpleArticle	readData(String name)
SimpleArticle	readData(String name, int properties)
void	useEditApi(boolean useEditApi)
void	writeContent(SimpleArticle simpleArticle)

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_LABEL_CHARS

public static final char[] INVALID_LABEL_CHARS

These chars are not allowed in article names.

Constructor Detail

MediaWikiBot

public MediaWikiBot()

use this constructor, if you want to work with IoC.

MediaWikiBot

public MediaWikiBot(URL u)

Parameters:

u - wikihosturl like "http://www.mediawiki.org/w/"

MediaWikiBot

public MediaWikiBot(HttpActionClient client)

MediaWikiBot

public MediaWikiBot(String url)

Parameters:

url - wikihosturl like "http://www.mediawiki.org/w/"

Throws:

IllegalArgumentException - if param url does not represent a well-formed url

MediaWikiBot

public MediaWikiBot(URL url,
            boolean testHostReachable)

Parameters:

url - wikihosturl like "http://www.mediawiki.org/w/"

testHostReachable - if true, test if host reachable

Method Detail

login

public void login(String username,
         String passwd,
         String domain)

Performs a Login.

Parameters:

username - the username

passwd - the password

domain - login domain (Special for LDAPAuth extention to authenticate against LDAP users)

See Also:

PostLogin

login

public void login(String username,
         String passwd)

Performs a Login. Actual old cookie login works right, because is pending on #writeContent(ContentAccessable)

Specified by:

login in interface WikiBot

Parameters:

username - the username

passwd - the password

See Also:

PostLogin

getArticle

public Article getArticle(String name,
                 int properties)

Parameters:

name - of article in a mediawiki like "Main Page"

properties - GetRevision

Returns:

a content representation of requested article, never null

See Also:

GetRevision

readData

public SimpleArticle readData(String name,
                     int properties)

Specified by:

readData in interface WikiBot

readData

public SimpleArticle readData(String name)

Specified by:

readData in interface WikiBot

getArticle

public Article getArticle(String name)

Parameters:

name - of article in a mediawiki like "Main Page"

Returns:

a content representation of requested article, never null

See Also:

GetRevision

writeContent

public void writeContent(SimpleArticle simpleArticle)

Specified by:

writeContent in interface WikiBot

isLoggedIn

public final boolean isLoggedIn()

Returns:

true if

getUserinfo

public Userinfo getUserinfo()

Specified by:

getUserinfo in interface WikiBot

delete

public void delete(String title)

Specified by:

delete in interface WikiBot

delete

public void delete(String title,
          String reason)

deletes an article with a reason

performAction

public String performAction(ContentProcessable a)

getVersion

@Nonnull
public MediaWiki.Version getVersion()
                             throws IllegalStateException

Returns:

the

Throws:

IllegalStateException - if no version was found.

See Also:

getSiteinfo()

getSiteinfo

@Nonnull
public Siteinfo getSiteinfo()

Returns:

a on problems with http, cookies and io

See Also:

Siteinfo

isEditApi

public boolean isEditApi()

Returns:

the

useEditApi

public final void useEditApi(boolean useEditApi)

Parameters:

useEditApi - Set to false, to force editing without the API.

getWikiType

public final String getWikiType()

Specified by:

getWikiType in interface WikiBot

getHostUrl

public String getHostUrl()