Class: Imap::Backup::Serializer::Imap

Inherits:
Object
  • Object
show all
Defined in:
lib/imap/backup/serializer/imap.rb

Constant Summary collapse

CURRENT_VERSION = 
3

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(folder_path) ⇒ Imap

Returns a new instance of Imap.



16
17
18
19
20
21
22
23
 
# File 'lib/imap/backup/serializer/imap.rb', line 16

def initialize(folder_path)
  @folder_path = folder_path
  @loaded = false
  @uid_validity = nil
  @messages = nil
  @version = nil
  @tsx = nil
end

Instance Attribute Details

#folder_path ⇒ Object (readonly)

Returns the value of attribute folder_path.



13
14
15
 
# File 'lib/imap/backup/serializer/imap.rb', line 13

def folder_path
  @folder_path
end

#loaded ⇒ Object (readonly)

Returns the value of attribute loaded.



14
15
16
 
# File 'lib/imap/backup/serializer/imap.rb', line 14

def loaded
  @loaded
end

Instance Method Details

#append(uid, length, flags: []) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/imap/backup/serializer/imap.rb', line 67

def append(uid, length, flags: [])
  offset =
    if messages.empty?
      0
    else
      last_message = messages[-1]
      last_message.offset + last_message.length
    end

  messages << Serializer::Message.new(
    uid: uid, offset: offset, length: length, mbox: mbox, flags: flags
  )

  save
end

#delete ⇒ Object 



87
88
89
90
91
92
93
94
95
 
# File 'lib/imap/backup/serializer/imap.rb', line 87

def delete
  return if !exist?

  FileUtils.rm(pathname)
  @loaded = false
  @messages = nil
  @uid_validity = nil
  @version = nil
end

#exist? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/imap/backup/serializer/imap.rb', line 55

def exist?
  File.exist?(pathname)
end

#get(uid) ⇒ Object 



83
84
85
 
# File 'lib/imap/backup/serializer/imap.rb', line 83

def get(uid)
  messages.find { |m| m.uid == uid }
end

#messages ⇒ Object

Make private



119
120
121
122
 
# File 'lib/imap/backup/serializer/imap.rb', line 119

def messages
  ensure_loaded
  @messages
end

#pathname ⇒ Object 



51
52
53
 
# File 'lib/imap/backup/serializer/imap.rb', line 51

def pathname
  "#{folder_path}.imap"
end

#rename(new_path) ⇒ Object 



97
98
99
100
101
102
103
104
105
 
# File 'lib/imap/backup/serializer/imap.rb', line 97

def rename(new_path)
  if exist?
    old_pathname = pathname
    @folder_path = new_path
    File.rename(old_pathname, pathname)
  else
    @folder_path = new_path
  end
end

#rollback ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/imap/backup/serializer/imap.rb', line 42

def rollback
  tsx.fail_outside_transaction!(:rollback)

  @messages = tsx.data[:savepoint][:messages]
  @uid_validity = tsx.data[:savepoint][:uid_validity]

  tsx.clear
end

#save ⇒ Object 



142
143
144
145
146
147
148
 
# File 'lib/imap/backup/serializer/imap.rb', line 142

def save
  return if tsx.in_transaction?

  ensure_loaded

  save_internal(version: version, uid_validity: uid_validity, messages: messages)
end

#transaction(&block) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/imap/backup/serializer/imap.rb', line 25

def transaction(&block)
  tsx.fail_in_transaction!(:transaction, message: "nested transactions are not supported")

  ensure_loaded
  # rubocop:disable Lint/RescueException
  tsx.begin({savepoint: {messages: messages.dup, uid_validity: uid_validity}}) do
    block.call

    save_internal(version: version, uid_validity: uid_validity, messages: messages) if tsx.data
  rescue Exception => e
    Logger.logger.error "#{self.class} handling #{e.class}"
    rollback
    raise e
  end
  # rubocop:enable Lint/RescueException
end

#uid_validity ⇒ Object 



107
108
109
110
 
# File 'lib/imap/backup/serializer/imap.rb', line 107

def uid_validity
  ensure_loaded
  @uid_validity
end

#uid_validity=(value) ⇒ Object 



112
113
114
115
116
 
# File 'lib/imap/backup/serializer/imap.rb', line 112

def uid_validity=(value)
  ensure_loaded
  @uid_validity = value
  save
end

#uids ⇒ Object

Deprecated



125
126
127
 
# File 'lib/imap/backup/serializer/imap.rb', line 125

def uids
  messages.map(&:uid)
end

#update_uid(old, new) ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/imap/backup/serializer/imap.rb', line 129

def update_uid(old, new)
  index = messages.find_index { |m| m.uid == old }
  return if index.nil?

  messages[index].uid = new
  save
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
62
63
64
65
 
# File 'lib/imap/backup/serializer/imap.rb', line 59

def valid?
  return false if !exist?
  return false if version != CURRENT_VERSION
  return false if !uid_validity

  true
end

#version ⇒ Object 



137
138
139
140
 
# File 'lib/imap/backup/serializer/imap.rb', line 137

def version
  ensure_loaded
  @version
end