e3eabc1c237fb94c03196fb834a9a60122cec6f6
[moodle.git] / repository / user / 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_user class is used to browse user private files
20  *
21  * @since 2.0
22  * @package moodlecore
23  * @subpackage repository
24  * @copyright 2010 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_user extends repository {
31     /**
32      * initialize user 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      * user plugin doesn't require login
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   = 0;
83             $filename = null;
84             $filearea = 'user_private';
85             $filepath = '/';
86             $context = get_context_instance(CONTEXT_USER, $USER->id);
87         }
89         try {
90             $browser = get_file_browser();
92             if ($fileinfo = $browser->get_file_info($context, $filearea, $itemid, $filepath, $filename)) {
93                 $pathnodes = array();
94                 $level = $fileinfo;
95                 $params = $fileinfo->get_params();
96                 while ($level && $params['filearea'] == 'user_private') {
97                     $encodedpath = base64_encode(serialize($level->get_params()));
98                     $pathnodes[] = array('name'=>$level->get_visible_name(), 'path'=>$encodedpath);
99                     $level = $level->get_parent();
100                     $params = $level->get_params();
101                 }
102                 $ret['path'] = array_reverse($pathnodes);
104                 // build file tree
105                 $children = $fileinfo->get_children();
106                 foreach ($children as $child) {
107                     if ($child->is_directory()) {
108                         $encodedpath = base64_encode(serialize($child->get_params()));
109                         $node = array(
110                             'title' => $child->get_visible_name(),
111                             'size' => 0,
112                             'date' => '',
113                             'path' => $encodedpath,
114                             'children'=>array(),
115                             'thumbnail' => $OUTPUT->pix_url('f/folder-32') . ''
116                         );
117                         $list[] = $node;
118                     } else {
119                         $encodedpath = base64_encode(serialize($child->get_params()));
120                         $icon = 'f/'.str_replace('.gif', '', mimeinfo('icon', $child->get_visible_name())).'-32';
121                         $node = array(
122                             'title' => $child->get_visible_name(),
123                             'size' => 0,
124                             'date' => '',
125                             'source'=> $encodedpath,
126                             'thumbnail' => $OUTPUT->pix_url($icon) . '',
127                         );
128                         $list[] = $node;
129                     }
130                 }
131             }
132         } catch (Exception $e) {
133             throw new repository_exception('emptyfilelist', 'repository_user');
134         }
135         $ret['list'] = $list;
136         $ret['list'] = array_filter($list, array($this, 'filter'));
137         return $ret;
138     }
140     /**
141      * Set repository name
142      *
143      * @return string repository name
144      */
145     public function get_name(){
146         return get_string('areauserpersonal', 'repository');;
147     }
149     /**
150      * User file don't support to link to external links
151      *
152      * @return int
153      */
154     public function supported_returntypes() {
155         return FILE_INTERNAL;
156     }
158     /**
159      * Copy a file to file area
160      *
161      * @global object $USER
162      * @global object $DB
163      * @param string $encoded The metainfo of file, it is base64 encoded php seriablized data
164      * @param string $new_filename The intended name of file
165      * @param string $new_itemid itemid
166      * @param string $new_filepath the new path in draft area
167      * @return array The information of file
168      */
169     public function copy_to_area($encoded, $new_filearea='user_draft', $new_itemid = '', $new_filepath = '/', $new_filename = '') {
170         global $USER, $DB;
171         $info = array();
173         $browser = get_file_browser();
174         $params = unserialize(base64_decode($encoded));
175         $user_context = get_context_instance(CONTEXT_USER, $USER->id);
176         // the final file
177         $contextid  = $params['contextid'];
178         $filearea   = $params['filearea'];
179         $filepath   = $params['filepath'];
180         $filename   = $params['filename'];
181         $fileitemid = $params['itemid'];
182         $context    = get_context_instance_by_id($contextid);
183         try {
184             $file_info = $browser->get_file_info($context, $filearea, $fileitemid, $filepath, $filename);
185             $file_info->copy_to_storage($user_context->id, $new_filearea, $new_itemid, $new_filepath, $new_filename);
186         } catch (Exception $e) {
187             throw $e;
188         }
190         $info['itemid'] = $new_itemid;
191         $info['title']  = $new_filename;
192         $info['contextid'] = $user_context->id;
193         $info['filesize'] = $file_info->get_filesize();
195         return $info;
196     }