Automatically generated installer lang files
[moodle.git] / portfolio / boxnet / lib.php
CommitLineData
b3abd2c6 1<?php
f675815e 2require_once($CFG->libdir.'/portfolio/plugin.php');
67a87e7d 3require_once($CFG->libdir.'/filelib.php');
615a2859 4require_once($CFG->libdir.'/boxlib.php');
67a87e7d 5
d96a1acc 6class portfolio_plugin_boxnet extends portfolio_plugin_push_base {
67a87e7d 7
7e95408b 8 public $boxclient;
67a87e7d 9 private $ticket;
10 private $authtoken;
67a87e7d 11 private $folders;
a226b58d 12 private $accounttree;
67a87e7d 13
0f71f48b 14 public static function get_name() {
15 return get_string('pluginname', 'portfolio_boxnet');
16 }
17
d67bfc32 18 public function prepare_package() {
13e7e765 19 // don't do anything for this plugin, we want to send all files as they are.
20 }
21
22 public function send_package() {
53aa4841 23 // if we need to create the folder, do it now
24 if ($newfolder = $this->get_export_config('newfolder')) {
5d37f13c 25 if (!$created = $this->boxclient->createFolder($newfolder, array('share' => (int)$this->get_export_config('sharefolder')))) {
53aa4841 26 throw new portfolio_plugin_exception('foldercreatefailed', 'portfolio_boxnet');
27 }
2e6a355d 28 $this->folders[$created['folder_id']] = $created['folder_name'];
53aa4841 29 $this->set_export_config(array('folder' => $created['folder_id']));
30 }
d67bfc32 31 foreach ($this->exporter->get_tempfiles() as $file) {
32 $return = $this->boxclient->uploadFile(
67a87e7d 33 array(
34 'file' => $file,
53aa4841 35 'folder_id' => $this->get_export_config('folder'),
fd64f098 36 'share' => $this->get_export_config('sharefile'),
67a87e7d 37 )
38 );
d67bfc32 39 if (array_key_exists('status', $return) && $return['status'] == 'upload_ok'
3e164872
FM
40 && array_key_exists('id', $return) && count($return['id']) == 1) {
41 $returnid = array_keys($return['id']);
42 $this->rename_file($return['id'][array_pop($returnid)], $file->get_filename());
37f03ea0 43 // if this fails, the file was sent but not renamed - this triggers a warning but is not fatal.
d67bfc32 44 }
67a87e7d 45 }
46 if ($this->boxclient->isError()) {
37f03ea0 47 throw new portfolio_plugin_exception('sendfailed', 'portfolio_boxnet', $this->boxclient->getErrorMsg());
67a87e7d 48 }
67a87e7d 49 }
50
67a87e7d 51 public function get_export_summary() {
52 $allfolders = $this->get_folder_list();
53aa4841 53 if ($newfolder = $this->get_export_config('newfolder')) {
54 $foldername = $newfolder . ' (' . get_string('tobecreated', 'portfolio_boxnet') . ')';
447192d3 55 } elseif ($this->get_export_config('folder')) {
53aa4841 56 $foldername = $allfolders[$this->get_export_config('folder')];
447192d3 57 } else {
58 $foldername = '';
53aa4841 59 }
67a87e7d 60 return array(
53aa4841 61 get_string('targetfolder', 'portfolio_boxnet') => $foldername
67a87e7d 62 );
63 }
64
5d0dbf13 65 public function get_interactive_continue_url() {
67a87e7d 66 return 'http://box.net/files#0:f:' . $this->get_export_config('folder');
67 }
68
69 public function expected_time($callertime) {
70 return $callertime;
71 }
72
73 public static function has_admin_config() {
74 return true;
75 }
76
77 public static function get_allowed_config() {
78 return array('apikey');
79 }
80
81 public function has_export_config() {
82 return true;
83 }
84
85 public function get_allowed_user_config() {
86 return array('authtoken', 'authtokenctime');
87 }
88
89 public function get_allowed_export_config() {
fd64f098 90 return array('folder', 'newfolder', 'sharefile', 'sharefolder');
67a87e7d 91 }
92
93 public function export_config_form(&$mform) {
94 $folders = $this->get_folder_list();
fd64f098 95 $mform->addElement('checkbox', 'plugin_sharefile', get_string('sharefile', 'portfolio_boxnet'));
67a87e7d 96 $mform->addElement('text', 'plugin_newfolder', get_string('newfolder', 'portfolio_boxnet'));
fd64f098 97 $mform->addElement('checkbox', 'plugin_sharefolder', get_string('sharefolder', 'portfolio_boxnet'));
447192d3 98 $folders[0] = '----';
99 ksort($folders);
100 $mform->addElement('select', 'plugin_folder', get_string('existingfolder', 'portfolio_boxnet'), $folders);
67a87e7d 101 }
102
caee6e6c 103 public function export_config_validation(array $data) {
67a87e7d 104 $allfolders = $this->get_folder_list();
105 if (in_array($data['plugin_newfolder'], $allfolders)) {
106 return array('plugin_newfolder' => get_string('folderclash', 'portfolio_boxnet'));
107 }
108 }
109
c17ec774 110 public static function admin_config_form(&$mform) {
89e12bd5 111 global $CFG;
ff347f99 112
eefb011d
DM
113 $mform->addElement('text', 'apikey', get_string('apikey', 'portfolio_boxnet'));
114 $mform->addRule('apikey', get_string('required'), 'required', null, 'client');
115 $a = new stdClass();
116 $a->servicesurl = 'http://www.box.net/developers/services';
117 $a->callbackurl = $CFG->wwwroot . '/portfolio/add.php?postcontrol=1&type=boxnet';
118 $mform->addElement('static', 'setupinfo', get_string('setupinfo', 'portfolio_boxnet'),
119 get_string('setupinfodetails', 'portfolio_boxnet', $a));
67a87e7d 120 }
121
122 public function steal_control($stage) {
123 if ($stage != PORTFOLIO_STAGE_CONFIG) {
124 return false;
125 }
126 if ($this->authtoken) {
127 return false;
128 }
129 if (!$this->ensure_ticket()) {
34035201 130 throw new portfolio_plugin_exception('noticket', 'portfolio_boxnet');
67a87e7d 131 }
132 $token = $this->get_user_config('authtoken', $this->get('user')->id);
133 $ctime= $this->get_user_config('authtokenctime', $this->get('user')->id);
134 if (!empty($token) && (($ctime + 60*60*20) > time())) {
135 $this->authtoken = $token;
136 $this->boxclient->auth_token = $token;
137 return false;
138 }
139 return 'http://www.box.net/api/1.0/auth/'.$this->ticket;
140 }
141
142 public function post_control($stage, $params) {
143 if ($stage != PORTFOLIO_STAGE_CONFIG) {
144 return;
145 }
146 if (!array_key_exists('auth_token', $params) || empty($params['auth_token'])) {
34035201 147 throw new portfolio_plugin_exception('noauthtoken', 'portfolio_boxnet');
67a87e7d 148 }
149 $this->authtoken = $params['auth_token'];
150 $this->boxclient->auth_token = $this->authtoken;
151 $this->set_user_config(array('authtoken' => $this->authtoken, 'authtokenctime' => time()), $this->get('user')->id);
152 }
153
154 private function ensure_ticket() {
155 if (!empty($this->boxclient)) {
156 return true;
157 }
158 $this->boxclient = new boxclient($this->get_config('apikey'), '');
159 $ticket_return = $this->boxclient->getTicket();
160 if ($this->boxclient->isError() || empty($ticket_return)) {
34035201 161 throw new portfolio_plugin_exception('noticket', 'portfolio_boxnet');
67a87e7d 162 }
163 $this->ticket = $ticket_return['ticket'];
8801ab06 164 return $this->ticket;
67a87e7d 165 }
166
a226b58d 167 private function ensure_account_tree() {
168 if (!empty($this->accounttree)) {
169 return;
67a87e7d 170 }
171 if (empty($this->ticket)
172 || empty($this->authtoken)
173 || empty($this->boxclient)) {
174 // if we don't have these we're pretty much screwed
34035201 175 throw new portfolio_plugin_exception('folderlistfailed', 'portfolio_boxnet');
67a87e7d 176 return false;
177 }
a226b58d 178 $this->accounttree = $this->boxclient->getAccountTree();
67a87e7d 179 if ($this->boxclient->isError()) {
34035201 180 throw new portfolio_plugin_exception('folderlistfailed', 'portfolio_boxnet');
67a87e7d 181 }
a226b58d 182 if (!is_array($this->accounttree)) {
67a87e7d 183 return false;
184 }
a226b58d 185 }
186
187 private function get_folder_list() {
188 if (!empty($this->folders)) {
189 return $this->folders;
190 }
191 $this->ensure_account_tree();
67a87e7d 192 $folders = array();
a226b58d 193 foreach ($this->accounttree['folder_id'] as $key => $id) {
67a87e7d 194 if (empty($id)) {
195 continue;
196 }
a226b58d 197 $name = $this->accounttree['folder_name'][$key];
198 if (!empty($this->accounttree['shared'][$key])) {
67a87e7d 199 $name .= ' (' . get_string('sharedfolder', 'portfolio_boxnet') . ')';
200 }
201 $folders[$id] = $name;
202 }
203 $this->folders = $folders;
204 return $folders;
205 }
206
a226b58d 207 private function rename_file($fileid, $newname) {
208 // look at moving this to the boxnet client class
209 $this->ensure_account_tree();
210 $count = 1;
211 $bits = explode('.', $newname);
212 $suffix = '';
213 if (count($bits) == 1) {
68b7eed0 214 $prefix = $newname;
a226b58d 215 } else {
216 $suffix = '.' . array_pop($bits);
217 $prefix = implode('.', $bits);
218 }
219 while (true) {
899ffdfb 220 if (!array_key_exists('file_name', $this->accounttree) || !in_array($newname, $this->accounttree['file_name'])) {
9b69a0ce 221 for ($i = 0; $i < 2; $i++) {
222 if ($this->boxclient->renameFile($fileid, $newname)) {
223 return true;
224 }
225 }
226 debugging("tried three times to rename file and failed");
227 return false;
a226b58d 228 }
229 $newname = $prefix . '(' . $count . ')' . $suffix;
230 $count++;
231 }
232 return false;
233 }
234
67a87e7d 235 public function instance_sanity_check() {
236 if (!$this->get_config('apikey')) {
237 return 'err_noapikey';
238 }
239 //@TODO see if we can verify the api key without actually getting an authentication token
240 }
2f68e760 241
384ba38a 242 public static function allows_multiple_instances() {
2f68e760 243 return false;
244 }
62e71954 245
38652d90 246 public function supported_formats() {
24b69846 247 return array(PORTFOLIO_FORMAT_FILE, PORTFOLIO_FORMAT_RICHHTML);
62e71954 248 }
bd39808b
PL
249
250 /*
251 * for now , boxnet doesn't support this,
252 * because we can't dynamically construct return urls.
253 */
254 public static function allows_multiple_exports() {
255 return false;
256 }
67a87e7d 257}