/*
このファイルの中身は、NTT オープンソースライセンス　バージョン 1.0（「本
契約」という）の適用を受けます。
本契約を遵守しない限り、このファイルを使用してはなりません。
本契約のコピーは、次のＵＲＬから入手できます。
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

本契約に基づき頒布されるソフトウェアは、現状のまま、明示又は黙示のあらゆ
る種類の保証なしで、頒布されます。本契約に基づく権利及び制限を律する特定
の文言については、本契約を参照してください。

「オリジナルコード」は、 NTT Cyber Space Laboratories Code です。 
「オリジナルコード」の「初期開発者」は、日本電信電話株式会社です。  
日本電信電話株式会社により創作された部分は、Copyright (C) 2004 
日本電信電話株式会社 です。
全ての権利が留保されます。 
「コントリビュータ」：_____________________________________ 


The contents of this file are subject to the NTT Opensource License
Version 1.0 (the License); you may not use this file except in
compliance with the License. You may obtain a copy of the License at
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

Software distributed under the License is distributed on an AS IS
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
License for the specific language governing rights and limitations
under the License.

The Original Code is NTT Cyber Space Laboratories Code .

The Initial Developer of the Original Code is NIPPON TELEGRAPH AND 
TELEPHONE CORPORATION.
Portions created by the NIPPON TELEGRAPH AND TELEPHONE CORPORATION 
are Copyright (C) 2004 NIPPON TELEGRAPH AND TELEPHONE CORPORATION. 
All Rights Reserved.

Contributor(s) ______________________________________.
*/

//
// XMS共通ユーティリティクラス。
// 
//
//	変更履歴
//	2004/01/08 新規作成	M.Seko 
//
package jp.co.ntt.lms.xms.common.util;
import java.util.Set;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

import jp.co.ntt.lms.xmo.Mail.MailEnv;
import jp.co.ntt.lms.xms.common.user.User;
import jp.co.ntt.lms.xms.framework.Constant;
import jp.co.ntt.lms.xms.framework.XmsException;
import jp.co.ntt.lms.xms.framework.XmsInnerException;
import jp.co.ntt.lms.xms.framework.XmsRequest;

/**
 * XMS共通ユーティリティクラス。<br>
 * 複数の業務で使用されるメソッドを持つ。<br>
 * 
 * @author M.Seko
 */
public class CommonUtil {

	/**
	 * privateコンストラクタ。<br>
	 * このクラスのインスタンス化禁止のために定義する。
	 */
	private CommonUtil() {
	}

	/**
	 * ログインユーザにユーザオブジェクトを取得する。<br>
	 * @param xmsRequest リクエスト・オブジェクト。
	 * @return セッションを取得でき、かつ、現在ログインしているユーザの
	 *          ユーザオブジェクトを取得できた場合、そのオブジェクト。
	 *          それ以外はnullを戻す。
	 * @throws XmsException 処理中に例外が発生した場合。
	 */
	public static User getLoginUser(XmsRequest xmsRequest) throws XmsException {
		// HTTPセッション取得用
		HttpServletRequest request = null;
		// HTTPセッション
		HttpSession session = null;
		// 対象ユーザオブジェクト。
		User user = null;
		try {
			request = xmsRequest.getRequest();
			session = request.getSession(false);
			if (session != null) {
				//ユーザオブジェクトを取得
				user = (User) session.getAttribute(Constant.KEY_USER);
			}
		} catch (Exception e) {
			throw new XmsInnerException(e);
		}
		return user;
	}

	/**
	 * メール権限の有無をチェックする。<br>
	 * 渡されたUserオブジェクトにメール権限が含まれているか判定する。
	 * @param user ユーザオブジェクト
	 * @return メール権限ある場合trueを、ない場合falseを戻す。
	 */
	private static boolean checkMailAuthority(User user) throws XmsException {

		// メール送信権限を示す値
		final String mailAuthorityMOId = "11";

		boolean returnValue = false;
		try {
			Set xmoListSet = user.getXMOIds();
			returnValue = xmoListSet.contains(mailAuthorityMOId);
		} catch (XmsException e) {
			throw e;
		} catch (Exception e) {
			throw new XmsInnerException(e);
		}
		return returnValue;
	}

	/**
	 * メール権限・環境の有無をチェックする。<br>
	 * メール環境が使用可能かチェックし、使用可能であれば、
	 * 渡されたリクエスト・オブジェクトを通じて、
	 * セッションからUserオブジェクトを取得し、
	 * Userオブジェクトにメール権限が含まれているか判定する。
	 * セッションやUserオブジェクトを取得できなかったときは、
	 * メール権限がないものとする。<br>
	 * 
	 * @param xmsRequest リクエスト・オブジェクト。
	 * @return メール環境が存在し、かつメール権限がある場合trueを、それ以外の場合はfalseを戻す。
	 */
	public static boolean checkMailAuthority(XmsRequest xmsRequest) throws XmsException {
		// 対象ユーザオブジェクト。
		User user = null;
		// このメソッドの戻り値。
		boolean returnValue = false;
		try {
			//メール環境が使用可能か確認
			returnValue = MailEnv.isExistSmtpEnv();

			//メール環境が使用可能であれば、ユーザの権限を確認する
			if (returnValue == true) {
				//ユーザオブジェクトを取得
				user = getLoginUser(xmsRequest);

				//userが存在した場合、権限を取得して実際に確認
				if (user != null) {
					returnValue = checkMailAuthority(user);
				}
			}
		} catch (XmsException e) {
			throw e;
		} catch (Exception e) {
			throw new XmsInnerException(e);
		}
		return returnValue;
	}

	/**
	 * セッションからデータを削除する。<br>
	 * リクエストオブジェクトからHttpSessionオブジェクトを取得し、
	 * 指定されたセッションキー名称に対応するデータをセッションから削除する。
	 * HttpSessionを取得できない場合、キー名称に対応するデータが存在しない場合、
	 * 指定されたキー名称がnullの場合には、セッションデータについて変化はない。
	 * 
	 * @param xmsRequest リクエスト・オブジェクト。
	 * @param name 削除するセッションデータのキー名称。
	 * @throws XmsException 処理中に例外が発生した場合。
	 * @see #removeSessionData(XmsRequest, String[])
	 * @see HttpSession
	 * @see HttpSession#removeAttribute(String)
	 */
	public static void removeSessionData(XmsRequest xmsRequest, String name) throws XmsException {
		String[] names = null;
		try {
			names = new String[1];
			names[0] = name;
			removeSessionData(xmsRequest, names);
		} catch (XmsException e) {
			throw e;
		} catch (Exception e) {
			throw new XmsInnerException(e);
		}
	}

	/**
	 * セッションからデータを削除する。<br>
	 * リクエストオブジェクトからHttpSessionオブジェクトを取得し、
	 * 指定されたセッションキー名称１つずつに対応するデータをセッションから削除する。
	 * HttpSessionを取得できない場合、キー名称に対応するデータが存在しない場合、
	 * 指定されたキー名称がnullの場合には、セッションデータについて変化はない。
	 * 
	 * @param xmsRequest リクエスト・オブジェクト。
	 * @param names 削除するセッションデータのキー名称の配列。
	 * @throws XmsException 処理中に例外が発生した場合。
	 * @see #removeSessionData(XmsRequest, String)
	 * @see HttpSession
	 * @see HttpSession#removeAttribute(java.lang.String)
	 */
	public static void removeSessionData(XmsRequest xmsRequest, String[] names)
		throws XmsException {
		// HTTPセッション・オブジェクト。
		HttpSession session = null;
		// HTTPリクエスト・オブジェクト。
		HttpServletRequest request = null;
		// 削除対象のキー名称。
		String name = null;

		try {
			// セッション・オブジェクトの取得。
			request = xmsRequest.getRequest();
			session = request.getSession(false);
			// セッション・オブジェクトが取得でき、
			// キー名称パラメータがnullでなければ、削除を実施。
			if (session != null && names != null) {
				for (int i = 0; i < names.length; i++) {
					// 削除対象のキー名称を取得し、nullでなければ削除。
					name = names[i];
					if (name == null) {
						continue;
					}
					session.removeAttribute(name);
				}
			}
		} catch (Exception e) {
			throw new XmsInnerException(e);
		}
	}

	/**
	 * ユーザIDか判定する。<br>
	 * @param userID 判定するID文字列。
	 * @return userIDが、nullではなく、かつ、&quot;PE&quot;で始まる場合trueを、
	 *          そのほかの場合falseを戻す。
	 */
	public static boolean isUserID(String userID) {
		boolean returnValue = false;
		if (userID == null) {
			returnValue = false;
		} else {
			returnValue = (userID.startsWith("PE"));
		}
		return returnValue;
	}

	/**
	 * グループIDか判定する。<br>
	 * @param groupID 判定するID文字列。
	 * @return groupIDが、nullではなく、かつ、&quot;GR&quot;で始まる場合trueを、
	 *          そのほかの場合falseを戻す。
	 */
	public static boolean isGroupID(String groupID) {
		boolean returnValue = false;
		if (groupID == null) {
			returnValue = false;
		} else {
			returnValue = (groupID.startsWith("GR"));
		}
		return returnValue;
	}
}
