src/org/sonews/daemon/NNTPConnection.java
author František Kučera <franta-hg@frantovo.cz>
Wed, 19 Oct 2011 21:40:51 +0200
changeset 101 d54786065fa3
parent 49 8df94bfd3e2f
child 108 fdc075324ef3
permissions -rwxr-xr-x
Drupal: ověřování uživatelů.
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
package org.sonews.daemon;
chris@1
    19
chris@1
    20
import java.io.IOException;
chris@1
    21
import java.net.InetSocketAddress;
chris@3
    22
import java.net.SocketException;
chris@1
    23
import java.nio.ByteBuffer;
chris@1
    24
import java.nio.CharBuffer;
chris@1
    25
import java.nio.channels.ClosedChannelException;
chris@1
    26
import java.nio.channels.SelectionKey;
chris@1
    27
import java.nio.channels.SocketChannel;
chris@1
    28
import java.nio.charset.Charset;
chris@3
    29
import java.util.Arrays;
chris@1
    30
import java.util.Timer;
chris@1
    31
import java.util.TimerTask;
cli@49
    32
import java.util.logging.Level;
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
 */
cli@49
    46
public final class NNTPConnection {
chris@1
    47
cli@37
    48
	public static final String NEWLINE = "\r\n";    // RFC defines this as newline
cli@37
    49
	public static final String MESSAGE_ID_PATTERN = "<[^>]+>";
cli@37
    50
	private static final Timer cancelTimer = new Timer(true); // Thread-safe? True for run as daemon
cli@37
    51
	/** SocketChannel is generally thread-safe */
cli@37
    52
	private SocketChannel channel = null;
cli@37
    53
	private Charset charset = Charset.forName("UTF-8");
cli@37
    54
	private Command command = null;
cli@37
    55
	private Article currentArticle = null;
cli@48
    56
	private Group currentGroup = null;
cli@37
    57
	private volatile long lastActivity = System.currentTimeMillis();
cli@37
    58
	private ChannelLineBuffers lineBuffers = new ChannelLineBuffers();
cli@37
    59
	private int readLock = 0;
cli@37
    60
	private final Object readLockGate = new Object();
cli@37
    61
	private SelectionKey writeSelKey = null;
franta-hg@101
    62
	
franta-hg@101
    63
	private String username;
franta-hg@101
    64
	private boolean userAuthenticated = false;
chris@1
    65
cli@37
    66
	public NNTPConnection(final SocketChannel channel)
cli@49
    67
			throws IOException {
cli@37
    68
		if (channel == null) {
cli@37
    69
			throw new IllegalArgumentException("channel is null");
cli@37
    70
		}
chris@1
    71
cli@37
    72
		this.channel = channel;
cli@37
    73
		Stats.getInstance().clientConnect();
cli@37
    74
	}
chris@1
    75
cli@37
    76
	/**
cli@37
    77
	 * Tries to get the read lock for this NNTPConnection. This method is Thread-
cli@37
    78
	 * safe and returns true of the read lock was successfully set. If the lock
cli@37
    79
	 * is still hold by another Thread the method returns false.
cli@37
    80
	 */
cli@49
    81
	boolean tryReadLock() {
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@49
    99
	void unlockReadLock() {
cli@37
   100
		synchronized (readLockGate) {
cli@37
   101
			if (readLock == Thread.currentThread().hashCode()) {
cli@37
   102
				readLock = 0;
cli@37
   103
			} else {
cli@37
   104
				throw new IllegalMonitorStateException();
cli@37
   105
			}
cli@37
   106
		}
cli@37
   107
	}
chris@1
   108
cli@37
   109
	/**
cli@37
   110
	 * @return Current input buffer of this NNTPConnection instance.
cli@37
   111
	 */
cli@49
   112
	public ByteBuffer getInputBuffer() {
cli@37
   113
		return this.lineBuffers.getInputBuffer();
cli@37
   114
	}
chris@1
   115
cli@37
   116
	/**
cli@37
   117
	 * @return Output buffer of this NNTPConnection which has at least one byte
cli@37
   118
	 * free storage.
cli@37
   119
	 */
cli@49
   120
	public ByteBuffer getOutputBuffer() {
cli@37
   121
		return this.lineBuffers.getOutputBuffer();
cli@37
   122
	}
cli@30
   123
cli@37
   124
	/**
cli@37
   125
	 * @return ChannelLineBuffers instance associated with this NNTPConnection.
cli@37
   126
	 */
cli@49
   127
	public ChannelLineBuffers getBuffers() {
cli@37
   128
		return this.lineBuffers;
cli@37
   129
	}
chris@1
   130
cli@37
   131
	/**
cli@37
   132
	 * @return true if this connection comes from a local remote address.
cli@37
   133
	 */
cli@49
   134
	public boolean isLocalConnection() {
cli@37
   135
		return ((InetSocketAddress) this.channel.socket().getRemoteSocketAddress()).getHostName().equalsIgnoreCase("localhost");
cli@37
   136
	}
chris@3
   137
cli@49
   138
	void setWriteSelectionKey(SelectionKey selKey) {
cli@37
   139
		this.writeSelKey = selKey;
cli@37
   140
	}
chris@3
   141
cli@49
   142
	public void shutdownInput() {
cli@37
   143
		try {
cli@37
   144
			// Closes the input line of the channel's socket, so no new data
cli@37
   145
			// will be received and a timeout can be triggered.
cli@37
   146
			this.channel.socket().shutdownInput();
cli@37
   147
		} catch (IOException ex) {
cli@37
   148
			Log.get().warning("Exception in NNTPConnection.shutdownInput(): " + ex);
cli@37
   149
		}
cli@37
   150
	}
chris@1
   151
cli@49
   152
	public void shutdownOutput() {
cli@49
   153
		cancelTimer.schedule(new TimerTask() {
cli@37
   154
			@Override
cli@49
   155
			public void run() {
cli@37
   156
				try {
cli@37
   157
					// Closes the output line of the channel's socket.
cli@37
   158
					channel.socket().shutdownOutput();
cli@37
   159
					channel.close();
cli@37
   160
				} catch (SocketException ex) {
cli@37
   161
					// Socket was already disconnected
cli@37
   162
					Log.get().info("NNTPConnection.shutdownOutput(): " + ex);
cli@37
   163
				} catch (Exception ex) {
cli@37
   164
					Log.get().warning("NNTPConnection.shutdownOutput(): " + ex);
cli@37
   165
				}
cli@37
   166
			}
cli@37
   167
		}, 3000);
cli@37
   168
	}
cli@37
   169
cli@49
   170
	public SocketChannel getSocketChannel() {
cli@37
   171
		return this.channel;
cli@37
   172
	}
cli@37
   173
cli@49
   174
	public Article getCurrentArticle() {
cli@37
   175
		return this.currentArticle;
cli@37
   176
	}
cli@37
   177
cli@49
   178
	public Charset getCurrentCharset() {
cli@37
   179
		return this.charset;
cli@37
   180
	}
cli@37
   181
cli@37
   182
	/**
cli@37
   183
	 * @return The currently selected communication channel (not SocketChannel)
cli@37
   184
	 */
cli@49
   185
	public Group getCurrentChannel() {
cli@37
   186
		return this.currentGroup;
cli@37
   187
	}
cli@37
   188
cli@49
   189
	public void setCurrentArticle(final Article article) {
cli@37
   190
		this.currentArticle = article;
cli@37
   191
	}
cli@37
   192
cli@49
   193
	public void setCurrentGroup(final Group group) {
cli@37
   194
		this.currentGroup = group;
cli@37
   195
	}
cli@37
   196
cli@49
   197
	public long getLastActivity() {
cli@37
   198
		return this.lastActivity;
cli@37
   199
	}
cli@37
   200
cli@37
   201
	/**
cli@37
   202
	 * Due to the readLockGate there is no need to synchronize this method.
cli@37
   203
	 * @param raw
cli@37
   204
	 * @throws IllegalArgumentException if raw is null.
cli@37
   205
	 * @throws IllegalStateException if calling thread does not own the readLock.
cli@37
   206
	 */
cli@49
   207
	void lineReceived(byte[] raw) {
cli@37
   208
		if (raw == null) {
cli@37
   209
			throw new IllegalArgumentException("raw is null");
cli@37
   210
		}
cli@37
   211
cli@37
   212
		if (readLock == 0 || readLock != Thread.currentThread().hashCode()) {
cli@37
   213
			throw new IllegalStateException("readLock not properly set");
cli@37
   214
		}
cli@37
   215
cli@37
   216
		this.lastActivity = System.currentTimeMillis();
cli@37
   217
cli@37
   218
		String line = new String(raw, this.charset);
cli@37
   219
cli@37
   220
		// There might be a trailing \r, but trim() is a bad idea
cli@37
   221
		// as it removes also leading spaces from long header lines.
cli@37
   222
		if (line.endsWith("\r")) {
cli@37
   223
			line = line.substring(0, line.length() - 1);
cli@37
   224
			raw = Arrays.copyOf(raw, raw.length - 1);
cli@37
   225
		}
cli@37
   226
cli@37
   227
		Log.get().fine("<< " + line);
cli@37
   228
cli@37
   229
		if (command == null) {
cli@37
   230
			command = parseCommandLine(line);
cli@37
   231
			assert command != null;
cli@37
   232
		}
cli@37
   233
cli@37
   234
		try {
cli@37
   235
			// The command object will process the line we just received
cli@37
   236
			try {
cli@37
   237
				command.processLine(this, line, raw);
cli@37
   238
			} catch (StorageBackendException ex) {
cli@37
   239
				Log.get().info("Retry command processing after StorageBackendException");
cli@37
   240
cli@37
   241
				// Try it a second time, so that the backend has time to recover
cli@37
   242
				command.processLine(this, line, raw);
cli@37
   243
			}
cli@37
   244
		} catch (ClosedChannelException ex0) {
cli@37
   245
			try {
cli@49
   246
				StringBuilder strBuf = new StringBuilder();
cli@49
   247
				strBuf.append("Connection to ");
cli@49
   248
				strBuf.append(channel.socket().getRemoteSocketAddress());
cli@49
   249
				strBuf.append(" closed: ");
cli@49
   250
				strBuf.append(ex0);
cli@49
   251
				Log.get().info(strBuf.toString());
cli@37
   252
			} catch (Exception ex0a) {
cli@37
   253
				ex0a.printStackTrace();
cli@37
   254
			}
cli@49
   255
		} catch (Exception ex1) { // This will catch a second StorageBackendException
cli@37
   256
			try {
cli@37
   257
				command = null;
cli@49
   258
				Log.get().log(Level.WARNING, ex1.getLocalizedMessage(), ex1);
cli@49
   259
				println("403 Internal server error");
cli@49
   260
cli@49
   261
				// Should we end the connection here?
cli@49
   262
				// RFC says we MUST return 400 before closing the connection
cli@49
   263
				shutdownInput();
cli@49
   264
				shutdownOutput();
cli@37
   265
			} catch (Exception ex2) {
cli@37
   266
				ex2.printStackTrace();
cli@37
   267
			}
cli@37
   268
		}
cli@37
   269
cli@37
   270
		if (command == null || command.hasFinished()) {
cli@37
   271
			command = null;
cli@37
   272
			charset = Charset.forName("UTF-8"); // Reset to default
cli@37
   273
		}
cli@37
   274
	}
cli@37
   275
cli@37
   276
	/**
cli@37
   277
	 * This method determines the fitting command processing class.
cli@37
   278
	 * @param line
cli@37
   279
	 * @return
cli@37
   280
	 */
cli@49
   281
	private Command parseCommandLine(String line) {
cli@37
   282
		String cmdStr = line.split(" ")[0];
cli@37
   283
		return CommandSelector.getInstance().get(cmdStr);
cli@37
   284
	}
cli@37
   285
cli@37
   286
	/**
cli@37
   287
	 * Puts the given line into the output buffer, adds a newline character
cli@37
   288
	 * and returns. The method returns immediately and does not block until
cli@37
   289
	 * the line was sent. If line is longer than 510 octets it is split up in
cli@37
   290
	 * several lines. Each line is terminated by \r\n (NNTPConnection.NEWLINE).
cli@37
   291
	 * @param line
cli@37
   292
	 */
cli@37
   293
	public void println(final CharSequence line, final Charset charset)
cli@49
   294
			throws IOException {
cli@37
   295
		writeToChannel(CharBuffer.wrap(line), charset, line);
cli@37
   296
		writeToChannel(CharBuffer.wrap(NEWLINE), charset, null);
cli@37
   297
	}
cli@37
   298
cli@37
   299
	/**
cli@37
   300
	 * Writes the given raw lines to the output buffers and finishes with
cli@37
   301
	 * a newline character (\r\n).
cli@37
   302
	 * @param rawLines
cli@37
   303
	 */
cli@37
   304
	public void println(final byte[] rawLines)
cli@49
   305
			throws IOException {
cli@37
   306
		this.lineBuffers.addOutputBuffer(ByteBuffer.wrap(rawLines));
cli@37
   307
		writeToChannel(CharBuffer.wrap(NEWLINE), charset, null);
cli@37
   308
	}
cli@37
   309
cli@37
   310
	/**
cli@37
   311
	 * Encodes the given CharBuffer using the given Charset to a bunch of
cli@37
   312
	 * ByteBuffers (each 512 bytes large) and enqueues them for writing at the
cli@37
   313
	 * connected SocketChannel.
cli@37
   314
	 * @throws java.io.IOException
cli@37
   315
	 */
cli@37
   316
	private void writeToChannel(CharBuffer characters, final Charset charset,
cli@49
   317
			CharSequence debugLine)
cli@49
   318
			throws IOException {
cli@37
   319
		if (!charset.canEncode()) {
cli@37
   320
			Log.get().severe("FATAL: Charset " + charset + " cannot encode!");
cli@37
   321
			return;
cli@37
   322
		}
cli@37
   323
cli@37
   324
		// Write characters to output buffers
cli@37
   325
		LineEncoder lenc = new LineEncoder(characters, charset);
cli@37
   326
		lenc.encode(lineBuffers);
cli@37
   327
cli@37
   328
		enableWriteEvents(debugLine);
cli@37
   329
	}
cli@37
   330
cli@49
   331
	private void enableWriteEvents(CharSequence debugLine) {
cli@37
   332
		// Enable OP_WRITE events so that the buffers are processed
cli@37
   333
		try {
cli@37
   334
			this.writeSelKey.interestOps(SelectionKey.OP_WRITE);
cli@37
   335
			ChannelWriter.getInstance().getSelector().wakeup();
cli@37
   336
		} catch (Exception ex) // CancelledKeyException and ChannelCloseException
cli@37
   337
		{
cli@37
   338
			Log.get().warning("NNTPConnection.writeToChannel(): " + ex);
cli@37
   339
			return;
cli@37
   340
		}
cli@37
   341
cli@37
   342
		// Update last activity timestamp
cli@37
   343
		this.lastActivity = System.currentTimeMillis();
cli@37
   344
		if (debugLine != null) {
cli@37
   345
			Log.get().fine(">> " + debugLine);
cli@37
   346
		}
cli@37
   347
	}
cli@37
   348
cli@37
   349
	public void println(final CharSequence line)
cli@49
   350
			throws IOException {
cli@37
   351
		println(line, charset);
cli@37
   352
	}
cli@37
   353
cli@37
   354
	public void print(final String line)
cli@49
   355
			throws IOException {
cli@37
   356
		writeToChannel(CharBuffer.wrap(line), charset, line);
cli@37
   357
	}
cli@37
   358
cli@49
   359
	public void setCurrentCharset(final Charset charset) {
cli@37
   360
		this.charset = charset;
cli@37
   361
	}
cli@37
   362
cli@49
   363
	void setLastActivity(long timestamp) {
cli@37
   364
		this.lastActivity = timestamp;
cli@37
   365
	}
franta-hg@101
   366
franta-hg@101
   367
	/**
franta-hg@101
   368
	 * @return Current username. 
franta-hg@101
   369
	 * But user may not have been authenticated yet.
franta-hg@101
   370
	 * You must check {@link #isUserAuthenticated()}
franta-hg@101
   371
	 */
franta-hg@101
   372
	public String getUsername() {
franta-hg@101
   373
		return username;
franta-hg@101
   374
	}
franta-hg@101
   375
franta-hg@101
   376
	/**
franta-hg@101
   377
	 * This method is to be called from AUTHINFO USER Command implementation.
franta-hg@101
   378
	 * @param username username from AUTHINFO USER username.
franta-hg@101
   379
	 */
franta-hg@101
   380
	public void setUsername(String username) {
franta-hg@101
   381
		this.username = username;
franta-hg@101
   382
	}
franta-hg@101
   383
franta-hg@101
   384
	/**
franta-hg@101
   385
	 * @return true if current user (see {@link #getUsername()}) has been succesfully authenticated.
franta-hg@101
   386
	 */
franta-hg@101
   387
	public boolean isUserAuthenticated() {
franta-hg@101
   388
		return userAuthenticated;
franta-hg@101
   389
	}
franta-hg@101
   390
franta-hg@101
   391
	/**
franta-hg@101
   392
	 * This method is to be called from AUTHINFO PASS Command implementation.
franta-hg@101
   393
	 * @param userAuthenticated true if user has provided right password in AUTHINFO PASS password.
franta-hg@101
   394
	 */
franta-hg@101
   395
	public void setUserAuthenticated(boolean userAuthenticated) {
franta-hg@101
   396
		this.userAuthenticated = userAuthenticated;
franta-hg@101
   397
	}
chris@1
   398
}