author Mike Conley <>
Tue, 14 Aug 2012 10:10:26 -0400
changeset 12544 8ad0a8d8ffc9bfbc237c7fb54da56d809ef59a40
parent 12286 84ac3c71109811da751f0ef2d72108075938f094
child 13324 3f9b812e72471c2172bfde0ebbeeb210bf5f1a95
permissions -rw-r--r--
Bug 741728 - Previous conversations should be collapsed by default. r=florian, ui-r=florian, a=Standard8.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

#ifndef nsNNTPProtocol_h___
#define nsNNTPProtocol_h___

#include "nsMsgProtocol.h"

#include "nsCOMPtr.h"
#include "nsIAsyncInputStream.h"
#include "nsIAsyncOutputStream.h"
#include "nsINntpUrl.h"
#include "nsINntpIncomingServer.h"
#include "nsINNTPProtocol.h"

#include "nsINNTPNewsgroupList.h"
#include "nsINNTPArticleList.h"
#include "nsIMsgAsyncPrompter.h"
#include "nsIMsgNewsFolder.h"
#include "nsIMsgWindow.h"

#include "nsMsgLineBuffer.h"
#include "nsIStringBundle.h"
#include "nsITimer.h"
#include "nsICacheListener.h"

// this is only needed as long as our libmime hack is in place
#include "prio.h"

// State Flags (Note, I use the word state in terms of storing
// state information about the connection (authentication, have we sent
// commands, etc. I do not intend it to refer to protocol state)

#define NNTP_PAUSE_FOR_READ      0x00000001  /* should we pause for the next read */
#define NNTP_PROXY_AUTH_REQUIRED    0x00000002  /* is auth required */
#define NNTP_SENT_PROXY_AUTH        0x00000004  /* have we sent a proxy auth? */
#define NNTP_READER_PERFORMED       0x00000010  /* have we sent any cmds to the server yet? */
#define NNTP_USE_FANCY_NEWSGROUP    0x00000020  /* use LIST XACTIVE or LIST */
#define NNTP_DESTROY_PROGRESS_GRAPH 0x00000040  /* do we need to destroy graph progress */
#define NNTP_SOME_PROTOCOL_SUCCEEDED 0x0000080  /* some protocol has suceeded so don't kill the connection */
#define NNTP_NO_XOVER_SUPPORT       0x00000100  /* xover command is not supported here */

/* states of the machine
typedef enum _StatesEnum {
} StatesEnum;

class nsICacheEntryDescriptor;

class nsNNTPProtocol : public nsMsgProtocol,
                       public nsINNTPProtocol,
                       public nsITimerCallback,
                       public nsICacheListener,
                       public nsIMsgAsyncPromptListener

  // Creating a protocol instance requires the URL
  // need to call Initialize after we do a new of nsNNTPProtocol
  nsNNTPProtocol(nsINntpIncomingServer *aServer, nsIURI *aURL,
                 nsIMsgWindow *aMsgWindow);
  virtual ~nsNNTPProtocol();

  // stop binding is a "notification" informing us that the stream associated with aURL is going away.
  NS_IMETHOD OnStopRequest(nsIRequest *request, nsISupports * aCtxt, nsresult aStatus);

  char * m_ProxyServer;    /* proxy server hostname */

  NS_IMETHOD Cancel(nsresult status);  // handle stop button
  NS_IMETHOD GetContentType(nsACString &aContentType);
  NS_IMETHOD AsyncOpen(nsIStreamListener *listener, nsISupports *ctxt);
  NS_IMETHOD GetOriginalURI(nsIURI* *aURI);
  NS_IMETHOD SetOriginalURI(nsIURI* aURI);

  nsresult LoadUrl(nsIURI * aURL, nsISupports * aConsumer);

   * Triggers the protocol state machine.
   * Most of the time, this machine will read as much input as it can before
   * closing.
   * This method additionally handles some states not covered by other methods:
   * NEWS_DONE: Alias for NEWS_FREE
   * NEWS_POST_DONE: Alias for NEWS_FREE that cleans up the URL state
   * NEWS_ERROR: An error which permits further use of the connection
   * NNTP_ERROR: An error which does not permit further use of the connection
   * NEWS_FREE: Cleans up from the current URL and prepares for the next one
   * NNTP_SUSPENDED: A state where the state machine does not read input until
   *                 reenabled by a non-network related callback
   * @note Use of NNTP_SUSPENDED is dangerous: if input comes along the socket,
   * the code will not read the input stream at all. Therefore, it is strongly
   * advised to suspend the request before using this state.
  virtual nsresult ProcessProtocolState(nsIURI * url, nsIInputStream * inputStream,
    PRUint32 sourceOffset, PRUint32 length);
  virtual nsresult CloseSocket();

  // we have our own implementation of SendData which writes to the nntp log
  // and then calls the base class to transmit the data
  nsresult SendData(const char * dataBuffer, bool aSuppressLogging = false);

  nsresult CleanupAfterRunningUrl();
  void Cleanup(); //free char* member variables

  void ParseHeaderForCancel(char *buf);

  virtual const char* GetType() {return "nntp";}

  static bool CheckIfAuthor(nsISupports *aElement, void *data);

  nsCOMPtr <nsINNTPNewsgroupList> m_newsgroupList;
  nsCOMPtr <nsINNTPArticleList> m_articleList;

  nsCOMPtr <nsIMsgNewsFolder> m_newsFolder;
  nsCOMPtr <nsIMsgWindow> m_msgWindow;

  nsCOMPtr<nsIAsyncInputStream> mDisplayInputStream;
  nsCOMPtr<nsIAsyncOutputStream> mDisplayOutputStream;
  nsMsgLineStreamBuffer   * m_lineStreamBuffer; // used to efficiently extract lines from the incoming data stream
  // the nsINntpURL that is currently running
  nsCOMPtr<nsINntpUrl> m_runningURL;
  bool        m_connectionBusy;
  bool        m_fromCache;  // is this connection from the cache?
  PRTime      m_lastActiveTimeStamp;
  nsNewsAction m_newsAction;

  // Generic state information -- What state are we in? What state do we want to go to
  // after the next response? What was the last response code? etc.
  StatesEnum  m_nextState;
  StatesEnum  m_nextStateAfterResponse;
  PRInt32     m_typeWanted;     /* Article, List, or Group */
  PRInt32     m_responseCode;    /* code returned from NNTP server */
  PRInt32   m_previousResponseCode;
  char       *m_responseText;   /* text returned from NNTP server */

  char    *m_dataBuf;
  PRUint32   m_dataBufSize;

  /* for group command */
  nsCString m_currentGroup;     /* current group */

  PRInt32   m_firstArticle;
  PRInt32   m_lastArticle;
  PRInt32   m_firstPossibleArticle;
  PRInt32   m_lastPossibleArticle;

  PRInt32    m_numArticlesLoaded;  /* How many articles we got XOVER lines for. */
  PRInt32    m_numArticlesWanted; /* How many articles we wanted to get XOVER lines for. */
  PRInt32   m_maxArticles;        /* max articles to get during an XOVER */

  // Cancelation specific state. In particular, the headers that should be
  // used for the cancelation message.
  // mscott: we can probably replace this stuff with nsString
  char   *m_cancelFromHdr;
  char     *m_cancelNewsgroups;
  char     *m_cancelDistribution;
  char     *m_cancelID;
  PRInt32    m_cancelStatus;

  // variable for ReadNewsList
  PRInt32   m_readNewsListCount;

  // Per news article state information. (article number, author, subject, id, etc
  nsCString m_messageID;
  PRInt32   m_articleNumber;   /* current article number */
  nsCString m_searchData;

  PRInt32   m_originalContentLength; /* the content length at the time of calling graph progress */

  nsCOMPtr<nsIStringBundle> m_stringBundle;

  nsCOMPtr<nsINntpIncomingServer> m_nntpServer;

  nsresult GetNewsStringByName(const char *aName, PRUnichar **aString);
  nsresult GetNewsStringByID(PRInt32 stringID, PRUnichar **aString);

  PRInt32 PostMessageInFile(nsIFile * filePath);

  // Communication methods --> Reading and writing protocol

  PRInt32 ReadLine(nsIInputStream * inputStream, PRUint32 length, char ** line);

  // Protocol Methods --> This protocol is state driven so each protocol method
  //            is designed to re-act to the current "state". I've attempted to
  //            group them together based on functionality.

  // gets the response code from the nntp server and the response line. Returns the TCP return code
  // from the read.
  PRInt32 NewsResponse(nsIInputStream * inputStream, PRUint32 length);

  // Interpret the server response after the connect.
  // Returns negative if the server responds unexpectedly
  PRInt32 LoginResponse();
  PRInt32 SendModeReader();
  PRInt32 SendModeReaderResponse();

  PRInt32 SendListExtensions();
  PRInt32 SendListExtensionsResponse(nsIInputStream * inputStream, PRUint32 length);

  PRInt32 SendListSearches();
  PRInt32 SendListSearchesResponse(nsIInputStream * inputStream, PRUint32 length);

  PRInt32 SendListSearchHeaders();
  PRInt32 SendListSearchHeadersResponse(nsIInputStream * inputStream, PRUint32 length);

  PRInt32 GetProperties();
  PRInt32 GetPropertiesResponse(nsIInputStream * inputStream, PRUint32 length);

  PRInt32 SendListSubscriptions();
  PRInt32 SendListSubscriptionsResponse(nsIInputStream * inputStream, PRUint32 length);

  // Figure out what the first command is and send it.
  // Returns the status from the NETWrite.
  PRInt32 SendFirstNNTPCommand(nsIURI * url);

  // Interprets the server response from the first command sent.
  // returns negative if the server responds unexpectedly.
  PRInt32 SendFirstNNTPCommandResponse();

  PRInt32 SetupForTransfer();

  PRInt32 SendGroupForArticle();
  PRInt32 SendGroupForArticleResponse();

  PRInt32 SendArticleNumber();
  PRInt32 BeginArticle();
  PRInt32 ReadArticle(nsIInputStream * inputStream, PRUint32 length);
  PRInt32 DisplayArticle(nsIInputStream * inputStream, PRUint32 length);

  // News authentication code

   * Sends the username via AUTHINFO USER, NNTP_BEGIN_AUTHORIZE.
   * This also handles the step of getting authentication credentials; if this
   * requires a prompt to run, the connection will be suspended and we will
   * come back to this point.
   * Followed by: NNTP_AUTHORIZE_RESPONSE if the username was sent
   *              NNTP_SUSPENDED          if we need to wait for the password
  PRInt32 BeginAuthorization();
   * Sends the password if necessary, the state NNTP_AUTHORIZE_RESPONSE.
   * This also reads the result of the username.
   * Followed by: NNTP_PASSWORD_RESPONSE  if a password is sent
   *              NNTP_SEND_MODE_READER   if MODE READER needed auth
   *              SEND_FIRST_NNTP_COMMAND if any other command needed auth
   *              NNTP_ERROR              if the username was rejected
  PRInt32 AuthorizationResponse();
   * This state, NNTP_PASSWORD_RESPONSE, reads the password.
   * Followed by: NNTP_SEND_MODE_READER   if MODE READER needed auth
   *              SEND_FIRST_NNTP_COMMAND if any other command needed auth
   *              NNTP_ERROR              if the password was rejected
  PRInt32 PasswordResponse();

  PRInt32 BeginReadNewsList();
  PRInt32 ReadNewsList(nsIInputStream * inputStream, PRUint32 length);

  // Newsgroup specific protocol handlers
  PRInt32 DisplayNewsgroups();
  PRInt32 BeginNewsgroups();
  PRInt32 ProcessNewsgroups(nsIInputStream * inputStream, PRUint32 length);

  // Protocol handlers used for posting data
  PRInt32 PostData();
  PRInt32 PostDataResponse();

  PRInt32 CheckForArticle();

  // XHDR, XOVER, HEAD filtering process handlers
  // These are ordered by the rough order of usage
   * The first step in the filtering process, the state NNTP_XOVER_BEGIN.
   * This method sets up m_newsgroupList.
   * Followed by: NNTP_FIGURE_NEXT_CHUNK
  PRInt32 BeginReadXover();
   * The loop control for filtering, the state NNTP_FIGURE_NEXT_CHUNK.
   * This method contacts the newsgroupList to figure out which articles to
   * download and then prepares it for XOVER support.
   * Followed by: NEWS_PROCESS_XOVER       if everything is finished
   *              NNTP_READ_GROUP          if XOVER doesn't work
   *              NNTP_XOVER_SEND          if XOVER does work
  PRInt32 FigureNextChunk();

  // The XOVER process core
   * The state NNTP_XOVER_SEND, which actually sends the message.
   * Followed by: NNTP_XOVER_RESPONSE
  PRInt32 XoverSend();
   * This state, NNTP_XOVER_RESPONSE, actually checks the XOVER capabiliity.
   * Followed by: NNTP_XOVER               if XOVER is supported
   *              NNTP_READ_GROUP          if it isn't
  PRInt32 ReadXoverResponse();
   * This state, NNTP_XOVER, processes the results from the XOVER command.
   * It asks nsNNTPNewsgroupList to process the line using ProcessXOVERLINE.
   * Followed by: NNTP_XHDR_SEND
  PRInt32 ReadXover(nsIInputStream * inputStream, PRUint32 length);

  // The XHDR process core
   * This state, NNTP_XHDR_SEND, sends the XHDR command.
   * The headers are all managed by nsNNTPNewsgroupList, and this picks them up
   * one by one as they are needed.
   * Followed by: NNTP_XHDR_RESPONSE       if there is a header to be sent
   *              NNTP_FIGURE_NEXT_CHUNK   if all headers have been sent
  PRInt32 XhdrSend();
   * This state, NNTP_XHDR_RESPONSE, processes the XHDR response.
   * It mostly passes the information off to nsNNTPNewsgroupList, and only does
   * response code checking and a bit of preprocessing. Note that if XHDR
   * doesn't work properly, HEAD fallback is switched on and all subsequent
   * chunks will NOT use XOVER.
   * Followed by: NNTP_READ_GROUP          if XHDR doesn't work properly
   *              NNTP_XHDR_SEND           when finished processing XHR.
  PRInt32 XhdrResponse(nsIInputStream *inputStream);

  // HEAD processing core
   * This state, NNTP_READ_GROUP, is the control for the HEAD processor.
   * It sends the HEAD command and increments the article number until it is
   * finished. WARNING: HEAD is REALLY SLOW.
   * Followed by: NNTP_FIGURE_NEXT_CHUNK   when it is finished 
   *              NNTP_READ_GROUP_RESPONSE when it is not
  PRInt32 ReadHeaders();
   * This state, NNTP_READ_GROUP_RESPONSE, checks if the article exists.
   * Because it is required by NNTP, if it doesn't work, the only problem would
   * be that the article doesn't exist. Passes off article number data to 
   * nsNNTPNewsgroupList.
   * Followed by: NNTP_READ_GROUP_BODY     if the article exists
   *              NNTP_READ_GROUP          if it doesn't.
  PRInt32 ReadNewsgroupResponse();
   * This state, NNTP_READ_GROUP_BODY, reads the body of the HEAD command.
   * Once again, it passes information off to nsNNTPNewsgroupList.
   * Followed by: NNTP_READ_GROUP
  PRInt32 ReadNewsgroupBody(nsIInputStream * inputStream, PRUint32 length);

   * This state, NNTP_PROCESS_XOVER, is the final step of the filter-processing
   * code. Currently, all it does is cleans up the unread count and calls the
   * filters, both via nsNNTPNewsgroupList.
   * Followed by: NEWS_DONE
  PRInt32 ProcessXover();

  // Canceling
  PRInt32 StartCancel();
  PRInt32 DoCancel();

  // XPAT
  PRInt32 XPATSend();
  PRInt32 XPATResponse(nsIInputStream * inputStream, PRUint32 length);
  PRInt32 ListPrettyNames();
  PRInt32 ListPrettyNamesResponse(nsIInputStream * inputStream, PRUint32 length);

  PRInt32 ListXActive();
  PRInt32 ListXActiveResponse(nsIInputStream * inputStream, PRUint32 length);

  // for "?list-ids"
  PRInt32 SendListGroup();
  PRInt32 SendListGroupResponse(nsIInputStream * inputStream, PRUint32 length);

  // Searching Protocol....
  PRInt32 Search();
  PRInt32 SearchResponse();
  PRInt32 SearchResults(nsIInputStream *inputStream, PRUint32 length);

  // End of Protocol Methods

  nsresult ParseURL(nsIURI *aURL, nsCString &aGroup, nsCString &aMessageID);

  void SetProgressBarPercent(PRUint32 aProgress, PRUint32 aProgressMax);
  nsresult SetProgressStatus(const PRUnichar *aMessage);
  nsresult InitializeNewsFolderFromUri(const char *uri);
  void TimerCallback();

  void HandleAuthenticationFailure();
  nsCOMPtr <nsIInputStream> mInputStream;
  nsCOMPtr <nsITimer> mUpdateTimer;
  nsresult AlertError(PRInt32 errorCode, const char *text);
  PRInt32 mBytesReceived;
  PRInt32 mBytesReceivedSinceLastStatusUpdate;
  PRTime m_startTime;
  PRInt32 mNumGroupsListed;
  nsMsgKey m_key;

  nsresult SetCurrentGroup(); /* sets m_currentGroup.  should be called after doing a successful GROUP command */
  nsresult CleanupNewsgroupList(); /* cleans up m_newsgroupList, and set it to null */

  // cache related helper methods
  void FinishMemCacheEntry(bool valid); // either mark it valid, or doom it
  nsresult OpenCacheEntry(); // makes a request to the cache service for a cache entry for a url
  bool ReadFromLocalCache(); // attempts to read the url out of our local (offline) cache....
  nsresult ReadFromNewsConnection(); // creates a new news connection to read the url
  nsresult ReadFromMemCache(nsICacheEntryDescriptor *entry); // attempts to read the url out of our memory cache
  nsresult SetupPartExtractorListener(nsIStreamListener * aConsumer);

#endif  // nsNNTPProtocol_h___