123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173 |
- /*
- * Copyright (c) 2006-2010 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.addons.identd;
-
- import com.dmdirc.Server;
- import com.dmdirc.actions.ActionManager;
- import com.dmdirc.actions.CoreActionType;
- import com.dmdirc.actions.interfaces.ActionType;
- import com.dmdirc.config.IdentityManager;
- import com.dmdirc.config.prefs.PluginPreferencesCategory;
- import com.dmdirc.config.prefs.PreferencesCategory;
- import com.dmdirc.config.prefs.PreferencesManager;
- import com.dmdirc.config.prefs.PreferencesSetting;
- import com.dmdirc.config.prefs.PreferencesType;
- import com.dmdirc.config.prefs.validator.PortValidator;
- import com.dmdirc.interfaces.ActionListener;
- import com.dmdirc.plugins.Plugin;
-
- import java.util.ArrayList;
- import java.util.List;
-
- /**
- * The Identd plugin answers ident requests from IRC servers.
- *
- * @author Shane
- */
- public class IdentdPlugin extends Plugin implements ActionListener {
-
- /** Array list to store all the servers in that need ident replies. */
- private final List<Server> servers = new ArrayList<Server>();
-
- /** The IdentdServer that we use. */
- private IdentdServer myServer;
-
- /**
- * Creates a new instance of IdentdPlugin.
- */
- public IdentdPlugin() {
- }
-
- /**
- * Called when the plugin is loaded.
- */
- @Override
- public void onLoad() {
- // Add action hooks
- ActionManager.addListener(this, CoreActionType.SERVER_CONNECTED, CoreActionType.SERVER_CONNECTING, CoreActionType.SERVER_CONNECTERROR);
-
- myServer = new IdentdServer(this);
- if (IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "advanced.alwaysOn")) {
- myServer.startServer();
- }
- }
-
- /**
- * Called when this plugin is unloaded.
- */
- @Override
- public void onUnload() {
- myServer.stopServer();
- servers.clear();
- ActionManager.removeListener(this);
- }
-
- /**
- * Process an event of the specified type.
- *
- * @param type The type of the event to process
- * @param format Format of messages that are about to be sent. (May be null)
- * @param arguments The arguments for the event
- */
- @Override
- public void processEvent(final ActionType type, final StringBuffer format, final Object... arguments) {
- if (type == CoreActionType.SERVER_CONNECTING) {
- synchronized (servers) {
- if (servers.isEmpty()) {
- myServer.startServer();
- }
- servers.add((Server) arguments[0]);
- }
- } else if (type == CoreActionType.SERVER_CONNECTED || type == CoreActionType.SERVER_CONNECTERROR) {
- synchronized (servers) {
- servers.remove(arguments[0]);
-
- if (servers.isEmpty() && !IdentityManager.getGlobalConfig().getOptionBool(getDomain(), "advanced.alwaysOn")) {
- myServer.stopServer();
- }
- }
- }
- }
-
- /** {@inheritDoc} */
- @Override
- public void showConfig(final PreferencesManager manager) {
- final PreferencesCategory general = new PluginPreferencesCategory(getPluginInfo(), "Identd",
- "General Identd Plugin config ('Lower' options take priority " +
- "over those above them)");
- final PreferencesCategory advanced = new PluginPreferencesCategory(getPluginInfo(), "Advanced",
- "Advanced Identd Plugin config - Only edit these if you need " +
- "to/know what you are doing. Editing these could prevent " +
- "access to some servers. ('Lower' options take priority over " +
- "those above them)");
-
- general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
- getDomain(), "general.useUsername", "Use connection " +
- "username rather than system username", "If this is enabled," +
- " the username for the connection will be used rather than " +
- "'" + System.getProperty("user.name") + "'"));
- general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
- getDomain(), "general.useNickname", "Use connection " +
- "nickname rather than system username", "If this is enabled, " +
- "the nickname for the connection will be used rather than " +
- "'" + System.getProperty("user.name") + "'"));
- general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
- getDomain(), "general.useCustomName", "Use custom name" +
- " all the time", "If this is enabled, the name specified below" +
- " will be used all the time"));
- general.addSetting(new PreferencesSetting(PreferencesType.TEXT,
- getDomain(), "general.customName", "Custom Name to use",
- "The custom name to use when 'Use Custom Name' is enabled"));
-
- advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
- getDomain(), "advanced.alwaysOn", "Always have ident " +
- "port open", "By default the identd only runs when there are " +
- "active connection attempts. This overrides that."));
- advanced.addSetting(new PreferencesSetting(PreferencesType.INTEGER,
- new PortValidator(), getDomain(), "advanced.port",
- "What port should the identd listen on", "Default port is 113," +
- " this is probably useless if changed unless you port forward" +
- " ident to a different port"));
- advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
- getDomain(), "advanced.useCustomSystem", "Use custom OS",
- "By default the plugin uses 'UNIX' or 'WIN32' as the system " +
- "type, this can be overriden by enabling this."));
- advanced.addSetting(new PreferencesSetting(PreferencesType.TEXT,
- getDomain(), "advanced.customSystem", "Custom OS to use",
- "The custom system to use when 'Use Custom System' is enabled"));
- advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
- getDomain(), "advanced.isHiddenUser", "Respond to ident" +
- " requests with HIDDEN-USER error", "By default the plugin will" +
- " give a USERID response, this can force an 'ERROR :" +
- " HIDDEN-USER' response instead."));
- advanced.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
- getDomain(), "advanced.isNoUser", "Respond to ident" +
- " requests with NO-USER error", "By default the plugin will" +
- " give a USERID response, this can force an 'ERROR : NO-USER'" +
- " response instead. (Overrides HIDDEN-USER)"));
-
- manager.getCategory("Plugins").addSubCategory(general);
- general.addSubCategory(advanced);
- }
-
- }
|