lijab 0.1.1

data/lib/lijab/commands/contacts.rb

@@ -0,0 +1,101 @@
+
+module Lijab
+module Commands
+
+   module ContactsCommandMixin
+      SORTBY = ["status", "alpha"]
+
+      def completer(line)
+         sortby = line.split[1] || ""
+         if SORTBY.grep(sortby).empty?
+            SORTBY.grep(/^#{Regexp.escape(sortby)}/)
+         end
+      end
+
+      def group_contacts(contacts)
+         grouped = {}
+         contacts.each do |jid,contact|
+            groups = contact.roster_item.groups
+            if groups.empty?
+               (grouped["<no group>"] ||= []) << contact
+            else
+               groups.each { |g| (grouped[g] ||= []) << contact }
+            end
+         end
+
+         grouped = grouped.sort_by { |g,c| g }
+      end
+
+      def print_contacts(sort_by_status=false, online_only=false)
+         if sort_by_status
+            contacts = Main.contacts.sort { |a, b| -(a[1].presence <=> b[1].presence) }
+         else
+            contacts = Main.contacts.sort_by { |j,c| c.simple_name }
+         end
+
+         if Config.opts[:show_groups_in_contact_list]
+            grouped = group_contacts(contacts)
+         else
+            grouped = {nil => contacts.map { |j,c| c }}
+         end
+
+         s = []
+         grouped.each do |group, contactz|
+            if online_only
+               next unless contactz.any? { |c| c.online? }
+            end
+
+            s << " #{group} ".on_blue if group
+            contactz.each do |contact|
+               unless online_only && !contact.online?
+                  main = contact.presence
+                  s << "* #{contact.simple_name} #{main.pretty(true)} " \
+                     "(#{main.priority || 0}) [#{main.from || contact.jid}]"
+
+                  if online_only && contact.roster_item.presences.length > 1
+                     contact.roster_item.presences.each do |p|
+                        if p.from != main.from
+                           s << "    #{p.from} #{p.pretty(true)} (#{p.priority || 0})"
+                        end
+                     end
+                  end
+               end
+            end
+         end
+
+         Out::put(s.join("\n")) unless s.empty?
+      end
+
+   end
+
+   Command.define :contacts do
+      usage "/contacts [status|alpha]"
+      description "Show a list of all contacts. Sorted alphabetically or by status."
+
+      SORTBY = ["status", "alpha"]
+
+      def run(args)
+         print_contacts(args.split[0] == "status")
+      end
+
+      class << self
+         include ContactsCommandMixin
+      end
+   end
+
+   Command.define :who do
+      usage "/who [status|alpha]"
+      description "Show a list of online contacts. Sorted alphabetically or by status."
+
+      def run(args)
+         print_contacts(args.split[0] == "status", true)
+      end
+
+      class << self
+         include ContactsCommandMixin
+      end
+   end
+
+end
+
+end

data/lib/lijab/commands/options.rb

@@ -0,0 +1,49 @@
+
+module Lijab
+module Commands
+
+   Command.define :set do
+      usage "/set <option> [<value>]"
+      description "Modify the options. Print the current value if no <value> is given.\n" \
+                  "See #{Config.files[:config]} for the available options."
+      def run(args)
+         option, value = args.split(nil, 2).strip
+
+         option = option.to_sym if option
+
+         if !(Config.opts[option].is_a?(String) ||
+              Config.opts[option].is_a?(Numeric) ||
+              [true, false, nil].include?(Config.opts[option])) &&
+            Config.opts.key?(option)
+            raise CommandError, %{can't change "#{option} with /set"}
+         elsif !Config.opts.key?(option)
+            raise CommandError, %{no such option "#{option}"}
+         end
+
+         if value && !value.empty?
+            begin
+               val = YAML.load(value)
+               #raise TypeError unless val.is_a?(Config.opts[option].class)
+               Config.opts[option] = val
+            rescue
+               Out::error("invalid value", false)
+            end
+         else
+            Out::put(YAML.dump(Config.opts[option])[4..-1].chomp)
+         end
+
+      end
+
+      def completer(line)
+         option = line.split(nil, 2).strip[1] || ""
+         Config.opts.keys.find_all do |k|
+            k.to_s =~ /^#{Regexp.escape(option)}/ &&
+            (Config.opts[k].is_a?(String) ||
+             Config.opts[k].is_a?(Numeric) ||
+             [true, false, nil].include?(Config.opts[k]))
+         end
+      end
+   end
+
+end
+end

data/lib/lijab/commands/simple.rb

@@ -0,0 +1,132 @@
+
+module Lijab
+module Commands
+
+   Command.define :help do
+      usage "/help [<command> | commands]"
+      description "Get some help."
+
+      def run(args)
+         if args.empty?
+            s = %Q{
+               When in doubt, hit <tab>.
+
+               Some general hints:
+
+               Run "lijab -a <name>" to connect to the account named <name>.
+
+               Tab on an empty line will try to complete online contacts.
+               If there are no online contact matches for what you typed, offline contacts will also be
+               considered.
+
+               You can tab-complete specific resources of a contact by typing the contact name
+               followed by an @ character, e.g. somecontact@<tab> will complete all the available 
+               resources for the contact and a message can be sent to that specific resource.
+
+               Config/logs folder is at #{Config.basedir}
+
+               Put your custom commands in #{Config.dirs[:commands]}
+               Check out the files in <install-path>/lib/lijab/commands/ for some examples.
+
+               Put your custom hooks in #{Config.dirs[:hooks]}
+
+               Send mails to quuxbaz@gmail.com to complain about the lack of documentation :-)
+
+            }.gsub!(/^ */, '')
+            Out::put(s)
+         else
+            if args == "commands"
+               Out::put
+               Commands::registered.each do |name, cmd|
+                  Out::put(%{#{cmd.usage || "/#{name}"}}.magenta)
+                  Out::put("#{cmd.description}\n\n")
+               end
+            else
+               cmd = Commands::get(args)
+               if cmd
+                  s = "usage: #{cmd.usage}\n\n" if cmd.usage
+                  s = "#{s}#{cmd.description}"
+                  Out::put(s)
+               else
+                  raise CommandError, %(No such command "#{args}")
+               end
+            end
+         end
+      end
+
+      def completer(line)
+         help_cmd, rest = line.split(" ", 2)
+         rest ||= ""
+
+         m = "commands" =~ /^#{Regexp.escape(rest)}/ ? ["commands"] : []
+
+         rest = "/#{rest}"
+
+         m += Commands::completer(rest).map { |c| c[1..-1] } if rest.split(" ", 2).length == 1
+      end
+   end
+
+   Command.define :history do
+      usage "/history [<contact>] [<limit>]"
+      description "Show the message history with a <contact>, or all the contacts."
+
+      def run(args)
+         contact, limit = args.split(" ", 2).strip
+         limit ||= 10
+
+         if contact
+            raise CommandError, %(No contact named "#{contact}) unless Main.contacts.key?(contact)
+            m = Main.contacts[contact].history.last(limit.to_i)
+         else
+            m = HistoryHandler::last(limit.to_i)
+         end
+         Out::history(*m)
+      end
+
+      class << self
+         include ContactCompleterMixin
+      end
+   end
+
+   Command.define :multiline do
+      usage "/multiline <contact> [<first_line>]"
+      description "Enter multiline mode, meaning, send a multiline message to a contact.\n" \
+                  "Ctrl-d in an empty line exits multiline mode and sends the message."
+
+      def run(args)
+         contact, first_line = args.split(" ", 2).strip
+         first_line = "#{contact}: #{first_line}"
+         InputHandler::multiline(true, first_line)
+      end
+
+      class << self
+         include ContactCompleterMixin
+      end
+   end
+
+   Command.define :quit do
+      usage "/quit"
+      description "Quit lijab"
+
+      def run(args)
+         Main.quit
+      end
+   end
+
+   # TODO: make a generic option changer?
+   Command.define :show_status_changes do
+      usage "/show_status_changes yes|no"
+      description "Enable/disable printing the contacts' status changes. Can get quite spammish."
+
+      def run(args)
+         if !args || args.empty?
+            Out::put(Config.opts[:show_status_changes] ? "yes" : "no")
+         else
+            Config.opts[:show_status_changes] = args.strip == "yes"
+         end
+      end
+   end
+
+end
+end
+

data/lib/lijab/commands/status.rb

@@ -0,0 +1,63 @@
+
+module Lijab
+module Commands
+
+   Command.define :priority do
+      usage "/priority [<priority>]"
+      description "Change the jabber priority. Number must be between -127 and 127.\n" \
+                  "Show current priority if no argument is given."
+
+      def run(args)
+         if args.strip.empty?
+            Out::put("Current priority is #{Main.presence.priority}")
+            return
+         end
+
+         begin
+            p = Integer(args)
+         rescue ArgumentError
+            raise Commands::CommandError, %{"#{args}" is not a valid integer}
+         end
+
+         raise Commands::CommandError, "priority must be between -127 and 127" unless (-127..127).include?(p)
+
+         Main.set_priority(p)
+      end
+   end
+
+   Command.define :status do
+      usage "/status [available|away|chat|xa|dnd|invisible] [<message>]"
+      description "Set your status.\n" \
+                  "If no status is given, keep the current and set the status message.\n" \
+                  "If no message is given, keep the current status and clear the message.\n" \
+                  "If no arguments are given, print the current status."
+
+      STATUSES = ["available", "away", "chat", "xa", "dnd", "invisible"]
+
+      def run(args)
+         status, message = args.split(" ", 2).strip
+
+         unless status
+            p = Main.presence
+            Out::put("#{Config.jid} (#{p.priority || 0}) #{p.pretty(true)}")
+            return
+         end
+
+         unless STATUSES.include?(status)
+            message = "#{status} #{message}".strip
+            status = nil
+         end
+
+         Main.set_status(status && status.to_sym, message)
+      end
+
+      def completer(line)
+         status = line.split[1] || ""
+         if STATUSES.grep(status).empty?
+            STATUSES.grep(/^#{Regexp.escape(status)}/)
+         end
+      end
+   end
+
+end
+end

data/lib/lijab/commands/subscription.rb

@@ -0,0 +1,78 @@
+
+module Lijab
+module Commands
+   Command.define :add do
+      usage "/add <user@server>"
+      description "Add a user to your roster."
+
+      def run(args)
+         Main.contacts.add(args)
+         Out::put("subscription request sent to #{args}")
+      end
+   end
+
+   Command.define :remove do
+      usage "/remove <user@server>"
+      description "Remove a user from your roster."
+      
+      def run(args)
+         unless Main.contacts.remove(args)
+            raise CommandError, "no contact found for #{args}"
+         end
+      end
+
+      class << self
+         include ContactCompleterMixin
+      end
+   end
+
+   # TODO: <user@server | all>
+   Command.define :requests do
+      usage "/requests [accept|accept_and_add|decline <user@server>]"
+      description "Accept/decline a user's request to see your status.\n" \
+                  "Print pending requests if no argument given." \
+
+      ACTIONS = ["accept", "accept_and_add", "decline"]
+
+      def run(args)
+         action, addr = args.split(nil, 2).strip
+
+         if action
+            unless ACTIONS.include?(action)
+               raise CommandError, "action must be accept, accept_and_add or decline"
+            end
+            raise CommandError, "need the user's address" unless addr and !addr.empty?
+
+            if ["accept", "accept_and_add"].include?(action)
+               success = Main.contacts.process_request(addr, :accept)
+               Main.contacts.add(addr) if success && action == "accept_and_add"
+            else
+               success = Main.contacts.process_request(addr, :decline)
+            end
+
+            raise CommandError, "no pending request from #{addr}" unless success
+         else
+            if Main.contacts.has_subscription_requests?
+               Out::put("pending requests from:")
+               Out::put(Main.contacts.subscription_requests.join("\n"))
+            else
+               Out::put("no pending requests")
+            end
+         end
+      end
+
+      def completer(line)
+         _, action, addr = line.split(nil, 3)
+
+         if !addr
+            ACTIONS.grep(/^#{Regexp.escape(action)}/)
+         elsif addr && ACTIONS.include?(action)
+            Main.contacts.subscription_requests.grep(/^#{Regexp.escape(addr)}/).map do |c|
+               "#{action} #{c}"
+            end
+         end
+      end
+   end
+
+end
+end

data/lib/lijab/config.rb

@@ -0,0 +1,174 @@
+
+module Lijab
+
+module Config
+   module_function
+
+   def init(args)
+      @opts = {}
+      @dirs = {}
+      @files = {}
+      @accounts = []
+      @account = nil
+
+      setup_basedir(args[:basedir])
+      read_accounts(args[:account])
+      read_options()
+
+      @jid = Jabber::JID.new("#{@account[:jabberid]}")
+      @jid.resource ||= "lijab#{(0...5).map{rand(10).to_s}.join}"
+      @account[:server] ||= @jid.domain
+
+      create_account_dirs()
+   end
+
+   def setup_basedir(basedir)
+      # xdg? meh
+      #xdg = ENV["XDG_CONFIG_HOME"]
+      #xdg && File.join(xdg, "lijab") ||
+
+      @basedir = basedir ||
+                 ENV["LIJABDIR"] ||
+                 "~/.lijab"
+      @basedir = File.expand_path(@basedir)
+
+      unless File.directory?(@basedir)
+         puts "Creating #{@basedir} with the default configs"
+      end
+
+      %w{accounts commands hooks}.each do |d|
+         @dirs[d.to_sym] = path = File.join(@basedir, d)
+         FileUtils.mkdir_p(path)
+      end
+
+      @files[:accounts] = path = File.join(@basedir, "accounts.yml")
+      File.open(path, 'w') { |f| f.puts(DEFAULT_ACCOUNTS_FILE) } unless File.file?(path)
+
+      @files[:config] = File.join(@basedir, "config.yml")
+      dump_config_file(true)
+   end
+
+   def dump_config_file(default=false, clobber=false)
+      if !File.file?(@files[:config]) || clobber
+         File.open(@files[:config], 'w') do |f|
+            DEFAULT_OPTIONS.each do |a|
+               if a[2]
+                  f.puts
+                  a[2].each { |l| f.puts("# #{l}") }
+               end
+               v = default ? a[1] : @opts[a[0]]
+               f.puts(YAML.dump({a[0] => v})[5..-1].chomp)
+            end
+         end
+      end
+   end
+
+   def read_accounts(account)
+      File.open(@files[:accounts]) do |f|
+         YAML.load_documents(f) { |a| @accounts << a }
+      end
+
+      errors = []
+      errors << "need at least one account!" if @accounts.empty?
+
+      @accounts.each do |a|
+         a[:port] ||= a[:use_ssl] ? 5223 : 5222
+
+         errors << "account #{a} needs a name" unless a.key?(:name)
+         errors << "account #{a[:name] || a} needs a jabberid" unless a.key?(:jabberid)
+      end
+
+      @account = account ? @accounts.find { |a| a[:name] == account} : @accounts[0]
+
+      errors << "no account with name #{account} in #{@accounts_file}" if account && !@account
+
+      errors.each do |e|
+         STDERR.puts("#{File.basename($0)}: error: #{e}")
+      end
+
+      exit(1) unless errors.empty?
+   end
+
+   def read_options
+      # FIXME: error check / validate
+
+      @opts = Hash[*DEFAULT_OPTIONS.collect { |a| [a[0], a[1]] }.flatten]
+      @opts.merge!(YAML.load_file(@files[:config]))
+   end
+
+   def create_account_dirs
+      @accounts.each do |a|
+         a[:dir] = File.join(@dirs[:accounts], @jid.strip.to_s)
+         a[:log_dir] = File.join(a[:dir], "logs")
+         a[:typed] = File.join(a[:dir], "typed_history")
+
+         [:dir, :log_dir].each { |s| FileUtils.mkdir_p(a[s]) }
+      end
+   end
+
+   DEFAULT_OPTIONS = [
+      [:datetime_format, "%H:%M:%S", ["Time formatting (leave empty to disable timestamps)"]],
+      [:history_datetime_format, "%Y-%b-%d %H:%M:%S"],
+      [:autocomplete_online_first, true, 
+       ["When completing contacts try to find matches for online contacts, and if none",
+        "is found try to find matches on all of them. Otherwise always match every",
+        "contact."]],
+      [:show_status_changes, true, ["Show changes in contacts' status"]],
+      [:show_groups_in_contact_list, false, ["Group contacts in contact list"]],
+      [:ctrl_c_quits, false,
+       ["ctrl+c quits the program if enabled, otherwise ctrl+c ignores whatever is",
+        "typed and you get a clean prompt, and ctrl+d on a clean line exits lijab,",
+        "terminal style."]],
+      [:terminal_bell_on_message, true,
+       ["Ring the terminal bell on incoming message.",
+        "Useful for setting the urgent hint on the terminal window:",
+        "Set as so in your ~/.Xdefaults, might have to run xrdb -merge ~/.Xdefaults afterwards",
+        "XTerm*bellIsUrgent: true",
+        "or",
+        "URxvt*urgentOnBell: true",
+        "or just look it up on your terminal's man page, don't be lazy."]],
+      [:status_priorities,
+       {:chat => 55, :available => 50, :away => 40, :xa => 30, :dnd => 20},
+       ["Default priority for each status"]],
+      [:aliases, {"/h" => "/history", "/exit" => "/quit"},
+       ["Command aliases.",
+        "<command_alias> : <existing_command>",
+        "Commands can be overloaded.",
+        "For instance /who could be redefined like so to sort by status by default.",
+        "/who : /who status"]]
+   ]
+
+   DEFAULT_ACCOUNTS_FILE = %Q{
+      # Accounts go here. Separate each one with ---
+      # First one is the default.
+
+      #---
+      #:name : an_account                  # the account name
+      #:jabberid : fisk@example.com/lijab  # the resource is optional
+      #:password : frosk                   # optional, will prompt if not present
+      #:server : localhost                 # optional, will use the jid domain if not present
+      #:port : 5222                        # optional
+      #:use_ssl : no                       # deprecated in jabber, but might help sometimes
+      #:log : yes                          # yes|no ; default no
+
+      #---
+      #:name : another_account
+      #:jabberid : another_user@example.com/lijab
+
+      #---
+      #:name : gmail_account
+      #:jabberid : blah@gmail.com/lijab
+      #:server : talk.google.com
+      ## might wanna try use_ssl if the normal settings don't work (e.g. in ubuntu afaik)
+      ##:port : 5223
+      ##:use_ssl : yes
+      #:log : yes
+
+   }.gsub!(/^ */, '')
+
+   attr_reader     :jid, :account, :basedir, :dirs, :files, :opts
+   module_function :jid, :account, :basedir, :dirs, :files, :opts
+end
+
+end
+