Back to index

lightning-sunbird  0.9+nobinonly
nsInstallFile.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 Communicator client code, released
00016  * March 31, 1998.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Daniel Veditz <dveditz@netscape.com>
00025  *   Douglas Turner <dougt@netscape.com>
00026  *
00027  * Alternatively, the contents of this file may be used under the terms of
00028  * either of the GNU General Public License Version 2 or later (the "GPL"),
00029  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00030  * in which case the provisions of the GPL or the LGPL are applicable instead
00031  * of those above. If you wish to allow use of your version of this file only
00032  * under the terms of either the GPL or the LGPL, and not to allow others to
00033  * use your version of this file under the terms of the MPL, indicate your
00034  * decision by deleting the provisions above and replace them with the notice
00035  * and other provisions required by the GPL or the LGPL. If you do not delete
00036  * the provisions above, a recipient may use your version of this file under
00037  * the terms of any one of the MPL, the GPL or the LGPL.
00038  *
00039  * ***** END LICENSE BLOCK ***** */
00040 
00041 
00042 #ifndef nsInstallFile_h__
00043 #define nsInstallFile_h__
00044 
00045 #include "prtypes.h"
00046 #include "nsString.h"
00047 
00048 #include "nsInstallObject.h"
00049 
00050 #include "nsInstall.h"
00051 #include "nsInstallVersion.h"
00052 
00053 
00054 /* Global defines for file handling mode bitfield values */
00055 #define INSTALL_NO_COMPARE        0x1
00056 #define INSTALL_IF_NEWER          0x2
00057 #define INSTALL_IF_EQUAL_OR_NEWER 0x4
00058 
00059 
00060 class nsInstallFile : public nsInstallObject 
00061 {
00062     public:
00063 
00064       /*************************************************************
00065        * Public Methods 
00066        *
00067        *      Constructor
00068        *    inSoftUpdate    - softUpdate object we belong to
00069        *    inComponentName - full path of the registry component
00070        *    inVInfo          - full version info
00071        *    inJarLocation   - location inside the JAR file
00072        *    inFinalFileSpec - final       location on   disk
00073        *************************************************************/
00074         nsInstallFile(  nsInstall* inInstall,
00075                         const nsString& inVRName,
00076                         const nsString& inVInfo,
00077                         const nsString& inJarLocation,
00078                         nsInstallFolder *folderSpec,
00079                         const nsString& inPartialPath,
00080                         PRInt32 mode,
00081                         PRBool  bRegister,
00082                         PRInt32 *error);
00083 
00084         virtual ~nsInstallFile();
00085 
00086         PRInt32 Prepare();
00087         PRInt32 Complete();
00088         void  Abort();
00089         char* toString();
00090 
00091         PRBool CanUninstall();
00092         PRBool RegisterPackageNode();
00093 
00094 
00095     private:
00096 
00097         /* Private Fields */
00098         nsString*         mVersionInfo;     /* Version info for this file*/
00099         
00100         nsString*         mJarLocation;         /* Location in the JAR */
00101         nsCOMPtr<nsIFile> mExtractedFile;   /* temporary file location */
00102         nsCOMPtr<nsIFile> mFinalFile;           /* final file destination */
00103 
00104         nsString*   mVersionRegistryName; /* full version path */
00105 
00106         PRBool      mReplaceFile;    /* whether file exists */
00107         PRBool      mRegister;       /* if true register this file */
00108         PRUint32    mFolderCreateCount; /* int to keep count of the number of folders created for a given path */
00109         
00110         PRInt32    mMode;            /* an integer used like a bitfield to control *
00111                                       * how a file is installed or registered      */
00112 
00113         PRInt32     CompleteFileMove();
00114         void        CreateAllFolders(nsInstall *inInstall, nsIFile *inFolderPath, PRInt32 *error);
00115     
00116 
00117 };
00118 
00119 #endif /* nsInstallFile_h__ */