summaryrefslogtreecommitdiffstats
path: root/aconf/model/field.lua
blob: f1236aaa80fb9b0c2079b338fefbc968c672089b (plain) (blame)
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
--[[
Copyright (c) 2012-2016 Kaarle Ritvanen
See LICENSE file for license details
--]]

--- @module aconf.model
local M = {}

local err = require('aconf.error')
local raise = err.raise

local node = require('aconf.model.node')

local object = require('aconf.object')
local class = object.class
local super = object.super

local util = require('aconf.util')
local map = util.map
local setdefaults = util.setdefaults
local update = util.update


M.Member = class()

function M.Member:init(params)
   for k, v in pairs(params or {}) do
      if self[k] == nil then self[k] = v end
   end
end

function M.Member:auto_ui_name(name)
   if not name then return end
   if type(name) ~= 'string' then return tostring(name) end
   local res = (name:sub(1, 1):upper()..name:sub(2)):gsub('-', ' ')
   return res
end

function M.Member:meta(context)
   return {
      name=self.name,
      description=self.description,
      ['ui-name']=self.ui_name or self:auto_ui_name(self.name)
   }
end


function M.normalize_name(name) return name:gsub('_', '-') end

function M.conv_filter(filter)
   if not filter then return end
   local res = {}
   for k, v in pairs(filter) do
      res[M.normalize_name(k)] = type(v) == 'table' and v or {v}
   end
   return res
end


M.Field = class(M.Member)

function M.Field:init(params)
   if not params then params = {} end
   setdefaults(
      params, {addr=params.compute and node.null_addr or nil, visible=true}
   )

   super(self, M.Field):init(params)

   for _, param in ipairs{'compute', 'store', 'editable'} do
      local func = self[param]
      if func then
	 if type(func) == 'string' then
	    local method = func
	    function func(obj, ...) return obj[method](obj, ...) end
	 end
	 if type(func) == 'function' then
	    self[param] = function(obj, ...)
	       return func(node.escalate(obj), ...)
	    end
	 end
      end
   end

   self.condition = M.conv_filter(self.condition)

   if self.choice then
      self.choice = map(
	 function(choice)
	    if type(choice) ~= 'table' then choice = {choice} end
	    for i, k in ipairs{'value', 'ui-value'} do
	       if choice[i] then
		  assert(not choice[k])
		  choice[k] = choice[i]
		  choice[i] = nil
	       end
	    end
	    return setdefaults(
	       choice,
	       {
		  be_value=choice.value,
		  enabled=true,
		  ['ui-value']=self:auto_ui_name(choice.value)
	       }
	    )
	 end,
	 self.choice
      )
   end

   if not self.widget then
      self.widget = self.choice and 'combobox' or 'field'
   end
end

function M.Field:_editable(context)
   if self.editable == nil then
      if not self.visible then return false end
      if self.store or not self.compute then return true end
      if self.compute then return self:_compute(context) == nil end
      return false
   end

   if type(self.editable) == 'function' then
      return self.editable(context.parent) and true or false
   end

   return self.editable
end

function M.Field:_choice(context) return self.choice end

function M.Field:meta(context)
   assert(self.dtype)
   local choice = self:_choice(context)
   return update(
      super(self, M.Field):meta(context),
      {
	 type=self.dtype,
	 visible=self.visible,
	 editable=self:_editable(context) and
	    node.has_permission(context.parent, 'modify'),
	 condition=self.condition,
	 required=self.required,
	 default=self.default,
	 choice=choice and map(
	    function(ch)
	       ch = util.copy(ch)
	       ch.be_value = nil
	       return ch
	    end,
	    choice
	 ),
	 widget=self.widget,
	 detail=self.detail
      }
   )
end

function M.Field:topology(context)
   return {
      {
	 path=context.path,
	 addr=context.addr,
	 be_mode=self.be_mode,
	 type=self.dtype
      }
   }
end

function M.Field:load(context)
   if not context.txn then return setmetatable({}, context) end
   local value = self:_load(context)
   if value == nil and self.compute then value = self:_compute(context) end
   if value == nil then return self.default end
   return value
end

function M.Field:_compute(context)
   return self.compute(context.parent, context.txn)
end

function M.Field:_load(context)
   local value = context.txn:get(context.addr)
   if value ~= nil then return self:decode(context, value) end
end

function M.Field:decode(context, value) return value end

function M.Field:_validate(context, value)
   if value == nil then
      self:check_required(context)
      return
   end

   value = self:normalize(context, value)

   local committing = context.txn:committing()
   local choice = self:_choice(context)
   local be_value
   if choice then
      for _, ch in ipairs(choice) do
	 if ch.value == value and (committing or ch.enabled) then
	    be_value = ch.be_value
	    break
	 end
      end
      if be_value == nil then raise(context.path, 'Invalid value') end
   end

   self:validate(context, value)

   if choice then return be_value end
   return value
end

function M.Field:check_required(context)
   if self.required then raise(context.path, 'Required value not set') end
end

function M.Field:normalize(context, value) return value end

function M.Field:validate(context, value) end

function M.Field:save(context, value)
   if not (context.privileged or self:_editable(context)) then
      raise(context.path, 'Is not editable')
   end

   if self.store then self.store(context.parent, value, context.txn)
   else self:_save(context, self:_validate(context, value)) end
end

function M.Field:_save(context, value)
   if value ~= nil then value = self:encode(context, value) end
   context.txn:set(context.addr, value)
end

function M.Field:encode(context, value) return value end

function M.Field:validate_saved(context)
   if self:_editable(context) then self:save(context, self:load(context)) end
end


local Primitive = class(M.Field)

function Primitive:_load(context)
   local value = super(self, Primitive):_load(context)
   if value == nil then return end

   local choice = self:_choice(context)
   if not choice then return value end

   for _, ch in ipairs(choice) do
      if ch.be_value == value then return ch.value end
   end
   assert(false)
end

function Primitive:validate(context, value)
   local t = self.dtype
   if type(value) ~= t then raise(context.path, 'Not a '..t) end
end


--- string field.
-- @fcons String
M.String = class(Primitive)

function M.String:init(params)
   super(self, M.String):init(params)
   self.dtype = 'string'
end

function M.String:validate(context, value)
   super(self, M.String):validate(context, value)
   if self['max-length'] and value:len() > self['max-length'] then
      raise(context.path, 'Maximum length exceeded')
   end
   if self.pattern and not value:match('^'..self.pattern..'$') then
      raise(context.path, 'Invalid value')
   end
end

function M.String:meta(context)
   local res = super(self, M.String):meta(context)
   res['max-length'] = self['max-length']
   return res
end


M.Number = class(Primitive)

function M.Number:init(params)
   super(self, M.Number):init(params)
   self.dtype = 'number'
end

function M.Number:normalize(context, value)
   return value and tonumber(value) or value
end

function M.Number:validate(context, value)
   super(self, M.Number):validate(context, value)
   if self.min and value < self.min then
      raise(context.path, 'Minimum value is '..self.min)
   end
   if self.max and value > self.max then
      raise(context.path, 'Maximum value is '..self.max)
   end
end


M.Integer = class(M.Number)

function M.Integer:validate(context, value)
   super(self, M.Integer):validate(context, value)
   if math.floor(value) ~= value then raise(context.path, 'Not an integer') end
end


--- boolean field.
-- @fcons Boolean
M.Boolean = class(Primitive)

function M.Boolean:init(params)
   super(self, M.Boolean):init(params)
   self.dtype = 'boolean'
   self.widget = 'checkbox'
end


M.TreeNode = class(M.Field)

function M.TreeNode:init(params)
   super(self, M.TreeNode):init(
      setdefaults(params, {detail=true, widget='link'})
   )
   self.iparams = {}
end

function M.TreeNode:topology(context)
   local res = super(self, M.TreeNode):topology(context)
   res[1].subtype = res[1].type
   res[1].type = 'table'
   util.extend(res, node.topology(self:load(context, {create=true})))
   return res
end

function M.TreeNode:load(context, options)
   if context.txn and not (
      util.setdefault(
	 options or {}, 'create', self.create
      ) or self:_load(context)
   ) then return end
   local res = self.itype(
      context, update({editable=self:_editable(context)}, self.iparams)
   )
   return node.has_permission(res, 'read') and res or nil
end

function M.TreeNode:save(context, value)
   local path = context.path

   if value == path then return end
   if type(value) == 'string' then
      value = node.fetch(context.parent, value)
   end
   if object.isinstance(value, node.TreeNode) and node.path(value) == path then
      return
   end

   self:_save(context)

   if value then
      if type(value) ~= 'table' then
	 raise(path, 'Cannot assign primitive value')
      end

      self:_save(context, {})
      local new = self:load(context, {create=true})

      local errors = err.ErrorDict()
      for k, v in pairs(value) do
	 errors:collect(self.save_member, new, k, v)
      end
      errors:raise()

      return new
   end
end

function M.TreeNode.save_member(node, k, v) node[k] = v end

function M.TreeNode:validate_saved(context)
   if self:load(context) == nil then self:check_required(context) end
end


--- model field. The value of this field is a [model
-- object](#Model_objects) conforming to the specified model. A model
-- field with default parameters is implicitly created when a model is
-- used in lieu of a field.
-- @fcons Model
-- @param model (<i>[&lt;Model&gt;](#new)</i>) model describing the
-- structure of the model objects
M.Model = class(M.TreeNode)

function M.Model:init(params)
   super(self, M.Model):init(params)

   assert(self.model)
   self.itype = self.model
   self.dtype = 'model'
end

function M.Model:save(context, value)
   local new = super(self, M.Model):save(context, value)
   if new then node.check_permission(new, 'create') end
end


return M