1

# jsonrpc.py

     2

#   original code: http://trac.pyworks.org/pyjamas/wiki/DjangoWithPyJamas

     3

#   also from: http://www.pimentech.fr/technologies/outils

     4

import datetime

     5

     6

from django.core.serializers import serialize

     7

     8

     9

from pyjs.jsonrpc import JSONRPCServiceBase

    10

# JSONRPCService and jsonremote are used in combination to drastically

    11

# simplify the provision of JSONRPC services.  use as follows:

    12

#

    13

# jsonservice = JSONRPCService()

    14

#

    15

# @jsonremote(jsonservice)

    16

# def test(request, echo_param):

    17

#     return "echoing the param back: %s" % echo_param

    18

#

    19

# dump jsonservice into urlpatterns:

    20

#  (r'^service1/$', 'djangoapp.views.jsonservice'),

    21

    22

    23

class JSONRPCService(JSONRPCServiceBase):

    24

    25

    def __call__(self, request, extra=None):

    26

        return self.process(request.raw_post_data)

    27

    28

    29

def jsonremote(service):

    30

    """Make JSONRPCService a decorator so that you can write :

    31

    32

    from jsonrpc import JSONRPCService

    33

    chatservice = JSONRPCService()

    34

    35

    @jsonremote(chatservice)

    36

    def login(request, user_name):

    37

        (...)

    38

    """

    39

    def remotify(func):

    40

        if isinstance(service, JSONRPCService):

    41

            service.add_method(func.__name__, func)

    42

        else:

    43

            emsg = 'Service "%s" not found' % str(service.__name__)

    44

            raise NotImplementedError(emsg)

    45

        return func

    46

    return remotify

    47

    48

    49

# FormProcessor provides a mechanism for turning Django Forms into JSONRPC

    50

# Services.  If you have an existing Django app which makes prevalent

    51

# use of Django Forms it will save you rewriting the app.

    52

# use as follows.  in djangoapp/views.py :

    53

#

    54

# class SimpleForm(forms.Form):

    55

#     testfield = forms.CharField(max_length=100)

    56

#

    57

# class SimpleForm2(forms.Form):

    58

#     testfield = forms.CharField(max_length=20)

    59

#

    60

# processor = FormProcessor({'processsimpleform': SimpleForm,

    61

#                            'processsimpleform2': SimpleForm2})

    62

#

    63

# this will result in a JSONRPC service being created with two

    64

# RPC functions.  dump "processor" into urlpatterns to make it

    65

# part of the app:

    66

#  (r'^formsservice/$', 'djangoapp.views.processor'),

    67

    68

    69

def builderrors(form):

    70

    d = {}

    71

    for error in form.errors.keys():

    72

        if error not in d:

    73

            d[error] = []

    74

        for errorval in form.errors[error]:

    75

            d[error].append(unicode(errorval))

    76

    return d

    77

    78

    79

# contains the list of arguments in each field

    80

field_names = {

    81

 'CharField': ['max_length', 'min_length'],

    82

 'IntegerField': ['max_value', 'min_value'],

    83

 'FloatField': ['max_value', 'min_value'],

    84

 'DecimalField': ['max_value', 'min_value', 'max_digits', 'decimal_places'],

    85

 'DateField': ['input_formats'],

    86

 'DateTimeField': ['input_formats'],

    87

 'TimeField': ['input_formats'],

    88

 'RegexField': ['max_length', 'min_length'],  # sadly we can't get the expr

    89

 'EmailField': ['max_length', 'min_length'],

    90

 'URLField': ['max_length', 'min_length', 'verify_exists', 'user_agent'],

    91

 'ChoiceField': ['choices'],

    92

 'FilePathField': ['path', 'match', 'recursive', 'choices'],

    93

 'IPAddressField': ['max_length', 'min_length'],

    94

 }

    95

    96

    97

def describe_field_errors(field):

    98

    res = {}

    99

    field_type = field.__class__.__name__

   100

    msgs = {}

   101

    for n, m in field.error_messages.items():

   102

        msgs[n] = unicode(m)

   103

    res['error_messages'] = msgs

   104

    if field_type in ['ComboField', 'MultiValueField', 'SplitDateTimeField']:

   105

        res['fields'] = map(describe_field, field.fields)

   106

    return res

   107

   108

   109

def describe_fields_errors(fields, field_names):

   110

    res = {}

   111

    if not field_names:

   112

        field_names = fields.keys()

   113

    for name in field_names:

   114

        field = fields[name]

   115

        res[name] = describe_field_errors(field)

   116

    return res

   117

   118

   119

def describe_field(field):

   120

    res = {}

   121

    field_type = field.__class__.__name__

   122

    for fname in (field_names.get(field_type, []) +

   123

                  ['help_text', 'label', 'initial', 'required']):

   124

        res[fname] = getattr(field, fname)

   125

    if field_type in ['ComboField', 'MultiValueField', 'SplitDateTimeField']:

   126

        res['fields'] = map(describe_field, field.fields)

   127

    return res

   128

   129

   130

def describe_fields(fields, field_names):

   131

    res = {}

   132

    if not field_names:

   133

        field_names = fields.keys()

   134

    for name in field_names:

   135

        field = fields[name]

   136

        res[name] = describe_field(field)

   137

    return res

   138

   139

   140

class FormProcessor(JSONRPCService):

   141

    def __init__(self, forms, _formcls=None):

   142

   143

        if _formcls is None:

   144

            JSONRPCService.__init__(self)

   145

            for k in forms.keys():

   146

                s = FormProcessor({}, forms[k])

   147

                self.add_method(k, s.__process)

   148

        else:

   149

            JSONRPCService.__init__(self, forms)

   150

            self.formcls = _formcls

   151

   152

    def __process(self, request, params, command=None):

   153

   154

        f = self.formcls(params)

   155

   156

        if command is None:  # just validate

   157

            if not f.is_valid():

   158

                return {'success': False, 'errors': builderrors(f)}

   159

            return {'success': True}

   160

   161

        elif 'describe_errors' in command:

   162

            field_names = command['describe_errors']

   163

            return describe_fields_errors(f.fields, field_names)

   164

   165

        elif 'describe' in command:

   166

            field_names = command['describe']

   167

            return describe_fields(f.fields, field_names)

   168

   169

        elif 'save' in command:

   170

            if not f.is_valid():

   171

                return {'success': False, 'errors': builderrors(f)}

   172

            instance = f.save()  # XXX: if you want more, over-ride save.

   173

            return {'success': True, 'instance': json_convert(instance)}

   174

   175

        elif 'html' in command:

   176

            return {'success': True, 'html': f.as_table()}

   177

   178

        return "unrecognised command"

   179

   180

# The following is incredibly convenient for saving vast amounts of

   181

# coding, avoiding doing silly things like this:

   182

#     jsonresult = {'field1': djangoobject.field1,

   183

#                   'field2': djangoobject.date.strftime('%Y.%M'),

   184

#                    ..... }

   185

#

   186

# The date/time flatten function is there because JSONRPC doesn't

   187

# support date/time objects or formats, so conversion to a string

   188

# is the most logical choice.  pyjamas, being python, can easily

   189

# be used to parse the string result at the other end.

   190

#

   191

# use as follows:

   192

#

   193

# jsonservice = JSONRPCService()

   194

#

   195

# @jsonremote(jsonservice)

   196

# def list_some_model(request, start=0, count=10):

   197

#     l = SomeDjangoModelClass.objects.filter()

   198

#     res = json_convert(l[start:end])

   199

#

   200

# @jsonremote(jsonservice)

   201

# def list_another_model(request, start=0, count=10):

   202

#     l = AnotherDjangoModelClass.objects.filter()

   203

#     res = json_convert(l[start:end])

   204

#

   205

# dump jsonservice into urlpatterns to make the two RPC functions,

   206

# list_some_model and list_another_model part of the django app:

   207

#  (r'^service1/$', 'djangoapp.views.jsonservice'),

   208

   209

   210

def dict_datetimeflatten(item):

   211

    d = {}

   212

    for k, v in item.items():

   213

        k = str(k)

   214

        if isinstance(v, datetime.date):

   215

            d[k] = str(v)

   216

        elif isinstance(v, dict):

   217

            d[k] = dict_datetimeflatten(v)

   218

        else:

   219

            d[k] = v

   220

    return d

   221

   222

   223

def json_convert(l, fields=None):

   224

    res = []

   225

    for item in serialize('python', l, fields=fields):

   226

        res.append(dict_datetimeflatten(item))

   227

    return res