d51ecf7a690c1b374065090cfa9f8c35e8198083
[moodle.git] / mod / imscp / locallib.php
1 <?php
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/>.
18 /**
19  * Private imscp module utility functions
20  *
21  * @package    mod
22  * @subpackage imscp
23  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once("$CFG->dirroot/mod/imscp/lib.php");
30 require_once("$CFG->libdir/filelib.php");
31 require_once("$CFG->libdir/resourcelib.php");
33 function imscp_print_content($imscp, $cm, $course) {
34     global $PAGE, $CFG;
36     $items = unserialize($imscp->structure);
37     $first = reset($items);
38     $context = context_module::instance($cm->id);
39     $urlbase = "$CFG->wwwroot/pluginfile.php";
40     $path = '/'.$context->id.'/mod_imscp/content/'.$imscp->revision.'/'.$first['href'];
41     $firsturl = file_encode_url($urlbase, $path, false);
43     echo '<div id="imscp_layout">';
44     echo '<div id="imscp_toc">';
45     echo '<div id="imscp_tree"><ul>';
46     foreach ($items as $item) {
47         echo imscp_htmllize_item($item, $imscp, $cm);
48     }
49     echo '</ul></div>';
50     echo '<div id="imscp_nav" style="display:none"><button id="nav_skipprev">&lt;&lt;</button><button id="nav_prev">&lt;</button><button id="nav_up">^</button><button id="nav_next">&gt;</button><button id="nav_skipnext">&gt;&gt;</button></div>';
51     echo '</div>';
52     echo '</div>';
54     $PAGE->requires->js_init_call('M.mod_imscp.init');
55     return;
56 }
58 /**
59  * Internal function - creates htmls structure suitable for YUI tree.
60  */
61 function imscp_htmllize_item($item, $imscp, $cm) {
62     global $CFG;
64     if (preg_match('|^https?://|', $item['href'])) {
65         $url = $item['href'];
66     } else {
67         $context = context_module::instance($cm->id);
68         $urlbase = "$CFG->wwwroot/pluginfile.php";
69         $path = '/'.$context->id.'/mod_imscp/content/'.$imscp->revision.'/'.$item['href'];
70         $url = file_encode_url($urlbase, $path, false);
71     }
72     $result = "<li><a href=\"$url\">".$item['title'].'</a>';
73     if ($item['subitems']) {
74         $result .= '<ul>';
75         foreach ($item['subitems'] as $subitem) {
76             $result .= imscp_htmllize_item($subitem, $imscp, $cm);
77         }
78         $result .= '</ul>';
79     }
80     $result .= '</li>';
82     return $result;
83 }
85 /**
86  * Parse an IMS content package's manifest file to determine its structure
87  * @param object $imscp
88  * @param object $context
89  * @return array
90  */
91 function imscp_parse_structure($imscp, $context) {
92     $fs = get_file_storage();
94     if (!$manifestfile = $fs->get_file($context->id, 'mod_imscp', 'content', $imscp->revision, '/', 'imsmanifest.xml')) {
95         return null;
96     }
98     return imscp_parse_manifestfile($manifestfile->get_content());
99 }
101 /**
102  * Parse the contents of a IMS package's manifest file
103  * @param string $manifestfilecontents the contents of the manifest file
104  * @return array
105  */
106 function imscp_parse_manifestfile($manifestfilecontents) {
107     $doc = new DOMDocument();
108     if (!$doc->loadXML($manifestfilecontents, LIBXML_NONET)) {
109         return null;
110     }
112     // we put this fake URL as base in order to detect path changes caused by xml:base attributes
113     $doc->documentURI = 'http://grrr/';
115     $xmlorganizations = $doc->getElementsByTagName('organizations');
116     if (empty($xmlorganizations->length)) {
117         return null;
118     }
119     $default = null;
120     if ($xmlorganizations->item(0)->attributes->getNamedItem('default')) {
121         $default = $xmlorganizations->item(0)->attributes->getNamedItem('default')->nodeValue;
122     }
123     $xmlorganization = $doc->getElementsByTagName('organization');
124     if (empty($xmlorganization->length)) {
125         return null;
126     }
127     $organization = null;
128     foreach ($xmlorganization as $org) {
129         if (is_null($organization)) {
130             // use first if default nor found
131             $organization = $org;
132         }
133         if (!$org->attributes->getNamedItem('identifier')) {
134             continue;
135         }
136         if ($default === $org->attributes->getNamedItem('identifier')->nodeValue) {
137             // found default - use it
138             $organization = $org;
139             break;
140         }
141     }
143     // load all resources
144     $resources = array();
146     $xmlresources = $doc->getElementsByTagName('resource');
147     foreach ($xmlresources as $res) {
148         if (!$identifier = $res->attributes->getNamedItem('identifier')) {
149             continue;
150         }
151         $identifier = $identifier->nodeValue;
152         if ($xmlbase = $res->baseURI) {
153             // undo the fake URL, we are interested in relative links only
154             $xmlbase = str_replace('http://grrr/', '/', $xmlbase);
155             $xmlbase = rtrim($xmlbase, '/').'/';
156         } else {
157             $xmlbase = '';
158         }
159         if (!$href = $res->attributes->getNamedItem('href')) {
160             // If href not found look for <file href="help.htm"/>
161             $fileresources = $res->getElementsByTagName('file');
162             foreach ($fileresources as $file) {
163                 $href = $file->getAttribute('href');
164             }
165             if (empty($href)) {
166                 continue;
167             }
168         } else {
169             $href = $href->nodeValue;
170         }
171         if (strpos($href, 'http://') !== 0) {
172             $href = $xmlbase.$href;
173         }
174         // href cleanup - Some packages are poorly done and use \ in urls
175         $href = ltrim(strtr($href, "\\", '/'), '/');
176         $resources[$identifier] = $href;
177     }
179     $items = array();
180     foreach ($organization->childNodes as $child) {
181         if ($child->nodeName === 'item') {
182             if (!$item = imscp_recursive_item($child, 0, $resources)) {
183                 continue;
184             }
185             $items[] = $item;
186         }
187     }
189     return $items;
192 function imscp_recursive_item($xmlitem, $level, $resources) {
193     $identifierref = '';
194     if ($identifierref = $xmlitem->attributes->getNamedItem('identifierref')) {
195         $identifierref = $identifierref->nodeValue;
196     }
198     $title = '?';
199     $subitems = array();
201     foreach ($xmlitem->childNodes as $child) {
202         if ($child->nodeName === 'title') {
203             $title = $child->textContent;
205         } else if ($child->nodeName === 'item') {
206             if ($subitem = imscp_recursive_item($child, $level+1, $resources)) {
207                 $subitems[] = $subitem;
208             }
209         }
210     }
212     return array('href'     => isset($resources[$identifierref]) ? $resources[$identifierref] : '',
213                  'title'    => $title,
214                  'level'    => $level,
215                  'subitems' => $subitems,
216                 );
219 /**
220  * File browsing support class
221  */
222 class imscp_file_info extends file_info {
223     protected $course;
224     protected $cm;
225     protected $areas;
226     protected $filearea;
228     public function __construct($browser, $course, $cm, $context, $areas, $filearea) {
229         parent::__construct($browser, $context);
230         $this->course   = $course;
231         $this->cm       = $cm;
232         $this->areas    = $areas;
233         $this->filearea = $filearea;
234     }
236     /**
237      * Returns list of standard virtual file/directory identification.
238      * The difference from stored_file parameters is that null values
239      * are allowed in all fields
240      * @return array with keys contextid, filearea, itemid, filepath and filename
241      */
242     public function get_params() {
243         return array('contextid'=>$this->context->id,
244                      'component'=>'mod_imscp',
245                      'filearea' =>$this->filearea,
246                      'itemid'   =>null,
247                      'filepath' =>null,
248                      'filename' =>null);
249     }
251     /**
252      * Returns localised visible name.
253      * @return string
254      */
255     public function get_visible_name() {
256         return $this->areas[$this->filearea];
257     }
259     /**
260      * Can I add new files or directories?
261      * @return bool
262      */
263     public function is_writable() {
264         return false;
265     }
267     /**
268      * Is directory?
269      * @return bool
270      */
271     public function is_directory() {
272         return true;
273     }
275     /**
276      * Returns list of children.
277      * @return array of file_info instances
278      */
279     public function get_children() {
280         return $this->get_filtered_children('*', false, true);
281     }
283     /**
284      * Help function to return files matching extensions or their count
285      *
286      * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
287      * @param bool|int $countonly if false returns the children, if an int returns just the
288      *    count of children but stops counting when $countonly number of children is reached
289      * @param bool $returnemptyfolders if true returns items that don't have matching files inside
290      * @return array|int array of file_info instances or the count
291      */
292     private function get_filtered_children($extensions = '*', $countonly = false, $returnemptyfolders = false) {
293         global $DB;
294         $params = array('contextid' => $this->context->id,
295             'component' => 'mod_imscp',
296             'filearea' => $this->filearea);
297         $sql = 'SELECT DISTINCT itemid
298                     FROM {files}
299                     WHERE contextid = :contextid
300                     AND component = :component
301                     AND filearea = :filearea';
302         if (!$returnemptyfolders) {
303             $sql .= ' AND filename <> :emptyfilename';
304             $params['emptyfilename'] = '.';
305         }
306         list($sql2, $params2) = $this->build_search_files_sql($extensions);
307         $sql .= ' '.$sql2;
308         $params = array_merge($params, $params2);
309         if ($countonly !== false) {
310             $sql .= ' ORDER BY itemid';
311         }
313         $rs = $DB->get_recordset_sql($sql, $params);
314         $children = array();
315         foreach ($rs as $record) {
316             if ($child = $this->browser->get_file_info($this->context, 'mod_imscp', $this->filearea, $record->itemid)) {
317                 $children[] = $child;
318                 if ($countonly !== false && count($children) >= $countonly) {
319                     break;
320                 }
321             }
322         }
323         $rs->close();
324         if ($countonly !== false) {
325             return count($children);
326         }
327         return $children;
328     }
330     /**
331      * Returns list of children which are either files matching the specified extensions
332      * or folders that contain at least one such file.
333      *
334      * @param string|array $extensions, either '*' or array of lowercase extensions, i.e. array('.gif','.jpg')
335      * @return array of file_info instances
336      */
337     public function get_non_empty_children($extensions = '*') {
338         return $this->get_filtered_children($extensions, false);
339     }
341     /**
342      * Returns the number of children which are either files matching the specified extensions
343      * or folders containing at least one such file.
344      *
345      * @param string|array $extensions, for example '*' or array('.gif','.jpg')
346      * @param int $limit stop counting after at least $limit non-empty children are found
347      * @return int
348      */
349     public function count_non_empty_children($extensions = '*', $limit = 1) {
350         return $this->get_filtered_children($extensions, $limit);
351     }
353     /**
354      * Returns parent file_info instance
355      * @return file_info or null for root
356      */
357     public function get_parent() {
358         return $this->browser->get_file_info($this->context);
359     }