001/* 002 * Copyright (c) 2009 The openGion Project. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 013 * either express or implied. See the License for the specific language 014 * governing permissions and limitations under the License. 015 */ 016package org.opengion.fukurou.util; 017 018import java.awt.Rectangle; 019import java.awt.Robot; 020import java.awt.image.BufferedImage; 021import java.awt.AWTException; 022import javax.imageio.ImageIO; 023 024import java.awt.Toolkit; 025import java.awt.datatransfer.Clipboard; 026import java.awt.datatransfer.DataFlavor; 027import java.awt.datatransfer.StringSelection; 028import java.awt.datatransfer.FlavorListener; 029import java.awt.datatransfer.FlavorEvent; 030import java.awt.datatransfer.UnsupportedFlavorException; 031import java.io.IOException; 032import java.io.File; 033 034/** 035 * DisplayCapture.java は、画面イメージをキャプチャして、ファイルに書き出すためのクラスです。 036 * 037 * 基本的な使い方は、main メソッドから立ち上げて、クリップボードの状態を監視します。 038 * クリップボードに、"GUI:画面ID xxxxx.jsp" 形式の文字が書き込まれると、flavorsChanged イベントが 039 * 発生して、画面を、ファイルに書き出す処理が実行されます。 040 * エンジンの機能と連動すれば、画面IDやファイル名をクリップボード経由でこのアプリケーションに 041 * 渡すことで、画面操作を行うだけで、自動的に画面キャプチャを行うことが可能です。 042 * 043 * エンジンでは、jsp/indexc.jsp に、この機能が組み込まれているため、gf\BAT\displayCapture の 044 * DisplayCapture.bat を起動後、アプリケーションを、jsp/indexc.jsp で呼び出せば、自動的に 045 * 画面のキャプチャを開始できます。 046 * キャプチャは、全画面のみですので、IEを最大に広げて操作してください。 047 * また、「Prnt Scrn」ボタンにも対応していますので、操作中やポップアップ等の非自動化の 048 * 画面キャプチャも、手動で取得できます。 049 * 050 * 起動時の引数に応じて、処理を制御することが可能です。 051 * 052 * 書き出すフォルダは、BASE_DIR で指定します。 053 * すべてのキャプチャ画像は、ベースフォルダ に集約して保存します。 054 * キャプチャ画像の情報は、出力されるファイル名に反映されます。ファイル名の形式も2種類あり、 055 * キャプチャ順と、画面ID順が指定できます。 056 * 初期値は、Java起動時のフォルダになります。 057 * 058 * 書き出すファイル名の初期形式は、firstID の設定により異なります。 059 * firstID を gui に設定した場合 060 * ベースフォルダでフォルダを作成し、その中に、画面ID_JSPファイル名_連番.画像形式 ファイルを作成します。 061 * 画面ID 単位に、画面のキャプチャを整理、使用したい場合に便利です。 062 * ファイルのタイムスタンプ(作成時刻)で並び替えを行えば、キャプチャ順に並び替えできます。 063 * firstID を seq に設定した場合 064 * ベースフォルダでフォルダを作成し、その中に、連番_画面ID_JSPファイル名.画像形式 ファイルを作成します。 065 * ファイルは、キャプチャされた順番に、画面IDも混在して作成されます。つまり、ファイル名の順番に 066 * 再生すれば、リンクや他のシステムとの連携などで、画面が行き来しても、作業の順番にキャプチャできて 067 * いる事になります。 068 * 069 * このクラスは、これらを実現するために利用している、static メソッドをいくつか持っています。 070 * BufferedImage doCapture() 071 * 画面イメージをキャプチャします。これは、全画面です。 072 * void saveImage( File saveFile, BufferedImage img, String imgType ) 073 * 指定のファイルに、画面イメージを書き出します。 074 * imgType に、画像の種類(png|gif|jpg)を指定します(初期値:png)。 075 * String getClipboard() 076 * 現在のクリップボードの値を取り出します。ここでは、文字列のみ取り出すことが可能です。 077 * このメソッドの特徴的なところは、PrintScreenなどの文字列以外の値をクリップボードにセット 078 * した場合に、"GUI:PRINT SCREEN.img" という文字列を返すところです。つまり、その場合は、 079 * 全画面のキャプチャが行われるという事です。 080 * void setClipboard( String txt ) 081 * クリップボードに、文字列をセットします。 082 * 083 * このクラスが実装している FlavorListener は、クリップボードの"値"の更新には追従していません。 084 * 内部の Transferable オブジェクトが変更された場合に、flavorsChanged メソッドが呼び出されます。 085 * つまり、一度セットされた文字型データは、取り出した後、別のTransferable オブジェクトに変更して 086 * おかないと、次の文字列の変更が拾えなくなります。また、この別のTransferableオブジェクトの 087 * 設定で、再び、イベントが発生するので、そのままでは、無限ループになってしまいます。 088 * そこで、少し、トリッキーなのですが、setClipboard( String ) すると、再びイベントが呼び出され 089 * ないように、取得した文字列の先頭が、"GUI:" で始まる場合のみ、再設定するようにしています。 090 * 091 * Usage: java org.opengion.fukurou.util.DisplayCapture 092 * [BASE_DIR] [firstID(seq|gui)] [imageFormat(png|gif|jpg)] [startCnt(100)] 093 * 094 * args[0] BASE_DIR : キャプチャファイルをセーブするベースとなるディレクトリ(初期値:起動フォルダ) 095 * args[1] firstID : キャプチャ画像をセーブするファイル方式を指定します(初期値:seq) 096 * gui (画面ID_JSPファイル名_連番.画像形式) 097 * seq (連番_画面ID_JSPファイル名.画像形式) 098 * args[2] imageFormat : 作成するイメージの形式。png|gif|jpg のどれか(初期値:png) 099 * args[3] startCnt : セーブファイル名をユニークにするためのカウント(初期値:100) 100 * 101 * この実装は同期化されません。 102 * 103 * @og.rev 5.1.7.0 (2010/06/01) 新規追加 104 * @og.rev 5.2.1.0 (2010/10/01) 実用性を重視した改修 105 * 106 * @version 5.0 107 * @author Kazuhiko Hasegawa 108 * @since JDK6.0, 109 */ 110public final class DisplayCapture implements FlavorListener { 111 private static final Clipboard CLIP_BOARD = Toolkit.getDefaultToolkit().getSystemClipboard(); 112 private static final Rectangle SCRN_SIZE = new Rectangle( Toolkit.getDefaultToolkit().getScreenSize() ); 113 114 private File baseDir = new File("."); // セーブするベースディレクトリ 115 private String firstID = "seq"; // 保存時のファイル名の形式(seq|gui) 116 private String imgType = "png" ; // 画像形式(png|gif|jpg) 117 private int cnt = 100; // ユニーク番号(セーブファイル名に付与) 118 119 /** 120 * キャプチャファイルをセーブするベースとなるディレクトリを設定します(初期値:java実行フォルダ)。 121 * 122 * クラスの内部的には、Java の実行フォルダ( new File(".") ) が初期値です。 123 * 124 * @param bsDir セーブするベースディレクトリ 125 * @throws RuntimeException セーブフォルダが作成できなかった場合 126 */ 127 public void setBaseDir( final String bsDir ) { 128 if( bsDir != null && bsDir.length() > 0 ) { 129 baseDir = new File( bsDir ); 130 131 // ベースフォルダの作成。初期値は起動フォルダなので、必ず存在する(はず) 132 if( !baseDir.exists() && !baseDir.mkdirs() ) { 133 String errMsg = "ERROR:セーブフォルダが作成できませんでした。" + baseDir.getAbsolutePath() ; 134 throw new RuntimeException( errMsg ); 135 } 136 } 137 } 138 139 /** 140 * キャプチャ画像をセーブするファイル方式を指定します(初期値:seq)。 141 * 142 * seq (連番_画面ID_JSPファイル名.画像形式) 143 * gui (画面ID_JSPファイル名_連番.画像形式) 144 * 145 * 初期値は、seq です。 146 * 147 * @param firstID セーブするファイル方式(seq|gui) 148 * @throws RuntimeException ファイル方式の指定が間違っていた場合 149 */ 150 public void setFirstID( final String firstID ) { 151 if( firstID != null ) { 152 if( firstID.matches( "seq|gui" ) ) { 153 this.firstID = firstID; 154 } 155 else { 156 String errMsg = "ERROR:firstID 属性は、(seq|gui)でお願いします。firstID=[" + firstID + "]" ; 157 throw new RuntimeException( errMsg ); 158 } 159 } 160 } 161 162 /** 163 * キャプチャ画像をセーブする画像形式を指定します(初期値:png)。 164 * 165 * キャプチャされたイメージをセーブするときの画像形式を指定できます。 166 * ここでは、png , gif ,jpg を指定できます。 167 * 168 * 初期値は、png 形式です。 169 * 170 * @param imgType セーブする画像形式(png|gif|jpg) 171 */ 172 public void setImageType( final String imgType ) { 173 if( imgType != null && imgType.matches( "png|gif|jpg" ) ) { 174 this.imgType = imgType; 175 } 176 } 177 178 /** 179 * キャプチャ画像をセーブするファイル名の先頭に付ける連番の開始数(初期値:100)。 180 * 181 * キャプチャされたイメージをセーブするとき、画面IDとJSPファイル名だけでは、前回分を 182 * 上書きしてしまうため、ファイル名の先頭に連番を付与しています。 183 * ここでは、その連番の開始番号を指定できます。 184 * 185 * 初期値は、100 です。 186 * 187 * @param startCnt 連番の開始数(初期値:100) 188 */ 189 public void setStartCnt( final String startCnt ) { 190 if( startCnt != null && startCnt.length() > 0 ) { 191 cnt = Integer.parseInt( startCnt ); 192 } 193 } 194 195 /** 196 * 全画面の画像イメージ(キャプチャ画像)を取得します。 197 * 198 * java.awt.Toolkit で、全画面のスクリーンサイズを取得し、java.awt.Robot の 199 * createScreenCapture( Rectangle ) メソッドで、BufferedImage を取得しています。 200 * 201 * @return 全画面の画像イメージ 202 * @throws RuntimeException AWTException が発生した場合 203 */ 204 public static BufferedImage doCapture() { 205 BufferedImage img = null; 206 try{ 207 Robot robo = new Robot(); 208 img = robo.createScreenCapture( SCRN_SIZE ); 209 } 210 catch( AWTException ex ) { 211 String errMsg = "ERROR:画像イメージ(キャプチャ画像)が取得できませんでした。" ; 212 setClipboard( errMsg ); 213 throw new RuntimeException( errMsg,ex ); 214 } 215 catch( Throwable th ) { 216 String errMsg = "ERROR:" + th.getLocalizedMessage() ; 217 setClipboard( errMsg ); 218 throw new RuntimeException( errMsg,th ); 219 } 220 221 return img; 222 } 223 224 /** 225 * キャプチャ画像をファイルにセーブします。 226 * 227 * ここでは、単純に、引数そのままで、ImageIO.write( BufferedImage,String,File ) しています。 228 * saveFile のディレクトリ存在チェックや、ファイル名の拡張子(png,gif,jpgなど)の修正、 229 * imgType の形式チェックなどは、行っていません。 230 * それらの処理は、事前に、調整しておいてください。 231 * 232 * @param img セーブする画像イメージ 233 * @param imgType セーブする画像形式(png|gif|jpg) 234 * @param saveFile セーブする画像ファイルオブジェクト 235 * @throws RuntimeException IOException が発生した場合 236 * @see javax.imageio.ImageIO#write( java.awt.image.RenderedImage , String , java.io.File ) 237 */ 238 public static void saveImage( final BufferedImage img , final String imgType , final File saveFile ) { 239 try{ 240 ImageIO.write( img,imgType,saveFile ); 241 } 242 catch( IOException ex ) { 243 String errMsg = "ERROR:キャプチャ画像をファイルにセーブできませんでした。" + saveFile.getAbsolutePath() ; 244 setClipboard( errMsg ); 245 throw new RuntimeException( errMsg,ex ); 246 } 247 catch( Throwable th ) { 248 String errMsg = "ERROR:" + th.getLocalizedMessage() ; 249 setClipboard( errMsg ); 250 throw new RuntimeException( errMsg,th ); 251 } 252 } 253 254 /** 255 * システムのクリップボードの文字列を取得します。 256 * 257 * Toolkit.getDefaultToolkit().getSystemClipboard() で取得された Clipboard オブジェクトから 258 * 文字列情報(DataFlavor.stringFlavor)を取得します。 259 * 文字列情報が取得できない場合、(UnsupportedFlavorException が発生した場合) 例えば、 260 * PrntScrn ボタンが押された場合などは、文字列として、"GUI:PRINT SCREEN.img" を返します。 261 * これは、文字列が返せない場合でも、クリップボードに書き込まれたイベントで、全画面のキャプチャを 262 * 取得するための、特殊なコマンドに相当します。 263 * 264 * @return クリップボードの文字列 265 * @throws RuntimeException IOException が発生した場合 266 * @see java.awt.datatransfer.Clipboard#getData( DataFlavor ) 267 */ 268 public static String getClipboard() { 269 String strClip = null; 270 271 // 方法として、Transferable を取得後、getTransferData する事もできる。 272 // Transferable data = CLIP_BOARD.getContents(null); 273 274 try { 275 // クリップボードの値を取得 276 // strClip = (String)data.getTransferData(DataFlavor.stringFlavor); 277 strClip = (String)CLIP_BOARD.getData( DataFlavor.stringFlavor ); 278 } 279 catch( UnsupportedFlavorException ex ) { 280 // PrintScreen が押された場合。 281 strClip = "GUI:PRINT SCREEN.img" ; // 形式をGUI:画面ID xxxxx.jsp 形式に合わす為 282 } 283 catch( IOException ex ) { 284 String errMsg = "ERROR:クリップボードの値を取得できませんでした。" ; 285 setClipboard( errMsg ); 286 throw new RuntimeException( errMsg,ex ); 287 } 288 catch( Throwable th ) { 289 String errMsg = "ERROR:" + th.getLocalizedMessage() ; 290 setClipboard( errMsg ); 291 throw new RuntimeException( errMsg,th ); 292 } 293 294 return strClip; 295 } 296 297 /** 298 * システムのクリップボードに文字列を書き込みます。 299 * 300 * システムの Clipboard オブジェクトに、StringSelection を セットします。 301 * 通常であれば、単純に、クリップボード経由でデータのやり取りをするだけの機構ですが、 302 * FlavorListener を実装している関係上、flavorsChanged が発生します。 303 * このイベントについては、#flavorsChanged( FlavorEvent ) を参照ください。 304 * 305 * @param txt クリップボードに書き込む文字列 306 * @see java.awt.datatransfer.StringSelection 307 * @see java.awt.datatransfer.Clipboard#setContents( Transferable , ClipboardOwner ) 308 */ 309 public static void setClipboard( final String txt ) { 310 StringSelection strSel = new StringSelection( txt ); 311 CLIP_BOARD.setContents( strSel, null ); 312 } 313 314 /** 315 * リスナー対象の Clipboard で使用可能な DataFlavor が変更されたときに呼び出されます。 316 * 317 * これは、FlavorListener の イベントの実装です。 318 * DataFlavor が変更されたときであり、そのデータの内容が書き換えられた場合には、イベントが 319 * 発生しません。 320 * そのため、データを取り出したあとで、Transferable を再セットする処理を行っています。 321 * 322 * クリップボードで使用可能な一連の DataFlavors の変更によるものでない、余分な通知もあります。 323 * さらに、イベントを発生させるために、Transferable をセットする処理( #setClipboard(String) )を 324 * 実行しても、同様にイベントが発生します。 325 * 326 * ここでは、取得したクリップボードの文字列が、"GUI:" の場合のみ処理しています。 327 * これにより、取得後の Transferable の再セット時の文字列は、"GUI:" を削除しています。 328 * 329 * このメソッドでは、画面キャプチャを取得し、クリップボードの文字列から、画面ID とJSPファイル名を 330 * 抜き出し、セーブする一連の処理を行っています。 331 * 332 * @param fe イベントソース 333 * @see java.awt.datatransfer.FlavorListener#flavorsChanged( FlavorEvent ) 334 */ 335 @Override 336 public void flavorsChanged( final FlavorEvent fe ) { 337 String txt = getClipboard(); 338 339 // クリップボードの値をクリアしたときのイベントは、拾わないため。 340 if( txt != null && txt.length() > 0 && txt.startsWith( "GUI:" ) ) { 341 System.out.println( cnt + ":【" + txt + "】" ); 342 BufferedImage img = doCapture(); 343 344 File saveFile = makeSaveFile( txt ); 345 346 saveImage( img,imgType,saveFile ); 347 348 // クリップボードのFlavorを置換します。(Windwosからセットされた時にイベントを発生させるため。) 349 // 先頭の GUI: を取り除く。イベントの無限ループを防ぐ意味。 350 setClipboard( txt.substring( 4 ) ); 351 } 352 } 353 354 /** 355 * キャプチャ画像を書き出すファイルオブジェクトを作成します。 356 * 357 * 引数は、"GUI:画面ID xxxxx.jsp" 形式を想定した文字列です。 358 * 359 * ファイル名には、2種類あります。 360 * firstID を seq に設定した場合 361 * ベースフォルダでフォルダを作成し、その中に、連番_画面ID_JSPファイル名.画像形式 ファイルを作成します。 362 * ファイルは、キャプチャされた順番に、画面IDも混在して作成されます。つまり、ファイル名の順番に 363 * 再生すれば、リンクや他のシステムとの連携などで、画面が行き来しても、作業の順番にキャプチャできて 364 * いる事になります。 365 * firstID を gui に設定した場合 366 * ベースフォルダでフォルダを作成し、その中に、画面ID_JSPファイル名_連番.画像形式 ファイルを作成します。 367 * 画面ID 単位に、画面のキャプチャを整理、使用したい場合に便利です。 368 * ファイルのタイムスタンプ(作成時刻)で並び替えを行えば、キャプチャ順に並び替えできます。 369 * 370 * このメソッドで、フォルダの存在チェック、および、無ければ作成(mkdirs)も行います。 371 * 372 * @param txt ファイル名の元となる文字列("GUI:画面ID xxxxx.jsp" 形式) 373 * 374 * @return 書き出すファイルオブジェクト 375 */ 376 private File makeSaveFile( final String txt ) { 377 int spc = txt.indexOf( ' ' ); // "GUI:画面ID xxxxx.jsp" をスペースで分離 378 String gui = txt.substring( 4,spc ); // 画面ID の部分のみ切り出す。 379 String jsp = txt.substring( spc+1,txt.length()-4 ); // xxxxx の部分のみ切り出す。 380 381 String saveFile = null; 382 if( "seq".equalsIgnoreCase( firstID ) ) { 383 saveFile = cnt++ + "_" + gui + "_" + jsp + "." + imgType ; 384 } 385 else if( "gui".equalsIgnoreCase( firstID ) ) { 386 saveFile = gui + "_" + jsp + "_" + cnt++ + "." + imgType ; 387 } 388 else { // 5.5.2.6 (2012/05/25) findbugs対応 389 saveFile = cnt++ + "_" + gui + "_" + jsp + "." + imgType ; // seqかguiしかないが、経路として、初期値(seq)を設定しておく。 390 } 391 392 File svf = new File( baseDir,saveFile ); 393 // セーブフォルダの作成。 394 File parent = svf.getParentFile(); 395 if( !parent.exists() && !parent.mkdirs() ) { 396 String errMsg = "ERROR:セーブフォルダが作成できませんでした。" + parent.getAbsolutePath() ; 397 setClipboard( errMsg ); 398 throw new RuntimeException( errMsg ); 399 } 400 401 // セーブファイルの存在チェック。上書き禁止にしておきます。 402 if( svf.exists() ) { 403 String errMsg = "ERROR:セーブファイルがすでに作成されています。" + svf.getAbsolutePath() ; 404 setClipboard( errMsg ); 405 throw new RuntimeException( errMsg ); 406 } 407 408 return svf; 409 } 410 411 /** 412 * DisplayCapture.java は、画面イメージをキャプチャする、メインメソッドです。 413 * 414 * Javaアプリケーションとして実行すると、無限処理に入ります。 415 * 内部的には、flavorsChanged イベント によるクリップボードの監視を行います。 416 * クリップボードに、"GUI:画面ID xxxxx.jsp" 形式の文字が書き込まれると、画面キャプチャを、 417 * ファイルに書き出す処理が実行されます。 418 * 書き出すファイル名の初期形式は、firstID の設定により異なります。 419 * firstID を seq に設定した場合 420 * ベースフォルダでフォルダを作成し、その中に、連番_画面ID_JSPファイル名.画像形式 ファイルを作成します。 421 * ファイルは、キャプチャされた順番に、画面IDも混在して作成されます。つまり、ファイル名の順番に 422 * 再生すれば、リンクや他のシステムとの連携などで、画面が行き来しても、作業の順番にキャプチャできて 423 * いる事になります。 424 * firstID を gui に設定した場合 425 * ベースフォルダでフォルダを作成し、その中に、画面ID_JSPファイル名_連番.画像形式 ファイルを作成します。 426 * 画面ID 単位に、画面のキャプチャを整理、使用したい場合に便利です。 427 * ファイルのタイムスタンプ(作成時刻)で並び替えを行えば、キャプチャ順に並び替えできます。 428 * 429 * Usage: java org.opengion.fukurou.util.DisplayCapture 430 * [BASE_DIR] [firstID(seq|gui)] [imageFormat(png|gif|jpg)] [startCnt(100)] 431 * 432 * args[0] BASE_DIR : キャプチャファイルをセーブするベースとなるディレクトリ(初期値:起動フォルダ) 433 * args[1] firstID : キャプチャ画像をセーブするファイル方式を指定します(初期値:seq) 434 * seq (連番_画面ID_JSPファイル名.画像形式) 435 * gui (画面ID_JSPファイル名_連番.画像形式) 436 * args[2] imageFormat : 作成するイメージの形式。png|gif|jpg のどれか(初期値:png) 437 * args[3] startCnt : セーブファイル名をユニークにするためのカウント(初期値:100) 438 * 439 * @param args 引数 [BASE_DIR] [firstID(seq|gui)] [imageFormat(png|gif|jpg)] [startCnt(100)] 440 */ 441 public static void main( final String[] args ) { 442 System.out.println( "DisplayCapture を起動しました。" ); 443 444 DisplayCapture dispCap = new DisplayCapture(); 445 446 if( args.length > 0 ) { dispCap.setBaseDir( args[0] ); } 447 if( args.length > 1 ) { dispCap.setFirstID( args[1] ); } 448 if( args.length > 2 ) { dispCap.setImageType( args[2] ); } 449 if( args.length > 3 ) { dispCap.setStartCnt( args[3] ); } 450 451 // クリップボードの値をクリア(FlavorEvent を起こさせるため) 452 DisplayCapture.setClipboard( null ); 453 454 // FlavorListener を登録します。(自分自身のオブジェクト) 455 CLIP_BOARD.addFlavorListener( dispCap ); 456 457 // FlavorEvent で処理させるので、ずっとスレッドをSleepさせておけばよい。 458 while( true ) { 459 try { 460 Thread.sleep( 100000 ); 461 } 462 catch( InterruptedException ex ) {} 463 } 464 } 465}