Back to index

lightning-sunbird  0.9+nobinonly
nsXREDirProvider.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Brian Ryner <bryner@brianryner.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef _nsXREDirProvider_h__
00040 #define _nsXREDirProvider_h__
00041 
00042 #include "nsIDirectoryService.h"
00043 #include "nsIProfileMigrator.h"
00044 #include "nsILocalFile.h"
00045 
00046 class nsXREDirProvider : public nsIDirectoryServiceProvider2,
00047                          public nsIProfileStartup
00048 {
00049 public:
00050   // we use a custom isupports implementation (no refcount)
00051   NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr);
00052   NS_IMETHOD_(nsrefcnt) AddRef(void);
00053   NS_IMETHOD_(nsrefcnt) Release(void);
00054 
00055   NS_DECL_NSIDIRECTORYSERVICEPROVIDER
00056   NS_DECL_NSIDIRECTORYSERVICEPROVIDER2
00057   NS_DECL_NSIPROFILESTARTUP
00058 
00059   nsXREDirProvider();
00060   nsresult Initialize(nsIFile *aXULAppDir);
00061   ~nsXREDirProvider();
00062 
00063   // We only set the profile dir, we don't ensure that it exists;
00064   // that is the responsibility of the toolkit profile service.
00065   // We also don't fire profile-changed notifications... that is
00066   // the responsibility of the apprunner.
00067   nsresult SetProfile(nsIFile* aProfileDir, nsIFile* aProfileLocalDir);
00068 
00069   void DoShutdown();
00070 
00071   nsresult GetProfileDefaultsDir(nsIFile* *aResult);
00072 
00073   static nsresult GetUserAppDataDirectory(nsILocalFile* *aFile) {
00074     return GetUserDataDirectory(aFile, PR_FALSE);
00075   }
00076   static nsresult GetUserLocalDataDirectory(nsILocalFile* *aFile) {
00077     return GetUserDataDirectory(aFile, PR_TRUE);
00078   }
00079 
00080   /* make sure you clone it, if you need to do stuff to it */
00081   nsIFile* GetAppDir() { return mAppDir; }
00082 
00088   nsresult GetUpdateRootDir(nsIFile* *aResult);
00089 
00090 protected:
00091   static nsresult GetUserDataDirectory(nsILocalFile* *aFile, PRBool aLocal);
00092   static nsresult EnsureDirectoryExists(nsIFile* aDirectory);
00093   void EnsureProfileFileExists(nsIFile* aFile);
00094 
00095   nsCOMPtr<nsILocalFile> mAppDir;
00096   nsCOMPtr<nsIFile>      mXULAppDir;
00097   nsCOMPtr<nsIFile>      mProfileDir;
00098   nsCOMPtr<nsIFile>      mProfileLocalDir;
00099   PRBool                 mProfileNotified;
00100 };
00101 
00102 #endif