Home

Script: weemustfeed.py

RSS/RDF/Atom feed aggregator. (for WeeChat ≥ 0.3.7, requires: feedparser)
Author: Bit Shift, version 0.2.3, MIT — added: 2013-10-19, updated: 2016-11-05
  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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# -*- coding: utf-8 -*-
# Licensed under the MIT license:
# Copyright (c) 2013 Bit Shift <bitshift@bigmacintosh.net>
# Copyright (c) 2016 Pol Van Aubel <dev@polvanaubel.com>
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:

# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
# http://www.opensource.org/licenses/mit-license.php
#
# Revision log:
# 0.2.3 Changed weechat.prnt to weechat.prnt_date_tags where messages
#       are not a direct result from user input; errors get tagged with
#       irc_error and notify_message, messages get tagged with
#       notify_message.
#
# 0.2.2 Version from Bit Shift

import weechat
import string
import feedparser

weechat.register(
        "weemustfeed",
        "Bit Shift <bitshift@bigmacintosh.net>",
        "0.2.3",
        "MIT",
        "RSS/Atom/RDF aggregator for weechat",
        "",
        ""
        )


default_settings = {
        "interval": "300",
        "feeds": ""
        }

weemustfeed_buffer = None
weemustfeed_timer = None
fetch_hooks = {}
updating = set()
partial_feeds = {}

help_message = """
COMMANDS:
a <name> <url>        Add a feed with display name of <name> and URL of <url>.
d <name>              Delete the feed with display name <name>.
u <name> <url>        Update the feed with display name <name> to use URL <url>.
l                     List all feeds known to WeeMustFeed.
t <name>              Toggle a feed - disable/enable it temporarily without fully removing it.
?                     Display this help message.

CONFIG:
plugins.var.python.weemustfeed.interval
    Interval between update checks, in seconds. Must be a number, but is stored
    as a string. Blame the scripting API.
    default: "300"
""".strip()


def show_help():
    for line in help_message.split("\n"):
        weechat.prnt(weemustfeed_buffer, "\t\t" + line)


def weemustfeed_input_cb(data, buffer, input_data):
    global updating

    chunks = input_data.split()

    if chunks[0] == "a":
        if len(chunks) != 3:
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Wrong number of parameters. Syntax is 'a <name> <url>'.")
            return weechat.WEECHAT_RC_ERROR
        elif any([c not in (string.ascii_letters + string.digits) for c in chunks[1]]):
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Only A-Z, a-z, and 0-9 permitted in names.")
            return weechat.WEECHAT_RC_ERROR
        else:
            current_feeds = weechat.config_get_plugin("feeds").strip().split(";")

            if chunks[1] in current_feeds:
                weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "A feed with that name already exists (note: feed names are case-insensitive).")
                return weechat.WEECHAT_RC_ERROR
            else:
                current_feeds.append(chunks[1])
                weechat.config_set_plugin("feed." + chunks[1].lower() + ".url", chunks[2])
                weechat.config_set_plugin("feeds", ";".join(current_feeds))
                weechat.prnt(weemustfeed_buffer, "Added '" + chunks[1] + "'.")
    elif chunks[0] == "d":
        if len(chunks) != 2:
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Wrong number of parameters. Syntax is 'd <name>'.")
            return weechat.WEECHAT_RC_ERROR
        elif any([c not in (string.ascii_letters + string.digits) for c in chunks[1]]):
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Only A-Z, a-z, and 0-9 permitted in names.")
            return weechat.WEECHAT_RC_ERROR
        else:
            current_feeds = weechat.config_get_plugin("feeds").strip().split(";")
            if not chunks[1] in current_feeds:
                weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "No such feed exists.")
                return weechat.WEECHAT_RC_ERROR
            else:
                current_feeds.remove(chunks[1])
                weechat.config_set_plugin("feeds", ";".join(current_feeds))
                weechat.prnt(weemustfeed_buffer, "Deleted '" + chunks[1] + "'.")
    elif chunks[0] == "u":
        if len(chunks) != 3:
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Wrong number of parameters. Syntax is 'u <name> <url>'.")
            return weechat.WEECHAT_RC_ERROR
        elif any([c not in (string.ascii_letters + string.digits) for c in chunks[1]]):
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Only A-Z, a-z, and 0-9 permitted in names.")
            return weechat.WEECHAT_RC_ERROR
        else:
            current_feeds = weechat.config_get_plugin("feeds").strip().split(";")

            if not chunks[1] in current_feeds:
                weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "No feed with that name currently exists (note: feed names are case-insensitive).")
                return weechat.WEECHAT_RC_ERROR
            else:
                weechat.config_set_plugin("feed." + chunks[1].lower() + ".url", chunks[2])
                weechat.config_set_plugin("feeds", ";".join(current_feeds))
                weechat.prnt(weemustfeed_buffer, "Updated '" + chunks[1] + "'.")
    elif chunks[0] == "l":
        if len(chunks) != 1:
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Wrong number of parameters. Syntax is 'l'.")
            return weechat.WEECHAT_RC_ERROR
        else:
            current_feeds = weechat.config_get_plugin("feeds").strip().split(";")
            for feed in current_feeds:
                if feed != "":
                    if (weechat.config_is_set_plugin("feed." + feed.lower() + ".enabled") and
                        weechat.config_get_plugin("feed." + feed.lower() + ".enabled").lower() != "yes"):
                        feed_status = "disabled"
                    elif not (weechat.config_is_set_plugin("feed." + feed.lower() + ".last_id") and
                              weechat.config_get_plugin("feed." + feed.lower() + ".last_id") != ""):
                        feed_status = "new"
                    elif feed in updating:
                        feed_status = "updating"
                    elif (weechat.config_is_set_plugin("feed." + feed.lower() + ".enabled") and
                          weechat.config_get_plugin("feed." + feed.lower() + ".enabled").lower() != "yes"):
                        feed_status = "disabled"
                    else:
                        feed_status = "enabled"
                    weechat.prnt(weemustfeed_buffer, "\t" + feed + ": " + weechat.config_get_plugin("feed." + feed.lower() + ".url") + " [" + feed_status + "]")
    elif chunks[0] == "t":
        if len(chunks) != 2:
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Wrong number of parameters. Syntax is 't <name>'.")
            return weechat.WEECHAT_RC_ERROR
        elif any([c not in (string.ascii_letters + string.digits) for c in chunks[1]]):
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Only A-Z, a-z, and 0-9 permitted in names.")
            return weechat.WEECHAT_RC_ERROR
        else:
            current_feeds = weechat.config_get_plugin("feeds").strip().split(";")
            if not chunks[1] in current_feeds:
                weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "No such feed exists.")
                return weechat.WEECHAT_RC_ERROR
            else:
                if not weechat.config_is_set_plugin("feed." + chunks[1].lower() + ".enabled"):
                    feed_enabled = True
                else:
                    feed_enabled = (weechat.config_get_plugin("feed." +
                        chunks[1].lower() + ".enabled").lower() == "yes")

                if feed_enabled:
                    weechat.config_set_plugin("feed." + chunks[1].lower() +
                            ".enabled", "no")
                    weechat.prnt(weemustfeed_buffer, "Disabled '" + chunks[1] + "'.")
                else:
                    weechat.config_set_plugin("feed." + chunks[1].lower() +
                            ".enabled", "yes")
                    weechat.prnt(weemustfeed_buffer, "Enabled '" + chunks[1] + "'.")
    elif chunks[0] == "?":
        if len(chunks) != 1:
            weechat.prnt(weemustfeed_buffer, weechat.prefix("error") + "Wrong number of parameters. Syntax is '?'.")
            return weechat.WEECHAT_RC_ERROR
        else:
            show_help()

    return weechat.WEECHAT_RC_OK


def weemustfeed_close_cb(data, buffer):
    global weemustfeed_buffer, weemustfeed_timer

    weemustfeed_buffer = None
    weechat.unhook(weemustfeed_timer)
    for feed in fetch_hooks:
        weechat.unhook(fetch_hooks[feed])
        del fetch_hooks[feed]
    weemustfeed_timer = None
    return weechat.WEECHAT_RC_OK


def weemustfeed_command_cb(data, buffer, args):
    global weemustfeed_buffer

    if weemustfeed_buffer is None:
        weemustfeed_buffer = weechat.buffer_new(
                "weemustfeed",
                "weemustfeed_input_cb", "",
                "weemustfeed_close_cb", ""
                )

        weechat.buffer_set(weemustfeed_buffer, "title",
                "WeeMustFeed - a: Add feed, d: Delete feed, u: Update URL, l: List feeds, t: Toggle feed, ?: Show help")

        set_timer()

    weechat.buffer_set(weemustfeed_buffer, "display", "1") # switch to it

    return weechat.WEECHAT_RC_OK


def weemustfeed_reset_timer_cb(data, option, value):
    if weemustfeed_timer is not None:
        unset_timer()
        set_timer()
    return weechat.WEECHAT_RC_OK


def weemustfeed_update_single_feed_cb(feed, command, return_code, out, err):
    global partial_feeds, updating

    if not feed in partial_feeds:
        partial_feeds[feed] = ""

    if return_code < 0:  # feed not done yet
        partial_feeds[feed] += out
        return weechat.WEECHAT_RC_OK
    elif return_code == 1:
        weechat.prnt_date_tags(weemustfeed_buffer, 0,
                "irc_error,notify_message",
                weechat.prefix("error") + "Invalid URL for feed '" + feed + "'.")
        status = weechat.WEECHAT_RC_ERROR
    elif return_code == 2:
        weechat.prnt_date_tags(weemustfeed_buffer, 0,
                "irc_error,notify_message",
                weechat.prefix("error") + "Transfer error while fetching feed '" + feed + "'.")
        status = weechat.WEECHAT_RC_ERROR
    elif return_code == 3:
        weechat.prnt_date_tags(weemustfeed_buffer, 0,
                "irc_error,notify_message",
                weechat.prefix("error") + "Out of memory while fetching feed '" + feed + "'.")
        status = weechat.WEECHAT_RC_ERROR
    elif return_code == 4:
        weechat.prnt_date_tags(weemustfeed_buffer, 0,
                "irc_error,notify_message",
                weechat.prefix("error") + "Error with a file while fetching feed '" + feed + "'.")
        status = weechat.WEECHAT_RC_ERROR
    else:  # all good, and we have a complete feed
        if not weechat.config_is_set_plugin("feed." + feed.lower() + ".last_id"):
            weechat.config_set_plugin("feed." + feed.lower() + ".last_id", "")
            last_id = ""

        last_id = weechat.config_get_plugin("feed." + feed.lower() + ".last_id")

        parsed_feed = feedparser.parse(partial_feeds[feed] + out)

        entries = list(reversed(parsed_feed.entries))

        for entry in entries:
            if not hasattr(entry, "id"):
                entry.id = entry.link

        if (last_id == "") and len(entries) > 0:
            last_id = entries[-1].id
        else:
            if last_id in [entry.id for entry in entries]:
                only_new = False
            else:
                only_new = True

            for entry in entries:
                if only_new:
                    weechat.prnt_date_tags(weemustfeed_buffer, 0, "notify_message", "{feed}\t{title} {url}".format(**{
                        "feed": feed,
                        "title": entry.title.encode("utf-8"),
                        "url": entry.link.encode("utf-8")
                        }))
                    last_id = entry.id
                elif entry.id == last_id:
                    only_new = True  # everything else will be newer

        weechat.config_set_plugin("feed." + feed.lower() + ".last_id", last_id)

        status = weechat.WEECHAT_RC_OK

    partial_feeds[feed] = ""
    if feed in updating:
        updating.remove(feed)
    if feed in fetch_hooks:
        del fetch_hooks[feed]
    return status


def weemustfeed_update_feeds_cb(data, remaining_calls):
    global updating

    for feed in weechat.config_get_plugin("feeds").strip().split(";"):
        if weechat.config_is_set_plugin("feed." + feed.lower() + ".url"):
            if not (weechat.config_is_set_plugin("feed." + feed.lower() + ".enabled") and
                    weechat.config_get_plugin("feed." + feed.lower() + ".enabled").lower() != "yes"):
                updating.add(feed)
                if not feed in fetch_hooks:
                    fetch_hooks[feed] = weechat.hook_process(
                        "url:" + weechat.config_get_plugin("feed." + feed.lower() + ".url"),
                        0,
                        "weemustfeed_update_single_feed_cb", feed
                        )
        elif feed != "":
            weechat.prnt_date_tags(weemustfeed_buffer, 0,
                    "irc_error,notify_message",
                    weechat.prefix("error") + "Feed '" + feed + "' has no URL set.")
    return weechat.WEECHAT_RC_OK


def set_timer():
    global weemustfeed_timer

    try:
        timer_interval = int(weechat.config_get_plugin("interval"))
    except ValueError:
        timer_interval = int(default_settings["interval"])

    weemustfeed_timer = weechat.hook_timer(
            timer_interval * 1000,
            0,
            0,
            "weemustfeed_update_feeds_cb", ""
            )


def unset_timer():
    if weemustfeed_timer is not None:
        weechat.unhook(weemustfeed_timer)


def init_script():
    global default_settings

    for option, default_value in default_settings.items():
        if not weechat.config_is_set_plugin(option):
            weechat.config_set_plugin(option, default_value)

    weechat.hook_command(
        "weemustfeed",
        "open/switch to weemustfeed buffer",
        "",
        "",
        "",
        "weemustfeed_command_cb", ""
        )

    weechat.hook_config(
        "plugins.var.python.weemustfeed.interval",
        "weemustfeed_reset_timer_cb", ""
        )


init_script()