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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
|
/****************************************************************************
*
* $Id: rmappv.h 7 2003-05-30 02:18:02Z gabest $
*
* Copyright (C) 1995-1999 RealNetworks, Inc. All rights reserved.
*
* http://www.real.com/devzone
*
* This program contains proprietary information of RealNetworks, Inc.,
* and is licensed subject to restrictions on use and distribution.
*
* RealMedia Architecture Interfaces for pay-per-view database plugins
*
*/
#ifndef _RMAPPV_H_
#define _RMAPPV_H_
#ifdef _MACINTOSH // Unsure whether this should be included on other platforms?
#include <time.h> // Get definition of time_t.
#endif
/*
* Structures and definitions for PPVPermission
*/
#define PPV_MAX_URL_LEN 2048
typedef enum _PPVURLType {
PPV_URL_TYPE_FILE = 0,
PPV_URL_TYPE_DIRECTORY
} PPVURLType;
typedef enum _PPVPermissionType {
PPV_PERMISSION_GENERAL = 0,
PPV_PERMISSION_EXPIRES,
PPV_PERMISSION_DEBIT,
PPV_PERMISSION_CREDIT,
PPV_PERMISSION_NONE
} PPVPermissionType;
typedef struct _PPVPermission
{
char pURL[PPV_MAX_URL_LEN];
PPVURLType nURLType;
PPVPermissionType nPermissionType;
time_t tExpires;
UINT32 ulDebitTime;
} PPVPermission;
/*
* Structures and definitions for PPVAccessLog
*/
typedef enum _PPVAccessPermissionOn {
PPV_PERMISSION_ON_FILE = 0,
PPV_PERMISSION_ON_DIRECTORY,
PPV_PERMISSION_ON_NONE
} PPVAccessPermissionOn;
typedef enum _PPVAccessDisconnectType {
PPV_DISCONNECT_CLIENT = 0,
PPV_DISCONNECT_TIME_EXPIRED
} PPVAccessDisconnectType;
typedef struct _PPVAccessLog
{
BOOL bAccessGranted;
char* pUserid;
char* pGUID;
char* pIPAddress;
char* pURL;
PPVPermissionType nPermissionType;
PPVAccessPermissionOn nPermOn;
time_t tStartTime;
time_t tStopTime;
UINT32 lTotalTime;
PPVAccessDisconnectType nWhyDisconnect;
} PPVAccessLog;
/*
* Structures and definitions for PPVRegLog
*/
typedef enum _PPVRegStatus
{
PPV_GUID_REG_SUCCESS = 0,
PPV_GUID_REG_FAILED_LOCKED,
PPV_GUID_REG_FAILED_COLLISION,
PPV_GUID_REG_FAILED_OLD_PLAYER,
PPV_GUID_REG_FAILED_NO_USER,
PPV_GUID_REG_FAILED
} PPVRegStatus;
typedef struct _PPVRegLog
{
PPVRegStatus nStatus;
char* pUserid;
char* pGUID;
char* pIPAddress;
time_t tRequestTime;
char* pURLRedirect;
} PPVRegLog;
/****************************************************************************
*
* Interface:
*
* IRMAPPVDatabase
*
* Purpose:
* This interface provides access to a backend database used to store
* information related to the server's pay-per-view feature.
*
* IID_IRMAPPVDatabase:
*
* {00001d00-0901-11d1-8B06-00A024406D59}
*
*/
DEFINE_GUID(IID_IRMAPPVDatabase, 0x00001d00, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
0xa0, 0x24, 0x40, 0x6d, 0x59);
#undef INTERFACE
#define INTERFACE IRMAPPVDatabase
DECLARE_INTERFACE_(IRMAPPVDatabase, IUnknown)
{
/*
* IUnknown methods
*/
STDMETHOD(QueryInterface) (THIS_
REFIID riid,
void** ppvObj) PURE;
STDMETHOD_(ULONG,AddRef) (THIS) PURE;
STDMETHOD_(ULONG,Release) (THIS) PURE;
/*
* IRMAPPVDatabase methods
*/
/************************************************************************
* Method:
* IRMAPPVDatabase::InitPPVDB
* Purpose:
* Open & Initialize the PPV Database.
* This function will called once per instance before any other
* methods are called.
*
* pDBName Name of the database (if supported)
* pUserID User ID to access database (if supported)
* pPassword Password to access database (if supported)
*/
STDMETHOD(InitPPVDB) (THIS_
const char* pDBName,
const char* pUserID,
const char* pPassword) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::GetPPVDBInfo
* Purpose:
* Get this databases short name.
* This unique identifier is used to identify this database plugin.
* It should be unique enough that no other plugin will ever have
* the same plugin name.
*/
STDMETHOD(GetPPVDBInfo) (THIS_
REF(const char*) /*OUT*/ pShortName) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::InsertUser
* Purpose:
* Inserts a user into the database (the user should not already
* exist).
*
* pUserid Userid key of the record to insert
* pPasswordCipher Optional Password to associate with this user;
* The password being passed in is already
* encrypted.
*/
STDMETHOD(InsertUser) (THIS_
const char* pUserid,
const char* pPasswordCipher) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::RemoveUser
* Purpose:
* Removes a user from the database.
*
* pUserid Userid key of the record
*/
STDMETHOD(RemoveUser) (THIS_
const char* pUserid) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::RegisterGUID
* Purpose:
* Registers a GUID to be associated with the pUserid
*
* pUserid Userid key of the record
* pGUID GUID to associate with user record
* bForce Forces registration of guid, even if
* the uuid_writeable flag is set to read only
*/
STDMETHOD(RegisterGUID) (THIS_
const char* pUserid,
const char* pGUID,
BOOL bForce) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::SetPassword
* Purpose:
* Sets the password for the user associated with pUserid
*
* pUserid Userid key of the record
* pCipherPassword User's Password
*/
STDMETHOD(SetPassword) (THIS_
const char* pUserid,
const char* pCipherPassword) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::ValidateUser
* Purpose:
* Sets the password for the user associated with pUserid
*
* pUserid Userid key of the record
* pPPVPermission Permission structure with URL to validate on
*/
STDMETHOD(ValidateUser) (THIS_
const char* pUserid,
PPVPermission* pPPVPermission) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::GrantPermission
* Purpose:
* Adds a permission record.
*
* pUserid Userid key of the record
* pPPVPermission Permission structure with URL
*/
STDMETHOD(GrantPermission) (THIS_
const char* pUserid,
const PPVPermission* pPPVPermission) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::RevokePermission
* Purpose:
* Removes a permission record.
*
* pUserid Userid key of the record
* pPPVPermission Permission structure with URL
*/
STDMETHOD(RevokePermission) (THIS_
const char* pUserid,
const PPVPermission* pPPVPermission) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::RevokeAllPermissions
* Purpose:
* Removes all permission records for a user.
*
* pUserid Userid key of the record
*/
STDMETHOD(RevokeAllPermissions) (THIS_
const char* pUserid) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::GetRedirect
* Purpose:
* Gets the redirection Url corresponding to the requested Url
* from the database.
*
* pURL Url key of redirect record (In)
* pURLRedirect Url to redirect to (Out)
* ulURLRedirectLen Maximum length of pURLRedirect (In)
*/
STDMETHOD(GetRedirect) (THIS_
const char* pURL,
char* pURLRedirect,
UINT32 ulURLRedirectLen) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::PutRedirect
* Purpose:
* Adds a redirection Url to the database to correspond with
* the Url key.
*
*
* pURL Url key of redirect record (In)
* pURLRedirect Url to redirect to (In)
*/
STDMETHOD(PutRedirect) (THIS_
const char* pURL,
const char* pURLRedirect) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::GrantTime
* Purpose:
* Grants a user time to view (specified by pPPVPermission).
*
* pUserid Userid key of the record
* pPPVPermission Permission structure with URL
* ulGrant Amount of time to grant
*/
STDMETHOD(GrantTime) (THIS_
const char* pUserid,
const PPVPermission* pPPVPermission,
UINT32 ulGrant) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::DeductTime
* Purpose:
* Deducts a user time to view (specified by pPPVPermission).
*
* pUserid Userid key of the record
* pPPVPermission Permission structure with URL
* ulDeduct Amount of time to deduct
*/
STDMETHOD(DeductTime) (THIS_
const char* pUserid,
const PPVPermission* pPPVPermission,
UINT32 ulDeduct) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::GetPasswordFromUserid
* Purpose:
* Get's a users password
*
* pUserid Userid key of the record (In)
* pCipherPassword Password to get (Out)
* ulCipherPasswordLen Maximum length of pCipherPassword
*/
STDMETHOD(GetPasswordFromUserid) (THIS_
const char* pUserid,
char* pCipherPassword,
UINT32 ulCipherPasswordLen) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::GetUseridFromGUID
* Purpose:
* Get's a users id
*
* pGUID GUID of existing user (In)
* pUserid Userid key of the record (Out)
* ulUseridLen Maximum length of pUserid (In)
*/
STDMETHOD(GetUseridFromGUID) (THIS_
const char* pGUID,
char* pUserid,
UINT32 ulUseridLen) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::LogReg
* Purpose:
* This function inserts a new record into the data with the logging
* information contained in pPPVRegLog
*/
STDMETHOD(LogReg) (THIS_
PPVRegLog* pPPVRegLog) PURE;
/************************************************************************
* Method:
* IRMAPPVDatabase::LogAccess
* Purpose:
* This function inserts a new record into the data with the logging
* information contained in pPPVAccessLog
*/
STDMETHOD(LogAccess) (THIS_
PPVAccessLog* pPPVAccessLog) PURE;
};
#endif /*_RMAPPV_H_*/
|