marvin_actions

  1#! /usr/bin/env python3
  2# -*- coding: utf-8 -*-
  3
  4"""
  5Make actions for Marvin, one function for each action.
  6"""
  7from urllib.parse import quote_plus
  8from urllib.request import urlopen
  9import calendar
 10import datetime
 11import json
 12import logging
 13import random
 14import requests
 15
 16from bs4 import BeautifulSoup
 17
 18LOG = logging.getLogger("action")
 19
 20def getAllActions():
 21    """
 22    Return all actions in an array.
 23    """
 24    return [
 25        marvinExplainShell,
 26        marvinGoogle,
 27        marvinLunch,
 28        marvinVideoOfToday,
 29        marvinWhoIs,
 30        marvinHelp,
 31        marvinSource,
 32        marvinBudord,
 33        marvinQuote,
 34        marvinWeather,
 35        marvinSun,
 36        marvinSayHi,
 37        marvinSmile,
 38        marvinStrip,
 39        marvinTimeToBBQ,
 40        marvinBirthday,
 41        marvinNameday,
 42        marvinUptime,
 43        marvinStream,
 44        marvinPrinciple,
 45        marvinJoke,
 46        marvinCommit
 47    ]
 48
 49
 50# Load all strings from file
 51with open("marvin_strings.json", encoding="utf-8") as f:
 52    STRINGS = json.load(f)
 53
 54
 55def getString(key, key1=None):
 56    """
 57    Get a string from the string database.
 58    """
 59    data = STRINGS[key]
 60    if isinstance(data, list):
 61        res = data[random.randint(0, len(data) - 1)]
 62    elif isinstance(data, dict):
 63        if key1 is None:
 64            res = data
 65        else:
 66            res = data[key1]
 67            if isinstance(res, list):
 68                res = res[random.randint(0, len(res) - 1)]
 69    elif isinstance(data, str):
 70        res = data
 71
 72    return res
 73
 74
 75def marvinSmile(row):
 76    """
 77    Make Marvin smile.
 78    """
 79    msg = None
 80    if any(r in row for r in ["smile", "le", "skratta", "smilies"]):
 81        msg = getString("smile")
 82    return msg
 83
 84
 85def wordsAfterKeyWords(words, keyWords):
 86    """
 87    Return all items in the words list after the first occurence
 88    of an item in the keyWords list.
 89    """
 90    kwIndex = []
 91    for kw in keyWords:
 92        if kw in words:
 93            kwIndex.append(words.index(kw))
 94
 95    if not kwIndex:
 96        return None
 97
 98    return words[min(kwIndex)+1:]
 99
100
101def marvinGoogle(row):
102    """
103    Let Marvin present an url to google.
104    """
105    query = wordsAfterKeyWords(row, ["google", "googla"])
106    if not query:
107        return None
108
109    searchStr = " ".join(query)
110    url = "https://www.google.se/search?q="
111    url += quote_plus(searchStr)
112    msg = getString("google")
113    return msg.format(url)
114
115
116def marvinExplainShell(row):
117    """
118    Let Marvin present an url to the service explain shell to
119    explain a shell command.
120    """
121    query = wordsAfterKeyWords(row, ["explain", "förklara"])
122    if not query:
123        return None
124    cmd = " ".join(query)
125    url = "https://explainshell.com/explain?cmd="
126    url += quote_plus(cmd, "/:")
127    msg = getString("explainShell")
128    return msg.format(url)
129
130
131def marvinSource(row):
132    """
133    State message about sourcecode.
134    """
135    msg = None
136    if any(r in row for r in ["källkod", "source"]):
137        msg = getString("source")
138
139    return msg
140
141
142def marvinBudord(row):
143    """
144    What are the budord for Marvin?
145    """
146    msg = None
147    if any(r in row for r in ["budord", "stentavla"]):
148        if any(r in row for r in ["#1", "1"]):
149            msg = getString("budord", "#1")
150        elif any(r in row for r in ["#2", "2"]):
151            msg = getString("budord", "#2")
152        elif any(r in row for r in ["#3", "3"]):
153            msg = getString("budord", "#3")
154        elif any(r in row for r in ["#4", "4"]):
155            msg = getString("budord", "#4")
156        elif any(r in row for r in ["#5", "5"]):
157            msg = getString("budord", "#5")
158
159    return msg
160
161
162def marvinQuote(row):
163    """
164    Make a quote.
165    """
166    msg = None
167    if any(r in row for r in ["quote", "citat", "filosofi", "filosofera"]):
168        msg = getString("hitchhiker")
169
170    return msg
171
172
173def videoOfToday():
174    """
175    Check what day it is and provide a url to a suitable video together with a greeting.
176    """
177    weekday = datetime.date.today().strftime("%A")
178    day = getString("video-of-today", weekday)
179    msg = day.get("message")
180
181    if day:
182        msg += " En passande video är " + day.get("url")
183    else:
184        msg += " Jag har ännu ingen passande video för denna dagen."
185
186    return msg
187
188
189def marvinVideoOfToday(row):
190    """
191    Show the video of today.
192    """
193    msg = None
194    if any(r in row for r in ["idag", "dagens"]):
195        if any(r in row for r in ["video", "youtube", "tube"]):
196            msg = videoOfToday()
197
198    return msg
199
200
201def marvinWhoIs(row):
202    """
203    Who is Marvin.
204    """
205    msg = None
206    if all(r in row for r in ["vem", "är"]):
207        msg = getString("whois")
208
209    return msg
210
211
212def marvinHelp(row):
213    """
214    Provide a menu.
215    """
216    msg = None
217    if any(r in row for r in ["hjälp", "help", "menu", "meny"]):
218        msg = getString("menu")
219
220    return msg
221
222
223def marvinSayHi(row):
224    """
225    Say hi with a nice message.
226    """
227    msg = None
228    if any(r in row for r in [
229            "snälla", "hej", "tjena", "morsning", "morrn", "mår", "hallå",
230            "halloj", "läget", "snäll", "duktig", "träna", "träning",
231            "utbildning", "tack", "tacka", "tackar", "tacksam"
232    ]):
233        smile = getString("smile")
234        hello = getString("hello")
235        friendly = getString("friendly")
236        msg = f"{smile} {hello} {friendly}"
237
238    return msg
239
240
241def marvinLunch(row):
242    """
243    Help decide where to eat.
244    """
245    lunchOptions = {
246        'stan centrum karlskrona kna': 'karlskrona',
247        'ängelholm angelholm engelholm': 'angelholm',
248        'hässleholm hassleholm': 'hassleholm',
249        'malmö malmo malmoe': 'malmo',
250        'göteborg goteborg gbg': 'goteborg'
251    }
252
253    data = getString("lunch")
254
255    if any(r in row for r in ["lunch", "mat", "äta", "luncha"]):
256        places = data.get("location").get("bth")
257        for keys, value in lunchOptions.items():
258            if any(r in row for r in keys.split(" ")):
259                places = data.get("location").get(value)
260
261        lunchStr = getString("lunch", "message")
262        return lunchStr.format(places[random.randint(0, len(places) - 1)])
263
264    return None
265
266
267def marvinSun(row):
268    """
269    Check when the sun goes up and down.
270    """
271    msg = None
272    if any(r in row for r in ["sol", "solen", "solnedgång", "soluppgång", "sun"]):
273        try:
274            url = getString("sun", "url")
275            r = requests.get(url, timeout=5)
276            sundata = r.json()
277            # Formats the time from the response to HH:mm instead of hh:mm:ss
278            sunrise = sundata["results"]["sunrise"].split()[0][:-3]
279            sunset = sundata["results"]["sunset"].split()[0][:-3]
280            # The api uses AM/PM notation, this converts the sunset to 12 hour time
281            sunsetHour = int(sunset.split(":")[0]) + 12
282            sunset = str(sunsetHour) + sunset[-3:]
283            msg = getString("sun", "msg").format(sunrise, sunset)
284            return msg
285
286        except Exception as e:
287            LOG.error("Failed to get sun times: %s", e)
288            return getString("sun", "error")
289
290    return msg
291
292
293def marvinWeather(row):
294    """
295    Check what the weather prognosis looks like.
296    """
297    msg = ""
298    if any(r in row for r in ["väder", "vädret", "prognos", "prognosen", "smhi"]):
299        forecast = ""
300        observation = ""
301
302        try:
303            station_req = requests.get(getString("smhi", "station_url"), timeout=5)
304            weather_code:int = int(station_req.json().get("value")[0].get("value"))
305
306            weather_codes_req = requests.get(getString("smhi", "weather_codes_url"), timeout=5)
307            weather_codes_arr: list = weather_codes_req.json().get("entry")
308
309            current_weather_req = requests.get(getString("smhi", "current_weather_url"), timeout=5)
310            current_w_data: list = current_weather_req.json().get("timeSeries")[0].get("parameters")
311
312            for curr_w in current_w_data:
313                if curr_w.get("name") == "t":
314                    forecast = curr_w.get("values")[0]
315
316            for code in weather_codes_arr:
317                if code.get("key") == weather_code:
318                    observation = code.get("value")
319
320            msg = f"Karlskrona just nu: {forecast} °C. {observation}."
321
322        except Exception as e:
323            LOG.error("Failed to get weather: %s", e)
324            msg: str = getString("smhi", "failed")
325
326    return msg
327
328
329def marvinStrip(row):
330    """
331    Get a comic strip.
332    """
333    msg = None
334    if any(r in row for r in ["strip", "comic", "nöje", "paus"]):
335        msg = commitStrip(randomize=any(r in row for r in ["rand", "random", "slump", "lucky"]))
336    return msg
337
338
339def commitStrip(randomize=False):
340    """
341    Latest or random comic strip from CommitStrip.
342    """
343    msg = getString("commitstrip", "message")
344
345    if randomize:
346        first = getString("commitstrip", "first")
347        last = getString("commitstrip", "last")
348        rand = random.randint(first, last)
349        url = getString("commitstrip", "urlPage") + str(rand)
350    else:
351        url = getString("commitstrip", "url")
352
353    return msg.format(url=url)
354
355
356def marvinTimeToBBQ(row):
357    """
358    Calcuate the time to next barbecue and print a appropriate msg
359    """
360    msg = None
361    if any(r in row for r in ["grilla", "grill", "grillcon", "bbq"]):
362        url = getString("barbecue", "url")
363        nextDate = nextBBQ()
364        today = datetime.date.today()
365        daysRemaining = (nextDate - today).days
366
367        if daysRemaining == 0:
368            msg = getString("barbecue", "today")
369        elif daysRemaining == 1:
370            msg = getString("barbecue", "tomorrow")
371        elif 1 < daysRemaining < 14:
372            msg = getString("barbecue", "week") % nextDate
373        elif 14 < daysRemaining < 200:
374            msg = getString("barbecue", "base") % nextDate
375        else:
376            msg = getString("barbecue", "eternity") % nextDate
377
378        msg = url + ". " + msg
379    return msg
380
381def nextBBQ():
382    """
383    Calculate the next grillcon date after today
384    """
385
386    MAY = 5
387    SEPTEMBER = 9
388
389    after = datetime.date.today()
390    spring = thirdFridayIn(after.year, MAY)
391    if after <= spring:
392        return spring
393
394    autumn = thirdFridayIn(after.year, SEPTEMBER)
395    if after <= autumn:
396        return autumn
397
398    return thirdFridayIn(after.year + 1, MAY)
399
400
401def thirdFridayIn(y, m):
402    """
403    Get the third Friday in a given month and year
404    """
405    THIRD = 2
406    FRIDAY = -1
407
408    # Start the weeks on saturday to prevent fridays from previous month
409    cal = calendar.Calendar(firstweekday=calendar.SATURDAY)
410
411    # Return the friday in the third week
412    return cal.monthdatescalendar(y, m)[THIRD][FRIDAY]
413
414
415def marvinBirthday(row):
416    """
417    Check birthday info
418    """
419    msg = None
420    if any(r in row for r in ["birthday", "födelsedag"]):
421        try:
422            url = getString("birthday", "url")
423            soup = BeautifulSoup(urlopen(url), "html.parser")
424            my_list = list()
425
426            for ana in soup.findAll('a'):
427                if ana.parent.name == 'strong':
428                    my_list.append(ana.getText())
429
430            my_list.pop()
431            my_strings = ', '.join(my_list)
432            if not my_strings:
433                msg = getString("birthday", "nobody")
434            else:
435                msg = getString("birthday", "somebody").format(my_strings)
436
437        except Exception as e:
438            LOG.error("Failed to get birthday: %s", e)
439            msg = getString("birthday", "error")
440
441    return msg
442
443def marvinNameday(row):
444    """
445    Check current nameday
446    """
447    msg = None
448    if any(r in row for r in ["nameday", "namnsdag"]):
449        try:
450            now = datetime.datetime.now()
451            raw_url = "https://api.dryg.net/dagar/v2.1/{year}/{month}/{day}"
452            url = raw_url.format(year=now.year, month=now.month, day=now.day)
453            r = requests.get(url, timeout=5)
454            nameday_data = r.json()
455            names = nameday_data["dagar"][0]["namnsdag"]
456            parsed_names = formatNames(names)
457            if names:
458                msg = getString("nameday", "somebody").format(parsed_names)
459            else:
460                msg = getString("nameday", "nobody")
461        except Exception as e:
462            LOG.error("Failed to get nameday: %s", e)
463            msg = getString("nameday", "error")
464    return msg
465
466def formatNames(names):
467    """
468    Parses namedata from nameday API
469    """
470    if len(names) > 1:
471        return " och ".join([", ".join(names[:-1])] + names[-1:])
472    return "".join(names)
473
474def marvinUptime(row):
475    """
476    Display info about uptime tournament
477    """
478    msg = None
479    if "uptime" in row:
480        msg = getString("uptime", "info")
481    return msg
482
483def marvinStream(row):
484    """
485    Display info about stream
486    """
487    msg = None
488    if any(r in row for r in ["stream", "streama", "ström", "strömma"]):
489        msg = getString("stream", "info")
490    return msg
491
492def marvinPrinciple(row):
493    """
494    Display one selected software principle, or provide one as random
495    """
496    msg = None
497    if any(r in row for r in ["principle", "princip", "principer"]):
498        principles = getString("principle")
499        principleKeys = list(principles.keys())
500        matchedKeys = [k for k in row if k in principleKeys]
501        if matchedKeys:
502            msg = principles[matchedKeys.pop()]
503        else:
504            msg = principles[random.choice(principleKeys)]
505    return msg
506
507def getJoke():
508    """
509    Retrieves joke from api.chucknorris.io/jokes/random?category=dev
510    """
511    try:
512        url = getString("joke", "url")
513        r = requests.get(url, timeout=5)
514        joke_data = r.json()
515        return joke_data["value"]
516    except Exception as e:
517        LOG.error("Failed to get joke: %s", e)
518        return getString("joke", "error")
519
520def marvinJoke(row):
521    """
522    Display a random Chuck Norris joke
523    """
524    msg = None
525    if any(r in row for r in ["joke", "skämt", "chuck norris", "chuck", "norris"]):
526        msg = getJoke()
527    return msg
528
529def getCommit():
530    """
531    Retrieves random commit message from whatthecommit.com/index.html
532    """
533    try:
534        url = getString("commit", "url")
535        r = requests.get(url, timeout=5)
536        res = r.text.strip()
537        msg = f"Använd detta meddelandet: '{res}'"
538        return msg
539    except Exception as e:
540        LOG.error("Failed to get commit message: %s", e)
541        return getString("commit", "error")
542
543def marvinCommit(row):
544    """
545    Display a random commit message
546    """
547    msg = None
548    if any(r in row for r in ["commit", "-m"]):
549        msg = getCommit()
550    return msg