[thirdparty/git.git] / contrib / mw-to-git / Git / Mediawiki.pm

package Git::Mediawiki;

use 5.008001;
use strict;
use POSIX;
use Git;

BEGIN {

our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);

# Totally unstable API.
$VERSION = '0.01';

require Exporter;

@ISA = qw(Exporter);

@EXPORT = ();

# Methods which can be called as standalone functions as well:
@EXPORT_OK = qw(clean_filename smudge_filename connect_maybe
				EMPTY HTTP_CODE_OK HTTP_CODE_PAGE_NOT_FOUND);
}

# Mediawiki filenames can contain forward slashes. This variable decides by which pattern they should be replaced
use constant SLASH_REPLACEMENT => '%2F';

# Used to test for empty strings
use constant EMPTY => q{};

# HTTP codes
use constant HTTP_CODE_OK => 200;
use constant HTTP_CODE_PAGE_NOT_FOUND => 404;

sub clean_filename {
	my $filename = shift;
	$filename =~ s{@{[SLASH_REPLACEMENT]}}{/}g;
	# [, ], |, {, and } are forbidden by MediaWiki, even URL-encoded.
	# Do a variant of URL-encoding, i.e. looks like URL-encoding,
	# but with _ added to prevent MediaWiki from thinking this is
	# an actual special character.
	$filename =~ s/[\[\]\{\}\|]/sprintf("_%%_%x", ord($&))/ge;
	# If we use the uri escape before
	# we should unescape here, before anything

	return $filename;
}

sub smudge_filename {
	my $filename = shift;
	$filename =~ s{/}{@{[SLASH_REPLACEMENT]}}g;
	$filename =~ s/ /_/g;
	# Decode forbidden characters encoded in clean_filename
	$filename =~ s/_%_([0-9a-fA-F][0-9a-fA-F])/sprintf('%c', hex($1))/ge;
	return substr($filename, 0, NAME_MAX-length('.mw'));
}

sub connect_maybe {
	my $wiki = shift;
	if ($wiki) {
		return $wiki;
	}

	my $remote_name = shift;
	my $remote_url = shift;
	my ($wiki_login, $wiki_password, $wiki_domain);

	$wiki_login = Git::config("remote.${remote_name}.mwLogin");
	$wiki_password = Git::config("remote.${remote_name}.mwPassword");
	$wiki_domain = Git::config("remote.${remote_name}.mwDomain");

	$wiki = MediaWiki::API->new;
	$wiki->{config}->{api_url} = "${remote_url}/api.php";
	if ($wiki_login) {
		my %credential = (
			'url' => $remote_url,
			'username' => $wiki_login,
			'password' => $wiki_password
		);
		Git::credential(\%credential);
		my $request = {lgname => $credential{username},
			       lgpassword => $credential{password},
			       lgdomain => $wiki_domain};
		if ($wiki->login($request)) {
			Git::credential(\%credential, 'approve');
			print {*STDERR} qq(Logged in mediawiki user "$credential{username}".\n);
		} else {
			print {*STDERR} qq(Failed to log in mediawiki user "$credential{username}" on ${remote_url}\n);
			print {*STDERR} '  (error ' .
				$wiki->{error}->{code} . ': ' .
				$wiki->{error}->{details} . ")\n";
			Git::credential(\%credential, 'reject');
			exit 1;
		}
	}

	return $wiki;
}

1; # Famous last words
Commit	Line	Data
e1918906 BP	1	package Git::Mediawiki;
e1918906 BP	2
d13a73e3	3	use 5.008001;
e1918906	4	use strict;
d1a7050f	5	use POSIX;
e1918906 BP	6	use Git;
	7
	8	BEGIN {
	9
	10	our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
	11
	12	# Totally unstable API.
	13	$VERSION = '0.01';
	14
	15	require Exporter;
	16
	17	@ISA = qw(Exporter);
	18
	19	@EXPORT = ();
	20
	21	# Methods which can be called as standalone functions as well:
192f7a08	22	@EXPORT_OK = qw(clean_filename smudge_filename connect_maybe
0078a7fa	23	EMPTY HTTP_CODE_OK HTTP_CODE_PAGE_NOT_FOUND);
192f7a08 BP	24	}
	25
	26	# Mediawiki filenames can contain forward slashes. This variable decides by which pattern they should be replaced
	27	use constant SLASH_REPLACEMENT => '%2F';
	28
	29	# Used to test for empty strings
	30	use constant EMPTY => q{};
	31
	32	# HTTP codes
	33	use constant HTTP_CODE_OK => 200;
0078a7fa	34	use constant HTTP_CODE_PAGE_NOT_FOUND => 404;
192f7a08 BP	35
	36	sub clean_filename {
	37	my $filename = shift;
	38	$filename =~ s{@{[SLASH_REPLACEMENT]}}{/}g;
	39	# [, ], \|, {, and } are forbidden by MediaWiki, even URL-encoded.
	40	# Do a variant of URL-encoding, i.e. looks like URL-encoding,
	41	# but with _ added to prevent MediaWiki from thinking this is
	42	# an actual special character.
	43	$filename =~ s/[\[\]\{\}\\|]/sprintf("_%%_%x", ord($&))/ge;
	44	# If we use the uri escape before
	45	# we should unescape here, before anything
	46
	47	return $filename;
	48	}
	49
	50	sub smudge_filename {
	51	my $filename = shift;
	52	$filename =~ s{/}{@{[SLASH_REPLACEMENT]}}g;
	53	$filename =~ s/ /_/g;
	54	# Decode forbidden characters encoded in clean_filename
	55	$filename =~ s/_%_([0-9a-fA-F][0-9a-fA-F])/sprintf('%c', hex($1))/ge;
d1a7050f	56	return substr($filename, 0, NAME_MAX-length('.mw'));
192f7a08 BP	57	}
	58
	59	sub connect_maybe {
	60	my $wiki = shift;
	61	if ($wiki) {
	62	return $wiki;
	63	}
	64
	65	my $remote_name = shift;
	66	my $remote_url = shift;
	67	my ($wiki_login, $wiki_password, $wiki_domain);
	68
	69	$wiki_login = Git::config("remote.${remote_name}.mwLogin");
	70	$wiki_password = Git::config("remote.${remote_name}.mwPassword");
	71	$wiki_domain = Git::config("remote.${remote_name}.mwDomain");
	72
	73	$wiki = MediaWiki::API->new;
	74	$wiki->{config}->{api_url} = "${remote_url}/api.php";
	75	if ($wiki_login) {
	76	my %credential = (
	77	'url' => $remote_url,
	78	'username' => $wiki_login,
	79	'password' => $wiki_password
	80	);
	81	Git::credential(\%credential);
	82	my $request = {lgname => $credential{username},
	83	lgpassword => $credential{password},
	84	lgdomain => $wiki_domain};
	85	if ($wiki->login($request)) {
	86	Git::credential(\%credential, 'approve');
	87	print {*STDERR} qq(Logged in mediawiki user "$credential{username}".\n);
	88	} else {
	89	print {*STDERR} qq(Failed to log in mediawiki user "$credential{username}" on ${remote_url}\n);
	90	print {*STDERR} ' (error ' .
	91	$wiki->{error}->{code} . ': ' .
	92	$wiki->{error}->{details} . ")\n";
	93	Git::credential(\%credential, 'reject');
	94	exit 1;
	95	}
	96	}
	97
	98	return $wiki;
e1918906 BP	99	}
	100
	101	1; # Famous last words