online_service.h

Go to the documentation of this file.

/*MT*
    
    MediaTomb - http://www.mediatomb.cc/
    
    online_service.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: online_service.h 2081 2010-03-23 20:18:00Z lww $
*/


#ifdef ONLINE_SERVICES

#ifndef __ONLINE_SERVICE_H__
#define __ONLINE_SERVICE_H__

#include "zmm/zmm.h"
#include "zmmf/zmmf.h"
#include "mxml/mxml.h"
#include "layout/layout.h"

#define ONLINE_SERVICE_AUX_ID "ols"
#define ONLINE_SERVICE_LAST_UPDATE "lu"

// make sure to add the storage prefixes when adding new services
typedef enum 
{
    OS_None         = 0,
    OS_YouTube      = 1,
    OS_SopCast      = 2,
    OS_Weborama     = 3,
    OS_ATrailers    = 4,
    OS_Max
} service_type_t;

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

    virtual bool refreshServiceData(zmm::Ref<Layout> layout) = 0;

    virtual service_type_t getServiceType() = 0;

    virtual zmm::String getServiceName() = 0;

    char getStoragePrefix();
    
    static char getStoragePrefix(service_type_t service);
    
    virtual zmm::Ref<zmm::Object> defineServiceTask(zmm::Ref<mxml::Element> xmlopt, zmm::Ref<zmm::Object> params) = 0;

    void incTaskCount() { taskCount++; }

    void decTaskCount() { taskCount--; }

    int getTaskCount() { return taskCount; }

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

    void setTimerParameter(zmm::Ref<zmm::Object> param) 
                           { timer_parameter = param; }

    zmm::Ref<Object> getTimerParameter() { return timer_parameter; }

    void setRefreshInterval(int interval) {refresh_interval = interval; }

    int getRefreshInterval() { return refresh_interval; }

    void setItemPurgeInterval(int interval) { purge_interval = interval; }

    int getItemPurgeInterval() { return purge_interval; }

protected:
    int taskCount;
    int refresh_interval;
    int purge_interval;
    zmm::Ref<zmm::Object> timer_parameter;

    zmm::String getCheckAttr(zmm::Ref<mxml::Element> xml, zmm::String attrname);
    int getCheckPosIntAttr(zmm::Ref<mxml::Element> xml, zmm::String attrname);
};

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

    void registerService(zmm::Ref<OnlineService> service);

    zmm::Ref<OnlineService> getService(service_type_t service);

protected:
    zmm::Ref<zmm::Array<OnlineService> > service_list;
};

#endif//__ONLINE_SERVICE_H__

#endif//ONLINE_SERVICE

---