Module: Canopus::Workspace::SessionPersistable

Defined in:
lib/canopus/workspace/session_persistable.rb

Instance Method Summary collapse

Instance Method Details

#restore_session(path) ⇒ Object 



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
 
# File 'lib/canopus/workspace/session_persistable.rb', line 60

def restore_session(path)
  data = JSON.parse(File.read(path))
  raise Error, "unsupported session" unless [1, 2].include?(data["version"]) && data["panes"].is_a?(Array) && data["panes"].length.between?(1, 100)
  records = data.fetch("buffers", {})
  raise Error, "invalid session buffers" unless records.is_a?(Hash) && records.length <= 10_000
  loaded, restored_buffers, restored_panes = {}, {}, []
  load_buffer = lambda do |id|
    return loaded[id] if loaded.key?(id)
    entry = records.fetch(id)
    raise Error, "invalid session buffer" unless entry.is_a?(Hash)
    if entry["excerpts"]
      excerpts = entry["excerpts"]
      raise Error, "invalid session excerpts" unless excerpts.is_a?(Array) && excerpts.length <= 10_000
      sources = excerpts.map do |excerpt|
        source_id = excerpt.fetch("buffer")
        raise Error, "nested or cyclic excerpt source" if records.fetch(source_id).key?("excerpts")
        source = load_buffer.call(source_id)
        raise Error, "excerpt source no longer exists" unless source
        first, last = excerpt.values_at("first", "last")
        raise Error, "invalid excerpt range" unless first.is_a?(Integer) && last.is_a?(Integer) && first <= last
        [source, first...last, excerpt["title"]]
      end
      buffer = MultiBuffer.new(excerpts: sources)
    elsif entry["draft"]
      buffer = Buffer.new(entry["draft"], path: entry["path"], draft: true, disk_digest: entry["digest"],
        encoding: Encoding.find(entry.fetch("encoding", "UTF-8")), bom: [entry.fetch("bom", "")].pack("H*"), read_only: entry.fetch("read_only", false))
    elsif entry["path"] && File.file?(entry["path"])
      buffer = Buffer.open(entry["path"])
    end
    load_persistent_undo(buffer) if buffer && buffer.path && !buffer.dirty?
    loaded[id] = buffer
    if buffer
      key = buffer.path ? canonical_path(buffer.path) : buffer.object_id
      if restored_buffers.key?(key)
        buffer.close
        raise Error, "duplicate session buffer path"
      end
      restored_buffers[key] = buffer
    end
    buffer
  end
  data["panes"].each do |saved|
    pane = Pane.new
    restored_panes << pane
    tabs = saved.fetch("tabs")
    raise Error, "invalid session tabs" unless tabs.is_a?(Array) && tabs.length <= 1000
    tabs.each do |tab|
      if data["version"] == 1
        tab["buffer_id"] = tab["path"] || "draft:#{tab.object_id}"
        records[tab["buffer_id"]] ||= tab
      end
      buffer = load_buffer.call(tab.fetch("buffer_id"))
      next unless buffer
      current = pane.open(buffer)
      current.language = definition_for(buffer.path)
      apply_editor_settings(current)
      if tab["selections"]
        selections = tab["selections"]
        raise Error, "invalid session selections" unless selections.is_a?(Array) && selections.length.between?(1, 10_000)
        selections.each_with_index do |selection, index|
          anchor, head = selection.values_at("anchor", "head")
          raise Error, "invalid session cursor" unless anchor.is_a?(Integer) && head.is_a?(Integer)
          current.select(anchor, head, add: index.positive?)
        end
      else
        begin
          current.select(tab.fetch("cursor", 0).clamp(0, buffer.rope.bytesize))
        rescue RangeError
          current.select(0)
        end
      end
      coordinates = [tab.fetch("scroll_x", 0), tab.fetch("scroll_y", 0)]
      raise Error, "invalid session scroll position" unless coordinates.all? { |value| value.is_a?(Numeric) && value.finite? && value >= 0 }
      current.scroll(dx: coordinates.first, dy: coordinates.last)
      pane.pin(current) if tab["pinned"]
    end
    pane.active_index = saved.fetch("active", 0).clamp(0, [pane.editors.length - 1, 0].max)
  end
  restored_layout = decode_layout(data.fetch("layout"), panes: restored_panes)
  layout_panes, pending = [], [restored_layout]
  until pending.empty?
    node = pending.pop
    node[:pane] ? layout_panes << node[:pane] : pending.concat(node[:children])
  end
  raise Error, "session layout must include each pane exactly once" unless layout_panes.length == restored_panes.length && layout_panes.uniq.length == restored_panes.length
  background = data.fetch("background_buffers", [])
  raise Error, "invalid background buffers" unless background.is_a?(Array) && background.length <= 10_000
  background.each { |id| load_buffer.call(id) }
  restored_docks = @docks.transform_values(&:dup)
  data.fetch("docks", {}).each do |side, value|
    next unless restored_docks.key?(side.to_sym)
    raise Error, "invalid session dock" unless value.is_a?(Hash) && [true, false].include?(value["visible"]) && value["size"].is_a?(Numeric) && value["size"].finite? && value["size"].positive?
    restored_docks[side.to_sym] = {visible: value["visible"], size: value["size"].clamp(40, 4000)}
  end
  restored_panels = data.fetch("panels", {})
  raise Error, "invalid session panels" unless restored_panels.is_a?(Hash) && restored_panels.length <= 1_000
  restored_panels.each do |id, value|
    next unless @panels.key?(id)
    valid = value.is_a?(Hash) && [true, false].include?(value["visible"]) &&
      value["size"].is_a?(Numeric) && value["size"].finite? && value["size"].positive?
    raise Error, "invalid session panel" unless valid
  end
  active = data.fetch("active_pane", 0)
  raise Error, "invalid active pane" unless active.is_a?(Integer) && active.between?(0, restored_panes.length - 1)
  terminal_records = validate_session_terminals(data) if @settings["terminal"]["restore_on_startup"]
  clear_vim_states
  close_language_documents
  @buffers.each_value { |buffer| detach_breakpoints(buffer) }
  @panes.each { |pane| pane.editors.each(&:dispose) }
  @buffers.each_value(&:close)
  @panels.restore(restored_panels, docks: restored_docks)
  @panels.hide("hierarchy") if @panels.key?("hierarchy")
  @panes, @buffers, @layout = restored_panes, restored_buffers, restored_layout
  @buffers.each_value { |buffer| attach_breakpoints(buffer) unless buffer.is_a?(MultiBuffer) }
  @active_pane = @panes[active]
  @recent_files = Array(data["recent_files"]).select { |item| item.is_a?(String) && File.file?(item) }.first(100)
  restore_terminals(data, terminal_records) if terminal_records
  self
rescue StandardError
  unless @panes.equal?(restored_panes)
    restored_panes&.each { |pane| pane.editors.each(&:dispose) }
    restored_buffers&.each_value(&:close)
  end
  raise
end

#save_session(path, max_draft_bytes: nil) ⇒ Object 



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
 
# File 'lib/canopus/workspace/session_persistable.rb', line 5

def save_session(path, max_draft_bytes: nil)
  records = {}
  record = lambda do |buffer|
    id = buffer.object_id.to_s
    return id if records.key?(id)
    entry = if buffer.is_a?(MultiBuffer)
      excerpts = buffer.excerpts.filter_map do |excerpt|
        source = record.call(excerpt.buffer)
        next unless source
        {buffer: source, first: excerpt.buffer.resolve(excerpt.first),
          last: excerpt.buffer.resolve(excerpt.last), title: excerpt.title}
      end
      next if excerpts.length != buffer.excerpts.length
      {excerpts: excerpts}
    else
      next if max_draft_bytes && (buffer.dirty? || !buffer.path) && buffer.rope.bytesize > max_draft_bytes
      {path: buffer.path, draft: buffer.dirty? || !buffer.path ? buffer.text : nil,
        digest: buffer.disk_digest, encoding: buffer.encoding.name, bom: buffer.bom.unpack1("H*"), read_only: buffer.read_only}
    end
    records[id] = entry
    id
  end
  state = {version: 2, root: @root, layout: encode_layout(@layout), recent_files: @recent_files || [],
    active_pane: @panes.index(@active_pane), docks: @docks, panels: @panels.state,
    terminals: @terminals.map do |current|
      cwd = current.respond_to?(:cwd) ? current.cwd : current.vt.cwd
      {cwd: cwd || (current.respond_to?(:initial_cwd) ? current.initial_cwd : @root), title: @terminal_names[current],
        profile: terminal_profile(current)}
    end,
    active_terminal: @active_terminal_index, terminal_layout: encode_terminal_layout(@terminal_layout),
    terminal_visible: terminal_visible,
    panes: @panes.map do |pane|
      {active: pane.active_index, tabs: pane.editors.filter_map do |current|
        buffer_id = record.call(current.buffer)
        next unless buffer_id
        {buffer_id: buffer_id, cursor: current.primary.head, pinned: pane.pinned.include?(current),
          selections: current.selections.map { |selection| {anchor: selection.anchor, head: selection.head} },
          scroll_x: current.scroll_x, scroll_y: current.scroll_y}
      end}
    end, buffers: records}
  state[:background_buffers] = @buffers.values.select(&:dirty?).filter_map { |buffer| record.call(buffer) }
  if max_draft_bytes && state[:panes][state[:active_pane]][:tabs].empty?
    state[:active_pane] = state[:panes].index { |pane| !pane[:tabs].empty? } || state[:active_pane]
  end
  FileUtils.mkdir_p(File.dirname(path))
  Tempfile.create([".session-", ".json"], File.dirname(path)) do |file|
    file.chmod(0o600)
    file.write(JSON.pretty_generate(state))
    file.flush
    file.fsync
    file.close
    File.rename(file.path, path)
  end
end