Back to index

lightning-sunbird  0.9+nobinonly
nsNetscapeProfileMigratorBase.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 The Browser Profile Migrator.
00016  *
00017  * The Initial Developer of the Original Code is Ben Goodger.
00018  * Portions created by the Initial Developer are Copyright (C) 2004
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *  Ben Goodger <ben@bengoodger.com>
00023  *  Scott MacGregor <mscott@mozilla.org>
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 netscapeprofilemigratorbase___h___
00040 #define netscapeprofilemigratorbase___h___
00041 
00042 #include "nsILocalFile.h"
00043 #include "nsIStringBundle.h"
00044 #include "nsString.h"
00045 
00046 class nsIFile;
00047 class nsIPrefBranch;
00048 class nsVoidArray;
00049 
00050 struct fileTransactionEntry {
00051   nsCOMPtr<nsIFile> srcFile;  // the src path including leaf name
00052   nsCOMPtr<nsIFile> destFile; // the destination path
00053   nsString newName; // only valid if the file should be renamed after getting copied
00054 };
00055 
00056 
00057 class nsNetscapeProfileMigratorBase
00058 {
00059 public:
00060   nsNetscapeProfileMigratorBase();
00061   virtual ~nsNetscapeProfileMigratorBase() { };
00062 
00063 public:
00064   typedef nsresult(*prefConverter)(void*, nsIPrefBranch*);
00065 
00066   struct PrefTransform {
00067     char*         sourcePrefName;
00068     char*         targetPrefName;
00069     prefConverter prefGetterFunc;
00070     prefConverter prefSetterFunc;
00071     PRBool        prefHasValue;
00072     union {
00073       PRInt32     intValue;
00074       PRBool      boolValue;
00075       char*       stringValue;
00076     };
00077   };
00078 
00079   static nsresult GetString(void* aTransform, nsIPrefBranch* aBranch);
00080   static nsresult SetString(void* aTransform, nsIPrefBranch* aBranch);
00081   static nsresult GetWString(void* aTransform, nsIPrefBranch* aBranch);
00082   static nsresult SetWString(void* aTransform, nsIPrefBranch* aBranch);
00083   static nsresult SetWStringFromASCII(void* aTransform, nsIPrefBranch* aBranch);
00084   static nsresult GetBool(void* aTransform, nsIPrefBranch* aBranch);
00085   static nsresult SetBool(void* aTransform, nsIPrefBranch* aBranch);
00086   static nsresult GetInt(void* aTransform, nsIPrefBranch* aBranch);
00087   static nsresult SetInt(void* aTransform, nsIPrefBranch* aBranch);
00088 
00089   nsresult RecursiveCopy(nsIFile* srcDir, nsIFile* destDir); // helper routine
00090 
00091 protected:
00092   nsresult GetProfileDataFromRegistry(nsILocalFile* aRegistryFile,
00093                                       nsISupportsArray* aProfileNames,
00094                                       nsISupportsArray* aProfileLocations);
00095 
00096   nsresult CopyFile(const nsAString& aSourceFileName, const nsAString& aTargetFileName);
00097 
00098   nsresult GetSignonFileName(PRBool aReplace, char** aFileName);
00099   nsresult LocateSignonsFile(char** aResult);
00100 
00101 protected:
00102   nsCOMPtr<nsILocalFile> mSourceProfile;
00103   nsCOMPtr<nsIFile> mTargetProfile;
00104   nsCOMPtr<nsIStringBundle> mBundle;
00105 
00106   nsVoidArray * mFileCopyTransactions; // list of src/destination files we still have to copy into the new profile directory
00107   PRUint32 mFileCopyTransactionIndex;
00108 };
00109  
00110 #endif