ipseeker.java

来自「用java实现的」· Java 代码 · 共 376 行

/*
* LumaQQ - Java QQ Client
*
* Copyright (C) 2004 luma <[e-mail]>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package edu.tsinghua.lumaqq;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.util.Hashtable;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import edu.tsinghua.lumaqq.qq.Utils;

/**
 * <pre>
 * 用来读取QQwry.dat文件，以根据ip获得好友位置，QQwry.dat的格式是
 * 一. 文件头，共8字节 
 * 	   1. 第一个起始IP的绝对偏移， 4字节
 *     2. 最后一个起始IP的绝对偏移， 4字节
 * 二. 结束地址+国家+区域记录区
 *     四字节ip地址后跟的每一条记录分成两个部分
 *     1. 国家记录
 *     2. 地区记录
 *     但是地区记录是不一定有的。而且国家记录和地区记录都有两种形式
 *     1. 以0结束的字符串
 *     2. 4个字节，一个字节可能为0x1或0x2
 * 		  a. 为0x1时，表示在绝对偏移后还跟着一个区域的记录，注意是绝对偏移之后，而不是这四个字节之后
 *        b. 为0x2时，表示在绝对偏移后没有区域记录
 *        不管为0x1还是0x2，后三个字节都是实际国家名的文件内绝对偏移
 * 		  如果是地区记录，0x1和0x2的含义不明，但是如果出现这两个字节，也肯定是跟着3个字节偏移，如果不是
 *        则为0结尾字符串
 * 三. 起始地址+结束地址偏移记录区
 *     1. 每条记录7字节，按照起始地址从小到大排列
 *        a. 起始IP地址，4字节
 *        b. 结束ip地址的绝对偏移，3字节
 * 
 * 注意，这个文件里的ip地址和所有的偏移量均采用little-endian格式，而java是采用
 * big-endian格式的，要注意转换
 * </pre>
 * 
 * @author 马若劼
 */
public class IPSeeker {
	// 用来封装ip相关信息，目前只有两个字段，ip所在的国家和地区
	private class IPInfo extends IPSeeker {
		public String country;
		public String area;
	}
	
	// 一些固定常量，比如记录长度等等
	private static final int IP_RECORD_LENGTH = 7;
	private static final byte AREA_FOLLOWED = 0x01;
	private static final byte NO_AREA = 0x2;
	
    // Log对象
    private static Log log = LogFactory.getLog(IPSeeker.class);
	// 用来做为cache，查询一个ip时首先查看cache，以减少不必要的重复查找
	private Hashtable ipCache;
	// 随机文件访问类
	private RandomAccessFile ipFile;
	// 单一模式实例
	private static IPSeeker instance = new IPSeeker();
	// 起始地区的开始和结束的绝对偏移
	private long ipBegin, ipEnd;
	// 本次搜索的ip的字节数组形式，之所以要保留这样一个形式是为了比较的方便一点
	//     注意这个字节数组是big-endian的，而文件里面的ip是little-endian的
	private byte[] ip;
	
	/**
	 * 私有构造函数
	 */
	private IPSeeker()  {
		ipCache = new Hashtable();
		try {
			ipFile = new RandomAccessFile(LumaQQ.IP_FILE, "r");
		} catch (FileNotFoundException e) {
			// 如果找不到这个文件，再尝试再当前目录下搜索，这次全部改用小写文件名
			//     因为有些系统可能区分大小写导致找不到ip地址信息文件
			String filename = new File(LumaQQ.IP_FILE).getName().toLowerCase();
			File[] files = new File(LumaQQ.INSTALL_DIR).listFiles();
			for(int i = 0; i < files.length; i++) {
				if(files[i].isFile()) {
					if(files[i].getName().toLowerCase().equals(filename)) {
						try {
							ipFile = new RandomAccessFile(files[i], "r");
						} catch (FileNotFoundException e1) {
							log.error("IP地址信息文件没有找到，IP显示功能将无法使用");
							ipFile = null;
						}
						break;
					}
				}
			}
		} 
		// 如果打开文件成功，读取文件头信息
		if(ipFile != null) {
			try {
				ipBegin = readLong4(0);
				ipEnd = readLong4(4);
				if(ipBegin == -1 || ipEnd == -1) {
					ipFile.close();
					ipFile = null;
				}			
			} catch (IOException e) {
				log.error("IP地址信息文件格式有错误，IP显示功能将无法使用");
				ipFile = null;
			}			
		}
	}
	
	/**
	 * @return 单一实例
	 */
	public static IPSeeker getInstance() {
		return instance;
	}
	
	/**
	 * 根据IP得到国家名
	 * @param ip ip的字节数组形式
	 * @return 国家名字符串
	 */
	public String getCountry(byte[] ip) {
		// 检查ip地址文件是否正常
		if(ipFile == null) return LumaQQ.getResourceString("bad.ip.file");
		// 保存ip，转换ip字节数组为字符串形式
		this.ip = ip;
		String ipStr = Utils.getIpStringFromBytes(ip);
		// 先检查cache中是否已经包含有这个ip的结果，没有再搜索文件
		if(ipCache.containsKey(ipStr)) {
			IPInfo info = (IPInfo)ipCache.get(ipStr);
			return info.country;
		} else {
			IPInfo info = retrieve();
			ipCache.put(ipStr, info);
			return info.country;
		}
	}
	
	/**
	 * 根据IP得到地区名
	 * @param ip ip的字节数组形式
	 * @return 地区名字符串
	 */
	public String getArea(byte[] ip) {
		// 检查ip地址文件是否正常
		if(ipFile == null) return LumaQQ.getResourceString("bad.ip.file");
		// 保存ip，转换ip字节数组为字符串形式
		this.ip = ip;
		String ipStr = Utils.getIpStringFromBytes(ip);
		// 先检查cache中是否已经包含有这个ip的结果，没有再搜索文件
		if(ipCache.containsKey(ipStr)) {
			IPInfo info = (IPInfo)ipCache.get(ipStr);
			return info.area;
		} else {
			IPInfo info = retrieve();
			ipCache.put(ipStr, info);
			return info.area;
		}
	}
	
	/**
	 * 根据ip搜索ip信息文件，得到IPInfo结构，所搜索的ip参数从类成员ip中得到
	 * @return IPInfo结构
	 */
	private IPInfo retrieve() {
		IPInfo info = null;
		long offset = locateIP();
		if(offset != -1)
			info = getIPInfo(offset);
		if(info == null) {
			info = new IPInfo();
			info.country = LumaQQ.getResourceString("unknown.country");
			info.area = LumaQQ.getResourceString("unknown.area");
		}
		return info;
	}
	
	// 从offset位置读取4个字节为一个long，因为java为big-endian格式，所以没办法
	//     用了这么一个函数来做转换，返回-1表示读取文件失败
	private long readLong4(long offset) {
		long ret = 0;
		try {
			ipFile.seek(offset);
			ret |= (ipFile.readByte() & 0xFF);
			ret |= ((ipFile.readByte() << 8) & 0xFF00);
			ret |= ((ipFile.readByte() << 16) & 0xFF0000);
			ret |= ((ipFile.readByte() << 24) & 0xFF000000);
			return ret;
		} catch (IOException e) {
			return -1;
		}
	}
	
	// 从offset位置读取3个字节为一个long，因为java为big-endian格式，所以没办法
	//     用了这么一个函数来做转换，返回-1表示读取文件失败
	private long readLong3(long offset) {
		long ret = 0;
		try {
			ipFile.seek(offset);
			ret |= (ipFile.readByte() & 0xFF);
			ret |= ((ipFile.readByte() << 8) & 0xFF00);
			ret |= ((ipFile.readByte() << 16) & 0xFF0000);
			return ret;
		} catch (IOException e) {
			return -1;
		}
	}
	
	// 从offset位置读取四个字节的ip地址放入ip数组中，读取后的ip为big-endian格式，但是
	//     文件中是little-endian形式，将会进行转换
	private void readIP(long offset, byte[] ip) {
		try {
			ipFile.seek(offset);
			ipFile.readFully(ip);
			byte temp = ip[0];
			ip[0] = ip[3];
			ip[3] = temp;
			temp = ip[1];
			ip[1] = ip[2];
			ip[2] = temp;
		} catch (IOException e) {
		}
	}
	
	// 把类成员ip和beginIp比较，相等返回0，ip大于beginIp则返回1，小于返回-1。
	//     注意这个beginIp是big-endian的
	private int compareIP(byte[] beginIp) {
		for(int i = 0; i < 4; i++) {
			int r = compareByte(ip[i], beginIp[i]);
			if(r != 0)
				return r;
		}
		return 0;
	}
	
	// 把两个byte当作无符号数进行比较，若b1大于b2则返回1，相等返回0，小于返回-1
	private int compareByte(byte b1, byte b2) {
		if((b1 & 0xFF) > (b2 & 0xFF)) // 比较是否大于
			return 1;
		else if((b1 ^ b2) == 0)// 判断是否相等
			return 0;
		else 
			return -1;
	}
	
	// 这个方法将根据ip的内容，定位到包含这个ip国家地区的记录处，返回一个绝对偏移
	//     方法使用二分法查找。如果找不到，则返回-1
	private long locateIP() {
		byte[] b = new byte[4];
		long m = 0;
		int r;
		// 比较第一个ip项
		readIP(ipBegin, b);
		r = compareIP(b);
		if(r == 0) return ipBegin;
		else if(r < 0) return -1;
		// 开始二分搜索
		for(long i = ipBegin, j = ipEnd; i < j; ) {
			m = getMiddleOffset(i, j);
			readIP(m, b);
			r = compareIP(b);
			// log.debug(Utils.getIpStringFromBytes(b));
			if(r > 0)
				i = m;
			else if(r < 0) {
				if(m == j) {
					j -= IP_RECORD_LENGTH;
					m = j;
				} else 
					j = m;
			} else
				return readLong3(m + 4);
		}
		// 如果循环结束了，那么i和j必定是相等的，这个记录为最可能的记录，但是不一定就
		//     肯定是，还要检查一下，如果是，就返回结束地址区的绝对偏移
		m = readLong3(m + 4);
		readIP(m, b);
		r = compareIP(b);
		if(r <= 0) return m;
		else return -1;
	}
	
	// 得到begin偏移和end偏移中间位置记录的偏移
	private long getMiddleOffset(long begin, long end) {
		long records = (end - begin) / IP_RECORD_LENGTH;
		records /= 2;
		if(records == 0) records = 1;
		return begin + records * IP_RECORD_LENGTH;
	}
	
	// 给定一个ip国家地区记录的偏移，返回一个IPInfo结构
	private IPInfo getIPInfo(long offset) {
		IPInfo info = new IPInfo();
		try {
			// 跳过4字节ip
			ipFile.seek(offset + 4);
			// 读取第一个字节判断是否标志字节
			byte b = ipFile.readByte();
			if(b == AREA_FOLLOWED) {
				// 读取国家偏移
				long countryOffset = readLong3(ipFile.getFilePointer());
				// 跳转至偏移处
				ipFile.seek(countryOffset);
				// 再检查一次标志字节，因为这个时候这个地方仍然可能是个重定向
				b = ipFile.readByte();
				if(b == NO_AREA) {
					info.country = readString(readLong3(ipFile.getFilePointer()));
					ipFile.seek(countryOffset + 4);
				} else
					info.country = readString(countryOffset);
				// 读取地区标志
				info.area = readArea(ipFile.getFilePointer());
			} else if(b == NO_AREA) {
				info.country = readString(readLong3(ipFile.getFilePointer()));
				info.area = readArea(offset + 8);
			} else {
				info.country = readString(ipFile.getFilePointer() - 1);
				info.area = readArea(ipFile.getFilePointer());
			}
			return info;
		} catch (IOException e) {
			return null;
		}
	}
	
	// 从offset偏移开始解析后面的字节，读出一个地区名
	private String readArea(long offset) throws IOException {
		ipFile.seek(offset);
		byte b = ipFile.readByte();
		if(b == 0x01 || b == 0x02) {
			long areaOffset = readLong3(ipFile.getFilePointer());
			if(areaOffset == 0)
				return LumaQQ.getResourceString("unknown.area");
			else
				return readString(areaOffset);
		} else
			return readString(ipFile.getFilePointer() - 1);
	}
	
	// 从offset偏移处读取一个以0结束的字符串
	private String readString(long offset) {
		try {
			ipFile.seek(offset);
			byte[] b = new byte[1];
			ByteArrayOutputStream baos = new ByteArrayOutputStream();
			for(b[0] = ipFile.readByte(); b[0] != 0; b[0] = ipFile.readByte())
				baos.write(b);
			String str = Utils.getString(baos.toByteArray(), "GBK");
			return str;
		} catch (IOException e) {
			return "";
		}
	}
}