ca06fdf9f12e2851be782fd30786346a8da611dc
[moodle.git] / repository / local / lib.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 doesn't require 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      * @return mixed
63      */
64     public function get_listing($encodedpath = '') {
65         global $CFG, $USER, $OUTPUT;
66         $ret = array();
67         $ret['dynload'] = true;
68         $ret['nosearch'] = true;
69         $ret['nologin'] = 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                 // build path navigation
94                 $pathnodes = array();
95                 $encodedpath = base64_encode(serialize($fileinfo->get_params()));
96                 $pathnodes[] = array('name'=>$fileinfo->get_visible_name(), 'path'=>$encodedpath);
97                 $level = $fileinfo->get_parent();
98                 while ($level) {
99                     $encodedpath = base64_encode(serialize($level->get_params()));
100                     $pathnodes[] = array('name'=>$level->get_visible_name(), 'path'=>$encodedpath);
101                     $level = $level->get_parent();
102                 }
103                 if (!empty($pathnodes) && is_array($pathnodes)) {
104                     $pathnodes = array_reverse($pathnodes);
105                     $ret['path'] = $pathnodes;
106                 }
107                 // build file tree
108                 $children = $fileinfo->get_children();
109                 foreach ($children as $child) {
110                     $shorttitle = $this->get_short_filename($child->get_visible_name(), 12);
111                     if ($child->is_directory()) {
112                         $params = $child->get_params();
113                         $subdir_children = $child->get_children();
114                         if (empty($subdir_children)) {
115                             continue;
116                         }
117                         $encodedpath = base64_encode(serialize($params));
118                         // hide user_private area from local plugin, user should
119                         // use private file plugin to access private files
120                         if ($params['filearea'] == 'user_private') {
121                             continue;
122                         }
123                         $node = array(
124                             'title' => $child->get_visible_name(),
125                             'shorttitle'=>$shorttitle,
126                             'size' => 0,
127                             'date' => '',
128                             'path' => $encodedpath,
129                             'children'=>array(),
130                             'thumbnail' => $OUTPUT->pix_url('f/folder-32') . ''
131                         );
132                         $list[] = $node;
133                     } else {
134                         $encodedpath = base64_encode(serialize($child->get_params()));
135                         $icon = 'f/'.str_replace('.gif', '', mimeinfo('icon', $child->get_visible_name())).'-32';
136                         $node = array(
137                             'title' => $child->get_visible_name(),
138                             'shorttitle'=>$shorttitle,
139                             'size' => 0,
140                             'date' => '',
141                             'source'=> $encodedpath,
142                             'thumbnail' => $OUTPUT->pix_url($icon) . '',
143                         );
144                         $list[] = $node;
145                     }
146                 }
147             }
148         } catch (Exception $e) {
149             throw new repository_exception('emptyfilelist', 'repository_local');
150         }
151         $ret['list'] = $list;
152         $ret['list'] = array_filter($list, array($this, 'filter'));
153         return $ret;
154     }
156     /**
157      * Set repository name
158      *
159      * @return string repository name
160      */
161     public function get_name(){
162         return get_string('pluginname', 'repository_local');;
163     }
165     /**
166      * Local file don't support to link to external links
167      *
168      * @return int
169      */
170     public function supported_returntypes() {
171         return FILE_INTERNAL;
172     }
174     /**
175      * Copy a file to file area
176      *
177      * @global object $USER
178      * @global object $DB
179      * @param string $encoded The metainfo of file, it is base64 encoded php seriablized data
180      * @param string $new_filename The intended name of file
181      * @param string $new_itemid itemid
182      * @param string $new_filepath the new path in draft area
183      * @return array The information of file
184      */
185     public function copy_to_area($encoded, $new_filearea='user_draft', $new_itemid = '', $new_filepath = '/', $new_filename = '') {
186         global $USER, $DB;
187         $info = array();
189         $browser = get_file_browser();
190         $params = unserialize(base64_decode($encoded));
191         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
192         // the final file
193         $contextid  = $params['contextid'];
194         $filearea   = $params['filearea'];
195         $filepath   = $params['filepath'];
196         $filename   = $params['filename'];
197         $fileitemid = $params['itemid'];
198         $context    = get_context_instance_by_id($contextid);
199         try {
200             $file_info = $browser->get_file_info($context, $filearea, $fileitemid, $filepath, $filename);
201             $file_info->copy_to_storage($user_context->id, $new_filearea, $new_itemid, $new_filepath, $new_filename);
202         } catch (Exception $e) {
203             throw $e;
204         }
206         $info['itemid'] = $new_itemid;
207         $info['title']  = $new_filename;
208         $info['contextid'] = $user_context->id;
209         $info['filesize'] = $file_info->get_filesize();
211         return $info;
212     }