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(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(PrintStream stream, 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(PrintStream stream, boolean suppressLogin, 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(PrintStream stream, boolean suppressLogin, char eolMarker, boolean showDirection) {
89          this(new PrintWriter(stream), suppressLogin, eolMarker, showDirection);
90      }
91  
92      /**
93       * Create the default instance which prints everything.
94       *
95       * @param writer where to write the commands and responses
96       */
97      public PrintCommandListener(PrintWriter writer)
98      {
99          this(writer, false);
100     }
101 
102     /**
103      * Create an instance which optionally suppresses login command text.
104      *
105      * @param writer where to write the commands and responses
106      * @param suppressLogin if {@code true}, only print command name for login
107      *
108      * @since 3.0
109      */
110     public PrintCommandListener(PrintWriter writer, boolean suppressLogin)
111     {
112         this(writer, suppressLogin, (char) 0);
113     }
114 
115     /**
116      * Create an instance which optionally suppresses login command text
117      * and indicates where the EOL starts with the specified character.
118      *
119      * @param writer where to write the commands and responses
120      * @param suppressLogin if {@code true}, only print command name for login
121      * @param eolMarker if non-zero, add a marker just before the EOL.
122      *
123      * @since 3.0
124      */
125     public PrintCommandListener(PrintWriter writer, boolean suppressLogin, char eolMarker)
126     {
127         this(writer, suppressLogin, eolMarker, false);
128     }
129 
130     /**
131      * Create an instance which optionally suppresses login command text
132      * and indicates where the EOL starts with the specified character.
133      *
134      * @param writer where to write the commands and responses
135      * @param suppressLogin if {@code true}, only print command name for login
136      * @param eolMarker if non-zero, add a marker just before the EOL.
137      * @param showDirection if {@code true}, add {@code ">} " or {@code "< "} as appropriate to the output
138      *
139      * @since 3.0
140      */
141     public PrintCommandListener(PrintWriter writer, boolean suppressLogin, char eolMarker, boolean showDirection)
142     {
143         __writer = writer;
144         __nologin = suppressLogin;
145         __eolMarker = eolMarker;
146         __directionMarker = showDirection;
147     }
148 
149 //    @Override
150     public void protocolCommandSent(ProtocolCommandEvent event)
151     {
152         if (__directionMarker) {
153             __writer.print("> ");
154         }
155         if (__nologin) {
156             String cmd = event.getCommand();
157             if ("PASS".equalsIgnoreCase(cmd) || "USER".equalsIgnoreCase(cmd)) {
158                 __writer.print(cmd);
159                 __writer.println(" *******"); // Don't bother with EOL marker for this!
160             } else {
161                 final String IMAP_LOGIN = "LOGIN";
162                 if (IMAP_LOGIN.equalsIgnoreCase(cmd)) { // IMAP
163                     String msg = event.getMessage();
164                     msg=msg.substring(0, msg.indexOf(IMAP_LOGIN)+IMAP_LOGIN.length());
165                     __writer.print(msg);
166                     __writer.println(" *******"); // Don't bother with EOL marker for this!
167                 } else {
168                     __writer.print(getPrintableString(event.getMessage()));
169                 }
170             }
171         } else {
172             __writer.print(getPrintableString(event.getMessage()));
173         }
174         __writer.flush();
175     }
176 
177     private String getPrintableString(String msg){
178         if (__eolMarker == 0) {
179             return msg;
180         }
181         int pos = msg.indexOf(SocketClient.NETASCII_EOL);
182         if (pos > 0) {
183             StringBuilder sb = new StringBuilder();
184             sb.append(msg.substring(0,pos));
185             sb.append(__eolMarker);
186             sb.append(msg.substring(pos));
187             return sb.toString();
188         }
189         return msg;
190     }
191 //    @Override
192     public void protocolReplyReceived(ProtocolCommandEvent event)
193     {
194         if (__directionMarker) {
195             __writer.print("< ");
196         }
197         __writer.print(event.getMessage());
198         __writer.flush();
199     }
200 }
201