4 # Jérémie Nikaes <jeremie.nikaes@ensimag.imag.fr>
5 # Arnaud Lacurie <arnaud.lacurie@ensimag.imag.fr>
6 # Claire Fousse <claire.fousse@ensimag.imag.fr>
7 # David Amouyal <david.amouyal@ensimag.imag.fr>
8 # Matthieu Moy <matthieu.moy@grenoble-inp.fr>
9 # License: GPL v2 or later
11 # Gateway between Git and MediaWiki.
12 # Documentation & bugtracker: https://github.com/moy/Git-Mediawiki/
17 use DateTime::Format::ISO8601;
20 # By default, use UTF-8 to communicate with Git and the user
21 binmode STDERR, ":encoding(UTF-8)";
22 binmode STDOUT, ":encoding(UTF-8)";
27 # Mediawiki filenames can contain forward slashes. This variable decides by which pattern they should be replaced
28 use constant SLASH_REPLACEMENT => "%2F";
30 # It's not always possible to delete pages (may require some
31 # privileges). Deleted pages are replaced with this content.
32 use constant DELETED_CONTENT => "[[Category:Deleted]]\n";
34 # It's not possible to create empty pages. New empty files in Git are
35 # sent with this content instead.
36 use constant EMPTY_CONTENT => "<!-- empty page -->\n";
38 # used to reflect file creation or deletion in diff.
39 use constant NULL_SHA1 => "0000000000000000000000000000000000000000";
41 # Used on Git's side to reflect empty edit messages on the wiki
42 use constant EMPTY_MESSAGE => '*Empty MediaWiki Message*';
44 my $remotename = $ARGV[0];
47 # Accept both space-separated and multiple keys in config file.
48 # Spaces should be written as _ anyway because we'll use chomp.
49 my @tracked_pages = split(/[ \n]/, run_git("config --get-all remote.". $remotename .".pages"));
50 chomp(@tracked_pages);
52 # Just like @tracked_pages, but for MediaWiki categories.
53 my @tracked_categories = split(/[ \n]/, run_git("config --get-all remote.". $remotename .".categories"));
54 chomp(@tracked_categories);
56 # Import media files on pull
57 my $import_media = run_git("config --get --bool remote.". $remotename .".mediaimport");
59 $import_media = ($import_media eq "true");
61 # Export media files on push
62 my $export_media = run_git("config --get --bool remote.". $remotename .".mediaexport");
64 $export_media = !($export_media eq "false");
66 my $wiki_login = run_git("config --get remote.". $remotename .".mwLogin");
67 # Note: mwPassword is discourraged. Use the credential system instead.
68 my $wiki_passwd = run_git("config --get remote.". $remotename .".mwPassword");
69 my $wiki_domain = run_git("config --get remote.". $remotename .".mwDomain");
74 # Import only last revisions (both for clone and fetch)
75 my $shallow_import = run_git("config --get --bool remote.". $remotename .".shallow");
76 chomp($shallow_import);
77 $shallow_import = ($shallow_import eq "true");
79 # Fetch (clone and pull) by revisions instead of by pages. This behavior
80 # is more efficient when we have a wiki with lots of pages and we fetch
81 # the revisions quite often so that they concern only few pages.
83 # - by_rev: perform one query per new revision on the remote wiki
84 # - by_page: query each tracked page for new revision
85 my $fetch_strategy = run_git("config --get remote.$remotename.fetchStrategy");
86 unless ($fetch_strategy) {
87 $fetch_strategy = run_git("config --get mediawiki.fetchStrategy");
89 chomp($fetch_strategy);
90 unless ($fetch_strategy) {
91 $fetch_strategy = "by_page";
94 # Remember the timestamp corresponding to a revision id.
97 # Dumb push: don't update notes and mediawiki ref to reflect the last push.
99 # Configurable with mediawiki.dumbPush, or per-remote with
100 # remote.<remotename>.dumbPush.
102 # This means the user will have to re-import the just-pushed
103 # revisions. On the other hand, this means that the Git revisions
104 # corresponding to MediaWiki revisions are all imported from the wiki,
105 # regardless of whether they were initially created in Git or from the
106 # web interface, hence all users will get the same history (i.e. if
107 # the push from Git to MediaWiki loses some information, everybody
108 # will get the history with information lost). If the import is
109 # deterministic, this means everybody gets the same sha1 for each
110 # MediaWiki revision.
111 my $dumb_push = run_git("config --get --bool remote.$remotename.dumbPush");
112 unless ($dumb_push) {
113 $dumb_push = run_git("config --get --bool mediawiki.dumbPush");
116 $dumb_push = ($dumb_push eq "true");
118 my $wiki_name = $url;
119 $wiki_name =~ s{[^/]*://}{};
120 # If URL is like http://user:password@example.com/, we clearly don't
121 # want the password in $wiki_name. While we're there, also remove user
122 # and '@' sign, to avoid author like MWUser@HTTPUser@host.com
123 $wiki_name =~ s/^.*@//;
130 if (defined($cmd[0])) {
132 if ($cmd[0] eq "capabilities") {
133 die("Too many arguments for capabilities\n") if (defined($cmd[1]));
135 } elsif ($cmd[0] eq "list") {
136 die("Too many arguments for list\n") if (defined($cmd[2]));
138 } elsif ($cmd[0] eq "import") {
139 die("Invalid arguments for import\n") if ($cmd[1] eq "" || defined($cmd[2]));
141 } elsif ($cmd[0] eq "option") {
142 die("Too many arguments for option\n") if ($cmd[1] eq "" || $cmd[2] eq "" || defined($cmd[3]));
143 mw_option($cmd[1],$cmd[2]);
144 } elsif ($cmd[0] eq "push") {
147 print STDERR "Unknown command. Aborting...\n";
151 # blank line: we should terminate
155 BEGIN { $| = 1 } # flush STDOUT, to make sure the previous
156 # command is fully processed.
159 ########################## Functions ##############################
161 # MediaWiki API instance, created lazily.
164 sub mw_connect_maybe {
168 $mediawiki = MediaWiki::API->new;
169 $mediawiki->{config}->{api_url} = "$url/api.php";
173 'username' => $wiki_login,
174 'password' => $wiki_passwd
176 Git::credential(\%credential);
177 my $request = {lgname => $credential{username},
178 lgpassword => $credential{password},
179 lgdomain => $wiki_domain};
180 if ($mediawiki->login($request)) {
181 Git::credential(\%credential, 'approve');
182 print STDERR "Logged in mediawiki user \"$credential{username}\".\n";
184 print STDERR "Failed to log in mediawiki user \"$credential{username}\" on $url\n";
185 print STDERR " (error " .
186 $mediawiki->{error}->{code} . ': ' .
187 $mediawiki->{error}->{details} . ")\n";
188 Git::credential(\%credential, 'reject');
197 print STDERR "fatal: could not $action.\n";
198 print STDERR "fatal: '$url' does not appear to be a mediawiki\n";
199 if ($url =~ /^https/) {
200 print STDERR "fatal: make sure '$url/api.php' is a valid page\n";
201 print STDERR "fatal: and the SSL certificate is correct.\n";
203 print STDERR "fatal: make sure '$url/api.php' is a valid page.\n";
205 print STDERR "fatal: (error " .
206 $mediawiki->{error}->{code} . ': ' .
207 $mediawiki->{error}->{details} . ")\n";
211 ## Functions for listing pages on the remote wiki
212 sub get_mw_tracked_pages {
214 get_mw_page_list(\@tracked_pages, $pages);
218 sub get_mw_page_list {
219 my $page_list = shift;
221 my @some_pages = @$page_list;
222 while (@some_pages) {
224 if ($#some_pages < $last_page) {
225 $last_page = $#some_pages;
227 my @slice = @some_pages[0..$last_page];
228 get_mw_first_pages(\@slice, $pages);
229 @some_pages = @some_pages[51..$#some_pages];
234 sub get_mw_tracked_categories {
236 foreach my $category (@tracked_categories) {
237 if (index($category, ':') < 0) {
238 # Mediawiki requires the Category
239 # prefix, but let's not force the user
241 $category = "Category:" . $category;
243 my $mw_pages = $mediawiki->list( {
245 list => 'categorymembers',
246 cmtitle => $category,
248 || die $mediawiki->{error}->{code} . ': '
249 . $mediawiki->{error}->{details} . "\n";
250 foreach my $page (@{$mw_pages}) {
251 $pages->{$page->{title}} = $page;
257 sub get_mw_all_pages {
259 # No user-provided list, get the list of pages from the API.
260 my $mw_pages = $mediawiki->list({
265 if (!defined($mw_pages)) {
266 fatal_mw_error("get the list of wiki pages");
268 foreach my $page (@{$mw_pages}) {
269 $pages->{$page->{title}} = $page;
274 # queries the wiki for a set of pages. Meant to be used within a loop
275 # querying the wiki for slices of page list.
276 sub get_mw_first_pages {
277 my $some_pages = shift;
278 my @some_pages = @{$some_pages};
282 # pattern 'page1|page2|...' required by the API
283 my $titles = join('|', @some_pages);
285 my $mw_pages = $mediawiki->api({
289 if (!defined($mw_pages)) {
290 fatal_mw_error("query the list of wiki pages");
292 while (my ($id, $page) = each(%{$mw_pages->{query}->{pages}})) {
294 print STDERR "Warning: page $page->{title} not found on wiki\n";
296 $pages->{$page->{title}} = $page;
302 # Get the list of pages to be fetched according to configuration.
306 print STDERR "Listing pages on remote wiki...\n";
308 my %pages; # hash on page titles to avoid duplicates
310 if (@tracked_pages) {
312 # The user provided a list of pages titles, but we
313 # still need to query the API to get the page IDs.
314 get_mw_tracked_pages(\%pages);
316 if (@tracked_categories) {
318 get_mw_tracked_categories(\%pages);
320 if (!$user_defined) {
321 get_mw_all_pages(\%pages);
324 print STDERR "Getting media files for selected pages...\n";
326 get_linked_mediafiles(\%pages);
328 get_all_mediafiles(\%pages);
331 print STDERR (scalar keys %pages) . " pages found.\n";
335 # usage: $out = run_git("command args");
336 # $out = run_git("command args", "raw"); # don't interpret output as UTF-8.
339 my $encoding = (shift || "encoding(UTF-8)");
340 open(my $git, "-|:$encoding", "git " . $args);
351 sub get_all_mediafiles {
353 # Attach list of all pages for media files from the API,
354 # they are in a different namespace, only one namespace
355 # can be queried at the same moment
356 my $mw_pages = $mediawiki->list({
359 apnamespace => get_mw_namespace_id("File"),
362 if (!defined($mw_pages)) {
363 print STDERR "fatal: could not get the list of pages for media files.\n";
364 print STDERR "fatal: '$url' does not appear to be a mediawiki\n";
365 print STDERR "fatal: make sure '$url/api.php' is a valid page.\n";
368 foreach my $page (@{$mw_pages}) {
369 $pages->{$page->{title}} = $page;
374 sub get_linked_mediafiles {
376 my @titles = map { $_->{title} } values(%{$pages});
378 # The query is split in small batches because of the MW API limit of
379 # the number of links to be returned (500 links max).
382 if ($#titles < $batch) {
385 my @slice = @titles[0..$batch];
387 # pattern 'page1|page2|...' required by the API
388 my $mw_titles = join('|', @slice);
390 # Media files could be included or linked from
391 # a page, get all related
394 prop => 'links|images',
395 titles => $mw_titles,
396 plnamespace => get_mw_namespace_id("File"),
399 my $result = $mediawiki->api($query);
401 while (my ($id, $page) = each(%{$result->{query}->{pages}})) {
403 if (defined($page->{links})) {
405 = map { $_->{title} } @{$page->{links}};
406 push(@media_titles, @link_titles);
408 if (defined($page->{images})) {
410 = map { $_->{title} } @{$page->{images}};
411 push(@media_titles, @image_titles);
414 get_mw_page_list(\@media_titles, $pages);
418 @titles = @titles[($batch+1)..$#titles];
423 sub get_mw_mediafile_for_page_revision {
424 # Name of the file on Wiki, with the prefix.
425 my $filename = shift;
426 my $timestamp = shift;
429 # Search if on a media file with given timestamp exists on
430 # MediaWiki. In that case download the file.
434 titles => "File:" . $filename,
435 iistart => $timestamp,
437 iiprop => 'timestamp|archivename|url',
440 my $result = $mediawiki->api($query);
442 my ($fileid, $file) = each( %{$result->{query}->{pages}} );
443 # If not defined it means there is no revision of the file for
445 if (defined($file->{imageinfo})) {
446 $mediafile{title} = $filename;
448 my $fileinfo = pop(@{$file->{imageinfo}});
449 $mediafile{timestamp} = $fileinfo->{timestamp};
450 # Mediawiki::API's download function doesn't support https URLs
451 # and can't download old versions of files.
452 print STDERR "\tDownloading file $mediafile{title}, version $mediafile{timestamp}\n";
453 $mediafile{content} = download_mw_mediafile($fileinfo->{url});
458 sub download_mw_mediafile {
459 my $download_url = shift;
461 my $response = $mediawiki->{ua}->get($download_url);
462 if ($response->code == 200) {
463 return $response->decoded_content;
465 print STDERR "Error downloading mediafile from :\n";
466 print STDERR "URL: $download_url\n";
467 print STDERR "Server response: " . $response->code . " " . $response->message . "\n";
472 sub get_last_local_revision {
473 # Get note regarding last mediawiki revision
474 my $note = run_git("notes --ref=$remotename/mediawiki show refs/mediawiki/$remotename/master 2>/dev/null");
475 my @note_info = split(/ /, $note);
477 my $lastrevision_number;
478 if (!(defined($note_info[0]) && $note_info[0] eq "mediawiki_revision:")) {
479 print STDERR "No previous mediawiki revision found";
480 $lastrevision_number = 0;
482 # Notes are formatted : mediawiki_revision: #number
483 $lastrevision_number = $note_info[1];
484 chomp($lastrevision_number);
485 print STDERR "Last local mediawiki revision found is $lastrevision_number";
487 return $lastrevision_number;
490 # Get the last remote revision without taking in account which pages are
491 # tracked or not. This function makes a single request to the wiki thus
492 # avoid a loop onto all tracked pages. This is useful for the fetch-by-rev
494 sub get_last_global_remote_rev {
499 list => 'recentchanges',
504 my $result = $mediawiki->api($query);
505 return $result->{query}->{recentchanges}[0]->{revid};
508 # Get the last remote revision concerning the tracked pages and the tracked
510 sub get_last_remote_revision {
513 my %pages_hash = get_mw_pages();
514 my @pages = values(%pages_hash);
518 print STDERR "Getting last revision id on tracked pages...\n";
520 foreach my $page (@pages) {
521 my $id = $page->{pageid};
526 rvprop => 'ids|timestamp',
530 my $result = $mediawiki->api($query);
532 my $lastrev = pop(@{$result->{query}->{pages}->{$id}->{revisions}});
534 $basetimestamps{$lastrev->{revid}} = $lastrev->{timestamp};
536 $max_rev_num = ($lastrev->{revid} > $max_rev_num ? $lastrev->{revid} : $max_rev_num);
539 print STDERR "Last remote revision found is $max_rev_num.\n";
543 # Clean content before sending it to MediaWiki
544 sub mediawiki_clean {
546 my $page_created = shift;
547 # Mediawiki does not allow blank space at the end of a page and ends with a single \n.
548 # This function right trims a string and adds a \n at the end to follow this rule
550 if ($string eq "" && $page_created) {
551 # Creating empty pages is forbidden.
552 $string = EMPTY_CONTENT;
557 # Filter applied on MediaWiki data before adding them to Git
558 sub mediawiki_smudge {
560 if ($string eq EMPTY_CONTENT) {
563 # This \n is important. This is due to mediawiki's way to handle end of files.
567 sub mediawiki_clean_filename {
568 my $filename = shift;
569 $filename =~ s{@{[SLASH_REPLACEMENT]}}{/}g;
570 # [, ], |, {, and } are forbidden by MediaWiki, even URL-encoded.
571 # Do a variant of URL-encoding, i.e. looks like URL-encoding,
572 # but with _ added to prevent MediaWiki from thinking this is
573 # an actual special character.
574 $filename =~ s/[\[\]\{\}\|]/sprintf("_%%_%x", ord($&))/ge;
575 # If we use the uri escape before
576 # we should unescape here, before anything
581 sub mediawiki_smudge_filename {
582 my $filename = shift;
583 $filename =~ s{/}{@{[SLASH_REPLACEMENT]}}g;
584 $filename =~ s/ /_/g;
585 # Decode forbidden characters encoded in mediawiki_clean_filename
586 $filename =~ s/_%_([0-9a-fA-F][0-9a-fA-F])/sprintf("%c", hex($1))/ge;
592 print STDOUT "data ", bytes::length($content), "\n", $content;
596 sub literal_data_raw {
597 # Output possibly binary content.
599 # Avoid confusion between size in bytes and in characters
600 utf8::downgrade($content);
601 binmode STDOUT, ":raw";
602 print STDOUT "data ", bytes::length($content), "\n", $content;
603 binmode STDOUT, ":encoding(UTF-8)";
607 sub mw_capabilities {
608 # Revisions are imported to the private namespace
609 # refs/mediawiki/$remotename/ by the helper and fetched into
610 # refs/remotes/$remotename later by fetch.
611 print STDOUT "refspec refs/heads/*:refs/mediawiki/$remotename/*\n";
612 print STDOUT "import\n";
613 print STDOUT "list\n";
614 print STDOUT "push\n";
620 # MediaWiki do not have branches, we consider one branch arbitrarily
621 # called master, and HEAD pointing to it.
622 print STDOUT "? refs/heads/master\n";
623 print STDOUT "\@refs/heads/master HEAD\n";
629 print STDERR "remote-helper command 'option $_[0]' not yet implemented\n";
630 print STDOUT "unsupported\n";
634 sub fetch_mw_revisions_for_page {
637 my $fetch_from = shift;
644 rvstartid => $fetch_from,
650 # Get 500 revisions at a time due to the mediawiki api limit
652 my $result = $mediawiki->api($query);
654 # Parse each of those 500 revisions
655 foreach my $revision (@{$result->{query}->{pages}->{$id}->{revisions}}) {
657 $page_rev_ids->{pageid} = $page->{pageid};
658 $page_rev_ids->{revid} = $revision->{revid};
659 push(@page_revs, $page_rev_ids);
662 last unless $result->{'query-continue'};
663 $query->{rvstartid} = $result->{'query-continue'}->{revisions}->{rvstartid};
665 if ($shallow_import && @page_revs) {
666 print STDERR " Found 1 revision (shallow import).\n";
667 @page_revs = sort {$b->{revid} <=> $a->{revid}} (@page_revs);
668 return $page_revs[0];
670 print STDERR " Found ", $revnum, " revision(s).\n";
674 sub fetch_mw_revisions {
675 my $pages = shift; my @pages = @{$pages};
676 my $fetch_from = shift;
680 foreach my $page (@pages) {
681 my $id = $page->{pageid};
683 print STDERR "page $n/", scalar(@pages), ": ". $page->{title} ."\n";
685 my @page_revs = fetch_mw_revisions_for_page($page, $id, $fetch_from);
686 @revisions = (@page_revs, @revisions);
689 return ($n, @revisions);
694 $path =~ s/\\/\\\\/g;
697 return '"' . $path . '"';
700 sub import_file_revision {
702 my %commit = %{$commit};
703 my $full_import = shift;
705 my $mediafile = shift;
708 %mediafile = %{$mediafile};
711 my $title = $commit{title};
712 my $comment = $commit{comment};
713 my $content = $commit{content};
714 my $author = $commit{author};
715 my $date = $commit{date};
717 print STDOUT "commit refs/mediawiki/$remotename/master\n";
718 print STDOUT "mark :$n\n";
719 print STDOUT "committer $author <$author\@$wiki_name> ", $date->epoch, " +0000\n";
720 literal_data($comment);
722 # If it's not a clone, we need to know where to start from
723 if (!$full_import && $n == 1) {
724 print STDOUT "from refs/mediawiki/$remotename/master^0\n";
726 if ($content ne DELETED_CONTENT) {
727 print STDOUT "M 644 inline " .
728 fe_escape_path($title . ".mw") . "\n";
729 literal_data($content);
731 print STDOUT "M 644 inline "
732 . fe_escape_path($mediafile{title}) . "\n";
733 literal_data_raw($mediafile{content});
737 print STDOUT "D " . fe_escape_path($title . ".mw") . "\n";
740 # mediawiki revision number in the git note
741 if ($full_import && $n == 1) {
742 print STDOUT "reset refs/notes/$remotename/mediawiki\n";
744 print STDOUT "commit refs/notes/$remotename/mediawiki\n";
745 print STDOUT "committer $author <$author\@$wiki_name> ", $date->epoch, " +0000\n";
746 literal_data("Note added by git-mediawiki during import");
747 if (!$full_import && $n == 1) {
748 print STDOUT "from refs/notes/$remotename/mediawiki^0\n";
750 print STDOUT "N inline :$n\n";
751 literal_data("mediawiki_revision: " . $commit{mw_revision});
756 # parse a sequence of
760 # (like batch sequence of import and sequence of push statements)
766 if ($line =~ /^$cmd (.*)$/) {
768 } elsif ($line eq "\n") {
771 die("Invalid command in a '$cmd' batch: $_\n");
778 # multiple import commands can follow each other.
779 my @refs = (shift, get_more_refs("import"));
780 foreach my $ref (@refs) {
783 print STDOUT "done\n";
789 # The remote helper will call "import HEAD" and
790 # "import refs/heads/master".
791 # Since HEAD is a symbolic ref to master (by convention,
792 # followed by the output of the command "list" that we gave),
793 # we don't need to do anything in this case.
794 if ($ref eq "HEAD") {
800 print STDERR "Searching revisions...\n";
801 my $last_local = get_last_local_revision();
802 my $fetch_from = $last_local + 1;
803 if ($fetch_from == 1) {
804 print STDERR ", fetching from beginning.\n";
806 print STDERR ", fetching from here.\n";
810 if ($fetch_strategy eq "by_rev") {
811 print STDERR "Fetching & writing export data by revs...\n";
812 $n = mw_import_ref_by_revs($fetch_from);
813 } elsif ($fetch_strategy eq "by_page") {
814 print STDERR "Fetching & writing export data by pages...\n";
815 $n = mw_import_ref_by_pages($fetch_from);
817 print STDERR "fatal: invalid fetch strategy \"$fetch_strategy\".\n";
818 print STDERR "Check your configuration variables remote.$remotename.fetchStrategy and mediawiki.fetchStrategy\n";
822 if ($fetch_from == 1 && $n == 0) {
823 print STDERR "You appear to have cloned an empty MediaWiki.\n";
824 # Something has to be done remote-helper side. If nothing is done, an error is
825 # thrown saying that HEAD is referring to unknown object 0000000000000000000
826 # and the clone fails.
831 sub mw_import_ref_by_pages {
833 my $fetch_from = shift;
834 my %pages_hash = get_mw_pages();
835 my @pages = values(%pages_hash);
837 my ($n, @revisions) = fetch_mw_revisions(\@pages, $fetch_from);
839 @revisions = sort {$a->{revid} <=> $b->{revid}} @revisions;
840 my @revision_ids = map { $_->{revid} } @revisions;
842 return mw_import_revids($fetch_from, \@revision_ids, \%pages_hash);
845 sub mw_import_ref_by_revs {
847 my $fetch_from = shift;
848 my %pages_hash = get_mw_pages();
850 my $last_remote = get_last_global_remote_rev();
851 my @revision_ids = $fetch_from..$last_remote;
852 return mw_import_revids($fetch_from, \@revision_ids, \%pages_hash);
855 # Import revisions given in second argument (array of integers).
856 # Only pages appearing in the third argument (hash indexed by page titles)
858 sub mw_import_revids {
859 my $fetch_from = shift;
860 my $revision_ids = shift;
865 my $last_timestamp = 0; # Placeholer in case $rev->timestamp is undefined
867 foreach my $pagerevid (@$revision_ids) {
868 # Count page even if we skip it, since we display
869 # $n/$total and $total includes skipped pages.
872 # fetch the content of the pages
876 rvprop => 'content|timestamp|comment|user|ids',
877 revids => $pagerevid,
880 my $result = $mediawiki->api($query);
883 die "Failed to retrieve modified page for revision $pagerevid\n";
886 if (defined($result->{query}->{badrevids}->{$pagerevid})) {
887 # The revision id does not exist on the remote wiki.
891 if (!defined($result->{query}->{pages})) {
892 die "Invalid revision $pagerevid.\n";
895 my @result_pages = values(%{$result->{query}->{pages}});
896 my $result_page = $result_pages[0];
897 my $rev = $result_pages[0]->{revisions}->[0];
899 my $page_title = $result_page->{title};
901 if (!exists($pages->{$page_title})) {
902 print STDERR "$n/", scalar(@$revision_ids),
903 ": Skipping revision #$rev->{revid} of $page_title\n";
910 $commit{author} = $rev->{user} || 'Anonymous';
911 $commit{comment} = $rev->{comment} || EMPTY_MESSAGE;
912 $commit{title} = mediawiki_smudge_filename($page_title);
913 $commit{mw_revision} = $rev->{revid};
914 $commit{content} = mediawiki_smudge($rev->{'*'});
916 if (!defined($rev->{timestamp})) {
919 $last_timestamp = $rev->{timestamp};
921 $commit{date} = DateTime::Format::ISO8601->parse_datetime($last_timestamp);
923 # Differentiates classic pages and media files.
924 my ($namespace, $filename) = $page_title =~ /^([^:]*):(.*)$/;
927 my $id = get_mw_namespace_id($namespace);
928 if ($id && $id == get_mw_namespace_id("File")) {
929 %mediafile = get_mw_mediafile_for_page_revision($filename, $rev->{timestamp});
932 # If this is a revision of the media page for new version
933 # of a file do one common commit for both file and media page.
934 # Else do commit only for that page.
935 print STDERR "$n/", scalar(@$revision_ids), ": Revision #$rev->{revid} of $commit{title}\n";
936 import_file_revision(\%commit, ($fetch_from == 1), $n_actual, \%mediafile);
942 sub error_non_fast_forward {
943 my $advice = run_git("config --bool advice.pushNonFastForward");
945 if ($advice ne "false") {
946 # Native git-push would show this after the summary.
947 # We can't ask it to display it cleanly, so print it
949 print STDERR "To prevent you from losing history, non-fast-forward updates were rejected\n";
950 print STDERR "Merge the remote changes (e.g. 'git pull') before pushing again. See the\n";
951 print STDERR "'Note about fast-forwards' section of 'git push --help' for details.\n";
953 print STDOUT "error $_[0] \"non-fast-forward\"\n";
958 my $complete_file_name = shift;
959 my $new_sha1 = shift;
960 my $extension = shift;
961 my $file_deleted = shift;
964 my $path = "File:" . $complete_file_name;
965 my %hashFiles = get_allowed_file_extensions();
966 if (!exists($hashFiles{$extension})) {
967 print STDERR "$complete_file_name is not a permitted file on this wiki.\n";
968 print STDERR "Check the configuration of file uploads in your mediawiki.\n";
971 # Deleting and uploading a file requires a priviledged user
979 if (!$mediawiki->edit($query)) {
980 print STDERR "Failed to delete file on remote wiki\n";
981 print STDERR "Check your permissions on the remote site. Error code:\n";
982 print STDERR $mediawiki->{error}->{code} . ':' . $mediawiki->{error}->{details};
986 # Don't let perl try to interpret file content as UTF-8 => use "raw"
987 my $content = run_git("cat-file blob $new_sha1", "raw");
988 if ($content ne "") {
990 $mediawiki->{config}->{upload_url} =
991 "$url/index.php/Special:Upload";
994 filename => $complete_file_name,
998 Content => $content],
1002 } ) || die $mediawiki->{error}->{code} . ':'
1003 . $mediawiki->{error}->{details} . "\n";
1004 my $last_file_page = $mediawiki->get_page({title => $path});
1005 $newrevid = $last_file_page->{revid};
1006 print STDERR "Pushed file: $new_sha1 - $complete_file_name.\n";
1008 print STDERR "Empty file $complete_file_name not pushed.\n";
1015 my $diff_info = shift;
1016 # $diff_info contains a string in this format:
1017 # 100644 100644 <sha1_of_blob_before_commit> <sha1_of_blob_now> <status>
1018 my @diff_info_split = split(/[ \t]/, $diff_info);
1020 # Filename, including .mw extension
1021 my $complete_file_name = shift;
1023 my $summary = shift;
1024 # MediaWiki revision number. Keep the previous one by default,
1025 # in case there's no edit to perform.
1026 my $oldrevid = shift;
1029 if ($summary eq EMPTY_MESSAGE) {
1033 my $new_sha1 = $diff_info_split[3];
1034 my $old_sha1 = $diff_info_split[2];
1035 my $page_created = ($old_sha1 eq NULL_SHA1);
1036 my $page_deleted = ($new_sha1 eq NULL_SHA1);
1037 $complete_file_name = mediawiki_clean_filename($complete_file_name);
1039 my ($title, $extension) = $complete_file_name =~ /^(.*)\.([^\.]*)$/;
1040 if (!defined($extension)) {
1043 if ($extension eq "mw") {
1044 my $ns = get_mw_namespace_id_for_page($complete_file_name);
1045 if ($ns && $ns == get_mw_namespace_id("File") && (!$export_media)) {
1046 print STDERR "Ignoring media file related page: $complete_file_name\n";
1047 return ($oldrevid, "ok");
1050 if ($page_deleted) {
1051 # Deleting a page usually requires
1052 # special privileges. A common
1053 # convention is to replace the page
1054 # with this content instead:
1055 $file_content = DELETED_CONTENT;
1057 $file_content = run_git("cat-file blob $new_sha1");
1062 my $result = $mediawiki->edit( {
1064 summary => $summary,
1066 basetimestamp => $basetimestamps{$oldrevid},
1067 text => mediawiki_clean($file_content, $page_created),
1069 skip_encoding => 1 # Helps with names with accentuated characters
1072 if ($mediawiki->{error}->{code} == 3) {
1073 # edit conflicts, considered as non-fast-forward
1074 print STDERR 'Warning: Error ' .
1075 $mediawiki->{error}->{code} .
1076 ' from mediwiki: ' . $mediawiki->{error}->{details} .
1078 return ($oldrevid, "non-fast-forward");
1080 # Other errors. Shouldn't happen => just die()
1081 die 'Fatal: Error ' .
1082 $mediawiki->{error}->{code} .
1083 ' from mediwiki: ' . $mediawiki->{error}->{details} . "\n";
1086 $newrevid = $result->{edit}->{newrevid};
1087 print STDERR "Pushed file: $new_sha1 - $title\n";
1088 } elsif ($export_media) {
1089 $newrevid = mw_upload_file($complete_file_name, $new_sha1,
1090 $extension, $page_deleted,
1093 print STDERR "Ignoring media file $title\n";
1095 $newrevid = ($newrevid or $oldrevid);
1096 return ($newrevid, "ok");
1100 # multiple push statements can follow each other
1101 my @refsspecs = (shift, get_more_refs("push"));
1103 for my $refspec (@refsspecs) {
1104 my ($force, $local, $remote) = $refspec =~ /^(\+)?([^:]*):([^:]*)$/
1105 or die("Invalid refspec for push. Expected <src>:<dst> or +<src>:<dst>\n");
1107 print STDERR "Warning: forced push not allowed on a MediaWiki.\n";
1110 print STDERR "Cannot delete remote branch on a MediaWiki\n";
1111 print STDOUT "error $remote cannot delete\n";
1114 if ($remote ne "refs/heads/master") {
1115 print STDERR "Only push to the branch 'master' is supported on a MediaWiki\n";
1116 print STDOUT "error $remote only master allowed\n";
1119 if (mw_push_revision($local, $remote)) {
1124 # Notify Git that the push is done
1127 if ($pushed && $dumb_push) {
1128 print STDERR "Just pushed some revisions to MediaWiki.\n";
1129 print STDERR "The pushed revisions now have to be re-imported, and your current branch\n";
1130 print STDERR "needs to be updated with these re-imported commits. You can do this with\n";
1132 print STDERR " git pull --rebase\n";
1138 sub mw_push_revision {
1140 my $remote = shift; # actually, this has to be "refs/heads/master" at this point.
1141 my $last_local_revid = get_last_local_revision();
1142 print STDERR ".\n"; # Finish sentence started by get_last_local_revision()
1143 my $last_remote_revid = get_last_remote_revision();
1144 my $mw_revision = $last_remote_revid;
1146 # Get sha1 of commit pointed by local HEAD
1147 my $HEAD_sha1 = run_git("rev-parse $local 2>/dev/null"); chomp($HEAD_sha1);
1148 # Get sha1 of commit pointed by remotes/$remotename/master
1149 my $remoteorigin_sha1 = run_git("rev-parse refs/remotes/$remotename/master 2>/dev/null");
1150 chomp($remoteorigin_sha1);
1152 if ($last_local_revid > 0 &&
1153 $last_local_revid < $last_remote_revid) {
1154 return error_non_fast_forward($remote);
1157 if ($HEAD_sha1 eq $remoteorigin_sha1) {
1162 # Get every commit in between HEAD and refs/remotes/origin/master,
1163 # including HEAD and refs/remotes/origin/master
1164 my @commit_pairs = ();
1165 if ($last_local_revid > 0) {
1166 my $parsed_sha1 = $remoteorigin_sha1;
1167 # Find a path from last MediaWiki commit to pushed commit
1168 print STDERR "Computing path from local to remote ...\n";
1169 my @local_ancestry = split(/\n/, run_git("rev-list --boundary --parents $local ^$parsed_sha1"));
1171 foreach my $line (@local_ancestry) {
1172 if (my ($child, $parents) = $line =~ /^-?([a-f0-9]+) ([a-f0-9 ]+)/) {
1173 foreach my $parent (split(/ /, $parents)) {
1174 $local_ancestry{$parent} = $child;
1176 } elsif (!$line =~ /^([a-f0-9]+)/) {
1177 die "Unexpected output from git rev-list: $line\n";
1180 while ($parsed_sha1 ne $HEAD_sha1) {
1181 my $child = $local_ancestry{$parsed_sha1};
1183 printf STDERR "Cannot find a path in history from remote commit to last commit\n";
1184 return error_non_fast_forward($remote);
1186 push(@commit_pairs, [$parsed_sha1, $child]);
1187 $parsed_sha1 = $child;
1190 # No remote mediawiki revision. Export the whole
1191 # history (linearized with --first-parent)
1192 print STDERR "Warning: no common ancestor, pushing complete history\n";
1193 my $history = run_git("rev-list --first-parent --children $local");
1194 my @history = split(/\n/, $history);
1195 @history = @history[1..$#history];
1196 foreach my $line (reverse @history) {
1197 my @commit_info_split = split(/[ \n]/, $line);
1198 push(@commit_pairs, \@commit_info_split);
1202 foreach my $commit_info_split (@commit_pairs) {
1203 my $sha1_child = @{$commit_info_split}[0];
1204 my $sha1_commit = @{$commit_info_split}[1];
1205 my $diff_infos = run_git("diff-tree -r --raw -z $sha1_child $sha1_commit");
1206 # TODO: we could detect rename, and encode them with a #redirect on the wiki.
1207 # TODO: for now, it's just a delete+add
1208 my @diff_info_list = split(/\0/, $diff_infos);
1209 # Keep the subject line of the commit message as mediawiki comment for the revision
1210 my $commit_msg = run_git("log --no-walk --format=\"%s\" $sha1_commit");
1213 while (@diff_info_list) {
1215 # git diff-tree -z gives an output like
1216 # <metadata>\0<filename1>\0
1217 # <metadata>\0<filename2>\0
1218 # and we've split on \0.
1219 my $info = shift(@diff_info_list);
1220 my $file = shift(@diff_info_list);
1221 ($mw_revision, $status) = mw_push_file($info, $file, $commit_msg, $mw_revision);
1222 if ($status eq "non-fast-forward") {
1223 # we may already have sent part of the
1224 # commit to MediaWiki, but it's too
1225 # late to cancel it. Stop the push in
1226 # the middle, but still give an
1227 # accurate error message.
1228 return error_non_fast_forward($remote);
1230 if ($status ne "ok") {
1231 die("Unknown error from mw_push_file()\n");
1234 unless ($dumb_push) {
1235 run_git("notes --ref=$remotename/mediawiki add -f -m \"mediawiki_revision: $mw_revision\" $sha1_commit");
1236 run_git("update-ref -m \"Git-MediaWiki push\" refs/mediawiki/$remotename/master $sha1_commit $sha1_child");
1240 print STDOUT "ok $remote\n";
1244 sub get_allowed_file_extensions {
1250 siprop => 'fileextensions'
1252 my $result = $mediawiki->api($query);
1253 my @file_extensions = map { $_->{ext}} @{$result->{query}->{fileextensions}};
1254 my %hashFile = map { $_ => 1 } @file_extensions;
1259 # In memory cache for MediaWiki namespace ids.
1262 # Namespaces whose id is cached in the configuration file
1263 # (to avoid duplicates)
1264 my %cached_mw_namespace_id;
1266 # Return MediaWiki id for a canonical namespace name.
1267 # Ex.: "File", "Project".
1268 sub get_mw_namespace_id {
1272 if (!exists $namespace_id{$name}) {
1273 # Look at configuration file, if the record for that namespace is
1274 # already cached. Namespaces are stored in form:
1275 # "Name_of_namespace:Id_namespace", ex.: "File:6".
1276 my @temp = split(/\n/, run_git("config --get-all remote."
1277 . $remotename .".namespaceCache"));
1279 foreach my $ns (@temp) {
1280 my ($n, $id) = split(/:/, $ns);
1281 if ($id eq 'notANameSpace') {
1282 $namespace_id{$n} = {is_namespace => 0};
1284 $namespace_id{$n} = {is_namespace => 1, id => $id};
1286 $cached_mw_namespace_id{$n} = 1;
1290 if (!exists $namespace_id{$name}) {
1291 print STDERR "Namespace $name not found in cache, querying the wiki ...\n";
1292 # NS not found => get namespace id from MW and store it in
1293 # configuration file.
1297 siprop => 'namespaces'
1299 my $result = $mediawiki->api($query);
1301 while (my ($id, $ns) = each(%{$result->{query}->{namespaces}})) {
1302 if (defined($ns->{id}) && defined($ns->{canonical})) {
1303 $namespace_id{$ns->{canonical}} = {is_namespace => 1, id => $ns->{id}};
1305 # alias (e.g. french Fichier: as alias for canonical File:)
1306 $namespace_id{$ns->{'*'}} = {is_namespace => 1, id => $ns->{id}};
1312 my $ns = $namespace_id{$name};
1315 unless (defined $ns) {
1316 print STDERR "No such namespace $name on MediaWiki.\n";
1317 $ns = {is_namespace => 0};
1318 $namespace_id{$name} = $ns;
1321 if ($ns->{is_namespace}) {
1325 # Store "notANameSpace" as special value for inexisting namespaces
1326 my $store_id = ($id || 'notANameSpace');
1328 # Store explicitely requested namespaces on disk
1329 if (!exists $cached_mw_namespace_id{$name}) {
1330 run_git("config --add remote.". $remotename
1331 .".namespaceCache \"". $name .":". $store_id ."\"");
1332 $cached_mw_namespace_id{$name} = 1;
1337 sub get_mw_namespace_id_for_page {
1338 my $namespace = shift;
1339 if ($namespace =~ /^([^:]*):/) {
1340 return get_mw_namespace_id($namespace);