qqclient.java

lumaQQ的源文件

/*
* 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.qq;

import static edu.tsinghua.lumaqq.qq.QQPort.*;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.net.InetSocketAddress;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Vector;
import java.util.concurrent.Callable;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;

import edu.tsinghua.lumaqq.qq.beans.Card;
import edu.tsinghua.lumaqq.qq.beans.ContactInfo;
import edu.tsinghua.lumaqq.qq.beans.FriendRemark;
import edu.tsinghua.lumaqq.qq.beans.Member;
import edu.tsinghua.lumaqq.qq.beans.QQOrganization;
import edu.tsinghua.lumaqq.qq.beans.QQUser;
import edu.tsinghua.lumaqq.qq.beans.Signature;
import edu.tsinghua.lumaqq.qq.events.IQQListener;
import edu.tsinghua.lumaqq.qq.events.PacketEvent;
import edu.tsinghua.lumaqq.qq.events.QQEvent;
import edu.tsinghua.lumaqq.qq.net.ConnectionPolicyFactory;
import edu.tsinghua.lumaqq.qq.net.IConnection;
import edu.tsinghua.lumaqq.qq.net.IConnectionPolicy;
import edu.tsinghua.lumaqq.qq.net.IConnectionPolicyFactory;
import edu.tsinghua.lumaqq.qq.net.IConnectionPool;
import edu.tsinghua.lumaqq.qq.net.IConnectionPoolFactory;
import edu.tsinghua.lumaqq.qq.packets.InPacket;
import edu.tsinghua.lumaqq.qq.packets.OutPacket;
import edu.tsinghua.lumaqq.qq.packets.Packet;
import edu.tsinghua.lumaqq.qq.packets.in.ReceiveIMPacket;
import edu.tsinghua.lumaqq.qq.packets.out.AddFriendAuthResponsePacket;
import edu.tsinghua.lumaqq.qq.packets.out.AddFriendExPacket;
import edu.tsinghua.lumaqq.qq.packets.out.AdvancedSearchUserPacket;
import edu.tsinghua.lumaqq.qq.packets.out.AuthorizePacket;
import edu.tsinghua.lumaqq.qq.packets.out.ChangeStatusPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterActivatePacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterActivateTempPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterAuthPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterCommitMemberOrganizationPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterCommitOrganizationPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterCreatePacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterCreateTempPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterDismissPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterExitPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterExitTempPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterGetCardBatchPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterGetCardPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterGetInfoPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterGetMemberInfoPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterGetOnlineMemberPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterGetTempInfoPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterJoinPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterModifyCardPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterModifyInfoPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterModifyMemberPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterModifyTempInfoPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterModifyTempMemberPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterSearchPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterSendIMExPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterSendTempIMPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterSetRolePacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterSubClusterOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterTransferRolePacket;
import edu.tsinghua.lumaqq.qq.packets.out.ClusterUpdateOrganizationPacket;
import edu.tsinghua.lumaqq.qq.packets.out.DeleteFriendPacket;
import edu.tsinghua.lumaqq.qq.packets.out.DownloadGroupFriendPacket;
import edu.tsinghua.lumaqq.qq.packets.out.FriendDataOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.FriendLevelOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.GetFriendListPacket;
import edu.tsinghua.lumaqq.qq.packets.out.GetOnlineOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.GetUserInfoPacket;
import edu.tsinghua.lumaqq.qq.packets.out.GroupDataOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.KeepAlivePacket;
import edu.tsinghua.lumaqq.qq.packets.out.LoginPacket;
import edu.tsinghua.lumaqq.qq.packets.out.LogoutPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ModifyInfoPacket;
import edu.tsinghua.lumaqq.qq.packets.out.PrivacyDataOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.ReceiveIMReplyPacket;
import edu.tsinghua.lumaqq.qq.packets.out.RemoveSelfPacket;
import edu.tsinghua.lumaqq.qq.packets.out.RequestKeyPacket;
import edu.tsinghua.lumaqq.qq.packets.out.RequestLoginTokenPacket;
import edu.tsinghua.lumaqq.qq.packets.out.SearchUserPacket;
import edu.tsinghua.lumaqq.qq.packets.out.SendIMPacket;
import edu.tsinghua.lumaqq.qq.packets.out.SendSMSPacket;
import edu.tsinghua.lumaqq.qq.packets.out.SignatureOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.TempSessionOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.UploadGroupFriendPacket;
import edu.tsinghua.lumaqq.qq.packets.out.UserPropertyOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.WeatherOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out._03.GetCustomHeadDataPacket;
import edu.tsinghua.lumaqq.qq.packets.out._03.GetCustomHeadInfoPacket;
import edu.tsinghua.lumaqq.qq.packets.out._05.RequestAgentPacket;
import edu.tsinghua.lumaqq.qq.packets.out._05.RequestBeginPacket;
import edu.tsinghua.lumaqq.qq.packets.out._05.RequestFacePacket;
import edu.tsinghua.lumaqq.qq.packets.out._05.TransferPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.ApplyPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.AuthenticatePacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.CreatePacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.DeletePacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.DownloadPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.FinalizePacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.GetServerListPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.GetShareListPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.GetSharedDiskPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.GetSizePacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.ListMyDiskDirPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.ListSharedDiskDirPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.MovePacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.PasswordOpPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.PreparePacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.RenamePacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.SetShareListPacket;
import edu.tsinghua.lumaqq.qq.packets.out.disk.UploadFilePacket;
import edu.tsinghua.lumaqq.qq.robot.IRobot;

/**
 * QQ的客户端类，这个类为用户提供一个方便的接口，比如发送消息之类的，只需要调用一个
 * 方法便可以完成了。
 * 
 * LumaQQ网络层通过NIO实现，每个Client分配一个Selector，每个Selector可以监听多个
 * Channel，channel包装在IPort的实现类中，对于一个Client，有一个Main Port，这个
 * Main Port定义为连接QQ登陆服务器的那个Port。系统登陆之初之有一个Port即Main Port，
 * 根据需要可以开启其他Port
 * 
 * @author luma
 */
public class QQClient implements IQQListener {    
    // 登陆的服务器IP
    private String loginServer;
    // TCP方式登录时的服务器端口，UDP方式时无用处
    private int tcpLoginPort;
    // 包处理器路由器
    private ProcessorRouter router;
    // QQ监听器
    private List<IQQListener> qqListeners, qqListenersBackup;
    // QQ用户
    private QQUser user;
    // 当前是否正在登陆
    private boolean logging;
    // 当前是否在重定向登录
    private boolean loginRedirect;
    // 网络连接池
    private IConnectionPool pool;
    // 网络连接池工厂
    private IConnectionPoolFactory poolFactory;
    // 连接策略工厂
    private IConnectionPolicyFactory policyFactory;
    // 代理类型
    private int proxyType;
    // 代理服务器地址
    private InetSocketAddress proxyAddress;
    // 代理服务器验证用户名，null表示不需要验证
    private String proxyUsername;
    // 代理服务器验证密码
    private String proxyPassword;
    // 是否打开了机器人功能
    private boolean robotMode;
    // 机器人实例
    private IRobot robot;
    
    // 是否监听器有改变，这是为了处理同步问题而设置的，在实际fireQQEvent时，
    // 不使用qqListeners，而是用backup，这样在事件触发期间如果要修改
    // 监听器也是可以的，不然有可能造成并发修改异常。如果有更好的办法当
    // 然，目前只想出这种办法
    private boolean listenerChanged;   
    
    /** 
     * 单线程执行器
     */
    protected static final SingleExecutor executor = new SingleExecutor();
    /** 包事件触发过程 */
    protected Callable<Object> packetEventTrigger;
    /** 重发过程 */
    protected ResendTrigger<Object> resendTrigger;
    /** Keep Alive过程 */
    protected Runnable keepAliveTrigger;
    protected ScheduledFuture keepAliveFuture;

	/** 接收队列 */
	protected Queue<InPacket> receiveQueue;	
	/** 输入包和port的映射，用来判断一个包来自于哪个port */
	protected Map<InPacket, String> inConn;
	
	/** 包处理器数目 */
	protected static final int PROCESSOR_COUNT = 4;

    /**
     * 构造函数
     */
    public QQClient() {
        qqListeners = new Vector<IQQListener>();    
        qqListenersBackup = new Vector<IQQListener>();
        receiveQueue = new LinkedList<InPacket>();
        logging = false;
        loginRedirect = false;
        robotMode = false;
        listenerChanged = false;
        qqListeners.add(this);
        qqListenersBackup.add(this);
        packetEventTrigger = new PacketEventTrigger<Object>(this);
        keepAliveTrigger = new KeepAliveTrigger(this);
        resendTrigger = new ResendTrigger<Object>(this);
        inConn = new HashMap<InPacket, String>();
        policyFactory = new ConnectionPolicyFactory();
        
        router = new ProcessorRouter(this, PROCESSOR_COUNT);
        router.installProcessor(new BasicFamilyProcessor(this));
        router.installProcessor(new _05FamilyProcessor(this));
        router.installProcessor(new _03FamilyProcessor(this));
        router.installProcessor(new DiskFamilyProcessor(this));
        
        executor.increaseClient();
    }
    
    /**
     * 得到和某个输入包相关的端口策略 
     * 
     * @param in
     * 		回复包
     * @return
     * 		连接策略对象
     */
    public synchronized IConnectionPolicy getConnectionPolicy(InPacket in) {
    	String id = inConn.remove(in);
    	IConnection con = getConnection(id);
    	if(con == null)
    		return null;
    	else
    		return con.getPolicy();
    }

    /**
     * 设置代理类型
     * @param type
     */
    public void setProxyType(String type) {
        if(type.equalsIgnoreCase("Socks5"))
            proxyType = QQ.QQ_PROXY_SOCKS5;
        else if(type.equalsIgnoreCase("Http"))
            proxyType = QQ.QQ_PROXY_HTTP;
        else
            proxyType = QQ.QQ_PROXY_NONE;
    }
    
    /**
     * @return
     * 		代理类型
     */
    public int getProxyType() {
    	return proxyType;
    }
    
    /**
     * 设置代理服务器地址
     * @param proxyAddress
     */
    public void setProxy(InetSocketAddress proxyAddress) {
        this.proxyAddress = proxyAddress;
    }
    
    /**
     * 发送keep alive包
     */
    public void keepAlive() {
        if(user.isLoggedIn()) {
			KeepAlivePacket packet = new KeepAlivePacket(user);
			pool.send(QQPort.MAIN.name, packet, false);
        }
    }
    
    /**
     * 共享我的地理位置
     */
    public void shareMyGeography() {
    	if(user.isLoggedIn()) {
    		PrivacyDataOpPacket packet = new PrivacyDataOpPacket(user);
    		packet.setSubCommand(QQ.QQ_SUB_CMD_SHARE_GEOGRAPHY);
    		packet.setOpCode(QQ.QQ_VALUE_SET);
    		pool.send(QQPort.MAIN.name, packet, false);
    	}
    }
    
    /**
     * 不共享我的地理位置
     */
    public void unshareMyGeography() {
    	if(user.isLoggedIn()) {
    		PrivacyDataOpPacket packet = new PrivacyDataOpPacket(user);
    		packet.setSubCommand(QQ.QQ_SUB_CMD_SHARE_GEOGRAPHY);
    		packet.setOpCode(QQ.QQ_VALUE_UNSET);
    		pool.send(MAIN.name, packet, false);
    	}
    }
    
    /**
     * 设置仅能通过QQ号找到我
     */
    public void setSearchMeByQQOnly() {
    	if(user.isLoggedIn()) {
    		PrivacyDataOpPacket packet = new PrivacyDataOpPacket(user);
    		packet.setSubCommand(QQ.QQ_SUB_CMD_SEARCH_ME_BY_QQ_ONLY);
    		packet.setOpCode(QQ.QQ_VALUE_SET);
    		pool.send(MAIN.name, packet, false);
    	}
    }
    
    /**
     * 取消设置仅能通过QQ号找到我
     */
    public void unsetSearchMeByQQOnly() {
    	if(user.isLoggedIn()) {
    		PrivacyDataOpPacket packet = new PrivacyDataOpPacket(user);
    		packet.setSubCommand(QQ.QQ_SUB_CMD_SEARCH_ME_BY_QQ_ONLY);
    		packet.setOpCode(QQ.QQ_VALUE_UNSET);
    		pool.send(MAIN.name, packet, false);
    	}
    }
    
    /**
     * 请求天气预报
     * 
     * @param ip
     */
    public char getWeather(byte[] ip) {
    	if(user.isLoggedIn()) {
    		WeatherOpPacket packet = new WeatherOpPacket(user);
    		packet.setIp(ip);
    		pool.send(MAIN.name, packet, false);
    		return packet.getSequence();
    	}
    	return 0;
    }
    
    /**
     * 请求自己这里的天气预报
     * 
     * @param ip
     */
    public char getWeather() {
    	if(user.isLoggedIn()) {
    		WeatherOpPacket packet = new WeatherOpPacket(user);
    		packet.setIp(user.getIp());
    		pool.send(MAIN.name, packet, false);
    		return packet.getSequence();
    	}
    	return 0;
    }
    
    /**
     * 上传好友备注信息
     * 
     * @param qqNum 
     * 		好友的QQ号
     * @param remark
     * 		备注类
     */
    public void uploadFriendRemark(int qqNum, FriendRemark remark) {
    	if(user.isLoggedIn()) {
    		FriendDataOpPacket packet = new FriendDataOpPacket(user);
    		packet.setRemark(remark);
    		packet.setQQ(qqNum);
    		pool.send(MAIN.name, packet, true);	
    	}
    }
    
    /**
     * 下载好友备注信息
     * 
     * @param qqNum 
     * 		好友的QQ号
     */
    public void downloadFriendRemark(int qqNum) {
    	if(user.isLoggedIn()) {
    		FriendDataOpPacket packet = new FriendDataOpPacket(user);
    		packet.setSubCommand(QQ.QQ_SUB_CMD_DOWNLOAD_FRIEND_REMARK);
    		packet.setQQ(qqNum);
    		pool.send(MAIN.name, packet, false);	
    	}
    }
    
    /**
     * 批量下载好友备注