com.aoindustries.aoserv.client.email.SmtpRelay Maven / Gradle / Ivy

Go to download
/*
 * aoserv-client - Java client for the AOServ Platform.
 * Copyright (C) 2001-2013, 2016, 2017, 2018, 2019  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoserv-client.
 *
 * aoserv-client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aoserv-client 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with aoserv-client.  If not, see .
 */
package com.aoindustries.aoserv.client.email;

import com.aoindustries.aoserv.client.CachedObjectIntegerKey;
import com.aoindustries.aoserv.client.CannotRemoveReason;
import com.aoindustries.aoserv.client.Disablable;
import com.aoindustries.aoserv.client.Removable;
import com.aoindustries.aoserv.client.account.Account;
import com.aoindustries.aoserv.client.account.DisableLog;
import com.aoindustries.aoserv.client.billing.Package;
import com.aoindustries.aoserv.client.linux.Server;
import com.aoindustries.aoserv.client.schema.AoservProtocol;
import com.aoindustries.aoserv.client.schema.Table;
import com.aoindustries.io.stream.StreamableInput;
import com.aoindustries.io.stream.StreamableOutput;
import com.aoindustries.net.HostAddress;
import com.aoindustries.sql.UnmodifiableTimestamp;
import com.aoindustries.validation.ValidationException;
import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Collections;
import java.util.List;

/**
 * When a user successfully logs into either the POP3 or
 * IMAP mail systems, access from their host is
 * granted to the SMTP server via a EmailSmtpRelay.
 *
 * @author  AO Industries, Inc.
 */
public final class SmtpRelay extends CachedObjectIntegerKey implements Removable, Disablable {

	static final int
		COLUMN_PKEY=0,
		COLUMN_PACKAGE=1
	;
	static final String COLUMN_AO_SERVER_name = "ao_server";
	static final String COLUMN_HOST_name = "host";
	static final String COLUMN_PACKAGE_name = "package";

	/**
	 * Keep the SMTP relay history for three months (92 days).
	 */
	public static final int HISTORY_DAYS=92;

	Account.Name packageName;
	int ao_server;
	private HostAddress host;
	String type;
	private UnmodifiableTimestamp created;
	private UnmodifiableTimestamp last_refreshed;
	private int refresh_count;
	private UnmodifiableTimestamp expiration;
	int disable_log;

	public int addSpamEmailMessage(String message) throws IOException, SQLException {
		return table.getConnector().getEmail().getSpamMessage().addSpamEmailMessage(this, message);
	}

	@Override
	public boolean canDisable() {
		return disable_log==-1;
	}

	@Override
	public boolean canEnable() throws IOException, SQLException {
		DisableLog dl=getDisableLog();
		if(dl==null) return false;
		else return dl.canEnable() && !getPackage().isDisabled();
	}

	@Override
	public void disable(DisableLog dl) throws IOException, SQLException {
		table.getConnector().requestUpdateIL(true, AoservProtocol.CommandID.DISABLE, Table.TableID.EMAIL_SMTP_RELAYS, dl.getPkey(), pkey);
	}

	@Override
	public void enable() throws IOException, SQLException {
		table.getConnector().requestUpdateIL(true, AoservProtocol.CommandID.ENABLE, Table.TableID.EMAIL_SMTP_RELAYS, pkey);
	}

	@Override
	protected Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_PKEY: return pkey;
			case COLUMN_PACKAGE: return packageName;
			case 2: return ao_server==-1?null:ao_server;
			case 3: return host;
			case 4: return type;
			case 5: return created;
			case 6: return last_refreshed;
			case 7: return refresh_count;
			case 8: return expiration;
			case 9: return disable_log==-1?null:disable_log;
			default: throw new IllegalArgumentException("Invalid index: " + i);
		}
	}

	public UnmodifiableTimestamp getCreated() {
		return created;
	}

	@Override
	public boolean isDisabled() {
		return disable_log!=-1;
	}

	@Override
	public DisableLog getDisableLog() throws IOException, SQLException {
		if(disable_log==-1) return null;
		DisableLog obj=table.getConnector().getAccount().getDisableLog().get(disable_log);
		if(obj==null) throw new SQLException("Unable to find DisableLog: "+disable_log);
		return obj;
	}

	public UnmodifiableTimestamp getExpiration() {
		return expiration;
	}

	public HostAddress getHost() {
		return host;
	}

	public SmtpRelayType getType() throws SQLException, IOException {
		SmtpRelayType esrt=table.getConnector().getEmail().getSmtpRelayType().get(type);
		if(esrt==null) throw new SQLException("Unable to find EmailSmtpRelayType: "+type);
		return esrt;
	}

	public UnmodifiableTimestamp getLastRefreshed() {
		return last_refreshed;
	}

	public Package getPackage() throws IOException, SQLException {
		// May be filtered
		return table.getConnector().getBilling().getPackage().get(packageName);
	}

	public int getRefreshCount() {
		return refresh_count;
	}

	public Server getLinuxServer() throws SQLException, IOException {
		if(ao_server==-1) return null;
		Server ao=table.getConnector().getLinux().getServer().get(ao_server);
		if(ao==null) throw new SQLException("Unable to find linux.Server: "+ao_server);
		return ao;
	}

	public List getSpamEmailMessages() throws IOException, SQLException {
		return table.getConnector().getEmail().getSpamMessage().getSpamEmailMessages(this);
	}

	@Override
	public Table.TableID getTableID() {
		return Table.TableID.EMAIL_SMTP_RELAYS;
	}

	@Override
	public void init(ResultSet result) throws SQLException {
		try {
			pkey=result.getInt(1);
			packageName = Account.Name.valueOf(result.getString(2));
			ao_server=result.getInt(3);
			if(result.wasNull()) ao_server=-1;
			host=HostAddress.valueOf(result.getString(4));
			type=result.getString(5);
			created = UnmodifiableTimestamp.valueOf(result.getTimestamp(6));
			last_refreshed = UnmodifiableTimestamp.valueOf(result.getTimestamp(7));
			refresh_count=result.getInt(8);
			expiration = UnmodifiableTimestamp.valueOf(result.getTimestamp(9));
			disable_log=result.getInt(10);
			if(result.wasNull()) disable_log=-1;
		} catch(ValidationException e) {
			throw new SQLException(e);
		}
	}

	@Override
	public void read(StreamableInput in, AoservProtocol.Version protocolVersion) throws IOException {
		try {
			pkey=in.readCompressedInt();
			packageName = Account.Name.valueOf(in.readUTF()).intern();
			ao_server=in.readCompressedInt();
			host=HostAddress.valueOf(in.readUTF());
			type=in.readUTF().intern();
			created = in.readUnmodifiableTimestamp();
			last_refreshed = in.readUnmodifiableTimestamp();
			refresh_count=in.readCompressedInt();
			expiration = in.readNullUnmodifiableTimestamp();
			disable_log=in.readCompressedInt();
		} catch(ValidationException e) {
			throw new IOException(e);
		}
	}

	public void refresh(long minDuration) throws IOException, SQLException {
		table.getConnector().requestUpdateIL(
			true,
			AoservProtocol.CommandID.REFRESH_EMAIL_SMTP_RELAY,
			pkey,
			minDuration
		);
	}

	@Override
	public List> getCannotRemoveReasons() {
		return Collections.emptyList();
	}

	@Override
	public void remove() throws IOException, SQLException {
		table.getConnector().requestUpdateIL(
			true,
			AoservProtocol.CommandID.REMOVE,
			Table.TableID.EMAIL_SMTP_RELAYS,
			pkey
		);
	}

	@Override
	public String toStringImpl() throws SQLException, IOException {
		return packageName+" "+getType().getVerb()+" from "+host+" to "+getLinuxServer().getHostname();
	}

	@Override
	public void write(StreamableOutput out, AoservProtocol.Version protocolVersion) throws IOException {
		out.writeCompressedInt(pkey);
		out.writeUTF(packageName.toString());
		out.writeCompressedInt(ao_server);
		out.writeUTF(host.toString());
		out.writeUTF(type);
		if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_83_0) < 0) {
			out.writeLong(created.getTime());
		} else {
			out.writeTimestamp(created);
		}
		if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_83_0) < 0) {
			out.writeLong(last_refreshed.getTime());
		} else {
			out.writeTimestamp(last_refreshed);
		}
		out.writeCompressedInt(refresh_count);
		if(protocolVersion.compareTo(AoservProtocol.Version.VERSION_1_83_0) < 0) {
			out.writeLong(expiration == null ? -1 : expiration.getTime());
		} else {
			out.writeNullTimestamp(expiration);
		}
		out.writeCompressedInt(disable_log);
	}
}