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

# Copyright 2011-2015 Luc Saffre 

# License: BSD (see file COPYING for details) 

 

"""Defines built-in user roles. See :mod:`lino.core.permissions`. 

 

""" 

from builtins import object 

 

 

class UserRole(object): 

    """Base class for all user roles. Even anonymous users have this 

    role. 

 

    """ 

 

    def has_required_roles(self, required_roles): 

        """Return `True` if this role satisfies the specified roles. 

 

        The specified arguments are the set of role requirements 

        (class objects).  This role (an instance) must satisfy *every* 

        specified requirement.  Every requirement is either a class 

        object (subclass of :class:`<UserRole>`) or a tuple thereof. 

 

        """ 

        check_required_roles(required_roles, "code") 

        for rr in required_roles: 

            if not isinstance(self, rr): 

                return False 

        return True 

 

    @classmethod 

    def get_user_profiles(cls): 

        """Yield a series of all user profiles on this site which satisfy this 

        role. 

 

        """ 

        from lino.modlib.users.choicelists import UserProfiles 

        for p in UserProfiles.items(): 

            if p.has_required_roles([cls]): 

                yield p 

 

 

class SiteUser(UserRole): 

    """Every authenticated user has this role.""" 

 

 

class Supervisor(UserRole): 

    """A user who has permission to act as another user.""" 

 

 

class SiteStaff(SiteUser): 

    """A user who can configure site-wide functionality. 

 

    Certain privileged actions require this role: 

 

    - Merging duplicate database records (:class:`MergeAction 

      <lino.core.merge.MergeAction>`) 

 

    - Editing printable templates (:class:`EditTemplate 

      <lino.mixins.printable.EditTemplate>`) 

 

    """ 

 

 

class SiteAdmin(SiteStaff, Supervisor): 

    """The root user of this system. """ 

    pass 

 

 

def login_required(*args): 

    """An API shortcut available in :mod:`lino.api.dd`. See 

    :meth:`lino.modlib.users.choicelists.UserProfile.has_required_role` 

 

    """ 

    if len(args): 

        return set(args) 

    return set([SiteUser]) 

 

 

def check_role(rr, actor): 

    if not issubclass(rr, UserRole): 

        raise Exception( 

            "{0} (required on {1}) is not a UserRole".format(rr, actor)) 

 

 

def check_required_roles(required_roles, actor): 

    for rr in required_roles: 

        if isinstance(rr, (tuple, list)): 

            if len(rr) == 0: 

                raise Exception( 

                    "{0} (required on {1}) is an empty tuple".format( 

                        rr, actor)) 

            for rri in rr: 

                check_role(rri, actor) 

        else: 

            check_role(rr, actor)