development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-28 03:59:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

git-remote-mediawiki: import "File:" attachments

Browse source 
Add the symmetrical feature to the "File:" export support in the previous
patch. Download files from the wiki as needed, and feed them into the
fast-import stream. Import both the file itself, and the corresponding
description page.

Signed-off-by: Pavel Volek <Pavel.Volek@ensimag.imag.fr>
Signed-off-by: NGUYEN Kim Thuat <Kim-Thuat.Nguyen@ensimag.imag.fr>
Signed-off-by: ROUCHER IGLESIAS Javier <roucherj@ensimag.imag.fr>
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Pavel Volek 2012-06-27 16:21:29 +02:00 committed by Junio C Hamano
parent 9cb74f3666
commit 6a9e55b0fc
1 changed files with 249 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

257
contrib/mw-to-git/git-remote-mediawiki
View file

@ -13,9 +13,6 @@
#
# Known limitations:
#
# - Only wiki pages are managed, no support for [[File:...]]
# attachments.
#
# - Poor performance in the best case: it takes forever to check
# whether we're up-to-date (on fetch or push) or to fetch a few
# revisions from a large wiki, because we use exclusively a
@ -36,6 +33,7 @@
use strict;
use MediaWiki::API;
use DateTime::Format::ISO8601;
use FileHandle;
# By default, use UTF-8 to communicate with Git and the user
binmode STDERR, ":utf8";
@ -72,6 +70,11 @@ chomp(@tracked_pages);
my @tracked_categories = split(/[ \n]/, run_git("config --get-all remote.". $remotename .".categories"));
chomp(@tracked_categories);
# Import media files too.
my $import_media = run_git("config --get --bool remote.". $remotename .".mediaimport");
chomp($import_media);
$import_media = ($import_media eq "true");
my $wiki_login = run_git("config --get remote.". $remotename .".mwLogin");
# TODO: ideally, this should be able to read from keyboard, but we're
# inside a remote helper, so our stdin is connect to git, not to a
@ -87,6 +90,9 @@ my $shallow_import = run_git("config --get --bool remote.". $remotename .".shall
chomp($shallow_import);
$shallow_import = ($shallow_import eq "true");
# Cache for MediaWiki namespace ids.
my %namespace_id;
# Dumb push: don't update notes and mediawiki ref to reflect the last push.
#
# Configurable with mediawiki.dumbPush, or per-remote with
@ -363,6 +369,14 @@ sub get_mw_pages {
if (!$user_defined) {
get_mw_all_pages(\%pages);
}
if ($import_media) {
print STDERR "Getting media files for selected pages...\n";
if ($user_defined) {
get_linked_mediafiles(\%pages);
} else {
get_all_mediafiles(\%pages);
}
}
return values(%pages);
}
@ -379,6 +393,152 @@ sub run_git {
}
sub get_all_mediafiles {
my $pages = shift;
# Attach list of all pages for media files from the API,
# they are in a different namespace, only one namespace
# can be queried at the same moment
my $mw_pages = $mediawiki->list({
action => 'query',
list => 'allpages',
apnamespace => get_mw_namespace_id("File"),
aplimit => 'max'
});
if (!defined($mw_pages)) {
print STDERR "fatal: could not get the list of pages for media files.\n";
print STDERR "fatal: '$url' does not appear to be a mediawiki\n";
print STDERR "fatal: make sure '$url/api.php' is a valid page.\n";
exit 1;
}
foreach my $page (@{$mw_pages}) {
$pages->{$page->{title}} = $page;
}
}
sub get_linked_mediafiles {
my $pages = shift;
my @titles = map $_->{title}, values(%{$pages});
# The query is split in small batches because of the MW API limit of
# the number of links to be returned (500 links max).
my $batch = 10;
while (@titles) {
if ($#titles < $batch) {
$batch = $#titles;
}
my @slice = @titles[0..$batch];
# pattern 'page1|page2|...' required by the API
my $mw_titles = join('|', @slice);
# Media files could be included or linked from
# a page, get all related
my $query = {
action => 'query',
prop => 'links|images',
titles => $mw_titles,
plnamespace => get_mw_namespace_id("File"),
pllimit => 'max'
};
my $result = $mediawiki->api($query);
while (my ($id, $page) = each(%{$result->{query}->{pages}})) {
my @titles;
if (defined($page->{links})) {
my @link_titles = map $_->{title}, @{$page->{links}};
push(@titles, @link_titles);
}
if (defined($page->{images})) {
my @image_titles = map $_->{title}, @{$page->{images}};
push(@titles, @image_titles);
}
if (@titles) {
get_mw_first_pages(\@titles, \%{$pages});
}
}
@titles = @titles[($batch+1)..$#titles];
}
}
sub get_mw_mediafile_for_page_revision {
# Name of the file on Wiki, with the prefix.
my $mw_filename = shift;
my $timestamp = shift;
my %mediafile;
# Search if on MediaWiki exists a media file with given
# timestamp. In that case download the file.
my $query = {
action => 'query',
prop => 'imageinfo',
titles => $mw_filename,
iistart => $timestamp,
iiend => $timestamp,
iiprop => 'timestamp|archivename|url',
iilimit => 1
};
my $result = $mediawiki->api($query);
my ($fileid, $file) = each ( %{$result->{query}->{pages}} );
# If not defined it means there is no revision of the file for
# given timestamp.
if (defined($file->{imageinfo})) {
# Get real name of media file.
my $filename;
if (index($mw_filename, 'File:') == 0) {
$filename = substr $mw_filename, 5;
} else {
$filename = substr $mw_filename, 6;
}
$mediafile{title} = $filename;
my $fileinfo = pop(@{$file->{imageinfo}});
$mediafile{timestamp} = $fileinfo->{timestamp};
# If this is an old version of the file, the file has to be
# obtained from the archive. Otherwise it can be downloaded
# by MediaWiki API download() function.
if (defined($fileinfo->{archivename})) {
$mediafile{content} = download_mw_mediafile_from_archive($fileinfo->{url});
} else {
$mediafile{content} = download_mw_mediafile($mw_filename);
}
}
return %mediafile;
}
sub download_mw_mediafile_from_archive {
my $url = shift;
my $file;
my $ua = LWP::UserAgent->new;
my $response = $ua->get($url);
if ($response->code) {
$file = $response->decoded_content;
} else {
print STDERR "Error downloading a file from archive.\n";
}
return $file;
}
sub download_mw_mediafile {
my $filename = shift;
$mediawiki->{config}->{files_url} = $url;
my $file_content = $mediawiki->download( { title => $filename } );
if (!defined($file_content)) {
print STDERR "\tFile \'$filename\' could not be downloaded.\n";
exit 1;
} elsif ($file_content eq "") {
print STDERR "\tFile \'$filename\' does not exist on the wiki.\n";
exit 1;
} else {
return $file_content;
}
}
sub get_last_local_revision {
# Get note regarding last mediawiki revision
my $note = run_git("notes --ref=$remotename/mediawiki show refs/mediawiki/$remotename/master 2>/dev/null");
@ -482,6 +642,16 @@ sub literal_data {
print STDOUT "data ", bytes::length($content), "\n", $content;
}
sub literal_data_raw {
# Output possibly binary content.
my ($content) = @_;
# Avoid confusion between size in bytes and in characters
utf8::downgrade($content);
binmode STDOUT, ":raw";
print STDOUT "data ", bytes::length($content), "\n", $content;
binmode STDOUT, ":utf8";
}
sub mw_capabilities {
# Revisions are imported to the private namespace
# refs/mediawiki/$remotename/ by the helper and fetched into
@ -569,6 +739,11 @@ sub import_file_revision {
my %commit = %{$commit};
my $full_import = shift;
my $n = shift;
my $mediafile = shift;
my %mediafile;
if ($mediafile) {
%mediafile = %{$mediafile};
}
my $title = $commit{title};
my $comment = $commit{comment};
@ -588,6 +763,10 @@ sub import_file_revision {
if ($content ne DELETED_CONTENT) {
print STDOUT "M 644 inline $title.mw\n";
literal_data($content);
if (%mediafile) {
print STDOUT "M 644 inline $mediafile{title}\n";
literal_data_raw($mediafile{content});
}
print STDOUT "\n\n";
} else {
print STDOUT "D $title.mw\n";
@ -683,12 +862,11 @@ sub mw_import_ref {
$n++;
my $page_title = $result->{query}->{pages}->{$pagerevid->{pageid}}->{title};
my %commit;
$commit{author} = $rev->{user} || 'Anonymous';
$commit{comment} = $rev->{comment} || '*Empty MediaWiki Message*';
$commit{title} = mediawiki_smudge_filename(
$result->{query}->{pages}->{$pagerevid->{pageid}}->{title}
);
$commit{title} = mediawiki_smudge_filename($page_title);
$commit{mw_revision} = $pagerevid->{revid};
$commit{content} = mediawiki_smudge($rev->{'*'});
@ -699,9 +877,25 @@ sub mw_import_ref {
}
$commit{date} = DateTime::Format::ISO8601->parse_datetime($last_timestamp);
print STDERR "$n/", scalar(@revisions), ": Revision #$pagerevid->{revid} of $commit{title}\n";
# Differentiates classic pages and media files.
my @prefix = split(":", $page_title);
import_file_revision(\%commit, ($fetch_from == 1), $n);
my %mediafile;
if ($prefix[0] eq "File" || $prefix[0] eq "Image") {
# The name of the file is the same as the media page.
my $filename = $page_title;
%mediafile = get_mw_mediafile_for_page_revision($filename, $rev->{timestamp});
}
# If this is a revision of the media page for new version
# of a file do one common commit for both file and media page.
# Else do commit only for that page.
print STDERR "$n/", scalar(@revisions), ": Revision #$pagerevid->{revid} of $commit{title}\n";
if (%mediafile) {
print STDERR "\tDownloading file $mediafile{title}, version $mediafile{timestamp}\n";
import_file_revision(\%commit, ($fetch_from == 1), $n, \%mediafile);
} else {
import_file_revision(\%commit, ($fetch_from == 1), $n);
}
}
if ($fetch_from == 1 && $n == 0) {
@ -1006,3 +1200,50 @@ sub get_allowed_file_extensions {
return %hashFile;
}
# Return MediaWiki id for a canonical namespace name.
# Ex.: "File", "Project".
# Looks for the namespace id in the local configuration
# variables, if it is not found asks MW API.
sub get_mw_namespace_id {
mw_connect_maybe();
my $name = shift;
if (!exists $namespace_id{$name}) {
# Look at configuration file, if the record for that namespace is
# already stored. Namespaces are stored in form:
# "Name_of_namespace:Id_namespace", ex.: "File:6".
my @temp = split(/[ \n]/, run_git("config --get-all remote."
. $remotename .".namespaces"));
chomp(@temp);
foreach my $ns (@temp) {
my ($n, $s) = split(/:/, $ns);
$namespace_id{$n} = $s;
}
}
if (!exists $namespace_id{$name}) {
# NS not found => get namespace id from MW and store it in
# configuration file.
my $query = {
action => 'query',
meta => 'siteinfo',
siprop => 'namespaces'
};
my $result = $mediawiki->api($query);
while (my ($id, $ns) = each(%{$result->{query}->{namespaces}})) {
if (defined($ns->{canonical}) && ($ns->{canonical} eq $name)) {
run_git("config --add remote.". $remotename
.".namespaces ". $name .":". $ns->{id});
$namespace_id{$name} = $ns->{id};
}
}
}
if (exists $namespace_id{$name}) {
return $namespace_id{$name};
} else {
die "No such namespace $name on MediaWiki.";
}
}