DSpace システム説明書: バージョンアップ

この章では、DSpaceのバージョンアップの方法について説明します。各バージョンの機能の違いについてはバージョン履歴の章で説明します。

1.2.x から 1.3.x へのバージョンアップ

以下では、[dspace] は既存のDSpaceインストールディレクトリを、[dspace-1.3.x-source] はDSpace 1.3.xのソースディレクトリを表します。これらのパス参照が現れた場合は、各自のシステムにおける実際のパス名に置き換えてください。

作業を進める前にまず最初にすることは、もちろん、全てのデータのバックアップである。バックアップするものは、[dspace]配下の全コンテンツとPostgreSQLデータベースである。
新しいDSpace 1.3.x のソースコードをSourceForgeのDSpaceページからダウンロードし、適当な場所で解凍する。ただし、既存のインストールディレクト上に解凍してはならない。
PostgreSQLドライバのJARファイルをソースツリーにコピーする。たとえば、次の通り。

cd [dspace]/lib

cp postgresql.jar [dspace-1.2.2-source]/lib

（訳注：cp postgresql.jar [dspace-1.3.x-source]/lib の間違いだと思われる）
Tomcat（あるいは、使用しているサーブレットコンテナ）を停止する。
間違って使用しないように、古いバージョンのxerces.jarをインストールディレクトリから削除する。

rm [dspace]/lib/xerces.jar
dstat.cfg と dstat.mapを[dspace-1.3.x-source]/config/ から [dspace]/config へ移動することにより、新しい設定ファイルをインストールする。

[dspace]/dspace.cfgに以下の新しいパラメタを追加する必要がある。

###### Statistical Report Configuration Settings ######

# should the stats be publicly available?  should be set to false if you only （訳注: 統計を一般に公開するか? 統計へのアクセスを管理者に制限する場合や
# want administrators to access the stats, or you do not intend to generate           統計を作成しない場合は、false を設定する）
# any
report.public = false

# directory where live reports are stored   （訳注: レポートを格納するディレクトリ）
report.dir = /dspace/reports/

アップデートされたDSpace 1.3.xプログラムをビルドしてインストールする。[dspace-1.3.x-source] ディレクトリに移動し、次のコマンドを実行する。

ant -Dconfig=[dspace]/config/dspace.cfg update
PostgreSQLデータベースのデータベーススキーマを若干変更する必要がある。[dspace-1.3.x-source]/etc/database_schema_12-13.sqlにこれを行うためのSQLコマンドがある。独自にスキーマを変更している場合は、このファイルをチェックして、変更を加える必要があるかもしれない。

変更を適用するには、ソースディレクトリに移動し、次のコマンドを実行する。

psql -f etc/database_schema_12-13.sql [DSpaceデータベース名] -h localhost
システム統計レポートの設定に従って、統計用の設定ファイルをカスタマイズする。
以下のコマンドを実行して、統計を初期化する。

[dspace]/bin/stat-initial

[dspace]/bin/stat-general

[dspace]/bin/stat-report-initial

[dspace]/bin/stat-report-general
検索インデックスを再構築する。

[dspace]/bin/index-all
[dspace-1.3.x-source]/build に作成された.war Webアプリケーションファイルをサーブレットコンテナ（Tomcatなど）のwebappsディレクトリにコピーする。たとえば、次の通り。

cp [dspace-1.3.x-source]/build/*.war [tomcat]/webapps
Tomcatをリスタートする。

1.2.1 から 1.2.2 へのバージョンアップ

1.2.2 における変更はプログラムと設定の変更だけですので、バージョンアップはきわめて簡単です。

以下では、[dspace] は既存のDSpaceインストールディレクトリを、[dspace-1.2.2-source] はDSpace 1.2.2のソースディレクトリを表します。これらのパス参照が現れた場合は、各自のシステムにおける実際のパス名に置き換えてください。

新しいDSpace 1.2.2 のソースコードをSourceForgeのDSpaceページからダウンロードし、適当な場所で解凍する。ただし、既存のインストールディレクト上に解凍してはならない。
PostgreSQLドライバのJARファイルをソースツリーにコピーする。たとえば、次の通り。
```
cd [dspace]/lib
cp postgresql.jar [dspace-1.2.2-source]/lib
```
Tomcat（あるいは、使用しているサーブレットコンテナ）を停止する。
（jsp/localにある）「ローカライズした」JPSファイルは、今後ソースディレクトリで管理しなければならない。[dspace]/jsp/local にローカライズしたJPSファイルがある場合、新バージョン1.2.2での変更をローカライズしたJPSファイルに反映したいと思うだろう。これを行うために、diffコマンドを使って、バージョン1.2.1と1.2.2を比較することができる。また、変更されたJSPのリストについてはバージョン履歴を参考のこと。

新しいパラメタ（フルテキストのインデックス作成用の設定）を[dspace]/dspace.cfg に追加する必要がある。

##### Fulltext Indexing settings #####
# Maximum number of terms indexed for a single field in Lucene.            （訳注: 1フィールドあたりのインデックス作成対象の最大語数。
# Default is 10,000 words - often not enough for full-text indexing.               デフォルトは10,000語だが、フルテキストのインデックスには十分出ない場合が多い。
# If you change this, you'll need to re-index for the change                       このパラメタを変更した場合は、全てのアイテムに変更を反映するためにインデックスを
# to take effect on previously added items.                                        再作成する必要がある。
# -1 = unlimited (Integer.MAX_VALUE)                                               -1を指定すると無制限（実際は、Integer.MAX_VALUE 値）となる。
search.maxfieldlength = 10000

[dspace-1.2.2-source] で次のコマンドを実行する。
```
ant -Dconfig=[dspace]/config/dspace.cfg update
```
[dspace-1.2.2-source]/build に作成された .warWebアプリケーションファイルをサーブレットコンテナ（Tomcatなど）のwebappsディレクトリにコピーする。たとえば、次の通り。
```
cp [dspace-1.2.2-source]/build/*.war [tomcat]/webapps
```
Tomcatを使用している場合は、古い.warファイルに該当するディレクトリを削除する必要がある。たとえば、dspace.war が [tomcat]/webapps/dspace.war にインストールされている場合は、[tomcat]/webapps/dspaceディレクトリを削除する。そうしないと、Tomcatはこのディレクトリにある古いプログラムを使用し続けることになる。
最後に、新しく導入された設定可能な投稿フォームをインストールするために、[dspace-1.2.2-source]/config/input-forms.xmlファイルを [dspace]/config にコピーする。
Tomcatをリスタートする。

1.2 から 1.2.1へのバージョンアップ

1.2.1 における変更はプログラムの変更だけですので、バージョンアップはきわめて簡単です。

以下では、[dspace] は既存のDSpaceインストールディレクトリを、[dspace-1.2.1-source] はDSpace 1.2.1のソースディレクトリを表します。これらのパス参照が現れた場合は、各自のシステムにおける実際のパス名に置き換えてください。

新しいDSpace 1.2.1 のソースコードをSourceForgeのDSpaceページからダウンロードし、適当な場所で解凍する。ただし、既存のインストールディレクト上に解凍してはならない。
PostgreSQLドライバのJARファイルをソースツリーにコピーする。たとえば、次の通り。
```
cd [dspace]/lib
cp postgresql.jar [dspace-1.2.1-source]/lib
```
Tomcat（あるいは、使用しているサーブレットコンテナ）を停止する。
（jsp/localにある）「ローカライズした」JPSファイルは、今後ソースディレクトリで管理しなければならない。[dspace]/jsp/local にローカライズしたJPSファイルがある場合、新バージョン1.2.1での変更をローカライズしたJPSファイルに反映したいと思うだろう。これを行うために、diffコマンドを使ってバージョン1.2と1.2.1を比較することができる。また、変更されたJSPのリストについてはバージョン履歴を参考のこと。

新しいパラメタ（ブラウズ/検索結果画面およびアイテム表示画面へのサムネイルの表示、および、インデックスを作成するDCメタデータフィールドの設定）を [dspace]/dspace.cfg に追加する必要がある。

# whether to display thumbnails on browse and search results pages (1.2+)       （訳注: ブラウズ/検索結果画面にサムネイルを表示するか?（1.2以降））
webui.browse.thumbnail.show = false

# max dimensions of the browse/search thumbs. Must be <= thumbnail.maxwidth     （訳注: ブラウズ/検索結果用サムネイルの大きさ。thumbnail.maxwidthおよび
# and thumbnail.maxheight. Only need to be set if required to be smaller than           thumbnail.maxheidht以下でなければならない。メディアフィルターで
# dimension of thumbnails generated by mediafilter (1.2+)                               作成されるサムネイルより小さいものが必要な場合のみ指定する（1.2以降））
#webui.browse.thumbnail.maxheight = 80
#webui.browse.thumbnail.maxwidth = 80

# whether to display the thumb against each bitstream (1.2+)                    （訳注: 各ビットストリームにサムネイルを表示するか?（1.2以降））
webui.item.thumbnail.show = true

# where should clicking on a thumbnail from browse/search take the user         （訳注: ブラウズ/検索結果画面のサムネイルをクリックした場合のリンク先
# Only values currently supported are "item" and "bitstream"                            現在指定できる値は、"item"と"bitstream"のみ。
#webui.browse.thumbnail.linkbehaviour = item


 ##### Fields to Index for Search #####

# DC metadata elements.qualifiers to be indexed for search                      （訳注: 検索用のインデックスを作成するDCメタデータ要素.限定子
# format: - search.index.[number] = [search field]:element.qualifier                    指定形式: search.index.[数字] = [検索フィールド]:要素.限定子
#         - * used as wildcard                                                                    * をワイルドカードとして使用できる

###      changing these will change your search results,     ###                        これを変更すると検索結果は変更されるが、
###  but will NOT automatically change your search displays  ###                        検索の表示画面は自動的には変更されない。）

search.index.1 = author:contributor.*
search.index.2 = author:creator.*
search.index.3 = title:title.*
search.index.4 = keyword:subject.*
search.index.5 = abstract:description.abstract
search.index.6 = author:description.statementofresponsibility
search.index.7 = series:relation.ispartofseries
search.index.8 = abstract:description.tableofcontents
search.index.9 = mime:format.mimetype
search.index.10 = sponsor:description.sponsorship
search.index.11 = id:identifier.*

[dspace-1.2.1-source] で次のコマンドを実行する。
```
ant -Dconfig=[dspace]/config/dspace.cfg update
```
[dspace-1.2.1-source]/build に作成された .war Webアプリケーションファイルをサーブレットコンテナ（Tomcatなど）のwebappsディレクトリにコピーする。たとえば、次の通り。
```
cp [dspace-1.2.1-source]/build/*.war [tomcat]/webapps
```
Tomcatを使用している場合は、古い.warファイルに該当するディレクトリを削除する必要がある。たとえば、dspace.war が [tomcat]/webapps/dspace.war にインストールされている場合は、[tomcat]/webapps/dspaceディレクトリを削除する。そうしないと、Tomcatはこのディレクトリにある古いプログラムを使用し続けることになる。
Tomcatをリスタートする。

1.1（あるいは、1.1.1）から 1.2へのバージョンアップ

1.1あるいは1.1.1から1.2へのバージョンアップの方法は同じです。DSpace 1.0あるいは1.0.1を使用している場合は、以下を実行する前に1.0.1から1.1へのバージョンアップを実行する必要があります。

DSpaceに大きな変更を加えている場合は、まず、変更前のDSpace 1.1.1に以下の方法を適用し、その後に再度独自に行った変更を適用する必要があることに注意してください。

以下では、既存のDSpaceインストールディレクトリを [dspace] で、DSpace 1.2のソースディレクトリを [dspace-1.2-source] で表します。これらのパス参照が現れた場合は、各自のシステムにおける実際のパス名に置き換えてください。

作業を進める前にまず最初にすることは、もちろん、全てのデータのバックアップである。バックアップするものは、[dspace] 配下の全コンテンツとPostgreSQLデータベースである。
新しいDSpace 1.2 のソースコードをSourceForgeのDSpaceページからダウンロードし、適当な場所で解凍する。ただし、既存のインストールディレクト上に解凍してはならない。
ソースツリーに含めることができなかった必須のJavaライブラリをコピーする。たとえば、次の通り。
```
cd [dspace]/lib
cp activation.jar servlet.jar mail.jar [dspace-1.2-source]/lib
```
Tomcat（あるいは、使用しているサーブレットコンテナ）を停止する。
この機会にDSpaceで使用しているサードパーティ製のツールをバージョンアップすると良いだろう。
- Java （バージョン1.4.0以降が必要であることに注意）
- Tomcat （バージョン4.0以降のいずれのバージョンでも動く。シンボリックリンクはもはや問題ではない）
- PostgreSQL （最新のJDBCドライバの.jarファイルのビルド/ダウンロードを忘れないこと。また、まず最初に、データベースをバックアップすることも忘れないこと）
- Ant
以下の新しいパラメタを [dspace]/dspace.cfg に追加する必要がある。
```
##### Media Filter settings #####
# maximum width and height of generated thumbnails          （訳注: 作成するサムネイルの最大幅と最大高）
thumbnail.maxwidth  80
thumbnail.maxheight 80
```
さらに、オプションのパラメタ（データベースのコネクションプールの制御用）が1、2存在する。詳細についてはバージョン履歴を参照のこと。これらのパラメタを省略した場合は、デフォルト値が使用される。

また、今後の混乱を避けるために、もはや必要なくなった次のプロパティを削除した方が良いだろう。
```
config.template.oai-web.xml = [dspace]/oai/WEB-INF/web.xml
```
インストールディレクトリのレイアウト（すなわち、[dspace] の内容の構成）が1.1.1から若干変更された。まず、（jsp/localにある）「ローカライズした」JPSファイルを今後はソースディレクトリで管理しなければならなくなった。だから、今すぐそれらをコピーすること。

コピーが終わったら、[dspace]/jsp と [dspace]/oaiは、もはや使用されないので削除しても良い（.war Webアプリケーションアーカイブファイルが代わりに使用される）。

また、以前と同じバージョンのTomcatを使用している場合は、Tomcatの conf/server ファイルからDSpaceにシンボリックリンクの使用を許可する行を削除する必要がある。これは、DSpace 1.1.1を稼動させるために追加した<Context>要素であり、次のような行である。
```
<Context path="/dspace" docBase="dspace" debug="0" reloadable="true" crossContext="true">
  <Resources className="org.apache.naming.resources.FileDirContext" allowLinking="true" />
</Context>
```
Web UI用とOAI Webアプリケーション用の2つの <Context>要素を忘れずに削除すること。
アップデートされたDSpace 1.2プログラムをビルドしてインストールする。DSpace 1.2ソースディレクトリに移動し、次のコマンドを実行する。
```
ant -Dconfig=[dspace]/config/dspace.cfg update
```
configディレクトリにある新しいconfigファイルをインストールディレクトリにコピーする。たとえば、次の通り。
```
cp [dspace-1.2-source]/config/news-* [dspace-1.2-source]/config/mediafilter.cfg [dspace-1.2-source]/config/dc2mods.cfg [dspace]/config
```
PostgreSQLデータベースのデータベーススキーマを若干変更する必要がある。[dspace-1.2-source]/etc/database_schema_11-12.sql にこれを行うためのSQLコマンドがある。独自にスキーマを変更している場合は、このファイルをチェックして、変更を加える必要があるかもしれない。

変更を適用するには、ソースディレクトリに移動し、次のコマンドを実行する。
```
psql -f etc/database_schema_11-12.sql [DSpace database name] -h localhost
```
次に、DSpace 1.2で提供されているツールを使ってリレーショナルデータベースにある実際のデータを更新する。次のように実行する。
```
[dspace]/bin/dsrun org.dspace.administer.Upgrade11To12
```
続いて、検索インデックスを再構築する。
```
[dspace]/bin/index-all
```
サーブレットコンテナ（Tomcatなど）のwebappディレクトリにあるシンボリックリンクを削除する。

[dspace-1.2-source]/build に作成された .war Webアプリケーションファイルをサーブレットコンテナ（Tomcatなど）のwebappsディレクトリにコピーする。たとえば、次の通り
```
cp [dspace-1.2-source]/build/*.war [tomcat]/webapps
```
Tomcatをリスタートする。
画像サムネイルの作成とインデックス作成用のフルテキストの抽出を自動的に行うために、"cron" ジョブを設定する必要がある。たとえば、次のように設定する。
```
# Run the media filter at 02:00 every day    （訳注: 毎日02:00にメディアフィルターを実行）
0 2 * * * [dspace]/bin/filter-media
```
既にシステムに存在するコンテンツのサムネイルの作成とフルテキストのインデックス作成を今すぐ実行しても良いだろう。
注 1: このバージョンアッププロセスにおいて、事実上全てのアイテムが"touch"される（タイムスタンプが更新される）。その結果、ダブリンコアメタデータにおける日付（受入日など）は変更されないが、各アイテムのデータベース上の「最終更新」日は変更されることになる。

これにより、e-mail購読ツールに混乱が生じるかもしれない。アーカイブの全てのアイテムがその日にデポジットされたと判断して、多くの購読者に長いメールを送ることになるからである。したがって、DSpaceのcronジョブの該当する行をコメントアウトすることによりその日のe-mail購読機能を止め、翌日に再稼動させることを推奨する。

たとえば、バージョンアップを 2004年6月8日（UTC）に行い、e-mail購読のcronジョブが午前4時（UTC）に実行されるとする。購読ツールが2004年6月9日の午前4時に実行されると、システムの全てが2004年6月8日に変更されたことを発見して、巨大なメールを送信することになる。したがって、バージョンアップしたら直ちにDSpaceの"crontab"を編集して/dspace/bin/subs-dailyの行をコメントアウトする。そして、2004年6月9日の午前4時が過ぎてから「コメントをはずす」。そうすれば問題は生じない。

もちろんこれは、2004年6月8日に本当に新規デポジットされたアイテムについても通知されないことを意味する。しかし、システムのバージョンアップをしていれば、その間システムは動いていないだろうだから、これは大きな問題にはならないはずである。
注 2:OAIコミュニティとの協議を経て、OAI-PMH機能には様々な変更がなされた。
- OAI-PMH識別子が変更された（単なるハンドルではなく、oai:hostname:handleという形になった）
- 新しいサブコミュニティ機能により、セットの構造が変更された
- デフォルトのベースURLが変更された
- 注1で述べたように、全てのアイテムが"touch"されたので、再ハーベスティングが必要になる
これは、もしあなたのリポジトリが既に登録され、ハーベストされていたら、事実上「新しい」OAI-PMHデータリポジトリとして、リポジトリを再登録する必要があることを意味する。また、ハーベスタにシステムの更新を知らせるために、OAI実装者メーリングリストにアナウンスすることを検討すべきである。

さらに、その後数日間、あなたのサイトは非常に多くのOAI-PMHハーベスタからアクセスを受ける可能性があることに注意が必要である。resumption tokenのサポートがこの負担を幾分かは軽減するはずであるが、[dspace]/config/dspace.cfg でデータベースコネクションプール数を一時的に上げると良いだろう。このパラメタの意味と使い方については、ソースコードと一緒に配布されているdspace.cfgを参照のこと（なお、このパラメタを変更した後は、Tomcatを止め、リスタートする必要がある）。

これが理想の方法でないことは理解している。その理由についてはOAIコミュニティへ投稿した以下の関連ポストを参照してほしい: ポスト1、ポスト2、dspace-techメーリングリストへのポスト。

このようなベースURLの変更が本当にできない場合は、次のようにすることにより実に簡単に、おおよそそのまま使うことができます。
- org.dspace.app.oai.DSpaceOAICatalogクラスの最初にあるOAI_ID_PREFIXの値をhdl:に変更する
- OAIHandlerサーブレットのサーブレットマッピングを（/request）から）/に戻す。
- dspace-oai.warをリビルドし、再配備する
しかし、この場合にしても全てのレコードがハーベスタにより再ハーベストされるので、関連するデータベースはそのための対応をしておく必要がある。また、セットの仕様変更に気がつかないハーベスタもいるので注意が必要である。変更の理由を理解するために、上で示したメーリングリストのポストを読むことを勧める。

以上で、バージョンアップ作業は完了です。

1.1 から 1.1.1へのバージョンアップ

幸いなことに1.1.1 における変更はプログラムの変更だけですので、バージョンアップはきわめて簡単です。

以下では、[dspace] は既存のDSpaceインストールディレクトリを、[dspace-1.1.1-source] はDSpace 1.1.1のソースディレクトリを表します。これらのパス参照が現れた場合は、各自のシステムにおける実際のパス名に置き換えてください。

Tomcatを停止する。
この機会にDSpaceで使用しているサードパーティ製のツール（PostgreSQLなど）を、該当するツールの指示にしたがって、バージョンアップすると良いだろう。
[dspace-1.1.1-source] で次のコマンドを実行する。
```
ant -Dconfig=[dspace]/config/dspace.cfg update
```
[dspace]/jsp/localディレクトリにある以下のJSPファイルをローカルで変更した場合は、新バージョン1.1.1での変更をローカライズしたJPSファイルに反映したいと思うだろう。これを行うために、diffコマンドを使ってバージョン1.1と1.1.１の比較を行うことができる。変更はきわめて小さなものである。
```
collection-home.jsp
admin/authorize-collection-edit.jsp
admin/authorize-community-edit.jsp
admin/authorize-item-edit.jsp
admin/eperson-edit.jsp
```
Tomcatをリスタートする。

DSpace 1.0.1から1.1へのバージョンアップの手順は以下のとおりです。dspace.cfg を変更する必要はありません。以下では、既存のDSpaceのインストールディレクトリを [dspace]で、DSpace 1.1のソースディレクトリを[dspace-1.1-source]で表します。これらのパス参照が現れた場合は、各自のシステムにおける実際のパス名に置き換えてください。

Tomcat（あるいは、使用しているサーブレットコンテナ）を停止する。
PostgreSQLを最新版（7.3.2）にバージョンアップすることを推奨する。 PostgreSQLのバージョンアップについてのメモがここにある。このメモを実行するにはAntをバージョン1.5にする必要があることにも注意すること。

DSpaceデータベースに必要な変更を加える。若干のスキーマ変更と、パフォーマンス向上のためのインデックスの追加などである。また、多くのデータベースビューの名前を変更している。これまでの名前は長すぎて問題を引き起こしていたからである。まず、psqlコマンドでデータベースに接続する（たとえば、psql -U dspace -W と入力後に、パスワードを入力する）。そして、以下のSQLコマンドを実行する。

ALTER TABLE bitstream ADD store_number INTEGER;
UPDATE bitstream SET store_number = 0;

ALTER TABLE item ADD last_modified TIMESTAMP;
CREATE INDEX last_modified_idx ON Item（last_modified）;

CREATE INDEX eperson_email_idx ON EPerson（email）;
CREATE INDEX item2bundle_item_idx on Item2Bundle（item_id）;
REATE INDEX bundle2bitstream_bundle_idx ON Bundle2Bitstream（bundle_id）;
CREATE INDEX dcvalue_item_idx on DCValue（item_id）;
CREATE INDEX collection2item_collection_idx ON Collection2Item（collection_id）;
CREATE INDEX resourcepolicy_type_id_idx ON ResourcePolicy（resource_type_id,resource_id）;
CREATE INDEX epersongroup2eperson_group_idx on EPersonGroup2EPerson（eperson_group_id）;
CREATE INDEX handle_handle_idx ON Handle（handle）;
CREATE INDEX sort_author_idx on ItemsByAuthor（sort_author）;
CREATE INDEX sort_title_idx on ItemsByTitle（sort_title）;
CREATE INDEX date_issued_idx on ItemsByDate（date_issued）;

DROP VIEW CollectionItemsByDateAccessioned;

DROP VIEW CommunityItemsByDateAccessioned;
CREATE VIEW CommunityItemsByDateAccession as SELECT Community2Item.community_id, ItemsByDateAccessioned.*  FROM ItemsByDateAccessioned, Community2Item WHERE ItemsByDateAccessioned.item_id = Community2Item.item_id;
CREATE VIEW CollectionItemsByDateAccession AS SELECT collection2item.collection_id, itemsbydateaccessioned.items_by_date_accessioned_id, itemsbydateaccessioned.item_id, itemsbydateaccessioned.date_accessioned FROM itemsbydateaccessioned, collection2item WHERE（itemsbydateaccessioned.item_id = collection2item.item_id）;