class Cinch::User
@attr_reader [String] authname @attr_reader [String, nil] away The user's away message, or
`nil` if not away.
@attr_reader [Array<Channel>] channels All channels the user is
in.
@attr_reader [String] host @attr_reader [Integer] idle How long this user has been idle, in seconds.
This is a snapshot of the last WHOIS.
@attr_reader [String] nick The user's nickname @attr_reader [Boolean] online True if the user is online. @attr_reader [Boolean] oper True if the user is an IRC
operator. @attr_reader [String] realname @attr_reader [Boolean] secure True if the user is using a secure
connection, i.e. SSL.
@attr_reader [Time] signed_on_at
@attr_reader [Boolean] unknown True if the instance references an user who
cannot be found on the server.
@attr_reader [String] user
@version 2.0.0
Attributes
By default, you can use methods like {#user}, {#host} and alike – If you however fear that another thread might change data while you're using it and if this means a critical issue to your code, you can store a clone of the result of this method and work with that instead.
@example
on :channel do |m| data = m.user.data.dup do_something_with(data.user) do_something_with(data.host) end
@return [Hash]
@return [Boolean] @api private
@return [String] @since 1.1.0
@return [Boolean]
@return [Boolean]
Public Class Methods
@note Generally, you shouldn't initialize new instances of this
class. Use {UserList#find_ensured} instead.
# File lib/cinch/user.rb, line 191 def initialize(*args) @data = { user: nil, host: nil, realname: nil, authname: nil, idle: 0, signed_on_at: nil, unknown?: false, online?: false, channels: [], secure?: false, away: nil, oper?: false, } case args.size when 2 @name, @bot = args when 4 @data[:user], @name, @data[:host], @bot = args else raise ArgumentError end @synced_attributes = Set.new @when_requesting_synced_attribute = lambda { |attr| unless attribute_synced?(attr) @data[:unknown?] = false unsync :unknown? refresh end } @monitored = false end
Public Instance Methods
@see Syncable#attr
Cinch::Syncable#attr
# File lib/cinch/user.rb, line 239 def attr(attribute, data = true, unsync = false) super end
Checks if the user is identified. Currently officially supports Quakenet and Freenode.
@return [Boolean] true if the user is identified @version 1.1.0
# File lib/cinch/user.rb, line 234 def authed? !attr(:authname).nil? end
# File lib/cinch/user.rb, line 59 def authname attr(:authname, true, false) end
@private
# File lib/cinch/user.rb, line 119 def authname_unsynced attr(:authname, true, true) end
# File lib/cinch/user.rb, line 63 def away attr(:away, true, false) end
# File lib/cinch/user.rb, line 88 def channels attr(:channels, true, false) end
@private
# File lib/cinch/user.rb, line 146 def channels_unsynced attr(:channels, true, true) end
Send data via DCC
SEND to a user.
@param [DCC::DCCableObject] io @param [String] filename @since 2.0.0 @return [void] @note This method blocks.
# File lib/cinch/user.rb, line 425 def dcc_send(io, filename = File.basename(io.path)) own_ip = bot.config.dcc.own_ip || @bot.irc.socket.addr[2] dcc = DCC::Outgoing::Send.new(receiver: self, filename: filename, io: io, own_ip: own_ip) dcc.start_server handler = Handler.new(@bot, :message, Pattern.new(/^/, /\001DCC RESUME #{filename} #{dcc.port} (\d+)\001/, /$/)) do |m, position| next unless m.user == self dcc.seek(position.to_i) m.user.send "\001DCC ACCEPT #{filename} #{dcc.port} #{position}\001" handler.unregister end @bot.handlers.register(handler) @bot.loggers.info "DCC: Outgoing DCC SEND: File name: %s - Size: %dB - IP: %s - Port: %d - Status: waiting" % [filename, io.size, own_ip, dcc.port] dcc.send_handshake begin dcc.listen @bot.loggers.info "DCC: Outgoing DCC SEND: File name: %s - Size: %dB - IP: %s - Port: %d - Status: done" % [filename, io.size, own_ip, dcc.port] rescue Timeout::Error @bot.loggers.info "DCC: Outgoing DCC SEND: File name: %s - Size: %dB - IP: %s - Port: %d - Status: failed (timeout)" % [filename, io.size, own_ip, dcc.port] ensure handler.unregister end end
@param [Hash, nil] values A hash of values gathered from WHOIS,
or `nil` if no data was returned
@return [void] @api private @since 1.0.1
# File lib/cinch/user.rb, line 278 def end_of_whois(values) @in_whois = false if values.nil? # for some reason, we did not receive user information. one # reason is freenode throttling WHOIS Thread.new do sleep 2 refresh end return end if values[:unknown?] sync(:unknown?, true, true) self.online = false sync(:idle, 0, true) sync(:channels, [], true) fields = @data.keys fields.delete(:unknown?) fields.delete(:idle) fields.delete(:channels) fields.each do |field| sync(field, nil, true) end return end if values[:registered] values[:authname] ||= nick values.delete(:registered) end { authname: nil, idle: 0, secure?: false, oper?: false, away: nil, channels: [], }.merge(values).each do |attr, value| sync(attr, value, true) end sync(:unknown?, false, true) self.online = true end
# File lib/cinch/user.rb, line 51 def host attr(:host, true, false) end
@private
# File lib/cinch/user.rb, line 109 def host_unsynced attr(:host, true, true) end
# File lib/cinch/user.rb, line 67 def idle attr(:idle, true, false) end
@private
# File lib/cinch/user.rb, line 124 def idle_unsynced attr(:idle, true, true) end
@return [String]
# File lib/cinch/user.rb, line 340 def inspect "#<User nick=#{@name.inspect}>" end
Generates a mask for the user.
@param [String] s a pattern for generating the mask.
- %n = nickname - %u = username - %h = host - %r = realname - %a = authname
@return [Mask]
# File lib/cinch/user.rb, line 355 def mask(s = "%n!%u@%h") s = s.gsub(/%(.)/) do case Regexp.last_match(1) when "n" @name when "u" user when "h" host when "r" realname when "a" authname end end Mask.new(s) end
Check if the user matches a mask.
@param [Ban, Mask
, User
, String] other The user or mask to match against @return [Boolean]
# File lib/cinch/user.rb, line 378 def match(other) Mask.from(other) =~ Mask.from(self) end
Starts monitoring a user's online state by either using MONITOR or periodically running WHOIS.
@since 2.0.0 @return [void] @see unmonitor
# File lib/cinch/user.rb, line 389 def monitor if @bot.irc.isupport["MONITOR"] > 0 @bot.irc.send "MONITOR + #{@name}" else refresh @monitored_timer = Timer.new(@bot, interval: 30) do refresh end @monitored_timer.start end @monitored = true end
# File lib/cinch/user.rb, line 30 def nick name end
@note This attribute will be updated by various events, but unless {#monitor} is being used, this information cannot be ensured to be always correct.
# File lib/cinch/user.rb, line 83 def online attr(:online?, true, false) end
Updates the user's online state and dispatch the correct event.
@since 2.0.0 @return [void] @api private
# File lib/cinch/user.rb, line 464 def online=(bool) notify = __send__("online?_unsynced") != bool && @monitored sync(:online?, bool, true) return unless notify if bool @bot.handlers.dispatch(:online, nil, self) else @bot.handlers.dispatch(:offline, nil, self) end end
@private
# File lib/cinch/user.rb, line 140 def online_unsynced attr(:online?, true, true) end
@since 2.1.0
# File lib/cinch/user.rb, line 98 def oper attr(:oper?, true, false) end
@private @since 2.1.0
# File lib/cinch/user.rb, line 158 def oper_unsynced attr(:oper?, true, true) end
# File lib/cinch/user.rb, line 55 def realname attr(:realname, true, false) end
@private
# File lib/cinch/user.rb, line 114 def realname_unsynced attr(:realname, true, true) end
Queries the IRC
server for information on the user. This will set the User's state to not synced. After all information are received, the object will be set back to synced.
@return [void] @note The alias `whois` is deprecated and will be removed in a
future version.
# File lib/cinch/user.rb, line 250 def refresh return if @in_whois @data.keys.each do |attr| unsync attr end @in_whois = true if @bot.irc.network.whois_only_one_argument? @bot.irc.send "WHOIS #{@name}" else @bot.irc.send "WHOIS #{@name} #{@name}" end end
# File lib/cinch/user.rb, line 92 def secure attr(:secure?, true, false) end
@private
# File lib/cinch/user.rb, line 151 def secure_unsynced attr(:secure?, true, true) end
# File lib/cinch/user.rb, line 71 def signed_on_at attr(:signed_on_at, true, false) end
@private
# File lib/cinch/user.rb, line 129 def signed_on_at_unsynced attr(:signed_on_at, true, true) end
@return [String]
# File lib/cinch/user.rb, line 335 def to_s @name end
# File lib/cinch/user.rb, line 75 def unknown attr(:unknown?, true, false) end
@private
# File lib/cinch/user.rb, line 134 def unknown_unsynced attr(:unknown?, true, true) end
Stops monitoring a user's online state.
@since 2.0.0 @return [void] @see monitor
# File lib/cinch/user.rb, line 408 def unmonitor if @bot.irc.isupport["MONITOR"] > 0 @bot.irc.send "MONITOR - #{@name}" else @monitored_timer&.stop end @monitored = false end
@return [void] @since 1.0.1 @api private @see Syncable#unsync_all
Cinch::Syncable#unsync_all
# File lib/cinch/user.rb, line 330 def unsync_all super end
Used to update the user's nick on nickchange events.
@param [String] new_nick The user's new nick @api private @return [void]
# File lib/cinch/user.rb, line 482 def update_nick(new_nick) @last_nick = @name @name = new_nick # Unsync authname because some networks tie authentication to # the nick, so the user might not be authenticated anymore after # changing their nick unsync(:authname) @bot.user_list.update_nick(self) end
# File lib/cinch/user.rb, line 47 def user attr(:user, true, false) end
@private
# File lib/cinch/user.rb, line 104 def user_unsynced attr(:user, true, true) end