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
|
/*
Copyright (C) 2010 Bastien Nocera <hadess@hadess.net>
The Gnome Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
The Gnome Library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public
License along with the Gnome Library; see the file COPYING.LIB. If not,
write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301 USA.
Author: Bastien Nocera <hadess@hadess.net>
*/
#include "config.h"
#include <string.h>
#include <glib.h>
#include "totem-pl-parser-mini.h"
#include "totem-pl-parser-videosite.h"
#include "totem-pl-parser-private.h"
#define SCRIPT_ENVVAR "TOTEM_PL_PARSER_VIDEOSITE_SCRIPT"
/* totem-pl-parser can "parse" pages from certain websites into a single
* video playback URL. This is particularly useful for websites which
* show a unique video on a web page, and use one-time URLs to prevent direct
* linking.
*
* This feature is implemented in a helper binary, either the one shipped
* in totem-pl-parser (which uses libquvi), or the first non-hidden file in
* the totem-pl-parser libexec directory, when sorted by lexicographic
* ordering (through strcmp).
*
* The API to implement is straight-forward. For each URL that needs to
* be checked, the script will be called with the command-line arguments
* "--check --url" followed by the URL. The script should return the
* string "TRUE" if the script knows how to handle video pages from
* this site. This call should not making any network calls, and should
* be fast.
*
* If the video site is handled by the script, then the script can be
* called with "--url" followed by the URL. The script can return the
* strings "TOTEM_PL_PARSER_RESULT_ERROR" or
* "TOTEM_PL_PARSER_RESULT_UNHANDLED" to indicate an error (see the
* meaning of those values in the totem-pl-parser API documentation), or
* a list of "<key>=<value>" pairs separated by newlines characters (\n)
* The keys are "metadata fields" in the API documentation, such as:
* url=https://www.videosite.com/unique-link-to.mp4
* title=Unique Link to MP4
* author=Well-known creator
*
* Integrators should make sure that totem-pl-parser is shipped with at
* least one video site parser, either the quvi one offered by
* totem-pl-parser itself, or, in a separate package, a third-party parser
* that implements a compatible API as explained above. Do *NOT* ship
* third-party parsers in the same package as totem itself.
*/
static char *
find_helper_script (void)
{
GDir *dir;
const char *name, *script_dir;
char *script_name = NULL;
if (g_getenv (SCRIPT_ENVVAR) != NULL)
return g_strdup (g_getenv (SCRIPT_ENVVAR));
script_dir = g_getenv ("TOTEM_PL_PARSER_VIDEOSITE_SCRIPT_DIR");
if (!script_dir)
script_dir = LIBEXECDIR "/totem-pl-parser";
dir = g_dir_open (script_dir, 0, NULL);
if (!dir)
goto bail;
while ((name = g_dir_read_name (dir)) != NULL) {
/* Skip hidden files */
if (name[0] == '.')
continue;
if (script_name == NULL || g_strcmp0 (name, script_name) < 0) {
g_free (script_name);
script_name = g_strdup (name);
}
}
g_clear_pointer (&dir, g_dir_close);
if (script_name != NULL) {
char *ret;
ret = g_build_filename (script_dir, script_name, NULL);
g_free (script_name);
return ret;
}
bail:
return NULL;
}
gboolean
totem_pl_parser_is_videosite (const char *uri, gboolean debug)
{
const char *args[] = {
NULL,
"--check",
"--url",
NULL,
NULL
};
char *out;
char *script;
gboolean ret = FALSE;
script = find_helper_script ();
if (script == NULL) {
if (debug)
g_print ("Did not find a script to check whether '%s' is a videosite\n", uri);
return ret;
}
args[0] = script;
args[3] = uri;
g_spawn_sync (NULL,
(char **) args,
NULL,
0,
NULL,
NULL,
&out,
NULL,
NULL,
NULL);
ret = g_strcmp0 (out, "TRUE") == 0;
if (debug)
g_print ("Checking videosite with script '%s' for URI '%s' returned '%s' (%s)\n",
script, uri, out, ret ? "true" : "false");
g_free (script);
g_free (out);
return ret;
}
#ifndef TOTEM_PL_PARSER_MINI
TotemPlParserResult
totem_pl_parser_add_videosite (TotemPlParser *parser,
GFile *file,
GFile *base_file,
TotemPlParseData *parse_data,
gpointer data)
{
const char *args[] = {
NULL,
"--url",
NULL,
NULL
};
char *_uri;
char *out = NULL;
char **lines;
guint i;
GHashTable *ht;
char *new_uri = NULL;
char *script;
TotemPlParserResult ret;
script = find_helper_script ();
if (script == NULL) {
DEBUG (file, g_print ("Did not find a script to check whether '%s' is a videosite\n", uri));
return FALSE;
}
_uri = g_file_get_uri (file);
args[0] = script;
args[2] = _uri;
g_spawn_sync (NULL,
(char **) args,
NULL,
0,
NULL,
NULL,
&out,
NULL,
NULL,
NULL);
if (totem_pl_parser_is_debugging_enabled (parser))
g_print ("Parsing videosite for URI '%s' returned '%s'\n", _uri, out);
if (out != NULL) {
if (g_str_equal (out, "TOTEM_PL_PARSER_RESULT_ERROR")) {
ret = TOTEM_PL_PARSER_RESULT_ERROR;
goto out;
}
if (g_str_equal (out, "TOTEM_PL_PARSER_RESULT_UNHANDLED")) {
ret = TOTEM_PL_PARSER_RESULT_UNHANDLED;
goto out;
}
} else {
/* totem-pl-parser-videosite failed to launch */
ret = TOTEM_PL_PARSER_RESULT_ERROR;
goto out;
}
ht = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
lines = g_strsplit (out, "\n", -1);
g_free (out);
for (i = 0; lines[i] != NULL && *lines[i] != '\0'; i++) {
char **line;
line = g_strsplit (lines[i], "=", 2);
if (g_strcmp0 (line[0], TOTEM_PL_PARSER_FIELD_URI) == 0) {
if (new_uri == NULL)
new_uri = g_strdup (line[1]);
} else {
g_hash_table_insert (ht, g_strdup (line[0]), g_strdup (line[1]));
}
g_strfreev (line);
}
g_strfreev (lines);
totem_pl_parser_add_hash_table (parser, ht, new_uri, FALSE);
g_hash_table_unref (ht);
g_free (new_uri);
ret = TOTEM_PL_PARSER_RESULT_SUCCESS;
out:
g_free (script);
g_free (_uri);
return ret;
}
#endif /* !TOTEM_PL_PARSER_MINI */
|
