1

# jsonrpc.py

     2

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

     3

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

     4

from datetime import date

     5

import datetime

     6

import sys

     7

     8

from django.utils import simplejson

     9

from django.http import HttpResponse

    10

from django import forms

    11

from django.core.serializers import serialize

    12

    13

    14

from pyjs.jsonrpc import JSONRPCServiceBase

    15

# JSONRPCService and jsonremote are used in combination to drastically

    16

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

    17

#

    18

# jsonservice = JSONRPCService()

    19

#

    20

# @jsonremote(jsonservice)

    21

# def test(request, echo_param):

    22

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

    23

#

    24

# dump jsonservice into urlpatterns:

    25

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

    26

    27

    28

class JSONRPCService(JSONRPCServiceBase):

    29

    30

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

    31

        return self.process(request.raw_post_data)

    32

    33

    34

def jsonremote(service):

    35

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

    36

    37

    from jsonrpc import JSONRPCService

    38

    chatservice = JSONRPCService()

    39

    40

    @jsonremote(chatservice)

    41

    def login(request, user_name):

    42

        (...)

    43

    """

    44

    def remotify(func):

    45

        if isinstance(service, JSONRPCService):

    46

            service.add_method(func.__name__, func)

    47

        else:

    48

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

    49

            raise NotImplementedError(emsg)

    50

        return func

    51

    return remotify

    52

    53

    54

# FormProcessor provides a mechanism for turning Django Forms into JSONRPC

    55

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

    56

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

    57

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

    58

#

    59

# class SimpleForm(forms.Form):

    60

#     testfield = forms.CharField(max_length=100)

    61

#

    62

# class SimpleForm2(forms.Form):

    63

#     testfield = forms.CharField(max_length=20)

    64

#

    65

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

    66

#                            'processsimpleform2': SimpleForm2})

    67

#

    68

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

    69

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

    70

# part of the app:

    71

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

    72

    73

    74

def builderrors(form):

    75

    d = {}

    76

    for error in form.errors.keys():

    77

        if error not in d:

    78

            d[error] = []

    79

        for errorval in form.errors[error]:

    80

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

    81

    return d

    82

    83

    84

# contains the list of arguments in each field

    85

field_names = {

    86

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

    87

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

    88

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

    89

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

    90

 'DateField': ['input_formats'],

    91

 'DateTimeField': ['input_formats'],

    92

 'TimeField': ['input_formats'],

    93

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

    94

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

    95

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

    96

 'ChoiceField': ['choices'],

    97

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

    98

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

    99

 }

   100

   101

   102

def describe_field_errors(field):

   103

    res = {}

   104

    field_type = field.__class__.__name__

   105

    msgs = {}

   106

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

   107

        msgs[n] = unicode(m)

   108

    res['error_messages'] = msgs

   109

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

   110

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

   111

    return res

   112

   113

   114

def describe_fields_errors(fields, field_names):

   115

    res = {}

   116

    if not field_names:

   117

        field_names = fields.keys()

   118

    for name in field_names:

   119

        field = fields[name]

   120

        res[name] = describe_field_errors(field)

   121

    return res

   122

   123

   124

def describe_field(field):

   125

    res = {}

   126

    field_type = field.__class__.__name__

   127

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

   128

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

   129

        res[fname] = getattr(field, fname)

   130

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

   131

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

   132

    return res

   133

   134

   135

def describe_fields(fields, field_names):

   136

    res = {}

   137

    if not field_names:

   138

        field_names = fields.keys()

   139

    for name in field_names:

   140

        field = fields[name]

   141

        res[name] = describe_field(field)

   142

    return res

   143

   144

   145

class FormProcessor(JSONRPCService):

   146

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

   147

   148

        if _formcls is None:

   149

            JSONRPCService.__init__(self)

   150

            for k in forms.keys():

   151

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

   152

                self.add_method(k, s.__process)

   153

        else:

   154

            JSONRPCService.__init__(self, forms)

   155

            self.formcls = _formcls

   156

   157

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

   158

   159

        f = self.formcls(params)

   160

   161

        if command is None:  # just validate

   162

            if not f.is_valid():

   163

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

   164

            return {'success': True}

   165

   166

        elif 'describe_errors' in command:

   167

            field_names = command['describe_errors']

   168

            return describe_fields_errors(f.fields, field_names)

   169

   170

        elif 'describe' in command:

   171

            field_names = command['describe']

   172

            return describe_fields(f.fields, field_names)

   173

   174

        elif 'save' in command:

   175

            if not f.is_valid():

   176

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

   177

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

   178

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

   179

   180

        elif 'html' in command:

   181

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

   182

   183

        return "unrecognised command"

   184

   185

# The following is incredibly convenient for saving vast amounts of

   186

# coding, avoiding doing silly things like this:

   187

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

   188

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

   189

#                    ..... }

   190

#

   191

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

   192

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

   193

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

   194

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

   195

#

   196

# use as follows:

   197

#

   198

# jsonservice = JSONRPCService()

   199

#

   200

# @jsonremote(jsonservice)

   201

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

   202

#     l = SomeDjangoModelClass.objects.filter()

   203

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

   204

#

   205

# @jsonremote(jsonservice)

   206

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

   207

#     l = AnotherDjangoModelClass.objects.filter()

   208

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

   209

#

   210

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

   211

# list_some_model and list_another_model part of the django app:

   212

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

   213

   214

   215

def dict_datetimeflatten(item):

   216

    d = {}

   217

    for k, v in item.items():

   218

        k = str(k)

   219

        if isinstance(v, datetime.date):

   220

            d[k] = str(v)

   221

        elif isinstance(v, dict):

   222

            d[k] = dict_datetimeflatten(v)

   223

        else:

   224

            d[k] = v

   225

    return d

   226

   227

   228

def json_convert(l, fields=None):

   229

    res = []

   230

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

   231

        res.append(dict_datetimeflatten(item))

   232

    return res