recordingrule.h

Go to the documentation of this file.

#ifndef RECORDING_RULE_H
#define RECORDING_RULE_H

// QT
#include <QDateTime>
#include <QDate>
#include <QTime>
#include <QStringList>
#include <QCoreApplication>

// libmythbase
#include "mythtvexp.h"

// libmyth
#include "programinfo.h"

// libmythtv
#include "programtypes.h"
#include "recordingtypes.h"

class MTV_PUBLIC RecordingRule
{
    Q_DECLARE_TR_FUNCTIONS(RecordingRule);

  public:
    static const int kNumFilters = 12;

    RecordingRule();
   ~RecordingRule() = default;

    void ensureSortFields(void);
    bool Load(bool asTemplate = false);
    bool LoadByProgram(const ProgramInfo* proginfo);
    bool LoadBySearch(RecSearchType lsearch, QString textname, QString forwhat,
                      QString joininfo = "", ProgramInfo *pginfo = nullptr);
    bool LoadTemplate(QString category, QString categoryType = "Default");

    bool ModifyPowerSearchByID(int rid, QString textname, QString forwhat,
                               QString joininfo = "");
    bool MakeOverride(void);
    bool MakeTemplate(QString category);

    bool Save(bool sendSig = true);
    bool Delete(bool sendSig = true);

    bool IsLoaded() const { return m_loaded; }
    void UseTempTable(bool usetemp, QString table = "record_tmp");
    static unsigned GetDefaultFilter(void);

    void ToMap(InfoMap &infoMap) const;

    AutoExpireType GetAutoExpire(void) const
        { return m_autoExpire ? kNormalAutoExpire : kDisableAutoExpire; }

    bool IsValid(QString &text);

    static QString SearchTypeToString(const RecSearchType searchType);
    static QStringList GetTemplateNames(void);

    int m_recordID; 
    int m_parentRecID;

    bool m_isInactive; 

    // Recording metadata
    QString m_title;
    QString m_sortTitle;
    QString m_subtitle;
    QString m_sortSubtitle;
    QString m_description;
    uint m_season;
    uint m_episode;
    QString m_category;

    QTime m_starttime;
    QDate m_startdate;
    QTime m_endtime;
    QDate m_enddate;

    QString m_seriesid;
    QString m_programid;
    QString m_inetref;

    // Associated data for rule types
    int m_channelid;
    QString m_station; 
    int m_findday; 
    QTime m_findtime; 
    int m_findid;

    // Scheduling Options
    RecordingType m_type;
    RecSearchType m_searchType;
    int m_recPriority;
    int m_prefInput;
    int m_startOffset;
    int m_endOffset;
    RecordingDupMethodType m_dupMethod;
    RecordingDupInType m_dupIn;
    unsigned m_filter;

    // Storage Options
    // TODO: These should all be converted to integer IDs instead
    QString m_recProfile;
    uint    m_recGroupID;
    QString m_storageGroup;
    QString m_playGroup;

    bool m_autoExpire;
    int  m_maxEpisodes;
    bool m_maxNewest;

    // Post Processing Options
    bool m_autoCommFlag;
    bool m_autoTranscode;
    int m_transcoder;
    bool m_autoUserJob1;
    bool m_autoUserJob2;
    bool m_autoUserJob3;
    bool m_autoUserJob4;
    bool m_autoMetadataLookup;

    // Statistic fields - Used to generate statistics about particular rules
    // and influence watch list weighting
    QDateTime m_nextRecording;
    QDateTime m_lastRecorded;
    QDateTime m_lastDeleted;
    int m_averageDelay;

    // Temporary table related - Used for schedule previews
    QString m_recordTable;
    int m_tempID;

    // Is this an override rule? Purely for the benefit of the UI, we display
    // different options for override rules
    bool m_isOverride;

    // Is this a template rule?  Purely for the benefit of the UI, we
    // display all options for template rules
    bool m_isTemplate;

  private:
    // Populate variables from a ProgramInfo object
    void AssignProgramInfo();

    // Name of template used for new rule.
    QString m_template;

    // Pointer for ProgramInfo, exists only if we loaded from ProgramInfo in
    // the first place
    const ProgramInfo *m_progInfo;

    // Indicate that a rule has been loaded, for new rules this is still true
    // after any of the Load* methods is called
    bool m_loaded;
};

Q_DECLARE_METATYPE(RecordingRule*)

#endif