Back to index

lightning-sunbird  0.9+nobinonly
nsMsgSearchNews.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef _nsMsgSearchNews_h__
00039 #include "nsMsgSearchAdapter.h"
00040 
00041 //-----------------------------------------------------------------------------
00042 //---------- Adapter class for searching online (news) folders ----------------
00043 //-----------------------------------------------------------------------------
00044 
00045 class nsMsgSearchNews : public nsMsgSearchAdapter
00046 {
00047 public:
00048        nsMsgSearchNews (nsMsgSearchScopeTerm *scope, nsISupportsArray *termList);
00049        virtual ~nsMsgSearchNews ();
00050 
00051   NS_IMETHOD ValidateTerms ();
00052   NS_IMETHOD Search (PRBool *aDone);
00053   NS_IMETHOD GetEncoding (char **result);
00054   NS_IMETHOD AddHit(nsMsgKey key);
00055   NS_IMETHOD CurrentUrlDone(PRInt32 exitCode);
00056 
00057        virtual nsresult Encode (nsCString *outEncoding);
00058        virtual char *EncodeTerm (nsIMsgSearchTerm *);
00059        PRUnichar *EncodeToWildmat (const PRUnichar *);
00060        
00061   void ReportHits ();
00062     PRBool DuplicateHit(PRUint32 artNum) ;
00063     void CollateHits ();
00064     void ReportHit (nsIMsgDBHdr *pHeaders, nsIMsgFolder *folder);
00065     static int PR_CALLBACK CompareArticleNumbers (const void *v1, const void *v2, void *data);
00066 
00067 protected:
00068        nsCString m_encoding;
00069        PRBool m_ORSearch; // set to true if any of the search terms contains an OR for a boolean operator. 
00070 
00071        nsMsgKeyArray m_candidateHits;
00072        nsMsgKeyArray m_hits;
00073 
00074        static const char *m_kNntpFrom;
00075        static const char *m_kNntpSubject;
00076        static const char *m_kTermSeparator;
00077        static const char *m_kUrlPrefix;
00078 };
00079 
00080 
00081 
00082 class nsMsgSearchNewsEx : public nsMsgSearchNews
00083 {
00084 public:
00085        nsMsgSearchNewsEx (nsMsgSearchScopeTerm *scope, nsISupportsArray *termList);
00086        virtual ~nsMsgSearchNewsEx ();
00087 
00088        NS_IMETHOD ValidateTerms ();
00089        NS_IMETHOD Search (PRBool *aDone);
00090        virtual nsresult Encode (nsCString *pEncoding /*out*/);
00091 
00092        nsresult SaveProfile (const char *profileName);
00093 
00094 protected:
00095        static const char *m_kSearchTemplate;
00096        static const char *m_kProfileTemplate;
00097 };
00098 
00099 
00100 
00101 #endif
00102