src/org/sonews/daemon/NNTPConnection.java
author cli
Sun, 11 Sep 2011 15:05:04 +0200
changeset 48 b78e77619152
parent 37 74139325d305
child 49 8df94bfd3e2f
permissions -rwxr-xr-x
Merge Channel and Group classes.
chris@1
     1
/*
chris@1
     2
 *   SONEWS News Server
chris@1
     3
 *   see AUTHORS for the list of contributors
chris@1
     4
 *
chris@1
     5
 *   This program is free software: you can redistribute it and/or modify
chris@1
     6
 *   it under the terms of the GNU General Public License as published by
chris@1
     7
 *   the Free Software Foundation, either version 3 of the License, or
chris@1
     8
 *   (at your option) any later version.
chris@1
     9
 *
chris@1
    10
 *   This program is distributed in the hope that it will be useful,
chris@1
    11
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
chris@1
    12
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
chris@1
    13
 *   GNU General Public License for more details.
chris@1
    14
 *
chris@1
    15
 *   You should have received a copy of the GNU General Public License
chris@1
    16
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
chris@1
    17
 */
chris@1
    18
chris@1
    19
package org.sonews.daemon;
chris@1
    20
chris@1
    21
import java.io.IOException;
chris@1
    22
import java.net.InetSocketAddress;
chris@3
    23
import java.net.SocketException;
chris@1
    24
import java.nio.ByteBuffer;
chris@1
    25
import java.nio.CharBuffer;
chris@1
    26
import java.nio.channels.ClosedChannelException;
chris@1
    27
import java.nio.channels.SelectionKey;
chris@1
    28
import java.nio.channels.SocketChannel;
chris@1
    29
import java.nio.charset.Charset;
chris@3
    30
import java.util.Arrays;
chris@1
    31
import java.util.Timer;
chris@1
    32
import java.util.TimerTask;
chris@3
    33
import org.sonews.daemon.command.Command;
chris@3
    34
import org.sonews.storage.Article;
cli@48
    35
import org.sonews.storage.Group;
cli@30
    36
import org.sonews.storage.StorageBackendException;
cli@25
    37
import org.sonews.util.Log;
chris@1
    38
import org.sonews.util.Stats;
chris@1
    39
chris@1
    40
/**
chris@1
    41
 * For every SocketChannel (so TCP/IP connection) there is an instance of
chris@1
    42
 * this class.
chris@1
    43
 * @author Christian Lins
chris@1
    44
 * @since sonews/0.5.0
chris@1
    45
 */
chris@1
    46
public final class NNTPConnection
chris@1
    47
{
chris@1
    48
cli@37
    49
	public static final String NEWLINE = "\r\n";    // RFC defines this as newline
cli@37
    50
	public static final String MESSAGE_ID_PATTERN = "<[^>]+>";
cli@37
    51
	private static final Timer cancelTimer = new Timer(true); // Thread-safe? True for run as daemon
cli@37
    52
	/** SocketChannel is generally thread-safe */
cli@37
    53
	private SocketChannel channel = null;
cli@37
    54
	private Charset charset = Charset.forName("UTF-8");
cli@37
    55
	private Command command = null;
cli@37
    56
	private Article currentArticle = null;
cli@48
    57
	private Group currentGroup = null;
cli@37
    58
	private volatile long lastActivity = System.currentTimeMillis();
cli@37
    59
	private ChannelLineBuffers lineBuffers = new ChannelLineBuffers();
cli@37
    60
	private int readLock = 0;
cli@37
    61
	private final Object readLockGate = new Object();
cli@37
    62
	private SelectionKey writeSelKey = null;
chris@1
    63
cli@37
    64
	public NNTPConnection(final SocketChannel channel)
cli@37
    65
		throws IOException
cli@37
    66
	{
cli@37
    67
		if (channel == null) {
cli@37
    68
			throw new IllegalArgumentException("channel is null");
cli@37
    69
		}
chris@1
    70
cli@37
    71
		this.channel = channel;
cli@37
    72
		Stats.getInstance().clientConnect();
cli@37
    73
	}
chris@1
    74
cli@37
    75
	/**
cli@37
    76
	 * Tries to get the read lock for this NNTPConnection. This method is Thread-
cli@37
    77
	 * safe and returns true of the read lock was successfully set. If the lock
cli@37
    78
	 * is still hold by another Thread the method returns false.
cli@37
    79
	 */
cli@37
    80
	boolean tryReadLock()
cli@37
    81
	{
cli@37
    82
		// As synchronizing simple types may cause deadlocks,
cli@37
    83
		// we use a gate object.
cli@37
    84
		synchronized (readLockGate) {
cli@37
    85
			if (readLock != 0) {
cli@37
    86
				return false;
cli@37
    87
			} else {
cli@37
    88
				readLock = Thread.currentThread().hashCode();
cli@37
    89
				return true;
cli@37
    90
			}
cli@37
    91
		}
cli@37
    92
	}
chris@3
    93
cli@37
    94
	/**
cli@37
    95
	 * Releases the read lock in a Thread-safe way.
cli@37
    96
	 * @throws IllegalMonitorStateException if a Thread not holding the lock
cli@37
    97
	 * tries to release it.
cli@37
    98
	 */
cli@37
    99
	void unlockReadLock()
cli@37
   100
	{
cli@37
   101
		synchronized (readLockGate) {
cli@37
   102
			if (readLock == Thread.currentThread().hashCode()) {
cli@37
   103
				readLock = 0;
cli@37
   104
			} else {
cli@37
   105
				throw new IllegalMonitorStateException();
cli@37
   106
			}
cli@37
   107
		}
cli@37
   108
	}
chris@1
   109
cli@37
   110
	/**
cli@37
   111
	 * @return Current input buffer of this NNTPConnection instance.
cli@37
   112
	 */
cli@37
   113
	public ByteBuffer getInputBuffer()
cli@37
   114
	{
cli@37
   115
		return this.lineBuffers.getInputBuffer();
cli@37
   116
	}
chris@1
   117
cli@37
   118
	/**
cli@37
   119
	 * @return Output buffer of this NNTPConnection which has at least one byte
cli@37
   120
	 * free storage.
cli@37
   121
	 */
cli@37
   122
	public ByteBuffer getOutputBuffer()
cli@37
   123
	{
cli@37
   124
		return this.lineBuffers.getOutputBuffer();
cli@37
   125
	}
cli@30
   126
cli@37
   127
	/**
cli@37
   128
	 * @return ChannelLineBuffers instance associated with this NNTPConnection.
cli@37
   129
	 */
cli@37
   130
	public ChannelLineBuffers getBuffers()
cli@37
   131
	{
cli@37
   132
		return this.lineBuffers;
cli@37
   133
	}
chris@1
   134
cli@37
   135
	/**
cli@37
   136
	 * @return true if this connection comes from a local remote address.
cli@37
   137
	 */
cli@37
   138
	public boolean isLocalConnection()
cli@37
   139
	{
cli@37
   140
		return ((InetSocketAddress) this.channel.socket().getRemoteSocketAddress()).getHostName().equalsIgnoreCase("localhost");
cli@37
   141
	}
chris@3
   142
cli@37
   143
	void setWriteSelectionKey(SelectionKey selKey)
cli@37
   144
	{
cli@37
   145
		this.writeSelKey = selKey;
cli@37
   146
	}
chris@3
   147
cli@37
   148
	public void shutdownInput()
cli@37
   149
	{
cli@37
   150
		try {
cli@37
   151
			// Closes the input line of the channel's socket, so no new data
cli@37
   152
			// will be received and a timeout can be triggered.
cli@37
   153
			this.channel.socket().shutdownInput();
cli@37
   154
		} catch (IOException ex) {
cli@37
   155
			Log.get().warning("Exception in NNTPConnection.shutdownInput(): " + ex);
cli@37
   156
		}
cli@37
   157
	}
chris@1
   158
cli@37
   159
	public void shutdownOutput()
cli@37
   160
	{
cli@37
   161
		cancelTimer.schedule(new TimerTask()
cli@37
   162
		{
cli@25
   163
cli@37
   164
			@Override
cli@37
   165
			public void run()
cli@37
   166
			{
cli@37
   167
				try {
cli@37
   168
					// Closes the output line of the channel's socket.
cli@37
   169
					channel.socket().shutdownOutput();
cli@37
   170
					channel.close();
cli@37
   171
				} catch (SocketException ex) {
cli@37
   172
					// Socket was already disconnected
cli@37
   173
					Log.get().info("NNTPConnection.shutdownOutput(): " + ex);
cli@37
   174
				} catch (Exception ex) {
cli@37
   175
					Log.get().warning("NNTPConnection.shutdownOutput(): " + ex);
cli@37
   176
				}
cli@37
   177
			}
cli@37
   178
		}, 3000);
cli@37
   179
	}
cli@37
   180
cli@37
   181
	public SocketChannel getSocketChannel()
cli@37
   182
	{
cli@37
   183
		return this.channel;
cli@37
   184
	}
cli@37
   185
cli@37
   186
	public Article getCurrentArticle()
cli@37
   187
	{
cli@37
   188
		return this.currentArticle;
cli@37
   189
	}
cli@37
   190
cli@37
   191
	public Charset getCurrentCharset()
cli@37
   192
	{
cli@37
   193
		return this.charset;
cli@37
   194
	}
cli@37
   195
cli@37
   196
	/**
cli@37
   197
	 * @return The currently selected communication channel (not SocketChannel)
cli@37
   198
	 */
cli@48
   199
	public Group getCurrentChannel()
cli@37
   200
	{
cli@37
   201
		return this.currentGroup;
cli@37
   202
	}
cli@37
   203
cli@37
   204
	public void setCurrentArticle(final Article article)
cli@37
   205
	{
cli@37
   206
		this.currentArticle = article;
cli@37
   207
	}
cli@37
   208
cli@48
   209
	public void setCurrentGroup(final Group group)
cli@37
   210
	{
cli@37
   211
		this.currentGroup = group;
cli@37
   212
	}
cli@37
   213
cli@37
   214
	public long getLastActivity()
cli@37
   215
	{
cli@37
   216
		return this.lastActivity;
cli@37
   217
	}
cli@37
   218
cli@37
   219
	/**
cli@37
   220
	 * Due to the readLockGate there is no need to synchronize this method.
cli@37
   221
	 * @param raw
cli@37
   222
	 * @throws IllegalArgumentException if raw is null.
cli@37
   223
	 * @throws IllegalStateException if calling thread does not own the readLock.
cli@37
   224
	 */
cli@37
   225
	void lineReceived(byte[] raw)
cli@37
   226
	{
cli@37
   227
		if (raw == null) {
cli@37
   228
			throw new IllegalArgumentException("raw is null");
cli@37
   229
		}
cli@37
   230
cli@37
   231
		if (readLock == 0 || readLock != Thread.currentThread().hashCode()) {
cli@37
   232
			throw new IllegalStateException("readLock not properly set");
cli@37
   233
		}
cli@37
   234
cli@37
   235
		this.lastActivity = System.currentTimeMillis();
cli@37
   236
cli@37
   237
		String line = new String(raw, this.charset);
cli@37
   238
cli@37
   239
		// There might be a trailing \r, but trim() is a bad idea
cli@37
   240
		// as it removes also leading spaces from long header lines.
cli@37
   241
		if (line.endsWith("\r")) {
cli@37
   242
			line = line.substring(0, line.length() - 1);
cli@37
   243
			raw = Arrays.copyOf(raw, raw.length - 1);
cli@37
   244
		}
cli@37
   245
cli@37
   246
		Log.get().fine("<< " + line);
cli@37
   247
cli@37
   248
		if (command == null) {
cli@37
   249
			command = parseCommandLine(line);
cli@37
   250
			assert command != null;
cli@37
   251
		}
cli@37
   252
cli@37
   253
		try {
cli@37
   254
			// The command object will process the line we just received
cli@37
   255
			try {
cli@37
   256
				command.processLine(this, line, raw);
cli@37
   257
			} catch (StorageBackendException ex) {
cli@37
   258
				Log.get().info("Retry command processing after StorageBackendException");
cli@37
   259
cli@37
   260
				// Try it a second time, so that the backend has time to recover
cli@37
   261
				command.processLine(this, line, raw);
cli@37
   262
			}
cli@37
   263
		} catch (ClosedChannelException ex0) {
cli@37
   264
			try {
cli@37
   265
				Log.get().info("Connection to " + channel.socket().getRemoteSocketAddress()
cli@37
   266
					+ " closed: " + ex0);
cli@37
   267
			} catch (Exception ex0a) {
cli@37
   268
				ex0a.printStackTrace();
cli@37
   269
			}
cli@37
   270
		} catch (Exception ex1) // This will catch a second StorageBackendException
cli@37
   271
		{
cli@37
   272
			try {
cli@37
   273
				command = null;
cli@37
   274
				ex1.printStackTrace();
cli@37
   275
				println("500 Internal server error");
cli@37
   276
			} catch (Exception ex2) {
cli@37
   277
				ex2.printStackTrace();
cli@37
   278
			}
cli@37
   279
		}
cli@37
   280
cli@37
   281
		if (command == null || command.hasFinished()) {
cli@37
   282
			command = null;
cli@37
   283
			charset = Charset.forName("UTF-8"); // Reset to default
cli@37
   284
		}
cli@37
   285
	}
cli@37
   286
cli@37
   287
	/**
cli@37
   288
	 * This method determines the fitting command processing class.
cli@37
   289
	 * @param line
cli@37
   290
	 * @return
cli@37
   291
	 */
cli@37
   292
	private Command parseCommandLine(String line)
cli@37
   293
	{
cli@37
   294
		String cmdStr = line.split(" ")[0];
cli@37
   295
		return CommandSelector.getInstance().get(cmdStr);
cli@37
   296
	}
cli@37
   297
cli@37
   298
	/**
cli@37
   299
	 * Puts the given line into the output buffer, adds a newline character
cli@37
   300
	 * and returns. The method returns immediately and does not block until
cli@37
   301
	 * the line was sent. If line is longer than 510 octets it is split up in
cli@37
   302
	 * several lines. Each line is terminated by \r\n (NNTPConnection.NEWLINE).
cli@37
   303
	 * @param line
cli@37
   304
	 */
cli@37
   305
	public void println(final CharSequence line, final Charset charset)
cli@37
   306
		throws IOException
cli@37
   307
	{
cli@37
   308
		writeToChannel(CharBuffer.wrap(line), charset, line);
cli@37
   309
		writeToChannel(CharBuffer.wrap(NEWLINE), charset, null);
cli@37
   310
	}
cli@37
   311
cli@37
   312
	/**
cli@37
   313
	 * Writes the given raw lines to the output buffers and finishes with
cli@37
   314
	 * a newline character (\r\n).
cli@37
   315
	 * @param rawLines
cli@37
   316
	 */
cli@37
   317
	public void println(final byte[] rawLines)
cli@37
   318
		throws IOException
cli@37
   319
	{
cli@37
   320
		this.lineBuffers.addOutputBuffer(ByteBuffer.wrap(rawLines));
cli@37
   321
		writeToChannel(CharBuffer.wrap(NEWLINE), charset, null);
cli@37
   322
	}
cli@37
   323
cli@37
   324
	/**
cli@37
   325
	 * Encodes the given CharBuffer using the given Charset to a bunch of
cli@37
   326
	 * ByteBuffers (each 512 bytes large) and enqueues them for writing at the
cli@37
   327
	 * connected SocketChannel.
cli@37
   328
	 * @throws java.io.IOException
cli@37
   329
	 */
cli@37
   330
	private void writeToChannel(CharBuffer characters, final Charset charset,
cli@37
   331
		CharSequence debugLine)
cli@37
   332
		throws IOException
cli@37
   333
	{
cli@37
   334
		if (!charset.canEncode()) {
cli@37
   335
			Log.get().severe("FATAL: Charset " + charset + " cannot encode!");
cli@37
   336
			return;
cli@37
   337
		}
cli@37
   338
cli@37
   339
		// Write characters to output buffers
cli@37
   340
		LineEncoder lenc = new LineEncoder(characters, charset);
cli@37
   341
		lenc.encode(lineBuffers);
cli@37
   342
cli@37
   343
		enableWriteEvents(debugLine);
cli@37
   344
	}
cli@37
   345
cli@37
   346
	private void enableWriteEvents(CharSequence debugLine)
cli@37
   347
	{
cli@37
   348
		// Enable OP_WRITE events so that the buffers are processed
cli@37
   349
		try {
cli@37
   350
			this.writeSelKey.interestOps(SelectionKey.OP_WRITE);
cli@37
   351
			ChannelWriter.getInstance().getSelector().wakeup();
cli@37
   352
		} catch (Exception ex) // CancelledKeyException and ChannelCloseException
cli@37
   353
		{
cli@37
   354
			Log.get().warning("NNTPConnection.writeToChannel(): " + ex);
cli@37
   355
			return;
cli@37
   356
		}
cli@37
   357
cli@37
   358
		// Update last activity timestamp
cli@37
   359
		this.lastActivity = System.currentTimeMillis();
cli@37
   360
		if (debugLine != null) {
cli@37
   361
			Log.get().fine(">> " + debugLine);
cli@37
   362
		}
cli@37
   363
	}
cli@37
   364
cli@37
   365
	public void println(final CharSequence line)
cli@37
   366
		throws IOException
cli@37
   367
	{
cli@37
   368
		println(line, charset);
cli@37
   369
	}
cli@37
   370
cli@37
   371
	public void print(final String line)
cli@37
   372
		throws IOException
cli@37
   373
	{
cli@37
   374
		writeToChannel(CharBuffer.wrap(line), charset, line);
cli@37
   375
	}
cli@37
   376
cli@37
   377
	public void setCurrentCharset(final Charset charset)
cli@37
   378
	{
cli@37
   379
		this.charset = charset;
cli@37
   380
	}
cli@37
   381
cli@37
   382
	void setLastActivity(long timestamp)
cli@37
   383
	{
cli@37
   384
		this.lastActivity = timestamp;
cli@37
   385
	}
chris@1
   386
}