~azzar1/unity/add-show-desktop-key : revision 411

1

# IVLE

2

3

#

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.

8

#

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.

13

#

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

17

18

# Module: File Service / Action

19

# Author: Matt Giuca

20

# Date: 10/1/2008

21

22

# Handles actions requested by the client as part of the 2-stage process of

23

# fileservice (the second part being the return listing).

24

25

### Actions ###

26

27

# The most important argument is "action". This determines which action is

28

# taken. Note that action, and all other arguments, are ignored unless the

29

# request is a POST request. The other arguments depend upon the action.

30

# Note that paths are often specified as arguments. Paths that begin with a

31

# slash are taken relative to the user's home directory (the top-level

32

# directory seen when fileservice has no arguments or path). Paths without a

33

# slash are taken relative to the specified path.

34

35

# action=remove: Delete a file(s) or directory(s) (recursively).

36

# path: The path to the file or directory to delete. Can be specified

37

# multiple times.

38

#

39

# action=move: Move or rename a file or directory.

40

# from: The path to the file or directory to be renamed.

41

# to: The path of the target filename. Error if the file already

42

# exists.

43

#

44

# action=putfile: Upload a file to the student workspace, and optionally

45

# accept zip files which will be unpacked.

46

# path: The path to the file to be written. If it exists, will

47

# overwrite. Error if the target file is a directory.

48

# data: Bytes to be written to the file verbatim. May either be

49

# a string variable or a file upload.

50

# unpack: Optional. If "true", and the data is a valid ZIP file,

51

# will create a directory instead and unpack the ZIP file

52

# into it.

53

#

54

# action=putfiles: Upload multiple files to the student workspace, and

55

# optionally accept zip files which will be unpacked.

56

# path: The path to the DIRECTORY to place files in. Must not be a

57

# file.

58

# data: A file upload (may not be a simple string). The filename

59

# will be used to determine the target filename within

60

# the given path.

61

# unpack: Optional. If "true", if any data is a valid ZIP file,

62

# will create a directory instead and unpack the ZIP file

63

# into it.

64

#

65

# The differences between putfile and putfiles are:

66

# * putfile can only accept a single file.

67

# * putfile can accept string data, doesn't have to be a file upload.

68

# * putfile ignores the upload filename, the entire filename is specified on

69

# path. putfiles calls files after the name on the user's machine.

70

#

71

# Clipboard-based actions. Cut/copy/paste work in the same way as modern

72

# file browsers, by keeping a server-side clipboard of files that have been

73

# cut and copied. The clipboard is stored in the session data, so it persists

74

# across navigation, tabs and browser windows, but not across browser

75

# sessions.

76

#

77

# action=copy: Write file(s) to the session-based clipboard. Overrides any

78

# existing clipboard data. Does not actually copy the file.

79

# The files are physically copied when the clipboard is pasted.

80

# path: The path to the file or directory to copy. Can be specified

81

# multiple times.

82

#

83

# action=cut: Write file(s) to the session-based clipboard. Overrides any

84

# existing clipboard data. Does not actually move the file.

85

# The files are physically moved when the clipboard is pasted.

86

# path: The path to the file or directory to cut. Can be specified

87

# multiple times.

88

#

89

# action=paste: Copy or move the files stored in the clipboard. Clears the

90

# clipboard. The files are copied or moved to a specified dir.

91

# path: The path to the DIRECTORY to paste the files to. Must not

92

# be a file.

93

#

94

# Subversion actions.

95

# action=svnadd: Add an existing file(s) to version control.

96

# path: The path to the file to be added. Can be specified multiple

97

# times.

98

#

99

# action=svnrevert: Revert a file(s) to its state as of the current revision

100

# / undo local edits.

101

# path: The path to the file to be reverted. Can be specified multiple

102

# times.

103

#

104

# action=svnupdate: Bring a file up to date with the head revision.

105

# path: The path to the file to be updated. Only one file may be

106

# specified.

107

#

108

# action=svnpublish: Set the "published" flag on a file to True.

109

# path: The path to the file to be published. Can be specified

110

# multiple times.

111

#

112

# action=svnunpublish: Set the "published" flag on a file to False.

113

# path: The path to the file to be unpublished. Can be specified

114

# multiple times.

115

#

116

# action=svncommit: Commit a file(s) or directory(s) to the repository.

117

# path: The path to the file or directory to be committed. Can be

118

# specified multiple times. Directories are committed

119

# recursively.

120

# logmsg: Text of the log message. Optional. There is a default log

121

# message if unspecified.

122

#

123

# TODO: Implement the following actions:

124

# putfiles, svnrevert, svnupdate, svncommit

125

# TODO: Implement ZIP unpacking in putfile and putfiles.

126

# TODO: svnupdate needs a digest to tell the user the files that were updated.

127

# This can be implemented by some message passing between action and

128

# listing, and having the digest included in the listing. (Problem if

129

# the listing is not a directory, but we could make it an error to do an

130

# update if the path is not a directory).

131

132

import os

133

import shutil

134

135

import pysvn

136

137

from common import (util, studpath, zip)

138

139

# Make a Subversion client object

140

svnclient = pysvn.Client()

141

142

DEFAULT_LOGMESSAGE = "No log message supplied."

143

144

# Mime types

145

# application/json is the "best" content type but is not good for

146

# debugging because Firefox just tries to download it

147

mime_dirlisting = "text/html"

148

#mime_dirlisting = "application/json"

149

150

class ActionError(Exception):

151

"""Represents an error processing an action. This can be

152

raised by any of the action functions, and will be caught

153

by the top-level handler, put into the HTTP response field,

154

and continue.

155

156

Important Security Consideration: The message passed to this

157

exception will be relayed to the client.

158

"""

159

pass

160

161

def handle_action(req, action, fields):

162

"""Perform the "action" part of the response.

163

This function should only be called if the response is a POST.

164

This performs the action's side-effect on the server. If unsuccessful,

165

writes the X-IVLE-Action-Error header to the request object. Otherwise,

166

does not touch the request object. Does NOT write any bytes in response.

167

168

May throw an ActionError. The caller should put this string into the

169

X-IVLE-Action-Error header, and then continue normally.

170

171

action: String, the action requested. Not sanitised.

172

fields: FieldStorage object containing all arguments passed.

173

"""

174

global actions_table # Table of function objects

175

try:

176

action = actions_table[action]

177

except KeyError:

178

# Default, just send an error but then continue

179

raise ActionError("Unknown action")

180

action(req, fields)

181

182

def actionpath_to_urlpath(req, path):

183

"""Determines the URL path (relative to the student home) upon which the

184

action is intended to act. See actionpath_to_local.

185

"""

186

if path is None:

187

return req.path

188

elif len(path) > 0 and path[0] == os.sep:

189

# Relative to student home

190

return path[1:]

191

else:

192

# Relative to req.path

193

return os.path.join(req.path, path)

194

195

def actionpath_to_local(req, path):

196

"""Determines the local path upon which an action is intended to act.

197

Note that fileservice actions accept two paths: the request path,

198

and the "path" argument given to the action.

199

According to the rules, if the "path" argument begins with a '/' it is

200

relative to the user's home; if it does not, it is relative to the

201

supplied path.

202

203

This resolves the path, given the request and path argument.

204

205

May raise an ActionError("Invalid path"). The caller is expected to

206

let this fall through to the top-level handler, where it will be

207

put into the HTTP response field. Never returns None.

208

209

Does not mutate req.

210

"""

211

_, r = studpath.url_to_local(actionpath_to_urlpath(req, path))

212

if r is None:

213

raise ActionError("Invalid path")

214

return r

215

216

def movefile(req, frompath, topath, copy=False):

217

"""Performs a file move, resolving filenames, checking for any errors,

218

and throwing ActionErrors if necessary. Can also be used to do a copy

219

operation instead.

220

221

frompath and topath are straight paths from the client. Will be checked.

222

"""

223

# TODO: Do an SVN mv if the file is versioned.

224

# TODO: Disallow tampering with student's home directory

225

if frompath is None or topath is None:

226

raise ActionError("Required field missing")

227

frompath = actionpath_to_local(req, frompath)

228

topath = actionpath_to_local(req, topath)

229

if not os.path.exists(frompath):

230

raise ActionError("The source file does not exist")

231

if os.path.exists(topath):

232

if frompath == topath:

233

raise ActionError("Source and destination are the same")

234

raise ActionError("Another file already exists with that name")

235

236

try:

237

if copy:

238

if os.path.isdir(frompath):

239

shutil.copytree(frompath, topath)

240

else:

241

shutil.copy2(frompath, topath)

242

else:

243

shutil.move(frompath, topath)

244

except OSError:

245

raise ActionError("Could not move the file specified")

246

except shutil.Error:

247

raise ActionError("Could not move the file specified")

248

249

### ACTIONS ###

250

251

def action_remove(req, fields):

252

# TODO: Do an SVN rm if the file is versioned.

253

# TODO: Disallow removal of student's home directory

254

"""Removes a list of files or directories.

255

256

Reads fields: 'path' (multiple)

257

"""

258

paths = fields.getlist('path')

259

goterror = False

260

for path in paths:

261

path = actionpath_to_local(req, path)

262

try:

263

if os.path.isdir(path):

264

shutil.rmtree(path)

265

else:

266

os.remove(path)

267

except OSError:

268

goterror = True

269

except shutil.Error:

270

goterror = True

271

if goterror:

272

if len(paths) == 1:

273

raise ActionError("Could not delete the file specified")

274

else:

275

raise ActionError(

276

"Could not delete one or more of the files specified")

277

278

def action_move(req, fields):

279

# TODO: Do an SVN mv if the file is versioned.

280

# TODO: Disallow tampering with student's home directory

281

"""Removes a list of files or directories.

282

283

Reads fields: 'from', 'to'

284

"""

285

frompath = fields.getfirst('from')

286

topath = fields.getfirst('to')

287

movefile(req, frompath, topath)

288

289

def action_putfile(req, fields):

290

"""Writes data to a file, overwriting it if it exists and creating it if

291

it doesn't.

292

293

Reads fields: 'path', 'data' (file upload)

294

"""

295

# TODO: Read field "unpack".

296

# Important: Data is "None" if the file submitted is empty.

297

path = fields.getfirst('path')

298

data = fields.getfirst('data')

299

if path is None:

300

raise ActionError("Required field missing")

301

path = actionpath_to_local(req, path)

302

if data is not None:

303

data = data.file

304

305

# Copy the contents of file object 'data' to the path 'path'

306

try:

307

dest = open(path, 'wb')

308

if data is not None:

309

shutil.copyfileobj(data, dest)

310

except OSError:

311

raise ActionError("Could not write to target file")

312

313

def action_putfiles(req, fields):

314

"""Writes data to one or more files in a directory, overwriting them if

315

it they exist.

316

317

Reads fields: 'path', 'data' (file upload, multiple), 'unpack'

318

"""

319

# Important: Data is "None" if the file submitted is empty.

320

path = fields.getfirst('path')

321

data = fields.getlist('data')

322

unpack = fields.getfirst('unpack')

323

if unpack is None:

324

unpack = False

325

else:

326

unpack = True

327

if path is None:

328

raise ActionError("Required field missing")

329

path = actionpath_to_urlpath(req, path)

330

goterror = False

331

332

for datum in data:

333

# Each of the uploaded files

334

filepath = os.path.join(path, datum.filename)

335

filedata = datum.file

336

337

if unpack and datum.filename.lower().endswith(".zip"):

338

# A zip file - unpack it instead of just copying

339

# TODO: Use the magic number instead of file extension

340

# Note: Just unzip into the current directory (ignore the

341

# filename)

342

try:

343

zip.unzip(path, filedata)

344

except (OSError, IOError):

345

goterror = True

346

else:

347

# Not a zip file

348

_, filepath_local = studpath.url_to_local(filepath)

349

if filepath_local is None:

350

raise ActionError("Invalid path")

351

352

# Copy the contents of file object 'data' to the path 'path'

353

try:

354

dest = open(filepath_local, 'wb')

355

if data is not None:

356

shutil.copyfileobj(filedata, dest)

357

except OSError:

358

goterror = True

359

360

if goterror:

361

if len(data) == 1:

362

raise ActionError("Could not write to target file")

363

else:

364

raise ActionError(

365

"Could not write to one or more of the target files")

366

367

def action_copy_or_cut(req, fields, mode):

368

"""Marks specified files on the clipboard, stored in the

369

browser session. Sets clipboard for either a cut or copy operation

370

as specified.

371

372

Reads fields: 'path'

373

"""

374

# The clipboard object created conforms to the JSON clipboard

375

# specification given at the top of listing.py.

376

# Note that we do not check for the existence of files here. That is done

377

# in the paste operation.

378

files = fields.getlist('path')

379

files = map(lambda field: field.value, files)

380

clipboard = { "mode" : mode, "base" : req.path, "files" : files }

381

session = req.get_session()

382

session['clipboard'] = clipboard

383

session.save()

384

385

def action_copy(req, fields):

386

"""Marks specified files on the clipboard, stored in the

387

browser session. Sets clipboard for a "copy" action.

388

389

Reads fields: 'path'

390

"""

391

action_copy_or_cut(req, fields, "copy")

392

393

def action_cut(req, fields):

394

"""Marks specified files on the clipboard, stored in the

395

browser session. Sets clipboard for a "cut" action.

396

397

Reads fields: 'path'

398

"""

399

action_copy_or_cut(req, fields, "cut")

400

401

def action_paste(req, fields):

402

"""Performs the copy or move action with the files stored on

403

the clipboard in the browser session. Copies/moves the files

404

to the specified directory. Clears the clipboard.

405

406

Reads fields: 'path'

407

"""

408

errormsg = None

409

410

todir = fields.getfirst('path')

411

if todir is None:

412

raise ActionError("Required field missing")

413

todir_local = actionpath_to_local(req, todir)

414

if not os.path.isdir(todir_local):

415

raise ActionError("Target is not a directory")

416

417

session = req.get_session()

418

try:

419

clipboard = session['clipboard']

420

files = clipboard['files']

421

base = clipboard['base']

422

if clipboard['mode'] == "copy":

423

copy = True

424

else:

425

copy = False

426

except KeyError:

427

raise ActionError("Clipboard was empty")

428

429

errorfiles = []

430

for file in files:

431

# The source must not be interpreted as relative to req.path

432

# Add a slash (relative to top-level)

433

frompath = os.sep + os.path.join(base, file)

434

# The destination is found by taking just the basename of the file

435

topath = os.path.join(todir, os.path.basename(file))

436

try:

437

movefile(req, frompath, topath, copy)

438

except ActionError, message:

439

# Store the error for later; we want to copy as many as possible

440

if errormsg is None:

441

errormsg = message

442

else:

443

# Multiple errors; generic message

444

errormsg = "One or more files could not be pasted"

445

# Add this file to errorfiles; it will be put back on the

446

# clipboard for possible future pasting.

447

errorfiles.append(file)

448

# If errors occured, augment the clipboard and raise ActionError

449

if len(errorfiles) > 0:

450

clipboard['files'] = errorfiles

451

session['clipboard'] = clipboard

452

session.save()

453

raise ActionError(errormsg)

454

455

# Success: Clear the clipboard

456

del session['clipboard']

457

session.save()

458

459

def action_svnadd(req, fields):

460

"""Performs a "svn add" to each file specified.

461

462

Reads fields: 'path' (multiple)

463

"""

464

paths = fields.getlist('path')

465

paths = map(lambda path: actionpath_to_local(req, path), paths)

466

467

try:

468

svnclient.add(paths, recurse=True, force=True)

469

except pysvn.ClientError:

470

raise ActionError("One or more files could not be added")

471

472

def action_svnupdate(req, fields):

473

"""Performs a "svn update" to each file specified.

474

475

Reads fields: 'path'

476

"""

477

path = fields.getfirst('path')

478

if path is None:

479

raise ActionError("Required field missing")

480

path = actionpath_to_local(req, path)

481

482

try:

483

svnclient.update(path, recurse=True)

484

except pysvn.ClientError:

485

raise ActionError("One or more files could not be updated")

486

487

def action_svnrevert(req, fields):

488

"""Performs a "svn revert" to each file specified.

489

490

Reads fields: 'path' (multiple)

491

"""

492

paths = fields.getlist('path')

493

paths = map(lambda path: actionpath_to_local(req, path), paths)

494

495

try:

496

svnclient.revert(paths, recurse=True)

497

except pysvn.ClientError:

498

raise ActionError("One or more files could not be reverted")

499

500

def action_svnpublish(req, fields):

501

"""Sets svn property "ivle:published" on each file specified.

502

Should only be called on directories (only effective on directories

503

anyway).

504

505

Reads fields: 'path'

506

"""

507

paths = fields.getlist('path')

508

paths = map(lambda path: actionpath_to_local(req, path), paths)

509

510

try:

511

for path in paths:

512

# Note: Property value doesn't matter

513

svnclient.propset("ivle:published", "", path, recurse=False)

514

except pysvn.ClientError:

515

raise ActionError("One or more files could not be updated")

516

517

def action_svnunpublish(req, fields):

518

"""Deletes svn property "ivle:published" on each file specified.

519

520

Reads fields: 'path'

521

"""

522

paths = fields.getlist('path')

523

paths = map(lambda path: actionpath_to_local(req, path), paths)

524

525

try:

526

for path in paths:

527

svnclient.propdel("ivle:published", path, recurse=False)

528

except pysvn.ClientError:

529

raise ActionError("One or more files could not be updated")

530

531

def action_svncommit(req, fields):

532

"""Performs a "svn commit" to each file specified.

533

534

Reads fields: 'path' (multiple), 'logmsg' (optional)

535

"""

536

paths = fields.getlist('path')

537

paths = map(lambda path: actionpath_to_local(req, str(path)), paths)

538

logmsg = str(fields.getfirst('logmsg', DEFAULT_LOGMESSAGE))

539

if logmsg == '': logmsg = DEFAULT_LOGMESSAGE

540

541

try:

542

svnclient.checkin(paths, logmsg, recurse=True)

543

except pysvn.ClientError:

544

raise ActionError("One or more files could not be committed")

545

546

# Table of all action functions #

547

# Each function has the interface f(req, fields).

548

549

actions_table = {

550

"remove" : action_remove,

551

"move" : action_move,

552

"putfile" : action_putfile,

553

"putfiles" : action_putfiles,

554

555

"copy" : action_copy,

556

"cut" : action_cut,

557

"paste" : action_paste,

558

559

"svnadd" : action_svnadd,

560

"svnupdate" : action_svnupdate,

561

"svnrevert" : action_svnrevert,

562

"svnpublish" : action_svnpublish,

563

"svnunpublish" : action_svnunpublish,

564

"svncommit" : action_svncommit,

565

}