Word・PowerPoint の共通処理と Office アプリの管理¶
扱うこと: Word・PowerPoint に共通の抽出処理・テキスト読み取り、失敗の原因の言い換え、Office アプリ(Excel・Word・PowerPoint)の起動・終了・制限時間の監視。扱わないこと: Excel の抽出処理(Excel)、Word・PowerPoint それぞれの旧形式の変換と場所(Word・PowerPoint)。先に読むページ: インデックス作成。
Word・PowerPoint で共通の抽出処理(Word・PowerPoint の抽出処理)、失敗の原因の言い換え(失敗の原因)、Office アプリの起動・終了と制限時間の監視(Office アプリ(Excel・Word・PowerPoint)の管理)を扱う。
Word・PowerPoint の抽出処理(extractDocument)¶
Word・PowerPoint で共通の処理。旧形式などをアプリで変換する処理は Word の旧形式の変換(Word)・PowerPoint の旧形式の変換(PowerPoint)、ファイルの読み取りは Word・PowerPoint のテキスト読み取り(共通)・Word のテキスト読み取りと TSV の場所(Word)・PowerPoint のテキスト読み取りと TSV の場所(PowerPoint)。
flowchart TD
A["extractDocument(パス)"] --> CP["作業領域に source.#lt;拡張子#gt; としてコピー<br>(copyFileShared。元のファイルに影響を出さない)"]
CP --> Z{"コピーの先頭が<br>ZIP のシグネチャ(PK)?"}
Z -- はい --> R["コピーをそのまま読む(6.4〜6.6)<br>readDocxUnits / readPptxUnits"]
Z -- いいえ --> K{"暗号化の種類<br>(下の「暗号化されたファイルの判定」)"}
K -- "Password・Rights" --> ERR2["Officeを使わずに失敗<br>(throwProtectionFailure)"]
K -- "Unknown(形式の分からないバイナリ)" --> FB{"アプリごとの<br>予備の切り替えが有効?"}
FB -- いいえ --> ERR2
FB -- はい --> C2["拡張子は変えず、Wordは形式を固定して開く<br>(Format はテキスト自動判定にしない)"]
C2 --> O2{"開けた?"}
O2 -- いいえ --> ERR3["元の例外をログに書き、<br>『暗号化されているか壊れている』に言い換えて失敗"]
O2 -- はい --> S2["converted.docx / converted.pptx として保存"]
K -- "Legacy・Text(旧形式・空・RTF・HTML等)" --> PC{"PowerPoint で、先頭が<br>複合ドキュメント形式でない?"}
PC -- はい --> ERR
PC -- いいえ --> C["コピーの名前を source.doc / source.ppt に変える"]
C --> O{"Word / PowerPoint で開く<br>(4.5 / 4.6)"}
O -- "開けない<br>(パスワード付き等)" --> ERR["例外 → 取り込み一覧に『失敗』と記録"]
O -- 開けた --> S["converted.docx / converted.pptx として保存"]
S & S2 --> OC{"出力の先頭がZIP?<br>(testOfficeOutput)"}
OC -- いいえ --> ERR4["『ファイルを暗号化する製品が<br>一時ファイルを暗号化した』に失敗"]
OC -- はい --> R2["保存したファイルを読む(6.4〜6.6)"]
R & R2 --> W["writeUnits: 場所ごとに<br>#lt;場所#gt;.tsv を作業領域に出力<br>(空の場所は出力しない)"]
W --> D["作業領域のコピー・変換したファイルを削除(finally)"]
- 元のファイルは直接読まず、先に作業領域へコピーする(Excel・テキストと同じく
copyFileShared。Excel の補足)。元のファイルに絶対に影響を出さない方針のため。効果として、読んでいる間も利用者が上書き保存でき、利用者が編集中(書き込みで開いている)のファイルも読める。 - ZIP でないコピーは、開く前に暗号化の種類を判定する(下の「暗号化されたファイルの判定」)。パスワード付き(新形式)・IRM は Word・PowerPoint を起動せずに失敗にする。旧形式・テキストらしい内容は今までどおり開く。
- コピーに旧形式の拡張子を付けてから開くのは、Word・PowerPoint が拡張子と中身が異なるファイル(中身が
.docの.docx等)を開けないため。「形式の分からないバイナリ」(下記)は拡張子を変えない。 - パスワード付きの
.docx.pptxは、Word・PowerPointを起動せずに失敗にする(下記)。Excel はパスワード付きでもそのままWorkbooks.Openに任せる(Excel の判定)。
暗号化されたファイルの判定(office_protection.ps1・office_protection_view.ps1)¶
直接読み(ZIP)が開けないファイルを Office で開く前に、ファイルを開かず(Office を使わず)先頭バイト列と、複合ドキュメント形式(CFB。[MS-CFB])のディレクトリのエントリ名だけで種類を見分ける。パスワード付き・IRM・秘密度ラベルの暗号化は、Office を起動するとダイアログ・サインイン画面が見えないまま出て止まりうるため、開く前に見分けて避ける。
判断層(scripts/shared/office/office_protection_view.ps1)が種類・文言を決め、状態層(scripts/shared/office/office_protection.ps1)がファイルの先頭バイト列(readFileHead)と CFB のディレクトリのエントリ名(readCompoundEntryNames)を読む。判断層はファイル・COM に触らないためテストが書ける(単体テスト(Officeまわり))。
| 種類 | 見分け方(開かずに) | 扱い | 取り込み一覧のエラー列 |
|---|---|---|---|
Zip |
先頭が ZIP のシグネチャ(PK 03 04) |
直接読む(今と同じ) | – |
Password |
CFB で StrongEncryptionDataSpace・EncryptionInfo のいずれかを持つ |
Word・PowerPointはOfficeを起動せずに失敗(Excel は今までどおり Workbooks.Open に任せる。既定のパスワードで暗号化されたブックを開けなくしないため) |
読み取りパスワードが設定されているため開けません(パスワード付きのファイルは取り込めません) |
Rights |
CFB で権限保護の名前(下表)のいずれかを持つ。または \x06DataSpaces(データスペース)はあるが、権限保護・パスワードの名前を1つも取りこぼした場合(安全側に倒す) |
Officeを起動せずに失敗(ライセンス取得・サインイン画面を防ぐ) | IRM・秘密度ラベルで暗号化されているため取り込めません。 |
Legacy |
CFB で、上のどれでもない(旧形式 .doc .xls .ppt、CFB のディレクトリが読めなかった壊れたファイルを含む) |
今と同じ(Officeで開く。ダミーのパスワードで失敗) | 今と同じ |
Text |
ZIPでもCFBでもなく、先頭4KBにNUL(0x00)を含まない(空・RTF・HTML・UTF-8・UTF-16のBOM付きを含む) |
今と同じ(Officeで開く) | – |
Unknown |
ZIPでもCFBでもなく、先頭4KBにNULを含む(透過暗号化の製品の暗号文の見込み) | 予備: アプリごとの切り替え(${officeFallbackEnabled})が有効なら、拡張子を変えずに(WordはFormatも拡張子に合わせて固定して)Officeに開かせる。無効・開けない・出力の確かめに失敗したら、Officeを使わず(または使ってしまった分は元の例外をログに書いて)失敗にする |
暗号化されているか壊れているため取り込めません。 |
権限保護(IRM・秘密度ラベル)の CFB のエントリ名([MS-OFFCRYPTO] の IRMDS):
| 形式 | 名前 |
|---|---|
| 新形式 | DRMEncryptedDataSpace・DRMEncryptedTransform(\x06DataSpaces の配下) |
| 旧形式 | \x09DRMContent(必須)・\x09DRMDataSpace・\x09DRMTransform(任意で \x09DRMViewerContent・\x09LZXDRMDataSpace・\x09LZXTransform) |
(\x06・\x09 は制御文字 0x06・0x09 で始まる名前を表す)
- CFBのディレクトリの読み取り(
readCompoundEntryNames)は、壊れたファイルでも例外を出さず、決まった時間で戻る。FATの鎖が輪になる・範囲外のセクターを指す・ディレクトリが途中で切れる、のいずれでも、たどった鎖を打ち切って読めた分だけを返す(読めなければ$null。判断層は$nullをLegacyとして扱う)。ミニFAT・ストリームの中身は読まない(エントリ名だけが目的のため)。 - Officeの出力も確かめる(
testOfficeOutput)。透過暗号化の製品が、Officeの保存した一時ファイル(変換した.docx・.pptx、Excel のテキスト保存)まで暗号化することがあるため、種類によらずすべての出力で先頭バイト列(ZIP・UTF-16のBOM)を確かめる。合わなければファイルを暗号化する製品が一時ファイルを暗号化したため取り込めません。にする。 - 予備で開くときの守り(
Unknownのときだけ。固まらない・暗号文を索引に入れない): - Word:
Documents.OpenのFormatを拡張子に合うWdOpenFormatの値に固定する(getWordOpenFormat。自動判定に任せると文字コードを選ぶダイアログが出ることがある)。 - Excel: 開いた後の
Workbook.FileFormatがテキスト・HTML・CSV等でないことを確かめる(testWorkbookFormat)。Text(中身がHTMLの.xls等)には当てない。 - PowerPoint: 拡張子を変えずに開く(
.pptに変えるとアウトラインとして読むため)。 - 実機で数秒以内に例外にならない・ダイアログが出るアプリは、
${officeFallbackEnabled}でそのアプリの予備を無効にする(Word・PowerPointの注意点・既知の問題)。 - 判定で失敗にしたときは、Officeの起動し直し(
stopApp)を呼ばない(throwProtectionFailureが例外のDataに印を付け、invokeIngestTaskがそれを見る)。IRM・パスワード付きのファイルが並んでも、そのたびにOfficeを起動し直さないため。Officeを一度使ってから失敗にしたとき(予備で開けた後に出力が合わない等)は、今までどおり起動し直す。 - Excel は、コピーが ZIP でないときにこの判定を呼ぶ(Excel の抽出処理)。読み取りのスレッド(Office を持たない)では、
Password・Rightsはその場で失敗にし、Unknown(予備が有効なとき)は今の旧形式と同じく Office の持ち主のワーカーに回し直す。
Word の旧形式の変換 Word の旧形式の変換(
extractWithWord) → Word の旧形式の変換PowerPoint の旧形式の変換 PowerPoint の旧形式の変換(
extractWithPowerPoint) → PowerPoint の旧形式の変換
Word・PowerPoint のテキスト読み取り(scripts/shared/office/office_reader.ps1)¶
.docx .pptx を ZIP として開き(System.IO.Compression)、XML を XmlReader で先頭から順に読む(readXmlLines)。Word(WordprocessingML、w:)と PowerPoint(DrawingML、a:)で同じ処理を使い、名前空間だけを切り替える。
ZIP の部品(エントリ)を読む readZipEntry は、展開後の大きさに部品 1 つにつき 100MB・1 ファイルの合計 300MB の上限を設け、超えたら簡潔な文言で例外にする(ヘッダーの大きさを偽って小さく見せた部品も検知する)。XmlDocument を作るところ(newXmlDocument)はすべて DTD(<!DOCTYPE>)の処理を禁止する。どちらも Office ファイルを開くときの設定 を参照。
| 要素 | 扱い |
|---|---|
段落(p) |
1 行。文字(t)を連結する。タブ・改行(tab br cr)はスペース、noBreakHyphen は - |
表の行(tr) |
1 行。セル(tc)をタブ区切りにし、行末の空セルは除く。セル内の複数段落はスペース区切り。入れ子の表は外側のセルの中でスペース区切り |
| テキストボックス | Word の本文($objects を渡したとき): 本文の行には入れず、段落をスペースでつないで図形 1 つとして集める(Word のテキスト読み取りと TSV の場所の ページNNN[図形])。ヘッダー・フッター・脚注: 中の段落をそれぞれ 1 行とする(アンカーの段落の前に出力される) |
| SmartArt・グラフ・コメントの参照 | $objects を渡したとき、dgm:relIds の r:dm・c:chart の r:id・w:commentReference の w:id をページ付きで集める(中身は呼び出し元がリレーションシップの先から読む) |
| 埋め込みオブジェクト | $collect のとき、w:objectEmbed・o:OLEObject(Type="Embed")・p:oleObj をページ(スライド)付きで集める。中の文字は呼び出し元が readEmbeddedObjectLines(office_embedded.ps1。Word)で読む |
互換用の代替表示(mc:Fallback) |
読まない(mc:Choice と同じ内容が重複するため) |
| 変更履歴 | 削除された文字(w:delText)と移動元(w:moveFrom)は読まない。挿入された文字は読む |
フィールドコード(w:instrText) |
読まない(表示される結果の文字は読む) |
- Word・PowerPoint の TSV は、空行を除いて 1 行 = 段落 1 つ、または表の 1 行(セルをタブ区切り)。
- どの XML をどの場所(TSV)として読むかは、Word のテキスト読み取りと TSV の場所(Word)・PowerPoint のテキスト読み取りと TSV の場所(PowerPoint)を参照。
Word のテキスト読み取りと TSV の場所 Word のテキスト読み取りと TSV の場所(
readDocxUnits) → Word のテキスト読み取りと TSV の場所PowerPoint のテキスト読み取りと TSV の場所 PowerPoint のテキスト読み取りと TSV の場所(
readPptxUnits) → PowerPoint のテキスト読み取りと TSV の場所Excel の図形・コメントの読み取り Excel の図形・コメントの読み取り(
readXlsxObjectUnits) → Excel の図形・コメントの読み取り
失敗の原因(describeIngestError)¶
取り込みに失敗したファイルは、取り込み一覧のエラー列に失敗の原因を記録する。画面の[インデックス管理]タブには、失敗したファイルと原因を一覧で表示する(インデックス一覧の管理)。
Office アプリの例外メッセージはそのままでは分かりにくい(パスワード付きのファイルでも「入力したパスワードが間違っています」と出る、作業領域のコピーのパスが出る、等)。そのため describeIngestError で、よくある原因を言い換えて 原因(詳細: 元のメッセージ) の形にする。
- メソッド呼び出しの例外(
"7" 個の引数を指定して "Open" を呼び出し中に例外が発生しました等)は、中の例外(GetBaseException())のメッセージを使う。 - スクリプト自身が
throwしたメッセージは、利用者向けに書いてあるためそのまま使う。 - 判定できない例外は、元のメッセージをそのまま使う(空ならエラーコードを表示する)。
| 判定 | 記録する原因 |
|---|---|
メッセージに パスワード / password を含む |
読み取りパスワードが設定されているため開けません(パスワード付きのファイルは取り込めません)(元のメッセージは誤解を招くため付けない) |
FileNotFoundException / DirectoryNotFoundException |
ファイルが見つかりません(取り込み中に移動・削除・名前変更された可能性があります) |
UnauthorizedAccessException、0x80070005 |
ファイルを読むアクセス権がありません |
PathTooLongException |
パスが長すぎるため読めません |
OutOfMemoryException |
シート・文書が大きすぎて取り込めません(メモリが不足しました)(整形(TSV 整形仕様)はシート 1 枚分を一度に読み込むため、テキストにして約 1GB を超えるシートで発生する) |
0x80070020 / 0x80070021(共有違反・ロック違反) |
ほかのアプリ・利用者がファイルを使用中のため読めません(ファイルを閉じてから再取り込みしてください) |
0x80040154 / 0x80080005 / 0x800401F3 |
Officeアプリ(Excel・Word・PowerPoint)を起動できませんでした(インストール・ライセンス認証の状態を確認してください) |
0x800706BA / 0x800706BE / 0x80010105 / 0x80010108 |
Officeアプリが異常終了したか、内部でエラーが発生しました(ファイルが壊れている、または大きすぎる可能性があります) |
0x80010001 / 0x8001010A |
Officeアプリが応答しませんでした(Officeアプリでダイアログを表示中などの可能性があります) |
InvalidDataException / XmlException、メッセージに ファイル形式 破損 壊れ 等を含む |
ファイルが壊れているか、拡張子と中身の形式が一致していません |
制限時間を超えた場合(インデックス作成のメインフロー)と、取り込み中に続けて強制終了した場合(取り込み一覧)は、それぞれ専用のメッセージを記録する。
記録・表示するメッセージの全文と対処は、エラーメッセージ一覧(エラーメッセージ一覧)にまとめる。
Office アプリ(Excel・Word・PowerPoint)の管理¶
stateDiagram-v2
state "停止" as Stopped
state "起動中(PID を保持)" as Running
state "利用者に渡した" as HandedOver
state "持ち続け(参照を放さず、後で試し直す)" as Kept
[*] --> Stopped
Stopped --> Running : getApp(最初に必要になったとき。COM 生成の前後のプロセス一覧の差分で PID を取得)
Running --> Running : ファイルを取り込む
Running --> Stopped : stopApp(Quit → Excel は 1 秒・Word/PowerPoint は 5 秒待ち → 残っていれば PID で Kill)
Running --> HandedOver : Excel・Word・PowerPoint に利用者のファイルが入った(1 ファイルの取り込みごとと stopApp で確かめる)
HandedOver --> [*] : Quit も Kill もせず、窓を出して利用者に渡す
Running --> Kept : 窓や設定を戻しきれない・Word で一覧を読めない
Kept --> HandedOver : retryKeptApps(waitKeptApps)で戻しきれた
Kept --> Stopped : 一覧を読み直して自分のファイルだけと分かった(Word。quitApp)
Kept --> [*] : スレッドの終わりで上限まで通らず、参照が切れる
Stopped --> Running : 次に必要になったとき
Stopped --> [*] : finally(正常終了・中止・続けられないエラー)
| 項目 | 仕様 |
|---|---|
| 起動 | getApp <名前> がアプリごとに 1 つの COM オブジェクトを保持し、最初に必要になったときに起動する。保持はスレッドごとで、Excel・Word・PowerPoint はそれぞれのアプリの持ち主のワーカー 1 つだけが起動する(Excel のスレッドは Excel だけ、Word のスレッドは Word だけ、PowerPoint のスレッドは PowerPoint だけを持つ。読み取りのスレッドは Office を起動しない)。インデックス作成が起動する Office は、種類ごとに最大 1 つである。スレッドの間で Office を分け合わないため、鍵は使わない(取り込みの並列化) |
| PID の取得 | COM 生成の前後でプロセス一覧(EXCEL / WINWORD / POWERPNT)を比べ、新しく増えた 1 つを自分が起動したプロセスとする。比較は自分のセッションのプロセスだけで行う(別の利用者・別の作業フォルダの tebunko など、ほかのセッションのプロセスを自分のものと取り違えない)。同じ種類の Office を起動するのはそのアプリの持ち主のワーカー 1 つだけのため、ほかのスレッドの起動と取り違えない。増えた 1 つの起動時刻(UTC の Ticks)も、止める前の照合に使うために一度だけ読んで控える(getOfficeStartTicks)。読めなければ控えず、記録も書かない(下の「起動時刻が読めないとき」) |
| 優先度 | 自分が起動した Office のプロセスも PriorityClass を変えない(Normal のまま)。利用者がダブルクリックしたファイルがインデックス作成の Excel・Word で開くことがあり、利用者とプロセスを共有しないと確実には言えない(スレッドの一覧)。PID・プロセス名・起動時刻を受け渡しの口の OfficePids に記録する(画面を閉じるときに止まらなければ、名前と起動時刻が合うものだけを止める。閉じるときの順番) |
| 利用者のアプリとの共用(Excel・Word) | 新しいプロセスが増えなかった場合は利用者のアプリとみなし、Quit() も強制終了もしない。PowerPoint は、そもそも利用者のアプリに接続しない(下の「PowerPoint」) |
| 利用者のファイルが入ったアプリ(Excel・Word・PowerPoint) | 窓の無いアプリに、利用者がダブルクリックしたファイルが入ることがある(入るのを防ぐ設定は使わない。スレッドの一覧)。1 ファイルを取り込むたびと stopApp の前に、作業用フォルダの外のファイルがあるかを確かめ(handOverForeignApp)、あれば Quit() も強制終了もせず利用者に渡す(handOverApp)。詳しくは下の「利用者のファイルが入ったアプリの扱い」 |
| 終了 | Quit() と ReleaseComObject の後、待ち時間(Excel は 1 秒、Word・PowerPoint は 5 秒)以内にプロセスが終了しなければ PID で強制終了する。待つ前と強制終了の前に、控えた名前・起動時刻と同じプロセスか照らす(isSameOfficeProcess)。起動時刻が違えば控えたプロセスはもう終わっているので、待たず止めずに終わったものとして扱う。Quit の直後に自分で終わっていれば、終わったものとして扱う。起動時刻が読めないときは、待たず止めない(下の「起動時刻が読めないとき」)。Excel の待ち時間が短いのは、抽出で取り出した COM オブジェクトが解放されきらず、インデクサが動いている間は Quit しても終わらない(長く待っても無駄になる)ため。GC.Collect() で解放を促して自分で終わらせる方法は、インデクサの終了が COM の解放待ちで約 60 秒止まることがある(実測 25 回中 1〜2 回)ため採らない。GC.WaitForPendingFinalizers() も同じ理由で使わない |
| 終了の失敗 | 終了処理中のプロセスへの Kill() は「アクセス拒否」になることがあるため無視する。1 つのアプリの終了に失敗しても残りのアプリは終了させる(stopAllApps)。強制終了しても待ち時間内に終わらなかったプロセスが残っていれば、記録(office_pids)に残し、次の起動の確認に任せる。PowerPoint(SingleInstance)は、さらに次の getApp が利用者のアプリとみなす(下の「PowerPoint」。安全な側に倒れる) |
| 制限時間の監視 | 監視のスレッドは 取り込みのワーカーごとに 1 つ(OfficeWatchdog の Start。読み取りのスレッドは持たない)。getApp / stopApp のたびに、そのスレッドが自分で起動したアプリの PID を監視スレッドに渡す(OfficeWatchdog の UpdateWatchedPids)。1 ファイルの制限時間を過ぎたら、監視スレッドがそれらを強制終了する(取り込み一覧)。ほかのワーカーのアプリは止めない。画面から中止を求められた(受け渡しの口の Stop。State.Cancel に口を渡してある)ときは、制限時間を待たず、同じ条件で自分が起動したアプリを止める。止めるものが実際にあったときだけ、State.Cancelled を立てる(利用者が使っているアプリだけで止めたものが無いときは立てない。制限時間の TimedOut とは別)。取り込みのスレッドは、Cancelled を見て、そのファイルを取り込まずに抜ける。PID が別のプロセスに再利用されている場合に備え、プロセス名が EXCEL / WINWORD / POWERPNT で、かつ控えた名前・起動時刻と同じ(isSameOfficeProcess)ときだけ終了させる。起動時刻が読めないときは止めない(quitApp・画面を閉じるときの KillOffice も同じ。下の「起動時刻が読めないとき」) |
| 利用者が使っている PowerPoint | 取り込み中に、利用者が PowerPoint にファイルを開く(インデックス作成が起動した PowerPoint に、利用者が窓を出して使い始める)ことがある。固まった PowerPoint の窓は、約 5 秒でゴースト窓に差し替わって見えなくなるため、制限時間を過ぎたときに窓を探しても見つからない。そこで監視のスレッドは、取り込み中は 500 ミリ秒ごとに、PowerPoint の PID の Process.MainWindowHandle を取り直して見る(testOfficeProcessHasWindow。COM も窓へのメッセージも使わないので、固まったプロセスにも戻る。窓の中身で探さず、PID だけを見る)。見えた窓があれば、その PID と起動時刻を「利用者が使った」印(OfficeWatchdog の State.Users、受け渡しの口の UserOfficePids)に残す。制限時間を過ぎたとき、印のあるプロセスは止めない(窓が消えていても止めない)。印は、ファイルを取り込み終えた境目(handOverForeignApp)で COM が利用者のファイルを 0 件と答えたとき(利用者が窓を開いて閉じた)、PID が見張りから外れたとき(UpdateWatchedPids・stopApp・untrackApp)と、同じ PID で起動時刻が違うとき(PID の使い回し)に消す。止めない代わりに、監視は取り込みのワーカーを諦めたと司令に伝える(ワーカーの状態 Abandoned)。司令は、そのワーカーで取り込み中だったファイルと、まだ渡していないファイルを、取り込まず、理由付きの失敗として見せる(一覧の状態は「未取り込み」のまま、理由はエラーの列。インデックスは変えない。取り込み一覧)。固まった呼び出しから戻らないスレッドは待たず(IngestDispatcher.Stop は止める依頼だけを出す)、戻ってきた結果は捨てる。戻ってきたスレッドも、書き出さず、アプリも終了させない。印が無い(窓を一度も見ていない)プロセスは、今までどおり制限時間で止める。司令のスレッドで取り込む形(-Workers 0)では諦めるワーカーが無く、止めないだけにする |
| 起動時刻が読めないとき | 起動時刻を読めなかった Office(アクセスが拒否されたなど)は、控えず、止める対象にしない。制限時間を過ぎても監視は止めず、COM の呼び出しが戻らなければ取り込みが進まない。画面を閉じるときの KillOffice でも止まらず、利用者がタスクマネージャーで止めることになる。起きるのはまれで、別のプロセスを止めてしまうより安全なため、この動きにしている |
| PowerPoint | PowerPoint は 1 つのセッションに 1 つのプロセスしか持てず、接続すると利用者の設定(DisplayAlerts・AutomationSecurity)まで書き換えてしまう。そのため getApp は、起動する前に自分のセッションに POWERPNT が無いかを確かめ、あれば COM を作らずに例外にする。起動した後(COM 生成の前後)に新しいプロセスが増えていなければ、設定を変える前に COM を解放して同じ例外にする。この例外を受けた司令(indexer_run.ps1)は、そのファイルを取り込まずに後回し(Postponed)にする(未取り込みのまま次回のインデックス作成に回す。取り込み一覧)。それ以外は他の Office と同じく、一度起動したら使い回し(旧形式の変換のたびに起動し直さない)、100 ファイルごと・取り込み失敗時・制限時間を過ぎたときに終了して次に必要になったときに起動し直す。インデックス作成が起動した PowerPoint は、そのスレッドが終わるときに終了する |
利用者のファイルを渡す前に残る隙間がある。1 ファイルの取り込みの途中に利用者のファイルが入ったときは、そのファイルの取り込みが終わるまで確かめない。隙間の長さは、最長で 1 ファイルの制限時間までである。その間に制限時間の監視の強制終了や、画面を閉じるときの OfficePids による終了が来ると、そのファイルも閉じる(この隙間をふさぐ対応は別に扱う。既知の問題)。また、渡した Excel は、利用者がブックを閉じたあとも窓の無いまま残ることがある。
利用者のファイルが入ったアプリの扱い¶
Excel(Workbooks)・Word(Documents)・PowerPoint(Presentations)で同じ流れを使う。アプリごとの違い(ファイルの一覧・自分のファイルの閉じ方・戻す設定)は、office_app.ps1 の $appInfo の表にある。
- 確かめ: ファイルの一覧(
Workbooks・Documents・Presentations)の中に、作業用フォルダの外のファイルがあるかを調べる。比較はGetFullPathで正規化した作業用フォルダの前方一致(大文字小文字を区別せず、末尾に\を付けてtmpとtmp2を取り違えない)で行い、~を含む短い名前はGet-Itemで長い名前にしてから比べる。読めない名前と、FullNameを正規化できないもの(URL・保存前のBook1など)は利用者のファイルと数える(データを失わない側に倒す)。確かめに使う一覧の参照は、数えたあとに放す。 - 一覧を読めないとき(COM が呼び出しを拒んだ。利用者が操作中のことがある): Excel・PowerPoint は、起動で控えた PID のプロセスに見える窓があれば、利用者が使っているとみなして渡す。無ければ従来どおり終了させる(窓を中身で探すことはしない)。Word は自分で窓を隠していて窓では分からないため、渡しも終了もさせず、持ち続けて後で一覧を読み直す(
keepUndecidedApp。空の窓を出さず、利用者のファイルも閉じない。持ち続けたことはログに 1 行書く)。持ち続けた Word は、retryKeptAppsが一覧を読み直し、利用者のファイルがあれば渡し、自分のファイルだけなら終了させ、まだ読めなければそのまま持ち続ける。 -
渡す処理(
restoreHandedOverApp。handOverAppとretryKeptAppsが呼ぶ):handOverAppが、監視の PID・受け渡しの口・起動の記録から外す(retryKeptAppsからの呼び出しでは外さない。外し済みのため)。そのうえで、次を順に行う。- 置き場の下と確かめられた自分の取り込み用のファイルだけを、保存せずに閉じる。1 つでも閉じられなければ、次回に一覧を取り直して閉じる(閉じたものは一覧から消えるので、二重には閉じない)。
- 必須の設定を、数回やり直しながら戻す。
- 任意の設定を戻す。
戻す設定はアプリごとに次のとおり。
getAppが変える設定は、この表にすべて入っている(テストで確かめる)。アプリ 必須 任意 Excel DisplayAlertsを真に戻す・VisibleとUserControlを真にして窓を出すEnableEvents・ScreenUpdating・AskToUpdateLinks・マクロ無効の解除Word DisplayAlertsをwdAlertsAll(-1)に戻す・Visibleを真にして窓を出すマクロ無効の解除 PowerPoint DisplayAlertsをppAlertsAll(2)に戻す(窓は、利用者のファイルが開いた時点で見えているため触らない)マクロ無効の解除 - 渡したとみなす条件: 上の全部が通ったときだけ。通らなければ COM の参照を放さずに持ち続け( Quit()も強制終了もしない)、ログには窓や設定を戻しきれなかったことを書く。済んだ設定は控えるので、やり直しは済んでいないものだけを行う。- 持ち続けたアプリの仕上げ直し: - 次のファイルの確かめと一括終了( stopAllApps)のたびに、retryKeptAppsが仕上げ直す(待たない)。全部通れば参照を放して、渡したことをログに書く。- 控えた PID のプロセス(名前が EXCEL・WINWORD・POWERPNT)がもう無ければ、利用者が先に終えたので、参照だけ放して一覧から外す(PID と名前だけを見る。窓は探さず、プロセスは止めない)。- 取り込みのスレッドの終わり(司令のスレッドで取り込むときはその終わり)に限り、持ち続けがあるときだけ、 waitKeptAppsが間を置いて、経過時間で 30 秒(定数officeKeptWaitSeconds)まで仕上げ直す。持ち続けが無ければ待たない。100 件ごとの起動し直しでは待たない。中止・画面を閉じる合図が来たら、次の刻みで抜ける。- 残りうるもの: 上限まで通らなかったもの、または待たずに抜けたもの(中止したとき・画面を閉じたとき)は、そのまま持ち続け、スレッドが終わると参照が切れる。そのとき残りうるのは、 DisplayAlertsが偽のまま(利用者がブックを閉じるときの保存の確認が出ない)、任意の設定が戻らないまま、自分の一時コピーが閉じられないまま、窓が出ないまま、である。窓も操作する人もいなければ、そのアプリは終わることがある。一覧を読めないまま持ち続けた Word も、スレッドが終わると参照が切れ、窓の無い Word が残りうる。持ち続けたアプリが、閉じ損ねた自分の一時コピーを開いたままのときは、同じワーカーの次のファイルの取り込みの最初の作業フォルダの片付け(clearTmpDir)が失敗し、そのファイルは取り込みの失敗として記録される(次の更新で取り込み直す)。- 渡したあと: 次のファイルからは新しいアプリを起動する(PowerPoint は、渡した PowerPoint が残っているため起動せず、残りの PowerPoint のファイルを取り込まず、失敗として理由を見せる。上の「PowerPoint」)。渡したこと(と、一覧を読めずに持ち続けたこと)は、1 ファイルの取り込みの中で起きたときはインデックス作成のログに 1 行残す(取り込みのスレッドが終わるときと起動し直しの一括終了で渡した分は、ログに出る場所が無いため残らない)。
Word の起動・終了¶
Word では、利用者が同じアプリで作業していることがあるため、次の場合は終了させない(PowerPoint は利用者のアプリに接続しないため、この状態にならない。上の「PowerPoint」)。
| 場合 | 仕様 |
|---|---|
| 起動中のアプリに接続された | COM 生成の前後で新しいプロセスが増えなかった場合は利用者のアプリとみなし、Quit() も強制終了もしない |
| インデックス作成中に利用者がファイルを開いた | 作業用フォルダの外の文書があれば、利用者に渡す(上の「利用者のファイルが入ったアプリの扱い」)。自分の文書だけなら、今までどおり終了させる |