Hide keyboard shortcuts

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

# -*- coding: UTF-8 -*- 

# Copyright 2008-2015 Luc Saffre 

# License: BSD (see file COPYING for details) 

""" 

Database models for `lino.modlib.uploads`. 

""" 

from builtins import str 

from builtins import object 

 

import logging 

logger = logging.getLogger(__name__) 

 

from django.db import models 

from django.conf import settings 

from django.utils.translation import ugettext_lazy as _ 

from django.utils.translation import string_concat 

 

from lino.api import dd, rt 

from lino import mixins 

from lino.utils.xmlgen.html import E 

from lino.utils import join_elems 

from lino.modlib.gfks.mixins import Controllable 

from lino.modlib.users.mixins import UserAuthored, My 

from lino.modlib.office.roles import OfficeUser, OfficeStaff, OfficeOperator 

 

from .choicelists import Shortcuts, UploadAreas 

 

 

class UploadType(mixins.BabelNamed): 

    """The type of an upload. 

 

    .. attribute:: shortcut 

 

        Optional pointer to a virtual **upload shortcut** field.  If 

        this is not empty, then the given shortcut field will manage 

        uploads of this type.  See also :class:`Shortcuts 

        <lino.modlib.uploads.choicelists.Shortcuts>`. 

 

    """ 

    class Meta(object): 

        abstract = dd.is_abstract_model(__name__, 'UploadType') 

        verbose_name = _("Upload Type") 

        verbose_name_plural = _("Upload Types") 

 

    upload_area = UploadAreas.field(default=UploadAreas.general.as_callable) 

 

    max_number = models.IntegerField( 

        _("Max. number"), default=-1, 

        help_text=string_concat( 

            _("No need to upload more uploads than N of this type."), 

            "\n", 

            _("-1 means no limit."))) 

    wanted = models.BooleanField( 

        _("Wanted"), default=False, 

        help_text=_("Add a (+) button when there is no upload of this type.")) 

 

    shortcut = Shortcuts.field(blank=True) 

 

 

class UploadTypes(dd.Table): 

    """The table with all existing upload types. 

 

    This usually is accessible via the `Configure` menu. 

    """ 

    required_roles = dd.required(OfficeStaff) 

    model = 'uploads.UploadType' 

    column_names = "upload_area name max_number wanted shortcut *" 

    order_by = ["upload_area", "name"] 

 

    insert_layout = """ 

    name 

    upload_area 

    """ 

 

    detail_layout = """ 

    id upload_area wanted max_number shortcut 

    name 

    uploads.UploadsByType 

    """ 

 

 

def filename_leaf(name): 

    i = name.rfind('/') 

    if i != -1: 

        return name[i + 1:] 

    return name 

 

 

@dd.python_2_unicode_compatible 

class Upload(mixins.Uploadable, UserAuthored, Controllable): 

    """Represents an uploaded file.""" 

    class Meta(object): 

        abstract = dd.is_abstract_model(__name__, 'Upload') 

        verbose_name = _("Upload") 

        verbose_name_plural = _("Uploads") 

 

    upload_area = UploadAreas.field(default=UploadAreas.general.as_callable) 

 

    type = dd.ForeignKey( 

        "uploads.UploadType", 

        blank=True, null=True) 

 

    description = models.CharField( 

        _("Description"), max_length=200, blank=True) 

 

    def __str__(self): 

        if self.description: 

            s = self.description 

        elif self.file: 

            s = filename_leaf(self.file.name) 

        else: 

            s = str(self.id) 

        if self.type: 

            s = str(self.type) + ' ' + s 

        return s 

 

    @dd.chooser() 

    def type_choices(self, upload_area): 

        M = dd.resolve_model('uploads.UploadType') 

        logger.info("20140430 type_choices %s", upload_area) 

        if upload_area is None: 

            return M.objects.all() 

        return M.objects.filter(upload_area=upload_area) 

 

    def save(self, *args, **kw): 

        if self.type is not None: 

            self.upload_area = self.type.upload_area 

        super(Upload, self).save(*args, **kw) 

 

 

dd.update_field(Upload, 'user', verbose_name=_("Uploaded by")) 

 

 

class Uploads(dd.Table): 

    "Shows all Uploads" 

    model = 'uploads.Upload' 

    required_roles = dd.login_required((OfficeUser, OfficeOperator)) 

    column_names = "file type user owner description *" 

    order_by = ['-id'] 

 

    detail_layout = dd.DetailLayout(""" 

    file user 

    upload_area type description 

    owner 

    """, window_size=(80, 'auto')) 

 

    insert_layout = """ 

    type 

    description 

    file 

    user 

    """ 

 

    parameters = mixins.ObservedPeriod( 

        # user=models.ForeignKey( 

        #     'users.User', blank=True, null=True, 

        #     verbose_name=_("Uploaded by")), 

        upload_type=models.ForeignKey( 

            'uploads.UploadType', blank=True, null=True)) 

    params_layout = "start_date end_date user upload_type" 

 

    # simple_parameters = ['user'] 

 

    @classmethod 

    def get_request_queryset(cls, ar): 

        qs = super(Uploads, cls).get_request_queryset(ar) 

        pv = ar.param_values 

 

        if pv.user: 

            qs = qs.filter(user=pv.user) 

 

        if pv.upload_type: 

            qs = qs.filter(type=pv.upload_type) 

 

        return qs 

 

 

class AllUploads(Uploads): 

    use_as_default_table = False 

    required_roles = dd.required(OfficeStaff) 

 

 

class UploadsByType(Uploads): 

    master_key = 'type' 

    column_names = "file description user * " 

 

 

class MyUploads(My, Uploads): 

    """Shows only my Uploads (i.e. those whose author is current user).""" 

    required_roles = dd.required((OfficeUser, OfficeOperator)) 

    column_names = "file description user owner *" 

    # order_by = ["modified"] 

 

    # @classmethod 

    # def get_actor_label(self): 

    #     return _("My %s") % _("Uploads") 

 

    # @classmethod 

    # def param_defaults(self, ar, **kw): 

    #     kw = super(MyUploads, self).param_defaults(ar, **kw) 

    #     kw.update(user=ar.get_user()) 

    #     return kw 

 

 

class AreaUploads(Uploads): 

    required_roles = dd.required((OfficeUser, OfficeOperator)) 

    stay_in_grid = True 

    _upload_area = UploadAreas.general 

    slave_grid_format = 'summary' 

 

    @classmethod 

    def get_known_values(self): 

        return dict(upload_area=self._upload_area) 

 

    @classmethod 

    def get_actor_label(self): 

        if self._upload_area is not None: 

            return self._upload_area.text 

        return self._label or self.__name__ 

 

    @classmethod 

    def format_row_in_slave_summary(self, ar, obj): 

        """almost as unicode, but without the type 

        """ 

        return obj.description or filename_leaf(obj.file.name) \ 

            or str(obj.id) 

 

    @classmethod 

    def get_slave_summary(self, obj, ar): 

        """Displays the uploads related to this controller as a list grouped 

        by uploads type. 

 

        Note that this also works on 

        :class:`lino_welfare.modlib.uploads.models.UploadsByClient` 

        and their subclasses for the different `_upload_area`. 

 

        """ 

        UploadType = rt.modules.uploads.UploadType 

        # Upload = rt.modules.uploads.Upload 

        elems = [] 

        types = [] 

 

        perm = ar.get_user().profile.has_required_roles(self.required_roles) 

 

        for ut in UploadType.objects.filter(upload_area=self._upload_area): 

            sar = ar.spawn( 

                self, master_instance=obj, 

                known_values=dict(type_id=ut.id)) 

            # logger.info("20140430 %s", sar.data_iterator.query) 

            files = [] 

            for m in sar: 

                text = self.format_row_in_slave_summary(ar, m) 

                if text is None: 

                    continue 

                edit = ar.obj2html( 

                    m,  text,  # _("Edit"), 

                    # icon_name='application_form', 

                    title=_("Edit metadata of the uploaded file.")) 

                if m.file.name: 

                    show = ar.renderer.href_button( 

                        settings.SITE.build_media_url(m.file.name), 

                        # u"\u21A7",  # DOWNWARDS ARROW FROM BAR (↧) 

                        # u"\u21E8", 

                        u"\u21f2",  # SOUTH EAST ARROW TO CORNER (⇲) 

                        style="text-decoration:none;", 

                        # _(" [show]"),  # fmt(m), 

                        target='_blank', 

                        # icon_name=settings.SITE.build_static_url( 

                        #     'images/xsite/link'), 

                        # icon_name='page_go', 

                        # style="vertical-align:-30%;", 

                        title=_("Open the uploaded file in a new browser window")) 

                    # logger.info("20140430 %s", E.tostring(e)) 

                    files.append(E.span(edit, ' ', show)) 

                else: 

                    files.append(edit) 

            if perm and ut.wanted \ 

               and (ut.max_number < 0 or len(files) < ut.max_number): 

                btn = self.insert_action.request_from( 

                    sar, master_instance=obj, 

                    known_values=dict(type_id=ut.id)).ar2button() 

                if btn is not None: 

                    files.append(btn) 

            if len(files) > 0: 

                e = E.p(str(ut), ': ', *join_elems(files, ', ')) 

                types.append(e) 

        # logger.info("20140430 %s", [E.tostring(e) for e in types]) 

        if len(types) == 0: 

            elems.append(E.ul(E.li(ar.no_data_text))) 

        else: 

            elems.append(E.ul(*[E.li(e) for e in types])) 

        return E.div(*elems) 

 

 

class UploadsByController(AreaUploads): 

    "UploadsByController" 

    master_key = 'owner' 

    column_names = "file type description user *" 

 

    insert_layout = """ 

    file 

    type 

    description 

    """ 

 

    @classmethod 

    def format_upload(self, obj): 

        return str(obj.type)