latest version works with new magpie 0.7.1 files
[moodle.git] / rss / rsslib.php
1 <?php  // $Id$
2        // This file contains all the common stuff to be used in RSS System
4 //This function returns the icon (from theme) with the link to rss/file.php
5 function rss_get_link($courseid, $userid, $modulename, $id, $tooltiptext='') {
7  global $CFG, $THEME, $USER;
9     static $pixpath = '';
10     static $rsspath = '';
12     //In site course, if no logged (userid), use admin->id. Bug 2048.
13     if ($courseid == SITEID and empty($userid)) {
14         $admin = get_admin();
15         $userid = $admin->id;
16     }
18     if ($CFG->slasharguments) {
19         $rsspath = "$CFG->wwwroot/rss/file.php/$courseid/$userid/$modulename/$id/rss.xml";
20     } else {
21         $rsspath = "$CFG->wwwroot/rss/file.php?file=/$courseid/$userid/$modulename/$id/rss.xml";
22     }
24     if (empty($pixpath)) {
25         if (empty($THEME->custompix)) {
26             $pixpath = $CFG->wwwroot .'/pix';
27         } else {
28             $pixpath = $CFG->wwwroot .'/theme/'. $CFG->theme .'/pix';
29         }
30     }
32     $rsspix = $pixpath .'/i/rss.gif';
34     return '<a href="'. $rsspath .'"><img src="'. $rsspix .'" title="'. $tooltiptext .'" alt="" /></a>';
36 }
38 //This function prints the icon (from theme) with the link to rss/file.php
39 function rss_print_link($courseid, $userid, $modulename, $id, $tooltiptext='') {
41     echo rss_get_link($courseid, $userid, $modulename, $id, $tooltiptext);
43 }
44 //This function iterates over each module in the server to see if
45 //it supports generating rss feeds, searching for a MODULENAME_rss_feeds()
46 //function and invoking it foreach activity as necessary
47 function cron_rss_feeds () {
49     global $CFG;
51     $status = true;
52    
53     mtrace('    Generating rssfeeds...');
55     //Check for required functions...
56     if(!function_exists('utf8_encode')) {
57         mtrace('        ERROR: You need to add XML support to your PHP installation!');
58         return true;
59     }
61     if ($allmods = get_records('modules') ) {
62         foreach ($allmods as $mod) {
63             mtrace('        '.$mod->name.': ', '');
64             $modname = $mod->name;
65             $modfile = "$CFG->dirroot/mod/$modname/rsslib.php";
66             //If file exists and we have selected to restore that type of module
67             if (file_exists($modfile)) {
68                 include_once($modfile);
69                 $generaterssfeeds = $modname.'_rss_feeds';
70                 if (function_exists($generaterssfeeds)) {
71                     if ($status) {
72                         mtrace('generating ', '');;
73                         $status = $generaterssfeeds();
74                         if (!empty($status)) {
75                             mtrace('...OK');
76                         } else {
77                             mtrace('...FAILED');
78                         }
79                     } else {
80                         mtrace('...SKIPPED (failed above)');
81                     }
82                 } else {
83                     mtrace('...NOT SUPPORTED (function)');
84                 }
85             } else {
86                 mtrace('...NOT SUPPORTED (file)');
87             }
88         }
89     }
90     mtrace('    Ending  rssfeeds...', '');
91     if (!empty($status)) {
92         mtrace('...OK');
93     } else {
94         mtrace('...FAILED');
95     }
97     return $status;
98 }
100 //This function saves to file the rss feed specified in the parameters
101 function rss_save_file ($modname, $mod, $result) {
102  
103     global $CFG;
104     
105     $status = true;
107     if (! $basedir = make_upload_directory ('rss/'. $modname)) {
108         //Cannot be created, so error
109         $status = false;
110     }
112     if ($status) {
113         $file = rss_file_name($modname, $mod);
114         $rss_file = fopen($file, "w");
115         if ($rss_file) {
116             $status = fwrite ($rss_file, $result);
117             fclose($rss_file);
118         } else {
119             $status = false;
120         }
121     }
122     return $status;
126 function rss_file_name($modname, $mod) {
127     global $CFG;
129     return "$CFG->dataroot/rss/$modname/$mod->id.xml";
132 //This function return all the common headers for every rss feed in the site
133 function rss_standard_header($title = NULL, $link = NULL, $description = NULL) {
135     global $CFG, $THEME, $USER;
137     static $pixpath = '';
139     $status = true;
140     $result = "";
142     if (!$site = get_site()) {
143         $status = false;
144     }
146     if ($status) {
148         //Calculate title, link and description
149         if (empty($title)) {
150             $title = $site->fullname;
151         }
152         if (empty($link)) {
153             $link = $CFG->wwwroot;
154         }
155         if (empty($description)) {
156             $description = $site->summary;
157         }
159         //xml headers
160         $result .= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
161         $result .= "<rss version=\"2.0\">\n";
163         //open the channel
164         $result .= rss_start_tag("channel",1,true);
166         //write channel info
167         $result .= rss_full_tag("title",2,false,$title);
168         $result .= rss_full_tag("link",2,false,$link);
169         $result .= rss_full_tag("description",2,false,$description);
170         if (!empty($USER->lang)) {
171             $result .= rss_full_tag("language",2,false,substr($USER->lang,0,2));
172         }
173         $today = getdate();
174         $result .= rss_full_tag("copyright",2,false,"&copy; ".$today['year']." ".$site->fullname);
175         if (!empty($USER->email)) {
176             $result .= rss_full_tag("managingEditor",2,false,$USER->email);
177             $result .= rss_full_tag("webMaster",2,false,$USER->email);
178         }
180         //write image info
181         //Calculate the origin
182         if (empty($pixpath)) {
183             if (empty($THEME->custompix)) {
184                 $pixpath = "$CFG->wwwroot/pix";
185             } else {
186                 $pixpath = "$CFG->wwwroot/theme/$CFG->theme/pix";
187             }
188         }
189         $rsspix = $pixpath."/i/rsssitelogo.gif";
191         //write the info 
192         $result .= rss_start_tag("image",2,true);
193         $result .= rss_full_tag("url",3,false,$rsspix);
194         $result .= rss_full_tag("title",3,false,"moodle");
195         $result .= rss_full_tag("link",3,false,$CFG->wwwroot);
196         $result .= rss_full_tag("width",3,false,"140");
197         $result .= rss_full_tag("height",3,false,"35");
198         $result .= rss_end_tag("image",2,true);
199     }
201     if (!$status) {
202         return false;
203     } else {
204         return $result;
205     }
208 //This function returns the rss XML code for every item passed in the array
209 //item->title: The title of the item
210 //item->author: The author of the item. Optional !!
211 //item->pubdate: The pubdate of the item
212 //item->link: The link url of the item
213 //item->description: The content of the item
214 function rss_add_items($items) {
216     global $CFG;
217         
218     $result = "";
220     if (!empty($items)) {
221         foreach ($items as $item) {
222             $result .= rss_start_tag("item",2,true);
223             $result .= rss_full_tag("title",3,false,$item->title);
224             $result .= rss_full_tag("link",3,false,$item->link);
225             $result .= rss_full_tag("pubDate",3,false,date("r",$item->pubdate));
226             //Include the author if exists 
227             if (isset($item->author)) {
228                 $item->description = get_string("byname","",$item->author)."<p>".$item->description;
229             }
230             $result .= rss_full_tag("description",3,false,$item->description);
231             $result .= rss_end_tag("item",2,true);
233         }
234     } else {
235         $result = false;
236     }
237     return $result;
240 //This function return all the common footers for every rss feed in the site
241 function rss_standard_footer($title = NULL, $link = NULL, $description = NULL) {
243     global $CFG, $USER;
245     $status = true;
246     $result = "";
248     //Close the chanel
249     $result .= rss_end_tag("channel",1,true);
250     ////Close the rss tag
251     $result .= "</rss>";
253     return $result;
256 //This function return an error xml file (string)
257 //to be sent when a rss is required (file.php)
258 //and something goes wrong
259 function rss_geterrorxmlfile() {
261     global $CFG;
263     $return = '';
265     //XML Header
266     $return = rss_standard_header();
268     //XML item 
269     if ($return) {
270         $item->title = "RSS Error";
271         $item->link = $CFG->wwwroot;
272         $item->pubdate = time();
273         $item->description = get_string("rsserror");
274         $return .= rss_add_items(array($item));
275     }
277     //XML Footer
278     if ($return) {
279         $return .= rss_standard_footer();
280     }
281     
282     return $return;
285 // ===== This function are used to write XML tags =========
286 // [stronk7]: They are similar to the glossary export and backup generation
287 // but I've replicated them here because they have some minor
288 // diferences. Someday all they should go to a common place.
290 //Return the xml start tag
291 function rss_start_tag($tag,$level=0,$endline=false) {
292     if ($endline) {
293        $endchar = "\n";
294     } else {
295        $endchar = "";
296     }
297     return str_repeat(" ",$level*2)."<".$tag.">".$endchar;
300 //Return the xml end tag
301 function rss_end_tag($tag,$level=0,$endline=true) {
302     if ($endline) {
303        $endchar = "\n";
304     } else {
305        $endchar = "";
306     }
307     return str_repeat(" ",$level*2)."</".$tag.">".$endchar;
310 //Return the start tag, the contents and the end tag
311 function rss_full_tag($tag,$level=0,$endline=true,$content,$to_utf=true) {
312     //Here we encode absolute links
313     $st = rss_start_tag($tag,$level,$endline);
314     $co="";
315     if ($to_utf) {
316         $co = preg_replace("/\r\n|\r/", "\n", utf8_encode(htmlspecialchars($content)));
317     } else {
318         $co = preg_replace("/\r\n|\r/", "\n", htmlspecialchars($content));
319     }
320     $et = rss_end_tag($tag,0,true);
321     return $st.$co.$et;
324 //////////////////// LIBRARY FUNCTIONS FOR RSS_CLIENT BLOCK ////////////////
326 //initialize default config vars for rss_client block if needed
327 if (!isset($CFG->block_rss_client_submitters) ) {
328     $CFG->block_rss_client_submitters = 1; //default to admin only
330 if (empty($CFG->block_rss_client_num_entries) ) {
331     $CFG->block_rss_client_num_entries = 5; //default to 5 entries per block
333 if (!isset($CFG->block_rss_timeout) ) {
334     $CFG->block_rss_timeout = 30;
337 // Defines for moodle's use of magpierss classes
338 define('MAGPIE_DIR', $CFG->dirroot.'/rss/magpie/');
339 define('MAGPIE_CACHE_DIR', $CFG->dataroot .'/cache/rsscache/');
340 define('MAGPIE_CACHE_ON', true); //should be exposed as an admin config option
341 define('MAGPIE_CACHE_FRESH_ONLY', false); //should be exposed as an admin config option
342 define('MAGPIE_CACHE_AGE', $CFG->block_rss_timeout);
343 if ($CFG->debug) {
344     define('MAGPIE_DEBUG', true);
345 } else {
346     define('MAGPIE_DEBUG', false);
349 // defines for config var block_rss_client_submitters
350 define('SUBMITTERS_ALL_ACCOUNT_HOLDERS', 0);
351 define('SUBMITTERS_ADMIN_ONLY', 1);
352 define('SUBMITTERS_ADMIN_AND_TEACHER', 2);
354 /**
355  * @param int $rssid .
356  */
357 function rss_display_feeds($rssid='none') {
358     global $db, $USER, $CFG, $THEME;
359     global $blogid; //hackish, but if there is a blogid it would be good to preserve it
361     static $pixpath = '';
362     if (empty($pixpath)) {
363         if (empty($THEME->custompix)) {
364             $pixpath = $CFG->wwwroot .'/pix';
365         } else {
366             $pixpath = $CFG->wwwroot .'/theme/'. $CFG->theme .'/pix';
367         }
368     }
370     $rsspix = $pixpath .'/i/rss.gif';
372     $closeTable = false;
373     //Daryl Hawes note: convert this sql statement to a moodle function call
374     if ($rssid != 'none'){
375         $sql = 'SELECT * FROM '. $CFG->prefix .'block_rss_client WHERE id='. $rssid;
376     } else {
377         $sql = 'SELECT * FROM '. $CFG->prefix .'block_rss_client';
378     }
379     
380     $res = $db->Execute($sql);
381 //    print_object($res); //debug
382     
383     if ($res->fields){
384         $closeTable = true;
385         ?>
386             <table width="100%">
387             <tr bgcolor="<?php echo $THEME->cellheading;?>" class="forumpostheadertopic">
388                 <td><?php print_string('block_rss_feed', 'block_rss_client'); ?></td>
389                 <td><?php print_string('edit'); ?></td>
390                 <td><?php print_string('delete'); ?></td>
391             </tr>
392         <?php
393     }
394     
395     if (isset($res) && $res->fields){
396         while(!$res->EOF) {
397             $editString = '&nbsp;';
398             $deleteString = '&nbsp;';
399             if ($res->fields['userid'] == $USER->id || isadmin()){
400                 $editString = '<a href="'. $CFG->wwwroot .'/blocks/rss_client/block_rss_client_action.php?act=rss_edit&rssid='. $res->fields['id'] .'&blogid='. $blogid .'">';
401                 $editString .= '<img src="'. $CFG->pixpath .'/t/edit.gif" alt="'. get_string('edit');
402                 $editString .= '" title="'. get_string('edit') .'" align="absmiddle" height="16" width="16" border="0" /></a>';
403                 
404                 $deleteString = '<a href="'. $CFG->wwwroot .'/blocks/rss_client/block_rss_client_action.php?act=delfeed&rssid='. $res->fields['id'];
405                 $deleteString .= '&blogid='. $blogid .'" onClick="return confirm(\''. get_string('block_rss_delete_feed_confirm', 'block_rss_client') .'\');">';
406                 $deleteString .= '<img src="'. $CFG->pixpath .'/t/delete.gif" alt="'. get_string('delete');
407                 $deleteString .= '" title="'. get_string('delete') .'" align="absmiddle" border="0" /></a>';
408             }
409             print '<tr bgcolor="'. $THEME->cellcontent .'" class="forumpostmessage"><td><strong><a href="'. $CFG->wwwroot .'/blocks/rss_client/block_rss_client_action.php?act=view&rssid=';
410             print $res->fields['id'] .'&blogid='. $blogid .'">'. $res->fields['title'] .'</a></strong><br />' ."\n";
411             print $res->fields['description'] .'&nbsp;<br />' ."\n";
412             print $res->fields['url'] .'&nbsp;&nbsp;<a href="'. $res->fields['url'] .'" target=_new><img src="'. $rsspix .'" border="0" /></a>' ."\n";
413             print '<a href="http://feeds.archive.org/validator/check?url='. $res->fields['url'] .'">(Validate)</a>';
414             print '</td><td align="center">'. $editString .'</td>' ."\n";
415             print '<td align="center">'. $deleteString .'</td>' ."\n";
416             print '</tr>'."\n";
417             $res->MoveNext();
418         }
419     }
420     if ($closeTable){
421         print '</table>'."\n";
422     }
425 /**
426  * @param string $act .
427  * @param string $url .
428  * @param int $rssid .
429  * @param string $rsstype .
430  * @param bool $printnow .
431  */
432 function rss_get_form($act, $url, $rssid, $rsstype, $printnow=true) {
433     global $USER, $CFG, $_SERVER, $blockid, $blockaction;
434     global $blogid; //hackish, but if there is a blogid it would be good to preserve it
436     $returnstring = '<table><tr><td valign=\"top\">'; 
437     if ($act == 'rss_edit') { 
438         $returnstring .= get_string('edit'); 
439     } else { 
440         $returnstring .= get_string('block_rss_add_new', 'block_rss_client');
441     }
442     $returnstring .= '  '. get_string('block_rss_feed', 'block_rss_client');
443     
444     $returnstring .= '</td></tr><tr><td>';
445     
446     $returnstring .= '<form action="'. $_SERVER['PHP_SELF'] .'" method=POST name="block_rss">';
447     $returnstring .= 'URL: <input type="text" size="32" maxlength="128" name="url" value="';
448     if ($act == 'rss_edit') { 
449         $returnstring .= $url; 
450     } 
451     
452     $returnstring .= '" /><br />';
453     //<select name="rsstype"><option value="R">RSS/RDF</option>
454     //<option value="A"';
455     //if ($act == 'rss_edit' and $rsstype == 'A') {
456     //    $returnstring .= ' selected';
457     //} 
458     
459     //$returnstring .= '>Atom</option></select>';
460     
461     $returnstring .= '<input type="hidden" name="act" value="';
462     if ($act == 'rss_edit') {
463         $returnstring .= 'updfeed';
464     } else {
465         $returnstring .= 'addfeed';
466     } 
467     $returnstring .= '" />';
468     if ($act == 'rss_edit') { 
469         $returnstring .= '<input type="hidden" name="rssid" value="'. $rssid .'" />'. "\n"; 
470     } 
471     $returnstring .= '<input type="hidden" name="blogid" value="'. $blogid .'" />';
472     $returnstring .= '<input type="hidden" name="user" value="'. $USER->id .'" />';
473     $returnstring .= '<input type="submit" value="';
474     if ($act == 'rss_edit') {
475         $returnstring .= get_string('update'); 
476     } else { 
477         $returnstring .= get_string('add'); 
478     }
479     $returnstring .= '" />&nbsp;</form>';
480     
481 //    $returnstring .= '<ul>' . get_string('block_rss_find_more_feeds', 'block_rss_client');
482 // removed as this is possibly out of place here
483 //    $returnstring .= '<li><a href="http://www.syndic8.com" target="_new">syndic8</a> <li><a href="http://www.newsisfree.com" target="_new">NewsIsFree</A>';
484 //    $returnstring .= '</ul>';
485     $returnstring .= '</td></tr></table>';
486     
487     if ($printnow){
488         print $returnstring;
489     }
490     return $returnstring;
492 ?>