Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

#!/usr/bin/env python 

# -*- coding: utf-8 -*- 

 

############################################################################### 

#  Copyright 2013 Kitware Inc. 

# 

#  Licensed under the Apache License, Version 2.0 ( the "License" ); 

#  you may not use this file except in compliance with the License. 

#  You may obtain a copy of the License at 

# 

#    http://www.apache.org/licenses/LICENSE-2.0 

# 

#  Unless required by applicable law or agreed to in writing, software 

#  distributed under the License is distributed on an "AS IS" BASIS, 

#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

#  See the License for the specific language governing permissions and 

#  limitations under the License. 

############################################################################### 

 

import cherrypy 

import json 

import os 

 

from ..describe import Description 

from ..rest import Resource, RestException, loadmodel 

from ...constants import AccessType 

from ...utility import ziputil 

 

 

class Folder(Resource): 

    """API Endpoint for folders.""" 

 

    def __init__(self): 

        self.resourceName = 'folder' 

        self.route('DELETE', (':id',), self.deleteFolder) 

        self.route('GET', (), self.find) 

        self.route('GET', (':id',), self.getFolder) 

        self.route('GET', (':id', 'access'), self.getFolderAccess) 

        self.route('GET', (':id', 'download'), self.downloadFolder) 

        self.route('POST', (), self.createFolder) 

        self.route('PUT', (':id',), self.updateFolder) 

        self.route('PUT', (':id', 'access'), self.updateFolderAccess) 

 

    def find(self, params): 

        """ 

        Get a list of folders with given search parameters. Currently accepted 

        search modes are: 

 

        1. Searching by parentId and parentType. 

        2. Searching with full text search. 

 

        To search with full text search, pass the "text" parameter. To search 

        by parent, (i.e. list child folders) pass parentId and parentType, 

        which must be one of ('folder' | 'collection' | 'user'). You can also 

        pass limit, offset, sort, and sortdir paramters. 

 

        :param limit: The result set size limit, default=50. 

        :param offset: Offset into the results, default=0. 

        :param sort: The field to sort by, default=lowerName. 

        :param sortdir: 1 for ascending, -1 for descending, default=1. 

        """ 

        limit, offset, sort = self.getPagingParameters(params, 'lowerName') 

        user = self.getCurrentUser() 

 

        if 'text' in params: 

            return self.model('folder').textSearch( 

                params['text'], user=user, limit=limit, project={ 

                    'name': 1 

                }) 

        elif 'parentId' in params and 'parentType' in params: 

            parentType = params['parentType'].lower() 

            if parentType not in ('collection', 'folder', 'user'): 

                raise RestException('The parentType must be user, collection,' 

                                    ' or folder.') 

 

            parent = self.model(parentType).load( 

                id=params['parentId'], user=user, level=AccessType.READ, 

                exc=True) 

 

            return [self.model('folder').filter(folder, user) for folder in 

                    self.model('folder').childFolders( 

                        parentType=parentType, parent=parent, user=user, 

                        offset=offset, limit=limit, sort=sort)] 

        else: 

            raise RestException('Invalid search mode.') 

    find.description = ( 

        Description('Search for folders by certain properties.') 

        .responseClass('Folder') 

        .param('parentType', """Type of the folder's parent: either user, 

               folder, or collection (default='folder').""", required=False) 

        .param('parentId', "The ID of the folder's parent.", required=False) 

        .param('text', 'Pass to perform a text search.', required=False) 

        .param('limit', "Result set size limit (default=50).", required=False, 

               dataType='int') 

        .param('offset', "Offset into result set (default=0).", required=False, 

               dataType='int') 

        .param('sort', "Field to sort the folder list by (default=name)", 

               required=False) 

        .param('sortdir', "1 for ascending, -1 for descending (default=1)", 

               required=False, dataType='int') 

        .errorResponse() 

        .errorResponse('Read access was denied on the parent resource.', 403)) 

 

    @loadmodel(map={'id': 'folder'}, model='folder', level=AccessType.READ) 

    def downloadFolder(self, folder, params): 

        """ 

        Returns a generator function that will be used to stream out a zip 

        file containing this folder's contents, filtered by permissions. 

        """ 

        cherrypy.response.headers['Content-Type'] = 'application/zip' 

        cherrypy.response.headers['Content-Disposition'] = \ 

            'attachment; filename="{}{}"'.format(folder['name'], '.zip') 

 

        user = self.getCurrentUser() 

 

        def stream(): 

            zip = ziputil.ZipGenerator(folder['name']) 

            for data in self._downloadFolder(folder, zip, user): 

                yield data 

 

            yield zip.footer() 

        return stream 

    downloadFolder.description = ( 

        Description('Download an entire folder as a zip archive.') 

        .param('id', 'The ID of the folder.', paramType='path') 

        .errorResponse('ID was invalid.') 

        .errorResponse('Read access was denied for the folder.', 403)) 

 

    def _downloadFolder(self, folder, zip, user, path=''): 

        """ 

        Helper method to recurse through folders and download files in them. 

        """ 

        for sub in self.model('folder').childFolders(parentType='folder', 

                                                     parent=folder, user=user, 

                                                     limit=0): 

            for data in self._downloadFolder(sub, zip, user, os.path.join( 

                                             path, sub['name'])): 

                yield data 

        for item in self.model('folder').childItems(folder=folder, limit=0): 

            for file in self.model('item').childFiles(item=item, limit=0): 

                for data in zip.addFile( 

                    self.model('file') 

                        .download(file, headers=False), os.path.join( 

                            path, file['name'])): 

                    yield data 

 

    @loadmodel(map={'id': 'folder'}, model='folder', level=AccessType.WRITE) 

    def updateFolder(self, folder, params): 

        """ 

        Update the folder. 

 

        :param name: Name for the folder. 

        :param description: Description for the folder. 

        :param public: Public read access flag. 

        :type public: bool 

        """ 

        folder['name'] = params.get('name', folder['name']).strip() 

        folder['description'] = params.get( 

            'description', folder['description']).strip() 

 

        folder = self.model('folder').updateFolder(folder) 

        return self.model('folder').filter(folder, self.getCurrentUser()) 

    updateFolder.description = ( 

        Description('Update a folder by ID.') 

        .responseClass('Folder') 

        .param('id', 'The ID of the folder.', paramType='path') 

        .param('name', 'Name of the folder.') 

        .param('description', 'Description for the folder.', required=False) 

        .param('public', "Whether the folder should be public or private.", 

               required=False, dataType='boolean') 

        .errorResponse('ID was invalid.') 

        .errorResponse('Write access was denied for the folder.', 403)) 

 

    @loadmodel(map={'id': 'folder'}, model='folder', level=AccessType.ADMIN) 

    def updateFolderAccess(self, folder, params): 

        self.requireParams(['access'], params) 

 

        public = params.get('public', 'false').lower() == 'true' 

        self.model('folder').setPublic(folder, public) 

 

        try: 

            access = json.loads(params['access']) 

            return self.model('folder').setAccessList( 

                folder, access, save=True) 

        except ValueError: 

            raise RestException('The access parameter must be JSON.') 

    updateFolderAccess.description = ( 

        Description('Update the access control list for a folder.') 

        .param('id', 'The ID of the folder.', paramType='path') 

        .param('access', 'The JSON-encoded access control list.') 

        .param('public', 'Public read access flag.', dataType='bool') 

        .errorResponse('ID was invalid.') 

        .errorResponse('Admin access was denied for the folder.', 403)) 

 

    def createFolder(self, params): 

        """ 

        Create a new folder. 

 

        :param parentId: The _id of the parent folder. 

        :type parentId: str 

        :param parentType: The type of the parent of this folder. 

        :type parentType: str - 'user', 'collection', or 'folder' 

        :param name: The name of the folder to create. 

        :param description: Folder description. 

        :param public: Public read access flag. 

        :type public: bool 

        """ 

        self.requireParams(['name', 'parentId'], params) 

 

        user = self.getCurrentUser() 

        parentType = params.get('parentType', 'folder').lower() 

        name = params['name'].strip() 

        description = params.get('description', '').strip() 

        public = params.get('public') 

 

        if public is not None: 

            public = public.lower() == 'true' 

 

        if parentType not in ('folder', 'user', 'collection'): 

            raise RestException('Set parentType to collection, folder, ' 

                                'or user.') 

 

        model = self.model(parentType) 

 

        parent = model.load(id=params['parentId'], user=user, 

                            level=AccessType.WRITE, exc=True) 

 

        folder = self.model('folder').createFolder( 

            parent=parent, name=name, parentType=parentType, creator=user, 

            description=description, public=public) 

 

        if parentType == 'user': 

            folder = self.model('folder').setUserAccess( 

                folder, user=user, level=AccessType.ADMIN, save=True) 

        elif parentType == 'collection': 

            # TODO set appropriate top-level community folder permissions 

            pass 

        return self.model('folder').filter(folder, user) 

    createFolder.description = ( 

        Description('Create a new folder.') 

        .responseClass('Folder') 

        .param('parentType', """Type of the folder's parent: either user, 

               folder', or collection (default='folder').""", required=False) 

        .param('parentId', "The ID of the folder's parent.") 

        .param('name', "Name of the folder.") 

        .param('description', "Description for the folder.", required=False) 

        .param('public', """Wheter the folder should be public or private. By 

               default, inherits the value from parent folder, or in the 

               case of user or collection parentType, defaults to False.""", 

               required=False, dataType='boolean') 

        .errorResponse() 

        .errorResponse('Write access was denied on the parent', 403)) 

 

    @loadmodel(map={'id': 'folder'}, model='folder', level=AccessType.READ) 

    def getFolder(self, folder, params): 

        """Get a folder by ID.""" 

        return self.model('folder').filter(folder, self.getCurrentUser()) 

    getFolder.description = ( 

        Description('Get a folder by ID.') 

        .responseClass('Folder') 

        .param('id', 'The ID of the folder.', paramType='path') 

        .errorResponse('ID was invalid.') 

        .errorResponse('Read access was denied for the folder.', 403)) 

 

    @loadmodel(map={'id': 'folder'}, model='folder', level=AccessType.ADMIN) 

    def getFolderAccess(self, folder, params): 

        """ 

        Get an access list for a folder. 

        """ 

        return self.model('folder').getFullAccessList(folder) 

    getFolderAccess.description = ( 

        Description('Get the access control list for a folder.') 

        .responseClass('Folder') 

        .param('id', 'The ID of the folder.', paramType='path') 

        .errorResponse('ID was invalid.') 

        .errorResponse('Admin access was denied for the folder.', 403)) 

 

    @loadmodel(map={'id': 'folder'}, model='folder', level=AccessType.ADMIN) 

    def deleteFolder(self, folder, params): 

        """ 

        Delete a folder recursively. 

        """ 

        self.model('folder').remove(folder) 

        return {'message': 'Deleted folder %s.' % folder['name']} 

    deleteFolder.description = ( 

        Description('Delete a folder by ID.') 

        .param('id', 'The ID of the folder.', paramType='path') 

        .errorResponse('ID was invalid.') 

        .errorResponse('Admin access was denied for the folder.', 403))