1#! /usr/bin/perl 2 3# Copyright (C) 2011 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 10 11# Gateway between Git and MediaWiki. 12# Documentation & bugtracker: https://github.com/moy/Git-Mediawiki/ 13 14use strict; 15use MediaWiki::API; 16use Git; 17use Git::Mediawiki qw(clean_filename smudge_filename connect_maybe 18 EMPTY HTTP_CODE_OK); 19use DateTime::Format::ISO8601; 20use warnings; 21 22# By default, use UTF-8 to communicate with Git and the user 23binmode STDERR,':encoding(UTF-8)'; 24binmode STDOUT,':encoding(UTF-8)'; 25 26use URI::Escape; 27 28# It's not always possible to delete pages (may require some 29# privileges). Deleted pages are replaced with this content. 30useconstant DELETED_CONTENT =>"[[Category:Deleted]]\n"; 31 32# It's not possible to create empty pages. New empty files in Git are 33# sent with this content instead. 34useconstant EMPTY_CONTENT =>"<!-- empty page -->\n"; 35 36# used to reflect file creation or deletion in diff. 37useconstant NULL_SHA1 =>'0000000000000000000000000000000000000000'; 38 39# Used on Git's side to reflect empty edit messages on the wiki 40useconstant EMPTY_MESSAGE =>'*Empty MediaWiki Message*'; 41 42# Number of pages taken into account at once in submodule get_mw_page_list 43useconstant SLICE_SIZE =>50; 44 45# Number of linked mediafile to get at once in get_linked_mediafiles 46# The query is split in small batches because of the MW API limit of 47# the number of links to be returned (500 links max). 48useconstant BATCH_SIZE =>10; 49 50if(@ARGV!=2) { 51 exit_error_usage(); 52} 53 54my$remotename=$ARGV[0]; 55my$url=$ARGV[1]; 56 57# Accept both space-separated and multiple keys in config file. 58# Spaces should be written as _ anyway because we'll use chomp. 59my@tracked_pages=split(/[ \n]/, run_git("config --get-all remote.${remotename}.pages")); 60chomp(@tracked_pages); 61 62# Just like @tracked_pages, but for MediaWiki categories. 63my@tracked_categories=split(/[ \n]/, run_git("config --get-all remote.${remotename}.categories")); 64chomp(@tracked_categories); 65 66# Import media files on pull 67my$import_media= run_git("config --get --bool remote.${remotename}.mediaimport"); 68chomp($import_media); 69$import_media= ($import_mediaeq'true'); 70 71# Export media files on push 72my$export_media= run_git("config --get --bool remote.${remotename}.mediaexport"); 73chomp($export_media); 74$export_media= !($export_mediaeq'false'); 75 76my$wiki_login= run_git("config --get remote.${remotename}.mwLogin"); 77# Note: mwPassword is discourraged. Use the credential system instead. 78my$wiki_passwd= run_git("config --get remote.${remotename}.mwPassword"); 79my$wiki_domain= run_git("config --get remote.${remotename}.mwDomain"); 80chomp($wiki_login); 81chomp($wiki_passwd); 82chomp($wiki_domain); 83 84# Import only last revisions (both for clone and fetch) 85my$shallow_import= run_git("config --get --bool remote.${remotename}.shallow"); 86chomp($shallow_import); 87$shallow_import= ($shallow_importeq'true'); 88 89# Fetch (clone and pull) by revisions instead of by pages. This behavior 90# is more efficient when we have a wiki with lots of pages and we fetch 91# the revisions quite often so that they concern only few pages. 92# Possible values: 93# - by_rev: perform one query per new revision on the remote wiki 94# - by_page: query each tracked page for new revision 95my$fetch_strategy= run_git("config --get remote.${remotename}.fetchStrategy"); 96if(!$fetch_strategy) { 97$fetch_strategy= run_git('config --get mediawiki.fetchStrategy'); 98} 99chomp($fetch_strategy); 100if(!$fetch_strategy) { 101$fetch_strategy='by_page'; 102} 103 104# Remember the timestamp corresponding to a revision id. 105my%basetimestamps; 106 107# Dumb push: don't update notes and mediawiki ref to reflect the last push. 108# 109# Configurable with mediawiki.dumbPush, or per-remote with 110# remote.<remotename>.dumbPush. 111# 112# This means the user will have to re-import the just-pushed 113# revisions. On the other hand, this means that the Git revisions 114# corresponding to MediaWiki revisions are all imported from the wiki, 115# regardless of whether they were initially created in Git or from the 116# web interface, hence all users will get the same history (i.e. if 117# the push from Git to MediaWiki loses some information, everybody 118# will get the history with information lost). If the import is 119# deterministic, this means everybody gets the same sha1 for each 120# MediaWiki revision. 121my$dumb_push= run_git("config --get --bool remote.${remotename}.dumbPush"); 122if(!$dumb_push) { 123$dumb_push= run_git('config --get --bool mediawiki.dumbPush'); 124} 125chomp($dumb_push); 126$dumb_push= ($dumb_pusheq'true'); 127 128my$wiki_name=$url; 129$wiki_name=~s{[^/]*://}{}; 130# If URL is like http://user:password@example.com/, we clearly don't 131# want the password in $wiki_name. While we're there, also remove user 132# and '@' sign, to avoid author like MWUser@HTTPUser@host.com 133$wiki_name=~s/^.*@//; 134 135# Commands parser 136while(<STDIN>) { 137chomp; 138 139if(!parse_command($_)) { 140last; 141} 142 143BEGIN{ $| =1}# flush STDOUT, to make sure the previous 144# command is fully processed. 145} 146 147########################## Functions ############################## 148 149## error handling 150sub exit_error_usage { 151die"ERROR: git-remote-mediawiki module was not called with a correct number of\n". 152"parameters\n". 153"You may obtain this error because you attempted to run the git-remote-mediawiki\n". 154"module directly.\n". 155"This module can be used the following way:\n". 156"\tgit clone mediawiki://<address of a mediawiki>\n". 157"Then, use git commit, push and pull as with every normal git repository.\n"; 158} 159 160sub parse_command { 161my($line) =@_; 162my@cmd=split(/ /,$line); 163if(!defined$cmd[0]) { 164return0; 165} 166if($cmd[0]eq'capabilities') { 167die("Too many arguments for capabilities\n") 168if(defined($cmd[1])); 169 mw_capabilities(); 170}elsif($cmd[0]eq'list') { 171die("Too many arguments for list\n")if(defined($cmd[2])); 172 mw_list($cmd[1]); 173}elsif($cmd[0]eq'import') { 174die("Invalid argument for import\n") 175if($cmd[1]eq EMPTY); 176die("Too many arguments for import\n") 177if(defined($cmd[2])); 178 mw_import($cmd[1]); 179}elsif($cmd[0]eq'option') { 180die("Invalid arguments for option\n") 181if($cmd[1]eq EMPTY ||$cmd[2]eq EMPTY); 182die("Too many arguments for option\n") 183if(defined($cmd[3])); 184 mw_option($cmd[1],$cmd[2]); 185}elsif($cmd[0]eq'push') { 186 mw_push($cmd[1]); 187}else{ 188print{*STDERR}"Unknown command. Aborting...\n"; 189return0; 190} 191return1; 192} 193 194# MediaWiki API instance, created lazily. 195my$mediawiki; 196 197sub fatal_mw_error { 198my$action=shift; 199print STDERR "fatal: could not$action.\n"; 200print STDERR "fatal: '$url' does not appear to be a mediawiki\n"; 201if($url=~/^https/) { 202print STDERR "fatal: make sure '$url/api.php' is a valid page\n"; 203print STDERR "fatal: and the SSL certificate is correct.\n"; 204}else{ 205print STDERR "fatal: make sure '$url/api.php' is a valid page.\n"; 206} 207print STDERR "fatal: (error ". 208$mediawiki->{error}->{code} .': '. 209$mediawiki->{error}->{details} .")\n"; 210exit1; 211} 212 213## Functions for listing pages on the remote wiki 214sub get_mw_tracked_pages { 215my$pages=shift; 216 get_mw_page_list(\@tracked_pages,$pages); 217return; 218} 219 220sub get_mw_page_list { 221my$page_list=shift; 222my$pages=shift; 223my@some_pages= @{$page_list}; 224while(@some_pages) { 225my$last_page= SLICE_SIZE; 226if($#some_pages<$last_page) { 227$last_page=$#some_pages; 228} 229my@slice=@some_pages[0..$last_page]; 230 get_mw_first_pages(\@slice,$pages); 231@some_pages=@some_pages[(SLICE_SIZE +1)..$#some_pages]; 232} 233return; 234} 235 236sub get_mw_tracked_categories { 237my$pages=shift; 238foreachmy$category(@tracked_categories) { 239if(index($category,':') <0) { 240# Mediawiki requires the Category 241# prefix, but let's not force the user 242# to specify it. 243$category="Category:${category}"; 244} 245my$mw_pages=$mediawiki->list( { 246 action =>'query', 247 list =>'categorymembers', 248 cmtitle =>$category, 249 cmlimit =>'max'} ) 250||die$mediawiki->{error}->{code} .': ' 251.$mediawiki->{error}->{details} ."\n"; 252foreachmy$page(@{$mw_pages}) { 253$pages->{$page->{title}} =$page; 254} 255} 256return; 257} 258 259sub get_mw_all_pages { 260my$pages=shift; 261# No user-provided list, get the list of pages from the API. 262my$mw_pages=$mediawiki->list({ 263 action =>'query', 264 list =>'allpages', 265 aplimit =>'max' 266}); 267if(!defined($mw_pages)) { 268 fatal_mw_error("get the list of wiki pages"); 269} 270foreachmy$page(@{$mw_pages}) { 271$pages->{$page->{title}} =$page; 272} 273return; 274} 275 276# queries the wiki for a set of pages. Meant to be used within a loop 277# querying the wiki for slices of page list. 278sub get_mw_first_pages { 279my$some_pages=shift; 280my@some_pages= @{$some_pages}; 281 282my$pages=shift; 283 284# pattern 'page1|page2|...' required by the API 285my$titles=join('|',@some_pages); 286 287my$mw_pages=$mediawiki->api({ 288 action =>'query', 289 titles =>$titles, 290}); 291if(!defined($mw_pages)) { 292 fatal_mw_error("query the list of wiki pages"); 293} 294while(my($id,$page) =each(%{$mw_pages->{query}->{pages}})) { 295if($id<0) { 296print{*STDERR}"Warning: page$page->{title} not found on wiki\n"; 297}else{ 298$pages->{$page->{title}} =$page; 299} 300} 301return; 302} 303 304# Get the list of pages to be fetched according to configuration. 305sub get_mw_pages { 306$mediawiki= connect_maybe($mediawiki,$remotename,$url); 307 308print{*STDERR}"Listing pages on remote wiki...\n"; 309 310my%pages;# hash on page titles to avoid duplicates 311my$user_defined; 312if(@tracked_pages) { 313$user_defined=1; 314# The user provided a list of pages titles, but we 315# still need to query the API to get the page IDs. 316 get_mw_tracked_pages(\%pages); 317} 318if(@tracked_categories) { 319$user_defined=1; 320 get_mw_tracked_categories(\%pages); 321} 322if(!$user_defined) { 323 get_mw_all_pages(\%pages); 324} 325if($import_media) { 326print{*STDERR}"Getting media files for selected pages...\n"; 327if($user_defined) { 328 get_linked_mediafiles(\%pages); 329}else{ 330 get_all_mediafiles(\%pages); 331} 332} 333print{*STDERR} (scalar keys%pages) ." pages found.\n"; 334return%pages; 335} 336 337# usage: $out = run_git("command args"); 338# $out = run_git("command args", "raw"); # don't interpret output as UTF-8. 339sub run_git { 340my$args=shift; 341my$encoding= (shift||'encoding(UTF-8)'); 342open(my$git,"-|:${encoding}","git ${args}") 343or die"Unable to fork:$!\n"; 344my$res=do{ 345local$/=undef; 346<$git> 347}; 348close($git); 349 350return$res; 351} 352 353 354sub get_all_mediafiles { 355my$pages=shift; 356# Attach list of all pages for media files from the API, 357# they are in a different namespace, only one namespace 358# can be queried at the same moment 359my$mw_pages=$mediawiki->list({ 360 action =>'query', 361 list =>'allpages', 362 apnamespace => get_mw_namespace_id('File'), 363 aplimit =>'max' 364}); 365if(!defined($mw_pages)) { 366print{*STDERR}"fatal: could not get the list of pages for media files.\n"; 367print{*STDERR}"fatal: '$url' does not appear to be a mediawiki\n"; 368print{*STDERR}"fatal: make sure '$url/api.php' is a valid page.\n"; 369exit1; 370} 371foreachmy$page(@{$mw_pages}) { 372$pages->{$page->{title}} =$page; 373} 374return; 375} 376 377sub get_linked_mediafiles { 378my$pages=shift; 379my@titles=map{$_->{title} }values(%{$pages}); 380 381my$batch= BATCH_SIZE; 382while(@titles) { 383if($#titles<$batch) { 384$batch=$#titles; 385} 386my@slice=@titles[0..$batch]; 387 388# pattern 'page1|page2|...' required by the API 389my$mw_titles=join('|',@slice); 390 391# Media files could be included or linked from 392# a page, get all related 393my$query= { 394 action =>'query', 395 prop =>'links|images', 396 titles =>$mw_titles, 397 plnamespace => get_mw_namespace_id('File'), 398 pllimit =>'max' 399}; 400my$result=$mediawiki->api($query); 401 402while(my($id,$page) =each(%{$result->{query}->{pages}})) { 403my@media_titles; 404if(defined($page->{links})) { 405my@link_titles 406=map{$_->{title} } @{$page->{links}}; 407push(@media_titles,@link_titles); 408} 409if(defined($page->{images})) { 410my@image_titles 411=map{$_->{title} } @{$page->{images}}; 412push(@media_titles,@image_titles); 413} 414if(@media_titles) { 415 get_mw_page_list(\@media_titles,$pages); 416} 417} 418 419@titles=@titles[($batch+1)..$#titles]; 420} 421return; 422} 423 424sub get_mw_mediafile_for_page_revision { 425# Name of the file on Wiki, with the prefix. 426my$filename=shift; 427my$timestamp=shift; 428my%mediafile; 429 430# Search if on a media file with given timestamp exists on 431# MediaWiki. In that case download the file. 432my$query= { 433 action =>'query', 434 prop =>'imageinfo', 435 titles =>"File:${filename}", 436 iistart =>$timestamp, 437 iiend =>$timestamp, 438 iiprop =>'timestamp|archivename|url', 439 iilimit =>1 440}; 441my$result=$mediawiki->api($query); 442 443my($fileid,$file) =each( %{$result->{query}->{pages}} ); 444# If not defined it means there is no revision of the file for 445# given timestamp. 446if(defined($file->{imageinfo})) { 447$mediafile{title} =$filename; 448 449my$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. 453print{*STDERR}"\tDownloading file$mediafile{title}, version$mediafile{timestamp}\n"; 454$mediafile{content} = download_mw_mediafile($fileinfo->{url}); 455} 456return%mediafile; 457} 458 459sub download_mw_mediafile { 460my$download_url=shift; 461 462my$response=$mediawiki->{ua}->get($download_url); 463if($response->code== HTTP_CODE_OK) { 464return$response->decoded_content; 465}else{ 466print{*STDERR}"Error downloading mediafile from :\n"; 467print{*STDERR}"URL: ${download_url}\n"; 468print{*STDERR}'Server response: '.$response->code.q{ }.$response->message."\n"; 469exit1; 470} 471} 472 473sub get_last_local_revision { 474# Get note regarding last mediawiki revision 475my$note= run_git("notes --ref=${remotename}/mediawiki show refs/mediawiki/${remotename}/master 2>/dev/null"); 476my@note_info=split(/ /,$note); 477 478my$lastrevision_number; 479if(!(defined($note_info[0]) &&$note_info[0]eq'mediawiki_revision:')) { 480print{*STDERR}'No previous mediawiki revision found'; 481$lastrevision_number=0; 482}else{ 483# Notes are formatted : mediawiki_revision: #number 484$lastrevision_number=$note_info[1]; 485chomp($lastrevision_number); 486print{*STDERR}"Last local mediawiki revision found is ${lastrevision_number}"; 487} 488return$lastrevision_number; 489} 490 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 494# option. 495sub get_last_global_remote_rev { 496$mediawiki= connect_maybe($mediawiki,$remotename,$url); 497 498my$query= { 499 action =>'query', 500 list =>'recentchanges', 501 prop =>'revisions', 502 rclimit =>'1', 503 rcdir =>'older', 504}; 505my$result=$mediawiki->api($query); 506return$result->{query}->{recentchanges}[0]->{revid}; 507} 508 509# Get the last remote revision concerning the tracked pages and the tracked 510# categories. 511sub get_last_remote_revision { 512$mediawiki= connect_maybe($mediawiki,$remotename,$url); 513 514my%pages_hash= get_mw_pages(); 515my@pages=values(%pages_hash); 516 517my$max_rev_num=0; 518 519print{*STDERR}"Getting last revision id on tracked pages...\n"; 520 521foreachmy$page(@pages) { 522my$id=$page->{pageid}; 523 524my$query= { 525 action =>'query', 526 prop =>'revisions', 527 rvprop =>'ids|timestamp', 528 pageids =>$id, 529}; 530 531my$result=$mediawiki->api($query); 532 533my$lastrev=pop(@{$result->{query}->{pages}->{$id}->{revisions}}); 534 535$basetimestamps{$lastrev->{revid}} =$lastrev->{timestamp}; 536 537$max_rev_num= ($lastrev->{revid} >$max_rev_num?$lastrev->{revid} :$max_rev_num); 538} 539 540print{*STDERR}"Last remote revision found is$max_rev_num.\n"; 541return$max_rev_num; 542} 543 544# Clean content before sending it to MediaWiki 545sub mediawiki_clean { 546my$string=shift; 547my$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 550$string=~s/\s+$//; 551if($stringeq EMPTY &&$page_created) { 552# Creating empty pages is forbidden. 553$string= EMPTY_CONTENT; 554} 555return$string."\n"; 556} 557 558# Filter applied on MediaWiki data before adding them to Git 559sub mediawiki_smudge { 560my$string=shift; 561if($stringeq EMPTY_CONTENT) { 562$string= EMPTY; 563} 564# This \n is important. This is due to mediawiki's way to handle end of files. 565return"${string}\n"; 566} 567 568sub literal_data { 569my($content) =@_; 570print{*STDOUT}'data ', bytes::length($content),"\n",$content; 571return; 572} 573 574sub literal_data_raw { 575# Output possibly binary content. 576my($content) =@_; 577# Avoid confusion between size in bytes and in characters 578 utf8::downgrade($content); 579binmode STDOUT,':raw'; 580print{*STDOUT}'data ', bytes::length($content),"\n",$content; 581binmode STDOUT,':encoding(UTF-8)'; 582return; 583} 584 585sub mw_capabilities { 586# Revisions are imported to the private namespace 587# refs/mediawiki/$remotename/ by the helper and fetched into 588# refs/remotes/$remotename later by fetch. 589print{*STDOUT}"refspec refs/heads/*:refs/mediawiki/${remotename}/*\n"; 590print{*STDOUT}"import\n"; 591print{*STDOUT}"list\n"; 592print{*STDOUT}"push\n"; 593if($dumb_push) { 594print{*STDOUT}"no-private-update\n"; 595} 596print{*STDOUT}"\n"; 597return; 598} 599 600sub mw_list { 601# MediaWiki do not have branches, we consider one branch arbitrarily 602# called master, and HEAD pointing to it. 603print{*STDOUT}"? refs/heads/master\n"; 604print{*STDOUT}"\@refs/heads/masterHEAD\n"; 605print{*STDOUT}"\n"; 606return; 607} 608 609sub mw_option { 610print{*STDERR}"remote-helper command 'option$_[0]' not yet implemented\n"; 611print{*STDOUT}"unsupported\n"; 612return; 613} 614 615sub fetch_mw_revisions_for_page { 616my$page=shift; 617my$id=shift; 618my$fetch_from=shift; 619my@page_revs= (); 620my$query= { 621 action =>'query', 622 prop =>'revisions', 623 rvprop =>'ids', 624 rvdir =>'newer', 625 rvstartid =>$fetch_from, 626 rvlimit =>500, 627 pageids =>$id, 628 629# Let MediaWiki know that we support the latest API. 630continue=>'', 631}; 632 633my$revnum=0; 634# Get 500 revisions at a time due to the mediawiki api limit 635while(1) { 636my$result=$mediawiki->api($query); 637 638# Parse each of those 500 revisions 639foreachmy$revision(@{$result->{query}->{pages}->{$id}->{revisions}}) { 640my$page_rev_ids; 641$page_rev_ids->{pageid} =$page->{pageid}; 642$page_rev_ids->{revid} =$revision->{revid}; 643push(@page_revs,$page_rev_ids); 644$revnum++; 645} 646 647if($result->{'query-continue'}) {# For legacy APIs 648$query->{rvstartid} =$result->{'query-continue'}->{revisions}->{rvstartid}; 649}elsif($result->{continue}) {# For newer APIs 650$query->{rvstartid} =$result->{continue}->{rvcontinue}; 651$query->{continue} =$result->{continue}->{continue}; 652}else{ 653last; 654} 655} 656if($shallow_import&&@page_revs) { 657print{*STDERR}" Found 1 revision (shallow import).\n"; 658@page_revs=sort{$b->{revid} <=>$a->{revid}} (@page_revs); 659return$page_revs[0]; 660} 661print{*STDERR}" Found ${revnum} revision(s).\n"; 662return@page_revs; 663} 664 665sub fetch_mw_revisions { 666my$pages=shift;my@pages= @{$pages}; 667my$fetch_from=shift; 668 669my@revisions= (); 670my$n=1; 671foreachmy$page(@pages) { 672my$id=$page->{pageid}; 673print{*STDERR}"page ${n}/",scalar(@pages),': ',$page->{title},"\n"; 674$n++; 675my@page_revs= fetch_mw_revisions_for_page($page,$id,$fetch_from); 676@revisions= (@page_revs,@revisions); 677} 678 679return($n,@revisions); 680} 681 682sub fe_escape_path { 683my$path=shift; 684$path=~s/\\/\\\\/g; 685$path=~s/"/\\"/g; 686$path=~s/\n/\\n/g; 687returnqq("${path}"); 688} 689 690sub import_file_revision { 691my$commit=shift; 692my%commit= %{$commit}; 693my$full_import=shift; 694my$n=shift; 695my$mediafile=shift; 696my%mediafile; 697if($mediafile) { 698%mediafile= %{$mediafile}; 699} 700 701my$title=$commit{title}; 702my$comment=$commit{comment}; 703my$content=$commit{content}; 704my$author=$commit{author}; 705my$date=$commit{date}; 706 707print{*STDOUT}"commit refs/mediawiki/${remotename}/master\n"; 708print{*STDOUT}"mark :${n}\n"; 709print{*STDOUT}"committer ${author} <${author}\@${wiki_name}> ".$date->epoch." +0000\n"; 710 literal_data($comment); 711 712# If it's not a clone, we need to know where to start from 713if(!$full_import&&$n==1) { 714print{*STDOUT}"from refs/mediawiki/${remotename}/master^0\n"; 715} 716if($contentne DELETED_CONTENT) { 717print{*STDOUT}'M 644 inline '. 718 fe_escape_path("${title}.mw") ."\n"; 719 literal_data($content); 720if(%mediafile) { 721print{*STDOUT}'M 644 inline ' 722. fe_escape_path($mediafile{title}) ."\n"; 723 literal_data_raw($mediafile{content}); 724} 725print{*STDOUT}"\n\n"; 726}else{ 727print{*STDOUT}'D '. fe_escape_path("${title}.mw") ."\n"; 728} 729 730# mediawiki revision number in the git note 731if($full_import&&$n==1) { 732print{*STDOUT}"reset refs/notes/${remotename}/mediawiki\n"; 733} 734print{*STDOUT}"commit refs/notes/${remotename}/mediawiki\n"; 735print{*STDOUT}"committer ${author} <${author}\@${wiki_name}> ".$date->epoch." +0000\n"; 736 literal_data('Note added by git-mediawiki during import'); 737if(!$full_import&&$n==1) { 738print{*STDOUT}"from refs/notes/${remotename}/mediawiki^0\n"; 739} 740print{*STDOUT}"N inline :${n}\n"; 741 literal_data("mediawiki_revision:$commit{mw_revision}"); 742print{*STDOUT}"\n\n"; 743return; 744} 745 746# parse a sequence of 747# <cmd> <arg1> 748# <cmd> <arg2> 749# \n 750# (like batch sequence of import and sequence of push statements) 751sub get_more_refs { 752my$cmd=shift; 753my@refs; 754while(1) { 755my$line= <STDIN>; 756if($line=~/^$cmd (.*)$/) { 757push(@refs,$1); 758}elsif($lineeq"\n") { 759return@refs; 760}else{ 761die("Invalid command in a '$cmd' batch:$_\n"); 762} 763} 764return; 765} 766 767sub mw_import { 768# multiple import commands can follow each other. 769my@refs= (shift, get_more_refs('import')); 770foreachmy$ref(@refs) { 771 mw_import_ref($ref); 772} 773print{*STDOUT}"done\n"; 774return; 775} 776 777sub mw_import_ref { 778my$ref=shift; 779# The remote helper will call "import HEAD" and 780# "import refs/heads/master". 781# Since HEAD is a symbolic ref to master (by convention, 782# followed by the output of the command "list" that we gave), 783# we don't need to do anything in this case. 784if($refeq'HEAD') { 785return; 786} 787 788$mediawiki= connect_maybe($mediawiki,$remotename,$url); 789 790print{*STDERR}"Searching revisions...\n"; 791my$last_local= get_last_local_revision(); 792my$fetch_from=$last_local+1; 793if($fetch_from==1) { 794print{*STDERR}", fetching from beginning.\n"; 795}else{ 796print{*STDERR}", fetching from here.\n"; 797} 798 799my$n=0; 800if($fetch_strategyeq'by_rev') { 801print{*STDERR}"Fetching & writing export data by revs...\n"; 802$n= mw_import_ref_by_revs($fetch_from); 803}elsif($fetch_strategyeq'by_page') { 804print{*STDERR}"Fetching & writing export data by pages...\n"; 805$n= mw_import_ref_by_pages($fetch_from); 806}else{ 807print{*STDERR}qq(fatal: invalid fetch strategy "${fetch_strategy}".\n); 808print{*STDERR}"Check your configuration variables remote.${remotename}.fetchStrategy and mediawiki.fetchStrategy\n"; 809exit1; 810} 811 812if($fetch_from==1&&$n==0) { 813print{*STDERR}"You appear to have cloned an empty MediaWiki.\n"; 814# Something has to be done remote-helper side. If nothing is done, an error is 815# thrown saying that HEAD is referring to unknown object 0000000000000000000 816# and the clone fails. 817} 818return; 819} 820 821sub mw_import_ref_by_pages { 822 823my$fetch_from=shift; 824my%pages_hash= get_mw_pages(); 825my@pages=values(%pages_hash); 826 827my($n,@revisions) = fetch_mw_revisions(\@pages,$fetch_from); 828 829@revisions=sort{$a->{revid} <=>$b->{revid}}@revisions; 830my@revision_ids=map{$_->{revid} }@revisions; 831 832return mw_import_revids($fetch_from, \@revision_ids, \%pages_hash); 833} 834 835sub mw_import_ref_by_revs { 836 837my$fetch_from=shift; 838my%pages_hash= get_mw_pages(); 839 840my$last_remote= get_last_global_remote_rev(); 841my@revision_ids=$fetch_from..$last_remote; 842return mw_import_revids($fetch_from, \@revision_ids, \%pages_hash); 843} 844 845# Import revisions given in second argument (array of integers). 846# Only pages appearing in the third argument (hash indexed by page titles) 847# will be imported. 848sub mw_import_revids { 849my$fetch_from=shift; 850my$revision_ids=shift; 851my$pages=shift; 852 853my$n=0; 854my$n_actual=0; 855my$last_timestamp=0;# Placeholer in case $rev->timestamp is undefined 856 857foreachmy$pagerevid(@{$revision_ids}) { 858# Count page even if we skip it, since we display 859# $n/$total and $total includes skipped pages. 860$n++; 861 862# fetch the content of the pages 863my$query= { 864 action =>'query', 865 prop =>'revisions', 866 rvprop =>'content|timestamp|comment|user|ids', 867 revids =>$pagerevid, 868}; 869 870my$result=$mediawiki->api($query); 871 872if(!$result) { 873die"Failed to retrieve modified page for revision$pagerevid\n"; 874} 875 876if(defined($result->{query}->{badrevids}->{$pagerevid})) { 877# The revision id does not exist on the remote wiki. 878next; 879} 880 881if(!defined($result->{query}->{pages})) { 882die"Invalid revision ${pagerevid}.\n"; 883} 884 885my@result_pages=values(%{$result->{query}->{pages}}); 886my$result_page=$result_pages[0]; 887my$rev=$result_pages[0]->{revisions}->[0]; 888 889my$page_title=$result_page->{title}; 890 891if(!exists($pages->{$page_title})) { 892print{*STDERR}"${n}/",scalar(@{$revision_ids}), 893": Skipping revision #$rev->{revid} of ${page_title}\n"; 894next; 895} 896 897$n_actual++; 898 899my%commit; 900$commit{author} =$rev->{user} ||'Anonymous'; 901$commit{comment} =$rev->{comment} || EMPTY_MESSAGE; 902$commit{title} = smudge_filename($page_title); 903$commit{mw_revision} =$rev->{revid}; 904$commit{content} = mediawiki_smudge($rev->{'*'}); 905 906if(!defined($rev->{timestamp})) { 907$last_timestamp++; 908}else{ 909$last_timestamp=$rev->{timestamp}; 910} 911$commit{date} = DateTime::Format::ISO8601->parse_datetime($last_timestamp); 912 913# Differentiates classic pages and media files. 914my($namespace,$filename) =$page_title=~/^([^:]*):(.*)$/; 915my%mediafile; 916if($namespace) { 917my$id= get_mw_namespace_id($namespace); 918if($id&&$id== get_mw_namespace_id('File')) { 919%mediafile= get_mw_mediafile_for_page_revision($filename,$rev->{timestamp}); 920} 921} 922# If this is a revision of the media page for new version 923# of a file do one common commit for both file and media page. 924# Else do commit only for that page. 925print{*STDERR}"${n}/",scalar(@{$revision_ids}),": Revision #$rev->{revid} of$commit{title}\n"; 926 import_file_revision(\%commit, ($fetch_from==1),$n_actual, \%mediafile); 927} 928 929return$n_actual; 930} 931 932sub error_non_fast_forward { 933my$advice= run_git('config --bool advice.pushNonFastForward'); 934chomp($advice); 935if($advicene'false') { 936# Native git-push would show this after the summary. 937# We can't ask it to display it cleanly, so print it 938# ourselves before. 939print{*STDERR}"To prevent you from losing history, non-fast-forward updates were rejected\n"; 940print{*STDERR}"Merge the remote changes (e.g. 'git pull') before pushing again. See the\n"; 941print{*STDERR}"'Note about fast-forwards' section of 'git push --help' for details.\n"; 942} 943print{*STDOUT}qq(error$_[0] "non-fast-forward"\n); 944return0; 945} 946 947sub mw_upload_file { 948my$complete_file_name=shift; 949my$new_sha1=shift; 950my$extension=shift; 951my$file_deleted=shift; 952my$summary=shift; 953my$newrevid; 954my$path="File:${complete_file_name}"; 955my%hashFiles= get_allowed_file_extensions(); 956if(!exists($hashFiles{$extension})) { 957print{*STDERR}"${complete_file_name} is not a permitted file on this wiki.\n"; 958print{*STDERR}"Check the configuration of file uploads in your mediawiki.\n"; 959return$newrevid; 960} 961# Deleting and uploading a file requires a priviledged user 962if($file_deleted) { 963$mediawiki= connect_maybe($mediawiki,$remotename,$url); 964my$query= { 965 action =>'delete', 966 title =>$path, 967 reason =>$summary 968}; 969if(!$mediawiki->edit($query)) { 970print{*STDERR}"Failed to delete file on remote wiki\n"; 971print{*STDERR}"Check your permissions on the remote site. Error code:\n"; 972print{*STDERR}$mediawiki->{error}->{code} .':'.$mediawiki->{error}->{details}; 973exit1; 974} 975}else{ 976# Don't let perl try to interpret file content as UTF-8 => use "raw" 977my$content= run_git("cat-file blob ${new_sha1}",'raw'); 978if($contentne EMPTY) { 979$mediawiki= connect_maybe($mediawiki,$remotename,$url); 980$mediawiki->{config}->{upload_url} = 981"${url}/index.php/Special:Upload"; 982$mediawiki->edit({ 983 action =>'upload', 984 filename =>$complete_file_name, 985 comment =>$summary, 986 file => [undef, 987$complete_file_name, 988 Content =>$content], 989 ignorewarnings =>1, 990}, { 991 skip_encoding =>1 992} ) ||die$mediawiki->{error}->{code} .':' 993.$mediawiki->{error}->{details} ."\n"; 994my$last_file_page=$mediawiki->get_page({title =>$path}); 995$newrevid=$last_file_page->{revid}; 996print{*STDERR}"Pushed file: ${new_sha1} - ${complete_file_name}.\n"; 997}else{ 998print{*STDERR}"Empty file ${complete_file_name} not pushed.\n"; 999}1000}1001return$newrevid;1002}10031004sub mw_push_file {1005my$diff_info=shift;1006# $diff_info contains a string in this format:1007# 100644 100644 <sha1_of_blob_before_commit> <sha1_of_blob_now> <status>1008my@diff_info_split=split(/[ \t]/,$diff_info);10091010# Filename, including .mw extension1011my$complete_file_name=shift;1012# Commit message1013my$summary=shift;1014# MediaWiki revision number. Keep the previous one by default,1015# in case there's no edit to perform.1016my$oldrevid=shift;1017my$newrevid;10181019if($summaryeq EMPTY_MESSAGE) {1020$summary= EMPTY;1021}10221023my$new_sha1=$diff_info_split[3];1024my$old_sha1=$diff_info_split[2];1025my$page_created= ($old_sha1eq NULL_SHA1);1026my$page_deleted= ($new_sha1eq NULL_SHA1);1027$complete_file_name= clean_filename($complete_file_name);10281029my($title,$extension) =$complete_file_name=~/^(.*)\.([^\.]*)$/;1030if(!defined($extension)) {1031$extension= EMPTY;1032}1033if($extensioneq'mw') {1034my$ns= get_mw_namespace_id_for_page($complete_file_name);1035if($ns&&$ns== get_mw_namespace_id('File') && (!$export_media)) {1036print{*STDERR}"Ignoring media file related page: ${complete_file_name}\n";1037return($oldrevid,'ok');1038}1039my$file_content;1040if($page_deleted) {1041# Deleting a page usually requires1042# special privileges. A common1043# convention is to replace the page1044# with this content instead:1045$file_content= DELETED_CONTENT;1046}else{1047$file_content= run_git("cat-file blob ${new_sha1}");1048}10491050$mediawiki= connect_maybe($mediawiki,$remotename,$url);10511052my$result=$mediawiki->edit( {1053 action =>'edit',1054 summary =>$summary,1055 title =>$title,1056 basetimestamp =>$basetimestamps{$oldrevid},1057 text => mediawiki_clean($file_content,$page_created),1058}, {1059 skip_encoding =>1# Helps with names with accentuated characters1060});1061if(!$result) {1062if($mediawiki->{error}->{code} ==3) {1063# edit conflicts, considered as non-fast-forward1064print{*STDERR}'Warning: Error '.1065$mediawiki->{error}->{code} .1066' from mediawiki: '.$mediawiki->{error}->{details} .1067".\n";1068return($oldrevid,'non-fast-forward');1069}else{1070# Other errors. Shouldn't happen => just die()1071die'Fatal: Error '.1072$mediawiki->{error}->{code} .1073' from mediawiki: '.$mediawiki->{error}->{details} ."\n";1074}1075}1076$newrevid=$result->{edit}->{newrevid};1077print{*STDERR}"Pushed file: ${new_sha1} - ${title}\n";1078}elsif($export_media) {1079$newrevid= mw_upload_file($complete_file_name,$new_sha1,1080$extension,$page_deleted,1081$summary);1082}else{1083print{*STDERR}"Ignoring media file ${title}\n";1084}1085$newrevid= ($newrevidor$oldrevid);1086return($newrevid,'ok');1087}10881089sub mw_push {1090# multiple push statements can follow each other1091my@refsspecs= (shift, get_more_refs('push'));1092my$pushed;1093formy$refspec(@refsspecs) {1094my($force,$local,$remote) =$refspec=~/^(\+)?([^:]*):([^:]*)$/1095or die("Invalid refspec for push. Expected <src>:<dst> or +<src>:<dst>\n");1096if($force) {1097print{*STDERR}"Warning: forced push not allowed on a MediaWiki.\n";1098}1099if($localeq EMPTY) {1100print{*STDERR}"Cannot delete remote branch on a MediaWiki\n";1101print{*STDOUT}"error ${remote} cannot delete\n";1102next;1103}1104if($remotene'refs/heads/master') {1105print{*STDERR}"Only push to the branch 'master' is supported on a MediaWiki\n";1106print{*STDOUT}"error ${remote} only master allowed\n";1107next;1108}1109if(mw_push_revision($local,$remote)) {1110$pushed=1;1111}1112}11131114# Notify Git that the push is done1115print{*STDOUT}"\n";11161117if($pushed&&$dumb_push) {1118print{*STDERR}"Just pushed some revisions to MediaWiki.\n";1119print{*STDERR}"The pushed revisions now have to be re-imported, and your current branch\n";1120print{*STDERR}"needs to be updated with these re-imported commits. You can do this with\n";1121print{*STDERR}"\n";1122print{*STDERR}" git pull --rebase\n";1123print{*STDERR}"\n";1124}1125return;1126}11271128sub mw_push_revision {1129my$local=shift;1130my$remote=shift;# actually, this has to be "refs/heads/master" at this point.1131my$last_local_revid= get_last_local_revision();1132print{*STDERR}".\n";# Finish sentence started by get_last_local_revision()1133my$last_remote_revid= get_last_remote_revision();1134my$mw_revision=$last_remote_revid;11351136# Get sha1 of commit pointed by local HEAD1137my$HEAD_sha1= run_git("rev-parse ${local} 2>/dev/null");1138chomp($HEAD_sha1);1139# Get sha1 of commit pointed by remotes/$remotename/master1140my$remoteorigin_sha1= run_git("rev-parse refs/remotes/${remotename}/master 2>/dev/null");1141chomp($remoteorigin_sha1);11421143if($last_local_revid>0&&1144$last_local_revid<$last_remote_revid) {1145return error_non_fast_forward($remote);1146}11471148if($HEAD_sha1eq$remoteorigin_sha1) {1149# nothing to push1150return0;1151}11521153# Get every commit in between HEAD and refs/remotes/origin/master,1154# including HEAD and refs/remotes/origin/master1155my@commit_pairs= ();1156if($last_local_revid>0) {1157my$parsed_sha1=$remoteorigin_sha1;1158# Find a path from last MediaWiki commit to pushed commit1159print{*STDERR}"Computing path from local to remote ...\n";1160my@local_ancestry=split(/\n/, run_git("rev-list --boundary --parents ${local} ^${parsed_sha1}"));1161my%local_ancestry;1162foreachmy$line(@local_ancestry) {1163if(my($child,$parents) =$line=~/^-?([a-f0-9]+) ([a-f0-9 ]+)/) {1164foreachmy$parent(split(/ /,$parents)) {1165$local_ancestry{$parent} =$child;1166}1167}elsif(!$line=~/^([a-f0-9]+)/) {1168die"Unexpected output from git rev-list: ${line}\n";1169}1170}1171while($parsed_sha1ne$HEAD_sha1) {1172my$child=$local_ancestry{$parsed_sha1};1173if(!$child) {1174print{*STDERR}"Cannot find a path in history from remote commit to last commit\n";1175return error_non_fast_forward($remote);1176}1177push(@commit_pairs, [$parsed_sha1,$child]);1178$parsed_sha1=$child;1179}1180}else{1181# No remote mediawiki revision. Export the whole1182# history (linearized with --first-parent)1183print{*STDERR}"Warning: no common ancestor, pushing complete history\n";1184my$history= run_git("rev-list --first-parent --children ${local}");1185my@history=split(/\n/,$history);1186@history=@history[1..$#history];1187foreachmy$line(reverse@history) {1188my@commit_info_split=split(/[ \n]/,$line);1189push(@commit_pairs, \@commit_info_split);1190}1191}11921193foreachmy$commit_info_split(@commit_pairs) {1194my$sha1_child= @{$commit_info_split}[0];1195my$sha1_commit= @{$commit_info_split}[1];1196my$diff_infos= run_git("diff-tree -r --raw -z ${sha1_child} ${sha1_commit}");1197# TODO: we could detect rename, and encode them with a #redirect on the wiki.1198# TODO: for now, it's just a delete+add1199my@diff_info_list=split(/\0/,$diff_infos);1200# Keep the subject line of the commit message as mediawiki comment for the revision1201my$commit_msg= run_git(qq(log --no-walk --format="%s" ${sha1_commit}));1202chomp($commit_msg);1203# Push every blob1204while(@diff_info_list) {1205my$status;1206# git diff-tree -z gives an output like1207# <metadata>\0<filename1>\01208# <metadata>\0<filename2>\01209# and we've split on \0.1210my$info=shift(@diff_info_list);1211my$file=shift(@diff_info_list);1212($mw_revision,$status) = mw_push_file($info,$file,$commit_msg,$mw_revision);1213if($statuseq'non-fast-forward') {1214# we may already have sent part of the1215# commit to MediaWiki, but it's too1216# late to cancel it. Stop the push in1217# the middle, but still give an1218# accurate error message.1219return error_non_fast_forward($remote);1220}1221if($statusne'ok') {1222die("Unknown error from mw_push_file()\n");1223}1224}1225if(!$dumb_push) {1226 run_git(qq(notes --ref=${remotename}/mediawiki add -f -m "mediawiki_revision: ${mw_revision}" ${sha1_commit}));1227}1228}12291230print{*STDOUT}"ok ${remote}\n";1231return1;1232}12331234sub get_allowed_file_extensions {1235$mediawiki= connect_maybe($mediawiki,$remotename,$url);12361237my$query= {1238 action =>'query',1239 meta =>'siteinfo',1240 siprop =>'fileextensions'1241};1242my$result=$mediawiki->api($query);1243my@file_extensions=map{$_->{ext}} @{$result->{query}->{fileextensions}};1244my%hashFile=map{$_=>1}@file_extensions;12451246return%hashFile;1247}12481249# In memory cache for MediaWiki namespace ids.1250my%namespace_id;12511252# Namespaces whose id is cached in the configuration file1253# (to avoid duplicates)1254my%cached_mw_namespace_id;12551256# Return MediaWiki id for a canonical namespace name.1257# Ex.: "File", "Project".1258sub get_mw_namespace_id {1259$mediawiki= connect_maybe($mediawiki,$remotename,$url);1260my$name=shift;12611262if(!exists$namespace_id{$name}) {1263# Look at configuration file, if the record for that namespace is1264# already cached. Namespaces are stored in form:1265# "Name_of_namespace:Id_namespace", ex.: "File:6".1266my@temp=split(/\n/,1267 run_git("config --get-all remote.${remotename}.namespaceCache"));1268chomp(@temp);1269foreachmy$ns(@temp) {1270my($n,$id) =split(/:/,$ns);1271if($ideq'notANameSpace') {1272$namespace_id{$n} = {is_namespace =>0};1273}else{1274$namespace_id{$n} = {is_namespace =>1, id =>$id};1275}1276$cached_mw_namespace_id{$n} =1;1277}1278}12791280if(!exists$namespace_id{$name}) {1281print{*STDERR}"Namespace ${name} not found in cache, querying the wiki ...\n";1282# NS not found => get namespace id from MW and store it in1283# configuration file.1284my$query= {1285 action =>'query',1286 meta =>'siteinfo',1287 siprop =>'namespaces'1288};1289my$result=$mediawiki->api($query);12901291while(my($id,$ns) =each(%{$result->{query}->{namespaces}})) {1292if(defined($ns->{id}) &&defined($ns->{canonical})) {1293$namespace_id{$ns->{canonical}} = {is_namespace =>1, id =>$ns->{id}};1294if($ns->{'*'}) {1295# alias (e.g. french Fichier: as alias for canonical File:)1296$namespace_id{$ns->{'*'}} = {is_namespace =>1, id =>$ns->{id}};1297}1298}1299}1300}13011302my$ns=$namespace_id{$name};1303my$id;13041305if(!defined$ns) {1306print{*STDERR}"No such namespace ${name} on MediaWiki.\n";1307$ns= {is_namespace =>0};1308$namespace_id{$name} =$ns;1309}13101311if($ns->{is_namespace}) {1312$id=$ns->{id};1313}13141315# Store "notANameSpace" as special value for inexisting namespaces1316my$store_id= ($id||'notANameSpace');13171318# Store explicitly requested namespaces on disk1319if(!exists$cached_mw_namespace_id{$name}) {1320 run_git(qq(config --add remote.${remotename}.namespaceCache "${name}:${store_id}"));1321$cached_mw_namespace_id{$name} =1;1322}1323return$id;1324}13251326sub get_mw_namespace_id_for_page {1327my$namespace=shift;1328if($namespace=~/^([^:]*):/) {1329return get_mw_namespace_id($namespace);1330}else{1331return;1332}1333}