1
/* IVLE - Informatics Virtual Learning Environment
2
* Copyright (C) 2007-2008 The University of Melbourne
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License as published by
6
* the Free Software Foundation; either version 2 of the License, or
7
* (at your option) any later version.
9
* This program is distributed in the hope that it will be useful,
10
* but WITHOUT ANY WARRANTY; without even the implied warranty of
11
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
* GNU General Public License for more details.
14
* You should have received a copy of the GNU General Public License
15
* along with this program; if not, write to the Free Software
16
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
* Module: File Browser (client)
23
/* Url names for apps */
26
service_app = "fileservice";
28
download_app = "download";
30
/* Mapping MIME types onto handlers.
31
* "text" : When navigating to a text file, the text editor is opened.
32
* "image" : When navigating to an image, the image is displayed (rather than
33
* going to the text editor).
34
* "audio" : When navigating to an audio file, a "play" button is presented.
35
* "binary" : When navigating to a binary file, offer it as a download through
38
* If a file is not on the list, its default action is determined by the first
39
* part of its content type, where "text/*", "image/*" and "audio/*" are
40
* treated as above, and other types are simply treated as binary.
43
"application/x-javascript" : "text",
44
"application/javascript" : "text",
45
"application/json" : "text",
46
"application/xml" : "text"
49
/* Mapping MIME types to icons, just the file's basename */
51
"text/directory": "dir.png",
52
"text/x-python": "py.png"
55
default_type_icon = "txt.png";
57
/* Relative to IVLE root */
58
type_icons_path = "media/images/mime";
59
type_icons_path_large = "media/images/mime/large";
61
/* Mapping SVN status to icons, just the file's basename */
64
"normal": "normal.png",
66
"missing": "missing.png",
67
"deleted": "deleted.png",
68
"modified": "modified.png",
69
"revision": "revision.png"
72
/* Mapping SVN status to "nice" strings */
74
"unversioned": "Temporary file",
75
"normal": "Permanent file",
76
"added": "Temporary file (scheduled to be added)",
77
"missing": "Permanent file (missing)",
78
"deleted": "Permanent file (scheduled for deletion)",
79
"replaced": "Permanent file (replaced)",
80
"modified": "Permanent file (modified)",
81
"merged": "Permanent file (merged)",
82
"conflicted": "Permanent file (conflicted)",
83
"revision": "Past Permanent file (revision)"
86
default_svn_icon = null;
87
default_svn_nice = "Unknown status";
89
svn_icons_path = "media/images/svn";
91
published_icon = "media/images/interface/published.png";
93
/* List of MIME types considered "executable" by the system.
94
* Executable files offer a "run" link, implying that the "serve"
95
* application can interpret them.
102
/* Global variables */
104
/** The listing object returned by the server as JSON */
109
/** Filenames of all files selected
110
* (Only used by dir listings, but still needs to be [] for files, so that
111
* update_actions knows that nothing is selected).
115
upload_callback_count = 0; /* See upload_callback */
117
/** Calls the server using Ajax, performing an action on the server side.
118
* Receives the response from the server and performs a refresh of the page
119
* contents, updating it to display the returned data (such as a directory
120
* listing, file preview, or editor pane).
121
* Always makes a POST request.
124
* \param action String. Name of the action to perform, as defined in the
126
* \param path URL path to make the request to, within the application.
127
* \param args Argument object, as described in util.parse_url and friends.
128
* This should contain the arguments to the action, but NOT the action
129
* itself. (Also a minor side-effect; the "args" object will be mutated
130
* to include the action attribute).
131
* \param content_type String, optional.
132
* May be "application/x-www-form-urlencoded" or "multipart/form-data".
133
* Defaults to "application/x-www-form-urlencoded".
134
* "multipart/form-data" is recommended for large uploads.
136
function do_action(action, path, args, content_type, ignore_response)
138
args.action = action;
139
/* Callback action, when the server returns */
140
var callback = function(response)
142
/* Check for action errors reported by the server, and report them
144
var error = response.getResponseHeader("X-IVLE-Action-Error");
146
/* Note: This header (in particular) comes URI-encoded, to
147
* allow multi-line error messages. Decode */
148
alert("Error: " + decodeURIComponent(error.toString()) + ".");
149
/* Now read the response and set up the page accordingly */
150
if (ignore_response != true)
151
handle_response(path, response, true);
153
/* Call the server and perform the action. This mutates the server. */
154
ajax_call(callback, service_app, path, args, "POST", content_type);
157
/** Calls the server using Ajax, requesting a directory listing. This should
158
* not modify the server in any way. Receives the response from the server and
159
* performs a refresh of the page contents, updating it to display the
160
* returned data (such as a directory listing, file preview, or editor pane).
161
* Called "navigate", can also be used for a simple refresh.
162
* Always makes a GET request.
165
function navigate(path)
167
callback = function(response)
169
/* Read the response and set up the page accordingly */
170
handle_response(path, response, false, url.args);
172
/* Get any query strings */
173
url = parse_url(window.location.href);
175
/* Call the server and request the listing. */
176
ajax_call(callback, service_app, path, url.args, "GET");
179
/* Refreshes the current view.
180
* Calls navigate on the current path.
184
navigate(current_path);
187
/** Determines the "handler type" from a MIME type.
188
* The handler type is a string, either "text", "image", "audio" or "binary".
190
function get_handler_type(content_type)
194
if (content_type in type_handlers)
195
return type_handlers[content_type];
197
{ /* Based on the first part of the MIME type */
198
var handler_type = content_type.split('/')[0];
199
if (handler_type != "text" && handler_type != "image" &&
200
handler_type != "audio")
201
handler_type = "binary";
206
/** Given an HTTP response object, cleans up and rebuilds the contents of the
207
* page using the response data. This does not navigate away from the page, it
208
* merely rebuilds most of the data.
209
* Note that depending on the type of data returned, this could result in a
210
* directory listing, an image preview, an editor pane, etc.
211
* Figures out the type and calls the appropriate function.
212
* \param path URL path which the request was made for. This can (among other
213
* things) be used to update the URL in the location bar.
214
* \param response XMLHttpRequest object returned by the server. Should
215
* contain all the response data.
216
* \param is_action Boolean. True if this is the response to an action, false
217
* if this is the response to a simple listing. This is used in handling the
219
* \param url_args Arguments dict, for the arguments passed to the URL
220
* in the browser's address bar (will be forwarded along).
222
function handle_response(path, response, is_action, url_args)
224
/* TODO: Set location bar to "path" */
227
/* Clear away the existing page contents */
230
/* Check the status, and if not 200, read the error and handle this as an
232
if (response.status != 200)
234
var error = response.getResponseHeader("X-IVLE-Return-Error");
236
error = response.statusText;
241
/* This will always return a listing, whether it is a dir or a file.
243
var listing = response.responseText;
244
/* The listing SHOULD be valid JSON text. Parse it into an object. */
247
listing = JSON.parse(listing);
248
file_listing = listing.listing; /* Global */
254
var err = document.createElement("div");
255
var p = dom_make_text_elem("p", "Error: "
256
+ "There was an unexpected server error processing "
257
+ "the selected command.");
259
p = dom_make_text_elem("p", "If the problem persists, please "
260
+ "contact the system administrator.")
262
p = document.createElement("p");
263
var refresh = document.createElement("input");
264
refresh.setAttribute("type", "button");
265
refresh.setAttribute("value", "Back to file view");
266
refresh.setAttribute("onclick", "refresh()");
267
p.appendChild(refresh);
273
var err = document.createElement("div");
274
var p = dom_make_text_elem("p", "Error: "
275
+ "There was an unexpected server error retrieving "
276
+ "the requested file or directory.");
278
p = dom_make_text_elem("p", "If the problem persists, please "
279
+ "contact the system administrator.")
285
/* Get "." out, it's special */
286
current_file = file_listing["."]; /* Global */
287
delete file_listing["."];
289
/* Check if this is a directory listing or file contents */
290
var isdir = response.getResponseHeader("X-IVLE-Return") == "Dir";
293
handle_dir_listing(path, listing);
297
/* Need to make a 2nd ajax call, this time get the actual file
299
callback = function(response)
301
/* Read the response and set up the page accordingly */
302
handle_contents_response(path, response);
304
/* Call the server and request the listing. */
306
args = shallow_clone_object(url_args);
309
/* This time, get the contents of the file, not its metadata */
310
args['return'] = "contents";
311
ajax_call(callback, service_app, path, args, "GET");
313
update_actions(isdir);
316
function handle_contents_response(path, response)
318
/* Treat this as an ordinary file. Get the file type. */
319
var content_type = response.getResponseHeader("Content-Type");
320
var handler_type = get_handler_type(content_type);
321
would_be_handler_type = handler_type;
322
/* handler_type should now be set to either
323
* "text", "image", "audio" or "binary". */
324
switch (handler_type)
327
handle_text(path, response.responseText,
328
would_be_handler_type);
331
/* TODO: Custom image handler */
332
handle_binary(path, response.responseText);
335
/* TODO: Custom audio handler */
336
handle_binary(path, response.responseText);
344
/* Called when a form upload comes back (from an iframe).
345
* Refreshes the page.
347
function upload_callback()
349
/* This has a pretty nasty hack, which happens to work.
350
* upload_callback is set as the "onload" callback for the iframe which
351
* receives the response from the server for uploading a file.
352
* This means it gets called twice. Once when initialising the iframe, and
353
* a second time when the actual response comes back.
354
* All we want to do is call navigate to refresh the page. But we CAN'T do
355
* that on the first load or it will just go into an infinite cycle of
356
* refreshing. We need to refresh the page ONLY on the second refresh.
357
* upload_callback_count is reset to 0 just before the iframe is created.
359
upload_callback_count++;
360
if (upload_callback_count >= 2)
364
/** Deletes all "dynamic" content on the page.
365
* This returns the page back to the state it is in when the HTML arrives to
366
* the browser, ready for another handler to populate it.
370
dom_removechildren(document.getElementById("filesbody"));
373
/** Deletes all "dynamic" content on the page necessary to navigate from
374
* one directory listing to another (does not clear as much as clearpage
376
* This is the equivalent of calling clearpage() then
377
* setup_for_dir_listing(), assuming the page is already on a dir listing.
379
function clearpage_dir()
381
dom_removechildren(document.getElementById("path"));
382
dom_removechildren(document.getElementById("files"));
383
dom_removechildren(document.getElementById("sidepanel"));
386
/*** HANDLERS for different types of responses (such as dir listing, file,
390
* message may either be a string, or a DOM node, which will be placed inside
393
function handle_error(message)
395
var files = document.getElementById("filesbody");
397
if (typeof(message) == "string")
399
txt_elem = dom_make_text_elem("div", "Error: "
400
+ message.toString() + ".")
404
/* Assume message is a DOM node */
405
txt_elem = document.createElement("div");
406
txt_elem.appendChild(message);
408
txt_elem.setAttribute("class", "padding error");
409
files.appendChild(txt_elem);
412
/** Given a mime type, returns the path to the icon.
413
* \param type String, Mime type.
414
* \param sizelarge Boolean, optional.
415
* \return Path to the icon. Has applied make_path, so it is relative to site
418
function mime_type_to_icon(type, sizelarge)
421
if (type in type_icons)
422
filename = type_icons[type];
424
filename = default_type_icon;
426
return make_path(path_join(type_icons_path_large, filename));
428
return make_path(path_join(type_icons_path, filename));
431
/** Given an svnstatus, returns the path to the icon.
432
* \param type String, svn status.
433
* \return Path to the icon. Has applied make_path, so it is relative to site
434
* root. May return null to indicate no SVN icon.
436
function svnstatus_to_icon(svnstatus)
439
if (svnstatus in svn_icons)
440
filename = svn_icons[svnstatus];
442
filename = default_svn_icon;
443
if (filename == null) return null;
444
return make_path(path_join(svn_icons_path, filename));
447
/** Given an svnstatus, returns the "nice" string.
449
function svnstatus_to_string(svnstatus)
451
if (svnstatus in svn_nice)
452
return svn_nice[svnstatus];
454
return default_svn_nice;
457
/** Displays a download link to the binary file.
459
function handle_binary(path)
461
var files = document.getElementById("filesbody");
462
var div = document.createElement("div");
463
files.appendChild(div);
464
div.setAttribute("class", "padding");
465
var download_link = app_path(download_app, path);
466
var par1 = dom_make_text_elem("p",
467
"The file " + path + " is a binary file. To download this file, " +
468
"click the following link:");
469
var par2 = dom_make_link_elem("p",
470
"Download " + path, "Download " + path, download_link);
471
div.appendChild(par1);
472
div.appendChild(par2);
475
function update_actions()
478
var numsel = selected_files.length;
483
/* Display information about the current directory instead */
484
filename = path_basename(current_path);
487
else if (numsel == 1)
489
filename = selected_files[0];
490
file = file_listing[filename];
493
/* Update each action node in the topbar.
494
* This includes enabling/disabling actions as appropriate, and
495
* setting href/onclick attributes. */
499
/* Available if exactly one file is selected */
500
var open = document.getElementById("act_open");
503
open.setAttribute("class", "choice");
505
open.setAttribute("title",
506
"Navigate to this directory in the file browser");
508
open.setAttribute("title",
509
"Edit or view this file");
510
open.setAttribute("href", app_path(this_app, current_path, filename));
514
open.setAttribute("class", "disabled");
515
open.removeAttribute("title");
516
open.removeAttribute("href");
520
/* Available if zero or one files are selected,
521
* and only if this is a file, not a directory */
522
var serve = document.getElementById("act_serve");
523
if (numsel <= 1 && !file.isdir)
525
serve.setAttribute("class", "choice");
527
serve.setAttribute("href",
528
app_path(serve_app, current_path));
530
serve.setAttribute("href",
531
app_path(serve_app, current_path, filename));
535
serve.setAttribute("class", "disabled");
536
serve.removeAttribute("href");
540
/* Available if exactly one file is selected,
541
* and it is a Python file.
543
var run = document.getElementById("act_run");
545
if (numsel == 0 && !file.isdir && file.type == "text/x-python")
547
// In the edit window
548
run.setAttribute("class", "choice");
549
localpath = app_path('home',current_path);
550
run.setAttribute("onclick", "runfile('" + localpath + "')");
552
else if (numsel == 1 && !file.isdir && file.type == "text/x-python")
554
// In the browser window
555
run.setAttribute("class", "choice");
556
localpath = app_path('home',current_path,filename);
557
run.setAttribute("onclick", "runfile('" + localpath + "')");
561
run.setAttribute("class", "disabled");
562
run.removeAttribute("onclick");
567
* If 0 files selected, download the current file or directory as a ZIP.
568
* If 1 directory selected, download it as a ZIP.
569
* If 1 non-directory selected, download it.
570
* If >1 files selected, download them all as a ZIP.
572
var download = document.getElementById("act_download");
577
download.setAttribute("href",
578
app_path(download_app, current_path));
580
download.setAttribute("title",
581
"Download the current directory as a ZIP file");
583
download.setAttribute("title",
584
"Download the current file");
588
download.setAttribute("href",
589
app_path(download_app, current_path, filename));
591
download.setAttribute("title",
592
"Download the selected directory as a ZIP file");
594
download.setAttribute("title",
595
"Download the selected file");
600
/* Make a query string with all the files to download */
601
var dlpath = urlencode_path(app_path(download_app, current_path)) + "?";
602
for (var i=0; i<numsel; i++)
603
dlpath += "path=" + encodeURIComponent(selected_files[i]) + "&";
604
dlpath = dlpath.substr(0, dlpath.length-1);
605
download.setAttribute("href", dlpath);
606
download.setAttribute("title",
607
"Download the selected files as a ZIP file");
610
/* Refresh - No changes required */
612
/* Publish and Submit */
613
/* If this directory is under subversion and selected/unselected file is a
615
var publish = document.getElementById("act_publish");
616
var submit = document.getElementById("act_submit");
617
if (numsel <= 1 && file.isdir)
619
/* TODO: Work out of file is svn'd */
620
publish.setAttribute("class", "choice");
621
publish.removeAttribute("disabled");
622
/* If this dir is already published, call it "Unpublish" */
625
publish.setAttribute("value", "unpublish");
626
publish.setAttribute("title" ,"Make it so this directory "
627
+ "can not be seen by anyone on the web");
628
publish.textContent = "Unpublish";
630
publish.setAttribute("value", "publish");
631
publish.setAttribute("title","Make it so this directory "
632
+ "can be seen by anyone on the web");
633
publish.textContent = "Publish";
635
submit.setAttribute("class", "choice");
636
submit.removeAttribute("disabled");
640
publish.setAttribute("class", "disabled");
641
publish.setAttribute("disabled", "disabled");
642
submit.setAttribute("class", "disabled");
643
submit.setAttribute("disabled", "disabled");
647
/* If exactly 1 non-directory file is selected/opened, and its parent
648
* directory is published.
650
var share = document.getElementById("act_share");
651
if (numsel <= 1 && !file.isdir)
653
/* Work out if parent dir is published */
654
parentdir = current_file;
655
if (parentdir.published)
657
share.setAttribute("class", "choice");
658
share.removeAttribute("disabled");
660
share.setAttribute("class", "disabled");
661
share.setAttribute("disabled", "disabled");
666
share.setAttribute("class", "disabled");
667
share.setAttribute("disabled", "disabled");
671
/* If exactly 1 file is selected */
672
var rename = document.getElementById("act_rename");
675
rename.setAttribute("class", "choice");
676
rename.removeAttribute("disabled");
680
rename.setAttribute("class", "disabled");
681
rename.setAttribute("disabled", "disabled");
684
/* Delete, cut, copy */
685
/* If >= 1 file is selected */
686
var act_delete = document.getElementById("act_delete");
687
var cut = document.getElementById("act_cut");
688
var copy = document.getElementById("act_copy");
691
act_delete.setAttribute("class", "choice");
692
act_delete.removeAttribute("disabled");
693
cut.setAttribute("class", "choice");
694
cut.removeAttribute("disabled");
695
copy.setAttribute("class", "choice");
696
copy.removeAttribute("disabled");
700
act_delete.setAttribute("class", "disabled");
701
act_delete.setAttribute("disabled", "disabled");
702
cut.setAttribute("class", "disabled");
703
cut.setAttribute("disabled", "disabled");
704
copy.setAttribute("class", "disabled");
705
copy.setAttribute("disabled", "disabled");
708
/* Paste, new file, new directory, upload */
709
/* Disable if the current file is not a directory */
710
if (!current_file.isdir)
712
var paste = document.getElementById("act_paste");
713
var newfile = document.getElementById("act_newfile");
714
var mkdir = document.getElementById("act_mkdir");
715
var upload = document.getElementById("act_upload");
716
paste.setAttribute("class", "disabled");
717
paste.setAttribute("disabled", "disabled");
718
newfile.setAttribute("class", "disabled");
719
newfile.setAttribute("disabled", "disabled");
720
mkdir.setAttribute("class", "disabled");
721
mkdir.setAttribute("disabled", "disabled");
722
upload.setAttribute("class", "disabled");
723
upload.setAttribute("disabled", "disabled");
726
/* Subversion actions */
727
/* TODO: Work out when these are appropriate */
728
var svnadd = document.getElementById("act_svnadd");
729
var svnrevert = document.getElementById("act_svnrevert");
730
var svncommit = document.getElementById("act_svncommit");
733
svnadd.setAttribute("class", "choice");
734
svnadd.removeAttribute("disabled");
735
svnrevert.setAttribute("class", "choice");
736
svnrevert.removeAttribute("disabled");
737
svncommit.setAttribute("class", "choice");
738
svncommit.removeAttribute("disabled");
740
var svncheckout = document.getElementById("act_svncheckout");
741
/* current_path == username: We are at the top level */
742
if (current_path == username)
744
svncheckout.setAttribute("class", "choice");
745
svncheckout.removeAttribute("disabled");
749
svncheckout.setAttribute("class", "disabled");
750
svncheckout.setAttribute("disabled", "disabled");
753
/* There is currently nothing on the More Actions menu of use
754
* when the current file is not a directory. Hence, just remove
756
* (This makes some of the above decisions somewhat redundant).
758
if (!(current_file.isdir))
760
var moreactions = document.getElementById("moreactions_area");
761
moreactions.setAttribute("style", "display: none;");
767
/** Event handler for when an item of the "More actions..." dropdown box is
768
* selected. Performs the selected action. */
769
function handle_moreactions()
771
var moreactions = document.getElementById("moreactions");
772
if (moreactions.value == "top")
774
var selectedaction = moreactions.value;
775
/* Reset to "More actions..." */
776
moreactions.selectedIndex = 0;
778
/* If 0 files selected, filename is the name of the current dir.
779
* If 1 file selected, filename is that file.
781
if (selected_files.length == 0)
782
filename = path_basename(current_path);
783
else if (selected_files.length == 1)
784
filename = selected_files[0];
788
/* Now handle the selected action */
789
switch(selectedaction)
792
action_publish(selected_files);
795
action_unpublish(selected_files);
798
//alert("Not yet implemented: Sharing files");
799
window.open(public_app_path(serve_app, current_path, filename), 'share')
803
alert("Not yet implemented: Submit");
806
action_rename(filename);
809
action_remove(selected_files);
812
action_copy(selected_files);
815
action_cut(selected_files);
827
show_uploadpanel(true);
830
action_add(selected_files);
833
action_revert(selected_files);
836
action_commit(selected_files);
844
/** User clicks "Run" button.
845
* Do an Ajax call and print the test output.
847
function runfile(localpath)
849
/* Dump the entire file to the console */
850
var callback = function()
852
console_enter_line("execfile('" + localpath + "')", "block");
854
start_server(callback)
858
/** Called when the page loads initially.
860
window.onload = function()
862
/* Navigate (internally) to the path in the URL bar.
863
* This causes the page to be populated with whatever is at that address,
864
* whether it be a directory or a file.
866
var path = parse_url(window.location.href).path;
867
/* Strip out root_dir + "/files" from the front of the path */
868
var strip = make_path(this_app);
869
if (path.substr(0, strip.length) == strip)
870
path = path.substr(strip.length+1);
873
/* See if this is an edit path */
874
strip = make_path(edit_app);
875
if (path.substr(0, strip.length) == strip)
877
path = path.substr(strip.length+1);
881
if (path.length == 0)
883
/* Navigate to the user's home directory by default */
890
/* Set up the console plugin to display as a popup window */
added
removed
www/media/browser/browser.js
