MDL-20067 new IMS Content package module, includes migrate from old mod/resource...
[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-imscp
22  * @copyright 2009 Petr Skoda (http://skodak.org)
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require_once("$CFG->dirroot/mod/imscp/lib.php");
27 require_once("$CFG->libdir/file/file_browser.php");
28 require_once("$CFG->libdir/filelib.php");
29 require_once("$CFG->libdir/resourcelib.php");
31 function imscp_print_content($imscp, $cm, $course) {
32     global $PAGE, $CFG;
34     $items = unserialize($imscp->structure);
35     $first = reset($items);
36     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
37     $urlbase = "$CFG->wwwroot/pluginfile.php";
38     $path = '/'.$context->id.'/imscp_content/'.$imscp->revision.'/'.$first['href'];
39     $firsturl = file_encode_url($urlbase, $path, false);
41     echo '<div id="imscp_layout">';
42     echo '<div id="imscp_toc">';
43     echo '<div id="imscp_tree"><ul>';
44     foreach ($items as $item) {
45         echo imscp_htmllize_item($item, $imscp, $cm);
46     }
47     echo '</ul></div></div>';
48     echo '</div>';
49     echo '<div id="imscp_navpanel"></div>';
51     echo $PAGE->requires->js_function_call('imscp_init')->now();
52     return;
53 }
55 /**
56  * Internal function - creates htmls structure suitable for YUI tree.
57  */
58 function imscp_htmllize_item($item, $imscp, $cm) {
59     global $CFG;
61     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
62     $urlbase = "$CFG->wwwroot/pluginfile.php";
63     $path = '/'.$context->id.'/imscp_content/'.$imscp->revision.'/'.$item['href'];
64     $url = file_encode_url($urlbase, $path, false);
65     $result = "<li><a href=\"$url\">".$item['title'].'</a>';
66     if ($item['subitems']) {
67         $result .= '<ul>';
68         foreach ($item['subitems'] as $subitem) {
69             $result .= imscp_htmllize_item($subitem, $imscp, $cm);
70         }
71         $result .= '</ul>';
72     }
73     $result .= '</li>';
75     return $result;
76 }
78 function imscp_parse_structure($imscp, $context) {
79     $fs = get_file_storage();
81     if (!$manifestfile = $fs->get_file($context->id, 'imscp_content', $imscp->revision, '/', 'imsmanifest.xml')) {
82         return null;
83     }
86     $doc = new DOMDocument();
87     if (!$doc->loadXML($manifestfile->get_content(), LIBXML_NONET)) {
88         return null;
89     }
91     // we put this fake URL as base in order to detect path changes caused by xml:base attributes
92     $doc->documentURI = 'http://grrr/';
94     $xmlorganizations = $doc->getElementsByTagName('organizations');
95     if (empty($xmlorganizations->length)) {
96         return null;
97     }
98     $default = null;
99     if ($xmlorganizations->item(0)->attributes->getNamedItem('default')) {
100         $default = $xmlorganizations->item(0)->attributes->getNamedItem('default')->nodeValue;
101     }
102     $xmlorganization = $doc->getElementsByTagName('organization');
103     if (empty($xmlorganization->length)) {
104         return null;
105     }
106     $organization = null;
107     foreach ($xmlorganization as $org) {
108         if (is_null($organization)) {
109             // use first if default nor found
110             $organization = $org;
111         }
112         if (!$org->attributes->getNamedItem('identifier')) {
113             continue;
114         }
115         if ($default === $org->attributes->getNamedItem('identifier')->nodeValue) {
116             // found default - use it
117             $organization = $org;
118             break;
119         }
120     }
122     // load all resources
123     $resources = array();
125     $xmlresources = $doc->getElementsByTagName('resource');
126     foreach ($xmlresources as $res) {
127         if (!$identifier = $res->attributes->getNamedItem('identifier')) {
128             continue;
129         }
130         $identifier = $identifier->nodeValue;
131         if ($xmlbase = $res->baseURI) {
132             // undo the fake URL, we are interested in relative links only
133             $xmlbase = str_replace('http://grrr/', '/', $xmlbase);
134             $xmlbase = rtrim($xmlbase, '/').'/';
135         } else {
136             $xmlbase = '';
137         }
138         if (!$href = $res->attributes->getNamedItem('href')) {
139             continue;
140         }
141         $href = $href->nodeValue;
142         if (strpos($href, 'http://') !== 0) {
143             $href = $xmlbase.$href;
144         }
145         // href cleanup - Some packages are poorly done and use \ in urls
146         $href = ltrim(strtr($href, "\\", '/'), '/');
147         $resources[$identifier] = $href;
148     }
150     $items = array();
151     foreach ($organization->childNodes as $child) {
152         if ($child->nodeName === 'item') {
153             if (!$item = imscp_recursive_item($child, 0, $resources)) {
154                 continue;
155             }
156             $items[] = $item;
157         }
158     }
160     return $items;
163 function imscp_recursive_item($xmlitem, $level, $resources) {
164     $identifierref = '';
165     if ($identifierref = $xmlitem->attributes->getNamedItem('identifierref')) {
166         $identifierref = $identifierref->nodeValue;
167     }
169     $title = '?';
170     $subitems = array();
172     foreach ($xmlitem->childNodes as $child) {
173         if ($child->nodeName === 'title') {
174             $title = $child->textContent;
176         } else if ($child->nodeName === 'item') {
177             if ($subitem = imscp_recursive_item($child, $level+1, $resources)) {
178                 $subitems[] = $subitem;
179             }
180         }
181     }
183     return array('href'     => isset($resources[$identifierref]) ? $resources[$identifierref] : '',
184                  'title'    => $title,
185                  'level'    => $level,
186                  'subitems' => $subitems,
187                 );
190 /**
191  * File browsing support class
192  */
193 class imscp_file_info extends file_info {
194     protected $course;
195     protected $cm;
196     protected $areas;
197     protected $filearea;
199     public function __construct($browser, $course, $cm, $context, $areas, $filearea) {
200         parent::__construct($browser, $context);
201         $this->course   = $course;
202         $this->cm       = $cm;
203         $this->areas    = $areas;
204         $this->filearea = $filearea;
205     }
207     /**
208      * Returns list of standard virtual file/directory identification.
209      * The difference from stored_file parameters is that null values
210      * are allowed in all fields
211      * @return array with keys contextid, filearea, itemid, filepath and filename
212      */
213     public function get_params() {
214         return array('contextid'=>$this->context->id,
215                      'filearea' =>$this->filearea,
216                      'itemid'   =>null,
217                      'filepath' =>null,
218                      'filename' =>null);
219     }
221     /**
222      * Returns localised visible name.
223      * @return string
224      */
225     public function get_visible_name() {
226         return $this->areas[$this->filearea];
227     }
229     /**
230      * Can I add new files or directories?
231      * @return bool
232      */
233     public function is_writable() {
234         return false;
235     }
237     /**
238      * Is directory?
239      * @return bool
240      */
241     public function is_directory() {
242         return true;
243     }
245     /**
246      * Returns list of children.
247      * @return array of file_info instances
248      */
249     public function get_children() {
250         global $DB;
252         $children = array();
253         $itemids = $DB->get_records('files', array('contextid'=>$this->context->id, 'filearea'=>$this->filearea), 'itemid', "DISTINCT itemid");
254         foreach ($itemids as $itemid=>$unused) {
255             if ($child = $this->browser->get_file_info($this->context, $this->filearea, $itemid)) {
256                 $children[] = $child;
257             }
258         }
259         return $children;
260     }
262     /**
263      * Returns parent file_info instance
264      * @return file_info or null for root
265      */
266     public function get_parent() {
267         return $this->browser->get_file_info($this->context);
268     }