Included global $THEME to support custom images...
[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 prints the icon (from theme) with the link to rss/file.php
5 function rss_print_link($courseid, $userid, $modulename, $id, $tooltiptext="") {
7  global $CFG, $THEME, $USER;
9     static $pixpath = '';
10     static $rsspath = '';
12     if ($CFG->slasharguments) {
13         $rsspath = "$CFG->wwwroot/rss/file.php/$courseid/$userid/$modulename/$id/rss.xml";
14     } else {
15         $rsspath = "$CFG->wwwroot/rss/file.php?file=/$courseid/$userid/$modulename/$id/rss.xml";
16     }
18     if (empty($pixpath)) {
19         if (empty($THEME->custompix)) {
20             $pixpath = "$CFG->wwwroot/pix";
21         } else {
22             $pixpath = "$CFG->wwwroot/theme/$CFG->theme/pix";
23         }
24     }
26     $rsspix = $pixpath."/i/rss.gif";
28      echo "<a href=\"".$rsspath."\"><img src=\"$rsspix\" title=\"$tooltiptext\"></a>";
30 }
32 //This function iterates over each module in the server to see if
33 //it supports generating rss feeds, searching for a MODULENAME_rss_feeds()
34 //function and invoking it foreach activity as necessary
35 function cron_rss_feeds () {
37     global $CFG;
39     $status = true;
40    
41     echo "    Generating rssfeeds...\n";
43     if ($allmods = get_records("modules") ) {
44         foreach ($allmods as $mod) {
45             echo '        '.$mod->name.': ';
46             $modname = $mod->name;
47             $modfile = "$CFG->dirroot/mod/$modname/rsslib.php";
48             //If file exists and we have selected to restore that type of module
49             if (file_exists($modfile)) {
50                 include_once($modfile);
51                 $generaterssfeeds = $modname.'_rss_feeds';
52                 if (function_exists($generaterssfeeds)) {
53                     if ($status) {
54                         echo 'generating ';
55                         $status = $generaterssfeeds();
56                         if (!empty($status)) {
57                             echo "...OK\n";
58                         } else {
59                             echo "...FAILED\n";
60                         }
61                     } else {
62                         echo "...SKIPPED (failed above)\n";
63                     }
64                 } else {
65                     echo "...NOT SUPPORTED (function)\n";
66                 }
67             } else {
68                 echo "...NOT SUPPORTED (file)\n";
69             }
70         }
71     }
72     echo "    Ending  rssfeeds...";
73     if (!empty($status)) {
74         echo "...OK\n";
75     } else {
76         echo "...FAILED\n";
77     }
79     return $status;
80 }
82 //This function saves to file the rss feed specified in the parameters
83 function rss_save_file ($modname,$mod,$result) {
84  
85     global $CFG;
86     
87     $status = true;
89     $basedir = $CFG->dataroot."/rss";
91     //Check dataroot/rss exists
92     $status = check_dir_exists($basedir,true);
94     $basedir .= "/".$modname;
96     //Check dataroot/rrs/$modname exists
97     $status = check_dir_exists($basedir,true);
99     if ($status) {
100         $file = $basedir .= "/".$mod->id.".xml";
101         $rss_file = fopen($file,"w");
102         if ($rss_file) {
103             $status = fwrite ($rss_file,$result);
104             fclose($rss_file);
105         }
106     }
107     return $status;
110 //This function return all the common headers for every rss feed in the site
111 function rss_standard_header($title = NULL, $link = NULL, $description = NULL) {
113     global $CFG, $THEME, $USER;
115     static $pixpath = '';
117     $status = true;
118     $result = "";
120     if (!$site = get_site()) {
121         $status = false;
122     }
124     if ($status) {
126         //Calculate title, link and description
127         if (empty($title)) {
128             $title = $site->fullname;
129         }
130         if (empty($link)) {
131             $link = $CFG->wwwroot;
132         }
133         if (empty($description)) {
134             $description = $site->summary;
135         }
137         //xml headers
138         $result .= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
139         $result .= "<rss version=\"2.0\">\n";
141         //open the channel
142         $result .= rss_start_tag("channel",1,true);
144         //write channel info
145         $result .= rss_full_tag("title",2,false,$title);
146         $result .= rss_full_tag("link",2,false,$link);
147         $result .= rss_full_tag("description",2,false,$description);
148         $result .= rss_full_tag("language",2,false,substr($USER->lang,0,2));
149         $today = getdate();
150         $result .= rss_full_tag("copyright",2,false,"&copy; ".$today['year']." ".$site->fullname);
151         $result .= rss_full_tag("managingEditor",2,false,$USER->email);
152         $result .= rss_full_tag("webMaster",2,false,$USER->email);
154         //write image info
155         //Calculate the origin
156         if (empty($pixpath)) {
157             if (empty($THEME->custompix)) {
158                 $pixpath = "$CFG->wwwroot/pix";
159             } else {
160                 $pixpath = "$CFG->wwwroot/theme/$CFG->theme/pix";
161             }
162         }
163         $rsspix = $pixpath."/i/rsssitelogo.gif";
165         //write the info 
166         $result .= rss_start_tag("image",2,true);
167         $result .= rss_full_tag("url",3,false,$rsspix);
168         $result .= rss_full_tag("title",3,false,"moodle");
169         $result .= rss_full_tag("link",3,false,$CFG->wwwroot);
170         $result .= rss_full_tag("width",3,false,"140");
171         $result .= rss_full_tag("height",3,false,"35");
172         $result .= rss_end_tag("image",2,true);
173     }
175     if (!$status) {
176         return false;
177     } else {
178         return $result;
179     }
182 //This function returns the rss XML code for every item passed in the array
183 //item->title: The title of the item
184 //item->author: The author of the item
185 //item->pubdate: The pubdate of the item
186 //item->link: The link url of the item
187 //item->description: The content of the item
188 function rss_add_items($items) {
190     global $CFG;
191         
192     $result = "";
194     if (!empty($items)) {
195         foreach ($items as $item) {
196             $result .= rss_start_tag("item",2,true);
197             $result .= rss_full_tag("title",3,false,$item->title);
198             $result .= rss_full_tag("link",3,false,$item->link);
199             $result .= rss_full_tag("pubDate",3,false,date("r",$item->pubdate));
200             $result .= rss_full_tag("description",3,false,$item->description);
201             $result .= rss_end_tag("item",2,true);
203         }
204     } else {
205         $result = false;
206     }
207     return $result;
210 //This function return all the common footers for every rss feed in the site
211 function rss_standard_footer($title = NULL, $link = NULL, $description = NULL) {
213     global $CFG, $USER;
215     $status = true;
216     $result = "";
218     //Close the chanel
219     $result .= rss_end_tag("channel",1,true);
220     ////Close the rss tag
221     $result .= "</rss>";
223     return $result;
226 // ===== This function are used to write XML tags =========
227 // [stronk7]: They are similar to the glossary export and backup generation
228 // but I've replicated them here because they have some minor
229 // diferences. Someday all they should go to a common place.
231 //Return the xml start tag
232 function rss_start_tag($tag,$level=0,$endline=false) {
233     if ($endline) {
234        $endchar = "\n";
235     } else {
236        $endchar = "";
237     }
238     return str_repeat(" ",$level*2)."<".$tag.">".$endchar;
241 //Return the xml end tag
242 function rss_end_tag($tag,$level=0,$endline=true) {
243     if ($endline) {
244        $endchar = "\n";
245     } else {
246        $endchar = "";
247     }
248     return str_repeat(" ",$level*2)."</".$tag.">".$endchar;
251 //Return the start tag, the contents and the end tag
252 function rss_full_tag($tag,$level=0,$endline=true,$content,$to_utf=true) {
253     //Here we encode absolute links
254     $st = rss_start_tag($tag,$level,$endline);
255     $co="";
256     if ($to_utf) {
257         $co = preg_replace("/\r\n|\r/", "\n", utf8_encode(htmlspecialchars($content)));
258     } else {
259         $co = preg_replace("/\r\n|\r/", "\n", htmlspecialchars($content));
260     }
261     $et = rss_end_tag($tag,0,true);
262     return $st.$co.$et;
265 ?>