OSDN Git Service

#27621 言語間リンク取得時に<includeonly>, <noinclude>を考慮するよう修正,
[wptscs/wpts.git] / Wptscs / Logics / MediaWikiTranslator.cs
1 // ================================================================================================
2 // <summary>
3 //      Wikipedia用の翻訳支援処理実装クラスソース</summary>
4 //
5 // <copyright file="MediaWikiTranslator.cs" company="honeplusのメモ帳">
6 //      Copyright (C) 2012 Honeplus. All rights reserved.</copyright>
7 // <author>
8 //      Honeplus</author>
9 // ================================================================================================
10
11 namespace Honememo.Wptscs.Logics
12 {
13     using System;
14     using System.Collections.Generic;
15     using System.IO;
16     using System.Linq;
17     using System.Net;
18     using System.Text;
19     using System.Windows.Forms;
20     using Honememo.Models;
21     using Honememo.Parsers;
22     using Honememo.Utilities;
23     using Honememo.Wptscs.Models;
24     using Honememo.Wptscs.Parsers;
25     using Honememo.Wptscs.Properties;
26     using Honememo.Wptscs.Utilities;
27     using Honememo.Wptscs.Websites;
28
29     /// <summary>
30     /// MediaWiki用の翻訳支援処理実装クラスです。
31     /// </summary>
32     public class MediaWikiTranslator : Translator
33     {
34         #region private変数
35
36         /// <summary>
37         /// <see cref="Translator.ItemTable"/>用ロックオブジェクト。
38         /// </summary>
39         private LockObject itemTableLock = new LockObject();
40
41         #endregion
42
43         #region コンストラクタ
44
45         /// <summary>
46         /// MediaWikiでの翻訳支援処理を行うトランスレータを作成。
47         /// </summary>
48         /// <remarks>
49         /// 別途プロパティに必要なパラメータを設定する必要あり。
50         /// 通常は<see cref="Translator.Create"/>にて設定ファイルから作成する。
51         /// </remarks>
52         public MediaWikiTranslator()
53         {
54             // このクラス用のロガーと、デフォルトの確認処理としてメッセージダイアログ版を設定
55             this.Logger = new MediaWikiLogger();
56             this.IsContinueAtInterwikiExisted = this.IsContinueAtInterwikiExistedWithDialog;
57         }
58
59         #endregion
60
61         #region デリゲート
62
63         /// <summary>
64         /// 対象記事に言語間リンクが存在する場合の確認処理を表すデリゲート。
65         /// </summary>
66         /// <param name="interwiki">言語間リンク先記事。</param>
67         /// <returns>処理を続行する場合<c>true</c>。</returns>
68         public delegate bool IsContinueAtInterwikiExistedDelegate(string interwiki);
69
70         #endregion
71
72         #region プロパティ
73
74         /// <summary>
75         /// 翻訳元言語のサイト。
76         /// </summary>
77         public new MediaWiki From
78         {
79             get
80             {
81                 return base.From as MediaWiki;
82             }
83
84             set
85             {
86                 base.From = value;
87             }
88         }
89
90         /// <summary>
91         /// 翻訳先言語のサイト。
92         /// </summary>
93         public new MediaWiki To
94         {
95             get
96             {
97                 return base.To as MediaWiki;
98             }
99
100             set
101             {
102                 base.To = value;
103             }
104         }
105
106         /// <summary>
107         /// 対象記事に言語間リンクが存在する場合の確認処理。
108         /// </summary>
109         /// <remarks>確認を行わない場合<c>null</c>。</remarks>
110         public IsContinueAtInterwikiExistedDelegate IsContinueAtInterwikiExisted
111         {
112             get;
113             set;
114         }
115
116         #endregion
117
118         #region メイン処理メソッド
119
120         /// <summary>
121         /// 翻訳支援処理実行部の本体。
122         /// ※継承クラスでは、この関数に処理を実装すること
123         /// </summary>
124         /// <param name="name">記事名。</param>
125         /// <exception cref="ApplicationException">処理が中断された場合。中断の理由は<see cref="Translator.Logger"/>に出力される。</exception>
126         protected override void RunBody(string name)
127         {
128             // 対象記事を取得
129             MediaWikiPage article = this.GetTargetPage(name);
130             if (article == null)
131             {
132                 throw new ApplicationException("article is not found");
133             }
134
135             // 対象記事に言語間リンクが存在する場合、処理を継続するか確認
136             // ※ 言語間リンク取得中は、処理状態を解析中に変更
137             MediaWikiLink interlanguage;
138             using (var sm = this.StatusManager.Switch(Resources.StatusParsing))
139             {
140                 interlanguage = article.GetInterlanguage(this.To.Language.Code);
141             }
142
143             if (interlanguage != null)
144             {
145                 // 確認処理の最中は処理時間をカウントしない(ダイアログ等を想定するため)
146                 this.Stopwatch.Stop();
147                 if (this.IsContinueAtInterwikiExisted != null && !this.IsContinueAtInterwikiExisted(interlanguage.Title))
148                 {
149                     throw new ApplicationException("user canceled");
150                 }
151
152                 this.Stopwatch.Start();
153                 this.Logger.AddResponse(Resources.LogMessageTargetArticleHadInterWiki, interlanguage.Title);
154             }
155
156             // 冒頭部を作成
157             this.Text += this.CreateOpening(article.Title);
158
159             // 言語間リンク・定型句の変換、実行中は処理状態を解析中に設定
160             this.Logger.AddSeparator();
161             this.Logger.AddResponse(Resources.LogMessageStartParseAndReplace);
162             using (var sm = this.StatusManager.Switch(Resources.StatusParsing))
163             {
164                 IElement element;
165                 using (MediaWikiParser parser = new MediaWikiParser(this.From))
166                 {
167                     element = parser.Parse(article.Text);
168                 }
169
170                 this.Text += this.ReplaceElement(element, article).ToString();
171             }
172
173             // 記事の末尾に新しい言語間リンクと、コメントを追記
174             this.Text += this.CreateEnding(article);
175
176             // ダウンロードされるテキストがLFなので、最後にクライアント環境に合わせた改行コードに変換
177             // ※ダウンロード時に変換するような仕組みが見つかれば、そちらを使う
178             //   その場合、上のように\nをべたに吐いている部分を修正する
179             this.Text = this.Text.Replace("\n", Environment.NewLine);
180         }
181
182         #endregion
183
184         #region 他のクラスの処理をこのクラスにあわせて拡張したメソッド
185
186         /// <summary>
187         /// ログ出力によるエラー処理を含んだページ取得処理。
188         /// </summary>
189         /// <param name="title">ページタイトル。</param>
190         /// <param name="page">取得したページ。ページが存在しない場合は <c>null</c> を返す。</param>
191         /// <returns>処理が成功した(404も含む)場合<c>true</c>、失敗した(通信エラーなど)の場合<c>false</c>。</returns>
192         /// <exception cref="ApplicationException"><see cref="Translator.CancellationPending"/>が<c>true</c>の場合。</exception>
193         /// <remarks>
194         /// 本メソッドは、大きく3パターンの動作を行う。
195         /// <list type="number">
196         /// <item><description>正常にページが取得できた → <c>true</c>でページを設定、ログ出力無し</description></item>
197         /// <item><description>404など想定内の例外でページが取得できなかった → <c>true</c>でページ無し、ログ出力無し</description></item>
198         /// <item><description>想定外の例外でページが取得できなかった → <c>false</c>でページ無し、ログ出力有り
199         ///                    or <c>ApplicationException</c>で処理中断(アプリケーション設定のIgnoreErrorによる)。</description></item>
200         /// </list>
201         /// また、実行中は処理状態をサーバー接続中に更新する。
202         /// 実行前後には終了要求のチェックも行う。
203         /// </remarks>
204         protected bool TryGetPage(string title, out MediaWikiPage page)
205         {
206             // &amp; &nbsp; 等の特殊文字をデコードして、親クラスのメソッドを呼び出し
207             Page p;
208             bool success = base.TryGetPage(WebUtility.HtmlDecode(title), out p);
209             page = p as MediaWikiPage;
210             return success;
211         }
212
213         #endregion
214
215         #region 冒頭/末尾ブロックの生成メソッド
216
217         /// <summary>
218         /// 変換後記事冒頭用の「'''日本語記事名'''([[英語|英]]: '''{{Lang|en|英語記事名}}''')」みたいなのを作成する。
219         /// </summary>
220         /// <param name="title">翻訳支援対象の記事名。</param>
221         /// <returns>冒頭部のテキスト。</returns>
222         protected virtual string CreateOpening(string title)
223         {
224             string langPart = String.Empty;
225             MediaWikiLink langLink = this.GetLanguageLink(this.From, this.To.Language.Code);
226             if (langLink != null)
227             {
228                 langPart = langLink.ToString() + ": ";
229             }
230
231             string langBody = this.To.FormatLang(this.From.Language.Code, title);
232             if (String.IsNullOrEmpty(langBody))
233             {
234                 langBody = title;
235             }
236
237             StringBuilder b = new StringBuilder("'''xxx'''");
238             b.Append(this.To.Language.FormatBracket(langPart + "'''" + langBody + "'''"));
239             b.Append("\n\n");
240             return b.ToString();
241         }
242
243         /// <summary>
244         /// 変換後記事末尾用の新しい言語間リンクとコメントを作成する。
245         /// </summary>
246         /// <param name="page">翻訳支援対象の記事。</param>
247         /// <returns>末尾部のテキスト。</returns>
248         protected virtual string CreateEnding(MediaWikiPage page)
249         {
250             MediaWikiLink link = new MediaWikiLink();
251             link.Title = page.Title;
252             link.Interwiki = this.From.Language.Code;
253             return "\n\n" + link.ToString() + "\n" + String.Format(
254                 Resources.ArticleFooter,
255                 FormUtils.ApplicationName(),
256                 this.From.Language.Code,
257                 page.Title,
258                 page.Timestamp.HasValue ? page.Timestamp.Value.ToString("U") : String.Empty) + "\n";
259         }
260
261         #endregion
262
263         #region 要素の変換メソッド
264
265         /// <summary>
266         /// 渡されたページ要素の変換を行う。
267         /// </summary>
268         /// <param name="element">ページ要素。</param>
269         /// <param name="parent">ページ要素を取得した変換元記事。</param>
270         /// <returns>変換後のページ要素。</returns>
271         protected virtual IElement ReplaceElement(IElement element, MediaWikiPage parent)
272         {
273             // ユーザーからの中止要求をチェック
274             this.ThrowExceptionIfCanceled();
275
276             // 要素の型に応じて、必要な置き換えを行う
277             if (element is MediaWikiTemplate)
278             {
279                 // テンプレート
280                 return this.ReplaceTemplate((MediaWikiTemplate)element, parent);
281             }
282             else if (element is MediaWikiLink)
283             {
284                 // 内部リンク
285                 return this.ReplaceLink((MediaWikiLink)element, parent);
286             }
287             else if (element is MediaWikiHeading)
288             {
289                 // 見出し
290                 return this.ReplaceHeading((MediaWikiHeading)element, parent);
291             }
292             else if (element is MediaWikiVariable)
293             {
294                 // 変数
295                 return this.ReplaceVariable((MediaWikiVariable)element, parent);
296             }
297             else if (element is ListElement)
298             {
299                 // 値を格納する要素
300                 return this.ReplaceListElement((ListElement)element, parent);
301             }
302
303             // それ以外は、特に何もせず元の値を返す
304             return element;
305         }
306
307         /// <summary>
308         /// 内部リンクを解析し、変換先言語の記事へのリンクに変換する。
309         /// </summary>
310         /// <param name="link">変換元リンク。</param>
311         /// <param name="parent">ページ要素を取得した変換元記事。</param>
312         /// <returns>変換済みリンク。</returns>
313         protected virtual IElement ReplaceLink(MediaWikiLink link, MediaWikiPage parent)
314         {
315             // 記事名が存在しないor自記事内の別セクションへのリンクの場合、記事名絡みの処理を飛ばす
316             if (!this.IsSectionLink(link, parent.Title))
317             {
318                 // 記事名の種類に応じて処理を実施
319                 MediaWikiPage article = new MediaWikiPage(this.From, link.Title);
320
321                 bool child = false;
322                 if (link.IsSubpage())
323                 {
324                     // サブページ(子)の場合だけ後で記事名を復元するので記録
325                     child = link.Title.StartsWith("/");
326                     
327                     // ページ名を完全な形に補完
328                     string title = parent.Normalize(link);
329                     if (parent.Title.StartsWith(title))
330                     {
331                         // サブページ(親)の場合、変換してもしょうがないのでセクションだけチェックして終了
332                         if (!String.IsNullOrEmpty(link.Section))
333                         {
334                             link.Section = this.ReplaceLinkSection(link.Section);
335                             link.ParsedString = null;
336                         }
337
338                         return link;
339                     }
340
341                     link.Title = title;
342                 }
343                 else if (!String.IsNullOrEmpty(link.Interwiki))
344                 {
345                     // 言語間リンク・姉妹プロジェクトへのリンクの場合、変換対象外とする
346                     // ただし、先頭が : でない、翻訳先言語への言語間リンクだけは削除
347                     return this.ReplaceLinkInterwiki(link);
348                 }
349                 else if (article.IsFile())
350                 {
351                     // 画像の場合、名前空間を翻訳先言語の書式に変換、パラメータ部を再帰的に処理
352                     return this.ReplaceLinkFile(link, parent);
353                 }
354                 else if (article.IsCategory() && !link.IsColon)
355                 {
356                     // カテゴリで記事へのリンクでない([[:Category:xxx]]みたいなリンクでない)場合、
357                     // カテゴリ用の変換を実施
358                     return this.ReplaceLinkCategory(link);
359                 }
360
361                 // 専用処理の無い内部リンクの場合、言語間リンクによる置き換えを行う
362                 string interWiki = this.GetInterlanguage(link);
363                 if (interWiki == null)
364                 {
365                     // 記事自体が存在しない(赤リンク)場合、リンクはそのまま
366                 }
367                 else if (interWiki == String.Empty)
368                 {
369                     // 言語間リンクが存在しない場合、可能なら{{仮リンク}}に置き換え
370                     if (!String.IsNullOrEmpty(this.To.LinkInterwikiFormat))
371                     {
372                         return this.ReplaceLinkLinkInterwiki(link);
373                     }
374
375                     // 設定が無ければ [[:en:xxx]] みたいな形式に置換
376                     link.Title = this.From.Language.Code + ':' + link.Title;
377                     link.IsColon = true;
378                 }
379                 else if (child)
380                 {
381                     // 言語間リンクが存在してサブページ(子)の場合、親ページ部分を消す
382                     // TODO: 兄弟や叔父のパターンも対処したい(ややこしいので現状未対応)
383                     link.Title = StringUtils.Substring(interWiki, interWiki.IndexOf('/'));
384                 }
385                 else
386                 {
387                     // 普通に言語間リンクが存在する場合、記事名を置き換え
388                     link.Title = interWiki;
389                 }
390
391                 if (link.PipeTexts.Count == 0 && interWiki != null)
392                 {
393                     // 表示名が存在しない場合、元の名前を表示名に設定
394                     // 元の名前にはあればセクションも含む
395                     link.PipeTexts.Add(
396                         new TextElement(new MediaWikiLink { Title = article.Title, Section = link.Section }
397                             .GetLinkString()));
398                 }
399             }
400
401             // セクション部分([[#関連項目]]とか)を変換
402             if (!String.IsNullOrEmpty(link.Section))
403             {
404                 link.Section = this.ReplaceLinkSection(link.Section);
405             }
406
407             link.ParsedString = null;
408             return link;
409         }
410
411         /// <summary>
412         /// テンプレートを解析し、変換先言語の記事へのテンプレートに変換する。
413         /// </summary>
414         /// <param name="template">変換元テンプレート。</param>
415         /// <param name="parent">ページ要素を取得した変換元記事。</param>
416         /// <returns>変換済みテンプレート。</returns>
417         protected virtual IElement ReplaceTemplate(MediaWikiTemplate template, MediaWikiPage parent)
418         {
419             // システム変数({{PAGENAME}}とか)の場合は対象外
420             if (this.From.IsMagicWord(template.Title))
421             {
422                 return template;
423             }
424
425             // テンプレートは通常名前空間が省略されているので補完する
426             string filledTitle = this.FillTemplateName(template, parent);
427
428             // リンクを辿り、対象記事の言語間リンクを取得
429             string interWiki = this.GetInterlanguage(new MediaWikiTemplate(filledTitle));
430             if (interWiki == null)
431             {
432                 // 記事自体が存在しない(赤リンク)場合、リンクはそのまま
433                 return template;
434             }
435             else if (interWiki == String.Empty)
436             {
437                 // 言語間リンクが存在しない場合、[[:en:Template:xxx]]みたいな普通のリンクに置換
438                 // おまけで、元のテンプレートの状態をコメントでつける
439                 ListElement list = new ListElement();
440                 MediaWikiLink link = new MediaWikiLink();
441                 link.IsColon = true;
442                 link.Title = this.From.Language.Code + ':' + filledTitle;
443                 list.Add(link);
444                 XmlCommentElement comment = new XmlCommentElement();
445                 comment.Raw = ' ' + template.ToString() + ' ';
446                 list.Add(comment);
447                 return list;
448             }
449             else
450             {
451                 // 言語間リンクが存在する場合、そちらを指すように置換
452                 // : より前の部分を削除して出力(: が無いときは-1+1で0から)
453                 template.Title = interWiki.Substring(interWiki.IndexOf(':') + 1);
454
455                 // | の後に内部リンクやテンプレートが書かれている場合があるので、再帰的に処理する
456                 template.PipeTexts = this.ReplaceElements(template.PipeTexts, parent);
457                 template.ParsedString = null;
458                 return template;
459             }
460         }
461
462         /// <summary>
463         /// 指定された見出しに対して、対訳表による変換を行う。
464         /// </summary>
465         /// <param name="heading">見出し。</param>
466         /// <param name="parent">ページ要素を取得した変換元記事。</param>
467         /// <returns>変換後の見出し。</returns>
468         protected virtual IElement ReplaceHeading(MediaWikiHeading heading, MediaWikiPage parent)
469         {
470             // 変換元ログ出力
471             this.Logger.AddSource(heading);
472
473             // 定型句変換
474             StringBuilder oldText = new StringBuilder();
475             foreach (IElement e in heading)
476             {
477                 oldText.Append(e.ToString());
478             }
479
480             string newText = this.GetHeading(oldText.ToString().Trim());
481             if (newText != null)
482             {
483                 // 対訳表による変換が行えた場合、変換先をログ出力し処理終了
484                 heading.Clear();
485                 heading.ParsedString = null;
486                 heading.Add(new XmlTextElement(newText));
487                 this.Logger.AddDestination(heading);
488                 return heading;
489             }
490
491             // 対訳表に存在しない場合、内部要素を通常の変換で再帰的に処理
492             return this.ReplaceListElement(heading, parent);
493         }
494
495         /// <summary>
496         /// 変数要素を再帰的に解析し、変換先言語の記事への要素に変換する。
497         /// </summary>
498         /// <param name="variable">変換元変数要素。</param>
499         /// <param name="parent">ページ要素を取得した変換元記事。</param>
500         /// <returns>変換済み変数要素。</returns>
501         protected virtual IElement ReplaceVariable(MediaWikiVariable variable, MediaWikiPage parent)
502         {
503             // 変数、これ自体は処理しないが、再帰的に探索
504             string old = variable.Value.ToString();
505             variable.Value = this.ReplaceElement(variable.Value, parent);
506             if (variable.Value.ToString() != old)
507             {
508                 // 内部要素が変化した(置き換えが行われた)場合、変換前のテキストを破棄
509                 variable.ParsedString = null;
510             }
511
512             return variable;
513         }
514
515         /// <summary>
516         /// 要素を再帰的に解析し、変換先言語の記事への要素に変換する。
517         /// </summary>
518         /// <param name="listElement">変換元要素。</param>
519         /// <param name="parent">ページ要素を取得した変換元記事。</param>
520         /// <returns>変換済み要素。</returns>
521         protected virtual IElement ReplaceListElement(ListElement listElement, MediaWikiPage parent)
522         {
523             // 値を格納する要素、これ自体は処理しないが、再帰的に探索
524             for (int i = 0; i < listElement.Count; i++)
525             {
526                 string old = listElement[i].ToString();
527                 listElement[i] = this.ReplaceElement(listElement[i], parent);
528                 if (listElement[i].ToString() != old)
529                 {
530                     // 内部要素が変化した(置き換えが行われた)場合、変換前のテキストを破棄
531                     listElement.ParsedString = null;
532                 }
533             }
534
535             return listElement;
536         }
537
538         #endregion
539
540         #region 対訳表アクセスメソッド
541
542         /// <summary>
543         /// 対訳表に指定された記事名の情報が登録されているか?
544         /// </summary>
545         /// <param name="title">記事名。</param>
546         /// <returns>指定した記事の情報が登録されている場合<c>true</c>。</returns>
547         /// <remarks>複数スレッドからのアクセスに対応する。また項目の対訳表が無い場合も動作する。</remarks>
548         protected bool ContainsAtItemTable(string title)
549         {
550             if (this.ItemTable == null)
551             {
552                 return false;
553             }
554
555             // 以下マルチスレッドで使われることも想定して対訳表へのアクセス時はロック
556             // ※ 対訳表へのアクセス時は記事名をデコードしておく
557             string decodedTitle = WebUtility.HtmlDecode(title);
558             lock (this.itemTableLock.GetObject(decodedTitle.ToLower()))
559             {
560                 // 対訳表へのキーとしてはHTMLデコードした記事名を使用する
561                 return this.ItemTable.ContainsKey(decodedTitle);
562             }
563         }
564         
565         /// <summary>
566         /// 指定されたコードでの見出しに相当する、別の言語での見出しを取得。
567         /// </summary>
568         /// <param name="heading">翻訳元言語での見出し。</param>
569         /// <returns>翻訳先言語での見出し。値が存在しない場合は<c>null</c>。</returns>
570         /// <remarks>見出しの対訳表が無い場合も動作する。</remarks>
571         protected string GetHeading(string heading)
572         {
573             if (this.HeadingTable == null)
574             {
575                 return null;
576             }
577
578             return this.HeadingTable.GetWord(heading);
579         }
580
581         #endregion
582
583         #region 言語間リンク取得メソッド
584         
585         /// <summary>
586         /// ロガーに取得結果を出力しつつ、指定された要素の記事の翻訳先言語への言語間リンクを返す。
587         /// </summary>
588         /// <param name="element">内部リンク要素。</param>
589         /// <returns>言語間リンク先の記事名。見つからない場合は空。ページ自体が存在しない場合は<c>null</c>。</returns>
590         /// <remarks>取得処理では対訳表を使用する。また新たな取得結果は対訳表に追加する。</remarks>
591         protected string GetInterlanguage(MediaWikiLink element)
592         {
593             // 翻訳元をロガーに出力
594             this.Logger.AddSource(element);
595             string title = element.Title;
596             TranslationDictionary.Item item;
597             if (this.ItemTable == null)
598             {
599                 // 対訳表が指定されていない場合は、使わずに言語間リンクを探索して終了
600                 return this.GetInterlanguageWithCreateCache(title, out item);
601             }
602
603             // 対訳表を使用して言語間リンクを探索。
604             // 以下マルチスレッドで使われることも想定して対訳表へのアクセス時はロック(記事名単位)。
605             // また、対訳表へのアクセス時は記事名をデコードしておく。
606             string decodedTitle = WebUtility.HtmlDecode(title);
607             lock (this.itemTableLock.GetObject(decodedTitle.ToLower()))
608             {
609                 if (this.ItemTable.TryGetValue(decodedTitle, out item))
610                 {
611                     // 存在する場合はその値を使用
612                     if (!String.IsNullOrWhiteSpace(item.Alias))
613                     {
614                         // リダイレクトがあれば、そのメッセージも表示
615                         this.Logger.AddAlias(new MediaWikiLink(item.Alias));
616                     }
617
618                     if (!String.IsNullOrEmpty(item.Word))
619                     {
620                         this.Logger.AddDestination(new MediaWikiLink(item.Word), true);
621                         return item.Word;
622                     }
623                     else
624                     {
625                         this.Logger.AddDestination(new TextElement(Resources.LogMessageInterWikiNotFound), true);
626                         return String.Empty;
627                     }
628                 }
629
630                 // 対訳表に存在しない場合は、普通に取得し表に記録
631                 // ※ こちらは内部でデコードしているためデコードした記事名を渡してはならない
632                 string interlanguage = this.GetInterlanguageWithCreateCache(title, out item);
633                 if (interlanguage != null)
634                 {
635                     // ページ自体が存在しない場合を除き、結果を対訳表に登録
636                     // ※ キャッシュとしては登録すべきかもしれないが、一応"対訳表"であるので
637                     this.ItemTable[decodedTitle] = item;
638                 }
639
640                 return interlanguage;
641             }
642         }
643
644         /// <summary>
645         /// ロガーに取得結果を出力しつつ、指定された記事の翻訳先言語への言語間リンクを返す。
646         /// キャッシュ用の処理結果情報も出力する。
647         /// </summary>
648         /// <param name="title">記事名。</param>
649         /// <param name="item">キャッシュ用の処理結果情報。</param>
650         /// <returns>言語間リンク先の記事名。見つからない場合は空。ページ自体が存在しない場合は<c>null</c>。</returns>
651         private string GetInterlanguageWithCreateCache(string title, out TranslationDictionary.Item item)
652         {
653             // 記事名から記事を探索
654             item = new TranslationDictionary.Item { Timestamp = DateTime.UtcNow };
655             MediaWikiPage page = this.GetDestinationPage(title);
656             if (page != null && page.IsRedirect())
657             {
658                 // リダイレクトの場合、リダイレクトである旨出力し、その先の記事を取得
659                 this.Logger.AddAlias(new MediaWikiLink(page.Redirect.Title));
660                 item.Alias = page.Redirect.Title;
661                 page = this.GetDestinationPage(page.Redirect.Title);
662             }
663
664             if (page == null)
665             {
666                 // ページ自体が存在しない場合はnull
667                 return null;
668             }
669
670             // 記事があればその言語間リンクを取得
671             MediaWikiLink interlanguage = page.GetInterlanguage(this.To.Language.Code);
672             if (interlanguage != null)
673             {
674                 item.Word = interlanguage.Title;
675                 this.Logger.AddDestination(interlanguage);
676             }
677             else
678             {
679                 // 見つからない場合は空
680                 item.Word = String.Empty;
681                 this.Logger.AddDestination(new TextElement(Resources.LogMessageInterWikiNotFound));
682             }
683
684             return item.Word;
685         }
686
687         /// <summary>
688         /// 変換先の記事を取得する。
689         /// </summary>
690         /// <param name="title">ページタイトル。</param>
691         /// <returns>取得したページ。ページが存在しない場合は <c>null</c> を返す。</returns>
692         /// <remarks>記事が無い場合、通信エラーなど例外が発生した場合は、エラーログを出力する。</remarks>
693         private MediaWikiPage GetDestinationPage(string title)
694         {
695             MediaWikiPage page;
696             if (this.TryGetPage(title, out page) && page == null)
697             {
698                 // 記事が存在しない場合だけ、変換先に「記事無し」を出力
699                 // ※ エラー時のログはTryGetPageが自動的に出力
700                 this.Logger.AddDestination(new TextElement(Resources.LogMessageLinkArticleNotFound));
701             }
702
703             return page;
704         }
705
706         #endregion
707
708         #region 要素の変換関連その他メソッド
709
710         /// <summary>
711         /// 同記事内の別のセクションを指すリンク([[#関連項目]]とか[[自記事#関連項目]]とか)か?
712         /// </summary>
713         /// <param name="link">判定する内部リンク。</param>
714         /// <param name="parent">内部リンクがあった記事。</param>
715         /// <returns>セクション部分のみ変換済みリンク。</returns>
716         private bool IsSectionLink(MediaWikiLink link, string parent)
717         {
718             // 記事名が指定されていない、または記事名が自分の記事名で
719             // 言語コード等も特に無く、かつセクションが指定されている場合
720             // (記事名もセクションも指定されていない・・・というケースもありえるが、
721             //   その場合他に指定できるものも思いつかないので通す)
722             return String.IsNullOrEmpty(link.Title)
723                 || (link.Title == parent && String.IsNullOrEmpty(link.Interwiki) && !String.IsNullOrEmpty(link.Section));
724         }
725
726         /// <summary>
727         /// 内部リンクのセクション部分([[#関連項目]]とか)の定型句変換を行う。
728         /// </summary>
729         /// <param name="section">セクション文字列。</param>
730         /// <returns>セクション部分のみ変換済みリンク。</returns>
731         private string ReplaceLinkSection(string section)
732         {
733             // セクションが指定されている場合、定型句変換を通す
734             string heading = this.GetHeading(section);
735             return heading != null ? heading : section;
736         }
737
738         /// <summary>
739         /// 言語間リンク指定の内部リンクを解析し、不要であれば削除する。
740         /// </summary>
741         /// <param name="link">変換元言語間リンク。</param>
742         /// <returns>変換済み言語間リンク。</returns>
743         private IElement ReplaceLinkInterwiki(MediaWikiLink link)
744         {
745             // 言語間リンク・姉妹プロジェクトへのリンクの場合、変換対象外とする
746             // ただし、先頭が : でない、翻訳先言語への言語間リンクだけは削除
747             if (!link.IsColon && link.Interwiki == this.To.Language.Code)
748             {
749                 return new TextElement();
750             }
751
752             return link;
753         }
754
755         /// <summary>
756         /// カテゴリ指定の内部リンクを解析し、変換先言語のカテゴリへのリンクに変換する。
757         /// </summary>
758         /// <param name="link">変換元カテゴリ。</param>
759         /// <returns>変換済みカテゴリ。</returns>
760         private IElement ReplaceLinkCategory(MediaWikiLink link)
761         {
762             // リンクを辿り、対象記事の言語間リンクを取得
763             string interWiki = this.GetInterlanguage(link);
764             if (interWiki == null)
765             {
766                 // 記事自体が存在しない(赤リンク)場合、リンクはそのまま
767                 return link;
768             }
769             else if (interWiki == String.Empty)
770             {
771                 // 言語間リンクが存在しない場合、コメントで元の文字列を保存した後
772                 // [[:en:xxx]]みたいな形式に置換。また | 以降は削除する
773                 XmlCommentElement comment = new XmlCommentElement();
774                 comment.Raw = ' ' + link.ToString() + ' ';
775
776                 link.Title = this.From.Language.Code + ':' + link.Title;
777                 link.IsColon = true;
778                 link.PipeTexts.Clear();
779                 link.ParsedString = null;
780
781                 ListElement list = new ListElement();
782                 list.Add(link);
783                 list.Add(comment);
784                 return list;
785             }
786             else
787             {
788                 // 普通に言語間リンクが存在する場合、記事名を置き換え
789                 link.Title = interWiki;
790                 link.ParsedString = null;
791                 return link;
792             }
793         }
794
795         /// <summary>
796         /// ファイル指定の内部リンクを解析し、変換先言語で参照可能なファイルへのリンクに変換する。
797         /// </summary>
798         /// <param name="link">変換元リンク。</param>
799         /// <param name="parent">ページ要素を取得した変換元記事。</param>
800         /// <returns>変換済みリンク。</returns>
801         private IElement ReplaceLinkFile(MediaWikiLink link, MediaWikiPage parent)
802         {
803             // 名前空間を翻訳先言語の書式に変換、またパラメータ部を再帰的に処理
804             link.Title = this.ReplaceLinkNamespace(link.Title, this.To.FileNamespace);
805             link.PipeTexts = this.ReplaceElements(link.PipeTexts, parent);
806             link.ParsedString = null;
807             return link;
808         }
809
810         /// <summary>
811         /// 記事名のうち名前空間部分の変換先言語への変換を行う。
812         /// </summary>
813         /// <param name="title">変換元記事名。</param>
814         /// <param name="id">名前空間のID。</param>
815         /// <returns>変換済み記事名。</returns>
816         private string ReplaceLinkNamespace(string title, int id)
817         {
818             // 名前空間だけ翻訳先言語の書式に変換
819             IgnoreCaseSet names;
820             if (!this.To.Namespaces.TryGetValue(id, out names))
821             {
822                 // 翻訳先言語に相当する名前空間が無い場合、何もしない
823                 return title;
824             }
825
826             // 記事名の名前空間部分を置き換えて返す
827             return names.FirstOrDefault() + title.Substring(title.IndexOf(':'));
828         }
829
830         /// <summary>
831         /// 内部リンクを他言語版への{{仮リンク}}等に変換する。。
832         /// </summary>
833         /// <param name="link">変換元言語間リンク。</param>
834         /// <returns>変換済み言語間リンク。</returns>
835         private IElement ReplaceLinkLinkInterwiki(MediaWikiLink link)
836         {
837             // 仮リンクにはセクションの指定が可能なので、存在する場合付加する
838             // ※ 渡されたlinkをそのまま使わないのは、余計なゴミが含まれる可能性があるため
839             MediaWikiLink title = new MediaWikiLink { Title = link.Title, Section = link.Section };
840             string langTitle = title.GetLinkString();
841             if (!String.IsNullOrEmpty(title.Section))
842             {
843                 // 変換先言語版のセクションは、セクションの変換を通したものにする
844                 title.Section = this.ReplaceLinkSection(title.Section);
845             }
846
847             // 表示名は、設定されていればその値を、なければ変換元言語の記事名を使用
848             string label = langTitle;
849             if (link.PipeTexts.Count > 0)
850             {
851                 label = link.PipeTexts.Last().ToString();
852             }
853
854             // 書式化した文字列を返す
855             // ※ {{仮リンク}}を想定しているが、やろうと思えば何でもできるのでテキストで処理
856             return new TextElement(this.To.FormatLinkInterwiki(title.GetLinkString(), this.From.Language.Code, langTitle, label));
857         }
858
859         /// <summary>
860         /// 渡された要素リストに対して<see cref="ReplaceElement"/>による変換を行う。
861         /// </summary>
862         /// <param name="elements">変換元要素リスト。</param>
863         /// <param name="parent">ページ要素を取得した変換元記事。</param>
864         /// <returns>変換済み要素リスト。</returns>
865         private IList<IElement> ReplaceElements(IList<IElement> elements, MediaWikiPage parent)
866         {
867             if (elements == null)
868             {
869                 return null;
870             }
871
872             IList<IElement> result = new List<IElement>();
873             foreach (IElement e in elements)
874             {
875                 result.Add(this.ReplaceElement(e, parent));
876             }
877
878             return result;
879         }
880
881         /// <summary>
882         /// テンプレート名に必要に応じて名前空間を補完する。
883         /// </summary>
884         /// <param name="template">テンプレート。</param>
885         /// <param name="parent">ページ要素を取得した変換元記事。</param>
886         /// <returns>補完済みのテンプレート名。</returns>
887         private string FillTemplateName(MediaWikiTemplate template, MediaWikiPage parent)
888         {
889             // プレフィックスが付いた記事名を作成
890             string filledTitle = parent.Normalize(template);
891             if (filledTitle == template.Title || template.IsSubpage())
892             {
893                 // 補完が不要な場合、またはサブページだった場合、ここで終了
894                 return filledTitle;
895             }
896
897             // プレフィックスが付いた記事名が実際に存在するかを確認
898             // ※ 不要かもしれないが、マジックワードの漏れ等の誤検出を減らしたいので
899             if (this.ContainsAtItemTable(filledTitle))
900             {
901                 // 対訳表に記事名が確認されている場合、既知の名前として確定
902                 return filledTitle;
903             }
904
905             // 実際に頭にプレフィックスを付けた記事名でアクセスし、存在するかをチェック
906             // TODO: GetInterWikiの方とあわせ、テンプレートでは2度GetPageが呼ばれている。可能であれば共通化する
907             MediaWikiPage page = null;
908             try
909             {
910                 // 記事が存在する場合、プレフィックスをつけた名前を使用
911                 page = this.From.GetPage(WebUtility.HtmlDecode(filledTitle)) as MediaWikiPage;
912                 return filledTitle;
913             }
914             catch (FileNotFoundException)
915             {
916                 // 記事が存在しない場合、元のページ名を使用
917                 return template.Title;
918             }
919             catch (Exception e)
920             {
921                 // 想定外の例外が発生した場合
922                 if (!Settings.Default.IgnoreError)
923                 {
924                     // エラーを無視しない場合、ここで翻訳支援処理を中断する
925                     this.Logger.AddError(e);
926                     throw new ApplicationException(e.Message, e);
927                 }
928
929                 // 続行する場合は、とりあえずプレフィックスをつけた名前で処理
930                 this.Logger.AddResponse(Resources.LogMessageTemplateNameUnidentified, template.Title, filledTitle, e.Message);
931                 return filledTitle;
932             }
933         }
934
935         #endregion
936
937         #region その他内部処理用メソッド
938
939         /// <summary>
940         /// 翻訳支援対象のページを取得。
941         /// </summary>
942         /// <param name="title">翻訳支援対象の記事名。</param>
943         /// <returns>取得したページ。取得失敗時は<c>null</c>。</returns>
944         private MediaWikiPage GetTargetPage(string title)
945         {
946             // 指定された記事をWikipediaから取得、リダイレクトの場合その先まで探索
947             // ※ この処理ではキャッシュは使用しない。
948             // ※ 万が一相互にリダイレクトしていると無限ループとなるが、特に判定はしない。
949             //    ユーザーが画面上から止めることを期待。
950             this.Logger.AddMessage(Resources.LogMessageGetTargetArticle, this.From.Location, title);
951             MediaWikiPage page;
952             for (string s = title; this.TryGetPage(s, out page); s = page.Redirect.Title)
953             {
954                 if (page == null)
955                 {
956                     // 記事が存在しない場合、メッセージを出力して終了
957                     this.Logger.AddResponse(Resources.LogMessageTargetArticleNotFound);
958                     break;
959                 }
960                 else if (!page.IsRedirect())
961                 {
962                     // リダイレクト以外もここで終了
963                     break;
964                 }
965
966                 // リダイレクトであれば、さらにその先の記事を取得
967                 this.Logger.AddResponse(Resources.LogMessageRedirect
968                     + " " + new MediaWikiLink(page.Redirect.Title).ToString());
969             }
970
971             return page;
972         }
973
974         /// <summary>
975         /// 指定した言語での言語名称を [[言語名称|略称]]の内部リンクで取得。
976         /// </summary>
977         /// <param name="site">サイト。</param>
978         /// <param name="code">言語のコード。</param>
979         /// <returns>[[言語名称|略称]]の内部リンク。登録されていない場合<c>null</c>。</returns>
980         private MediaWikiLink GetLanguageLink(Website site, string code)
981         {
982             if (!site.Language.Names.ContainsKey(code))
983             {
984                 return null;
985             }
986
987             Language.LanguageName name = site.Language.Names[code];
988             MediaWikiLink link = new MediaWikiLink(name.Name);
989             if (!String.IsNullOrEmpty(name.ShortName))
990             {
991                 link.PipeTexts.Add(new TextElement(name.ShortName));
992             }
993
994             return link;
995         }
996
997         /// <summary>
998         /// 対象記事に言語間リンクが存在する場合にメッセージダイアログでユーザーに確認する処理。
999         /// </summary>
1000         /// <param name="interwiki">言語間リンク先記事。</param>
1001         /// <returns>処理を続行する場合<c>true</c>。</returns>
1002         private bool IsContinueAtInterwikiExistedWithDialog(string interwiki)
1003         {
1004             // 確認ダイアログを表示
1005             if (MessageBox.Show(
1006                         String.Format(Resources.QuestionMessageArticleExisted, interwiki),
1007                         Resources.QuestionTitle,
1008                         MessageBoxButtons.YesNo,
1009                         MessageBoxIcon.Question)
1010                    == DialogResult.No)
1011             {
1012                 // 中断の場合、同じメッセージをログにも表示
1013                 this.Logger.AddSeparator();
1014                 this.Logger.AddMessage(Resources.QuestionMessageArticleExisted, interwiki);
1015                 return false;
1016             }
1017
1018             return true;
1019         }
1020
1021         #endregion
1022     }
1023 }