| [ Index ] |
PHP Cross Reference of moodle-2.8 |
[Summary view] [Print] [Text view]
1 <?php 2 3 // This file is part of Moodle - http://moodle.org/ 4 // 5 // Moodle is free software: you can redistribute it and/or modify 6 // it under the terms of the GNU General Public License as published by 7 // the Free Software Foundation, either version 3 of the License, or 8 // (at your option) any later version. 9 // 10 // Moodle is distributed in the hope that it will be useful, 11 // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 // GNU General Public License for more details. 14 // 15 // You should have received a copy of the GNU General Public License 16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>. 17 18 /** 19 * This file contains all the common stuff to be used in RSS System 20 * 21 * @package core_rss 22 * @category rss 23 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} 24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 25 */ 26 27 defined('MOODLE_INTERNAL') || die(); 28 29 /** 30 * Build the URL for the RSS feed and add it as a header 31 * 32 * @param stdClass $context The context under which the URL should be created 33 * @param string $componentname The name of the component for which the RSS feed exists 34 * @param stdClass $componentinstance The instance of the component 35 * @param string $title Name for the link to be added to the page header 36 */ 37 function rss_add_http_header($context, $componentname, $componentinstance, $title) { 38 global $PAGE, $USER; 39 40 $componentid = null; 41 if (is_object($componentinstance)) { 42 $componentid = $componentinstance->id; 43 } else { 44 $componentid = $componentinstance; 45 } 46 47 $rsspath = rss_get_url($context->id, $USER->id, $componentname, $componentid); 48 $PAGE->add_alternate_version($title, $rsspath, 'application/rss+xml'); 49 } 50 51 /** 52 * Print the link for the RSS feed with the correct RSS icon 53 * 54 * @param stdClass $contextid The id of the context under which the URL should be created 55 * @param int $userid The source of the RSS feed (site/course/group/user) 56 * @param string $componentname The name of the component for which the feed exists 57 * @param string $id The name by which to call the RSS File 58 * @param string $tooltiptext The tooltip to be displayed with the link 59 * @return string HTML output for the RSS link 60 */ 61 function rss_get_link($contextid, $userid, $componentname, $id, $tooltiptext='') { 62 global $OUTPUT; 63 64 static $rsspath = ''; 65 66 $rsspath = rss_get_url($contextid, $userid, $componentname, $id); 67 $rsspix = $OUTPUT->pix_url('i/rss'); 68 69 return '<a href="'. $rsspath .'"><img src="'. $rsspix .'" title="'. strip_tags($tooltiptext) .'" alt="'.get_string('rss').'" /></a>'; 70 } 71 72 /** 73 * This function returns the URL for the RSS XML file. 74 * 75 * @param int $contextid the course id 76 * @param int $userid the current user id 77 * @param string $componentname the name of the current component. For example "forum" 78 * @param string $additionalargs For modules, module instance id 79 * @return string the url of the RSS feed 80 */ 81 function rss_get_url($contextid, $userid, $componentname, $additionalargs) { 82 global $CFG; 83 require_once($CFG->libdir.'/filelib.php'); 84 $usertoken = rss_get_token($userid); 85 return get_file_url($contextid.'/'.$usertoken.'/'.$componentname.'/'.$additionalargs.'/rss.xml', null, 'rssfile'); 86 } 87 88 /** 89 * Print the link for the RSS feed with the correct RSS icon (Theme based) 90 * 91 * @param stdClass $contextid The id of the context under which the URL should be created 92 * @param int $userid The source of the RSS feed (site/course/group/user) 93 * @param string $componentname The name of the component for which the feed exists 94 * @param string $id The name by which to call the RSS File 95 * @param string $tooltiptext The tooltip to be displayed with the link 96 */ 97 function rss_print_link($contextid, $userid, $componentname, $id, $tooltiptext='') { 98 print rss_get_link($contextid, $userid, $componentname, $id, $tooltiptext); 99 100 } 101 102 /** 103 * Given an object, deletes all RSS files associated with it. 104 * 105 * @param string $componentname the name of the module ie 'forum'. Used to construct the cache path. 106 * @param stdClass $instance An object with an id member variable ie $forum, $glossary. 107 */ 108 function rss_delete_file($componentname, $instance) { 109 global $CFG; 110 111 $dirpath = "$CFG->cachedir/rss/$componentname"; 112 if (is_dir($dirpath)) { 113 if (!$dh = opendir($dirpath)) { 114 error_log("Directory permission error. RSS directory store for component '{$componentname}' exists but cannot be opened.", DEBUG_DEVELOPER); 115 return; 116 } 117 while (false !== ($filename = readdir($dh))) { 118 if ($filename!='.' && $filename!='..') { 119 if (preg_match("/{$instance->id}_/", $filename)) { 120 unlink("$dirpath/$filename"); 121 } 122 } 123 } 124 } 125 } 126 127 /** 128 * Are RSS feeds enabled for the supplied module instance? 129 * 130 * @param string $modname The name of the module to be checked 131 * @param stdClass $instance An instance of an activity module ie $forum, $glossary. 132 * @param bool $hasrsstype Should there be a rsstype member variable? 133 * @param bool $hasrssarticles Should there be a rssarticles member variable? 134 * @return bool whether or not RSS is enabled for the module 135 */ 136 function rss_enabled_for_mod($modname, $instance=null, $hasrsstype=true, $hasrssarticles=true) { 137 if ($hasrsstype) { 138 if (empty($instance->rsstype) || $instance->rsstype==0) { 139 return false; 140 } 141 } 142 143 //have they set the RSS feed to return 0 results? 144 if ($hasrssarticles) { 145 if (empty($instance->rssarticles) || $instance->rssarticles==0) { 146 return false; 147 } 148 } 149 150 if (!empty($instance) && !instance_is_visible($modname,$instance)) { 151 return false; 152 } 153 154 return true; 155 } 156 157 /** 158 * This function saves to file the rss feed specified in the parameters 159 * 160 * @param string $componentname the module name ie forum. Used to create a cache directory. 161 * @param string $filename the name of the file to be created ie "rss.xml" 162 * @param string $contents the data to be written to the file 163 * @param bool $expandfilename whether or not the fullname of the RSS file should be used 164 * @return bool whether the save was successful or not 165 */ 166 function rss_save_file($componentname, $filename, $contents, $expandfilename=true) { 167 global $CFG; 168 169 $status = true; 170 171 if (! $basedir = make_cache_directory ('rss/'. $componentname)) { 172 //Cannot be created, so error 173 $status = false; 174 } 175 176 if ($status) { 177 $fullfilename = $filename; 178 if ($expandfilename) { 179 $fullfilename = rss_get_file_full_name($componentname, $filename); 180 } 181 182 $rss_file = fopen($fullfilename, "w"); 183 if ($rss_file) { 184 $status = fwrite ($rss_file, $contents); 185 fclose($rss_file); 186 } else { 187 $status = false; 188 } 189 } 190 return $status; 191 } 192 193 /** 194 * Retrieve the location and file name of a cached RSS feed 195 * 196 * @param string $componentname the name of the component the RSS feed is being created for 197 * @param string $filename the name of the RSS FEED 198 * @return string The full name and path of the RSS file 199 */ 200 function rss_get_file_full_name($componentname, $filename) { 201 global $CFG; 202 return "$CFG->cachedir/rss/$componentname/$filename.xml"; 203 } 204 205 /** 206 * Construct the file name of the RSS File 207 * 208 * @param stdClass $instance the instance of the source of the RSS feed 209 * @param string $sql the SQL used to produce the RSS feed 210 * @param array $params the parameters used in the SQL query 211 * @return string the name of the RSS file 212 */ 213 function rss_get_file_name($instance, $sql, $params = array()) { 214 if ($params) { 215 // If a parameters array is passed, then we want to 216 // serialize it and then concatenate it with the sql. 217 // The reason for this is to generate a unique filename 218 // for queries using the same sql but different parameters. 219 asort($params); 220 $serializearray = serialize($params); 221 return $instance->id.'_'.md5($sql . $serializearray); 222 } else { 223 return $instance->id.'_'.md5($sql); 224 } 225 } 226 227 /** 228 * This function return all the common headers for every rss feed in the site 229 * 230 * @param string $title the title for the RSS Feed 231 * @param string $link the link for the origin of the RSS feed 232 * @param string $description the description of the contents of the RSS feed 233 * @return bool|string the standard header for the RSS feed 234 */ 235 function rss_standard_header($title = NULL, $link = NULL, $description = NULL) { 236 global $CFG, $USER, $OUTPUT; 237 238 $status = true; 239 $result = ""; 240 241 $site = get_site(); 242 243 if ($status) { 244 245 //Calculate title, link and description 246 if (empty($title)) { 247 $title = format_string($site->fullname); 248 } 249 if (empty($link)) { 250 $link = $CFG->wwwroot; 251 } 252 if (empty($description)) { 253 $description = $site->summary; 254 } 255 256 //xml headers 257 $result .= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"; 258 $result .= "<rss version=\"2.0\">\n"; 259 260 //open the channel 261 $result .= rss_start_tag('channel', 1, true); 262 263 //write channel info 264 $result .= rss_full_tag('title', 2, false, strip_tags($title)); 265 $result .= rss_full_tag('link', 2, false, $link); 266 $result .= rss_full_tag('description', 2, false, $description); 267 $result .= rss_full_tag('generator', 2, false, 'Moodle'); 268 if (!empty($USER->lang)) { 269 $result .= rss_full_tag('language', 2, false, substr($USER->lang,0,2)); 270 } 271 $today = getdate(); 272 $result .= rss_full_tag('copyright', 2, false, '(c) '. $today['year'] .' '. format_string($site->fullname)); 273 /* 274 if (!empty($USER->email)) { 275 $result .= rss_full_tag('managingEditor', 2, false, fullname($USER)); 276 $result .= rss_full_tag('webMaster', 2, false, fullname($USER)); 277 } 278 */ 279 280 //write image info 281 $rsspix = $OUTPUT->pix_url('i/rsssitelogo'); 282 283 //write the info 284 $result .= rss_start_tag('image', 2, true); 285 $result .= rss_full_tag('url', 3, false, $rsspix); 286 $result .= rss_full_tag('title', 3, false, 'moodle'); 287 $result .= rss_full_tag('link', 3, false, $CFG->wwwroot); 288 $result .= rss_full_tag('width', 3, false, '140'); 289 $result .= rss_full_tag('height', 3, false, '35'); 290 $result .= rss_end_tag('image', 2, true); 291 } 292 293 if (!$status) { 294 return false; 295 } else { 296 return $result; 297 } 298 } 299 300 301 /** 302 * Generates the rss XML code for every item passed in the array 303 * 304 * item->title: The title of the item 305 * item->author: The author of the item. Optional !! 306 * item->pubdate: The pubdate of the item 307 * item->link: The link url of the item 308 * item->description: The content of the item 309 * 310 * @param array $items an array of item objects 311 * @return bool|string the rss XML code for every item passed in the array 312 */ 313 function rss_add_items($items) { 314 global $CFG; 315 316 $result = ''; 317 318 if (!empty($items)) { 319 foreach ($items as $item) { 320 $result .= rss_start_tag('item',2,true); 321 //Include the category if exists (some rss readers will use it to group items) 322 if (isset($item->category)) { 323 $result .= rss_full_tag('category',3,false,$item->category); 324 } 325 if (isset($item->tags)) { 326 $attributes = array(); 327 if (isset($item->tagscheme)) { 328 $attributes['domain'] = s($item->tagscheme); 329 } 330 foreach ($item->tags as $tag) { 331 $result .= rss_full_tag('category', 3, false, $tag, $attributes); 332 } 333 } 334 $result .= rss_full_tag('title',3,false,strip_tags($item->title)); 335 $result .= rss_full_tag('link',3,false,$item->link); 336 $result .= rss_add_enclosures($item); 337 $result .= rss_full_tag('pubDate',3,false,gmdate('D, d M Y H:i:s',$item->pubdate).' GMT'); # MDL-12563 338 //Include the author if exists 339 if (isset($item->author) && !empty($item->author)) { 340 //$result .= rss_full_tag('author',3,false,$item->author); 341 //We put it in the description instead because it's more important 342 //for moodle than most other feeds, and most rss software seems to ignore 343 //the author field ... 344 $item->description = get_string('byname','',$item->author).'. <p>'.$item->description.'</p>'; 345 } 346 $result .= rss_full_tag('description',3,false,$item->description); 347 $result .= rss_full_tag('guid',3,false,$item->link,array('isPermaLink' => 'true')); 348 $result .= rss_end_tag('item',2,true); 349 350 } 351 } else { 352 $result = false; 353 } 354 return $result; 355 } 356 357 /** 358 * This function return all the common footers for every rss feed in the site. 359 * 360 * @return string 361 */ 362 function rss_standard_footer() { 363 $status = true; 364 $result = ''; 365 366 $result .= rss_end_tag('channel', 1, true); 367 $result .= '</rss>'; 368 369 return $result; 370 } 371 372 373 /** 374 * This function return an error xml file (string) to be sent when a rss is required (file.php) and something goes wrong 375 * 376 * @param string $errortype Type of error to send, default is rsserror 377 * @return stdClass returns a XML Feed with an error message in it 378 */ 379 function rss_geterrorxmlfile($errortype = 'rsserror') { 380 global $CFG; 381 382 $return = ''; 383 384 //XML Header 385 $return = rss_standard_header(); 386 387 //XML item 388 if ($return) { 389 $item = new stdClass(); 390 $item->title = "RSS Error"; 391 $item->link = $CFG->wwwroot; 392 $item->pubdate = time(); 393 $item->description = get_string($errortype); 394 $return .= rss_add_items(array($item)); 395 } 396 397 //XML Footer 398 if ($return) { 399 $return .= rss_standard_footer(); 400 } 401 402 return $return; 403 } 404 405 /** 406 * Get the ID of the user from a given RSS Token 407 * 408 * @param string $token the RSS token you would like to use to find the user id 409 * @return int The user id 410 */ 411 function rss_get_userid_from_token($token) { 412 global $DB; 413 414 $sql = 'SELECT u.id FROM {user} u 415 JOIN {user_private_key} k ON u.id = k.userid 416 WHERE u.deleted = 0 AND u.confirmed = 1 417 AND u.suspended = 0 AND k.value = ?'; 418 return $DB->get_field_sql($sql, array($token), IGNORE_MISSING); 419 } 420 421 /** 422 * Get the RSS Token from a given user id 423 * 424 * @param int $userid The user id 425 * @return string the RSS token for the user 426 */ 427 function rss_get_token($userid) { 428 return get_user_key('rss', $userid); 429 } 430 431 /** 432 * Removes the token for the given user from the DB 433 * @param int $userid The user id for the token you wish to delete 434 */ 435 function rss_delete_token($userid) { 436 delete_user_key('rss', $userid); 437 } 438 439 /** 440 * Return the xml start tag 441 * 442 * @param string $tag the xml tag name 443 * @param int $level the indentation level 444 * @param bool $endline whether or not to start new tags on a new line 445 * @param array $attributes the attributes of the xml tag 446 * @return string the xml start tag 447 */ 448 function rss_start_tag($tag,$level=0,$endline=false,$attributes=null) { 449 if ($endline) { 450 $endchar = "\n"; 451 } else { 452 $endchar = ""; 453 } 454 $attrstring = ''; 455 if (!empty($attributes) && is_array($attributes)) { 456 foreach ($attributes as $key => $value) { 457 $attrstring .= " ".$key."=\"".$value."\""; 458 } 459 } 460 return str_repeat(" ",$level*2)."<".$tag.$attrstring.">".$endchar; 461 } 462 463 /** 464 * Return the xml end tag 465 * @param string $tag the xml tag name 466 * @param int $level the indentation level 467 * @param bool $endline whether or not to start new tags on a new line 468 * @return string the xml end tag 469 */ 470 function rss_end_tag($tag,$level=0,$endline=true) { 471 if ($endline) { 472 $endchar = "\n"; 473 } else { 474 $endchar = ""; 475 } 476 return str_repeat(" ",$level*2)."</".$tag.">".$endchar; 477 } 478 479 /** 480 * Return the while xml element, including content 481 * 482 * @param string $tag the xml tag name 483 * @param int $level the indentation level 484 * @param bool $endline whether or not to start new tags on a new line 485 * @param string $content the text to go inside the tag 486 * @param array $attributes the attributes of the xml tag 487 * @return string the whole xml element 488 */ 489 function rss_full_tag($tag,$level=0,$endline=true,$content,$attributes=null) { 490 $st = rss_start_tag($tag,$level,$endline,$attributes); 491 $co=""; 492 $co = preg_replace("/\r\n|\r/", "\n", htmlspecialchars($content)); 493 $et = rss_end_tag($tag,0,true); 494 495 return $st.$co.$et; 496 } 497 498 /** 499 * Adds RSS Media Enclosures for "podcasting" by including attachments that 500 * are specified in the item->attachments field. 501 * 502 * @param stdClass $item representing an RSS item 503 * @return string RSS enclosure tags 504 */ 505 function rss_add_enclosures($item){ 506 global $CFG; 507 508 $returnstring = ''; 509 510 // list of media file extensions and their respective mime types 511 include_once($CFG->libdir.'/filelib.php'); 512 $mediafiletypes = get_mimetypes_array(); 513 514 // take into account attachments (e.g. from forum) - with these, we are able to know the file size 515 if (isset($item->attachments) && is_array($item->attachments)) { 516 foreach ($item->attachments as $attachment){ 517 $extension = strtolower(substr($attachment->url, strrpos($attachment->url, '.')+1)); 518 if (isset($mediafiletypes[$extension]['type'])) { 519 $type = $mediafiletypes[$extension]['type']; 520 } else { 521 $type = 'document/unknown'; 522 } 523 $returnstring .= "\n<enclosure url=\"$attachment->url\" length=\"$attachment->length\" type=\"$type\" />\n"; 524 } 525 } 526 527 return $returnstring; 528 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Fri Nov 28 20:29:05 2014 | Cross-referenced by PHPXref 0.7.1 |