Class: Tilia::DavAcl::PrincipalBackend::Sequel

Inherits:
AbstractBackend show all
Includes:
CreatePrincipalSupport
Defined in:
lib/tilia/dav_acl/principal_backend/sequel.rb

Overview

PDO principal backend

This backend assumes all principals are in a single collection. The default collection is ‘principals/’, but this can be overriden.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sequel) ⇒ Sequel

Sets up the backend.

Parameters:

  • PDO —

    pdo



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 38

def initialize(sequel)
  @table_name = 'principals'
  @group_members_table_name = 'groupmembers'
  @field_map = {
    # This property can be used to display the users' real name.
    '{DAV:}displayname' => {
      'dbField' => 'displayname'
    },

    # This is the users' primary email-address.
    '{http://sabredav.org/ns}email-address' => {
      'dbField' => 'email'
    }
  }
  @sequel = sequel
end

Instance Attribute Details

#group_members_table_name ⇒ Object

PDO table name for ‘group members’



19
20
21
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 19

def group_members_table_name
  @group_members_table_name
end

#table_name ⇒ Object

PDO table name for ‘principals’



14
15
16
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 14

def table_name
  @table_name
end

Instance Method Details

#create_principal(path, mk_col) ⇒ Object

Creates a new principal.

This method receives a full path for the new principal. The mkCol object contains any additional webdav properties specified during the creation of the principal.

Parameters:

  • string —

    path

  • MkCol —

    mk_col

Returns:

  • void



348
349
350
351
352
353
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 348

def create_principal(path, mk_col)
  ds = @sequel["INSERT INTO #{@table_name} (uri) VALUES (?)", path]
  ds.insert

  update_principal(path, mk_col)
end

#find_by_uri(uri, principal_prefix) ⇒ Object

Finds a principal by its URI.

This method may receive any type of uri, but mailto: addresses will be the most common.

Implementation of this API is optional. It is currently used by the CalDAV system to find principals based on their email addresses. If this API is not implemented, some features may not work correctly.

This method must return a relative principal path, or null, if the principal was not found or you refuse to find it.

Parameters:

  • string —

    uri

  • string —

    principal_prefix

Returns:

  • string, nil



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 250

def find_by_uri(uri, principal_prefix)
  value = nil
  scheme = nil
  (scheme, value) = uri.split(":", 2)
  return nil unless value

  uri = nil
  case scheme
  when "mailto"
    @sequel.fetch("SELECT uri FROM #{@table_name} WHERE lower(email)=lower(?)", [value]) do |row|
      # Checking if the principal is in the prefix
      row_prefix = Http::UrlUtil.split_path(row[:uri]).first
      next unless row_prefix == principal_prefix

      uri = row[:uri]
      break # Stop on first match
    end
  else
    #unsupported uri scheme
    return nil
  end

  uri
end

#group_member_set(principal) ⇒ Object

Returns the list of members for a group-principal

Parameters:

  • string —

    principal

Returns:

  • array



279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 279

def group_member_set(principal)
  principal = principal_by_path(principal)
  fail Dav::Exception, 'Principal not found' if principal.empty?

  result = []
  @sequel.fetch("SELECT principals.uri as uri FROM #{@group_members_table_name} AS groupmembers LEFT JOIN #{@table_name} AS principals ON groupmembers.member_id = principals.id WHERE groupmembers.principal_id = ?", principal['id']) do |row|
    result << row[:uri]
  end

  result
end

#group_membership(principal) ⇒ Object

Returns the list of groups a principal is a member of

Parameters:

  • string —

    principal

Returns:

  • array



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 295

def group_membership(principal)
  principal = principal_by_path(principal)
  fail Dav::Exception, 'Principal not found' if principal.empty?

  result = []
  @sequel.fetch("SELECT principals.uri as uri FROM #{@group_members_table_name} AS groupmembers LEFT JOIN #{@table_name} AS principals ON groupmembers.principal_id = principals.id WHERE groupmembers.member_id = ?", principal['id']) do |row|
    result << row[:uri]
  end

  result
end

#principal_by_path(path) ⇒ Object

Returns a specific principal, specified by it’s path. The returned structure should be the exact same as from getPrincipalsByPrefix.

Parameters:

  • string —

    path

Returns:

  • array



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
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 104

def principal_by_path(path)
  fields = [
    'id',
    'uri'
  ]

  @field_map.each do |_key, value|
    fields << value['dbField']
  end

  ds = @sequel["SELECT #{fields.join(',')}  FROM #{@table_name} WHERE uri = ?", path]
  row = ds.all.first

  return unless row

  principal = {
    'id'  => row[:id],
    'uri' => row[:uri]
  }

  @field_map.each do |key, value|
    if row[value['dbField'].to_sym]
      principal[key] = row[value['dbField'].to_sym]
    end
  end

  principal
end

#principals_by_prefix(prefix_path) ⇒ Object

Returns a list of principals based on a prefix.

This prefix will often contain something like ‘principals’. You are only expected to return principals that are in this base path.

You are expected to return at least a ‘uri’ for every user, you can return any additional properties if you wish so. Common properties are:

{DAV:}displayname
{http://sabredav.org/ns}email-address - This is a custom SabreDAV
  field that's actualy injected in a number of other properties. If
  you have an email address, use this property.

Parameters:

  • string —

    prefix_path

Returns:

  • array



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
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 69

def principals_by_prefix(prefix_path)
  fields = ['uri']

  @field_map.each do |_key, value|
    fields << value['dbField']
  end

  principals = []
  @sequel.fetch("SELECT #{fields.join(',')} FROM #{@table_name}") do |row|
    # Checking if the principal is in the prefix
    row_prefix = Http::UrlUtil.split_path(row[:uri])[0]

    next unless row_prefix == prefix_path

    principal = {
      'uri' => row[:uri]
    }

    @field_map.each do |key, value|
      unless row[value['dbField'].to_sym].blank?
        principal[key] = row[value['dbField'].to_sym]
      end
    end
    principals << principal
  end

  principals
end

#search_principals(prefix_path, search_properties, test = 'allof') ⇒ Object

This method is used to search for principals matching a set of properties.

This search is specifically used by RFC3744’s principal-property-search REPORT.

The actual search should be a unicode-non-case-sensitive search. The keys in searchProperties are the WebDAV property names, while the values are the property values to search on.

By default, if multiple properties are submitted to this method, the various properties should be combined with ‘AND’. If test is set to ‘anyof’, it should be combined using ‘OR’.

This method should simply return an array with full principal uri’s.

If somebody attempted to search on a property the backend does not support, you should simply return 0 results.

You can also just return 0 results if you choose to not support searching at all, but keep in mind that this may stop certain features from working.

Parameters:

  • string —

    prefix_path

  • array —

    search_properties

  • string —

    test

Returns:

  • array



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
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 201

def search_principals(prefix_path, search_properties, test = 'allof')
  return [] if search_properties.empty? # No criteria

  query = "SELECT uri FROM #{@table_name} WHERE "
  values = []

  search_properties.each do |property, value|
    case property
    when '{DAV:}displayname'
      column = 'displayname'
    when '{http://sabredav.org/ns}email-address'
      column = 'email'
    else
      # Unsupported property
      return []
    end

    query += test == 'anyof' ? ' OR ' : ' AND ' if values.any?
    query += "lower(#{column}) LIKE lower(?)"
    values << "%#{value}%"
  end

  principals = []
  @sequel.fetch(query, *values) do |row|
    # Checking if the principal is in the prefix
    row_prefix = Http::UrlUtil.split_path(row[:uri])[0]
    next unless row_prefix == prefix_path

    principals << row[:uri]
  end

  principals
end

#update_group_member_set(principal, members) ⇒ Object

Updates the list of group members for a group principal.

The principals should be passed as a list of uri’s.

Parameters:

  • string —

    principal

  • array —

    members

Returns:

  • void



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 314

def update_group_member_set(principal, members)
  # Grabbing the list of principal id's.
  member_ids = []
  principal_id = nil

  @sequel.fetch("SELECT id, uri FROM #{@table_name} WHERE uri IN (?#{', ?' * members.size})", principal, *members) do |row|
    if row[:uri] == principal
      principal_id = row[:id]
    else
      member_ids << row[:id]
    end
  end

  fail Dav::Exception, 'Principal not found' unless principal_id

  # Wiping out old members
  ds = @sequel["DELETE FROM #{@group_members_table_name} WHERE principal_id = ?", principal_id]
  ds.delete

  member_ids.each do |member_id|
    ds = @sequel["INSERT INTO #{@group_members_table_name} (principal_id, member_id) VALUES (?, ?)", principal_id, member_id]
    ds.insert
  end
end

#update_principal(path, prop_patch) ⇒ Object

Updates one ore more webdav properties on a principal.

The list of mutations is stored in a SabreDAVPropPatch object. To do the actual updates, you must tell this object which properties you’re going to process with the handle method.

Calling the handle method is like telling the PropPatch object “I promise I can handle updating this property”.

Read the PropPatch documenation for more info and examples.

Parameters:

  • string —

    path

  • DAV\PropPatch —

    prop_patch



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
 
# File 'lib/tilia/dav_acl/principal_backend/sequel.rb', line 146

def update_principal(path, prop_patch)
  prop_patch.handle(
    @field_map.keys,
    lambda do |properties|
      query = "UPDATE #{@table_name} SET "

      first = true
      values = {}
      properties.each do |key, value|
        db_field = @field_map[key]['dbField']

        query << ', ' unless first
        first = false
        query << "#{db_field} = :#{db_field}"
        values[db_field.to_sym] = value
      end

      query << ' WHERE uri = :uri'
      values[:uri] = path

      ds = @sequel[query, values]
      ds.update

      true
    end
  )
end