View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.net;
19  
20  import java.io.PrintStream;
21  import java.io.PrintWriter;
22  
23  /**
24   * This is a support class for some of the example programs.  It is
25   * a sample implementation of the ProtocolCommandListener interface
26   * which just prints out to a specified stream all command/reply traffic.
27   *
28   * @since 2.0
29   */
30  
31  public class PrintCommandListener implements ProtocolCommandListener
32  {
33      private final PrintWriter writer;
34      private final boolean nologin;
35      private final char eolMarker;
36      private final boolean directionMarker;
37  
38      /**
39       * Create the default instance which prints everything.
40       *
41       * @param stream where to write the commands and responses
42       * e.g. System.out
43       * @since 3.0
44       */
45      public PrintCommandListener(final PrintStream stream)
46      {
47          this(new PrintWriter(stream));
48      }
49  
50      /**
51       * Create an instance which optionally suppresses login command text
52       * and indicates where the EOL starts with the specified character.
53       *
54       * @param stream where to write the commands and responses
55       * @param suppressLogin if {@code true}, only print command name for login
56       *
57       * @since 3.0
58       */
59      public PrintCommandListener(final PrintStream stream, final boolean suppressLogin) {
60          this(new PrintWriter(stream), suppressLogin);
61      }
62  
63      /**
64       * Create an instance which optionally suppresses login command text
65       * and indicates where the EOL starts with the specified character.
66       *
67       * @param stream where to write the commands and responses
68       * @param suppressLogin if {@code true}, only print command name for login
69       * @param eolMarker if non-zero, add a marker just before the EOL.
70       *
71       * @since 3.0
72       */
73      public PrintCommandListener(final PrintStream stream, final boolean suppressLogin, final char eolMarker) {
74          this(new PrintWriter(stream), suppressLogin, eolMarker);
75      }
76  
77      /**
78       * Create an instance which optionally suppresses login command text
79       * and indicates where the EOL starts with the specified character.
80       *
81       * @param stream where to write the commands and responses
82       * @param suppressLogin if {@code true}, only print command name for login
83       * @param eolMarker if non-zero, add a marker just before the EOL.
84       * @param showDirection if {@code true}, add {@code "> "} or {@code "< "} as appropriate to the output
85       *
86       * @since 3.0
87       */
88      public PrintCommandListener(final PrintStream stream, final boolean suppressLogin, final char eolMarker,
89              final boolean showDirection) {
90          this(new PrintWriter(stream), suppressLogin, eolMarker, showDirection);
91      }
92  
93      /**
94       * Create the default instance which prints everything.
95       *
96       * @param writer where to write the commands and responses
97       */
98      public PrintCommandListener(final PrintWriter writer)
99      {
100         this(writer, false);
101     }
102 
103     /**
104      * Create an instance which optionally suppresses login command text.
105      *
106      * @param writer where to write the commands and responses
107      * @param suppressLogin if {@code true}, only print command name for login
108      *
109      * @since 3.0
110      */
111     public PrintCommandListener(final PrintWriter writer, final boolean suppressLogin)
112     {
113         this(writer, suppressLogin, (char) 0);
114     }
115 
116     /**
117      * Create an instance which optionally suppresses login command text
118      * and indicates where the EOL starts with the specified character.
119      *
120      * @param writer where to write the commands and responses
121      * @param suppressLogin if {@code true}, only print command name for login
122      * @param eolMarker if non-zero, add a marker just before the EOL.
123      *
124      * @since 3.0
125      */
126     public PrintCommandListener(final PrintWriter writer, final boolean suppressLogin, final char eolMarker)
127     {
128         this(writer, suppressLogin, eolMarker, false);
129     }
130 
131     /**
132      * Create an instance which optionally suppresses login command text
133      * and indicates where the EOL starts with the specified character.
134      *
135      * @param writer where to write the commands and responses
136      * @param suppressLogin if {@code true}, only print command name for login
137      * @param eolMarker if non-zero, add a marker just before the EOL.
138      * @param showDirection if {@code true}, add {@code ">} " or {@code "< "} as appropriate to the output
139      *
140      * @since 3.0
141      */
142     public PrintCommandListener(final PrintWriter writer, final boolean suppressLogin, final char eolMarker,
143             final boolean showDirection) {
144         this.writer = writer;
145         this.nologin = suppressLogin;
146         this.eolMarker = eolMarker;
147         this.directionMarker = showDirection;
148     }
149 
150     @Override
151     public void protocolCommandSent(final ProtocolCommandEvent event)
152     {
153         if (directionMarker) {
154             writer.print("> ");
155         }
156         if (nologin) {
157             final String cmd = event.getCommand();
158             if ("PASS".equalsIgnoreCase(cmd) || "USER".equalsIgnoreCase(cmd)) {
159                 writer.print(cmd);
160                 writer.println(" *******"); // Don't bother with EOL marker for this!
161             } else {
162                 final String IMAP_LOGIN = "LOGIN";
163                 if (IMAP_LOGIN.equalsIgnoreCase(cmd)) { // IMAP
164                     String msg = event.getMessage();
165                     msg=msg.substring(0, msg.indexOf(IMAP_LOGIN)+IMAP_LOGIN.length());
166                     writer.print(msg);
167                     writer.println(" *******"); // Don't bother with EOL marker for this!
168                 } else {
169                     writer.print(getPrintableString(event.getMessage()));
170                 }
171             }
172         } else {
173             writer.print(getPrintableString(event.getMessage()));
174         }
175         writer.flush();
176     }
177 
178     private String getPrintableString(final String msg){
179         if (eolMarker == 0) {
180             return msg;
181         }
182         final int pos = msg.indexOf(SocketClient.NETASCII_EOL);
183         if (pos > 0) {
184             final StringBuilder sb = new StringBuilder();
185             sb.append(msg.substring(0,pos));
186             sb.append(eolMarker);
187             sb.append(msg.substring(pos));
188             return sb.toString();
189         }
190         return msg;
191     }
192 
193     @Override
194     public void protocolReplyReceived(final ProtocolCommandEvent event)
195     {
196         if (directionMarker) {
197             writer.print("< ");
198         }
199         writer.print(event.getMessage());
200         writer.flush();
201     }
202 }
203