search/documents/wiki_document.php

   1 <?php
   2 /**
   3 * Global Search Engine for Moodle
   4 * Michael Champanis (mchampan) [cynnical@gmail.com]
   5 * review 1.8+ : Valery Fremaux [valery.fremaux@club-internet.fr]
   6 * 2007/08/02
   7 *
   8 * document handling for wiki activity module
   9 * This file contains the mapping between a wiki page and it's indexable counterpart,
  10 * e.g. searchdocument->title = wikipage->pagename
  11 *
  12 * Functions for iterating and retrieving the necessary records are now also included
  13 * in this file, rather than mod/wiki/lib.php
  14 **/
  15
  16 require_once("$CFG->dirroot/search/documents/document.php");
  17 require_once("$CFG->dirroot/mod/wiki/lib.php");
  18
  19 /*
  20 * All the $doc->___ fields are required by the base document class!
  21 * Each and every module that requires search functionality must correctly
  22 * map their internal fields to the five $doc fields (id, title, author, contents
  23 * and url). Any module specific data can be added to the $data object, which is
  24 * serialised into a binary field in the index.
  25 **/
  26 class WikiSearchDocument extends SearchDocument {
  27     public function __construct(&$page, $wiki_id, $course_id, $group_id, $user_id, $context_id) {
  28         // generic information; required
  29         $doc->docid         = $page['id'];
  30         $doc->documenttype  = SEARCH_TYPE_WIKI;
  31         $doc->itemtype      = 'standard';
  32         $doc->contextid     = $context_id;
  33
  34         $doc->title     = $page['pagename'];
  35         $doc->date      = $page['timemodified'];
  36         //remove '(ip.ip.ip.ip)' from wiki author field
  37         $doc->author    = preg_replace('/\(.*?\)/', '', $page['author']);
  38         $doc->contents  = $page['content'];
  39         $doc->url       = wiki_make_link($wiki_id, $page['pagename'], $page['version']);
  40
  41         // module specific information; optional
  42         $data->version  = $page['version'];
  43         $data->wiki     = $wiki_id;
  44
  45         // construct the parent class
  46         parent::__construct($doc, $data, $course_id, $group_id, $user_id, PATH_FOR_SEARCH_TYPE_WIKI);
  47     } //constructor
  48 } //WikiSearchDocument
  49
  50 /**
  51 * converts a page name to cope Wiki constraints. Transforms spaces in plus.
  52 * @param str the name to convert
  53 * @return the converted name
  54 */
  55 function wiki_name_convert($str) {
  56     return str_replace(' ', '+', $str);
  57 } //wiki_name_convert
  58
  59 /**
  60 * constructs a valid link to a wiki content
  61 * @param wikiId
  62 * @param title
  63 * @param version
  64 */
  65 function wiki_make_link($wikiId, $title, $version) {
  66     global $CFG;
  67
  68     return $CFG->wwwroot.'/mod/wiki/view.php?wid='.$wikiId.'&amp;page='.wiki_name_convert($title).'&amp;version='.$version;
  69 } //wiki_make_link
  70
  71 /**
  72 * rescued and converted from ewikimoodlelib.php
  73 * retrieves latest version of a page
  74 * @param entry the wiki object as a reference
  75 * @param pagename the name of the page known by the wiki engine
  76 * @param version
  77 */
  78 function wiki_get_latest_page(&$entry, $pagename, $version = 0) {
  79     $pagename = "'".addslashes($pagename)."'";
  80
  81     if ($version > 0 and is_int($version)) {
  82         $version = "AND (version=$version)";
  83     } else {
  84         $version = '';
  85     }
  86
  87     $select = "(pagename=$pagename) AND wiki=".$entry->id." $version ";
  88     $sort   = 'version DESC';
  89
  90     //change this to recordset_select, as per http://docs.moodle.org/en/Datalib_Notes
  91     if ($result_arr = get_records_select('wiki_pages', $select, $sort, '*', 0, 1)) {
  92         foreach ($result_arr as $obj) {
  93             $result_obj = $obj;
  94         }
  95     }
  96
  97     if (isset($result_obj))  {
  98         $result_obj->meta = @unserialize($result_obj->meta);
  99         return $result_obj;
 100     } else {
 101         return false;
 102     }
 103 } //wiki_get_latest_page
 104
 105 /**
 106 * fetches all pages, including old versions
 107 * @param entry the wiki object as a reference
 108 * @return an array of record objects that represents pages of this wiki object
 109 */
 110 function wiki_get_pages(&$entry) {
 111     return get_records('wiki_pages', 'wiki', $entry->id);
 112 } //wiki_get_pages
 113
 114 /**
 115 * fetches all the latest versions of all the pages
 116 *
 117 */
 118 function wiki_get_latest_pages(&$entry) {
 119   //== (My)SQL for this
 120   /* select * from wiki_pages
 121      inner join
 122     (select wiki_pages.pagename, max(wiki_pages.version) as ver
 123     from wiki_pages group by pagename) as a
 124     on ((wiki_pages.version = a.ver) and
 125     (wiki_pages.pagename like a.pagename)) */
 126
 127     $pages = array();
 128
 129     //http://moodle.org/bugs/bug.php?op=show&bugid=5877&pos=0
 130     if ($ids = get_records('wiki_pages', 'wiki', $entry->id, '', 'distinct pagename')) {
 131         if ($pagesets = get_records('wiki_pages', 'wiki', $entry->id, '', 'distinct pagename')) {
 132             foreach ($pagesets as $aPageset) {
 133                 $pages[] = wiki_get_latest_page($entry, $aPageset->id);
 134             }
 135         } else {
 136             return false;
 137         }
 138     }
 139     return $pages;
 140 } //wiki_get_latest_pages
 141
 142 /**
 143 * part of search engine API
 144 *
 145 */
 146 function wiki_iterator() {
 147     $wikis = get_records('wiki');
 148     return $wikis;
 149 } //wiki_iterator
 150
 151 /**
 152 * part of search engine API
 153 * @param wiki a wiki instance
 154 * @return an array of searchable deocuments
 155 */
 156 function wiki_get_content_for_index(&$wiki) {
 157
 158     $documents = array();
 159     $entries = wiki_get_entries($wiki);
 160     foreach($entries as $entry) {
 161         $coursemodule = get_field('modules', 'id', 'name', 'wiki');
 162         $cm = get_record('course_modules', 'course', $entry->course, 'module', $coursemodule, 'instance', $entry->wikiid);
 163         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 164
 165         //all pages
 166         //$pages = wiki_get_pages($entry);
 167
 168         //latest pages
 169         $pages = wiki_get_latest_pages($entry);
 170         if (is_array($pages)) {
 171             foreach($pages as $page) {
 172                 if (strlen($page->content) > 0) {
 173                     $documents[] = new WikiSearchDocument(get_object_vars($page), $entry->wikiid, $entry->course, $entry->groupid, $page->userid, $context->id);
 174                 }
 175             }
 176         }
 177     }
 178     return $documents;
 179 } //wiki_get_content_for_index
 180
 181 /**
 182 * returns a single wiki search document based on a wiki_entry id
 183 * @param id the id of the wiki
 184 * @param itemtype the type of information (standard)
 185 * @retuen a searchable document
 186 */
 187 function wiki_single_document($id, $itemtype) {
 188     $page = get_record('wiki_pages', 'id', $id);
 189     $entry = get_record('wiki_entries', 'id', $page->wiki);
 190     $coursemodule = get_field('modules', 'id', 'name', 'wiki');
 191     $cm = get_record('course_modules', 'course', $entry->course, 'module', $coursemodule, 'instance', $entry->wikiid);
 192     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 193     return new WikiSearchDocument(get_object_vars($page), $entry->wikiid, $entry->course, $entry->groupid, $page->userid, $context->id);
 194 } //wiki_single_document
 195
 196 /**
 197 * dummy delete function that packs id with itemtype.
 198 * this was here for a reason, but I can't remember it at the moment.
 199 *
 200 */
 201 function wiki_delete($info, $itemtype) {
 202     $object->id = $info;
 203     $object->itemtype = $itemtype;
 204     return $object;
 205 } //wiki_delete
 206
 207 //returns the var names needed to build a sql query for addition/deletions
 208 function wiki_db_names() {
 209     //[primary id], [table name], [time created field name], [time modified field name]
 210     return array(array('id', 'wiki_pages', 'created', 'lastmodified', 'standard'));
 211 } //wiki_db_names
 212
 213 /**
 214 * this function handles the access policy to contents indexed as searchable documents. If this
 215 * function does not exist, the search engine assumes access is allowed.
 216 * When this point is reached, we already know that :
 217 * - user is legitimate in the surrounding context
 218 * - user may be guest and guest access is allowed to the module
 219 * - the function may perform local checks within the module information logic
 220 * @param path the access path to the module script code
 221 * @param itemtype the information subclassing (usefull for complex modules, defaults to 'standard')
 222 * @param this_id the item id within the information class denoted by itemtype. In wikies, this id
 223 * points out the indexed wiki page.
 224 * @param user the user record denoting the user who searches
 225 * @param group_id the current group used by the user when searching
 226 * @return true if access is allowed, false elsewhere
 227 */
 228 function wiki_check_text_access($path, $itemtype, $this_id, $user, $group_id, $context_id){
 229     global $CFG;
 230
 231     // get the wiki object and all related stuff
 232     $page = get_record('wiki_pages', 'id', $id);
 233     $entry = get_record('wiki_entries', 'id', $page->wiki);
 234     $course = get_record('course', 'id', $entry->course);
 235     $module_context = get_record('context', 'id', $context_id);
 236     $cm = get_record('course_modules', 'id', $module_context->instance);
 237     if (!$cm->visible and !has_capability('moodle/course:viewhiddenactivities', $module_context)) return false;
 238
 239     //group consistency check : checks the following situations about groups
 240     // trap if user is not same group and groups are separated
 241     $current_group = get_current_group($course->id);
 242     if ((groupmode($course) == SEPARATEGROUPS) && $group_id != $current_group && !has_capability('moodle/site:accessallgroups', $module_context)) return false;
 243
 244     return true;
 245 } //wiki_check_text_access
 246 ?>