FilesExpand file tree

 master

/

greetingSystem.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

202 lines (179 loc) · 7.85 KB

 master

/

greetingSystem.js

Copy path

Top

File metadata and controls

• Code
• Blame

202 lines (179 loc) · 7.85 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

/*

* Copyright (C) 2016-2019 phantombot.tv

*

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

*/

/**

* greetingSystem.js

*

* Tags in greetings:

* - (name) The username corresponding to the target user

*/

(function() {

var autoGreetEnabled = $.getSetIniDbBoolean('greeting', 'autoGreetEnabled', false),

defaultJoinMessage = $.getSetIniDbString('greeting', 'defaultJoin', '(name) joined!'),

greetingCooldown = $.getSetIniDbNumber('greeting', 'cooldown', (6 * 36e5)),

/* 6 Hours */

greetingQueue = new java.util.concurrent.ConcurrentLinkedQueue,

lastAutoGreet = $.systemTime();

/**

* @event ircChannelJoin

*/

$.bind('ircChannelJoin', function(event) {

if ($.isOnline($.channelName) && autoGreetEnabled) {

var sender = event.getUser().toLowerCase(),

username = $.resolveRank(sender),

message = $.getIniDbString('greeting', sender, ''),

lastUserGreeting = $.getIniDbNumber('greetingCoolDown', sender, 0),

now = $.systemTime();

if (lastUserGreeting + greetingCooldown < now) {

if (message) {

greetingQueue.add(message.replace('(name)', username));

$.inidb.set('greetingCoolDown', sender, now);

}

}

}

});

/**

* @function doUserGreetings

* Provides timer function for sending greetings into chat. Will delete messages if the

* host disables autoGreetings in the middle of a loop. The reason for a delay is to

* ensure that the output queue does not become overwhelmed.

*/

function doUserGreetings() {

setInterval(function() {

/* Send a greeting out into chat. */

if (!greetingQueue.isEmpty() && autoGreetEnabled) {

$.say(greetingQueue.poll());

}

/* There are greetings, however, autoGreet has been disabled, so destroy the queue. */

if (!greetingQueue.isEmpty() && !autoGreetEnabled) {

greetingQueue = new java.util.concurrent.ConcurrentLinkedQueue;

}

}, 15000, 'scripts::systems::greetingSystem.js');

}

/**

* @function greetingspanelupdate

*/

function greetingspanelupdate() {

autoGreetEnabled = $.getIniDbBoolean('greeting', 'autoGreetEnabled');

defaultJoinMessage = $.getIniDbString('greeting', 'defaultJoin');

greetingCooldown = $.getIniDbNumber('greeting', 'cooldown');

}

/**

* @event command

*/

$.bind('command', function(event) {

var sender = event.getSender().toLowerCase(),

command = event.getCommand(),

args = event.getArgs(),

action = args[0],

cooldown,

message;

/**

* @commandpath greeting - Base command for controlling greetings.

*/

if (command.equalsIgnoreCase('greeting')) {

if (!action) {

if ($.isAdmin(sender)) {

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.admin'));

} else {

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.other'));

}

return;

}

/**

* @commandpath greeting cooldown [hours] - Cooldown in hours before displaying a greeting for a person rejoining chat.

*/

if (action.equalsIgnoreCase('cooldown')) {

if (!args[1]) {

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.cooldown.usage'));

return;

}

cooldown = parseInt(args[1]);

if (isNaN(cooldown)) {

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.cooldown.usage'));

return;

}

greetingCooldown = cooldown * 36e5; // Convert hours to ms

$.inidb.set('greeting', 'cooldown', greetingCooldown);

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.cooldown.success', cooldown));

return;

}

/**

* @commandpath greeting toggle - Enable/disable the greeting system.

*/

if (action.equalsIgnoreCase('toggle')) {

autoGreetEnabled = !autoGreetEnabled;

$.setIniDbBoolean('greeting', 'autoGreetEnabled', autoGreetEnabled);

if (autoGreetEnabled) {

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.autogreet.enabled', $.username.resolve($.botName)));

} else {

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.autogreet.disabled', $.username.resolve($.botName)));

}

}

/**

* @commandpath greeting setdefault - Set the default greeting message

*/

if (action.equalsIgnoreCase('setdefault')) {

message = args.splice(1, args.length - 1).join(' ');

if (!message) {

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.admin'));

return;

}

$.inidb.set('greeting', 'defaultJoin', message);

defaultJoinMessage = message;

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.default.success', defaultJoinMessage));

}

/**

* @commandpath greeting enable [default | message] - Enable greetings and use the default or set a message.

*/

if (action.equalsIgnoreCase('enable')) {

message = args.splice(1, args.length - 1).join(' ');

if (!message) {

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.generalusage.other'));

return;

}

if (message.equalsIgnoreCase('default')) {

$.inidb.set('greeting', sender, defaultJoinMessage);

} else {

$.inidb.set('greeting', sender, message);

}

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.set.personal.success', $.inidb.get('greeting', sender)));

}

/**

* @commandpath greeting disable - Delete personal greeting and automated greeting at join

*/

if (action.equalsIgnoreCase('disable')) {

if ($.inidb.exists('greeting', sender)) {

$.inidb.del('greeting', sender);

$.say($.whisperPrefix(sender) + $.lang.get('greetingsystem.remove.personal.success'));

}

}

}

});

/**

* @event initReady

*/

$.bind('initReady', function() {

$.registerChatCommand('./systems/greetingSystem.js', 'greeting', 6);

$.registerChatSubcommand('greeting', 'cooldown', 1);

$.registerChatSubcommand('greeting', 'toggle', 1);

$.registerChatSubcommand('greeting', 'setdefault', 2);

$.registerChatSubcommand('greeting', 'enable', 6);

$.registerChatSubcommand('greeting', 'disable', 6);

doUserGreetings();

});

$.greetingspanelupdate = greetingspanelupdate;

})();