git-remote-mediawiki: factoring code between git-remote-mediawiki and Git::Mediawiki
For now, Git::Mediawiki contains nothing. This first patch moves some of git-remote-mediawiki.perl's factorisable code into Git::Mediawiki. In the same time, it removes the side effects of that code and renames the fucntions and constants moved to expose a better API. Signed-off-by: Benoit Person <benoit.person@ensimag.fr> Signed-off-by: Matthieu Moy <matthieu.moy@grenoble-inp.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Benoit Person
Junio C Hamano
parent
c7956f9084
commit
192f7a0804
@ -18,7 +18,82 @@ require Exporter;
|
||||
@EXPORT = ();
|
||||
|
||||
# Methods which can be called as standalone functions as well:
|
||||
@EXPORT_OK = ();
|
||||
@EXPORT_OK = qw(clean_filename smudge_filename connect_maybe
|
||||
EMPTY HTTP_CODE_OK);
|
||||
}
|
||||
|
||||
# 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;
|
||||
|
||||
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 $filename;
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
@ -14,6 +14,8 @@
|
||||
use strict;
|
||||
use MediaWiki::API;
|
||||
use Git;
|
||||
use Git::Mediawiki qw(clean_filename smudge_filename connect_maybe
|
||||
EMPTY HTTP_CODE_OK);
|
||||
use DateTime::Format::ISO8601;
|
||||
use warnings;
|
||||
|
||||
@ -23,9 +25,6 @@ binmode STDOUT, ':encoding(UTF-8)';
|
||||
|
||||
use URI::Escape;
|
||||
|
||||
# Mediawiki filenames can contain forward slashes. This variable decides by which pattern they should be replaced
|
||||
use constant SLASH_REPLACEMENT => '%2F';
|
||||
|
||||
# It's not always possible to delete pages (may require some
|
||||
# privileges). Deleted pages are replaced with this content.
|
||||
use constant DELETED_CONTENT => "[[Category:Deleted]]\n";
|
||||
@ -40,8 +39,6 @@ use constant NULL_SHA1 => '0000000000000000000000000000000000000000';
|
||||
# Used on Git's side to reflect empty edit messages on the wiki
|
||||
use constant EMPTY_MESSAGE => '*Empty MediaWiki Message*';
|
||||
|
||||
use constant EMPTY => q{};
|
||||
|
||||
# Number of pages taken into account at once in submodule get_mw_page_list
|
||||
use constant SLICE_SIZE => 50;
|
||||
|
||||
@ -50,8 +47,6 @@ use constant SLICE_SIZE => 50;
|
||||
# the number of links to be returned (500 links max).
|
||||
use constant BATCH_SIZE => 10;
|
||||
|
||||
use constant HTTP_CODE_OK => 200;
|
||||
|
||||
if (@ARGV != 2) {
|
||||
exit_error_usage();
|
||||
}
|
||||
@ -199,37 +194,6 @@ sub parse_command {
|
||||
# MediaWiki API instance, created lazily.
|
||||
my $mediawiki;
|
||||
|
||||
sub mw_connect_maybe {
|
||||
if ($mediawiki) {
|
||||
return;
|
||||
}
|
||||
$mediawiki = MediaWiki::API->new;
|
||||
$mediawiki->{config}->{api_url} = "${url}/api.php";
|
||||
if ($wiki_login) {
|
||||
my %credential = (
|
||||
'url' => $url,
|
||||
'username' => $wiki_login,
|
||||
'password' => $wiki_passwd
|
||||
);
|
||||
Git::credential(\%credential);
|
||||
my $request = {lgname => $credential{username},
|
||||
lgpassword => $credential{password},
|
||||
lgdomain => $wiki_domain};
|
||||
if ($mediawiki->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 ${url}\n);
|
||||
print {*STDERR} ' (error ' .
|
||||
$mediawiki->{error}->{code} . ': ' .
|
||||
$mediawiki->{error}->{details} . ")\n";
|
||||
Git::credential(\%credential, 'reject');
|
||||
exit 1;
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
sub fatal_mw_error {
|
||||
my $action = shift;
|
||||
print STDERR "fatal: could not $action.\n";
|
||||
@ -339,7 +303,7 @@ sub get_mw_first_pages {
|
||||
|
||||
# Get the list of pages to be fetched according to configuration.
|
||||
sub get_mw_pages {
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
|
||||
print {*STDERR} "Listing pages on remote wiki...\n";
|
||||
|
||||
@ -529,7 +493,7 @@ sub get_last_local_revision {
|
||||
# avoid a loop onto all tracked pages. This is useful for the fetch-by-rev
|
||||
# option.
|
||||
sub get_last_global_remote_rev {
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
|
||||
my $query = {
|
||||
action => 'query',
|
||||
@ -545,7 +509,7 @@ sub get_last_global_remote_rev {
|
||||
# Get the last remote revision concerning the tracked pages and the tracked
|
||||
# categories.
|
||||
sub get_last_remote_revision {
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
|
||||
my %pages_hash = get_mw_pages();
|
||||
my @pages = values(%pages_hash);
|
||||
@ -601,29 +565,6 @@ sub mediawiki_smudge {
|
||||
return "${string}\n";
|
||||
}
|
||||
|
||||
sub mediawiki_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 mediawiki_smudge_filename {
|
||||
my $filename = shift;
|
||||
$filename =~ s{/}{@{[SLASH_REPLACEMENT]}}g;
|
||||
$filename =~ s/ /_/g;
|
||||
# Decode forbidden characters encoded in mediawiki_clean_filename
|
||||
$filename =~ s/_%_([0-9a-fA-F][0-9a-fA-F])/sprintf('%c', hex($1))/ge;
|
||||
return $filename;
|
||||
}
|
||||
|
||||
sub literal_data {
|
||||
my ($content) = @_;
|
||||
print {*STDOUT} 'data ', bytes::length($content), "\n", $content;
|
||||
@ -831,7 +772,7 @@ sub mw_import_ref {
|
||||
return;
|
||||
}
|
||||
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
|
||||
print {*STDERR} "Searching revisions...\n";
|
||||
my $last_local = get_last_local_revision();
|
||||
@ -945,7 +886,7 @@ sub mw_import_revids {
|
||||
my %commit;
|
||||
$commit{author} = $rev->{user} || 'Anonymous';
|
||||
$commit{comment} = $rev->{comment} || EMPTY_MESSAGE;
|
||||
$commit{title} = mediawiki_smudge_filename($page_title);
|
||||
$commit{title} = smudge_filename($page_title);
|
||||
$commit{mw_revision} = $rev->{revid};
|
||||
$commit{content} = mediawiki_smudge($rev->{'*'});
|
||||
|
||||
@ -1006,7 +947,7 @@ sub mw_upload_file {
|
||||
}
|
||||
# Deleting and uploading a file requires a priviledged user
|
||||
if ($file_deleted) {
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
my $query = {
|
||||
action => 'delete',
|
||||
title => $path,
|
||||
@ -1022,7 +963,7 @@ sub mw_upload_file {
|
||||
# Don't let perl try to interpret file content as UTF-8 => use "raw"
|
||||
my $content = run_git("cat-file blob ${new_sha1}", 'raw');
|
||||
if ($content ne EMPTY) {
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
$mediawiki->{config}->{upload_url} =
|
||||
"${url}/index.php/Special:Upload";
|
||||
$mediawiki->edit({
|
||||
@ -1070,7 +1011,7 @@ sub mw_push_file {
|
||||
my $old_sha1 = $diff_info_split[2];
|
||||
my $page_created = ($old_sha1 eq NULL_SHA1);
|
||||
my $page_deleted = ($new_sha1 eq NULL_SHA1);
|
||||
$complete_file_name = mediawiki_clean_filename($complete_file_name);
|
||||
$complete_file_name = clean_filename($complete_file_name);
|
||||
|
||||
my ($title, $extension) = $complete_file_name =~ /^(.*)\.([^\.]*)$/;
|
||||
if (!defined($extension)) {
|
||||
@ -1093,7 +1034,7 @@ sub mw_push_file {
|
||||
$file_content = run_git("cat-file blob ${new_sha1}");
|
||||
}
|
||||
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
|
||||
my $result = $mediawiki->edit( {
|
||||
action => 'edit',
|
||||
@ -1279,7 +1220,7 @@ sub mw_push_revision {
|
||||
}
|
||||
|
||||
sub get_allowed_file_extensions {
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
|
||||
my $query = {
|
||||
action => 'query',
|
||||
@ -1303,7 +1244,7 @@ my %cached_mw_namespace_id;
|
||||
# Return MediaWiki id for a canonical namespace name.
|
||||
# Ex.: "File", "Project".
|
||||
sub get_mw_namespace_id {
|
||||
mw_connect_maybe();
|
||||
$mediawiki = connect_maybe($mediawiki, $remotename, $url);
|
||||
my $name = shift;
|
||||
|
||||
if (!exists $namespace_id{$name}) {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user