src/include/common/spds/SyncManager.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 #ifndef INCL_SYNC_MANAGER
00037 #define INCL_SYNC_MANAGER
00038 
00042 #include "base/globalsdef.h"
00043 #include "base/util/ArrayList.h"
00044 #include "http/TransportAgent.h"
00045 #include "spds/constants.h"
00046 #include "spds/AbstractSyncConfig.h"
00047 #include "spds/SyncSource.h"
00048 #include "spds/SyncMLBuilder.h"
00049 #include "spds/SyncMLProcessor.h"
00050 #include "spds/CredentialHandler.h"
00051 #include "spds/CredentialHandler.h"
00052 #include "spds/SyncReport.h"
00053 #include "spds/MappingsManager.h"
00054 
00055 // Tolerance to data size for incoming items (106%) -> will be allocated some more space.
00056 #define DATA_SIZE_TOLERANCE      1.06
00057 
00058 BEGIN_NAMESPACE
00059 
00060 typedef enum {
00061                 STATE_START        = 0,
00062                 STATE_PKG1_SENDING = 1,
00063                 STATE_PKG1_SENT    = 2,
00064                 STATE_PKG3_SENDING = 3,
00065                 STATE_PKG3_SENT    = 4,
00066                 STATE_PKG5_SENDING = 5,
00067                 STATE_PKG5_SENT    = 6
00068              } SyncManagerState ;
00069 
00070 
00078 class SyncManager {
00079 
00080     public:
00088         SyncManager(AbstractSyncConfig& config, SyncReport& report);
00089         ~SyncManager();
00090 
00095         int prepareSync(SyncSource** sources);
00096 
00105         int sync();
00106 
00110         int endSync();
00111 
00122         DevInf *createDeviceInfo();
00123 
00124     private:
00125 
00126         // SyncManager makes local key safe to use in SyncML by
00127         // encoding it as b64 if it contains special characters. The
00128         // SyncML standard says that the key should be a "URI" or
00129         // "URN"; we interpret that less strictly as "do not
00130         // include characters which actually break XML".
00131         //
00132         // Encoded keys are sent as "funambol-b64-<encoded original
00133         // key>". When receiving a key from the server it is only decoded
00134         // if it contains this magic tag, therefore an updated client
00135         // remains compatible with a server that already contains keys.
00136         static const char encodedKeyPrefix[];
00137 
00138         void encodeItemKey(SyncItem *syncItem);
00139         void decodeItemKey(SyncItem *syncItem);
00140 
00141         // Struct used to pass command info to the method processSyncItem
00142         struct CommandInfo {
00143             const char* commandName;
00144             const char* cmdRef;
00145             const char* format;
00146             const char* dataType;
00147             long size;
00148         };
00149 
00150         DevInf* devInf;
00151         AbstractSyncConfig& config;
00152         SyncReport& syncReport;
00153 
00154         CredentialHandler credentialHandler;
00155         SyncMLBuilder syncMLBuilder;
00156         SyncMLProcessor syncMLProcessor;
00157         TransportAgent* transportAgent;
00158 
00159         SyncManagerState currentState;
00160         SyncSource** sources;
00161         ArrayList commands;        
00162         
00163         MappingsManager** mmanager;
00164         // Now using sources[i].checkState() method
00165         //int* check;
00166 
00167         int  sourcesNumber;
00168         int  count;
00169 
00170         /* A list of syncsource names from server. The server sends sources
00171          * modifications sorted as alerts in this list. This array is retrieved from
00172          * SyncMLProcessor::getSortedSourcesFromServer.
00173          */
00174         char** sortedSourcesFromServer;
00175         
00176         StringBuffer syncURL;
00177         StringBuffer deviceId;
00178         int responseTimeout;  // the response timeout for a rensponse from server (default = 5min) [in seconds]
00179         int maxMsgSize;       // the max message size. Default = 512k. Setting it implies LargeObject support.
00180         int maxObjSize;       // The maximum object size. The server gets this in the Meta init message and should obey it.
00181         bool loSupport;             // enable support for large objects - without it large outgoing items are not split
00182         unsigned int readBufferSize; // the size of the buffer to store chunk of incoming stream.
00183         char  credentialInfo[1024]; // used to store info for the des;b64 encription
00184 
00185         // Handling of incomplete incoming objects by processSyncItem().
00186         // Always active, even if Large Object support is off,
00187         // just in case the server happens to rely on it.
00188         //
00189         class IncomingSyncItem : public SyncItem {
00190           public:
00191             IncomingSyncItem(const WCHAR* key,
00192                              const CommandInfo &cmdInfo,
00193                              int currentSource) :
00194                 SyncItem(key),
00195                 offset(0),
00196                 cmdName(cmdInfo.commandName),
00197                 cmdRef(cmdInfo.cmdRef),
00198                 sourceIndex(currentSource) {
00199             }
00200 
00201             long offset;                // number of bytes already received, append at this point
00202             const StringBuffer cmdName; // name of the command which started the incomplete item
00203             const StringBuffer cmdRef;  // reference of the command which started the incomplete item
00204             const int sourceIndex;      // the index of the source to which the incomplete item belongs
00205         } *incomingItem;       // sync item which is not complete yet, more data expected
00206 
00207         void initialize();
00208         bool readSyncSourceDefinition(SyncSource& source);
00209         bool commitChanges(SyncSource& source);
00210         int assignSources(SyncSource** sources);
00211 
00212         Status *processSyncItem(Item* item, const CommandInfo &cmdInfo, SyncMLBuilder &syncMLBuilder);
00213         bool checkForServerChanges(SyncML* syncml, ArrayList &statusList);
00214 
00215         const char*  getUserAgent(AbstractSyncConfig& config);
00216         bool isToExit();
00217         void setSourceStateAndError(unsigned int index, SourceState  state,
00218                                     unsigned int code,  const char*  msg);
00219 
00220 
00221         // Used to reserve some more space (DATA_SIZE_TOLERANCE) for incoming items.
00222         long getToleranceDataSize(long size);
00223         bool testIfDataSizeMismatch(long allocatedSize, long receivedSize);
00224 
00233         SyncItem* getItem(SyncSource& source, SyncItem* (SyncSource::* getItem)());
00234 
00239         void addMapCommand(int sourceIndex);       
00240 
00241 };
00242 
00243 
00244 END_NAMESPACE
00245 
00248 #endif
00249 

Generated on Wed Jan 14 17:15:36 2009 for Funambol C++ Client Library by  doxygen 1.5.2