forked from moodle/moodle
/
rsslib.php
477 lines (409 loc) · 15.4 KB
/
rsslib.php
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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* This file contains all the common stuff to be used in RSS System
*
* @package core
* @subpackage rss
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
function rss_add_http_header($context, $componentname, $componentinstance, $title) {
global $PAGE, $USER;
$componentid = null;
if (is_object($componentinstance)) {
$componentid = $componentinstance->id;
} else {
$componentid = $componentinstance;
}
$rsspath = rss_get_url($context->id, $USER->id, $componentname, $componentid);
$PAGE->add_alternate_version($title, $rsspath, 'application/rss+xml');
}
/**
* This function returns the icon (from theme) with the link to rss/file.php
*
* @global object
* @global object
*/
function rss_get_link($contextid, $userid, $componentname, $id, $tooltiptext='') {
global $OUTPUT;
static $rsspath = '';
$rsspath = rss_get_url($contextid, $userid, $componentname, $id);
$rsspix = $OUTPUT->pix_url('i/rss');
return '<a href="'. $rsspath .'"><img src="'. $rsspix .'" title="'. strip_tags($tooltiptext) .'" alt="'.get_string('rss').'" /></a>';
}
/**
* This function returns the URL for the RSS XML file.
*
* @global object
* @param int contextid the course id
* @param int userid the current user id
* @param string modulename the name of the current module. For example "forum"
* @param string $additionalargs For modules, module instance id
*/
function rss_get_url($contextid, $userid, $componentname, $additionalargs) {
global $CFG;
require_once($CFG->libdir.'/filelib.php');
$usertoken = rss_get_token($userid);
return get_file_url($contextid.'/'.$usertoken.'/'.$componentname.'/'.$additionalargs.'/rss.xml', null, 'rssfile');
}
/**
* This function prints the icon (from theme) with the link to rss/file.php
*/
function rss_print_link($contextid, $userid, $componentname, $id, $tooltiptext='') {
print rss_get_link($contextid, $userid, $componentname, $id, $tooltiptext);
}
/**
* Given an object, deletes all RSS files associated with it.
* Relies on a naming convention. See rss_get_filename()
*
* @param string $componentname the name of the module ie 'forum'. Used to construct the cache path.
* @param object $instance An object with an id member variable ie $forum, $glossary.
* @return void
*/
function rss_delete_file($componentname, $instance) {
global $CFG;
$dirpath = "$CFG->dataroot/cache/rss/$componentname";
if (is_dir($dirpath)) {
$dh = opendir($dirpath);
while (false !== ($filename = readdir($dh))) {
if ($filename!='.' && $filename!='..') {
if (preg_match("/{$instance->id}_/", $filename)) {
unlink("$dirpath/$filename");
}
}
}
}
}
/**
* Are RSS feeds enabled for the supplied module instance?
* @param object $instance An instance of an activity module ie $forum, $glossary.
* @param boolean $hasrsstype Should there be a rsstype member variable?
* @param boolean $hasrssarticles Should there be a rssarticles member variable?
*/
function rss_enabled_for_mod($modname, $instance=null, $hasrsstype=true, $hasrssarticles=true) {
if ($hasrsstype) {
if (empty($instance->rsstype) || $instance->rsstype==0) {
return false;
}
}
//have they set the RSS feed to return 0 results?
if ($hasrssarticles) {
if (empty($instance->rssarticles) || $instance->rssarticles==0) {
return false;
}
}
if (!empty($instance) && !instance_is_visible($modname,$instance)) {
return false;
}
return true;
}
/**
* This function saves to file the rss feed specified in the parameters
*
* @global object
* @param string $componentname the module name ie forum. Used to create a cache directory.
* @param string $filename the name of the file to be created ie "1234"
* @param string $contents the data to be written to the file
*/
function rss_save_file($componentname, $filename, $contents, $expandfilename=true) {
global $CFG;
$status = true;
if (! $basedir = make_upload_directory ('cache/rss/'. $componentname)) {
//Cannot be created, so error
$status = false;
}
if ($status) {
$fullfilename = $filename;
if ($expandfilename) {
$fullfilename = rss_get_file_full_name($componentname, $filename);
}
$rss_file = fopen($fullfilename, "w");
if ($rss_file) {
$status = fwrite ($rss_file, $contents);
fclose($rss_file);
} else {
$status = false;
}
}
return $status;
}
function rss_get_file_full_name($componentname, $filename) {
global $CFG;
return "$CFG->dataroot/cache/rss/$componentname/$filename.xml";
}
function rss_get_file_name($instance, $sql) {
return $instance->id.'_'.md5($sql);
}
/**
* This function return all the common headers for every rss feed in the site
*
* @global object
* @global object
*/
function rss_standard_header($title = NULL, $link = NULL, $description = NULL) {
global $CFG, $USER, $OUTPUT;
$status = true;
$result = "";
$site = get_site();
if ($status) {
//Calculate title, link and description
if (empty($title)) {
$title = format_string($site->fullname);
}
if (empty($link)) {
$link = $CFG->wwwroot;
}
if (empty($description)) {
$description = $site->summary;
}
//xml headers
$result .= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
$result .= "<rss version=\"2.0\">\n";
//open the channel
$result .= rss_start_tag('channel', 1, true);
//write channel info
$result .= rss_full_tag('title', 2, false, strip_tags($title));
$result .= rss_full_tag('link', 2, false, $link);
$result .= rss_full_tag('description', 2, false, $description);
$result .= rss_full_tag('generator', 2, false, 'Moodle');
if (!empty($USER->lang)) {
$result .= rss_full_tag('language', 2, false, substr($USER->lang,0,2));
}
$today = getdate();
$result .= rss_full_tag('copyright', 2, false, '© '. $today['year'] .' '. format_string($site->fullname));
/*
if (!empty($USER->email)) {
$result .= rss_full_tag('managingEditor', 2, false, fullname($USER));
$result .= rss_full_tag('webMaster', 2, false, fullname($USER));
}
*/
//write image info
$rsspix = $OUTPUT->pix_url('i/rsssitelogo');
//write the info
$result .= rss_start_tag('image', 2, true);
$result .= rss_full_tag('url', 3, false, $rsspix);
$result .= rss_full_tag('title', 3, false, 'moodle');
$result .= rss_full_tag('link', 3, false, $CFG->wwwroot);
$result .= rss_full_tag('width', 3, false, '140');
$result .= rss_full_tag('height', 3, false, '35');
$result .= rss_end_tag('image', 2, true);
}
if (!$status) {
return false;
} else {
return $result;
}
}
//This function returns the rss XML code for every item passed in the array
//item->title: The title of the item
//item->author: The author of the item. Optional !!
//item->pubdate: The pubdate of the item
//item->link: The link url of the item
//item->description: The content of the item
function rss_add_items($items) {
global $CFG;
$result = '';
if (!empty($items)) {
foreach ($items as $item) {
$result .= rss_start_tag('item',2,true);
//Include the category if exists (some rss readers will use it to group items)
if (isset($item->category)) {
$result .= rss_full_tag('category',3,false,$item->category);
}
if (isset($item->tags)) {
$attributes = array();
if (isset($item->tagscheme)) {
$attributes['domain'] = s($item->tagscheme);
}
foreach ($item->tags as $tag) {
$result .= rss_full_tag('category', 3, false, $tag, $attributes);
}
}
$result .= rss_full_tag('title',3,false,strip_tags($item->title));
$result .= rss_full_tag('link',3,false,$item->link);
$result .= rss_add_enclosures($item);
$result .= rss_full_tag('pubDate',3,false,gmdate('D, d M Y H:i:s',$item->pubdate).' GMT'); # MDL-12563
//Include the author if exists
if (isset($item->author) && !empty($item->author)) {
//$result .= rss_full_tag('author',3,false,$item->author);
//We put it in the description instead because it's more important
//for moodle than most other feeds, and most rss software seems to ignore
//the author field ...
$item->description = get_string('byname','',$item->author).'. <p>'.$item->description.'</p>';
}
$result .= rss_full_tag('description',3,false,$item->description);
$result .= rss_full_tag('guid',3,false,$item->link,array('isPermaLink' => 'true'));
$result .= rss_end_tag('item',2,true);
}
} else {
$result = false;
}
return $result;
}
/**
* This function return all the common footers for every rss feed in the site
*/
function rss_standard_footer($title = NULL, $link = NULL, $description = NULL) {
$status = true;
$result = '';
//Close the chanel
$result .= rss_end_tag('channel', 1, true);
////Close the rss tag
$result .= '</rss>';
return $result;
}
/**
* This function return an error xml file (string)
* to be sent when a rss is required (file.php)
* and something goes wrong
*/
function rss_geterrorxmlfile($errortype = 'rsserror') {
global $CFG;
$return = '';
//XML Header
$return = rss_standard_header();
//XML item
if ($return) {
$item = new stdClass();
$item->title = "RSS Error";
$item->link = $CFG->wwwroot;
$item->pubdate = time();
$item->description = get_string($errortype);
$return .= rss_add_items(array($item));
}
//XML Footer
if ($return) {
$return .= rss_standard_footer();
}
return $return;
}
function rss_get_userid_from_token($token) {
global $DB;
$record = $DB->get_record('user_private_key', array('script'=>'rss','value' => $token), 'userid', IGNORE_MISSING);
if ($record) {
return $record->userid;
}
return null;
}
function rss_get_token($userid) {
return get_user_key('rss', $userid);
}
function rss_delete_token($userid) {
delete_user_key('rss', $userid);
}
// ===== This function are used to write XML tags =========
// [stronk7]: They are similar to the glossary export and backup generation
// but I've replicated them here because they have some minor
// diferences. Someday all they should go to a common place.
/**
* Return the xml start tag
*/
function rss_start_tag($tag,$level=0,$endline=false,$attributes=null) {
if ($endline) {
$endchar = "\n";
} else {
$endchar = "";
}
$attrstring = '';
if (!empty($attributes) && is_array($attributes)) {
foreach ($attributes as $key => $value) {
$attrstring .= " ".$key."=\"".$value."\"";
}
}
return str_repeat(" ",$level*2)."<".$tag.$attrstring.">".$endchar;
}
/**
* Return the xml end tag
*/
function rss_end_tag($tag,$level=0,$endline=true) {
if ($endline) {
$endchar = "\n";
} else {
$endchar = "";
}
return str_repeat(" ",$level*2)."</".$tag.">".$endchar;
}
/**
* Return the start tag, the contents and the end tag
*/
function rss_full_tag($tag,$level=0,$endline=true,$content,$attributes=null) {
$st = rss_start_tag($tag,$level,$endline,$attributes);
$co="";
$co = preg_replace("/\r\n|\r/", "\n", htmlspecialchars($content));
$et = rss_end_tag($tag,0,true);
return $st.$co.$et;
}
/**
* Adds RSS Media Enclosures for "podcasting" by examining links to media files,
* and attachments which are media files. Please note that the RSS that is
* produced cannot be strictly valid for the linked files, since we do not know
* the files' sizes and cannot include them in the "length" attribute. At
* present, the validity (and therefore the podcast working in most software)
* can only be ensured for attachments, and not for links.
* Note also that iTunes does some things very badly - one thing it does is
* refuse to download ANY of your files if you're using "file.php?file=blah"
* and can't use the more elegant "file.php/blah" slasharguments setting. It
* stops after ".php" and assumes the files are not media files, despite what
* is specified in the "type" attribute. Dodgy coding all round!
*
* Authors
* - Hannes Gassert <hannes@mediagonal.ch>
* - Dan Stowell
*
* @global object
* @param $item object representing an RSS item
* @return string RSS enclosure tags
*/
function rss_add_enclosures($item){
global $CFG;
$returnstring = '';
$rss_text = $item->description;
// list of media file extensions and their respective mime types
include_once($CFG->libdir.'/filelib.php');
$mediafiletypes = get_mimetypes_array();
// regular expression (hopefully) matching all links to media files
$medialinkpattern = '@href\s*=\s*(\'|")(\S+(' . implode('|', array_keys($mediafiletypes)) . '))\1@Usie';
// take into account attachments (e.g. from forum) - with these, we are able to know the file size
if (isset($item->attachments) && is_array($item->attachments)) {
foreach ($item->attachments as $attachment){
$extension = strtolower(substr($attachment->url, strrpos($attachment->url, '.')+1));
if (isset($mediafiletypes[$extension]['type'])) {
$type = $mediafiletypes[$extension]['type'];
} else {
$type = 'document/unknown';
}
$returnstring .= "\n<enclosure url=\"$attachment->url\" length=\"$attachment->length\" type=\"$type\" />\n";
}
}
if (!preg_match_all($medialinkpattern, $rss_text, $matches)){
return $returnstring;
}
// loop over matches of regular expression
for ($i = 0; $i < count($matches[2]); $i++){
$url = htmlspecialchars($matches[2][$i]);
$extension = strtolower($matches[3][$i]);
if (isset($mediafiletypes[$extension]['type'])) {
$type = $mediafiletypes[$extension]['type'];
} else {
$type = 'document/unknown';
}
// the rss_*_tag functions can't deal with methods, unfortunately
$returnstring .= "\n<enclosure url='$url' type='$type' />\n";
}
return $returnstring;
}