/*
* 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 3 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, see <http://www.gnu.org/licenses/>.
*/
package net.sf.l2j.gameserver.network;
import java.net.InetAddress;
import java.nio.ByteBuffer;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.Future;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.locks.ReentrantLock;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.sf.l2j.Config;
import net.sf.l2j.L2DatabaseFactory;
import net.sf.l2j.gameserver.LoginServerThread;
import net.sf.l2j.gameserver.LoginServerThread.SessionKey;
import net.sf.l2j.gameserver.ThreadPoolManager;
import net.sf.l2j.gameserver.datatables.CharNameTable;
import net.sf.l2j.gameserver.datatables.ClanTable;
import net.sf.l2j.gameserver.model.CharSelectInfoPackage;
import net.sf.l2j.gameserver.model.L2Clan;
import net.sf.l2j.gameserver.model.L2World;
import net.sf.l2j.gameserver.model.actor.instance.L2PcInstance;
import net.sf.l2j.gameserver.network.serverpackets.ActionFailed;
import net.sf.l2j.gameserver.network.serverpackets.L2GameServerPacket;
import net.sf.l2j.gameserver.network.serverpackets.ServerClose;
import net.sf.l2j.gameserver.util.FloodProtectors;
import net.sf.l2j.protection.CatsGuard;
import org.mmocore.network.MMOClient;
import org.mmocore.network.MMOConnection;
import org.mmocore.network.ReceivablePacket;
/**
* Represents a client connected on Game Server
* @author KenM
*/
public final class L2GameClient extends MMOClient<MMOConnection<L2GameClient>> implements Runnable
{
protected static final Logger _log = Logger.getLogger(L2GameClient.class.getName());
public static enum GameClientState
{
CONNECTED, // client has just connected
AUTHED, // client has authed but doesnt has character attached to it yet
IN_GAME // client has selected a char and is in game
};
public GameClientState _state;
// Info
private String _accountName;
private SessionKey _sessionId;
private L2PcInstance _activeChar;
private final ReentrantLock _activeCharLock = new ReentrantLock();
@SuppressWarnings("unused")
private boolean _isAuthedGG;
private final long _connectionStartTime;
private CharSelectInfoPackage[] _charSlotMapping = null;
// floodprotectors
private final FloodProtectors _floodProtectors = new FloodProtectors(this);
_crypt = new GameCrypt();
// Task
protected final ScheduledFuture<?> _autoSaveInDB;
protected ScheduledFuture<?> _cleanupTask = null;
public GameCrypt _crypt;
private String _hwid = null;
public IExReader _reader;
private final ClientStats _stats;
private boolean _isDetached = false;
private final ArrayBlockingQueue<ReceivablePacket<L2GameClient>> _packetQueue;
private final ReentrantLock _queueLock = new ReentrantLock();
public L2GameClient(MMOConnection<L2GameClient> con)
{
super(con);
_state = GameClientState.CONNECTED;
_connectionStartTime = System.currentTimeMillis();
_crypt = new GameCrypt();
_stats = new ClientStats();
_packetQueue = new ArrayBlockingQueue<>(Config.CLIENT_PACKET_QUEUE_SIZE);
_autoSaveInDB = ThreadPoolManager.getInstance().scheduleGeneralAtFixedRate(new AutoSaveTask(), 300000L, 900000L);
}
public byte[] enableCrypt()
{
byte[] key = BlowFishKeygen.getRandomKey();
_crypt.setKey(key);
return key;
}
public GameClientState getState()
{
return _state;
}
public void setState(GameClientState pState)
{
if (_state != pState)
{
_state = pState;
_packetQueue.clear();
}
}
public ClientStats getStats()
{
return _stats;
}
public long getConnectionStartTime()
{
return _connectionStartTime;
}
@Override
public boolean decrypt(ByteBuffer buf, int size)
{
_crypt.decrypt(buf.array(), buf.position(), size);
return true;
}
@Override
public boolean encrypt(final ByteBuffer buf, final int size)
{
_crypt.encrypt(buf.array(), buf.position(), size);
buf.position(buf.position() + size);
return true;
}
public L2PcInstance getActiveChar()
{
return _activeChar;
}
public void setActiveChar(L2PcInstance pActiveChar)
{
activeChar = pActiveChar;
if ((_reader != null) && (activeChar != null))
{
_reader.checkChar(activeChar);
L2World.getInstance().storeObject(getActiveChar());
}
}
public ReentrantLock getActiveCharLock()
{
return _activeCharLock;
}
public FloodProtectors getFloodProtectors()
{
return _floodProtectors;
}
public void setGameGuardOk(boolean val)
{
_isAuthedGG = val;
}
public void setAccountName(String pAccountName)
{
_accountName = pAccountName;
if (_reader == null)
CatsGuard.getInstance().initSession(this);
}
public String getAccountName()
{
return _accountName;
if (this._reader != null)
CatsGuard.getInstance().doneSession(this);
}
public void setSessionId(SessionKey sk)
{
_sessionId = sk;
}
public SessionKey getSessionId()
{
return _sessionId;
}
public void sendPacket(L2GameServerPacket gsp)
{
if (_isDetached)
return;
getConnection().sendPacket(gsp);
gsp.runImpl();
}
public boolean isDetached()
{
return _isDetached;
}
public void setDetached(boolean
{
_isDetached = b;
}
/**
* Method to handle character deletion
* @param charslot The slot to check.
* @return a byte: <li>-1: Error: No char was found for such charslot, caught exception, etc... <li>0: character is not member of any clan, proceed with deletion <li>1: character is member of a clan, but not clan leader <li>2: character is clan leader
*/
public byte markToDeleteChar(int charslot)
{
int objid = getObjectIdForSlot(charslot);
if (objid < 0)
return -1;
try (Connection con = L2DatabaseFactory.getInstance().getConnection())
{
PreparedStatement statement = con.prepareStatement("SELECT clanId FROM characters WHERE obj_id=?");
statement.setInt(1, objid);
ResultSet rs = statement.executeQuery();
rs.next();
int clanId = rs.getInt(1);
byte answer = 0;
if (clanId != 0)
{
L2Clan clan = ClanTable.getInstance().getClan(clanId);
if (clan == null)
answer = 0; // jeezes!
else if (clan.getLeaderId() == objid)
answer = 2;
else
answer = 1;
}
rs.close();
statement.close();
// Setting delete time
if (answer == 0)
{
if (Config.DELETE_DAYS == 0)
deleteCharByObjId(objid);
else
{
statement = con.prepareStatement("UPDATE characters SET deletetime=? WHERE obj_id=?");
statement.setLong(1, System.currentTimeMillis() + Config.DELETE_DAYS * 86400000L); // 24*60*60*1000 = 86400000
statement.setInt(2, objid);
statement.execute();
statement.close();
}
}
return answer;
}
catch (Exception e)
{
_log.log(Level.SEVERE, "Error updating delete time of character.", e);
return -1;
}
}
public void markRestoredChar(int charslot)
{
final int objid = getObjectIdForSlot(charslot);
if (objid < 0)
return;
try (Connection con = L2DatabaseFactory.getInstance().getConnection())
{
PreparedStatement statement = con.prepareStatement("UPDATE characters SET deletetime=0 WHERE obj_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
}
catch (Exception e)
{
_log.log(Level.SEVERE, "Error restoring character.", e);
}
}
public static void deleteCharByObjId(int objid)
{
if (objid < 0)
return;
CharNameTable.getInstance().removeName(objid);
try (Connection con = L2DatabaseFactory.getInstance().getConnection())
{
PreparedStatement statement;
statement = con.prepareStatement("DELETE FROM character_friends WHERE char_id=? OR friend_id=?");
statement.setInt(1, objid);
statement.setInt(2, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_hennas WHERE char_obj_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_macroses WHERE char_obj_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_quests WHERE charId=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_recipebook WHERE char_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_shortcuts WHERE char_obj_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_skills WHERE char_obj_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_skills_save WHERE char_obj_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_subclasses WHERE char_obj_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM heroes WHERE char_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM olympiad_nobles WHERE char_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM seven_signs WHERE char_obj_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM pets WHERE item_obj_id IN (SELECT object_id FROM items WHERE items.owner_id=?)");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM augmentations WHERE item_id IN (SELECT object_id FROM items WHERE items.owner_id=?)");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM items WHERE owner_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM character_raid_points WHERE char_id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
statement = con.prepareStatement("DELETE FROM characters WHERE obj_Id=?");
statement.setInt(1, objid);
statement.execute();
statement.close();
}
catch (Exception e)
{
_log.log(Level.SEVERE, "Error deleting character.", e);
}
}
public L2PcInstance loadCharFromDisk(int charslot)
{
final int objId = getObjectIdForSlot(charslot);
if (objId < 0)
return null;
L2PcInstance character = L2World.getInstance().getPlayer(objId);
if (character != null)
{
// exploit prevention, should not happens in normal way
_log.severe("Attempt of double login: " + character.getName() + "(" + objId + ") " + getAccountName());
if (character.getClient() != null)
character.getClient().closeNow();
else
character.deleteMe();
return null;
}
character = L2PcInstance.restore(objId);
if (character != null)
{
character.setRunning(); // running is default
character.standUp(); // standing is default
character.refreshOverloaded();
character.refreshExpertisePenalty();
character.setOnlineStatus(true, false);
}
else
{
_log.severe("could not restore in slot: " + charslot);
}
return character;
}
/**
* @param chars
*/
public void setCharSelection(CharSelectInfoPackage[] chars)
{
_charSlotMapping = chars;
}
public CharSelectInfoPackage getCharSelection(int charslot)
{
if ((_charSlotMapping == null) || (charslot < 0) || (charslot >= _charSlotMapping.length))
return null;
return _charSlotMapping[charslot];
}
public void close(L2GameServerPacket gsp)
{
getConnection().close(gsp);
}
/**
* @param charslot
* @return
*/
private int getObjectIdForSlot(int charslot)
{
final CharSelectInfoPackage info = getCharSelection(charslot);
if (info == null)
{
_log.warning(toString() + " tried to delete Character in slot " + charslot + " but no characters exits at that slot.");
return -1;
}
return info.getObjectId();
}
@Override
protected void onForcedDisconnection()
{
_log.fine("Client " + toString() + " disconnected abnormally.");
}
@Override
protected void onDisconnection()
{
// no long running tasks here, do it async
try
{
ThreadPoolManager.getInstance().executeTask(new DisconnectTask());
}
catch (RejectedExecutionException e)
{
// server is closing
}
}
/**
* Close client connection with {@link ServerClose} packet
*/
public void closeNow()
{
_isDetached = true; // prevents more packets execution
close(ServerClose.STATIC_PACKET);
synchronized (this)
{
if (_cleanupTask != null)
cancelCleanup();
_cleanupTask = ThreadPoolManager.getInstance().scheduleGeneral(new CleanupTask(), 0); // instant
}
}
/**
* Produces the best possible string representation of this client.
*/
@Override
public String toString()
{
try
{
final InetAddress address = getConnection().getInetAddress();
switch (getState())
{
case CONNECTED:
return "[iP: " + (address == null ? "disconnected" : address.getHostAddress()) + "]";
case AUTHED:
return "[Account: " + getAccountName() + " - IP: " + (address == null ? "disconnected" : address.getHostAddress()) + "]";
case IN_GAME:
return "[Character: " + (getActiveChar() == null ? "disconnected" : getActiveChar().getName()) + " - Account: " + getAccountName() + " - IP: " + (address == null ? "disconnected" : address.getHostAddress()) + "]";
default:
throw new IllegalStateException("Missing state on switch");
}
}
catch (NullPointerException e)
{
return "[Character read failed due to disconnect]";
}
}
protected class DisconnectTask implements Runnable
{
/**
* @see java.lang.Runnable#run()
*/
@Override
public void run()
{
boolean fast = true;
try
{
if (getActiveChar() != null && !isDetached())
{
setDetached(true);
fast = !getActiveChar().isInCombat() && !getActiveChar().isLocked();
}
cleanMe(fast);
}
catch (Exception e1)
{
_log.log(Level.WARNING, "error while disconnecting client", e1);
}
}
}
public void cleanMe(boolean fast)
{
try
{
synchronized (this)
{
if (_cleanupTask == null)
_cleanupTask = ThreadPoolManager.getInstance().scheduleGeneral(new CleanupTask(), fast ? 5 : 15000L);
}
}
catch (Exception e1)
{
_log.log(Level.WARNING, "Error during cleanup.", e1);
}
}
protected class CleanupTask implements Runnable
{
/**
* @see java.lang.Runnable#run()
*/
@Override
public void run()
{
try
{
// we are going to manually save the char below thus we can force the cancel
if (_autoSaveInDB != null)
_autoSaveInDB.cancel(true);
if (getActiveChar() != null) // this should only happen on connection loss
{
if (getActiveChar().isLocked())
_log.log(Level.WARNING, getActiveChar().getName() + " is still performing subclass actions during disconnect.");
// prevent closing again
getActiveChar().setClient(null);
if (getActiveChar().isOnline())
getActiveChar().deleteMe();
}
setActiveChar(null);
}
catch (Exception e1)
{
_log.log(Level.WARNING, "Error while cleanup client.", e1);
}
finally
{
LoginServerThread.getInstance().sendLogout(getAccountName());
}
}
}
protected class AutoSaveTask implements Runnable
{
@Override
public void run()
{
try
{
if (getActiveChar() != null && getActiveChar().isOnline())
{
getActiveChar().store();
if (getActiveChar().getPet() != null)
getActiveChar().getPet().store();
}
}
catch (Exception e)
{
_log.log(Level.SEVERE, "Error on AutoSaveTask.", e);
}
}
}
/**
* @return false if client can receive packets. True if detached, or flood detected, or queue overflow detected and queue still not empty.
*/
public boolean dropPacket()
{
if (_isDetached) // detached clients can't receive any packets
return true;
// flood protection
if (getStats().countPacket(_packetQueue.size()))
{
sendPacket(ActionFailed.STATIC_PACKET);
return true;
}
return getStats().dropPacket();
}
/**
* Counts buffer underflow exceptions.
*/
public void onBufferUnderflow()
{
if (getStats().countUnderflowException())
{
_log.severe("Client " + toString() + " - Disconnected: Too many buffer underflow exceptions.");
closeNow();
return;
}
if (_state == GameClientState.CONNECTED) // in CONNECTED state kick client immediately
{
if (Config.PACKET_HANDLER_DEBUG)
_log.severe("Client " + toString() + " - Disconnected, too many buffer underflows in non-authed state.");
closeNow();
}
}
/**
* Counts unknown packets
*/
public void onUnknownPacket()
{
if (getStats().countUnknownPacket())
{
_log.severe("Client " + toString() + " - Disconnected: Too many unknown packets.");
closeNow();
return;
}
if (_state == GameClientState.CONNECTED) // in CONNECTED state kick client immediately
{
if (Config.PACKET_HANDLER_DEBUG)
_log.severe("Client " + toString() + " - Disconnected, too many unknown packets in non-authed state.");
closeNow();
}
}
/**
* Add packet to the queue and start worker thread if needed
* @param packet The packet to execute.
*/
public void execute(ReceivablePacket<L2GameClient> packet)
{
if (getStats().countFloods())
{
_log.severe("Client " + toString() + " - Disconnected, too many floods:" + getStats().longFloods + " long and " + getStats().shortFloods + " short.");
closeNow();
return;
}
if (!_packetQueue.offer(packet))
{
if (getStats().countQueueOverflow())
{
_log.severe("Client " + toString() + " - Disconnected, too many queue overflows.");
closeNow();
}
else
sendPacket(ActionFailed.STATIC_PACKET);
return;
}
if (_queueLock.isLocked()) // already processing
return;
try
{
if (_state == GameClientState.CONNECTED)
{
if (getStats().processedPackets > 3)
{
if (Config.PACKET_HANDLER_DEBUG)
_log.severe("Client " + toString() + " - Disconnected, too many packets in non-authed state.");
closeNow();
return;
}
ThreadPoolManager.getInstance().executeIOPacket(this);
}
else
ThreadPoolManager.getInstance().executePacket(this);
}
catch (RejectedExecutionException e)
{
// if the server is shutdown we ignore
if (!ThreadPoolManager.getInstance().isShutdown())
{
_log.severe("Failed executing: " + packet.getClass().getSimpleName() + " for Client: " + toString());
}
}
}
@Override
public void run()
{
if (!_queueLock.tryLock())
return;
try
{
int count = 0;
ReceivablePacket<L2GameClient> packet;
while (true)
{
packet = _packetQueue.poll();
if (packet == null) // queue is empty
return;
if (_isDetached) // clear queue immediately after detach
{
_packetQueue.clear();
return;
}
try
{
packet.run();
}
catch (Exception e)
{
_log.severe("Exception during execution " + packet.getClass().getSimpleName() + ", client: " + toString() + "," + e.getMessage());
}
count++;
if (getStats().countBurst(count))
return;
}
}
finally
{
_queueLock.unlock();
}
}
private boolean cancelCleanup()
{
final Future<?> task = _cleanupTask;
if (task != null)
{
_cleanupTask = null;
return task.cancel(true);
}
return false;
}
public void setHWID(String hwid)
{
this._hwid = hwid;
}
public String getHWid()
{
return this._hwid;
}
public static abstract interface IExReader
{
public abstract int read(ByteBuffer paramByteBuffer);
public abstract void checkChar(L2PcInstance paramL2PcInstance);
}
}
