Skip to content
Navigation Menu
{{ message }}
forked from weechat/scripts
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathkeepnick.py
More file actions
231 lines (202 loc) · 11.2 KB
/
Copy pathkeepnick.py
File metadata and controls
231 lines (202 loc) · 11.2 KB
1
2
3
4
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
59
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# -*- coding: utf-8 -*-
#
# Copyright (c) 2012-2014 by nils_2 <weechatter@arcor.de>
# Copyright (c) 2006 by EgS <i@egs.name>
#
# script to keep your nick and recover it in case it's occupied
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# 2014-10-30: nils_2 (freenode.#weechat)
# 1.2 : support of regular expression for server option (idea by michele)
#
# 2013-09-17: nils_2 (freenode.#weechat)
# 1.1 : format of weechat_string_eval_expression() changed
#
# 2013-07-29: nils_2 (freenode.#weechat)
# 1.0 : support of /secure for passwords
#
# 2013-01-29: nils_2 (freenode.#weechat)
# 0.9 : script optimized
#
# 2013-01-27: nils_2 (freenode.#weechat)
# 0.8 : make script compatible with Python 3.x
#
# 2012-10-05: nils_2, (freenode.#weechat)
# 0.7 : add options "plugins.var.python.keepnick.nickserv", "plugins.var.python.keepnick.<server>.password"
# : changed default "delay" value from 60 to 600 seconds.
#
# 2012-10-04: nils_2, (freenode.#weechat)
# 0.6 : fix bug with case-sensitive nicks (reported by Faethor)
#
# 2012-02-08: nils_2, (freenode.#weechat)
# 0.5 : sync with 0.3.x API (requested by CAHbI4)
#
# requires: WeeChat version 0.3.4
#
# Development is currently hosted at
# https://github.com/weechatter/weechat-scripts
#
#######################################################################
# #
# This script enables the user to keep their nicks and recover it in #
# case it get's stolen. It uses the servers prefered nicks, so there #
# is no need for any kind of setup. #
# #
# Name: Keepnick #
# Licence: GPL v2 #
# Author: Marcus Eggenberger <i@egs.name> #
#
# Changelog: #
# 0.4: now starts on load and features user defined check intervals #
# 0.3: Fixed major bug with continuous nickchanges #
# 0.2: Fixed Bug: now only checks connected servers #
# 0.1: first version released #
# #
#######################################################################
try:
from string import Template
import weechat,sys,re
except Exception:
print("This script must be run under WeeChat.")
print("Get WeeChat now at: http://www.weechat.org/")
quit()
# -------------------------------[ Constants ]-------------------------------------
SCRIPT_NAME = "keepnick"
SCRIPT_AUTHOR = "nils_2 <weechatter@arcor.de>"
SCRIPT_VERSION = "1.2"
SCRIPT_LICENCE = "GPL3"
SCRIPT_DESC = "keep your nick and recover it in case it's occupied"
ISON = '/ison %s'
OPTIONS = { 'delay' : ('600','delay (in seconds) to look at occupied nick (0 means OFF). It is not recommended to flood the server with /ison requests)'),
'timeout' : ('60','timeout (in seconds) to wait for an answer from server.'),
'serverlist' : ('','comma separated list of servers to look at. Try to register a nickname on server (see: /msg NickServ help).regular expression are allowed (eg. ".*" = matches ALL server,"freen.*" = matches freenode, freenet....)'),
'text' : ('Nickstealer left Network: %s!','text that will be displayed if your nick will not be occupied anymore. (\"%s\" is a placeholder for the servername)'),
'nickserv' : ('/msg -server $server NICKSERV IDENTIFY $passwd','Use SASL authentification, if possible. This command will be used to IDENTIFY you on server (following placeholder can be used: \"$server\" for servername; \"$passwd\" for password. The password will be stored in a separate option for every single server: \"plugins.var.python.%s.<servername>.password\"). Using the "/secure" function, you\'ll have to add a format described in "/help secure" to password option (eg: ${sec.data.keepnick_freenode_password})' % SCRIPT_NAME),
'command' : ('/nick %s','This command will be used to rename your nick (\"%s\" will be filled with your nickname for specific server)'),
}
HOOK = { 'timer': '', 'redirect': '' }
serverlist = []
# ================================[ redirection ]===============================
# calling /ison all x seconds using hook:timer()
def ison(bufpointer,servername,nick,nicklist):
command = ISON % ' '.join(nicklist)
weechat.hook_hsignal_send('irc_redirect_command',
{ 'server': servername, 'pattern': 'ison', 'signal': SCRIPT_NAME, 'count': '1', 'string': servername, 'timeout': OPTIONS['timeout'], 'cmd_filter': '' })
weechat.hook_signal_send('irc_input_send', weechat.WEECHAT_HOOK_SIGNAL_STRING, '%s;;;;%s' % (servername,command))
def redirect_isonhandler(data, signal, hashtable):
if hashtable['output'] == '':
return weechat.WEECHAT_RC_OK
# ISON_nicks contains nicks that are online on server (separated with space)
# nicks in ISON_nicks are lowercase
message,ISON_nicks = hashtable['output'].split(':')[1:]
ISON_nicks = [nick.lower() for nick in ISON_nicks.split()]
for nick in server_nicks(hashtable['server']):
mynick = weechat.info_get('irc_nick',hashtable['server'])
if nick.lower() == mynick.lower():
return weechat.WEECHAT_RC_OK
elif nick.lower() not in ISON_nicks and nick != '':
# get password for given server (evaluated)
if int(version) >= 0x00040200:
password = weechat.string_eval_expression(weechat.config_get_plugin('%s.password' % hashtable['server']),{},{},{})
else:
password = weechat.config_get_plugin('%s.password' % hashtable['server'])
grabnick(hashtable['server'], nick) # get your nick back
if password != '' and OPTIONS['nickserv'] != '':
# command stored in "keepnick.nickserv" option
t = Template(OPTIONS['nickserv'])
run_msg = t.safe_substitute(server=hashtable['server'], passwd=password)
weechat.command('',run_msg)
return weechat.WEECHAT_RC_OK
# ================================[ functions ]===============================
# nicks used on server
def server_nicks(servername):
infolist = weechat.infolist_get('irc_server','',servername)
weechat.infolist_next(infolist)
nicks = weechat.infolist_string(infolist, 'nicks')
weechat.infolist_free(infolist)
return nicks.split(',')
def check_nicks(data, remaining_calls):
serverlist = OPTIONS['serverlist'].split(',')
infolist = weechat.infolist_get('irc_server','','')
while weechat.infolist_next(infolist):
servername = weechat.infolist_string(infolist, 'name')
ptr_buffer = weechat.infolist_pointer(infolist,'buffer')
nick = weechat.infolist_string(infolist, 'nick')
ssl_connected = weechat.infolist_integer(infolist,'ssl_connected')
is_connected = weechat.infolist_integer(infolist,'is_connected')
server_matched = re.search(r"\b({})\b".format("|".join(serverlist)), servername)
if servername in serverlist or server_matched and is_connected:
if nick and ssl_connected + is_connected:
ison(ptr_buffer,servername,nick,server_nicks(servername))
weechat.infolist_free(infolist)
return weechat.WEECHAT_RC_OK
def grabnick(servername, nick):
if nick and servername:
weechat.prnt(weechat.current_buffer(),OPTIONS['text'] % servername)
weechat.command(weechat.buffer_search('irc','%s.%s' % ('server',servername)), OPTIONS['command'] % nick)
# ================================[ weechat hook ]===============================
def install_hooks():
global HOOK,OPTIONS
if HOOK['timer'] != '' or HOOK['redirect'] != '': # should not happen, but...
return
if not OPTIONS['delay'] or not OPTIONS['timeout']:
return
HOOK['timer'] = weechat.hook_timer(int(OPTIONS['delay']) * 1000, 0, 0, 'check_nicks', '')
HOOK['redirect'] = weechat.hook_hsignal('irc_redirection_%s_ison' % SCRIPT_NAME, 'redirect_isonhandler', '' )
if HOOK['timer'] == 0:
weechat.prnt('',"%s: can't enable %s, hook_timer() failed" % (weechat.prefix('error'), SCRIPT_NAME))
if HOOK['redirect'] == 0:
weechat.prnt('',"%s: can't enable %s, hook_signal() failed" % (weechat.prefix('error'), SCRIPT_NAME))
def remove_hooks():
global HOOK
if HOOK['timer'] != '':
weechat.unhook(HOOK['timer'])
HOOK['timer'] = ''
if HOOK['redirect'] != '':
weechat.unhook(HOOK['redirect'])
HOOK['redirect'] = ''
# ================================[ weechat options and description ]===============================
def init_options():
global HOOK,OPTIONS
for option,value in list(OPTIONS.items()):
weechat.config_set_desc_plugin(option, '%s (default: "%s")' % (value[1], value[0]))
if not weechat.config_is_set_plugin(option):
weechat.config_set_plugin(option, value[0])
OPTIONS[option] = value[0]
else:
OPTIONS[option] = weechat.config_get_plugin(option)
def toggle_refresh(pointer, name, value):
global HOOK,OPTIONS
option = name[len('plugins.var.python.' + SCRIPT_NAME + '.'):] # get optionname
OPTIONS[option] = value # save new value
if option == 'delay' or option == 'timeout':
if int(OPTIONS['delay']) > 0 or int(OPTIONS['timeout']) > 0:
remove_hooks()
install_hooks()
else:
remove_hooks() # user switched timer off
return weechat.WEECHAT_RC_OK
# ================================[ main ]===============================
if __name__ == '__main__':
weechat.register(SCRIPT_NAME, SCRIPT_AUTHOR, SCRIPT_VERSION, SCRIPT_LICENCE, SCRIPT_DESC, '','')
version = weechat.info_get("version_number", "") or 0
if int(version) >= 0x00030400:
if int(OPTIONS['delay'][0]) > 0 and int(OPTIONS['timeout'][0]) > 0:
init_options()
install_hooks()
weechat.hook_config( 'plugins.var.python.' + SCRIPT_NAME + '.*', 'toggle_refresh', '' )
else:
weechat.prnt('','%s%s %s' % (weechat.prefix('error'),SCRIPT_NAME,': needs version 0.3.4 or higher'))
weechat.command('','/wait 1ms /python unload %s' % SCRIPT_NAME)
You can’t perform that action at this time.