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)
341 or die "Unable to open: $!\n";
352 sub get_all_mediafiles {
354 # Attach list of all pages for media files from the API,
355 # they are in a different namespace, only one namespace
356 # can be queried at the same moment
357 my $mw_pages = $mediawiki->list({
360 apnamespace => get_mw_namespace_id("File"),
363 if (!defined($mw_pages)) {
364 print STDERR "fatal: could not get the list of pages for media files.\n";
365 print STDERR "fatal: '$url' does not appear to be a mediawiki\n";
366 print STDERR "fatal: make sure '$url/api.php' is a valid page.\n";
369 foreach my $page (@{$mw_pages}) {
370 $pages->{$page->{title}} = $page;
375 sub get_linked_mediafiles {
377 my @titles = map { $_->{title} } values(%{$pages});
379 # The query is split in small batches because of the MW API limit of
380 # the number of links to be returned (500 links max).
383 if ($#titles < $batch) {
386 my @slice = @titles[0..$batch];
388 # pattern 'page1|page2|...' required by the API
389 my $mw_titles = join('|', @slice);
391 # Media files could be included or linked from
392 # a page, get all related
395 prop => 'links|images',
396 titles => $mw_titles,
397 plnamespace => get_mw_namespace_id("File"),
400 my $result = $mediawiki->api($query);
402 while (my ($id, $page) = each(%{$result->{query}->{pages}})) {
404 if (defined($page->{links})) {
406 = map { $_->{title} } @{$page->{links}};
407 push(@media_titles, @link_titles);
409 if (defined($page->{images})) {
411 = map { $_->{title} } @{$page->{images}};
412 push(@media_titles, @image_titles);
415 get_mw_page_list(\@media_titles, $pages);
419 @titles = @titles[($batch+1)..$#titles];
424 sub get_mw_mediafile_for_page_revision {
425 # Name of the file on Wiki, with the prefix.
426 my $filename = shift;
427 my $timestamp = shift;
430 # Search if on a media file with given timestamp exists on
431 # MediaWiki. In that case download the file.
435 titles => "File:" . $filename,
436 iistart => $timestamp,
438 iiprop => 'timestamp|archivename|url',
441 my $result = $mediawiki->api($query);
443 my ($fileid, $file) = each( %{$result->{query}->{pages}} );
444 # If not defined it means there is no revision of the file for
446 if (defined($file->{imageinfo})) {
447 $mediafile{title} = $filename;
449 my $fileinfo = pop(@{$file->{imageinfo}});
450 $mediafile{timestamp} = $fileinfo->{timestamp};
451 # Mediawiki::API's download function doesn't support https URLs
452 # and can't download old versions of files.
453 print STDERR "\tDownloading file $mediafile{title}, version $mediafile{timestamp}\n";
454 $mediafile{content} = download_mw_mediafile($fileinfo->{url});
459 sub download_mw_mediafile {
460 my $download_url = shift;
462 my $response = $mediawiki->{ua}->get($download_url);
463 if ($response->code == 200) {
464 return $response->decoded_content;
466 print STDERR "Error downloading mediafile from :\n";
467 print STDERR "URL: $download_url\n";
468 print STDERR "Server response: " . $response->code . " " . $response->message . "\n";
473 sub get_last_local_revision {
474 # Get note regarding last mediawiki revision
475 my $note = run_git("notes --ref=$remotename/mediawiki show refs/mediawiki/$remotename/master 2>/dev/null");
476 my @note_info = split(/ /, $note);
478 my $lastrevision_number;
479 if (!(defined($note_info[0]) && $note_info[0] eq "mediawiki_revision:")) {
480 print STDERR "No previous mediawiki revision found";
481 $lastrevision_number = 0;
483 # Notes are formatted : mediawiki_revision: #number
484 $lastrevision_number = $note_info[1];
485 chomp($lastrevision_number);
486 print STDERR "Last local mediawiki revision found is $lastrevision_number";
488 return $lastrevision_number;
491 # Get the last remote revision without taking in account which pages are
492 # tracked or not. This function makes a single request to the wiki thus
493 # avoid a loop onto all tracked pages. This is useful for the fetch-by-rev
495 sub get_last_global_remote_rev {
500 list => 'recentchanges',
505 my $result = $mediawiki->api($query);
506 return $result->{query}->{recentchanges}[0]->{revid};
509 # Get the last remote revision concerning the tracked pages and the tracked
511 sub get_last_remote_revision {
514 my %pages_hash = get_mw_pages();
515 my @pages = values(%pages_hash);
519 print STDERR "Getting last revision id on tracked pages...\n";
521 foreach my $page (@pages) {
522 my $id = $page->{pageid};
527 rvprop => 'ids|timestamp',
531 my $result = $mediawiki->api($query);
533 my $lastrev = pop(@{$result->{query}->{pages}->{$id}->{revisions}});
535 $basetimestamps{$lastrev->{revid}} = $lastrev->{timestamp};
537 $max_rev_num = ($lastrev->{revid} > $max_rev_num ? $lastrev->{revid} : $max_rev_num);
540 print STDERR "Last remote revision found is $max_rev_num.\n";
544 # Clean content before sending it to MediaWiki
545 sub mediawiki_clean {
547 my $page_created = shift;
548 # Mediawiki does not allow blank space at the end of a page and ends with a single \n.
549 # This function right trims a string and adds a \n at the end to follow this rule
551 if ($string eq "" && $page_created) {
552 # Creating empty pages is forbidden.
553 $string = EMPTY_CONTENT;
558 # Filter applied on MediaWiki data before adding them to Git
559 sub mediawiki_smudge {
561 if ($string eq EMPTY_CONTENT) {
564 # This \n is important. This is due to mediawiki's way to handle end of files.
568 sub mediawiki_clean_filename {
569 my $filename = shift;
570 $filename =~ s{@{[SLASH_REPLACEMENT]}}{/}g;
571 # [, ], |, {, and } are forbidden by MediaWiki, even URL-encoded.
572 # Do a variant of URL-encoding, i.e. looks like URL-encoding,
573 # but with _ added to prevent MediaWiki from thinking this is
574 # an actual special character.
575 $filename =~ s/[\[\]\{\}\|]/sprintf("_%%_%x", ord($&))/ge;
576 # If we use the uri escape before
577 # we should unescape here, before anything
582 sub mediawiki_smudge_filename {
583 my $filename = shift;
584 $filename =~ s{/}{@{[SLASH_REPLACEMENT]}}g;
585 $filename =~ s/ /_/g;
586 # Decode forbidden characters encoded in mediawiki_clean_filename
587 $filename =~ s/_%_([0-9a-fA-F][0-9a-fA-F])/sprintf("%c", hex($1))/ge;
593 print STDOUT "data ", bytes::length($content), "\n", $content;
597 sub literal_data_raw {
598 # Output possibly binary content.
600 # Avoid confusion between size in bytes and in characters
601 utf8::downgrade($content);
602 binmode STDOUT, ":raw";
603 print STDOUT "data ", bytes::length($content), "\n", $content;
604 binmode STDOUT, ":encoding(UTF-8)";
608 sub mw_capabilities {
609 # Revisions are imported to the private namespace
610 # refs/mediawiki/$remotename/ by the helper and fetched into
611 # refs/remotes/$remotename later by fetch.
612 print STDOUT "refspec refs/heads/*:refs/mediawiki/$remotename/*\n";
613 print STDOUT "import\n";
614 print STDOUT "list\n";
615 print STDOUT "push\n";
621 # MediaWiki do not have branches, we consider one branch arbitrarily
622 # called master, and HEAD pointing to it.
623 print STDOUT "? refs/heads/master\n";
624 print STDOUT "\@refs/heads/master HEAD\n";
630 print STDERR "remote-helper command 'option $_[0]' not yet implemented\n";
631 print STDOUT "unsupported\n";
635 sub fetch_mw_revisions_for_page {
638 my $fetch_from = shift;
645 rvstartid => $fetch_from,
651 # Get 500 revisions at a time due to the mediawiki api limit
653 my $result = $mediawiki->api($query);
655 # Parse each of those 500 revisions
656 foreach my $revision (@{$result->{query}->{pages}->{$id}->{revisions}}) {
658 $page_rev_ids->{pageid} = $page->{pageid};
659 $page_rev_ids->{revid} = $revision->{revid};
660 push(@page_revs, $page_rev_ids);
663 last unless $result->{'query-continue'};
664 $query->{rvstartid} = $result->{'query-continue'}->{revisions}->{rvstartid};
666 if ($shallow_import && @page_revs) {
667 print STDERR " Found 1 revision (shallow import).\n";
668 @page_revs = sort {$b->{revid} <=> $a->{revid}} (@page_revs);
669 return $page_revs[0];
671 print STDERR " Found ", $revnum, " revision(s).\n";
675 sub fetch_mw_revisions {
676 my $pages = shift; my @pages = @{$pages};
677 my $fetch_from = shift;
681 foreach my $page (@pages) {
682 my $id = $page->{pageid};
684 print STDERR "page $n/", scalar(@pages), ": ". $page->{title} ."\n";
686 my @page_revs = fetch_mw_revisions_for_page($page, $id, $fetch_from);
687 @revisions = (@page_revs, @revisions);
690 return ($n, @revisions);
695 $path =~ s/\\/\\\\/g;
698 return '"' . $path . '"';
701 sub import_file_revision {
703 my %commit = %{$commit};
704 my $full_import = shift;
706 my $mediafile = shift;
709 %mediafile = %{$mediafile};
712 my $title = $commit{title};
713 my $comment = $commit{comment};
714 my $content = $commit{content};
715 my $author = $commit{author};
716 my $date = $commit{date};
718 print STDOUT "commit refs/mediawiki/$remotename/master\n";
719 print STDOUT "mark :$n\n";
720 print STDOUT "committer $author <$author\@$wiki_name> ", $date->epoch, " +0000\n";
721 literal_data($comment);
723 # If it's not a clone, we need to know where to start from
724 if (!$full_import && $n == 1) {
725 print STDOUT "from refs/mediawiki/$remotename/master^0\n";
727 if ($content ne DELETED_CONTENT) {
728 print STDOUT "M 644 inline " .
729 fe_escape_path($title . ".mw") . "\n";
730 literal_data($content);
732 print STDOUT "M 644 inline "
733 . fe_escape_path($mediafile{title}) . "\n";
734 literal_data_raw($mediafile{content});
738 print STDOUT "D " . fe_escape_path($title . ".mw") . "\n";
741 # mediawiki revision number in the git note
742 if ($full_import && $n == 1) {
743 print STDOUT "reset refs/notes/$remotename/mediawiki\n";
745 print STDOUT "commit refs/notes/$remotename/mediawiki\n";
746 print STDOUT "committer $author <$author\@$wiki_name> ", $date->epoch, " +0000\n";
747 literal_data("Note added by git-mediawiki during import");
748 if (!$full_import && $n == 1) {
749 print STDOUT "from refs/notes/$remotename/mediawiki^0\n";
751 print STDOUT "N inline :$n\n";
752 literal_data("mediawiki_revision: " . $commit{mw_revision});
757 # parse a sequence of
761 # (like batch sequence of import and sequence of push statements)
767 if ($line =~ /^$cmd (.*)$/) {
769 } elsif ($line eq "\n") {
772 die("Invalid command in a '$cmd' batch: $_\n");
779 # multiple import commands can follow each other.
780 my @refs = (shift, get_more_refs("import"));
781 foreach my $ref (@refs) {
784 print STDOUT "done\n";
790 # The remote helper will call "import HEAD" and
791 # "import refs/heads/master".
792 # Since HEAD is a symbolic ref to master (by convention,
793 # followed by the output of the command "list" that we gave),
794 # we don't need to do anything in this case.
795 if ($ref eq "HEAD") {
801 print STDERR "Searching revisions...\n";
802 my $last_local = get_last_local_revision();
803 my $fetch_from = $last_local + 1;
804 if ($fetch_from == 1) {
805 print STDERR ", fetching from beginning.\n";
807 print STDERR ", fetching from here.\n";
811 if ($fetch_strategy eq "by_rev") {
812 print STDERR "Fetching & writing export data by revs...\n";
813 $n = mw_import_ref_by_revs($fetch_from);
814 } elsif ($fetch_strategy eq "by_page") {
815 print STDERR "Fetching & writing export data by pages...\n";
816 $n = mw_import_ref_by_pages($fetch_from);
818 print STDERR "fatal: invalid fetch strategy \"$fetch_strategy\".\n";
819 print STDERR "Check your configuration variables remote.$remotename.fetchStrategy and mediawiki.fetchStrategy\n";
823 if ($fetch_from == 1 && $n == 0) {
824 print STDERR "You appear to have cloned an empty MediaWiki.\n";
825 # Something has to be done remote-helper side. If nothing is done, an error is
826 # thrown saying that HEAD is referring to unknown object 0000000000000000000
827 # and the clone fails.
832 sub mw_import_ref_by_pages {
834 my $fetch_from = shift;
835 my %pages_hash = get_mw_pages();
836 my @pages = values(%pages_hash);
838 my ($n, @revisions) = fetch_mw_revisions(\@pages, $fetch_from);
840 @revisions = sort {$a->{revid} <=> $b->{revid}} @revisions;
841 my @revision_ids = map { $_->{revid} } @revisions;
843 return mw_import_revids($fetch_from, \@revision_ids, \%pages_hash);
846 sub mw_import_ref_by_revs {
848 my $fetch_from = shift;
849 my %pages_hash = get_mw_pages();
851 my $last_remote = get_last_global_remote_rev();
852 my @revision_ids = $fetch_from..$last_remote;
853 return mw_import_revids($fetch_from, \@revision_ids, \%pages_hash);
856 # Import revisions given in second argument (array of integers).
857 # Only pages appearing in the third argument (hash indexed by page titles)
859 sub mw_import_revids {
860 my $fetch_from = shift;
861 my $revision_ids = shift;
866 my $last_timestamp = 0; # Placeholer in case $rev->timestamp is undefined
868 foreach my $pagerevid (@$revision_ids) {
869 # Count page even if we skip it, since we display
870 # $n/$total and $total includes skipped pages.
873 # fetch the content of the pages
877 rvprop => 'content|timestamp|comment|user|ids',
878 revids => $pagerevid,
881 my $result = $mediawiki->api($query);
884 die "Failed to retrieve modified page for revision $pagerevid\n";
887 if (defined($result->{query}->{badrevids}->{$pagerevid})) {
888 # The revision id does not exist on the remote wiki.
892 if (!defined($result->{query}->{pages})) {
893 die "Invalid revision $pagerevid.\n";
896 my @result_pages = values(%{$result->{query}->{pages}});
897 my $result_page = $result_pages[0];
898 my $rev = $result_pages[0]->{revisions}->[0];
900 my $page_title = $result_page->{title};
902 if (!exists($pages->{$page_title})) {
903 print STDERR "$n/", scalar(@$revision_ids),
904 ": Skipping revision #$rev->{revid} of $page_title\n";
911 $commit{author} = $rev->{user} || 'Anonymous';
912 $commit{comment} = $rev->{comment} || EMPTY_MESSAGE;
913 $commit{title} = mediawiki_smudge_filename($page_title);
914 $commit{mw_revision} = $rev->{revid};
915 $commit{content} = mediawiki_smudge($rev->{'*'});
917 if (!defined($rev->{timestamp})) {
920 $last_timestamp = $rev->{timestamp};
922 $commit{date} = DateTime::Format::ISO8601->parse_datetime($last_timestamp);
924 # Differentiates classic pages and media files.
925 my ($namespace, $filename) = $page_title =~ /^([^:]*):(.*)$/;
928 my $id = get_mw_namespace_id($namespace);
929 if ($id && $id == get_mw_namespace_id("File")) {
930 %mediafile = get_mw_mediafile_for_page_revision($filename, $rev->{timestamp});
933 # If this is a revision of the media page for new version
934 # of a file do one common commit for both file and media page.
935 # Else do commit only for that page.
936 print STDERR "$n/", scalar(@$revision_ids), ": Revision #$rev->{revid} of $commit{title}\n";
937 import_file_revision(\%commit, ($fetch_from == 1), $n_actual, \%mediafile);
943 sub error_non_fast_forward {
944 my $advice = run_git("config --bool advice.pushNonFastForward");
946 if ($advice ne "false") {
947 # Native git-push would show this after the summary.
948 # We can't ask it to display it cleanly, so print it
950 print STDERR "To prevent you from losing history, non-fast-forward updates were rejected\n";
951 print STDERR "Merge the remote changes (e.g. 'git pull') before pushing again. See the\n";
952 print STDERR "'Note about fast-forwards' section of 'git push --help' for details.\n";
954 print STDOUT "error $_[0] \"non-fast-forward\"\n";
959 my $complete_file_name = shift;
960 my $new_sha1 = shift;
961 my $extension = shift;
962 my $file_deleted = shift;
965 my $path = "File:" . $complete_file_name;
966 my %hashFiles = get_allowed_file_extensions();
967 if (!exists($hashFiles{$extension})) {
968 print STDERR "$complete_file_name is not a permitted file on this wiki.\n";
969 print STDERR "Check the configuration of file uploads in your mediawiki.\n";
972 # Deleting and uploading a file requires a priviledged user
980 if (!$mediawiki->edit($query)) {
981 print STDERR "Failed to delete file on remote wiki\n";
982 print STDERR "Check your permissions on the remote site. Error code:\n";
983 print STDERR $mediawiki->{error}->{code} . ':' . $mediawiki->{error}->{details};
987 # Don't let perl try to interpret file content as UTF-8 => use "raw"
988 my $content = run_git("cat-file blob $new_sha1", "raw");
989 if ($content ne "") {
991 $mediawiki->{config}->{upload_url} =
992 "$url/index.php/Special:Upload";
995 filename => $complete_file_name,
999 Content => $content],
1000 ignorewarnings => 1,
1003 } ) || die $mediawiki->{error}->{code} . ':'
1004 . $mediawiki->{error}->{details} . "\n";
1005 my $last_file_page = $mediawiki->get_page({title => $path});
1006 $newrevid = $last_file_page->{revid};
1007 print STDERR "Pushed file: $new_sha1 - $complete_file_name.\n";
1009 print STDERR "Empty file $complete_file_name not pushed.\n";
1016 my $diff_info = shift;
1017 # $diff_info contains a string in this format:
1018 # 100644 100644 <sha1_of_blob_before_commit> <sha1_of_blob_now> <status>
1019 my @diff_info_split = split(/[ \t]/, $diff_info);
1021 # Filename, including .mw extension
1022 my $complete_file_name = shift;
1024 my $summary = shift;
1025 # MediaWiki revision number. Keep the previous one by default,
1026 # in case there's no edit to perform.
1027 my $oldrevid = shift;
1030 if ($summary eq EMPTY_MESSAGE) {
1034 my $new_sha1 = $diff_info_split[3];
1035 my $old_sha1 = $diff_info_split[2];
1036 my $page_created = ($old_sha1 eq NULL_SHA1);
1037 my $page_deleted = ($new_sha1 eq NULL_SHA1);
1038 $complete_file_name = mediawiki_clean_filename($complete_file_name);
1040 my ($title, $extension) = $complete_file_name =~ /^(.*)\.([^\.]*)$/;
1041 if (!defined($extension)) {
1044 if ($extension eq "mw") {
1045 my $ns = get_mw_namespace_id_for_page($complete_file_name);
1046 if ($ns && $ns == get_mw_namespace_id("File") && (!$export_media)) {
1047 print STDERR "Ignoring media file related page: $complete_file_name\n";
1048 return ($oldrevid, "ok");
1051 if ($page_deleted) {
1052 # Deleting a page usually requires
1053 # special privileges. A common
1054 # convention is to replace the page
1055 # with this content instead:
1056 $file_content = DELETED_CONTENT;
1058 $file_content = run_git("cat-file blob $new_sha1");
1063 my $result = $mediawiki->edit( {
1065 summary => $summary,
1067 basetimestamp => $basetimestamps{$oldrevid},
1068 text => mediawiki_clean($file_content, $page_created),
1070 skip_encoding => 1 # Helps with names with accentuated characters
1073 if ($mediawiki->{error}->{code} == 3) {
1074 # edit conflicts, considered as non-fast-forward
1075 print STDERR 'Warning: Error ' .
1076 $mediawiki->{error}->{code} .
1077 ' from mediwiki: ' . $mediawiki->{error}->{details} .
1079 return ($oldrevid, "non-fast-forward");
1081 # Other errors. Shouldn't happen => just die()
1082 die 'Fatal: Error ' .
1083 $mediawiki->{error}->{code} .
1084 ' from mediwiki: ' . $mediawiki->{error}->{details} . "\n";
1087 $newrevid = $result->{edit}->{newrevid};
1088 print STDERR "Pushed file: $new_sha1 - $title\n";
1089 } elsif ($export_media) {
1090 $newrevid = mw_upload_file($complete_file_name, $new_sha1,
1091 $extension, $page_deleted,
1094 print STDERR "Ignoring media file $title\n";
1096 $newrevid = ($newrevid or $oldrevid);
1097 return ($newrevid, "ok");
1101 # multiple push statements can follow each other
1102 my @refsspecs = (shift, get_more_refs("push"));
1104 for my $refspec (@refsspecs) {
1105 my ($force, $local, $remote) = $refspec =~ /^(\+)?([^:]*):([^:]*)$/
1106 or die("Invalid refspec for push. Expected <src>:<dst> or +<src>:<dst>\n");
1108 print STDERR "Warning: forced push not allowed on a MediaWiki.\n";
1111 print STDERR "Cannot delete remote branch on a MediaWiki\n";
1112 print STDOUT "error $remote cannot delete\n";
1115 if ($remote ne "refs/heads/master") {
1116 print STDERR "Only push to the branch 'master' is supported on a MediaWiki\n";
1117 print STDOUT "error $remote only master allowed\n";
1120 if (mw_push_revision($local, $remote)) {
1125 # Notify Git that the push is done
1128 if ($pushed && $dumb_push) {
1129 print STDERR "Just pushed some revisions to MediaWiki.\n";
1130 print STDERR "The pushed revisions now have to be re-imported, and your current branch\n";
1131 print STDERR "needs to be updated with these re-imported commits. You can do this with\n";
1133 print STDERR " git pull --rebase\n";
1139 sub mw_push_revision {
1141 my $remote = shift; # actually, this has to be "refs/heads/master" at this point.
1142 my $last_local_revid = get_last_local_revision();
1143 print STDERR ".\n"; # Finish sentence started by get_last_local_revision()
1144 my $last_remote_revid = get_last_remote_revision();
1145 my $mw_revision = $last_remote_revid;
1147 # Get sha1 of commit pointed by local HEAD
1148 my $HEAD_sha1 = run_git("rev-parse $local 2>/dev/null"); chomp($HEAD_sha1);
1149 # Get sha1 of commit pointed by remotes/$remotename/master
1150 my $remoteorigin_sha1 = run_git("rev-parse refs/remotes/$remotename/master 2>/dev/null");
1151 chomp($remoteorigin_sha1);
1153 if ($last_local_revid > 0 &&
1154 $last_local_revid < $last_remote_revid) {
1155 return error_non_fast_forward($remote);
1158 if ($HEAD_sha1 eq $remoteorigin_sha1) {
1163 # Get every commit in between HEAD and refs/remotes/origin/master,
1164 # including HEAD and refs/remotes/origin/master
1165 my @commit_pairs = ();
1166 if ($last_local_revid > 0) {
1167 my $parsed_sha1 = $remoteorigin_sha1;
1168 # Find a path from last MediaWiki commit to pushed commit
1169 print STDERR "Computing path from local to remote ...\n";
1170 my @local_ancestry = split(/\n/, run_git("rev-list --boundary --parents $local ^$parsed_sha1"));
1172 foreach my $line (@local_ancestry) {
1173 if (my ($child, $parents) = $line =~ /^-?([a-f0-9]+) ([a-f0-9 ]+)/) {
1174 foreach my $parent (split(/ /, $parents)) {
1175 $local_ancestry{$parent} = $child;
1177 } elsif (!$line =~ /^([a-f0-9]+)/) {
1178 die "Unexpected output from git rev-list: $line\n";
1181 while ($parsed_sha1 ne $HEAD_sha1) {
1182 my $child = $local_ancestry{$parsed_sha1};
1184 printf STDERR "Cannot find a path in history from remote commit to last commit\n";
1185 return error_non_fast_forward($remote);
1187 push(@commit_pairs, [$parsed_sha1, $child]);
1188 $parsed_sha1 = $child;
1191 # No remote mediawiki revision. Export the whole
1192 # history (linearized with --first-parent)
1193 print STDERR "Warning: no common ancestor, pushing complete history\n";
1194 my $history = run_git("rev-list --first-parent --children $local");
1195 my @history = split(/\n/, $history);
1196 @history = @history[1..$#history];
1197 foreach my $line (reverse @history) {
1198 my @commit_info_split = split(/[ \n]/, $line);
1199 push(@commit_pairs, \@commit_info_split);
1203 foreach my $commit_info_split (@commit_pairs) {
1204 my $sha1_child = @{$commit_info_split}[0];
1205 my $sha1_commit = @{$commit_info_split}[1];
1206 my $diff_infos = run_git("diff-tree -r --raw -z $sha1_child $sha1_commit");
1207 # TODO: we could detect rename, and encode them with a #redirect on the wiki.
1208 # TODO: for now, it's just a delete+add
1209 my @diff_info_list = split(/\0/, $diff_infos);
1210 # Keep the subject line of the commit message as mediawiki comment for the revision
1211 my $commit_msg = run_git("log --no-walk --format=\"%s\" $sha1_commit");
1214 while (@diff_info_list) {
1216 # git diff-tree -z gives an output like
1217 # <metadata>\0<filename1>\0
1218 # <metadata>\0<filename2>\0
1219 # and we've split on \0.
1220 my $info = shift(@diff_info_list);
1221 my $file = shift(@diff_info_list);
1222 ($mw_revision, $status) = mw_push_file($info, $file, $commit_msg, $mw_revision);
1223 if ($status eq "non-fast-forward") {
1224 # we may already have sent part of the
1225 # commit to MediaWiki, but it's too
1226 # late to cancel it. Stop the push in
1227 # the middle, but still give an
1228 # accurate error message.
1229 return error_non_fast_forward($remote);
1231 if ($status ne "ok") {
1232 die("Unknown error from mw_push_file()\n");
1235 unless ($dumb_push) {
1236 run_git("notes --ref=$remotename/mediawiki add -f -m \"mediawiki_revision: $mw_revision\" $sha1_commit");
1237 run_git("update-ref -m \"Git-MediaWiki push\" refs/mediawiki/$remotename/master $sha1_commit $sha1_child");
1241 print STDOUT "ok $remote\n";
1245 sub get_allowed_file_extensions {
1251 siprop => 'fileextensions'
1253 my $result = $mediawiki->api($query);
1254 my @file_extensions = map { $_->{ext}} @{$result->{query}->{fileextensions}};
1255 my %hashFile = map { $_ => 1 } @file_extensions;
1260 # In memory cache for MediaWiki namespace ids.
1263 # Namespaces whose id is cached in the configuration file
1264 # (to avoid duplicates)
1265 my %cached_mw_namespace_id;
1267 # Return MediaWiki id for a canonical namespace name.
1268 # Ex.: "File", "Project".
1269 sub get_mw_namespace_id {
1273 if (!exists $namespace_id{$name}) {
1274 # Look at configuration file, if the record for that namespace is
1275 # already cached. Namespaces are stored in form:
1276 # "Name_of_namespace:Id_namespace", ex.: "File:6".
1277 my @temp = split(/\n/, run_git("config --get-all remote."
1278 . $remotename .".namespaceCache"));
1280 foreach my $ns (@temp) {
1281 my ($n, $id) = split(/:/, $ns);
1282 if ($id eq 'notANameSpace') {
1283 $namespace_id{$n} = {is_namespace => 0};
1285 $namespace_id{$n} = {is_namespace => 1, id => $id};
1287 $cached_mw_namespace_id{$n} = 1;
1291 if (!exists $namespace_id{$name}) {
1292 print STDERR "Namespace $name not found in cache, querying the wiki ...\n";
1293 # NS not found => get namespace id from MW and store it in
1294 # configuration file.
1298 siprop => 'namespaces'
1300 my $result = $mediawiki->api($query);
1302 while (my ($id, $ns) = each(%{$result->{query}->{namespaces}})) {
1303 if (defined($ns->{id}) && defined($ns->{canonical})) {
1304 $namespace_id{$ns->{canonical}} = {is_namespace => 1, id => $ns->{id}};
1306 # alias (e.g. french Fichier: as alias for canonical File:)
1307 $namespace_id{$ns->{'*'}} = {is_namespace => 1, id => $ns->{id}};
1313 my $ns = $namespace_id{$name};
1316 unless (defined $ns) {
1317 print STDERR "No such namespace $name on MediaWiki.\n";
1318 $ns = {is_namespace => 0};
1319 $namespace_id{$name} = $ns;
1322 if ($ns->{is_namespace}) {
1326 # Store "notANameSpace" as special value for inexisting namespaces
1327 my $store_id = ($id || 'notANameSpace');
1329 # Store explicitely requested namespaces on disk
1330 if (!exists $cached_mw_namespace_id{$name}) {
1331 run_git("config --add remote.". $remotename
1332 .".namespaceCache \"". $name .":". $store_id ."\"");
1333 $cached_mw_namespace_id{$name} = 1;
1338 sub get_mw_namespace_id_for_page {
1339 my $namespace = shift;
1340 if ($namespace =~ /^([^:]*):/) {
1341 return get_mw_namespace_id($namespace);