Class: ICalPal::Event

Inherits:
Object
  • Object
show all
Includes:
ICalPal
Defined in:
lib/event.rb

Overview

Class representing items from the CalendarItem table

Constant Summary collapse

QUERY = 
<<~SQL
SELECT DISTINCT

Store.name AS account,
Store.type,

Calendar.color,
Calendar.title AS calendar,
Calendar.subcal_url,
Calendar.symbolic_color_name,

CAST(CalendarItem.end_date AS INT) AS end_date,
CAST(CalendarItem.orig_date AS INT) AS orig_date,
CAST(CalendarItem.start_date AS INT) AS start_date,
CAST(CalendarItem.end_date - CalendarItem.start_date AS INT) AS duration,
CalendarItem.all_day,
CalendarItem.availability,
CalendarItem.conference_url_detected,
CalendarItem.description AS notes,
CalendarItem.has_recurrences,
CalendarItem.invitation_status,
CalendarItem.orig_item_id,
CalendarItem.rowid,
CalendarItem.start_tz,
CalendarItem.status,
CalendarItem.summary AS title,
CalendarItem.unique_identifier,
CalendarItem.url,
CalendarItem.uuid,

json_group_array(DISTINCT CAST(ExceptionDate.date AS INT)) AS xdate,

json_group_array(DISTINCT Identity.display_name) AS attendees,

Location.address AS address,
Location.title AS location,

Recurrence.count,
CAST(Recurrence.end_date AS INT) AS rend_date,
Recurrence.frequency,
Recurrence.interval,
Recurrence.specifier,

min(Alarm.trigger_interval) AS trigger_interval

FROM Store

JOIN Calendar ON Calendar.store_id = Store.rowid
JOIN CalendarItem ON CalendarItem.calendar_id = Calendar.rowid

LEFT OUTER JOIN Location ON Location.rowid = CalendarItem.location_id
LEFT OUTER JOIN Recurrence ON Recurrence.owner_id = CalendarItem.rowid
LEFT OUTER JOIN ExceptionDate ON ExceptionDate.owner_id = CalendarItem.rowid
LEFT OUTER JOIN Alarm ON Alarm.calendaritem_owner_id = CalendarItem.rowid
LEFT OUTER JOIN Participant ON Participant.owner_id = CalendarItem.rowid
LEFT OUTER JOIN Identity ON Identity.rowid = Participant.identity_id

WHERE Store.disabled IS NOT 1

GROUP BY CalendarItem.rowid

ORDER BY CalendarItem.unique_identifier
SQL

Constants included from ICalPal

DOW, ITIME, NAME, VERSION

Instance Attribute Summary

Attributes included from ICalPal

#self

Instance Method Summary collapse

Methods included from ICalPal

call, #keys, load_data, nth, #to_csv, #to_xml, #values, #xmlify

Constructor Details

#initialize(obj) ⇒ Event #initialize(obj<DateTime>) ⇒ Event

Returns a new instance of Event.

Overloads:

  • #initialize(obj) ⇒ Event

    Parameters:

    • obj (SQLite3::ResultSet::HashWithTypesAndFields)
  • #initialize(obj<DateTime>) ⇒ Event

    Create a placeholder event for days with no events when using –sed

    Parameters:

    • obj (DateTime) 


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
 
# File 'lib/event.rb', line 72

def initialize(obj)
  # Placeholder for days with no events
  return @self = {
           $opts[:sep] => obj,
           'sdate' => obj,
           'placeholder' => true,
           'title' => 'Nothing.',
         } if DateTime === obj

  @self = {}
  obj.keys.each { |k| @self[k] = obj[k] }

  # Convert JSON arrays to Arrays
  @self['attendees'] = JSON.parse(obj['attendees'])
  @self['xdate'] = JSON.parse(obj['xdate']).map do |k|
    k = RDT.new(*Time.at(k + ITIME).to_a.reverse[4..]) if k
  end

  # Convert iCal dates to normal dates
  obj.keys.select { |i| i.end_with? '_date' }.each do |k|
    t = Time.at(obj[k] + ITIME) if obj[k]
    @self["#{k[0]}date"] = RDT.new(*t.to_a.reverse[4..], t.zone) if t
  end

  if @self['start_tz'] == '_float'
    tzoffset = Time.zone_offset($now.zone())

    @self['sdate'] = RDT.new(*(@self['sdate'].to_time - tzoffset).to_a.reverse[4..], $now.zone)
    @self['edate'] = RDT.new(*(@self['edate'].to_time - tzoffset).to_a.reverse[4..], $now.zone)
  end

  # Type of calendar event is from
  obj['type'] = EventKit::EKSourceType.find_index { |i| i[:name] == 'Subscribed' } if obj['subcal_url']
  type = EventKit::EKSourceType[obj['type']]

  @self['symbolic_color_name'] ||= @self['color']
  @self['type'] = type[:name]
end

Instance Method Details

#[](k) ⇒ Object

Standard accessor with special handling for age, availability, datetime, location, notes, status, title, and uid

Parameters:

  • k (String) —

    Key/property name



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
 
# File 'lib/event.rb', line 23

def [](k)
  case k
  when 'age' then           # pseudo-property
    @self['sdate'].year - @self['edate'].year

  when 'availability' then  # Integer -> String
    EventKit::EKEventAvailability.select { |k, v| v == @self['availability'] }.keys

  when 'datetime' then      # date[ at time[ - time]]
    unless $opts[:sd] || $opts[:days] == 1
      t = @self['sdate'].to_s
      t += ' at ' unless @self['all_day'].positive?
    end

    unless @self['all_day'] && @self['all_day'].positive? || @self['placeholder']
      t ||= ''
      t += "#{@self['sdate'].strftime($opts[:tf])}" if @self['sdate']
      t += " - #{@self['edate'].strftime($opts[:tf])}" unless $opts[:eed] || !@self['edate']
    end
    t

  when 'location' then      # location[ address]
    @self['location']? [ @self['location'], @self['address'] ].join(' ').chop : nil

  when 'notes' then         # \n -> :nnr
    @self['notes']? @self['notes'].strip.gsub(/\n/, $opts[:nnr]) : nil

  when 'sday' then        # pseudo-property
    ICalPal::RDT.new(*@self['sdate'].to_a[0..2])

  when 'status' then        # Integer -> String
    EventKit::EKEventStatus.select { |k, v| v == @self['status'] }.keys[0]

  when 'title' then         # title[ (age N)]
    @self['title'] + ((@self['calendar'] == 'Birthdays')? " (age #{self['age']})" : "")

  when 'uid' then           # for icalBuddy
    @self['UUID']

  else @self[k]
  end
end

#[]=(k, v) ⇒ Object

Standard accessor with special handling for sdate. Setting sdate will also set sday.

Parameters:

  • k (String) —

    Key/property name

  • v (Object) —

    Key/property value



13
14
15
16
 
# File 'lib/event.rb', line 13

def []=(k, v)
  @self[k] = v
  @self['sday'] = ICalPal::RDT.new(*self['sdate'].to_a[0..2]) if k == 'sdate'
end

#apply_frequency! ⇒ Object

Apply frequency and interval



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/event.rb', line 265

def apply_frequency!
  # Leave edate alone for birthdays to compute age
  dates = [ 'sdate' ]
  dates << 'edate' unless self['calendar'].include?('Birthday')

  dates.each do |d|
    case EventKit::EKRecurrenceFrequency[self['frequency'] - 1]
    when 'daily'   then self[d] +=  self['interval']
    when 'weekly'  then self[d] +=  self['interval'] * 7
    when 'monthly' then self[d] >>= self['interval']
    when 'yearly'  then self[d] >>= self['interval'] * 12
    else $log.error("Unknown frequency: #{self['frequency']}")
    end
  end if self['frequency'] && self['interval']
end

#clone ⇒ Object

Returns a deep clone of self.

Returns:

  • a deep clone of self



195
196
197
 
# File 'lib/event.rb', line 195

def clone()
  Marshal.load(Marshal.dump(self))
end

#get_occurrences(changes) ⇒ Array<IcalPal::Event>

Get next occurences of a recurring event from a specifier

Parameters:

  • changes (Array) —

    Recurrence changes for the event

Returns:

  • (Array<IcalPal::Event>) 


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
 
# File 'lib/event.rb', line 203

def get_occurrences(changes)
  occurrences = []

  dow = DOW.keys
  dom = [ nil ]
  moy = 1..12
  nth = nil

  specifier = self['specifier']? self['specifier'] : []

  # Deconstruct specifier
  specifier.split(';').each do |k|
    j = k.split('=')

    # D=Day of the week, M=Day of the month, O=Month of the year, S=Nth
    case j[0]
    when 'D' then dow = j[1].split(',')
    when 'M' then dom = j[1].split(',')
    when 'O' then moy = j[1].split(',')
    when 'S' then nth = j[1].to_i
    else $log.warn("Unknown specifier: #{k}")
    end
  end

  # Build array of DOWs
  dows = [ nil ]
  dow.each { |d| dows.push(DOW[d[-2..-1].to_sym]) }

  # Months of the year (O)
  moy.each do |m|
    next unless m

    nsdate = RDT.new(self['sdate'].year, m.to_i, 1)
    nedate = RDT.new(self['edate'].year, m.to_i, 1)

    # Days of the month (M)
    dom.each do |x|
      next unless x

      self['sdate'] = RDT.new(nsdate.year, nsdate.month, x.to_i)
      self['edate'] = RDT.new(nedate.year, nedate.month, x.to_i)
      occurrences.push(clone)
    end

    # Days of the week (D)
    if nth
      self['sdate'] = ICalPal.nth(nth, dows, nsdate)
      self['edate'] = ICalPal.nth(nth, dows, nedate)
      occurrences.push(clone)
    else
      if dows[0]
        self['sdate'] = RDT.new(nsdate.year, m.to_i, nsdate.wday)
        self['edate'] = RDT.new(nedate.year, m.to_i, nedate.wday)
        occurrences.push(clone)
      end
    end
  end

  return(occurrences)
end

#in_window?(s, e = s) ⇒ Boolean

Check if an event starts or ends between from and to, or if it’s running now (for -n)

Parameters:

  • s (RDT) —

    Event start

  • e (RDT) (defaults to: s) —

    Event end

Returns:

  • (Boolean) 


287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/event.rb', line 287

def in_window?(s, e = s)
  if $opts[:n] then
    if ($now >= s && $now < e) then
      $log.debug("now: #{s} to #{e} vs. #{$now}")
      return(true)
    else
      $log.debug("not now: #{s} to #{e} vs. #{$now}")
      return(false)
    end
  else
    if ([ s, e ].max >= $opts[:from] && s < $opts[:to]) then
      $log.debug("in window: #{s} to #{e} vs. #{$opts[:from]} to #{$opts[:to]}")
      return(true)
    else
      $log.debug("not in window: #{s} to #{e} vs. #{$opts[:from]} to #{$opts[:to]}")
      return(false)
    end
  end
end

#non_recurring ⇒ Array<Event>

Check non-recurring events

Returns:

  • (Array<Event>) —

    If an event spans multiple days, the return value will contain a unique ICalPal::Event for each day that falls within our window



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/event.rb', line 116

def non_recurring
  events = []

  nDays = (self['duration'] / 86400).to_i

  # Sanity checks
  return events if nDays > 100000

  # Repeat for multi-day events
  (nDays + 1).times do |i|
    break if self['sdate'] > $opts[:to]

    $log.debug("multi-day event #{i + 1}") if (i > 0)

    self['daynum'] = i + 1
    events.push(clone) if in_window?(self['sdate'])

    self['sdate'] += 1
    self['edate'] += 1
  end

  events
end

#recurring ⇒ Array<Event>

Check recurring events

Returns:

  • (Array<Event>) —

    All occurrences of a recurring event that are within our window



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
 
# File 'lib/event.rb', line 144

def recurring
  stop = [ $opts[:to], (self['rdate'] || $opts[:to]) ].min

  # See if event ends before we start
  if stop < $opts[:from] then
    $log.debug("#{stop} < #{$opts[:from]}")
    return(Array.new)
  end

  # Get changes to series
  changes = [ { 'orig_date' => -1 } ]
  changes += $rows.select { |r| r['orig_item_id'] == self['ROWID'] }

  events = []
  count = 1

  while self['sdate'] <= stop
    # count
    break if self['count'].positive? and count > self['count']
    count += 1

    # Handle specifier or clone self
    if self['specifier'] and self['specifier'].length.positive?
      occurrences = get_occurrences(changes)
    else
      occurrences = [ clone ]
    end

    # Check for changes
    occurrences.each do |occurrence|
      changes.each do |change|
        next if change['orig_date'] == self['sdate'].to_i - ITIME
        events.push(occurrence) if in_window?(occurrence['sdate'], occurrence['edate'])
      end
    end

    break if self['specifier']
    apply_frequency!
  end

  # Remove exceptions
  events.delete_if { |event| event['xdate'].any?(event['sdate']) }

  return(events)
end