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

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

#!/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 datetime 

 

from .model_base import AccessControlledModel, ValidationException 

from girder.constants import AccessType 

 

 

class Folder(AccessControlledModel): 

    """ 

    Folders are used to store items and can also store other folders in 

    a hierarchical way, like a directory on a filesystem. Every folder has 

    its own set of access control policies, but by default the access 

    control list is inherited from the folder's parent folder, if it has one. 

    Top-level folders are ones whose parent is a user or a collection. 

    """ 

 

    def initialize(self): 

        self.name = 'folder' 

        self.ensureIndices(['parentId', 'name', 'lowerName']) 

        self.ensureTextIndex({ 

            'name': 10, 

            'description': 1 

        }) 

 

    def filter(self, folder, user): 

        """ 

        Filter a folder document for display to the user. 

        """ 

        keys = ['_id', 'name', 'public', 'description', 'created', 'updated', 

                'size', 'parentId', 'parentCollection', 'creatorId', 

                'baseParentType', 'baseParentId'] 

 

        filtered = self.filterDocument(folder, allow=keys) 

 

        filtered['_accessLevel'] = self.getAccessLevel( 

            folder, user) 

 

        return filtered 

 

    def validate(self, doc): 

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

        doc['lowerName'] = doc['name'].lower() 

        doc['description'] = doc['description'].strip() 

 

        if not doc['name']: 

            raise ValidationException('Folder name must not be empty.', 'name') 

 

        if not doc['parentCollection'] in ('folder', 'user', 'collection'): 

            # Internal error; this shouldn't happen 

            raise Exception('Invalid folder parent type: %s.' % 

                            doc['parentCollection']) 

 

        # Ensure unique name among sibling folders 

        q = { 

            'parentId': doc['parentId'], 

            'name': doc['name'], 

            'parentCollection': doc['parentCollection'] 

        } 

        if '_id' in doc: 

            q['_id'] = {'$ne': doc['_id']} 

        duplicates = self.find(q, limit=1, fields=['_id']) 

        if duplicates.count() != 0: 

            raise ValidationException('A folder with that name already ' 

                                      'exists here.', 'name') 

 

        # Ensure unique name among sibling items 

        q = { 

            'folderId': doc['parentId'], 

            'name': doc['name'] 

        } 

        duplicates = self.model('item').find(q, limit=1, fields=['_id']) 

        if duplicates.count() != 0: 

            raise ValidationException('An item with that name already ' 

                                      'exists here.', 'name') 

 

        return doc 

 

    def load(self, id, level=AccessType.ADMIN, user=None, objectId=True, 

             force=False, fields=None, exc=False): 

        """ 

        We override load in order to ensure the folder has certain fields 

        within it, and if not, we add them lazily at read time. 

 

        :param id: The id of the resource. 

        :type id: string or ObjectId 

        :param user: The user to check access against. 

        :type user: dict or None 

        :param level: The required access type for the object. 

        :type level: AccessType 

        :param force: If you explicity want to circumvent access 

                      checking on this resource, set this to True. 

        :type force: bool 

        """ 

        doc = AccessControlledModel.load( 

            self, id=id, objectId=objectId, level=level, fields=fields, 

            exc=exc, force=force, user=user) 

 

        if doc is not None and 'baseParentType' not in doc: 

            pathFromRoot = self.parentsToRoot(doc, user=user, force=force) 

            baseParent = pathFromRoot[0] 

            doc['baseParentId'] = baseParent['object']['_id'] 

            doc['baseParentType'] = baseParent['type'] 

            self.save(doc) 

        if doc is not None and 'lowerName' not in doc: 

            self.save(doc) 

 

        return doc 

 

    def remove(self, folder): 

        """ 

        Delete a folder recursively. 

 

        :param folder: The folder document to delete. 

        :type folder: dict 

        """ 

        # Delete all child items 

        items = self.model('item').find({ 

            'folderId': folder['_id'] 

        }, limit=0) 

        for item in items: 

            self.model('item').remove(item) 

 

        # Delete all child folders 

        folders = self.find({ 

            'parentId': folder['_id'], 

            'parentCollection': 'folder' 

        }, limit=0) 

        for subfolder in folders: 

            self.remove(subfolder) 

 

        # Delete pending uploads into this folder 

        uploads = self.model('upload').find({ 

            'parentId': folder['_id'], 

            'parentType': 'folder' 

        }, limit=0) 

        for upload in uploads: 

            self.model('upload').remove(upload) 

 

        # Delete this folder 

        AccessControlledModel.remove(self, folder) 

 

    def childItems(self, folder, limit=50, offset=0, sort=None): 

        """ 

        Generator function that yields child items in a folder. 

 

        :param folder: The parent folder. 

        :param limit: Result limit. 

        :param offset: Result offset. 

        :param sort: The sort structure to pass to pymongo. 

        """ 

        q = { 

            'folderId': folder['_id'] 

        } 

 

        cursor = self.model('item').find( 

            q, limit=limit, offset=offset, sort=sort) 

        for item in cursor: 

            yield item 

 

    def childFolders(self, parent, parentType, user=None, limit=50, offset=0, 

                     sort=None): 

        """ 

        This generator will yield child folders of a user, collection, or 

        folder, with access policy filtering. 

 

        :param parent: The parent object. 

        :type parentType: Type of the parent object. 

        :param parentType: The parent type. 

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

        :param user: The user running the query. Only returns folders that this 

                     user can see. 

        :param limit: Result limit. 

        :param offset: Result offset. 

        :param sort: The sort structure to pass to pymongo. 

        """ 

        parentType = parentType.lower() 

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

            raise ValidationException('The parentType must be folder, ' 

                                      'collection, or user.') 

 

        q = { 

            'parentId': parent['_id'], 

            'parentCollection': parentType 

        } 

 

        # Perform the find; we'll do access-based filtering of the result set 

        # afterward. 

        cursor = self.find(q, limit=0, sort=sort) 

 

        for r in self.filterResultsByPermission(cursor=cursor, user=user, 

                                                level=AccessType.READ, 

                                                limit=limit, offset=offset): 

            yield r 

 

    def createFolder(self, parent, name, description='', parentType='folder', 

                     public=None, creator=None): 

        """ 

        Create a new folder under the given parent. 

 

        :param parent: The parent document. Should be a folder, user, or 

                       collection. 

        :type parent: dict 

        :param name: The name of the folder. 

        :type name: str 

        :param description: Description for the folder. 

        :type description: str 

        :param parentType: What type the parent is: 

                           ('folder' | 'user' | 'collection') 

        :type parentType: str 

        :param public: Public read access flag. 

        :type public: bool or None to inherit from parent 

        :param creator: User document representing the creator of this folder. 

        :type creator: dict 

        :returns: The folder document that was created. 

        """ 

        assert '_id' in parent 

        assert public is None or type(public) is bool 

 

        parentType = parentType.lower() 

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

            raise ValidationException('The parentType must be folder, ' 

                                      'collection, or user.') 

 

        if parentType == 'folder': 

            parentObject = {'parentId': parent['_id'], 

                            'parentCollection': parentType} 

            pathFromRoot = self.parentsToRoot(parentObject, user=creator) 

            if 'baseParentId' not in parent: 

                pathFromRoot = self.parentsToRoot(parent, user=creator) 

                parent['baseParentId'] = pathFromRoot[0]['object']['_id'] 

                parent['baseParentType'] = pathFromRoot[0]['type'] 

        else: 

            parent['baseParentId'] = parent['_id'] 

            parent['baseParentType'] = parentType 

 

        now = datetime.datetime.now() 

 

        if creator is None: 

            creatorId = None 

        else: 

            creatorId = creator.get('_id', None) 

 

        folder = { 

            'name': name, 

            'description': description, 

            'parentCollection': parentType, 

            'baseParentId': parent['baseParentId'], 

            'baseParentType': parent['baseParentType'], 

            'parentId': parent['_id'], 

            'creatorId': creatorId, 

            'created': now, 

            'updated': now, 

            'size': 0 

        } 

 

        # If this is a subfolder, default permissions are inherited from the 

        # parent folder. Otherwise, the creator is granted admin access. 

        if parentType == 'folder': 

            self.copyAccessPolicies(src=parent, dest=folder) 

        elif creator is not None: 

            self.setUserAccess(folder, user=creator, level=AccessType.ADMIN) 

 

        # Allow explicit public flag override if it's set. 

        if public is not None and type(public) is bool: 

            self.setPublic(folder, public=public) 

 

        # Now validate and save the folder. 

        return self.save(folder) 

 

    def updateFolder(self, folder): 

        """ 

        Updates a folder. 

 

        :param folder: The folder document to update 

        :type folder: dict 

        :returns: The folder document that was edited. 

        """ 

        folder['updated'] = datetime.datetime.now() 

 

        # Validate and save the folder 

        return self.save(folder) 

 

    def parentsToRoot(self, folder, curPath=[], user=None, force=False, 

                      level=AccessType.READ): 

        """ 

        Get the path to traverse to a root of the hierarchy. 

 

        :param item: The item whose root to find 

        :type item: dict 

        :returns: an ordered list of dictionaries from root to the current item 

        """ 

        curParentId = folder['parentId'] 

        curParentType = folder['parentCollection'] 

        if curParentType == 'user' or curParentType == 'collection': 

            curParentObject = self.model(curParentType).load( 

                curParentId, user=user, level=level, force=force) 

            parentFiltered = self.model(curParentType).filter(curParentObject, 

                                                              user) 

            return [{'type': curParentType, 

                     'object': parentFiltered}] + curPath 

        else: 

            curParentObject = self.load( 

                curParentId, user=user, level=level, force=force) 

            curPath = [{'type': curParentType, 

                        'object': self.filter(curParentObject, user)}] + curPath 

            return self.parentsToRoot(curParentObject, curPath, user=user, 

                                      force=force)