Module: Termtter::Client

Defined in:
lib/plugins/l2.rb,
lib/plugins/me.rb,
lib/plugins/sl.rb,
lib/plugins/fib.rb,
lib/plugins/log.rb,
lib/plugins/say.rb,
lib/plugins/bomb.rb,
lib/plugins/cool.rb,
lib/plugins/exec.rb,
lib/plugins/clear.rb,
lib/plugins/devel.rb,
lib/plugins/grass.rb,
lib/plugins/group.rb,
lib/plugins/shell.rb,
lib/plugins/timer.rb,
lib/plugins/wassr.rb,
lib/plugins/yhara.rb,
lib/plugins/yonda.rb,
lib/plugins/filter.rb,
lib/plugins/hatebu.rb,
lib/plugins/ignore.rb,
lib/plugins/otsune.rb,
lib/plugins/otsune.rb,
lib/plugins/primes.rb,
lib/plugins/random.rb,
lib/plugins/reblog.rb,
lib/plugins/scrape.rb,
lib/plugins/history.rb,
lib/plugins/outputz.rb,
lib/plugins/retweet.rb,
lib/plugins/reverse.rb,
lib/plugins/storage.rb,
lib/termtter/client.rb,
lib/plugins/addspace.rb,
lib/plugins/countter.rb,
lib/plugins/open_url.rb,
lib/plugins/uri-open.rb,
lib/plugins/quicklook.rb,
lib/plugins/fib_filter.rb,
lib/plugins/multi_post.rb,
lib/plugins/search_url.rb,
lib/plugins/typable_id.rb,
lib/plugins/auto_reload.rb,
lib/plugins/multi_reply.rb,
lib/plugins/switch_user.rb,
lib/plugins/command_plus.rb,
lib/plugins/command_plus.rb,
lib/plugins/screen-notify.rb,
lib/plugins/system_status.rb,
lib/plugins/update_editor.rb,
lib/plugins/expand-tinyurl.rb,
lib/plugins/list_with_opts.rb,
lib/plugins/direct_messages.rb,
lib/plugins/hatebu_and_update.rb,
lib/plugins/standard_commands.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.commands ⇒ Object (readonly)

Returns the value of attribute commands.



29
30
31
 
# File 'lib/termtter/client.rb', line 29

def commands
  @commands
end

.hooks ⇒ Object (readonly)

Returns the value of attribute hooks.



29
30
31
 
# File 'lib/termtter/client.rb', line 29

def hooks
  @hooks
end

Class Method Details

.add_filter(&b) ⇒ Object 



46
47
48
49
 
# File 'lib/termtter/client.rb', line 46

def add_filter(&b)
  warn "add_filter method will be removed. Use Termtter::Client.register_hook(:name => ..., :point => :filter_for_output, :exec => ... ) instead."
  @filters << b
end

.add_task(*arg, &block) ⇒ Object 



196
197
198
 
# File 'lib/termtter/client.rb', line 196

def add_task(*arg, &block)
  @task_manager.add_task(*arg, &block)
end

.alias_command(arg) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/plugins/command_plus.rb', line 12

def alias_command(arg)
  original, new = arg.split(/\s+/)
  if @commands[original.to_sym]
    @commands[new.to_sym] = @commands[original.to_sym].clone
    @commands[new.to_sym].name    = new.to_sym
    @commands[new.to_sym].aliases = []
    @commands[new.to_sym].help    = ''
    puts "alias '#{original}' to '#{new}'."
  else
    raise "#{original} command is not found."
  end
end

.apply_filters_for_hook(hook_name, statuses, event) ⇒ Object 



138
139
140
141
142
143
 
# File 'lib/termtter/client.rb', line 138

def apply_filters_for_hook(hook_name, statuses, event)
  get_hooks(hook_name).each do |hook|
    statuses = hook.call(statuses, event)
  end
  statuses
end

.call_commands(text) ⇒ Object

Raises:



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
 
# File 'lib/termtter/client.rb', line 155

def call_commands(text)
  return if text.empty?

  commands = find_commands(text)
  raise CommandNotFound, text if commands.empty?

  commands.each do |command|
    command_found = true
    command_str, command_arg = Command.split_command_line(text)

    modified_arg = call_hooks(
                      "modify_arg_for_#{command.name.to_s}",
                      command_str,
                      command_arg) || command_arg || ''

    @task_manager.invoke_and_wait do
      begin
        call_hooks("pre_exec_#{command.name.to_s}", command, modified_arg)
        # exec command
        result = command.call(command_str, modified_arg, text)
        if result
          call_hooks("post_exec_#{command.name.to_s}", command_str, modified_arg, result)
        end
      rescue CommandCanceled
      end
    end
  end
end

.call_hooks(point, *args) ⇒ Object

return last hook return value



146
147
148
149
150
151
152
153
 
# File 'lib/termtter/client.rb', line 146

def call_hooks(point, *args)
  result = nil
  get_hooks(point).each {|hook|
    break if result == false # interrupt if hook return false
    result = hook.call(*args)
  }
  result
end

.clear_command ⇒ Object 



89
90
91
 
# File 'lib/termtter/client.rb', line 89

def clear_command
  @commands.clear
end

.clear_filter ⇒ Object 



51
52
53
 
# File 'lib/termtter/client.rb', line 51

def clear_filter
  @filters.clear
end

.default_logger ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/termtter/client.rb', line 294

def default_logger
  logger = Logger.new(STDOUT)
  logger.formatter = lambda { |severity, time, progname, message|
    color =
      case severity
      when /^DEBUG/
        'blue'
      when /^INFO/
        'cyan'
      when /^WARN/
        'magenta'
      when /^ERROR/
        'red'
      when /^FATAL/
        'on_red'
      else
        'white'
      end
    TermColor.parse("<#{color}>" + TermColor.escape("[#{severity}] #{message}\n") + "</#{color}>")
  }
  logger
end

.delete_command(arg) ⇒ Object 



4
5
6
7
8
9
10
 
# File 'lib/plugins/command_plus.rb', line 4

def delete_command(arg)
  if @commands.delete(arg.to_sym)
    puts "#{arg} command is deleted."
  else
    raise "#{arg} command is not found."
  end
end

.exit ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/termtter/client.rb', line 200

def exit
  puts 'finalizing...'

  call_hooks(:exit)
  @task_manager.kill
  @input_thread.kill if @input_thread
end

.find_commands(text) ⇒ Object 



184
185
186
 
# File 'lib/termtter/client.rb', line 184

def find_commands(text)
  @commands.values.select { |command| command.match?(text) }
end

.find_filter_candidates(a, b, filters) ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'lib/plugins/filter.rb', line 49

def self.find_filter_candidates(a, b, filters)
  if a.empty?
    filters.to_a
  else
    filters.grep(/^#{Regexp.quote a}/i)
  end.
  map {|u| b % u }
end

.find_group_candidates(a, b) ⇒ Object 



19
20
21
22
23
 
# File 'lib/plugins/group.rb', line 19

def self.find_group_candidates(a, b)
  config.plugins.group.groups.keys.map {|k| k.to_s}.
    grep(/^#{Regexp.quote a}/).
    map {|u| b % u }
end

.find_plugin_candidates(a, b) ⇒ Object

Termtter reply command

== Usage
=== list
* ステータスリストを連番と一緒に出す。
> reply [list|ls]
0: foo: foo's message
1: bar: bar's message
..

* ユーザ指定してリスト作成。
> reply [list|ls] foo
0: foo: foo's message0
1: foo: foo's message1

=== reply
メッセージ送信の際、@usernameが自動的に付与される。

* status_idを自分で入力してreply送信
> reply 1234567890 message to status_id
=> @foo message to status_id (reply to 1234567890)

* reply listコマンドで出したステータス番号に対してreply送信
> reply up 0 message to status no
=> @foo message to status_no

* 対象ユーザの最後の発言に対してreply
> reply @foo message to foo
=> @foo message to foo

== Todo
* 英語で説明 => ヘルプを設定する
* リファクタ
* 補完
* 確認画面を出したい



543
544
545
546
547
 
# File 'lib/plugins/standard_commands.rb', line 543

def self.find_plugin_candidates(a, b)
  public_storage[:plugins].
    grep(/^#{Regexp.quote a}/i).
    map {|u| b % u }
end

.find_status_ids(text) ⇒ Object 



549
550
551
 
# File 'lib/plugins/standard_commands.rb', line 549

def self.find_status_ids(text)
  public_storage[:status_ids].select {|id| /#{Regexp.quote(text)}/ =~ id.to_s}
end

.find_user_candidates(a, b) ⇒ Object 



557
558
559
560
561
562
563
564
565
 
# File 'lib/plugins/standard_commands.rb', line 557

def self.find_user_candidates(a, b)
  users = 
    if a.nil? || a.empty?
      public_storage[:users].to_a
    else
      public_storage[:users].grep(/^#{Regexp.quote a}/i)
    end
  users.map {|u| b % u }
end

.find_users(text) ⇒ Object 



553
554
555
 
# File 'lib/plugins/standard_commands.rb', line 553

def self.find_users(text)
  public_storage[:users].select {|user| /^#{Regexp.quote(text)}/ =~ user}
end

.formatted_help(helps) ⇒ Object 



366
367
368
369
370
371
372
373
 
# File 'lib/plugins/standard_commands.rb', line 366

def self.formatted_help(helps)
  helps = helps.sort_by {|help| help[0] }
  width = helps.map {|n, _| n.size }.max
  space = 3
  helps.map {|name, desc|
    name.to_s.ljust(width + space) + desc.to_s
  }.join("\n")
end

.get_command(name) ⇒ Object 



93
94
95
 
# File 'lib/termtter/client.rb', line 93

def get_command(name)
  @commands[name]
end

.get_group_of(screen_name) ⇒ Object 



25
26
27
 
# File 'lib/plugins/group.rb', line 25

def self.get_group_of(screen_name)
  config.plugins.group.groups.select{ |k, v| v.include? screen_name}.map{|a| a.first}
end

.get_hook(name) ⇒ Object 



67
68
69
 
# File 'lib/termtter/client.rb', line 67

def get_hook(name)
  @hooks[name]
end

.get_hooks(point) ⇒ Object 



71
72
73
74
75
 
# File 'lib/termtter/client.rb', line 71

def get_hooks(point)
  @hooks.values.select do |hook|
    hook.match?(point)
  end
end

.handle_error(e) ⇒ Object 



357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/termtter/client.rb', line 357

def handle_error(e)
  if logger
    logger.error("#{e.class.to_s}: #{e.message}")
    logger.error(e.backtrace.join("\n")) if config.devel
  else
    raise e
  end
  get_hooks(:on_error).each {|hook| hook.call(e) }
rescue Exception => e
  puts "Error: #{e}"
  puts e.backtrace.join("\n")
end

.init(&block) ⇒ Object 



317
318
319
 
# File 'lib/termtter/client.rb', line 317

def init(&block)
  @init_block = block
end

.input_editor ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/plugins/update_editor.rb', line 14

def self.input_editor
  file = Tempfile.new('termtter')
  editor = config.plugins.update_editor.editor
  if config.plugins.update_editor.add_completion
    file.puts "\n"*100 + "__END__\n" + public_storage[:users].to_a.join(' ')
  end
  file.close
  system("#{editor} #{file.path}")
  result = file.open.read
  file.close(false)
  result
end

.legacy_config_support ⇒ Object 



217
218
219
220
221
222
223
224
 
# File 'lib/termtter/client.rb', line 217

def legacy_config_support
  case File.ftype(File.expand_path('~/.termtter'))
  when 'directory'
    # nop
  when 'file'
    move_legacy_config_file
  end
end

.load_config ⇒ Object 



208
209
210
211
212
213
214
215
 
# File 'lib/termtter/client.rb', line 208

def load_config
  legacy_config_support() if File.exist? Termtter::CONF_DIR
  unless File.exist?(Termtter::CONF_FILE)
    require 'termtter/config_setup'
    ConfigSetup.run
  end
  load Termtter::CONF_FILE
end

.load_history ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/plugins/history.rb', line 17

def self.load_history
  filename = File.expand_path(config.plugins.history.filename)
  keys = config.plugins.history.keys

  if File.exist?(filename)
    begin
      history = Marshal.load Zlib::Inflate.inflate(File.read(filename))
    end
    if history
      keys.each do |key|
        public_storage[key] = history[key] if history[key]
      end
      Readline::HISTORY.push *history[:history] if history[:history]
      puts "history loaded(#{File.size(filename)/1000}kb)"
    end
  end
end

.logger ⇒ Object 



286
287
288
 
# File 'lib/termtter/client.rb', line 286

def logger
  @logger
end

.move_legacy_config_file ⇒ Object 



226
227
228
229
230
231
232
233
234
 
# File 'lib/termtter/client.rb', line 226

def move_legacy_config_file
  FileUtils.mv(
    Termtter::CONF_DIR,
    File.expand_path('~/.termtter___'))
  Dir.mkdir(Termtter::CONF_DIR)
  FileUtils.mv(
    File.expand_path('~/.termtter___'),
    Termtter::CONF_FILE)
end

.open_uri(uri) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/plugins/open_url.rb', line 6

def self.open_uri(uri)
  unless config.plugins.open_url.browser.empty?
    system config.plugins.open_url.browser, uri
  else
    case RUBY_PLATFORM
    when /linux/
      system 'firefox', uri
    when /mswin(?!ce)|mingw|bccwin/
      system 'explorer', uri
    else
      system 'open', uri
    end
  end
end

.output(statuses, event) ⇒ Object

statuses => [status, status, …] status => {

  :id => status id,
  :created_at => created time,
  :user_id => user id,
  :name => user name,
  :screen_name => user screen_name,
  :source => source,
  :reply_to => reply_to status id,
  :text => status,
  :original_data => original data,
}



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

def output(statuses, event)
  return if statuses.nil? || statuses.empty?

  statuses = statuses.sort_by{|s|s.id}
  call_hooks(:pre_filter, statuses, event)

  filtered = statuses.map(&:dup)
  @filters.each do |f|  # TODO: code for compatibility. delete someday.
    statuses = f.call(statuses, event)
  end
  apply_filters_for_hook(:filter_for_output, statuses, event)

  call_hooks(:post_filter, filtered, event)
  get_hooks(:output).each do |hook|
    hook.call(
      apply_filters_for_hook("filter_for_#{hook.name}", filtered, event),
      event
    )
  end
end

.pause ⇒ Object 



188
189
190
 
# File 'lib/termtter/client.rb', line 188

def pause
  @task_manager.pause
end

.plug(name, options = {}) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/termtter/client.rb', line 31

def plug(name, options = {})
  unless options.empty?
    options.each do |key, value|
      config.plugins.__refer__(name.to_sym).__assign__(key.to_sym, value)
    end
  end
  load "plugins/#{name}.rb"
rescue Exception => e
  Termtter::Client.handle_error(e)
end

.post_retweet(s) ⇒ Object 



6
7
8
9
10
 
# File 'lib/plugins/retweet.rb', line 6

def self.post_retweet(s)
  text = ERB.new(config.plugins.retweet.format).result(binding)
  Termtter::API.twitter.update(text)
  puts "=> #{text}"
end

.public_storage ⇒ Object 



42
43
44
 
# File 'lib/termtter/client.rb', line 42

def public_storage
  @public_storage ||= {}
end

.register_command(arg) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/termtter/client.rb', line 77

def register_command(arg)
  command = case arg
    when Command
      arg
    when Hash
      Command.new(arg)
    else
      raise ArgumentError, 'must be given Termtter::Command or Hash'
    end
  @commands[command.name] = command
end

.register_hook(arg) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/termtter/client.rb', line 55

def register_hook(arg)
  hook = case arg
    when Hook
      arg
    when Hash
      Hook.new(arg)
    else
      raise ArgumentError, 'must be given Termtter::Hook or Hash'
    end
  @hooks[hook.name] = hook
end

.register_macro(name, macro, options = {}) ⇒ Object 



97
98
99
100
101
102
103
 
# File 'lib/termtter/client.rb', line 97

def register_macro(name, macro, options = {})
  command = {
    :name => name.to_sym,
    :exec_proc => lambda {|arg| call_commands(macro % arg)}
  }.merge(options)
  register_command(command)
end

.resume ⇒ Object 



192
193
194
 
# File 'lib/termtter/client.rb', line 192

def resume
  @task_manager.resume
end

.run ⇒ Object 



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
 
# File 'lib/termtter/client.rb', line 321

def run
  load_config()
  Termtter::API.setup()
  setup_logger()

  @init_block.call(self) if @init_block

  unless @init_block  # compatibility for old style config file
    plug 'stdout'
    plug 'standard_commands'
    plug 'auto_reload'
  end

  plug 'devel' if config.devel

  config.system.load_plugins.each do |plugin|
    plug plugin
  end

  config.system.eval_scripts.each do |script|
    begin
      eval script
    rescue Exception => e
      handle_error(e)
    end
  end

  config.system.run_commands.each { |cmd| call_commands(cmd) }

  unless config.system.cmd_mode
    call_hooks(:initialize)
    @task_manager.run()
    start_input_thread()
  end
end

.save_history ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/plugins/history.rb', line 35

def self.save_history
  filename = File.expand_path(config.plugins.history.filename)
  keys = config.plugins.history.keys
  history = { }
  keys.each do |key|
    history[key] = public_storage[key]
  end
  max_of_history = config.plugins.history.max_of_history
  history[:history] = Readline::HISTORY.to_a.reverse.uniq.reverse
  if history[:history].size > max_of_history
    history[:history] = history[:history][-max_of_history..-1]
  end

  File.open(filename, 'w') do |f|
    f.write Zlib::Deflate.deflate(Marshal.dump(history))
  end
  puts "history saved(#{File.size(filename)/1000}kb)"
end

.scrape_group(group) ⇒ Object 



14
15
16
17
 
# File 'lib/plugins/scrape.rb', line 14

def self.scrape_group(group)
  members = config.plugins.group.groups[group] || []
  scrape_members(members)
end

.scrape_members(members) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/plugins/scrape.rb', line 5

def self.scrape_members(members)
  statuses = []
  members.each_with_index do |member, index|
    puts "member #{index+1}/#{members.size} #{member}"
    statuses += Termtter::API.twitter.user_timeline(member)
  end
  statuses
end

.setup_logger ⇒ Object 



290
291
292
 
# File 'lib/termtter/client.rb', line 290

def setup_logger
  @logger = config.logger || default_logger
end

.setup_readline ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/termtter/client.rb', line 236

def setup_readline
  if Readline.respond_to?(:basic_word_break_characters=)
    Readline.basic_word_break_characters= "\t\n\"\\'`><=;|&{("
  end
  Readline.completion_proc = lambda {|input|
    begin
      @commands.map {|name, command| command.complement(input) }.flatten.compact
    rescue => e
      handle_error(e)
    end
  }
  vi_or_emacs = config.editing_mode
  unless vi_or_emacs.empty?
    Readline.__send__("#{vi_or_emacs}_editing_mode")
  end
end

.show_settings(conf, level = 0) ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/plugins/standard_commands.rb', line 290

def self.show_settings(conf, level = 0)
  conf.__values__.each do |k, v|
    if v.instance_of? Termtter::Config
      puts "#{k}:"
      show_settings v, level + 1
    else
      print '  ' * level
      puts "#{k} = #{v.nil? ? 'nil' : v.inspect}"
    end
  end
end

.start_input_thread ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/termtter/client.rb', line 267

def start_input_thread
  setup_readline()
  trap_setting()
  @input_thread = Thread.new do
    while buf = Readline.readline(ERB.new(config.prompt).result(API.twitter.__send__(:binding)), true)
      Readline::HISTORY.pop if buf.empty?
      begin
        call_commands(buf)
      rescue CommandNotFound => e
        warn "Unknown command \"#{e}\""
        warn 'Enter "help" for instructions'
      rescue => e
        handle_error e
      end
    end
  end
  @input_thread.join
end

.trap_setting ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/termtter/client.rb', line 253

def trap_setting()
  begin
    stty_save = `stty -g`.chomp
    trap("INT") do
      begin
        system "stty", stty_save
      ensure
        exit
      end
    end
  rescue Errno::ENOENT
  end
end

.typable_id?(id) ⇒ Boolean

Returns:

  • (Boolean) 


58
59
60
61
62
63
64
 
# File 'lib/plugins/typable_id.rb', line 58

def self.typable_id?(id)
  if public_storage[:typable_id].assoc(id.to_s)
    return true
  else
    return false
  end
end

.typable_id_convert(id) ⇒ Object 



39
40
41
42
43
44
45
46
47
 
# File 'lib/plugins/typable_id.rb', line 39

def self.typable_id_convert(id)
  if current_id = public_storage[:typable_id].assoc(id.to_s)
    return current_id[1]
  elsif current_id = public_storage[:typable_id].rassoc(id.to_s)
    return current_id[0]
  else
    return nil
  end
end

.typable_id_status(id) ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'lib/plugins/typable_id.rb', line 49

def self.typable_id_status(id)
  if current_id = (public_storage[:typable_id].assoc(id.to_s)||\
                   public_storage[:typable_id].rassoc(id.to_s))
    return current_id[2]
  else
    return nil
  end
end

.update_with_user_and_id(text, username, id) ⇒ Object 



499
500
501
502
503
504
 
# File 'lib/plugins/standard_commands.rb', line 499

def self.update_with_user_and_id(text, username, id)
  text = ERB.new("@#{username} #{text}").result(binding).gsub(/\n/, ' ')
  result = Termtter::API.twitter.update(text, {'in_reply_to_status_id' => id})
  puts "=> #{text}"
  result
end

.wassr_update(text) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/plugins/multi_post.rb', line 5

def wassr_update(text)
  Net::HTTP.version_1_2
  req = Net::HTTP::Post.new("/statuses/update.json?")
  req.basic_auth config.plugins.wassr.username, config.plugins.wassr.password
  Net::HTTP.start('api.wassr.jp', 80) do |http|
    res = http.request(req, "status=#{URI.escape(text)}&source=Termtter")
  end
end