FilesExpand file tree

 patch-1

/

fileaway.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

208 lines (195 loc) · 7.61 KB

 patch-1

/

fileaway.py

Copy path

Top

File metadata and controls

• Code
• Blame

208 lines (195 loc) · 7.61 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

# -*- coding: utf-8 -*-

#

# Copyright (c) 2011 by Richard A Hofer (javagamer) <atomic.quark@gmail.com>

#

# fileaway.py - A simple autoaway script for Weechat which monitors a file,

# allowing it to easily connect to external things (such as xscreensaver)

#

# The code from screen_away.py and auto_away.py were heavily consulted in the

# writing of this script

# ---------------------------------------------------------------------------

#

# 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/>.

#

# -------------------------------------------------------------------------

# Purpose -

# I wrote this auto-away script so that it could easily be hooked into other

# things to deterine whether or not I was there rather than just watching for

# keyboard input in Weechat. In my case I wanted to be able to have weechat in

# a tmux session on a server, yet still go away when I lock the screen on my

# desktop.

#

# Below is a sample shellscript which watches xscreensaver and sets away when

# it is locked, and available when unlocked

# While this only one way this script can be used, this is why I wrote it

#

# #!/bin/sh

#

# # Read xscreensaver's state

# xscreensaver-command -watch|

# while read STATUS; do

# case "$STATUS" in

# LOCK*)

# rm ~/.available

# ;;

# UNBLANK*)

# touch ~/.available

# ;;

# esac

# done

#

# Alternative for xset:

#

# #!/bin/bash

#

# xset -display ":0" q|grep "Monitor"|awk ' { print $3 $4 } '|

# while read MONITOR; do

# case "$MONITOR" in

# Off)

# rm ~/.available

# ;;

# On)

# touch ~/.available

# ;;

# esac

# done

# ------------------------------------------------------------------------

# Changelog:

# Version 1.0 released - March 27, 2011

# -Initial release

# Version 1.0.1 released - March 31, 2011

# -Handles improper commands

# Version 1.0.2 release - Jun 15, 2011

# -Added alternative for xset users (credit: sherpa9 at irc.freenode.net)

# Version 1.0.3 release - Dec 19, 2019

# -Adapt for python3

from __future__ import print_function

try:

import weechat as w

import os.path

except Exception:

print("This script must be run under WeeChat.")

print("Get WeeChat now at: http://www.wwchat.org/")

quit()

SCRIPT_NAME = "fileaway"

SCRIPT_AUTHOR = "javagamer"

SCRIPT_VERSION = "1.0.3"

SCRIPT_LICENSE = "GPL3"

SCRIPT_DESC = "Set away status based on presence of a file"

debug = 0

TIMER = None

settings = {

'filepath': './.available',

'awaymessage':'Away',

'interval': '20', # How often to check for inactivity (in seconds)

'status': '0',

'away': '0',

}

def set_back(overridable_messages):

'''Removes away status for servers where one of the overridable_messages is set'''

if(w.config_get_plugin('away') == '0'): return # No need to come back again

serverlist = w.infolist_get('irc_server','','')

if serverlist:

buffers = []

while w.infolist_next(serverlist):

if w.infolist_string(serverlist, 'away_message') in overridable_messages:

ptr = w.infolist_pointer(serverlist, 'buffer')

if ptr:

buffers.append(ptr)

w.infolist_free(serverlist)

for buffer in buffers:

w.command(buffer, "/away")

w.config_set_plugin('away', '0')

def set_away(message, overridable_messages=[]):

'''Sets away status, but respectfully (so it doesn't change already set statuses'''

if(w.config_get_plugin('away') == '1'): return # No need to go away again (this prevents some repeated messages)

if(debug): w.prnt('', "Setting away to %s" % message)

serverlist = w.infolist_get('irc_server','','')

if serverlist:

buffers = []

while w.infolist_next(serverlist):

if w.infolist_integer(serverlist, 'is_away') == 0:

if(debug): w.prnt('', "Not away on %s" % w.infolist_string(serverlist, 'name'))

ptr = w.infolist_pointer(serverlist, 'buffer')

if ptr:

buffers.append(ptr)

elif w.infolist_string(serverlist, 'away_message') in overridable_messages:

if(debug): w.prnt('', "%s is in %s" % (w.infolist_string(serverlist, 'away_message'), repr(overridable_messages)))

buffers.append(w.infolist_pointer(serverlist, 'buffer'))

w.infolist_free(serverlist)

if(debug): w.prnt('', repr(buffers))

for buffer in buffers:

w.command(buffer, "/away %s" % message)

w.config_set_plugin('away', '1')

def fileaway_cb(data, buffer, args):

response = { 'enable' : lambda args: w.config_set_plugin('status', '1') and check_timer(),

'disable' : lambda args: w.config_set_plugin('status', '0') and check_timer(),

'check' : check,

'file' : lambda filepath: w.config_set_plugin('filepath', filepath),

'interval': lambda interval: w.config_set_plugin('interval', interval),

'msg' : lambda status: w.config_set_plugin('awaymessage', status),

}

if args:

words = args.strip().partition(' ')

if words[0] in response:

response[words[0]](words[2])

else:

w.prnt('', "Fileaway error: %s not a recognized command. Try /help fileaway" % words[0])

w.prnt('', "fileaway: enabled: %s interval: %s away message: \"%s\" filepath: %s" %

(w.config_get_plugin('status'), w.config_get_plugin('interval'),

w.config_get_plugin('awaymessage'), w.config_get_plugin('filepath')))

return w.WEECHAT_RC_OK

def auto_check(data, remaining_calls):

'''Callback from timer'''

check(0)

return w.WEECHAT_RC_OK

def check(args):

'''Check for existance of file and set away if it isn't there'''

if os.path.isfile(w.config_get_plugin('filepath')):

set_back([w.config_get_plugin('awaymessage')])

else:

set_away(w.config_get_plugin('awaymessage'), [])

def check_timer():

'''Sets or unsets the timer based on whether or not the plugin is enabled'''

global TIMER

if TIMER:

w.unhook(TIMER)

if w.config_get_plugin('status') == '1':

TIMER = w.hook_timer(int(w.config_get_plugin('interval')) * 1000, 0, 0, "auto_check", "")

w.prnt('', "fileaway timer is running.")

if __name__ == "__main__":

if w.register(SCRIPT_NAME, SCRIPT_AUTHOR, SCRIPT_VERSION, SCRIPT_LICENSE, SCRIPT_DESC, "", ""):

for option, default_value in settings.items():

if not w.config_is_set_plugin(option):

w.config_set_plugin(option, default_value)

w.hook_command("fileaway",

"Set away status based on presense or absense of a file.",

"check, msg [status], interval [time], file [filepath], or enable|disable",

"check - manually checks for file rather than waiting for interval.\n"

"msg [status] - sets the away message"

"interval [time] - sets the interval to check for the file.\n"

"file [filepath] - sets the file to be watched.\n"

"enable|disable - enables or disables plugin.\n",

"check"

" || msg"

" || interval"

" || file %(filename)"

" || enable"

" || disable",

"fileaway_cb", "")

check_timer()

if(w.config_get_plugin('status') == '0'):

w.prnt('', "fileaway is currently disabled. Type /fileaway enable to enable it.")

else:

w.prnt('', "fileaway is currently enabled. Type /fileaway disable to disable it.")