"MDL-13766, fixed context default value"
[moodle.git] / repository / local / repository.class.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  * repository_local class is used to browse moodle files
20  *
21  * @since 2.0
22  * @package moodlecore
23  * @subpackage repository
24  * @copyright 2009 Dongsheng Cai
25  * @author Dongsheng Cai <dongsheng@moodle.com>
26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 class repository_local extends repository {
31     /**
32      * initialize local plugin
33      * @param int $repositoryid
34      * @param int $context
35      * @param array $options
36      */
37     public function __construct($repositoryid, $context = SYSCONTEXTID, $options = array()) {
38         parent::__construct($repositoryid, $context, $options);
39     }
41     /**
42      * local plugin don't need login, so list all files
43      * @return mixed
44      */
45     public function print_login() {
46         return $this->get_listing();
47     }
49     /**
50      * Not supported by File API yet
51      * @param string $search_text
52      * @return mixed
53      */
54     public function search($search_text) {
55         return array();
56     }
58     /**
59      * Get file listing
60      *
61      * @param string $encodedpath
62      * @param string $path not used by this plugin
63      * @return mixed
64      */
65     public function get_listing($encodedpath = '', $page = '') {
66         global $CFG, $USER, $OUTPUT;
67         $ret = array();
68         $ret['dynload'] = true;
69         $ret['nosearch'] = true;
70         $list = array();
72         if (!empty($encodedpath)) {
73             $params = unserialize(base64_decode($encodedpath));
74             if (is_array($params)) {
75                 $itemid   = $params['itemid'];
76                 $filename = $params['filename'];
77                 $filearea = $params['filearea'];
78                 $filepath = $params['filepath'];
79                 $context  = get_context_instance_by_id($params['contextid']);
80             }
81         } else {
82             $itemid   = null;
83             $filename = null;
84             $filearea = null;
85             $filepath = null;
86             $context  = get_system_context();
87         }
89         try {
90             $browser = get_file_browser();
92             if ($fileinfo = $browser->get_file_info($context, $filearea, $itemid, $filepath, $filename)) {
93                 $level = $fileinfo->get_parent();
94                 while ($level) {
95                     $params = base64_encode(serialize($level->get_params()));
96                     $path[] = array('name'=>$level->get_visible_name(), 'path'=>$params);
97                     $level = $level->get_parent();
98                 }
99                 if (!empty($path) && is_array($path)) {
100                     $path = array_reverse($path);
101                     $ret['path'] = $path;
102                 }
103                 $children = $fileinfo->get_children();
104                 foreach ($children as $child) {
105                     if ($child->is_directory()) {
106                         $params = base64_encode(serialize($child->get_params()));
107                         $node = array(
108                             'title' => $child->get_visible_name(),
109                             'size' => 0,
110                             'date' => '',
111                             'path' => $params,
112                             'children'=>array(),
113                             'thumbnail' => $OUTPUT->pix_url('f/folder-32') . ''
114                         );
115                         $list[] = $node;
116                     } else {
117                         $params = base64_encode(serialize($child->get_params()));
118                         $icon = 'f/'.str_replace('.gif', '', mimeinfo('icon', $child->get_visible_name())).'-32';
119                         $node = array(
120                             'title' => $child->get_visible_name(),
121                             'size' => 0,
122                             'date' => '',
123                             'source'=> $params,
124                             'thumbnail' => $OUTPUT->pix_url($icon),
125                         );
126                         $list[] = $node;
127                     }
128                 }
129             }
130         } catch (Exception $e) {
131             throw new repository_exception('emptyfilelist', 'repository_local');
132         }
133         $ret['list'] = $list;
134         return $ret;
135     }
137      /**
138      * Move a file to draft area
139      *
140      * @global object $USER
141      * @global object $DB
142      * @param string $encoded The metainfo of file, it is base64 encoded php seriablized data
143      * @param string $title The intended name of file
144      * @param string $itemid itemid
145      * @param string $save_path the new path in draft area
146      * @return array The information of file
147      */
148     public function move_to_draft($encoded, $title = '', $itemid = '', $save_path = '/') {
149         global $USER, $DB;
150         $ret = array();
152         $browser = get_file_browser();
153         $params = unserialize(base64_decode($encoded));
154         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
155         // the final file
156         $contextid  = $params['contextid'];
157         $filearea   = $params['filearea'];
158         $filepath   = $params['filepath'];
159         $filename   = $params['filename'];
160         $fileitemid = $params['itemid'];
161         $context    = get_context_instance_by_id($contextid);
162         $file_info = $browser->get_file_info($context, $filearea, $fileitemid, $filepath, $filename);
163         $file_info->copy_to_storage($user_context->id, 'user_draft', $itemid, $save_path, $title);
165         $ret['itemid'] = $itemid;
166         $ret['title']  = $title;
167         $ret['contextid'] = $user_context->id;
168         $ret['filesize'] = $file_info->get_filesize();
170         return $ret;
171     }
173     /**
174      * Set repository name
175      *
176      * @return string repository name
177      */
178     public function get_name(){
179         return get_string('repositoryname', 'repository_local');;
180     }
182     /**
183      * Local file don't support to link to external links
184      *
185      * @return int
186      */
187     public function supported_returntypes() {
188         return FILE_INTERNAL;
189     }