autoscan.h

Go to the documentation of this file.

/*MT*
    
    MediaTomb - http://www.mediatomb.cc/
    
    autoscan.h - this file is part of MediaTomb.
    
    Copyright (C) 2005 Gena Batyan <bgeradz@mediatomb.cc>,
                       Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>
    
    Copyright (C) 2006-2010 Gena Batyan <bgeradz@mediatomb.cc>,
                            Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>,
                            Leonhard Wimmer <leo@mediatomb.cc>
    
    MediaTomb is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2
    as published by the Free Software Foundation.
    
    MediaTomb 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
    version 2 along with MediaTomb; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
    
    $Id: autoscan.h 2081 2010-03-23 20:18:00Z lww $
*/


#ifndef __AUTOSCAN_H__
#define __AUTOSCAN_H__

#include "zmmf/zmmf.h"
#include "sync.h"
#include "timer.h"

#define INVALID_SCAN_ID -1

enum scan_level_t
{
    BasicScanLevel, // file was added or removed from the directory
    FullScanLevel   // file was modified/added/removed
};

enum scan_mode_t
{
    TimedScanMode,
    InotifyScanMode
};

class AutoscanDirectory;

class AutoscanList : public zmm::Object
{
public:
    AutoscanList();
    
    int add(zmm::Ref<AutoscanDirectory> dir);

    void addList(zmm::Ref<AutoscanList> list);

    zmm::Ref<AutoscanDirectory> get(int id);

    zmm::Ref<AutoscanDirectory> get(zmm::String location);
    
    zmm::Ref<AutoscanDirectory> getByObjectID(int objectID);

    int size() { return list->size(); }
   
    void remove(int id);

    int removeByObjectID(int objectID);
    
    int remove(zmm::String location);

    zmm::Ref<AutoscanList> removeIfSubdir(zmm::String parent, bool persistent = false);

    /*
    void subscribeAll(zmm::Ref<TimerSubscriber> obj);
    */

    void notifyAll(zmm::Ref<TimerSubscriberSingleton<Object> > obj);
        
    /*
    void subscribeDir(zmm::Ref<TimerSubscriber> obj, int id, bool once = true);
    */
    
    void updateLMinDB();

    zmm::Ref<zmm::Array<AutoscanDirectory> > getArrayCopy();

/*
    void dump();
*/

protected:
    zmm::Ref<Mutex> mutex;
    zmm::Ref<zmm::Array<AutoscanDirectory> > list;
    int _add(zmm::Ref<AutoscanDirectory> dir);
};

class AutoscanDirectory : public zmm::Object
{
public:
    AutoscanDirectory();

    AutoscanDirectory(zmm::String location, scan_mode_t mode, 
                      scan_level_t level, bool recursive,
                      bool persistent,
                      int id = INVALID_SCAN_ID, unsigned int interval = 0, bool hidden = false);

    void setStorageID(int storageID) { this->storageID = storageID; }

    int getStorageID() { return storageID; }

    void setLocation(zmm::String location);

    zmm::String getLocation() { return location; }

    scan_mode_t getScanMode() { return mode; }

    void setScanMode(scan_mode_t mode) { this->mode = mode; }

    scan_level_t getScanLevel() { return level; }

    void setScanLevel(scan_level_t level) { this->level = level; }

    bool getRecursive() { return recursive; }
   
    void setHidden(bool hidden) { this->hidden = hidden; }

    bool getHidden() { return hidden; }

    void setRecursive(bool recursive) { this->recursive = recursive; }
    
    unsigned int getInterval() { return interval; }

    void setInterval(unsigned int interval) { this->interval = interval; }

    void incTaskCount() { taskCount++; }
    
    void decTaskCount() { taskCount--; }

    int getTaskCount() { return taskCount; }

    void setTaskCount(int taskCount) { this->taskCount = taskCount; }
  
    void setScanID(int id);

    int getScanID() { return scanID; }

    void setObjectID(int id) { objectID = id; }

    int getObjectID() { return objectID; }

    bool persistent() { return persistent_flag; }

    void setCurrentLMT(time_t lmt);
    
    time_t getPreviousLMT() { return last_mod_previous_scan; }
    
    void updateLMT() { last_mod_previous_scan = last_mod_current_scan; }

    void resetLMT() { last_mod_previous_scan = 0; last_mod_current_scan = 0; }
 
    void copyTo(zmm::Ref<AutoscanDirectory> copy);

//    void setTimerParamter(zmm::Ref<zmm::Object> parameter);

    zmm::Ref<zmm::Object> getTimerParameter();

//    bool equals(Ref<AutoscanDirectory> dir);
   
    /* helpers for autoscan stuff */
    static zmm::String mapScanmode(scan_mode_t scanmode);
    static scan_mode_t remapScanmode(zmm::String scanmode);
    static zmm::String mapScanlevel(scan_level_t scanlevel);
    static scan_level_t remapScanlevel(zmm::String scanlevel);
    
protected:
    zmm::String location;
    scan_mode_t mode;
    scan_level_t level;
    bool recursive;
    bool hidden;
    bool persistent_flag;
    unsigned int interval;
    int taskCount;
    int scanID;
    int objectID;
    int storageID;
    time_t  last_mod_previous_scan; 
    time_t  last_mod_current_scan;
    zmm::Ref<zmm::Object> timer_parameter;
};

#endif

---