Back to index

lightning-sunbird  0.9+nobinonly
nsAddressBook.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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) 1998
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 __nsAddressBook_h
00039 #define __nsAddressBook_h
00040  
00041 #include "nsIAddressBook.h"
00042 #include "nsIAbCard.h"
00043 #include "nsCOMPtr.h"
00044 #include "nsIAddrDatabase.h"
00045 #include "nsIScriptGlobalObject.h"
00046 #include "nsIComponentManager.h"
00047 #include "nsIContentHandler.h"
00048 #include "nsIStreamLoader.h"
00049 #include "rdf.h"
00050 
00051 #ifdef MOZ_XUL_APP
00052 #include "nsICommandLineHandler.h"
00053 #define ICOMMANDLINEHANDLER nsICommandLineHandler
00054 #else
00055 #include "nsICmdLineHandler.h"
00056 #define ICOMMANDLINEHANDLER nsICmdLineHandler
00057 #endif
00058 
00059 class nsILocalFile;
00060 class nsIAbDirectory;
00061 
00062 #define NC_RDF_NEWABCARD            NC_NAMESPACE_URI "NewCard"
00063 #define NC_RDF_MODIFY               NC_NAMESPACE_URI "Modify"
00064 #define NC_RDF_DELETE               NC_NAMESPACE_URI "Delete"
00065 #define NC_RDF_DELETECARD           NC_NAMESPACE_URI "DeleteCards"
00066 #define NC_RDF_NEWDIRECTORY         NC_NAMESPACE_URI "NewDirectory"
00067 
00068 #define   EXPORT_ATTRIBUTES_TABLE_COUNT      53
00069 
00070 struct ExportAttributesTableStruct
00071 {
00072     const char* abColName;
00073     const char* ldapPropertyName;
00074     PRUint32 plainTextStringID;
00075 };
00076 
00077 const extern ExportAttributesTableStruct EXPORT_ATTRIBUTES_TABLE[EXPORT_ATTRIBUTES_TABLE_COUNT];
00078 
00079 // for now, the oder of the attributes with PR_TRUE for includeForPlainText
00080 // should be in the same order as they are in the import code
00081 // see importMsgProperties and nsImportStringBundle.
00082 // 
00083 // XXX todo, merge with what's in nsAbLDAPProperties.cpp, so we can
00084 // use this for LDAP and LDIF export
00085 //
00086 // here's how we're coming up with the ldapPropertyName values
00087 // if they are specified in RFC 2798, use them
00088 // else use the 4.x LDIF attribute names (for example, "xmozillanickname"
00089 // as we want to allow export from mozilla back to 4.x, and other apps
00090 // are probably out there that can handle 4.x LDIF)
00091 // else use the MOZ_AB_LDIF_PREFIX prefix, see nsIAddrDatabase.idl
00092 
00093 class nsAddressBook : public nsIAddressBook,
00094                       public ICOMMANDLINEHANDLER,
00095                       public nsIContentHandler,
00096                       public nsIStreamLoaderObserver
00097 {
00098   
00099 public:
00100        nsAddressBook();
00101        virtual ~nsAddressBook();
00102 
00103        NS_DECL_ISUPPORTS
00104        NS_DECL_NSIADDRESSBOOK
00105     NS_DECL_NSICONTENTHANDLER
00106     NS_DECL_NSISTREAMLOADEROBSERVER
00107 
00108 #ifdef MOZ_XUL_APP
00109     NS_DECL_NSICOMMANDLINEHANDLER
00110 #else
00111        NS_DECL_NSICMDLINEHANDLER
00112     CMDLINEHANDLER_REGISTERPROC_DECLS
00113 #endif
00114     
00115 protected:
00116        nsresult DoCommand(nsIRDFDataSource *db, const nsACString& command,
00117                      nsISupportsArray *srcArray, nsISupportsArray *arguments);
00118        nsresult GetAbDatabaseFromFile(char* pDbFile, nsIAddrDatabase **db);
00119 
00120 private:
00121   nsresult ExportDirectoryToDelimitedText(nsIAbDirectory *aDirectory, const char *aDelim, PRUint32 aDelimLen, nsILocalFile *aLocalFile);
00122   nsresult ExportDirectoryToLDIF(nsIAbDirectory *aDirectory, nsILocalFile *aLocalFile);
00123   nsresult AppendLDIFForMailList(nsIAbCard *aCard, nsACString &aResult);
00124   nsresult AppendDNForCard(const char *aProperty, nsIAbCard *aCard, nsACString &aResult);
00125   nsresult AppendBasicLDIFForCard(nsIAbCard *aCard, nsACString &aResult);
00126   nsresult AppendProperty(const char *aProperty, const PRUnichar *aValue, nsACString &aResult);
00127   PRBool IsSafeLDIFString(const PRUnichar *aStr);
00128 };
00129 
00130 #endif