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

""" 

Copyright (c) 2012-2013 RockStor, Inc. <http://rockstor.com> 

This file is part of RockStor. 

 

RockStor is free software; you can redistribute it and/or modify 

it under the terms of the GNU General Public License as published 

by the Free Software Foundation; either version 2 of the License, 

or (at your option) any later version. 

 

RockStor is distributed in the hope that it will be useful, but 

WITHOUT ANY WARRANTY; without even the implied warranty of 

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 

General Public License for more details. 

 

You should have received a copy of the GNU General Public License 

along with this program. If not, see <http://www.gnu.org/licenses/>. 

""" 

 

import pwd 

from rest_framework.response import Response 

from rest_framework.exceptions import NotFound 

from django.db import transaction 

from django.conf import settings 

from storageadmin.models import (SambaShare, User, SambaCustomConfig) 

from storageadmin.serializers import SambaShareSerializer 

from storageadmin.util import handle_exception 

import rest_framework_custom as rfc 

from share import ShareMixin 

from system.samba import (refresh_smb_config, status, restart_samba) 

from fs.btrfs import mount_share 

 

import logging 

logger = logging.getLogger(__name__) 

 

 

class SambaMixin(object): 

    serializer_class = SambaShareSerializer 

    DEF_OPTS = { 

        'comment': 'samba export', 

        'browsable': 'yes', 

        'guest_ok': 'no', 

        'read_only': 'no', 

        'custom_config': None, 

        'shadow_copy': False, 

        'snapshot_prefix': None, 

    } 

    BOOL_OPTS = ('yes', 'no',) 

 

    @staticmethod 

    def _restart_samba(): 

        out = status() 

        if (out[2] == 0): 

            restart_samba(hard=True) 

 

    @classmethod 

    def _validate_input(cls, request, smbo=None): 

        options = {} 

        def_opts = cls.DEF_OPTS 

        if (smbo is not None): 

            def_opts = cls.DEF_OPTS.copy() 

            def_opts['comment'] = smbo.comment 

            def_opts['browsable'] = smbo.browsable 

            def_opts['guest_ok'] = smbo.guest_ok 

            def_opts['read_only'] = smbo.read_only 

            def_opts['shadow_copy'] = smbo.shadow_copy 

 

        options['comment'] = request.data.get('comment', def_opts['comment']) 

        options['browsable'] = request.data.get('browsable', 

                                                def_opts['browsable']) 

 

        options['custom_config'] = request.data.get('custom_config', []) 

        if (type(options['custom_config']) != list): 

            e_msg = ('custom config must be a list of strings') 

            handle_exception(Exception(e_msg), request) 

        if (options['browsable'] not in cls.BOOL_OPTS): 

            e_msg = ('Invalid choice for browsable. Possible ' 

                     'choices are yes or no.') 

            handle_exception(Exception(e_msg), request) 

        options['guest_ok'] = request.data.get('guest_ok', 

                                               def_opts['guest_ok']) 

        if (options['guest_ok'] not in cls.BOOL_OPTS): 

            e_msg = ('Invalid choice for guest_ok. Possible ' 

                     'options are yes or no.') 

            handle_exception(Exception(e_msg), request) 

        options['read_only'] = request.data.get('read_only', 

                                                def_opts['read_only']) 

        if (options['read_only'] not in cls.BOOL_OPTS): 

            e_msg = ('Invalid choice for read_only. Possible ' 

                     'options are yes or no.') 

            handle_exception(Exception(e_msg), request) 

        options['shadow_copy'] = request.data.get('shadow_copy', 

                                                  def_opts['shadow_copy']) 

        if (options['shadow_copy']): 

            options['snapshot_prefix'] = request.data.get( 

                'snapshot_prefix', def_opts['snapshot_prefix']) 

            if (options['snapshot_prefix'] is None or 

                    len(options['snapshot_prefix'].strip()) == 0): 

                e_msg = ('Invalid choice for snapshot_prefix. It must be a ' 

                         'valid non-empty string') 

                handle_exception(Exception(e_msg), request) 

 

        return options 

 

    @staticmethod 

    def _set_admin_users(admin_users, smb_share): 

        for au in admin_users: 

            try: 

                auo = User.objects.get(username=au) 

            except User.DoesNotExist: 

                # check if the user is a system user, then create a temp user 

                # object. 

                try: 

                    system_user = pwd.getpwnam(au) 

                    auo = User(username=au, uid=system_user.pw_uid, 

                               gid=system_user.pw_gid, admin=False) 

                    auo.save() 

                except KeyError: 

                    # raise the outer exception as it's more meaningful to the 

                    # user. 

                    raise Exception('Requested admin user(%s) does ' 

                                    'not exist.' % au) 

            finally: 

                auo.smb_shares.add(smb_share) 

 

 

class SambaListView(SambaMixin, ShareMixin, rfc.GenericView): 

    queryset = SambaShare.objects.all() 

 

    @transaction.atomic 

    def post(self, request): 

        if ('shares' not in request.data): 

            e_msg = ('Must provide share names') 

            handle_exception(Exception(e_msg), request) 

        shares = [self._validate_share(request, s) for s in 

                  request.data['shares']] 

        options = self._validate_input(request) 

        custom_config = options['custom_config'] 

        del(options['custom_config']) 

        for share in shares: 

            if (SambaShare.objects.filter(share=share).exists()): 

                e_msg = ('Share(%s) is already exported via Samba' % 

                         share.name) 

                handle_exception(Exception(e_msg), request) 

        with self._handle_exception(request): 

            for share in shares: 

                mnt_pt = ('%s%s' % (settings.MNT_PT, share.name)) 

                options['share'] = share 

                options['path'] = mnt_pt 

                smb_share = SambaShare(**options) 

                smb_share.save() 

                for cc in custom_config: 

                    cco = SambaCustomConfig(smb_share=smb_share, 

                                            custom_config=cc) 

                    cco.save() 

                if not share.is_mounted: 

                    mount_share(share, mnt_pt) 

 

                admin_users = request.data.get('admin_users', []) 

                if (admin_users is None): 

                    admin_users = [] 

                self._set_admin_users(admin_users, smb_share) 

            refresh_smb_config(list(SambaShare.objects.all())) 

            self._restart_samba() 

            return Response(SambaShareSerializer(smb_share).data) 

 

 

class SambaDetailView(SambaMixin, rfc.GenericView): 

    def get(self, *args, **kwargs): 

        try: 

            data = SambaShare.objects.get(id=self.kwargs['smb_id']) 

            serialized_data = SambaShareSerializer(data) 

            return Response(serialized_data.data) 

        except SambaShare.DoesNotExist: 

            raise NotFound(detail=None) 

 

    @transaction.atomic 

    def delete(self, request, smb_id): 

        try: 

            smbo = SambaShare.objects.get(id=smb_id) 

            SambaCustomConfig.objects.filter(smb_share=smbo).delete() 

            smbo.delete() 

        except: 

            e_msg = ('Samba export for the id(%s) does not exist' % smb_id) 

            handle_exception(Exception(e_msg), request) 

 

        with self._handle_exception(request): 

            refresh_smb_config(list(SambaShare.objects.all())) 

            self._restart_samba() 

            return Response() 

 

    @transaction.atomic 

    def put(self, request, smb_id): 

        with self._handle_exception(request): 

            try: 

                smbo = SambaShare.objects.get(id=smb_id) 

            except: 

                e_msg = ('Samba export for the id(%s) does not exist' % smb_id) 

                handle_exception(Exception(e_msg), request) 

 

            options = self._validate_input(request, smbo=smbo) 

            custom_config = options['custom_config'] 

            del(options['custom_config']) 

            smbo.__dict__.update(**options) 

            admin_users = request.data.get('admin_users', []) 

            if (admin_users is None): 

                admin_users = [] 

            for uo in User.objects.filter(smb_shares=smbo): 

                if (uo.username not in admin_users): 

                    uo.smb_shares.remove(smbo) 

            self._set_admin_users(admin_users, smbo) 

            smbo.save() 

            for cco in SambaCustomConfig.objects.filter(smb_share=smbo): 

                if (cco.custom_config not in custom_config): 

                    cco.delete() 

                else: 

                    custom_config.remove(cco.custom_config) 

            for cc in custom_config: 

                cco = SambaCustomConfig(smb_share=smbo, custom_config=cc) 

                cco.save() 

            for smb_o in SambaShare.objects.all(): 

                if not smb_o.share.is_mounted: 

                    mnt_pt = ('%s%s' % (settings.MNT_PT, smb_o.share.name)) 

                    try: 

                        mount_share(smb_o.share, mnt_pt) 

                    except Exception as e: 

                        logger.exception(e) 

                        if (smb_o.id == smbo.id): 

                            e_msg = ('Failed to mount share(%s) due to a low ' 

                                     'level error.' % smb_o.share.name) 

                            handle_exception(Exception(e_msg), request) 

 

            refresh_smb_config(list(SambaShare.objects.all())) 

            self._restart_samba() 

            return Response(SambaShareSerializer(smbo).data)