summaryrefslogtreecommitdiff
path: root/history.c
blob: ac15c92c80e19f1299d92d3d38d970e270dc2bb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
 * history.c: A plugin for the Video Disk Recorder
 *
 * See the README file for copyright information and how to reach the author.
 *
 */

#include <vdr/plugin.h>
#include <vdr/i18n.h>
#include "config.h"
#include "logger.h"
#include "menu.h"
#include "setup_menu.h"

#ifndef GITVERSION
#define GITVERSION ""
#endif

static const char VERSION[]        = "0.0.3" GITVERSION;
static const char DESCRIPTION[]    = trNOOP("Show last replayed recordings");
static const char MAINMENUENTRY[]  = trNOOP("History");

class cPluginHistory : public cPlugin {
private:
  // Add any member variables or functions you may need here.
  cHistoryLogger *history_logger;
public:
  cPluginHistory(void);
  virtual ~cPluginHistory();
  virtual const char *Version(void) { return VERSION; }
  virtual const char *Description(void) { return tr(DESCRIPTION); }
  virtual const char *CommandLineHelp(void);
  virtual bool ProcessArgs(int argc, char *argv[]);
  virtual bool Initialize(void);
  virtual bool Start(void);
  virtual void Stop(void);
  virtual void Housekeeping(void);
  virtual void MainThreadHook(void);
  virtual cString Active(void);
  virtual time_t WakeupTime(void);
  virtual const char *MainMenuEntry(void) { return tr(MAINMENUENTRY); }
  virtual cOsdObject *MainMenuAction(void);
  virtual cMenuSetupPage *SetupMenu(void);
  virtual bool SetupParse(const char *Name, const char *Value);
  virtual bool Service(const char *Id, void *Data = NULL);
  virtual const char **SVDRPHelpPages(void);
  virtual cString SVDRPCommand(const char *Command, const char *Option, int &ReplyCode);
  };

cPluginHistory::cPluginHistory(void)
{
  // Initialize any member variables here.
  // DON'T DO ANYTHING ELSE THAT MAY HAVE SIDE EFFECTS, REQUIRE GLOBAL
  // VDR OBJECTS TO EXIST OR PRODUCE ANY OUTPUT!
  history_logger = NULL;
}

cPluginHistory::~cPluginHistory()
{
  // Clean up after yourself!
  delete history_logger;
}

const char *cPluginHistory::CommandLineHelp(void)
{
  // Return a string that describes all known command line options.
  return NULL;
}

bool cPluginHistory::ProcessArgs(int argc, char *argv[])
{
  // Implement command line argument processing here if applicable.
  return true;
}

bool cPluginHistory::Initialize(void)
{
  // Initialize any background activities the plugin shall perform.
  return true;
}

bool cPluginHistory::Start(void)
{
  // Start any background activities the plugin shall perform.
  history_logger = new cHistoryLogger;
  history_logger->SetReplayHistoryConfigFile(AddDirectory(cPlugin::ConfigDirectory(PLUGIN_NAME_I18N), "replay.log")); // allowed only via main thread!);
  history_logger->LoadReplayHistory();
  return true;
}

void cPluginHistory::Stop(void)
{
  // Stop any background activities the plugin is performing.
}

void cPluginHistory::Housekeeping(void)
{
  // Perform any cleanup or other regular tasks.
}

void cPluginHistory::MainThreadHook(void)
{
  // Perform actions in the context of the main program thread.
  // WARNING: Use with great care - see PLUGINS.html!
}

cString cPluginHistory::Active(void)
{
  // Return a message string if shutdown should be postponed
  return NULL;
}

time_t cPluginHistory::WakeupTime(void)
{
  // Return custom wakeup time for shutdown script
  return 0;
}

cOsdObject *cPluginHistory::MainMenuAction(void)
{
  // Perform the action when selected from the main VDR menu.
  return new cHistoryMainMenu(history_logger);
}

cMenuSetupPage *cPluginHistory::SetupMenu(void)
{
  // Return a setup menu in case the plugin supports one.
  return new cHistorySetupMenu();
}

bool cPluginHistory::SetupParse(const char *Name, const char *Value)
{
  // Parse your own setup parameters and store their values.
  return HistorySetup.SetupParse(Name, Value);
}

bool cPluginHistory::Service(const char *Id, void *Data)
{
  // Handle custom service requests from other plugins
  return false;
}

const char **cPluginHistory::SVDRPHelpPages(void)
{
  static const char *HelpPages[] = {
    "REPL\n"
    "    Show replay history.",
    "CLRR\n"
    "    Clear replay history.",
    NULL
    };
  return HelpPages;
}

cString cPluginHistory::SVDRPCommand(const char *Command, const char *Option, int &ReplyCode)
{
  if (strcasecmp(Command, "REPL") == 0) {
     if (HistorySetup.replay_history_size > 0) {
        cString string = "";
        cList<cHistoryRecordingItem> *replay_history = history_logger->GetReplayHistory();
        cHistoryRecordingItem *item = replay_history->First();
        while (item != NULL) {
              char *time = item->GetReplayTimeString();
              string = cString::sprintf("%s%s\n", *string, time);
              free(time);
              const cRecording *recording;
#if VDRVERSNUM >= 20301
              {
              LOCK_RECORDINGS_READ;
              recording = Recordings->GetByName(item->GetFilename());
              }
#else
              cThreadLock RecordingsLock(&Recordings);
              recording = Recordings.GetByName(item->GetFilename());
#endif
              if (recording)
                 string = cString::sprintf("%s%s\n", *string, recording->Title(' '));
              item = (cHistoryRecordingItem *)item->Next();
              }
        return string;
        }
     }
  else if (strcasecmp(Command, "CLRR") == 0) {
     if (HistorySetup.replay_history_size > 0) {
        history_logger->ClearReplayHistory();
        return cString("Replay history cleared");
        }
     }
  else {
        ReplyCode = 554; // Requested action failed
        return cString("Unable to show replay history");
     }
  return NULL;
}

VDRPLUGINCREATOR(cPluginHistory); // Don't touch this!