helpdownload.h

Go to the documentation of this file.
00001 // $Id: helpdownload.h 751 2006-03-31 15:43:49Z alex $
00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
00003 ================================XARAHEADERSTART===========================
00004  
00005                Xara LX, a vector drawing and manipulation program.
00006                     Copyright (C) 1993-2006 Xara Group Ltd.
00007        Copyright on certain contributions may be held in joint with their
00008               respective authors. See AUTHORS file for details.
00009 
00010 LICENSE TO USE AND MODIFY SOFTWARE
00011 ----------------------------------
00012 
00013 This file is part of Xara LX.
00014 
00015 Xara LX is free software; you can redistribute it and/or modify it
00016 under the terms of the GNU General Public License version 2 as published
00017 by the Free Software Foundation.
00018 
00019 Xara LX and its component source files are distributed in the hope
00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the
00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00022 See the GNU General Public License for more details.
00023 
00024 You should have received a copy of the GNU General Public License along
00025 with Xara LX (see the file GPL in the root directory of the
00026 distribution); if not, write to the Free Software Foundation, Inc., 51
00027 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00028 
00029 
00030 ADDITIONAL RIGHTS
00031 -----------------
00032 
00033 Conditional upon your continuing compliance with the GNU General Public
00034 License described above, Xara Group Ltd grants to you certain additional
00035 rights. 
00036 
00037 The additional rights are to use, modify, and distribute the software
00038 together with the wxWidgets library, the wxXtra library, and the "CDraw"
00039 library and any other such library that any version of Xara LX relased
00040 by Xara Group Ltd requires in order to compile and execute, including
00041 the static linking of that library to XaraLX. In the case of the
00042 "CDraw" library, you may satisfy obligation under the GNU General Public
00043 License to provide source code by providing a binary copy of the library
00044 concerned and a copy of the license accompanying it.
00045 
00046 Nothing in this section restricts any of the rights you have under
00047 the GNU General Public License.
00048 
00049 
00050 SCOPE OF LICENSE
00051 ----------------
00052 
00053 This license applies to this program (XaraLX) and its constituent source
00054 files only, and does not necessarily apply to other Xara products which may
00055 in part share the same code base, and are subject to their own licensing
00056 terms.
00057 
00058 This license does not apply to files in the wxXtra directory, which
00059 are built into a separate library, and are subject to the wxWindows
00060 license contained within that directory in the file "WXXTRA-LICENSE".
00061 
00062 This license does not apply to the binary libraries (if any) within
00063 the "libs" directory, which are subject to a separate license contained
00064 within that directory in the file "LIBS-LICENSE".
00065 
00066 
00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
00068 ----------------------------------------------
00069 
00070 Subject to the terms of the GNU Public License (see above), you are
00071 free to do whatever you like with your modifications. However, you may
00072 (at your option) wish contribute them to Xara's source tree. You can
00073 find details of how to do this at:
00074   http://www.xaraxtreme.org/developers/
00075 
00076 Prior to contributing your modifications, you will need to complete our
00077 contributor agreement. This can be found at:
00078   http://www.xaraxtreme.org/developers/contribute/
00079 
00080 Please note that Xara will not accept modifications which modify any of
00081 the text between the start and end of this header (marked
00082 XARAHEADERSTART and XARAHEADEREND).
00083 
00084 
00085 MARKS
00086 -----
00087 
00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
00089 designs are registered or unregistered trademarks, design-marks, and/or
00090 service marks of Xara Group Ltd. All rights in these marks are reserved.
00091 
00092 
00093       Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
00094                         http://www.xara.com/
00095 
00096 =================================XARAHEADEREND============================
00097  */
00098 
00099 
00100 #ifndef INC_HELPDOWNLOAD
00101 #define INC_HELPDOWNLOAD
00102 
00103 
00104 #include "inetop.h"
00105 
00106 
00110 
00111 
00112 
00113 /****************************************************************************
00114 
00115 >   class HelpDownloadParam : public DownloadOpParam
00116 
00117     Author:     Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
00118     Created:    07/04/2004
00119     Purpose:    File Download param, download a file in the OpMenuImport::Do().
00120     Purpose:    Download operation parameter structure - passes the minimum necessary information to the Op
00121 
00122 ****************************************************************************/
00123 
00124 class HelpDownloadParam : public DownloadOpParam
00125 {
00126 public:
00127 
00128     HelpDownloadParam();
00129     ~HelpDownloadParam();
00130 
00131     PathName m_pathDestination;
00132     String_16 m_strResourceType;
00133     COleDateTime m_date;
00134     IXMLDOMDocumentPtr m_pIndexDoc;
00135     IXMLDOMNodePtr m_pOptionNode;
00136 };
00137 
00138 
00139 /****************************************************************************
00140 
00141 >   class HelpDownloadOp : public DownloadOp
00142 
00143     Author:     Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
00144     Created:    07/04/2004
00145     Purpose:    File download operation. Download a file 
00146     SeeAlso: -
00147 
00148 ****************************************************************************/
00149 
00150 #define OPTOKEN_HELPDOWNLOADOP _T("HelpDownloadOp") // Optoken for the file download
00151 #define OPTOKEN_HELPDOWNLOADDLG _T("HelpDownloadDlg")
00152 
00153 class HelpDownloadOp : public DownloadOp
00154 {
00155     CC_DECLARE_DYNCREATE(HelpDownloadOp)
00156 
00157 public:
00158     static BOOL CheckForNewFiles(BOOL bForeground);
00159 
00160 public:
00161     HelpDownloadOp() {};
00162     virtual ~HelpDownloadOp() {};
00163 
00164     static BOOL     Init();                        
00165     static OpState  GetState(String_256*, OpDescriptor*);
00166 //  void            Do(OpDescriptor* od);
00167     virtual BOOL    OnDocChangingMsg(Document* pChangingDoc, DocChangingMsg::DocState State);
00168     static void     DeferFileCopy(const String_256& pTempFile, const String_256& pDestFile);
00169     static void     DoDeferredFileCopy();
00170 
00171 protected:
00172     virtual void OnDownloadSuccess();
00173     virtual void OnDownloadFail();
00174     virtual void OnDownloadAbort();
00175 
00176 protected:
00177     static CString GetSupportFilepath(const CString& strLeafName = _T(""), const CString& strSupportFolder = _T("HelpAndSupport\\"));
00178     static CString GetIndexFileForLocale(const CString& strLocale);
00179     static CString GetFileForLocale(const CString& strLocale, const CString& strFile);
00180     static CString GetFullResourcePath(const CString& strResourceType,
00181                                        const CString& strFilename,
00182                                        const CString& strLocale = _T(""));
00183     static BOOL MatchFileAttributes(const CString& strFilePath, const COleDateTime& datetime, UINT32 size);
00184     static BOOL CheckIndexFile();
00185     static BOOL FileOnCD(IXMLDOMDocumentPtr pDoc,
00186                               const CString& strName,
00187                               const COleDateTime& datetime,
00188                               UINT32 size,
00189                               const CString& strLocale,
00190                               const CString& strType);
00191     static BOOL LegalFileType(const CString& strFilename);
00192     static BOOL LegalPathname(const CString& strPathname);
00193     static BOOL HasBeenDownloaded(IXMLDOMNodePtr pNode);
00194 
00195     static BOOL ProcessDownloadIndex(IXMLDOMDocumentPtr pDoc, BOOL bSilent = FALSE, BOOL* pbDidSomething = NULL);
00196     static BOOL EnoughDiskSpace(const CString& strPath, const UINT32 sizeRequired);
00197     static IXMLDOMNodePtr FindFirstOption(IXMLDOMDocumentPtr pDoc,
00198                                            CString* pstrResourceType,
00199                                            CString* pstrLocale);
00200 
00201 // Properties
00202 public:
00203     static String_256 IndexBaseURL;
00204     static String_256 DeferredCopySrc;
00205     static String_256 DeferredCopyDest;
00206     static BOOL HighBandwidth;
00207     static String_32 IndexLeafName;
00208     static INT32 CurrentIndexRelease;
00209     
00210 };
00211 
00212 
00213 class HelpDownloadDlg : public Operation
00214 {
00215     CC_DECLARE_DYNCREATE(HelpDownloadDlg)
00216 
00217 public:
00218     HelpDownloadDlg() {};
00219     virtual ~HelpDownloadDlg() {};
00220 
00221     static BOOL     Init();                        
00222     static OpState  GetState(String_256*, OpDescriptor*);
00223     void            Do(OpDescriptor* od);
00224 };
00225 
00226 
00227 #endif // INC_HELPDOWNLOAD

Generated on Sat Nov 10 03:48:36 2007 for Camelot by  doxygen 1.4.4