Back to index

lightning-sunbird  0.9+nobinonly
nsProfileDirServiceProvider.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Conrad Carlen <ccarlen@netscape.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 // Interfaces Needed
00040 #include "nsIDirectoryService.h"
00041 #include "nsILocalFile.h"
00042 
00043 #include "nsCOMPtr.h"
00044 #include "nsDirectoryServiceUtils.h"
00045 #include "nsComponentManagerUtils.h"
00046 #include "nsServiceManagerUtils.h"
00047 
00048 #ifdef MOZILLA_INTERNAL_API
00049 #include "nsString.h"
00050 #else
00051 #include "nsEmbedString.h"
00052 #endif
00053 
00054 // Forward Declarations
00055 class nsProfileLock;
00056 
00057 // --------------------------------------------------------------------------------------
00058 // nsProfileDirServiceProvider - The nsIDirectoryServiceProvider implementation used for
00059 // profile-relative file locations.
00060 // --------------------------------------------------------------------------------------
00061 
00062 class nsProfileDirServiceProvider: public nsIDirectoryServiceProvider
00063 {  
00064   NS_DECL_ISUPPORTS
00065   NS_DECL_NSIDIRECTORYSERVICEPROVIDER
00066 
00067   friend nsresult NS_NewProfileDirServiceProvider(PRBool, nsProfileDirServiceProvider**);
00068 
00069 public:
00070 
00083    virtual nsresult        SetProfileDir(nsIFile* aProfileDir,
00084                                          nsIFile* aLocalProfileDir = nsnull);
00085 
00094   virtual nsresult         Register();
00095 
00104   virtual nsresult         Shutdown();
00105 
00106 protected:
00107                            nsProfileDirServiceProvider(PRBool aNotifyObservers = PR_TRUE);
00108    virtual                 ~nsProfileDirServiceProvider();
00109 
00110   nsresult                 Initialize();
00111   nsresult                 InitProfileDir(nsIFile* profileDir);
00112   nsresult                 InitNonSharedProfileDir();
00113   nsresult                 EnsureProfileFileExists(nsIFile *aFile, nsIFile *destDir);
00114   nsresult                 UndefineFileLocations();
00115 
00116 protected:
00117 
00118   nsCOMPtr<nsIFile>        mProfileDir;
00119   nsCOMPtr<nsIFile>        mLocalProfileDir;
00120   nsProfileLock*           mProfileDirLock;
00121   PRPackedBool             mNotifyObservers;
00122 
00123   PRPackedBool             mSharingEnabled;
00124 #ifndef MOZILLA_INTERNAL_API
00125   nsEmbedString            mNonSharedDirName;
00126 #else
00127   nsString                 mNonSharedDirName;
00128 #endif
00129   nsCOMPtr<nsIFile>        mNonSharedProfileDir;
00130 };
00131 
00132 
00133 // --------------------------------------------------------------------------------------
00134 
00143 nsresult NS_NewProfileDirServiceProvider(PRBool aNotifyObservers,
00144                                          nsProfileDirServiceProvider** aProvider);
00145