src/org/sonews/daemon/command/XPatCommand.java
author František Kučera <franta-hg@frantovo.cz>
Mon, 07 Nov 2011 17:35:43 +0100
changeset 117 79ce65d63cce
parent 37 74139325d305
permissions -rwxr-xr-x
ACL: uživatel v Article bude jako User ne jen jako String.
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.command;
chris@1
    20
chris@1
    21
import java.io.IOException;
chris@3
    22
import java.util.List;
chris@3
    23
import java.util.Locale;
chris@3
    24
import java.util.regex.PatternSyntaxException;
chris@1
    25
import org.sonews.daemon.NNTPConnection;
chris@3
    26
import org.sonews.storage.StorageBackendException;
chris@3
    27
import org.sonews.storage.StorageManager;
chris@3
    28
import org.sonews.util.Pair;
chris@1
    29
chris@1
    30
/**
chris@1
    31
 * <pre>
chris@1
    32
 *   XPAT header range|<message-id> pat [pat...]
chris@1
    33
 *
chris@1
    34
 *   The XPAT command is used to retrieve specific headers from
chris@1
    35
 *   specific articles, based on pattern matching on the contents of
chris@1
    36
 *   the header. This command was first available in INN.
chris@1
    37
 *
chris@1
    38
 *   The required header parameter is the name of a header line (e.g.
chris@1
    39
 *   "subject") in a news group article. See RFC-1036 for a list
chris@1
    40
 *   of valid header lines. The required range argument may be
chris@1
    41
 *   any of the following:
chris@1
    42
 *               an article number
chris@1
    43
 *               an article number followed by a dash to indicate
chris@1
    44
 *                  all following
chris@1
    45
 *               an article number followed by a dash followed by
chris@1
    46
 *                  another article number
chris@1
    47
 *
chris@1
    48
 *   The required message-id argument indicates a specific
chris@1
    49
 *   article. The range and message-id arguments are mutually
chris@1
    50
 *   exclusive. At least one pattern in wildmat must be specified
chris@1
    51
 *   as well. If there are additional arguments the are joined
chris@1
    52
 *   together separated by a single space to form one complete
chris@1
    53
 *   pattern. Successful responses start with a 221 response
chris@1
    54
 *   followed by a the headers from all messages in which the
chris@1
    55
 *   pattern matched the contents of the specified header line. This
chris@1
    56
 *   includes an empty list. Once the output is complete, a period
chris@1
    57
 *   is sent on a line by itself. If the optional argument is a
chris@1
    58
 *   message-id and no such article exists, the 430 error response
chris@1
    59
 *   is returned. A 502 response will be returned if the client only
chris@1
    60
 *   has permission to transfer articles.
chris@1
    61
 *
chris@1
    62
 *   Responses
chris@1
    63
 *
chris@1
    64
 *       221 Header follows
chris@1
    65
 *       430 no such article
chris@1
    66
 *       502 no permission
chris@3
    67
 *
chris@3
    68
 *   Response Data:
chris@3
    69
 *
chris@3
    70
 *       art_nr fitting_header_value
chris@3
    71
 * 
chris@1
    72
 * </pre>
chris@1
    73
 * [Source:"draft-ietf-nntp-imp-02.txt"] [Copyright: 1998 S. Barber]
chris@1
    74
 * 
chris@1
    75
 * @author Christian Lins
chris@1
    76
 * @since sonews/0.5.0
chris@1
    77
 */
chris@3
    78
public class XPatCommand implements Command
chris@1
    79
{
chris@1
    80
cli@37
    81
	@Override
cli@37
    82
	public String[] getSupportedCommandStrings()
cli@37
    83
	{
cli@37
    84
		return new String[] {"XPAT"};
cli@37
    85
	}
chris@1
    86
cli@37
    87
	@Override
cli@37
    88
	public boolean hasFinished()
cli@37
    89
	{
cli@37
    90
		return true;
cli@37
    91
	}
cli@20
    92
cli@37
    93
	@Override
cli@37
    94
	public String impliedCapability()
cli@37
    95
	{
cli@37
    96
		return null;
cli@37
    97
	}
chris@3
    98
cli@37
    99
	@Override
cli@37
   100
	public boolean isStateful()
cli@37
   101
	{
cli@37
   102
		return false;
cli@37
   103
	}
chris@3
   104
cli@37
   105
	@Override
cli@37
   106
	public void processLine(NNTPConnection conn, final String line, byte[] raw)
cli@37
   107
		throws IOException, StorageBackendException
cli@37
   108
	{
cli@37
   109
		if (conn.getCurrentChannel() == null) {
cli@37
   110
			conn.println("430 no group selected");
cli@37
   111
			return;
cli@37
   112
		}
chris@3
   113
cli@37
   114
		String[] command = line.split("\\p{Space}+");
chris@3
   115
cli@37
   116
		// There may be multiple patterns and Thunderbird produces
cli@37
   117
		// additional spaces between range and pattern
cli@37
   118
		if (command.length >= 4) {
cli@37
   119
			String header = command[1].toLowerCase(Locale.US);
cli@37
   120
			String range = command[2];
cli@37
   121
			String pattern = command[3];
chris@3
   122
cli@37
   123
			long start = -1;
cli@37
   124
			long end = -1;
cli@37
   125
			if (range.contains("-")) {
cli@37
   126
				String[] rsplit = range.split("-", 2);
cli@37
   127
				start = Long.parseLong(rsplit[0]);
cli@37
   128
				if (rsplit[1].length() > 0) {
cli@37
   129
					end = Long.parseLong(rsplit[1]);
cli@37
   130
				}
cli@37
   131
			} else // TODO: Handle Message-IDs
cli@37
   132
			{
cli@37
   133
				start = Long.parseLong(range);
cli@37
   134
			}
chris@1
   135
cli@37
   136
			try {
cli@37
   137
				List<Pair<Long, String>> heads = StorageManager.current().
cli@37
   138
					getArticleHeaders(conn.getCurrentChannel(), start, end, header, pattern);
cli@37
   139
cli@37
   140
				conn.println("221 header follows");
cli@37
   141
				for (Pair<Long, String> head : heads) {
cli@37
   142
					conn.println(head.getA() + " " + head.getB());
cli@37
   143
				}
cli@37
   144
				conn.println(".");
cli@37
   145
			} catch (PatternSyntaxException ex) {
cli@37
   146
				ex.printStackTrace();
cli@37
   147
				conn.println("500 invalid pattern syntax");
cli@37
   148
			} catch (StorageBackendException ex) {
cli@37
   149
				ex.printStackTrace();
cli@37
   150
				conn.println("500 internal server error");
cli@37
   151
			}
cli@37
   152
		} else {
cli@37
   153
			conn.println("430 invalid command usage");
cli@37
   154
		}
cli@37
   155
	}
chris@1
   156
}