1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528 |
- /*
- * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
- package com.dmdirc;
-
- import com.dmdirc.actions.ActionManager;
- import com.dmdirc.actions.CoreActionType;
- import com.dmdirc.actions.wrappers.AliasWrapper;
- import com.dmdirc.commandparser.CommandManager;
- import com.dmdirc.commandparser.CommandType;
- import com.dmdirc.config.ConfigManager;
- import com.dmdirc.config.Identity;
- import com.dmdirc.config.IdentityManager;
- import com.dmdirc.interfaces.AwayStateListener;
- import com.dmdirc.interfaces.InviteListener;
- import com.dmdirc.logger.ErrorLevel;
- import com.dmdirc.logger.Logger;
- import com.dmdirc.parser.irc.ChannelInfo;
- import com.dmdirc.parser.irc.ClientInfo;
- import com.dmdirc.parser.irc.IRCParser;
- import com.dmdirc.parser.irc.IRCStringConverter;
- import com.dmdirc.parser.irc.MyInfo;
- import com.dmdirc.parser.irc.ParserError;
- import com.dmdirc.parser.irc.ServerInfo;
- import com.dmdirc.ui.WindowManager;
- import com.dmdirc.ui.input.TabCompleter;
- import com.dmdirc.ui.input.TabCompletionType;
- import com.dmdirc.ui.interfaces.InputWindow;
- import com.dmdirc.ui.interfaces.ServerWindow;
- import com.dmdirc.ui.interfaces.Window;
-
- import java.io.Serializable;
- import java.util.ArrayList;
- import java.util.Hashtable;
- import java.util.List;
- import java.util.Map;
- import java.util.Timer;
- import java.util.TimerTask;
- import javax.net.ssl.TrustManager;
-
- /**
- * The Server class represents the client's view of a server. It maintains
- * a list of all channels, queries, etc, and handles parser callbacks pertaining
- * to the server.
- *
- * @author chris
- */
- public final class Server extends WritableFrameContainer implements Serializable {
-
- /**
- * A version number for this class. It should be changed whenever the class
- * structure is changed (or anything else that would prevent serialized
- * objects being unserialized with the new class).
- */
- private static final long serialVersionUID = 1;
-
- /** The name of the general domain. */
- private static final String DOMAIN_GENERAL = "general".intern();
- /** The name of the profile domain. */
- private static final String DOMAIN_PROFILE = "profile".intern();
- /** The name of the server domain. */
- private static final String DOMAIN_SERVER = "server".intern();
-
- /** Open channels that currently exist on the server. */
- private final Map<String, Channel> channels = new Hashtable<String, Channel>();
- /** Open query windows on the server. */
- private final List<Query> queries = new ArrayList<Query>();
-
- /** The IRC Parser instance handling this server. */
- private transient IRCParser parser;
- /** The raw frame used for this server instance. */
- private Raw raw;
- /** The ServerWindow corresponding to this server. */
- private ServerWindow window;
-
- /** The details of the server we're connecting to. */
- private ServerInfo serverInfo;
-
- /** The profile we're using. */
- private transient Identity profile;
-
- /** The current state of this server. */
- private final ServerStatus myState = new ServerStatus();
-
- /** The timer we're using to delay reconnects. */
- private Timer reconnectTimer;
-
- /** Channels we're meant to auto-join. */
- private final List<String> autochannels;
-
- /** The tabcompleter used for this server. */
- private final TabCompleter tabCompleter = new TabCompleter();
- /** The last activated internal frame for this server. */
- private FrameContainer activeFrame = this;
-
- /** Our reason for being away, if any. */
- private String awayMessage;
-
- /** Our event handler. */
- private final ServerEventHandler eventHandler = new ServerEventHandler(this);
-
- /** A list of outstanding invites. */
- private final List<Invite> invites = new ArrayList<Invite>();
-
- /** Our ignore list. */
- private final IgnoreList ignoreList = new IgnoreList();
-
- /** Our string convertor. */
- private IRCStringConverter converter = new IRCStringConverter();
-
- /** The parser factory to use. */
- private final ParserFactory parserFactory;
-
- /**
- * Creates a new instance of Server. Does not auto-join any channels, and
- * uses a default {@link ParserFactory}.
- *
- * @param server The hostname/ip of the server to connect to
- * @param port The port to connect to
- * @param password The server password
- * @param ssl Whether to use SSL or not
- * @param profile The profile to use
- */
- public Server(final String server, final int port, final String password,
- final boolean ssl, final Identity profile) {
- this(server, port, password, ssl, profile, new ArrayList<String>());
- }
-
- /**
- * Creates a new instance of Server. Uses a default {@link ParserFactory}.
- *
- * @param server The hostname/ip of the server to connect to
- * @param port The port to connect to
- * @param password The server password
- * @param ssl Whether to use SSL or not
- * @param profile The profile to use
- * @param autochannels A list of channels to auto-join when we connect
- */
- public Server(final String server, final int port, final String password,
- final boolean ssl, final Identity profile, final List<String> autochannels) {
- this(server, port, password, ssl, profile, autochannels, new ParserFactory());
- }
-
- /**
- * Creates a new instance of Server.
- *
- * @since 0.6
- * @param server The hostname/ip of the server to connect to
- * @param port The port to connect to
- * @param password The server password
- * @param ssl Whether to use SSL or not
- * @param profile The profile to use
- * @param autochannels A list of channels to auto-join when we connect
- * @param factory The {@link ParserFactory} to use to create parsers
- */
- public Server(final String server, final int port, final String password,
- final boolean ssl, final Identity profile,
- final List<String> autochannels, final ParserFactory factory) {
- super("server-disconnected", new ConfigManager("", "", server));
-
- serverInfo = new ServerInfo(server, port, password);
- serverInfo.setSSL(ssl);
-
- window = Main.getUI().getServer(this);
-
- ServerManager.getServerManager().registerServer(this);
- WindowManager.addWindow(window);
-
- window.setTitle(server + ":" + port);
-
- tabCompleter.addEntries(TabCompletionType.COMMAND,
- AliasWrapper.getAliasWrapper().getAliases());
- window.getInputHandler().setTabCompleter(tabCompleter);
-
- updateIcon();
-
- window.open();
-
- tabCompleter.addEntries(TabCompletionType.COMMAND,
- CommandManager.getCommandNames(CommandType.TYPE_SERVER));
- tabCompleter.addEntries(TabCompletionType.COMMAND,
- CommandManager.getCommandNames(CommandType.TYPE_GLOBAL));
-
- this.autochannels = autochannels;
- this.parserFactory = factory;
-
- new Timer("Server Who Timer").schedule(new TimerTask() {
- @Override
- public void run() {
- for (Channel channel : channels.values()) {
- channel.checkWho();
- }
- }
- }, 0, getConfigManager().getOptionInt(DOMAIN_GENERAL, "whotime", 60000));
-
- if (getConfigManager().getOptionBool(DOMAIN_GENERAL, "showrawwindow", false)) {
- addRaw();
- }
-
- connect(server, port, password, ssl, profile);
- }
-
- // ------------------------ CONNECTION, DISCONNECTION AND RECONNECTION -----
-
- /**
- * Connects to a new server with the specified details.
- *
- * @param server The hostname/ip of the server to connect to
- * @param port The port to connect to
- * @param password The server password
- * @param ssl Whether to use SSL or not
- * @param profile The profile to use
- */
- @Precondition({
- "The IRC Parser is null or not connected",
- "The specified profile is not null"
- })
- public void connect(final String server, final int port, final String password,
- final boolean ssl, final Identity profile) {
- assert profile != null;
-
- synchronized (this) {
- switch (myState.getState()) {
- case RECONNECT_WAIT:
- reconnectTimer.cancel();
- break;
- case CLOSING:
- // Ignore the connection attempt
- return;
- case CONNECTED:
- case CONNECTING:
- addLine("serverConnectInProgress");
- disconnect(getConfigManager().getOption(DOMAIN_GENERAL, "quitmessage"));
- return;
- case DISCONNECTING:
- addLine("serverDisconnectInProgress");
- return;
- default:
- // Do nothing
- break;
- }
-
- if (parser != null) {
- throw new IllegalArgumentException("Connection attempt while parser "
- + "is still connected.\n\nMy state:" + getState());
- }
-
- myState.transition(ServerState.CONNECTING);
-
- ActionManager.processEvent(CoreActionType.SERVER_CONNECTING, null, this);
-
- getConfigManager().migrate("", "", server);
-
- serverInfo = new ServerInfo(server, port, password);
- serverInfo.setSSL(ssl);
-
- if (getConfigManager().hasOption(DOMAIN_SERVER, "proxy.address")) {
- serverInfo.setUseSocks(true);
-
- serverInfo.setProxyHost(getConfigManager()
- .getOption(DOMAIN_SERVER, "proxy.address"));
- serverInfo.setProxyUser(getConfigManager()
- .getOption(DOMAIN_SERVER, "proxy.user", ""));
- serverInfo.setProxyPass(getConfigManager()
- .getOption(DOMAIN_SERVER, "proxy.password", ""));
- serverInfo.setProxyPort(getConfigManager()
- .getOptionInt(DOMAIN_SERVER, "proxy.port", 1080));
- }
-
- this.profile = profile;
-
- updateIcon();
-
- addLine("serverConnecting", server, port);
-
- final MyInfo myInfo = getMyInfo();
-
- CertificateManager certManager
- = new CertificateManager(server, getConfigManager());
-
- parser = parserFactory.getParser(myInfo, serverInfo);
- parser.setTrustManager(new TrustManager[]{certManager});
- parser.setKeyManagers(certManager.getKeyManager());
- parser.setRemoveAfterCallback(true);
- parser.setCreateFake(true);
- parser.setIgnoreList(ignoreList);
-
- if (getConfigManager().hasOption(DOMAIN_GENERAL, "bindip")) {
- parser.setBindIP(getConfigManager().getOption(DOMAIN_GENERAL, "bindip"));
- }
-
- doCallbacks();
-
- awayMessage = null;
- removeInvites();
- window.setAwayIndicator(false);
-
- try {
- new Thread(parser, "IRC Parser thread").start();
- } catch (IllegalThreadStateException ex) {
- Logger.appError(ErrorLevel.FATAL, "Unable to start IRC Parser", ex);
- }
- }
- }
-
- /**
- * Reconnects to the IRC server with a specified reason.
- *
- * @param reason The quit reason to send
- */
- public void reconnect(final String reason) {
- synchronized (this) {
- if (myState.getState() == ServerState.CLOSING) {
- return;
- }
-
- disconnect(reason);
- connect(serverInfo.getHost(), serverInfo.getPort(),
- serverInfo.getPassword(), serverInfo.getSSL(), profile);
- }
- }
-
- /**
- * Reconnects to the IRC server.
- */
- public void reconnect() {
- reconnect(getConfigManager().getOption(DOMAIN_GENERAL, "reconnectmessage"));
- }
-
- /**
- * Disconnects from the server with the default quit message.
- */
- public void disconnect() {
- disconnect(getConfigManager().getOption(DOMAIN_GENERAL, "quitmessage"));
- }
-
- /**
- * Disconnects from the server.
- *
- * @param reason disconnect reason
- */
- public void disconnect(final String reason) {
- synchronized (this) {
- switch (myState.getState()) {
- case CLOSING:
- case DISCONNECTING:
- case DISCONNECTED:
- case TRANSIENTLY_DISCONNECTED:
- return;
- case RECONNECT_WAIT:
- reconnectTimer.cancel();
- break;
- default:
- break;
- }
-
- if (parser == null) {
- myState.transition(ServerState.DISCONNECTED);
- } else {
- myState.transition(ServerState.DISCONNECTING);
-
- removeInvites();
- updateIcon();
-
- parser.disconnect(reason);
- }
-
- if (getConfigManager().getOptionBool(DOMAIN_GENERAL,
- "closechannelsonquit", false)) {
- closeChannels();
- } else {
- clearChannels();
- }
-
- if (getConfigManager().getOptionBool(DOMAIN_GENERAL,
- "closequeriesonquit", false)) {
- closeQueries();
- }
- }
- }
-
- /**
- * Schedules a reconnect attempt to be performed after a user-defiend delay.
- */
- @Precondition("The server state is transiently disconnected")
- private void doDelayedReconnect() {
- synchronized (this) {
- if (myState.getState() != ServerState.TRANSIENTLY_DISCONNECTED) {
- throw new IllegalStateException("doDelayedReconnect when not "
- + "transiently disconnected\n\nState: " + myState);
- }
-
- final int delay = Math.max(1000,
- getConfigManager().getOptionInt(DOMAIN_GENERAL, "reconnectdelay", 5000));
-
- handleNotification("connectRetry", getName(), delay / 1000);
-
- reconnectTimer = new Timer("Server Reconnect Timer");
- reconnectTimer.schedule(new TimerTask() {
- @Override
- public void run() {
- synchronized (Server.this) {
- if (myState.getState() == ServerState.RECONNECT_WAIT) {
- myState.transition(ServerState.TRANSIENTLY_DISCONNECTED);
- reconnect();
- }
- }
- }
- }, delay);
-
- myState.transition(ServerState.RECONNECT_WAIT);
- updateIcon();
- }
- }
-
- // ------------------------------------------------- CHILDREN HANDLING -----
-
- /**
- * Determines whether the server knows of the specified channel.
- *
- * @param channel The channel to be checked
- * @return True iff the channel is known, false otherwise
- */
- public boolean hasChannel(final String channel) {
- return channels.containsKey(converter.toLowerCase(channel));
- }
-
- /**
- * Retrieves the specified channel belonging to this server.
- *
- * @param channel The channel to be retrieved
- * @return The appropriate channel object
- */
- public Channel getChannel(final String channel) {
- return channels.get(converter.toLowerCase(channel));
- }
-
- /**
- * Retrieves a list of channel names belonging to this server.
- *
- * @return list of channel names belonging to this server
- */
- public List<String> getChannels() {
- final ArrayList<String> res = new ArrayList<String>();
-
- for (String channel : channels.keySet()) {
- res.add(channel);
- }
-
- return res;
- }
-
- /**
- * Determines whether the server knows of the specified query.
- *
- * @param host The host of the query to look for
- * @return True iff the query is known, false otherwise
- */
- public boolean hasQuery(final String host) {
- final String nick = ClientInfo.parseHost(host);
-
- for (Query query : queries) {
- if (converter.equalsIgnoreCase(ClientInfo.parseHost(query.getHost()), nick)) {
- return true;
- }
- }
-
- return false;
- }
-
- /**
- * Retrieves the specified query belonging to this server.
- *
- * @param host The host of the query to look for
- * @return The appropriate query object
- */
- public Query getQuery(final String host) {
- final String nick = ClientInfo.parseHost(host);
-
- for (Query query : queries) {
- if (converter.equalsIgnoreCase(ClientInfo.parseHost(query.getHost()), nick)) {
- return query;
- }
- }
-
- throw new IllegalArgumentException("No such query: " + host);
- }
-
- /**
- * Retrieves a list of queries belonging to this server.
- *
- * @return list of queries belonging to this server
- */
- public List<Query> getQueries() {
- return new ArrayList<Query>(queries);
- }
-
- /**
- * Adds a raw window to this server.
- */
- public void addRaw() {
- if (raw == null) {
- raw = new Raw(this);
-
- if (parser != null) {
- raw.registerCallbacks();
- }
- } else {
- raw.activateFrame();
- }
- }
-
- /**
- * Retrieves the raw window associated with this server.
- *
- * @return The raw window associated with this server.
- */
- public Raw getRaw() {
- return raw;
- }
-
- /**
- * Removes our reference to the raw object (presumably after it has been
- * closed).
- */
- public void delRaw() {
- raw = null; //NOPMD
- }
-
- /**
- * Removes a specific channel and window from this server.
- *
- * @param chan channel to remove
- */
- public void delChannel(final String chan) {
- tabCompleter.removeEntry(TabCompletionType.CHANNEL, chan);
- channels.remove(converter.toLowerCase(chan));
- }
-
- /**
- * Adds a specific channel and window to this server.
- *
- * @param chan channel to add
- */
- public void addChannel(final ChannelInfo chan) {
- synchronized (this) {
- if (myState.getState() == ServerState.CLOSING) {
- // Can't join channels while the server is closing
- return;
- }
- }
-
- if (hasChannel(chan.getName())) {
- getChannel(chan.getName()).setChannelInfo(chan);
- getChannel(chan.getName()).selfJoin();
- } else {
- final Channel newChan = new Channel(this, chan);
-
- tabCompleter.addEntry(TabCompletionType.CHANNEL, chan.getName());
- channels.put(converter.toLowerCase(chan.getName()), newChan);
- newChan.show();
- }
- }
-
- /**
- * Adds a query to this server.
- *
- * @param host host of the remote client being queried
- */
- public void addQuery(final String host) {
- synchronized (this) {
- if (myState.getState() == ServerState.CLOSING) {
- // Can't open queries while the server is closing
- return;
- }
- }
-
- if (!hasQuery(host)) {
- final Query newQuery = new Query(this, host);
-
- tabCompleter.addEntry(TabCompletionType.QUERY_NICK, ClientInfo.parseHost(host));
- queries.add(newQuery);
- }
- }
-
- /**
- * Deletes a query from this server.
- *
- * @param query The query that should be removed.
- */
- public void delQuery(final Query query) {
- tabCompleter.removeEntry(TabCompletionType.QUERY_NICK, query.getNickname());
- queries.remove(query);
- }
-
- /** {@inheritDoc} */
- @Override
- public boolean ownsFrame(final Window target) {
- // Check if it's our server frame
- if (window != null && window.equals(target)) { return true; }
- // Check if it's the raw frame
- if (raw != null && raw.ownsFrame(target)) { return true; }
- // Check if it's a channel frame
- for (Channel channel : channels.values()) {
- if (channel.ownsFrame(target)) { return true; }
- }
- // Check if it's a query frame
- for (Query query : queries) {
- if (query.ownsFrame(target)) { return true; }
- }
- return false;
- }
-
- /**
- * Sets the specified frame as the most-recently activated.
- *
- * @param source The frame that was activated
- */
- public void setActiveFrame(final FrameContainer source) {
- activeFrame = source;
- }
-
- /**
- * Retrieves a list of all children of this server instance.
- *
- * @return A list of this server's children
- */
- public List<WritableFrameContainer> getChildren() {
- final List<WritableFrameContainer> res = new ArrayList<WritableFrameContainer>();
-
- if (raw != null) {
- res.add(raw);
- }
-
- res.addAll(channels.values());
- res.addAll(queries);
-
- return res;
- }
-
- // --------------------------------------------- MISCELLANEOUS METHODS -----
-
- /**
- * Updates this server's icon.
- */
- private void updateIcon() {
- final String icon = myState.getState() == ServerState.CONNECTED
- ? serverInfo.getSSL() ? "secure-server" : "server"
- : "server-disconnected";
- setIcon(icon);
- }
-
- /**
- * Retrieves the MyInfo object used for the IRC Parser.
- *
- * @return The MyInfo object for our profile
- */
- @Precondition({
- "The current profile is not null",
- "The current profile specifies at least one nickname"
- })
- private MyInfo getMyInfo() {
- Logger.assertTrue(profile != null);
- Logger.assertTrue(!profile.getOptionList(DOMAIN_PROFILE, "nicknames").isEmpty());
-
- final MyInfo myInfo = new MyInfo();
- myInfo.setNickname(profile.getOptionList(DOMAIN_PROFILE, "nicknames").get(0));
- myInfo.setRealname(profile.getOption(DOMAIN_PROFILE, "realname"));
-
- if (profile.hasOption(DOMAIN_PROFILE, "ident")) {
- myInfo.setUsername(profile.getOption(DOMAIN_PROFILE, "ident"));
- }
-
- return myInfo;
- }
-
- /**
- * Registers callbacks.
- */
- private void doCallbacks() {
- if (raw != null) {
- raw.registerCallbacks();
- }
-
- eventHandler.registerCallbacks();
-
- for (Query query : queries) {
- query.reregister();
- }
- }
-
- /**
- * Joins the specified channel, or adds it to the auto-join list if the
- * server is not connected.
- *
- * @param channel The channel to be joined
- */
- public void join(final String channel) {
- synchronized (this) {
- if (myState.getState() == ServerState.CONNECTED) {
- removeInvites(channel);
-
- if (hasChannel(channel)) {
- getChannel(channel).join();
- getChannel(channel).activateFrame();
- } else {
- parser.joinChannel(channel);
- }
- } else {
- autochannels.add(channel);
- }
- }
- }
-
- /** {@inheritDoc} */
- @Override
- public void sendLine(final String line) {
- synchronized (this) {
- if (parser != null && myState.getState() == ServerState.CONNECTED) {
- parser.sendLine(window.getTranscoder().encode(line));
- }
- }
- }
-
- /** {@inheritDoc} */
- @Override
- public int getMaxLineLength() {
- return IRCParser.MAX_LINELENGTH;
- }
-
- /**
- * Retrieves the parser used for this connection.
- *
- * @return IRCParser this connection's parser
- */
- public IRCParser getParser() {
- return parser;
- }
-
- /**
- * Retrieves the profile that's in use for this server.
- *
- * @return The profile in use by this server
- */
- public Identity getProfile() {
- return profile;
- }
-
- /**
- * Retrieves the name of this server.
- *
- * @return The name of this server
- */
- public String getName() {
- return serverInfo.getHost();
- }
-
- /**
- * Retrieves the name of this server's network. The network name is
- * determined using the following rules:
- *
- * 1. If the server includes its network name in the 005 information, we
- * use that
- * 2. If the server's name ends in biz, com, info, net or org, we use the
- * second level domain (e.g., foo.com)
- * 3. If the server's name contains more than two dots, we drop everything
- * up to and including the first part, and use the remainder
- * 4. In all other cases, we use the full server name
- *
- * @return The name of this server's network
- */
- public String getNetwork() {
- if (parser == null) {
- throw new IllegalStateException("getNetwork called when "
- + "parser is null (state: " + getState() + ")");
- } else if (parser.getNetworkName().length() == 0) {
- return getNetworkFromServerName(parser.getServerName());
- } else {
- return parser.getNetworkName();
- }
- }
-
- /**
- * Calculates a network name from the specified server name. This method
- * implements parts 2-4 of the procedure documented at getNetwork().
- *
- * @param serverName The server name to parse
- * @return A network name for the specified server
- */
- protected static String getNetworkFromServerName(final String serverName) {
- final String[] parts = serverName.split("\\.");
- final String[] tlds = {"biz", "com", "info", "net", "org"};
- boolean isTLD = false;
-
- for (String tld : tlds) {
- if (serverName.endsWith("." + tld)) {
- isTLD = true;
- }
- }
-
- if (isTLD && parts.length > 2) {
- return parts[parts.length - 2] + "." + parts[parts.length - 1];
- } else if (parts.length > 2) {
- final StringBuilder network = new StringBuilder();
-
- for (int i = 1; i < parts.length; i++) {
- if (network.length() > 0) {
- network.append('.');
- }
-
- network.append(parts[i]);
- }
-
- return network.toString();
- } else {
- return serverName;
- }
- }
-
- /**
- * Retrieves the name of this server's IRCd.
- *
- * @return The name of this server's IRCd
- */
- public String getIrcd() {
- return parser.getIRCD(true);
- }
-
- /**
- * Returns the current away status.
- *
- * @return True if the client is marked as away, false otherwise
- */
- public boolean isAway() {
- return awayMessage != null;
- }
-
- /**
- * Gets the current away message.
- *
- * @return Null if the client isn't away, or a textual away message if it is
- */
- public String getAwayMessage() {
- return awayMessage;
- }
-
- /**
- * Returns the tab completer for this connection.
- *
- * @return The tab completer for this server
- */
- public TabCompleter getTabCompleter() {
- return tabCompleter;
- }
-
- /** {@inheritDoc} */
- @Override
- public InputWindow getFrame() {
- return window;
- }
-
- /**
- * Retrieves the current state for this server.
- *
- * @return This server's state
- */
- public ServerState getState() {
- return myState.getState();
- }
-
- /**
- * Retrieves the status object for this server. Effecting state transitions
- * on the object returned by this method will almost certainly cause
- * problems.
- *
- * @since 0.6.3
- * @return This server's status object.
- */
- public ServerStatus getStatus() {
- return myState;
- }
-
- /** {@inheritDoc} */
- @Override
- public void windowClosing() {
- synchronized (this) {
- // 1: Make the window non-visible
- window.setVisible(false);
-
- // 2: Remove any callbacks or listeners
- eventHandler.unregisterCallbacks();
-
- // 3: Trigger any actions neccessary
- if (parser != null && parser.isReady()) {
- disconnect();
- }
-
- myState.transition(ServerState.CLOSING);
- closeChannels();
- closeQueries();
- removeInvites();
-
- if (raw != null) {
- raw.close();
- }
-
- // 4: Trigger action for the window closing
- // 5: Inform any parents that the window is closing
- ServerManager.getServerManager().unregisterServer(this);
-
- // 6: Remove the window from the window manager
- WindowManager.removeWindow(window);
-
- // 7: Remove any references to the window and parents
- window = null; //NOPMD
- parser = null; //NOPMD
- }
- }
-
- /**
- * Closes all open channel windows associated with this server.
- */
- private void closeChannels() {
- for (Channel channel : new ArrayList<Channel>(channels.values())) {
- channel.close();
- }
- }
-
- /**
- * Clears the nicklist of all open channels.
- */
- private void clearChannels() {
- for (Channel channel : channels.values()) {
- channel.resetWindow();
- }
- }
-
- /**
- * Closes all open query windows associated with this server.
- */
- private void closeQueries() {
- for (Query query : new ArrayList<Query>(queries)) {
- query.close();
- }
- }
-
- /**
- * Passes the arguments to the most recently activated frame for this
- * server. If the frame isn't know, or isn't visible, use this frame
- * instead.
- *
- * @param messageType The type of message to send
- * @param args The arguments for the message
- */
- public void addLineToActive(final String messageType, final Object... args) {
- if (activeFrame == null || !activeFrame.getFrame().isVisible()) {
- activeFrame = this;
- }
-
- activeFrame.getFrame().addLine(messageType, args);
- }
-
- /**
- * Passes the arguments to all frames for this server.
- *
- * @param messageType The type of message to send
- * @param args The arguments of the message
- */
- public void addLineToAll(final String messageType, final Object... args) {
- for (Channel channel : channels.values()) {
- channel.getFrame().addLine(messageType, args);
- }
-
- for (Query query : queries) {
- query.getFrame().addLine(messageType, args);
- }
-
- addLine(messageType, args);
- }
-
- /**
- * Replies to an incoming CTCP message.
- *
- * @param source The source of the message
- * @param type The CTCP type
- * @param args The CTCP arguments
- */
- public void sendCTCPReply(final String source, final String type, final String args) {
- if (type.equalsIgnoreCase("VERSION")) {
- parser.sendCTCPReply(source, "VERSION", "DMDirc " + Main.VERSION
- + " - http://www.dmdirc.com/");
- } else if (type.equalsIgnoreCase("PING")) {
- parser.sendCTCPReply(source, "PING", args);
- } else if (type.equalsIgnoreCase("CLIENTINFO")) {
- parser.sendCTCPReply(source, "CLIENTINFO", "VERSION PING CLIENTINFO");
- }
- }
-
- /**
- * Determines if the specified channel name is valid. A channel name is
- * valid if we already have an existing Channel with the same name, or
- * we have a valid parser instance and the parser says it's valid.
- *
- * @param channelName The name of the channel to test
- * @return True if the channel name is valid, false otherwise
- */
- public boolean isValidChannelName(final String channelName) {
- return hasChannel(channelName)
- || (parser != null && parser.isValidChannelName(channelName));
- }
-
- /**
- * Returns this server's name.
- *
- * @return A string representation of this server (i.e., its name)
- */
- @Override
- public String toString() {
- return getName();
- }
-
- /**
- * Returns the server instance associated with this frame.
- *
- * @return the associated server connection
- */
- @Override
- public Server getServer() {
- return this;
- }
-
- /** {@inheritDoc} */
- @Override
- protected boolean processNotificationArg(final Object arg, final List<Object> args) {
- if (arg instanceof ClientInfo) {
- final ClientInfo clientInfo = (ClientInfo) arg;
- args.add(clientInfo.getNickname());
- args.add(clientInfo.getIdent());
- args.add(clientInfo.getHost());
- return true;
- } else {
- return super.processNotificationArg(arg, args);
- }
- }
-
- /**
- * Retusnt the list of invites for this server.
- *
- * @return Invite list
- */
- public List<Invite> getInvites() {
- return invites;
- }
-
- // -------------------------------------------------- PARSER CALLBACKS -----
-
- /**
- * Called when the server says that the nickname we're trying to use is
- * already in use.
- *
- * @param nickname The nickname that we were trying to use
- */
- public void onNickInUse(final String nickname) {
- final String lastNick = parser.getMyNickname();
-
- // If our last nick is still valid, ignore the in use message
- if (!converter.equalsIgnoreCase(lastNick, nickname)) {
- return;
- }
-
- String newNick = lastNick + (int) (Math.random() * 10);
-
- final List<String> alts = profile.getOptionList(DOMAIN_PROFILE, "nicknames");
- int offset = 0;
-
- // Loop so we can check case sensitivity
- for (String alt : alts) {
- offset++;
- if (converter.equalsIgnoreCase(alt, lastNick)) {
- break;
- }
- }
-
- if (offset < alts.size() && alts.get(offset).length() > 0) {
- newNick = alts.get(offset);
- }
-
- parser.setNickname(newNick);
- }
-
- /**
- * Called when the server sends a numeric event.
- *
- * @param numeric The numeric code for the event
- * @param tokens The (tokenised) arguments of the event
- */
- public void onNumeric(final int numeric, final String[] tokens) {
- String snumeric = String.valueOf(numeric);
-
- if (numeric < 10) {
- snumeric = "00" + snumeric;
- } else if (numeric < 100) {
- snumeric = "0" + snumeric;
- }
-
- final String withIrcd = "numeric_" + parser.getIRCD(true) + "_" + snumeric;
- final String sansIrcd = "numeric_" + snumeric;
- StringBuffer target = null;
-
- if (getConfigManager().hasOption("formatter", withIrcd)) {
- target = new StringBuffer(withIrcd);
- } else if (getConfigManager().hasOption("formatter", sansIrcd)) {
- target = new StringBuffer(sansIrcd);
- } else if (getConfigManager().hasOption("formatter", "numeric_unknown")) {
- target = new StringBuffer("numeric_unknown");
- }
-
- ActionManager.processEvent(CoreActionType.SERVER_NUMERIC, target, this,
- Integer.valueOf(numeric), tokens);
-
- if (target != null) {
- handleNotification(target.toString(), (Object[]) tokens);
- }
- }
-
- /**
- * Called when the socket has been closed.
- */
- public void onSocketClosed() {
- handleNotification("socketClosed", getName());
-
- ActionManager.processEvent(CoreActionType.SERVER_DISCONNECTED, null, this);
-
- eventHandler.unregisterCallbacks();
-
- synchronized (this) {
- if (myState.getState() == ServerState.CLOSING
- || myState.getState() == ServerState.DISCONNECTED) {
- // This has been triggered via .disconect()
- return;
- }
-
- if (myState.getState() == ServerState.DISCONNECTING) {
- myState.transition(ServerState.DISCONNECTED);
- } else {
- myState.transition(ServerState.TRANSIENTLY_DISCONNECTED);
- }
-
- parser = null;
-
- updateIcon();
-
- if (getConfigManager().getOptionBool(DOMAIN_GENERAL,
- "closechannelsondisconnect", false)) {
- closeChannels();
- } else {
- clearChannels();
- }
-
- if (getConfigManager().getOptionBool(DOMAIN_GENERAL,
- "closequeriesondisconnect", false)) {
- closeQueries();
- }
-
- removeInvites();
- updateAwayState(null);
-
- if (getConfigManager().getOptionBool(DOMAIN_GENERAL,
- "reconnectondisconnect", false)
- && myState.getState() == ServerState.TRANSIENTLY_DISCONNECTED) {
- doDelayedReconnect();
- }
- }
- }
-
- /**
- * Called when an error was encountered while connecting.
- *
- * @param errorInfo The parser's error information
- */
- @Precondition("The current server state is CONNECTING")
- public void onConnectError(final ParserError errorInfo) {
- synchronized (this) {
- if (myState.getState() == ServerState.CLOSING
- || myState.getState() == ServerState.DISCONNECTING) {
- // Do nothing
- return;
- } else if (myState.getState() != ServerState.CONNECTING) {
- // Shouldn't happen
- throw new IllegalStateException("Connect error when not "
- + "connecting\n\n" + getStatus().getTransitionHistory());
- }
-
- myState.transition(ServerState.TRANSIENTLY_DISCONNECTED);
- parser = null;
-
- updateIcon();
-
- String description;
-
- if (errorInfo.getException() == null) {
- description = errorInfo.getData();
- } else {
- final Exception exception = errorInfo.getException();
-
- if (exception instanceof java.net.UnknownHostException) {
- description = "Unknown host (unable to resolve)";
- } else if (exception instanceof java.net.NoRouteToHostException) {
- description = "No route to host";
- } else if (exception instanceof java.net.SocketException
- || exception instanceof javax.net.ssl.SSLException) {
- description = exception.getMessage();
- } else {
- Logger.appError(ErrorLevel.LOW, "Unknown socket error", exception);
- description = "Unknown error: " + exception.getMessage();
- }
- }
-
- ActionManager.processEvent(CoreActionType.SERVER_CONNECTERROR, null,
- this, description);
-
- handleNotification("connectError", getName(), description);
-
- if (getConfigManager().getOptionBool(DOMAIN_GENERAL,
- "reconnectonconnectfailure", false)) {
- doDelayedReconnect();
- }
- }
- }
-
- /**
- * Called when we fail to receive a ping reply within a set period of time.
- */
- public void onPingFailed() {
- Main.getUI().getStatusBar().setMessage("No ping reply from "
- + getName() + " for over "
- + ((int) (Math.floor(parser.getPingTime(false) / 1000.0)))
- + " seconds.", null, 10);
-
- ActionManager.processEvent(CoreActionType.SERVER_NOPING, null, this,
- Long.valueOf(parser.getPingTime(false)));
-
- if (parser.getPingTime(false)
- >= getConfigManager().getOptionInt(DOMAIN_SERVER, "pingtimeout", 60000)) {
- handleNotification("stonedServer", getName());
- reconnect();
- }
- }
-
- /**
- * Called after the parser receives the 005 headers from the server.
- */
- @Precondition("State is CONNECTING")
- public void onPost005() {
- synchronized (this) {
- if (myState.getState() != ServerState.CONNECTING) {
- // Shouldn't happen
- throw new IllegalStateException("Received onPost005 while not "
- + "connecting\n\nState: " + myState);
- }
-
- myState.transition(ServerState.CONNECTED);
-
- updateIcon();
-
- getConfigManager().migrate(parser.getIRCD(true), getNetwork(), getName());
- updateIgnoreList();
-
- converter = parser.getIRCStringConverter();
-
- ActionManager.processEvent(CoreActionType.SERVER_CONNECTED, null, this);
-
- if (getConfigManager().getOptionBool(DOMAIN_GENERAL, "rejoinchannels", false)) {
- for (Channel chan : channels.values()) {
- chan.join();
- }
- }
-
- for (String channel : autochannels) {
- parser.joinChannel(channel);
- }
-
- checkModeAliases();
- }
- }
-
- /**
- * Checks that we have the neccessary mode aliases for this server.
- */
- private void checkModeAliases() {
- // Check we have mode aliases
- final String modes = parser.getBoolChanModes() + parser.getListChanModes()
- + parser.getSetOnlyChanModes() + parser.getSetUnsetChanModes();
- final String umodes = parser.getUserModeString();
-
- final StringBuffer missingModes = new StringBuffer();
- final StringBuffer missingUmodes = new StringBuffer();
-
- for (char mode : modes.toCharArray()) {
- if (!getConfigManager().hasOption(DOMAIN_SERVER, "mode" + mode)) {
- missingModes.append(mode);
- }
- }
-
- for (char mode : umodes.toCharArray()) {
- if (!getConfigManager().hasOption(DOMAIN_SERVER, "umode" + mode)) {
- missingUmodes.append(mode);
- }
- }
-
- if (missingModes.length() + missingUmodes.length() > 0) {
- final StringBuffer missing = new StringBuffer("Missing mode aliases: ");
-
- if (missingModes.length() > 0) {
- missing.append("channel: +");
- missing.append(missingModes);
- }
-
- if (missingUmodes.length() > 0) {
- if (missingModes.length() > 0) {
- missing.append(' ');
- }
-
- missing.append("user: +");
- missing.append(missingUmodes);
- }
-
- Logger.appError(ErrorLevel.LOW, missing.toString() + " ["
- + parser.getIRCD(true) + "]",
- new Exception(missing.toString() + "\n" // NOPMD
- + "Network: " + getNetwork() + "\n"
- + "IRCd: " + parser.getIRCD(false)
- + " (" + parser.getIRCD(true) + ")\n"
- + "Mode alias version: "
- + getConfigManager().getOption("identity", "modealiasversion", "none")
- + "\n\n"));
- }
- }
-
- // ---------------------------------------------- IGNORE LIST HANDLING -----
-
- /**
- * Retrieves this server's ignore list.
- *
- * @return This server's ignore list
- */
- public IgnoreList getIgnoreList() {
- return ignoreList;
- }
-
- /**
- * Updates this server's ignore list to use the entries stored in the
- * config manager.
- */
- public void updateIgnoreList() {
- ignoreList.clear();
- ignoreList.addAll(getConfigManager().getOptionList("network", "ignorelist"));
- }
-
- /**
- * Saves the contents of our ignore list to the network identity.
- */
- public void saveIgnoreList() {
- getNetworkIdentity().setOption("network", "ignorelist", ignoreList.getRegexList());
- }
-
- // ------------------------------------------------- IDENTITY WRAPPERS -----
-
- /**
- * Retrieves the identity for this server.
- *
- * @return This server's identity
- */
- public Identity getServerIdentity() {
- return IdentityManager.getServerConfig(getName());
- }
-
- /**
- * Retrieves the identity for this server's network.
- *
- * @return This server's network identity
- */
- public Identity getNetworkIdentity() {
- return IdentityManager.getNetworkConfig(getNetwork());
- }
-
- // --------------------------------------------------- INVITE HANDLING -----
-
- /**
- * Adds an invite listener to this server.
- *
- * @param listener The listener to be added
- */
- public void addInviteListener(final InviteListener listener) {
- listeners.add(InviteListener.class, listener);
- }
-
- /**
- * Removes an invite listener from this server.
- *
- * @param listener The listener to be removed
- */
- public void removeInviteListener(final InviteListener listener) {
- listeners.remove(InviteListener.class, listener);
- }
-
- /**
- * Adds an invite to this server, and fires the appropriate listeners.
- *
- * @param invite The invite to be added
- */
- public void addInvite(final Invite invite) {
- synchronized (invites) {
- for (Invite oldInvite : new ArrayList<Invite>(invites)) {
- if (oldInvite.getChannel().equals(invite.getChannel())) {
- removeInvite(oldInvite);
- }
- }
-
- invites.add(invite);
-
- for (InviteListener listener : listeners.get(InviteListener.class)) {
- listener.inviteReceived(this, invite);
- }
- }
- }
-
- /**
- * Removes all invites for the specified channel.
- *
- * @param channel The channel to remove invites for
- */
- public void removeInvites(final String channel) {
- for (Invite invite : new ArrayList<Invite>(invites)) {
- if (invite.getChannel().equals(channel)) {
- removeInvite(invite);
- }
- }
- }
-
- /**
- * Removes all invites for all channels.
- */
- private void removeInvites() {
- for (Invite invite : new ArrayList<Invite>(invites)) {
- removeInvite(invite);
- }
- }
-
- /**
- * Removes an invite from this server, and fires the appropriate listeners.
- *
- * @param invite The invite to be removed
- */
- public void removeInvite(final Invite invite) {
- synchronized (invites) {
- invites.remove(invite);
-
- for (InviteListener listener : listeners.get(InviteListener.class)) {
- listener.inviteExpired(this, invite);
- }
- }
- }
-
- // ----------------------------------------------- AWAY STATE HANDLING -----
-
- /**
- * Adds an away state lisener to this server.
- *
- * @param listener The listener to be added
- */
- public void addAwayStateListener(final AwayStateListener listener) {
- listeners.add(AwayStateListener.class, listener);
- }
-
- /**
- * Removes an away state lisener from this server.
- *
- * @param listener The listener to be removed
- */
- public void removeAwayStateListener(final AwayStateListener listener) {
- listeners.remove(AwayStateListener.class, listener);
- }
-
- /**
- * Updates our away state and fires the relevant listeners.
- *
- * @param message The away message to use, or null if we're not away.
- */
- public void updateAwayState(final String message) {
- if ((awayMessage != null && awayMessage.equals(message))
- || (awayMessage == null && message == null)) {
- return;
- }
-
- awayMessage = message;
-
- if (message == null) {
- for (AwayStateListener listener : listeners.get(AwayStateListener.class)) {
- listener.onBack();
- }
- } else {
- for (AwayStateListener listener : listeners.get(AwayStateListener.class)) {
- listener.onAway(message);
- }
- }
- }
-
- }
|