FilesExpand file tree

 0.2.6

/

pmwhitelist.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

260 lines (198 loc) · 7.41 KB

 0.2.6

/

pmwhitelist.py

Copy path

Top

File metadata and controls

• Code
• Blame

260 lines (198 loc) · 7.41 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

#

# Copyright (c) 2007 by pr3d4t0r (tek_fox AT internet.lu)

#

# 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 2 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, write to the Free Software

# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

# pmwhitelist.py -- GPLv2

#

# Private messages white list for WeeChat 0.2.x.

# This script implements the commands /whitelist or

# /wl for managing users into a white list. The WeeChat user will only

# receive private messages from white listed users. All others will

# receive an automatic response indicating that the message didn't reach

# the WeeChat user and instructions to make an in-channel request

# to be added to the white list.

#

# /whitelist and /wl can be used in combination with these actions:

#

# /whitelist add nick

# /whitelist del nick

# /whitelist view

#

# The script can be loaded into WeeChat by executing:

#

# /python load pmwhitelist.py

#

# The script may also be auto-loaded by WeeChat. See the

# WeeChat manual for instructions about how to do this.

#

# This script was tested with WeeChat versions 0.2.4 and

# 0.2.6. An updated version of this script will be available

# when the new WeeChat API is released.

#

# For up-to-date information about this script, and new

# version downloads, please go to:

#

# http://eugeneciurana.com/site.php?page=tools

#

# If you have any questions, please contact me on-line at:

#

# irc.freenode.net - pr3d4t0r (op): ##java, #awk, #esb

# irc.freenode.net - pr3d4t0r (op): #java

# irc.osx86.hu - pr3d4t0r (op): #iphone-dev

#

# The fastest way to make feature requests or report a bug:

#

# http://eugeneciurana.com/site.php?page=contact

#

# Cheers!

#

# pr3d4t0r

#

# CHANGE LOG

# ==========

# 0.2 fixed: ~/.weechat/white_list.dat not found error

# 0.3 fixed: No more endless looping if sender and recipient both have pmwhitelist.py

# installed, or if the recipient is a 'bot not in the white list.

# 0.4 added: Notification to the current network server console that a user tried

# to send a private message, and who that user was. Also, fixed the

# mechanism for clearing the '\n' at the end of each line read from the

# white list.

# 0.5 fixed: Bug in auto-reply; the first time that a user sends a message, she gets the

# auto-reply; the second time she's able to send private messages.

#

# Removed: help command.

# 0.6 added: Updated the /wl add method to allow the user to enter multiple nicks

# in one operation: /wl add bob bob- alice alice_

import os

import string

import weechat

# *** Symbolic constants ***

FILE_NAME = "white_list.dat"

COMMANDS = [ "add", "del", "view" ]

# *** Globals ***

greyList = []

# *** Implementation and callback functions ***

def end_PMWhiteList():

weechat.prnt("PMWhiteList: ending...")

return weechat.PLUGIN_RC_OK

# end_PMWhiteList

def killPrivateMessage(bufferSender, bufferHome, myNick, bAutoReply):

weechat.command("/buffer "+bufferSender)

if (True == bAutoReply):

weechat.command("/say AUTOREPLY: "+myNick+" does not accept unsolicited private messages. Your message didn't reach the recipient. Please ask for your nick to be white listed in-channel. Thank you.")

weechat.command("/close")

weechat.command("/buffer "+bufferHome)

# killPrivateMessage

def whiteListFileName():

return weechat.get_info("weechat_dir")+"/"+FILE_NAME;

# whiteListFileName

def readList():

whiteList = [] # init

if os.access(whiteListFileName(), os.F_OK) == False:

outputFile = open(whiteListFileName(), "wb")

outputFile.writelines(whiteList)

outputFile.close()

inputFile = open(whiteListFileName(), "rb")

list = inputFile.readlines()

inputFile.close()

for item in list:

whiteList.append(item.rstrip('\n'))

whiteList.sort()

return whiteList

# readList

def writeList(whiteList):

outputFile = open(whiteListFileName(), "wb")

outputFile.writelines(whiteList)

outputFile.close()

# writeList

def isOnList(nickSender):

whiteList = readList()

for nick in whiteList:

if (nickSender.lower() == nick.lower()):

return True

return False

# isOnList

def whiteListAdd(nickList):

if nickList == None or len(nickList) < 1:

return

list = readList()

for nick in nickList:

weechat.print_server("Private message white list add: "+nick)

if nick not in list:

list.append(nick)

if nick in greyList:

greyList.remove(nick)

whiteList = []

for item in list:

whiteList.append(item+"\n")

writeList(whiteList)

# whiteListAdd

def whiteListDel(nick):

weechat.print_server("Private message white list delete: "+nick)

list = readList()

whiteList = []

for item in list:

if item != nick:

whiteList.append(item+"\n")

writeList(whiteList)

# whiteListDel

def whiteListDisplay():

weechat.print_server("*** Begin private message white list:")

for nick in readList():

weechat.print_server(nick)

weechat.print_server("*** End private message white list\n")

# whiteListDisplay

def PMWLInterceptor(server, argList):

bufferSender = argList.split(":")[1].split(" ")[0].split("!")[0]

nickSender = bufferSender

bufferHome = weechat.get_info("channel", server)

myNick = weechat.get_info("nick", server)

if os.access(whiteListFileName(), os.F_OK) == False:

killPrivateMessage(bufferSender, bufferHome, myNick, True)

return weechat.PLUGIN_RC_OK

if (False == isOnList(nickSender)):

if (nickSender not in greyList):

killPrivateMessage(bufferSender, bufferHome, myNick, True)

greyList.append(nickSender)

weechat.print_server(nickSender+" tried to send a private message.")

else:

killPrivateMessage(bufferSender, bufferHome, myNick, False)

return weechat.PLUGIN_RC_OK

# PMWLInterceptor

def PMWLCommandHandler(server, argList):

command = argList.split(" ")[0]

if command not in COMMANDS:

return weechat.PLUGIN_RC_KO

if len(argList.split(" ")) <= 1:

arguments = list()

else:

arguments = argList.split(" ")[1:]

if (command.lower() == "view"):

whiteListDisplay()

return weechat.PLUGIN_RC_OK

if (len(arguments) < 1):

return weechat.PLUGIN_RC_KO

if (command.lower() == "add"):

whiteListAdd(arguments)

if (command.lower() == "del"):

whiteListDel(arguments[0])

return weechat.PLUGIN_RC_OK

# PMWLCommandHandler

# *** Script starts here ***

weechat.register("PMWhiteList", "0.6", "end_PMWhiteList", "Private messages white list", "UTF-8");

weechat.set_charset("UTF-8");

weechat.add_message_handler("weechat_pv", "PMWLInterceptor")

weechat.add_command_handler("whitelist", "PMWLCommandHandler", "Private message white list", "add|del|view", "add nick1 nick2 ... nickN, delete nick, or view white list", "add|del|view")

weechat.add_command_handler("wl", "PMWLCommandHandler", "Private message white list (shorthand for /whitelist)", "add|del|view", "add nick1 nick2 ... nickN, delete nick, or view white list", "add|del|view")