src/include/common/client/FileSyncSource.h

/*
* Copyright (C) 2003-2007 Funambol
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef INCL_FILE_SYNC_SOURCE
#define INCL_FILE_SYNC_SOURCE

#include "base/fscapi.h"
#include "spds/constants.h"
#include "spds/SyncItem.h"
#include "spds/SyncMap.h"
#include "spds/SyncStatus.h"
#include "spds/SyncSource.h"
#include "spdm/ManagementNode.h"
#include "base/util/ItemContainer.h"


#define ERR_FILE_SYSTEM             1
#define ERR_NO_FILES_TO_SYNC        2
#define ERR_BAD_FILE_CONTENT        3

class FileSyncSource : public SyncSource {

protected:

    // The dir in which the files are and that are to be synced.
    char* dir;

    // The copy is protected
    FileSyncSource(SyncSource& s);

    // Return true if data correctly set: syncItem->getKey() contains
    // the file name relative to dir, copying its content into
    // the items data can be overriden by derived classes.
    virtual bool setItemData(SyncItem* syncItem);

    int addedItem(SyncItem& item, const WCHAR* key);

public:
    FileSyncSource(const WCHAR* name, SyncSourceConfig* sc);
    virtual ~FileSyncSource();

    void setDir(const char* p);
    const char* getDir();

    void setFileNode(ManagementNode *mn) { fileNode = mn; }
    ManagementNode *getFileNode() { return fileNode; }

    /* SyncSource interface implementations follow */
    
    SyncItem* getFirstItem() { return getFirst(allItems); }
    SyncItem* getNextItem() { return getNext(allItems); }
    SyncItem* getFirstNewItem() { return getFirst(newItems); }
    SyncItem* getNextNewItem() { return getNext(newItems); }
    SyncItem* getFirstUpdatedItem() { return getFirst(updatedItems); }
    SyncItem* getNextUpdatedItem() { return getNext(updatedItems); }
    SyncItem* getFirstDeletedItem() { return getFirst(deletedItems, FALSE); }
    SyncItem* getNextDeletedItem() { return getNext(deletedItems, FALSE); }
    SyncItem* getFirstItemKey() { return getFirst(allItems, FALSE); }
    SyncItem* getNextItemKey() { return getNext(allItems, FALSE); }
    int addItem(SyncItem& item);
    int updateItem(SyncItem& item);
    int deleteItem(SyncItem& item);
    void setItemStatus(const WCHAR* key, int status);
    int beginSync();
    int endSync();
    void assign(FileSyncSource& s);
    ArrayElement* clone();

  private:
    // Lists of all, new, update and deleted items
    // together with the current index.
    struct ItemIteratorContainer {
        ArrayList items;
        int index;
    } allItems, newItems, updatedItems, deletedItems;

    // an optional node in which file dates are stored to track changes
    ManagementNode* fileNode;

    unsigned long getServerModTime(const char* keystr);
            
    SyncItem* getFirst(ItemIteratorContainer& container, BOOL getData = TRUE);
    SyncItem* getNext(ItemIteratorContainer& container, BOOL getData = TRUE);
};

#endif

---