API:Import/ja

このページは MediaWiki API 説明文書の一部です。

言語:	English  • 日本語

MediaWiki API

Quick overview:

• Quick start guide
• FAQ
  • エチケットおよび使用制限
• チュートリアル
• フォーマット
• エラーの報告
• 使用制限
• クロスサイト リクエスト
• 認証
  • ログイン
  • ログアウト
  • アカウント作成
• クエリ
  • メタ情報
  • プロパティ
  • 一覧
• 検索の提案
• ウィキテキストの構文解析とテンプレートの展開
• ページのキャッシュの破棄
• パラメーター情報
• ウィキの本文の変更
  • ページの作成/編集
  • ページの移動
  • ロールバック
  • ページの削除
  • 削除された版の復元
  • ページの保護/保護解除
  • 利用者のブロック/ブロック解除
  • ページのウォッチ/ウォッチ解除
  • ウォッチしているページの版を訪問済みにする
  • メールの送信
  • 変更の巡回
  • ページの取り込み
  • 利用者の所属グループの変更
  • ファイルのアップロード
  • 利用者オプション
  • トークン
• ウォッチリストのフィード
• ウィキデータ /en
• 拡張機能
• MediaWikiおよび拡張機能内でのAPIの使用
• その他
• 実装
• クライアント コード
• アサート

MediaWiki バージョン:

1.15

トークン

ページを取り込むには、取り込みトークン (import token) が必要です。このトークンは編集トークンと同じで、すべてのページに対して同じトークンを使用できますが、ログインのたびに変化します。取り込みImport tokens can be obtained via action=tokens with type=import (MW 1.20+), or by using the following method:

api.php?action=query&prop=info&intoken=import&titles=Main%20Page

ページの取り込み

action=import でページを取り込めます。取り込みには、XML ファイルのアップロード、または別のページの指定、を使用できます (後者はウィキ間転送 (transwiki) とも呼ばれます)。

パラメーター

(アップロード) の印があるパラメーターは、XML ファイルのアップロードによる取り込みのみに使用します。同様に、(インターウィキ) の印があるパラメーターは、別のウィキからの取り込み (ウィキ間転送) のみに使用します。

• token: 以前のリクエストで取得したトークン。必ず末尾の +\ を %2B%5C に urlencode するようにしてください
• summary: 取り込み記録用の要約 (省略可能)
• xml: アップロードする XML ファイル (アップロード)
• interwikisource: 取り込み元のウィキ (インターウィキ)
  • The possible values for this parameter differ per wiki, see $wgImportSources. If the list of possible values for this parameter is empty, interwiki imports are disabled
• interwikipage: 取り込み先ページのページ名 (インターウィキ)
• fullhistory: 設定した場合、現在の版のみではなく、完全な履歴を取り込む (インターウィキ)
• namespace: 取り込み先の名前空間。設定しなかった場合、ページの名前空間を変更しません (インターウィキ)
• templates: 参照読み込みされたテンプレートもすべて取り込む (インターウィキ)

例

注記: In these examples, all parameters are passed in a GET request just for the sake of simplicity. However, action=import requires POST requests; GET requests will cause an error.

インターウィキ

api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory&token=58b54e0bab4a1d3fd3f7653af38e75cb%2B\

XML ファイル

api.php?action=import&xml=dumpcontentgoeshere&token=58b54e0bab4a1d3fd3f7653af38e75cb%2B\

When uploading a file, you need to use multipart/form-data as Content-Type or enctype, application/x-www-form-urlencoded will not work. The parameter xml is not a file name, but the actual content of a file.

Ruby source code example using httpclient (assumes login cookies are already in @headers)

 res = HTTPClient.post(@api_url, {
                              :action => 'import',
                              :xml => File.open("dump.xml"),
                              :token => token,
                              :format => 'xml'}, @headers)

FormData

If the result says "no file" it is expecting a file in a POST body. You can easily POST using FormData.

To quote from /api.php

    xml      - Uploaded XML file
               Must be posted as a file upload using multipart/form-data

JavaScript example

For simplicity, the following code is reading the XML from a textarea and makes use of MediaWiki's JavaScript includes:

 var apiUrl = mw.util.wikiScript( 'api' );
 var onreadystatechange = function() {
	if ( 4 !== this.readyState ) return;
	if ( 200 === this.status ) {
	  console.log( this.response );
	}
 };
 
 function continueWithToken ( token ) {
	  var fd = new FormData();
	  var xhr = new XMLHttpRequest();
	  // First argument is an array!
	  var bXml = new Blob( [$( 'textarea' ).val()], {
				 type: 'text/xml'
			} );
	  fd.append( 'format', 'json' );
	  fd.append( 'action', 'import' );
	  // Third parameter is not required but
	  // You're likely on the safe side using it
	  fd.append( 'xml', bXml, 'file.xml' );
	  fd.append( 'token', token );
 
	  xhr.onreadystatechange = onreadystatechange;
	  xhr.open( 'POST', apiUrl );
	  xhr.send( fd );
 }
 
 $.get( apiUrl, {
	  format: 'json',
	  type: 'import',
	  action: 'tokens'
 } ).done( function(r) {
	  var token = r.tokens.importtoken;
	  continueWithToken( token );
 } );

This is just a minimal implementation. Do not forget error-handling. If you have the exports as files for upload and want to make it working in older browsers not sufficiently supporting Blobs and FormData, just build a HTML form. The form's target could be an iframe so you can read the response from it without exposing the blank API result page to your users.

Expected response

{"import":[{"ns":0,"title":"Main Page2","revisions":1}]}

Raw request resulting

The request that is composed by the client and sent to the server for reference. Note the file's in a POST body.

POST http://localhost/api.php HTTP/1.1
Host: localhost
User-Agent: <ua string>
Accept-Language: de,en-US;q=0.7,en;q=0.3
Accept-Encoding: gzip, deflate
Referer: http://localhost/index.php?title=Special:Export&action=submit
Content-Length: 3231
Content-Type: multipart/form-data; boundary=---------------------768648126486
Cookie: <redacted>; mwdbUserID=1; mwdbUserName=Rillke
Connection: keep-alive
Pragma: no-cache
Cache-Control: no-cache

-----------------------768648126486
Content-Disposition: form-data; name="format"

json
-----------------------768648126486
Content-Disposition: form-data; name="action"

import
-----------------------768648126486
Content-Disposition: form-data; name="xml"; filename="file.xml"
Content-Type: text/xml

<mediawiki ...schemas... version="0.8" xml:lang="en">
<siteinfo>
  <sitename>Sample Wiki</sitename>
<!-- .... -->
</mediawiki>
-----------------------768648126486
Content-Disposition: form-data; name="token"

XX39e9fd22a9de7675c71eadcfd2XXXX+\
-----------------------768648126486--

"Missing boundary in multipart/form-data POST data" error?

This is because you sent it url-encoded but claimed it would be multipart/form-data? MediaWiki is looking for a boundary in the header but cannot find it.

起こりうるエラー

All errors are formatted as:

<error code="code" info="info">

コード	情報
notoken	The token parameter must be set
cantimport	You don't have permission to import pages
cantimport-upload	You don't have permission to import uploaded pages
nointerwikipage	The interwikipage parameter must be set
nofile	You didn't upload a file
filetoobig	The file you uploaded is bigger than the maximum upload size
partialupload	The file was only partially uploaded
notempdir	The temporary upload directory is missing Note: This generally means the server is broken or misconfigured
cantopenfile	Couldn't open the uploaded file Note: This generally means the server is broken or misconfigured
badinterwiki	Invalid interwiki title specified
import-unknownerror	Unknown error on import: "error"

関連項目

• ページの書き出し