summaryrefslogtreecommitdiff
path: root/upnpcomponents/contentdirectory.cpp
blob: 494b638db652dcd9c4432edb5ce53fe70f8e9947 (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
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
/* 
 * File:   contentdirectory.cpp
 * Author: savop
 * 
 * Created on 21. August 2009, 16:12
 */

#include <upnp/ixml.h>
#include <upnp/upnptools.h>
#include "contentdirectory.h"
#include "../common.h"
#include "../misc/util.h"

cContentDirectory::cContentDirectory(UpnpDevice_Handle DeviceHandle, cMediaDatabase* MediaDatabase)
: cUpnpService(DeviceHandle) {
    this->mMediaDatabase = MediaDatabase;
}

cContentDirectory::~cContentDirectory() {}

int cContentDirectory::subscribe(Upnp_Subscription_Request* Request){
    IXML_Document* PropertySet = NULL;

    /* The system update ID */
    UpnpAddToPropertySet(&PropertySet, "SystemUpdateID", itoa(this->mMediaDatabase->getSystemUpdateID()));
    /* The container update IDs as CSV list */
    UpnpAddToPropertySet(&PropertySet, "ContainerUpdateIDs", this->mMediaDatabase->getContainerUpdateIDs());
    /* The transfer IDs, which are not supported, i.e. empty */
    UpnpAddToPropertySet(&PropertySet, "TransferIDs", "");
    // Accept subscription
    int ret = UpnpAcceptSubscriptionExt(this->mDeviceHandle, Request->UDN, Request->ServiceId, PropertySet, Request->Sid);

    if(ret != UPNP_E_SUCCESS){
        ERROR("Subscription failed (Error code: %d)", ret);
    }

    ixmlDocument_free(PropertySet);
    return ret;
}

void cContentDirectory::Action(){
    static int Retry = 5;
    MESSAGE(VERBOSE_CDS, "Start Content directory thread");
    while(this->Running()){
        IXML_Document* PropertySet = NULL;
        UpnpAddToPropertySet(&PropertySet, "SystemUpdateID", itoa(this->mMediaDatabase->getSystemUpdateID()));
        int ret = UpnpNotifyExt(this->mDeviceHandle, UPNP_DEVICE_UDN, UPNP_CMS_SERVICE_ID, PropertySet);
        ixmlDocument_free(PropertySet);

        if(ret != UPNP_E_SUCCESS){
            Retry--;
            ERROR("State change notification failed (Error code: %d)",ret);
            ERROR("%d of %d notifications failed", (5-Retry), 5);
        }
        else {
            Retry = 5;
        }
        if (!Retry){
            ERROR("Maximum retries of notifications reached. Stopping...");
            this->Cancel();
        }
        // Sleep 2 seconds
        cCondWait::SleepMs(2000);
    }
}

int cContentDirectory::execute(Upnp_Action_Request* Request){
    if (Request == NULL) {
        ERROR("CMS Action Handler - request is null");
        return UPNP_E_BAD_REQUEST;
    }

    if(!strcmp(Request->ActionName, UPNP_CDS_ACTION_BROWSE))
        return this->browse(Request);
    if(!strcmp(Request->ActionName, UPNP_CDS_ACTION_SEARCHCAPABILITIES))
        return this->getSearchCapabilities(Request);
    if(!strcmp(Request->ActionName, UPNP_CDS_ACTION_SORTCAPABILITIES))
        return this->getSortCapabilities(Request);
    if(!strcmp(Request->ActionName, UPNP_CDS_ACTION_SYSTEMUPDATEID))
        return this->getSystemUpdateID(Request);

    return UPNP_E_BAD_REQUEST;
}


int cContentDirectory::browse(Upnp_Action_Request* Request){
    MESSAGE(VERBOSE_CDS, "Browse requested by %s.", inet_ntoa(Request->CtrlPtIPAddr));

    char* ObjectID = NULL;
    if(this->parseStringValue(Request->ActionRequest, "ObjectID", &ObjectID)){
        ERROR("Invalid arguments. ObjectID missing or wrong");
        this->setError(Request, UPNP_SOAP_E_INVALID_ARGS);
        return Request->ErrCode;
    }

    char* BrowseFlag = NULL;
    bool BrowseMetadata = false;
    if(this->parseStringValue(Request->ActionRequest, "BrowseFlag", &BrowseFlag)){
        ERROR("Invalid arguments. Browse flag missing or wrong");
        this->setError(Request, UPNP_SOAP_E_INVALID_ARGS);
        return Request->ErrCode;
    }
    if(!strcasecmp(BrowseFlag, "BrowseMetadata")){
        BrowseMetadata = true;
    }
    else if(!strcasecmp(BrowseFlag, "BrowseDirectChildren")){
        BrowseMetadata = false;
    }
    else {
        ERROR("Invalid argument. Browse flag invalid");
        this->setError(Request, UPNP_SOAP_E_INVALID_ARGS);
        return Request->ErrCode;
    }

    char* Filter = NULL;
    if(this->parseStringValue(Request->ActionRequest, "Filter", &Filter)){
        ERROR("Invalid arguments. Filter missing or wrong");
        this->setError(Request, UPNP_SOAP_E_INVALID_ARGS);
        return Request->ErrCode;
    }

    int StartingIndex = 0;
    if(this->parseIntegerValue(Request->ActionRequest, "StartingIndex", &StartingIndex)){
        ERROR("Invalid arguments. Starting index missing or wrong");
        this->setError(Request, UPNP_SOAP_E_INVALID_ARGS);
        return Request->ErrCode;
    }

    int RequestedCount = 0;
    if(this->parseIntegerValue(Request->ActionRequest, "RequestedCount", &RequestedCount)){
        ERROR("Invalid arguments. Requested count missing or wrong");
        this->setError(Request, UPNP_SOAP_E_INVALID_ARGS);
        return Request->ErrCode;
    }

    char* SortCriteria = NULL;
    if(this->parseStringValue(Request->ActionRequest, "SortCriteria", &SortCriteria)){
        ERROR("Invalid arguments. Sort criteria missing or wrong");
        this->setError(Request, UPNP_SOAP_E_INVALID_ARGS);
        return Request->ErrCode;
    }

    cUPnPResultSet* ResultSet;

    int ret = this->mMediaDatabase->browse(&ResultSet, ObjectID, BrowseMetadata, Filter, StartingIndex, RequestedCount, SortCriteria);
    if(ret!=UPNP_E_SUCCESS){
        ERROR("Error while browsing. Code: %d", ret);
        this->setError(Request, ret);
        return Request->ErrCode;
    }

    char* escapedResult = NULL;
    escapeXMLCharacters(ResultSet->mResult, &escapedResult);

    if(!escapedResult){
        ERROR("Escaping XML data failed");
        this->setError(Request, UPNP_SOAP_E_ACTION_FAILED);
        return Request->ErrCode;
    }

    cString Result = cString::sprintf(
            "<u:%sResponse xmlns:u=\"%s\"> \
                <Result>%s</Result> \
                <NumberReturned>%d</NumberReturned> \
                <TotalMatches>%d</TotalMatches> \
                <UpdateID>%d</UpdateID> \
             </u:%sResponse>",
            Request->ActionName,
            UPNP_CDS_SERVICE_TYPE,
            escapedResult,
            ResultSet->mNumberReturned,
            ResultSet->mTotalMatches,
            this->mMediaDatabase->getSystemUpdateID(),
            Request->ActionName
            );

    Request->ActionResult = ixmlParseBuffer(Result);
    Request->ErrCode = UPNP_E_SUCCESS;

    free(escapedResult);

    return Request->ErrCode;

}

int cContentDirectory::getSystemUpdateID(Upnp_Action_Request* Request){
    cString Result = cString::sprintf(
            "<u:%sResponse xmlns:u=\"%s\"> \
                <Id>%d</Id> \
             </u:%sResponse>",
            Request->ActionName,
            UPNP_CDS_SERVICE_TYPE,
            this->mMediaDatabase->getSystemUpdateID(),
            Request->ActionName
            );

    Request->ActionResult = ixmlParseBuffer(Result);
    Request->ErrCode = UPNP_E_SUCCESS;

    return Request->ErrCode;
}

int cContentDirectory::getSearchCapabilities(Upnp_Action_Request* Request){
    MESSAGE(VERBOSE_CDS, "Sorry, no search capabilities yet");

    cString Result = cString::sprintf(
            "<u:%sResponse xmlns:u=\"%s\"> \
                <SearchCaps>%s</SearchCaps> \
             </u:%sResponse>",
            Request->ActionName,
            UPNP_CDS_SERVICE_TYPE,
            UPNP_CDS_SEARCH_CAPABILITIES,
            Request->ActionName
            );

    Request->ActionResult = ixmlParseBuffer(Result);
    Request->ErrCode = UPNP_E_SUCCESS;

    return Request->ErrCode;
}

int cContentDirectory::getSortCapabilities(Upnp_Action_Request* Request){
    MESSAGE(VERBOSE_CDS, "Sorry, no sort capabilities yet");

    cString Result = cString::sprintf(
            "<u:%sResponse xmlns:u=\"%s\"> \
                <SortCaps>%s</SortCaps> \
             </u:%sResponse>",
            Request->ActionName,
            UPNP_CDS_SERVICE_TYPE,
            UPNP_CDS_SORT_CAPABILITIES,
            Request->ActionName
            );

    Request->ActionResult = ixmlParseBuffer(Result);
    Request->ErrCode = UPNP_E_SUCCESS;

    return Request->ErrCode;
}

void cContentDirectory::setError(Upnp_Action_Request* Request, int Error){
    Request->ErrCode = Error;
    switch(Error){
        case UPNP_CDS_E_BAD_METADATA:
            strn0cpy(Request->ErrStr,_("Bad metadata"),LINE_SIZE);
            break;
        case UPNP_CDS_E_CANT_PROCESS_REQUEST:
            strn0cpy(Request->ErrStr,_("Cannot process the request"),LINE_SIZE);
            break;
        case UPNP_CDS_E_DEST_RESOURCE_ACCESS_DENIED:
            strn0cpy(Request->ErrStr,_("Destination resource access denied"),LINE_SIZE);
            break;
        case UPNP_CDS_E_INVALID_CURRENT_TAG:
            strn0cpy(Request->ErrStr,_("Invalid current tag"),LINE_SIZE);
            break;
        case UPNP_CDS_E_INVALID_NEW_TAG:
            strn0cpy(Request->ErrStr,_("Invalid new tag"),LINE_SIZE);
            break;
        case UPNP_CDS_E_INVALID_SEARCH_CRITERIA:
            strn0cpy(Request->ErrStr,_("Invalid or unsupported search criteria"),LINE_SIZE);
            break;
        case UPNP_CDS_E_INVALID_SORT_CRITERIA:
            strn0cpy(Request->ErrStr,_("Invalid or unsupported sort criteria"),LINE_SIZE);
            break;
        case UPNP_CDS_E_NO_SUCH_CONTAINER:
            strn0cpy(Request->ErrStr,_("No such container"),LINE_SIZE);
            break;
        case UPNP_CDS_E_NO_SUCH_DESTINATION_RESOURCE:
            strn0cpy(Request->ErrStr,_("No such destination resource"),LINE_SIZE);
            break;
        case UPNP_CDS_E_NO_SUCH_FILE_TRANSFER:
            strn0cpy(Request->ErrStr,_("No such file transfer"),LINE_SIZE);
            break;
        case UPNP_CDS_E_NO_SUCH_OBJECT:
            strn0cpy(Request->ErrStr,_("No such objectID"),LINE_SIZE);
            break;
        case UPNP_CDS_E_NO_SUCH_SOURCE_RESOURCE:
            strn0cpy(Request->ErrStr,_("No such source resource"),LINE_SIZE);
            break;
        case UPNP_CDS_E_PARAMETER_MISMATCH:
            strn0cpy(Request->ErrStr,_("Parameter mismatch"),LINE_SIZE);
            break;
        case UPNP_CDS_E_READ_ONLY_TAG:
            strn0cpy(Request->ErrStr,_("Read only tag"),LINE_SIZE);
            break;
        case UPNP_CDS_E_REQUIRED_TAG:
            strn0cpy(Request->ErrStr,_("Required tag"),LINE_SIZE);
            break;
        case UPNP_CDS_E_RESOURCE_ACCESS_DENIED:
            strn0cpy(Request->ErrStr,_("Resource access denied"),LINE_SIZE);
            break;
        case UPNP_CDS_E_RESTRICTED_OBJECT:
            strn0cpy(Request->ErrStr,_("Restricted object"),LINE_SIZE);
            break;
        case UPNP_CDS_E_RESTRICTED_PARENT:
            strn0cpy(Request->ErrStr,_("Restricted parent"),LINE_SIZE);
            break;
        case UPNP_CDS_E_TRANSFER_BUSY:
            strn0cpy(Request->ErrStr,_("Transfer busy"),LINE_SIZE);
            break;
        default:
            cUpnpService::setError(Request, Error);
            break;
    }
    return;
}