e7f2ed0fe4ea54a1653c587cb4bcacdfb09aabf5
[moodle.git] / admin / uploadpicture.php
1 <?php
3 ///////////////////////////////////////////////////////////////////////////
4 //                                                                       //
5 // Copyright (C) 2007 Inaki Arenaza                                      //
6 //                                                                       //
7 // Based on .../admin/uploaduser.php and .../lib/gdlib.php               //
8 //                                                                       //
9 // This program is free software; you can redistribute it and/or modify  //
10 // it under the terms of the GNU General Public License as published by  //
11 // the Free Software Foundation; either version 2 of the License, or     //
12 // (at your option) any later version.                                   //
13 //                                                                       //
14 // This program is distributed in the hope that it will be useful,       //
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
17 // GNU General Public License for more details:                          //
18 //                                                                       //
19 //          http://www.gnu.org/copyleft/gpl.html                         //
20 //                                                                       //
21 ///////////////////////////////////////////////////////////////////////////
23 require_once('../config.php');
24 require_once($CFG->libdir.'/adminlib.php');
25 require_once($CFG->libdir.'/gdlib.php');
26 require_once('uploadpicture_form.php');
28 define ('PIX_FILE_UPDATED', 0);
29 define ('PIX_FILE_ERROR',   1);
30 define ('PIX_FILE_SKIPPED', 2);
32 admin_externalpage_setup('uploadpictures');
34 require_login();
36 require_capability('moodle/site:uploadusers', get_context_instance(CONTEXT_SYSTEM));
38 $site = get_site();
40 if (!$adminuser = get_admin()) {
41     print_error('noadmins', 'error');
42 }
44 $strfile = get_string('file');
45 $struser = get_string('user');
46 $strusersupdated = get_string('usersupdated', 'admin');
47 $struploadpictures = get_string('uploadpictures','admin');
49 $userfields = array (
50     0 => 'username',
51     1 => 'idnumber',
52     2 => 'id' );
54 $userfield = optional_param('userfield', 0, PARAM_INT);
55 $overwritepicture = optional_param('overwritepicture', 0, PARAM_BOOL);
57 /// Print the header
58 echo $OUTPUT->header();
60 echo $OUTPUT->heading_with_help($struploadpictures, 'uploadpictures', 'admin');
62 $mform = new admin_uploadpicture_form(null, $userfields);
63 if ($formdata = $mform->get_data()) {
64     if (!array_key_exists($userfield, $userfields)) {
65         echo $OUTPUT->notification(get_string('uploadpicture_baduserfield','admin'));
66     } else {
67         // Large files are likely to take their time and memory. Let PHP know
68         // that we'll take longer, and that the process should be recycled soon
69         // to free up memory.
70         @set_time_limit(0);
71         @raise_memory_limit("192M");
72         if (function_exists('apache_child_terminate')) {
73             @apache_child_terminate();
74         }
76         // Create a unique temporary directory, to process the zip file
77         // contents.
78         $zipdir = my_mktempdir($CFG->dataroot.'/temp/', 'usrpic');
79         $dstfile = $zipdir.'/images.zip';
81         if (!$mform->save_file('userpicturesfile', $dstfile, true)) {
82             echo $OUTPUT->notification(get_string('uploadpicture_cannotmovezip','admin'));
83             @remove_dir($zipdir);
84         } else {
85             $fp = get_file_packer('application/zip');
86             $unzipresult = $fp->extract_to_pathname($dstfile, $zipdir);
87             if (!$unzipresult) {
88                 echo $OUTPUT->notification(get_string('uploadpicture_cannotunzip','admin'));
89                 @remove_dir($zipdir);
90             } else {
91                 // We don't need the zip file any longer, so delete it to make
92                 // it easier to process the rest of the files inside the directory.
93                 @unlink($dstfile);
95                 $results = array ('errors' => 0,'updated' => 0);
97                 process_directory($zipdir, $userfields[$userfield], $overwritepicture, $results);
100                 // Finally remove the temporary directory with all the user images and print some stats.
101                 remove_dir($zipdir);
102                 echo $OUTPUT->notification(get_string('usersupdated', 'admin') . ": " . $results['updated']);
103                 echo $OUTPUT->notification(get_string('errors', 'admin') . ": " . $results['errors']);
104                 echo '<hr />';
105             }
106         }
107     }
109 $mform->display();
110 echo $OUTPUT->footer();
111 exit;
113 // ----------- Internal functions ----------------
115 /**
116  * Create a unique temporary directory with a given prefix name,
117  * inside a given directory, with given permissions. Return the
118  * full path to the newly created temp directory.
119  *
120  * @param string $dir where to create the temp directory.
121  * @param string $prefix prefix for the temp directory name (default '')
122  *
123  * @return string The full path to the temp directory.
124  */
125 function my_mktempdir($dir, $prefix='') {
126     global $CFG;
128     if (substr($dir, -1) != '/') {
129         $dir .= '/';
130     }
132     do {
133         $path = $dir.$prefix.mt_rand(0, 9999999);
134     } while (file_exists($path));
136     check_dir_exists($path);
138     return $path;
141 /**
142  * Recursively process a directory, picking regular files and feeding
143  * them to process_file().
144  *
145  * @param string $dir the full path of the directory to process
146  * @param string $userfield the prefix_user table field to use to
147  *               match picture files to users.
148  * @param bool $overwrite overwrite existing picture or not.
149  * @param array $results (by reference) accumulated statistics of
150  *              users updated and errors.
151  *
152  * @return nothing
153  */
154 function process_directory ($dir, $userfield, $overwrite, &$results) {
155     global $OUTPUT;
156     if(!($handle = opendir($dir))) {
157         echo $OUTPUT->notification(get_string('uploadpicture_cannotprocessdir','admin'));
158         return;
159     }
161     while (false !== ($item = readdir($handle))) {
162         if ($item != '.' && $item != '..') {
163             if (is_dir($dir.'/'.$item)) {
164                 process_directory($dir.'/'.$item, $userfield, $overwrite, $results);
165             } else if (is_file($dir.'/'.$item))  {
166                 $result = process_file($dir.'/'.$item, $userfield, $overwrite);
167                 switch ($result) {
168                     case PIX_FILE_ERROR:
169                         $results['errors']++;
170                         break;
171                     case PIX_FILE_UPDATED:
172                         $results['updated']++;
173                         break;
174                 }
175             }
176             // Ignore anything else that is not a directory or a file (e.g.,
177             // symbolic links, sockets, pipes, etc.)
178         }
179     }
180     closedir($handle);
183 /**
184  * Given the full path of a file, try to find the user the file
185  * corresponds to and assign him/her this file as his/her picture.
186  * Make extensive checks to make sure we don't open any security holes
187  * and report back any success/error.
188  *
189  * @param string $file the full path of the file to process
190  * @param string $userfield the prefix_user table field to use to
191  *               match picture files to users.
192  * @param bool $overwrite overwrite existing picture or not.
193  *
194  * @return integer either PIX_FILE_UPDATED, PIX_FILE_ERROR or
195  *                  PIX_FILE_SKIPPED
196  */
197 function process_file ($file, $userfield, $overwrite) {
198     global $DB, $OUTPUT;
200     // Add additional checks on the filenames, as they are user
201     // controlled and we don't want to open any security holes.
202     $path_parts = pathinfo(cleardoubleslashes($file));
203     $basename  = $path_parts['basename'];
204     $extension = $path_parts['extension'];
206     // The picture file name (without extension) must match the
207     // userfield attribute.
208     $uservalue = substr($basename, 0,
209                         strlen($basename) -
210                         strlen($extension) - 1);
212     // userfield names are safe, so don't quote them.
213     if (!($user = $DB->get_record('user', array ($userfield => $uservalue, 'deleted' => 0)))) {
214         $a = new stdClass();
215         $a->userfield = clean_param($userfield, PARAM_CLEANHTML);
216         $a->uservalue = clean_param($uservalue, PARAM_CLEANHTML);
217         echo $OUTPUT->notification(get_string('uploadpicture_usernotfound', 'admin', $a));
218         return PIX_FILE_ERROR;
219     }
221     $haspicture = $DB->get_field('user', 'picture', array('id'=>$user->id));
222     if ($haspicture && !$overwrite) {
223         echo $OUTPUT->notification(get_string('uploadpicture_userskipped', 'admin', $user->username));
224         return PIX_FILE_SKIPPED;
225     }
227     if (my_save_profile_image($user->id, $file)) {
228         $DB->set_field('user', 'picture', 1, array('id'=>$user->id));
229         echo $OUTPUT->notification(get_string('uploadpicture_userupdated', 'admin', $user->username));
230         return PIX_FILE_UPDATED;
231     } else {
232         echo $OUTPUT->notification(get_string('uploadpicture_cannotsave', 'admin', $user->username));
233         return PIX_FILE_ERROR;
234     }
237 /**
238  * Try to save the given file (specified by its full path) as the
239  * picture for the user with the given id.
240  *
241  * @param integer $id the internal id of the user to assign the
242  *                picture file to.
243  * @param string $originalfile the full path of the picture file.
244  *
245  * @return bool
246  */
247 function my_save_profile_image($id, $originalfile) {
248     $context = get_context_instance(CONTEXT_USER, $id);
249     return process_new_icon($context, 'user', 'icon', 0, $originalfile);