mirrored from git://git.moodle.org/moodle.git
/
rsslib.php
647 lines (559 loc) · 21.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
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
<?php // $Id$
// This file contains all the common stuff to be used in RSS System
//This function returns the icon (from theme) with the link to rss/file.php
function rss_get_link($courseid, $userid, $modulename, $id, $tooltiptext="") {
global $CFG, $THEME, $USER;
static $pixpath = '';
static $rsspath = '';
//In site course, if no logged (userid), use admin->id. Bug 2048.
if ($courseid == SITEID and empty($userid)) {
$admin = get_admin();
$userid = $admin->id;
}
if ($CFG->slasharguments) {
$rsspath = "$CFG->wwwroot/rss/file.php/$courseid/$userid/$modulename/$id/rss.xml";
} else {
$rsspath = "$CFG->wwwroot/rss/file.php?file=/$courseid/$userid/$modulename/$id/rss.xml";
}
if (empty($pixpath)) {
if (empty($THEME->custompix)) {
$pixpath = "$CFG->wwwroot/pix";
} else {
$pixpath = "$CFG->wwwroot/theme/$CFG->theme/pix";
}
}
$rsspix = $pixpath."/i/rss.gif";
return "<a href=\"".$rsspath."\"><img src=\"$rsspix\" title=\"$tooltiptext\" alt=\"\" /></a>";
}
//This function prints the icon (from theme) with the link to rss/file.php
function rss_print_link($courseid, $userid, $modulename, $id, $tooltiptext="") {
echo rss_get_link($courseid, $userid, $modulename, $id, $tooltiptext);
}
//This function iterates over each module in the server to see if
//it supports generating rss feeds, searching for a MODULENAME_rss_feeds()
//function and invoking it foreach activity as necessary
function cron_rss_feeds () {
global $CFG;
$status = true;
mtrace(" Generating rssfeeds...");
//Check for required functions...
if(!function_exists('utf8_encode')) {
mtrace(" ERROR: You need to add XML support to your PHP installation!");
return true;
}
if ($allmods = get_records("modules") ) {
foreach ($allmods as $mod) {
mtrace(' '.$mod->name.': ', '');
$modname = $mod->name;
$modfile = "$CFG->dirroot/mod/$modname/rsslib.php";
//If file exists and we have selected to restore that type of module
if (file_exists($modfile)) {
include_once($modfile);
$generaterssfeeds = $modname.'_rss_feeds';
if (function_exists($generaterssfeeds)) {
if ($status) {
mtrace('generating ', '');;
$status = $generaterssfeeds();
if (!empty($status)) {
mtrace("...OK");
} else {
mtrace("...FAILED");
}
} else {
mtrace("...SKIPPED (failed above)");
}
} else {
mtrace("...NOT SUPPORTED (function)");
}
} else {
mtrace("...NOT SUPPORTED (file)");
}
}
}
mtrace(" Ending rssfeeds...", '');
if (!empty($status)) {
mtrace("...OK");
} else {
mtrace("...FAILED");
}
return $status;
}
//This function saves to file the rss feed specified in the parameters
function rss_save_file ($modname,$mod,$result) {
global $CFG;
$status = true;
if (! $basedir = make_upload_directory ("rss/".$modname)) {
//Cannot be created, so error
$status = false;
}
if ($status) {
$file = rss_file_name($modname, $mod);
$rss_file = fopen($file,"w");
if ($rss_file) {
$status = fwrite ($rss_file,$result);
fclose($rss_file);
} else {
$status = false;
}
}
return $status;
}
function rss_file_name($modname, $mod) {
global $CFG;
return "$CFG->dataroot/rss/$modname/$mod->id.xml";
}
//This function return all the common headers for every rss feed in the site
function rss_standard_header($title = NULL, $link = NULL, $description = NULL) {
global $CFG, $THEME, $USER;
static $pixpath = '';
$status = true;
$result = "";
if (!$site = get_site()) {
$status = false;
}
if ($status) {
//Calculate title, link and description
if (empty($title)) {
$title = $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,$title);
$result .= rss_full_tag("link",2,false,$link);
$result .= rss_full_tag("description",2,false,$description);
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']." ".$site->fullname);
if (!empty($USER->email)) {
$result .= rss_full_tag("managingEditor",2,false,$USER->email);
$result .= rss_full_tag("webMaster",2,false,$USER->email);
}
//write image info
//Calculate the origin
if (empty($pixpath)) {
if (empty($THEME->custompix)) {
$pixpath = "$CFG->wwwroot/pix";
} else {
$pixpath = "$CFG->wwwroot/theme/$CFG->theme/pix";
}
}
$rsspix = $pixpath."/i/rsssitelogo.gif";
//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);
$result .= rss_full_tag("title",3,false,$item->title);
$result .= rss_full_tag("link",3,false,$item->link);
$result .= rss_full_tag("pubDate",3,false,date("r",$item->pubdate));
//Include the author if exists
if (isset($item->author)) {
$item->description = get_string("byname","",$item->author)."<p>".$item->description;
}
$result .= rss_full_tag("description",3,false,$item->description);
$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) {
global $CFG, $USER;
$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() {
global $CFG;
$return = '';
//XML Header
$return = rss_standard_header();
//XML item
if ($return) {
$item->title = "RSS Error";
$item->link = $CFG->wwwroot;
$item->pubdate = time();
$item->description = get_string("rsserror");
$return .= rss_add_items(array($item));
}
//XML Footer
if ($return) {
$return .= rss_standard_footer();
}
return $return;
}
// ===== 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) {
if ($endline) {
$endchar = "\n";
} else {
$endchar = "";
}
return str_repeat(" ",$level*2)."<".$tag.">".$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,$to_utf=true) {
//Here we encode absolute links
$st = rss_start_tag($tag,$level,$endline);
$co="";
if ($to_utf) {
$co = preg_replace("/\r\n|\r/", "\n", utf8_encode(htmlspecialchars($content)));
} else {
$co = preg_replace("/\r\n|\r/", "\n", htmlspecialchars($content));
}
$et = rss_end_tag($tag,0,true);
return $st.$co.$et;
}
//////////////////// LIBRARY FUNCTIONS FOR RSS_CLIENT BLOCK ////////////////
//initialize config vars for rss_client block if missing
if (empty($CFG->block_rss_client_submitters) ) {
$CFG->block_rss_client_submitters = 1; //default to admin only
}
if (empty($CFG->block_rss_client_num_entries) ) {
$CFG->block_rss_client_num_entries = 5; //default to 5 entries per block
}
if (empty($CFG->block_rss_timeout) ) {
$CFG->block_rss_timeout = 30;
}
/**
* Determines whether or not to get a news feed remotely or from cache and reads it into a string
* @param int rssid - id of feed in blog_rss table
* @param string url - url of remote feed
* @param string type - either 'A' or 'R' where A is an atom feed and R is either rss or rdf
* @return Atom|MagpieRSS|null This function returns an Atom object in the case of an Atom feed, a MagpieRSS object in the case of an RDF/RSS feed or null if there was an error loading the remote feed.
* NOTE that this function requires allow_url_fopen be On in your php.ini file
* (it may be off for security by your web host)
*/
function rss_get_feed($rssid, $url, $type) {
global $CFG;
$writetofile = false;
$urlfailurestring = 'Failed to open remote feed at: ' . $url .'<br /> allow_url_fopen needs to be On in the php.ini file for this file wrapper call to work. Please refer to <a href="http://us2.php.net/filesystem">http://us2.php.net/filesystem</a>';
$filefailurestring = 'Could not open the file located at: ';
$secs = $CFG->block_rss_timeout * 60;
// If moodle dataroot cache folder is missing create it
if (!file_exists($CFG->dataroot .'/cache/')) {
mkdir($CFG->dataroot .'/cache');
}
// If moodle dataroot cache/rsscache folder is missing create it
if (!file_exists($CFG->dataroot .'/cache/rsscache/')) {
mkdir($CFG->dataroot .'/cache/rsscache');
}
$file = $CFG->dataroot .'/cache/rsscache/'. $rssid .'.xml';
// echo "file = ". $file; //debug
//if feed in cache
if (file_exists($file)) {
//check age of cache file
// echo "file exists $file"; //debug
if ($CFG->debug){
$data = stat($file);
} else {
$data = @stat($file);
}
$now = time();
if (($now - $data[10]) > $secs) {
// The cached file has expired. Attempt to read fresh from source
$xml = load_feed_from_url($url);
if ($xml) {
//success
$writetofile = true;
} else {
// Failed to load remote feed. Since the file exists attempt to read from cache
if ($CFG->debug) {
print $urlfailurestring;
}
$xml = load_feed_from_file($file);
if (!$xml) {
// Failed to load from cache as well!
if ($CFG->debug) {
print $filefailurestring . $file;
return;
}
}
}
} else {
// Cached file has not expired. Attempt to read from cached file.
$xml = load_feed_from_file($file);
if (!$xml) {
// Failed to load from cache, attempt to read from source
if ($CFG->debug) {
print $filefailurestring . $file;
}
$xml = load_feed_from_url($url);
if ($xml) {
// success
$writetofile = true;
} else {
// Failed to read from source as well!
if ($CFG->debug) {
print $urlfailurestring;
}
return;
}
}
}
} else {
// No cached fil at all, read from source
$xml = load_feed_from_url($url);
if ($xml) {
//success
$writetofile = true;
} else {
// Failed to read from source url!
if ($CFG->debug) {
print $urlfailurestring;
}
return;
}
}
//print_object($xml); //debug
if ($CFG->debug){
$xmlstr = implode(' ', $xml);
} else {
$xmlstr = @implode(' ', $xml);
}
if ( $writetofile && !empty($xmlstr) ) { //write file to cache
// jlb: adding file:/ to the start of the file name fixed
// some caching problems that I was experiencing.
//$file="file:/" + $file;
file_put_contents($file, $xmlstr);
}
if ($type == 'A') {
//note: Atom is being modified by a working group
//http://www.mnot.net/drafts/draft-nottingham-atom-format-02.html
include_once($CFG->dirroot .'/rss/class.Atom.php');
$atom = new Atom($xmlstr);
$atom->channel = $atom->feed;
$atom->items = $atom->entries;
$atom->channel['description'] = $atom->channel['tagline'];
for($i=0;$i<count($atom->items);$i++) {
$atom->items[$i]['description'] = $atom->items[$i]['content'];
}
return $atom;
} else {
include_once($CFG->dirroot .'/rss/class.RSS.php');
$rss = new MagpieRSS($xmlstr);
return $rss;
}
}
/**
* @param string $file The path to the cached feed to load
*/
function load_feed_from_file($file) {
global $CFG;
// echo "read from cache"; //debug
//read in from cache
if ($CFG->debug){
$xml = file($file);
} else {
$xml = @file($file);
}
return $xml;
}
/**
* @param string $url The url of the remote news feed to load
*/
function load_feed_from_url($url) {
global $CFG;
// echo "read from original"; //debug
//read from source
if ($CFG->debug){
$xml = file($url);
} else {
$xml = @file($url);
}
return $xml;
}
/**
* @param int $rssid .
*/
function rss_display_feeds($rssid='none') {
global $db, $USER, $CFG, $THEME;
global $blogid; //hackish, but if there is a blogid it would be good to preserve it
$closeTable = false;
//Daryl Hawes note: convert this sql statement to a moodle function call
if ($rssid != 'none'){
$sql = 'SELECT * FROM '. $CFG->prefix .'block_rss_client WHERE id='. $rssid;
} else {
$sql = 'SELECT * FROM '. $CFG->prefix .'block_rss_client';
}
$res = $db->Execute($sql);
// print_object($res); //debug
if ($res->fields){
$closeTable = true;
?>
<table width="100%">
<tr bgcolor="<?php echo $THEME->cellheading;?>" class="forumpostheadertopic">
<td><?php print_string('block_rss_feed', 'block_rss_client'); ?></td>
<td><?php print_string('edit'); ?></td>
<td><?php print_string('delete'); ?></td>
</tr>
<?php
}
if (isset($res) && $res->fields){
while(!$res->EOF) {
$editString = ' ';
$deleteString = ' ';
if ($res->fields['userid'] == $USER->id || isadmin()){
$editString = '<a href="'. $CFG->wwwroot .'/blocks/rss_client/block_rss_client_action.php?act=rss_edit&rssid='. $res->fields['id'] .'&blogid='. $blogid .'">';
$editString .= '<img src="'. $CFG->pixpath .'/t/edit.gif" alt="'. get_string('edit');
$editString .= '" title="'. get_string('edit') .'" align="absmiddle" height=\"16\" width=\"16\" border=\"0\" /></a>';
$deleteString = '<a href="'. $CFG->wwwroot .'/blocks/rss_client/block_rss_client_action.php?act=delfeed&rssid='. $res->fields['id'];
$deleteString .= '&blogid='. $blogid .'" onClick="return confirm(\''. get_string('block_rss_delete_feed_confirm', 'block_rss_client') .'\');">';
$deleteString .= '<img src="'. $CFG->pixpath .'/t/delete.gif" alt="'. get_string('delete');
$deleteString .= '" title="'. get_string('delete') .'" align="absmiddle" border=\"0\" /></a>';
}
print '<tr bgcolor="'. $THEME->cellcontent .'" class="forumpostmessage"><td><strong><a href="'. $CFG->wwwroot .'/blocks/rss_client/block_rss_client_action.php?act=view&rssid=';
print $res->fields['id'] .'&blogid='. $blogid .'">'. $res->fields['title'] .'</a></strong><br />' ."\n";
print $res->fields['description'] .' <br />' ."\n";
print $res->fields['url'] .' <a href="'. $res->fields['url'] .'" target=_new><img src="'. $CFG->pixpath .'/blog/xml.gif" border="0" /></a>' ."\n";
print '<a href="http://feeds.archive.org/validator/check?url='. $res->fields['url'] .'">(Validate)</a>';
print '</td><td align="center">'. $editString .'</td>' ."\n";
print '<td align=\"center\">'. $deleteString .'</td>' ."\n";
print '</tr>'."\n";
$res->MoveNext();
}
}
if ($closeTable){
print '</table>'."\n";
}
}
/**
* @param string $act .
* @param string $url .
* @param int $rssid .
* @param string $rsstype .
* @param bool $printnow .
*/
function rss_get_form($act, $url, $rssid, $rsstype, $printnow=true) {
global $USER, $CFG, $_SERVER, $blockid, $blockaction;
global $blogid; //hackish, but if there is a blogid it would be good to preserve it
$returnstring = '<table><tr><td valign=\"top\">';
if ($act == 'rss_edit') {
$returnstring .= get_string('edit');
} else {
$returnstring .= get_string('block_rss_add_new', 'block_rss_client');
}
$returnstring .= ' '. get_string('block_rss_feed', 'block_rss_client');
$returnstring .= '</td></tr><tr><td>';
$returnstring .= '<form action="'. $_SERVER['PHP_SELF'] .'" method=POST name="block_rss">';
$returnstring .= 'URL: <input type="text" size="32" maxlength="128" name="url" value="';
if ($act == 'rss_edit') {
$returnstring .= $url;
}
$returnstring .= '" /><br /><select name="rsstype"><option value="R">RSS/RDF</option>
<option value="A"';
if ($act == 'rss_edit' and $rsstype == 'A') {
$returnstring .= ' selected';
}
$returnstring .= '>Atom</option></select>';
$returnstring .= '<input type="hidden" name="act" value="';
if ($act == 'rss_edit') {
$returnstring .= 'updfeed';
} else {
$returnstring .= 'addfeed';
}
$returnstring .= '" />';
if ($act == 'rss_edit') {
$returnstring .= '<input type="hidden" name="rssid" value="'. $rssid .'" />'. "\n";
}
$returnstring .= '<input type="hidden" name="blogid" value="'. $blogid .'" />';
$returnstring .= '<input type="hidden" name="user" value="'. $USER->id .'" />';
$returnstring .= '<input type="submit" value="';
if ($act == 'rss_edit') {
$returnstring .= get_string('update');
} else {
$returnstring .= get_string('add');
}
$returnstring .= '" /> </form>';
$returnstring .= '<ul>' . get_string('block_rss_find_more_feeds', 'block_rss_client');
// removed as this is possibly out of place here
// $returnstring .= '<li><a href="http://www.syndic8.com" target="_new">syndic8</a> <li><a href="http://www.newsisfree.com" target="_new">NewsIsFree</A>';
$returnstring .= '</ul>';
$returnstring .= '</td></tr></table>';
if ($printnow){
print $returnstring;
}
return $returnstring;
}
/**
* added by Daryl Hawes for rss/atom feeds
* found at http://us4.php.net/manual/en/function.fwrite.php
* added check for moodle debug option. if off then use '@' to suppress error/warning messages
* @param string $filename .
* @param string $content .
*/
if (! function_exists('file_put_contents')){
function file_put_contents($filename, $content) {
global $CFG;
$nr_of_bytes = 0;
if ($CFG->debug){
if (($file = fopen($filename, 'w+')) === false) return false;
} else {
if (($file = @fopen($filename, 'w+')) === false) return false;
}
if ($CFG->debug){
if ($nr_of_bytes = fwrite($file, $content, strlen($content)) === false) return false;
} else {
if ($nr_of_bytes = @fwrite($file, $content, strlen($content)) === false) return false;
}
fclose($file);
return $nr_of_bytes;
}
}
?>