Slixfeed/slixfeed/action.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""

TODO

1) Function scan at "for entry in entries"
   Suppress directly calling function "add_entry" (accept db_file)
   Pass a list of valid entries to a new function "add_entries"
   (accept db_file) which would call function "add_entry" (accept cur).
   * accelerate adding of large set of entries at once.
   * prevent (or mitigate halt of consequent actions).
   * reduce I/O.

2) Call sqlite function from function statistics.
   Returning a list of values doesn't' seem to be a good practice.

3) Special statistics for operator:
   * Size of database(s);
   * Amount of JIDs subscribed;
   * Amount of feeds of all JIDs;
   * Amount of entries of all JIDs.

"""

# import asyncio
from asyncio.exceptions import IncompleteReadError
from bs4 import BeautifulSoup
from feedparser import parse
import hashlib
from http.client import IncompleteRead
import json
from slixfeed.log import Logger
from lxml import html
import os
import slixfeed.config as config
from slixfeed.config import Config
import slixfeed.crawl as crawl
import slixfeed.dt as dt
import slixfeed.fetch as fetch
import slixfeed.sqlite as sqlite
import slixfeed.url as uri
from slixfeed.url import (
    complete_url,
    join_url,
    remove_tracking_parameters,
    replace_hostname,
    trim_url
    )
import slixfeed.task as task
from slixfeed.xmpp.bookmark import XmppBookmark
from slixfeed.xmpp.muc import XmppGroupchat
from slixfeed.xmpp.iq import XmppIQ
from slixfeed.xmpp.message import XmppMessage
from slixfeed.xmpp.presence import XmppPresence
from slixfeed.xmpp.publish import XmppPubsub
from slixfeed.xmpp.upload import XmppUpload
from slixfeed.xmpp.utility import get_chat_type
from slixmpp.xmlstream import ET
import sys
from urllib import error
from urllib.parse import parse_qs, urlsplit
import xml.etree.ElementTree as ETR

try:
    import tomllib
except:
    import tomli as tomllib

logger = Logger(__name__)


def export_feeds(self, jid, jid_file, ext):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: jid: {}: jid_file: {}: ext: {}'.format(function_name, jid, jid_file, ext))
    cache_dir = config.get_default_cache_directory()
    if not os.path.isdir(cache_dir):
        os.mkdir(cache_dir)
    if not os.path.isdir(cache_dir + '/' + ext):
        os.mkdir(cache_dir + '/' + ext)
    filename = os.path.join(
        cache_dir, ext, 'slixfeed_' + dt.timestamp() + '.' + ext)
    db_file = config.get_pathname_to_database(jid_file)
    results = sqlite.get_feeds(db_file)
    match ext:
        # case 'html':
        #     response = 'Not yet implemented.'
        case 'md':
            export_to_markdown(jid, filename, results)
        case 'opml':
            export_to_opml(jid, filename, results)
        # case 'xbel':
        #     response = 'Not yet implemented.'
    return filename


async def xmpp_muc_autojoin(self, bookmarks):
    for bookmark in bookmarks:
        if bookmark["jid"] and bookmark["autojoin"]:
            if not bookmark["nick"]:
                bookmark["nick"] = self.alias
                logger.error('Alias (i.e. Nicknname) is missing for '
                              'bookmark {}'.format(bookmark['name']))
            alias = bookmark["nick"]
            muc_jid = bookmark["jid"]
            result = await XmppGroupchat.join(self, muc_jid, alias)
            print(result)
            if result == 'ban':
                await XmppBookmark.remove(self, muc_jid)
                logger.warning('{} is banned from {}'.format(self.alias, muc_jid))
                logger.warning('Groupchat {} has been removed from bookmarks'
                               .format(muc_jid))
            else:
                logger.info('Autojoin groupchat\n'
                            'Name  : {}\n'
                            'JID   : {}\n'
                            'Alias : {}\n'
                            .format(bookmark["name"],
                                    bookmark["jid"],
                                    bookmark["nick"]))
        elif not bookmark["jid"]:
            logger.error('JID is missing for bookmark {}'
                          .format(bookmark['name']))


"""
TODO

Consider to append text to remind to share presence
'✒️ Share online status to receive updates'

# TODO Request for subscription
if (await get_chat_type(self, jid_bare) == 'chat' and
    not self.client_roster[jid_bare]['to']):
    XmppPresence.subscription(self, jid_bare, 'subscribe')
    await XmppRoster.add(self, jid_bare)
    status_message = '✒️ Share online status to receive updates'
    XmppPresence.send(self, jid_bare, status_message)
    message_subject = 'RSS News Bot'
    message_body = 'Share online status to receive updates.'
    XmppMessage.send_headline(self, jid_bare, message_subject,
                              message_body, 'chat')

"""

async def xmpp_send_status_message(self, jid):
    """
    Send status message.

    Parameters
    ----------
    jid : str
        Jabber ID.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: jid: {}'.format(function_name, jid))
    status_text = '📜️ Slixfeed RSS News Bot'
    jid_file = jid.replace('/', '_')
    db_file = config.get_pathname_to_database(jid_file)
    enabled = Config.get_setting_value(self.settings, jid, 'enabled')
    if enabled:
        jid_task = self.pending_tasks[jid]
        if len(jid_task):
            status_mode = 'dnd'
            status_text = jid_task[list(jid_task.keys())[0]]
        else:
            feeds = sqlite.get_number_of_items(db_file, 'feeds_properties')
            # print(await current_time(), jid, "has", feeds, "feeds")
            if not feeds:
                status_mode = 'available'
                status_text = '📪️ Send a URL from a blog or a news website'
            else:
                unread = sqlite.get_number_of_entries_unread(db_file)
                if unread:
                    status_mode = 'chat'
                    status_text = '📬️ There are {} news items'.format(str(unread))
                    # status_text = (
                    #     "📰 News items: {}"
                    #     ).format(str(unread))
                    # status_text = (
                    #     "📰 You have {} news items"
                    #     ).format(str(unread))
                else:
                    status_mode = 'available'
                    status_text = '📭️ No news'
    else:
        status_mode = 'xa'
        status_text = '📪️ Send "Start" to receive updates'
    # breakpoint()
    # print(await current_time(), status_text, "for", jid)
    XmppPresence.send(self, jid, status_text, status_type=status_mode)
    # await asyncio.sleep(60 * 20)
    # await refresh_task(self, jid, send_status, 'status', '90')
    # loop.call_at(
    #     loop.time() + 60 * 20,
    #     loop.create_task,
    #     send_status(jid)
    # )


async def xmpp_pubsub_send_selected_entry(self, jid_bare, jid_file, node_id, entry_id):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: jid_bare: {} jid_file: {}'.format(function_name, jid_bare, jid_file))
    # jid_file = jid_bare.replace('/', '_')
    db_file = config.get_pathname_to_database(jid_file)
    report = {}
    if jid_bare == self.boundjid.bare:
        node_id = 'urn:xmpp:microblog:0'
        node_subtitle = None
        node_title = None
    else:
        feed_id = sqlite.get_feed_id_by_entry_index(db_file, entry_id)
        feed_id = feed_id[0]
        feed_properties = sqlite.get_feed_properties(db_file, feed_id)
        node_id = feed_properties[2]
        node_title = feed_properties[3]
        node_subtitle = feed_properties[5]
    xep = None
    iq_create_node = XmppPubsub.create_node(
        self, jid_bare, node_id, xep, node_title, node_subtitle)
    await XmppIQ.send(self, iq_create_node)
    entry = sqlite.get_entry_properties(db_file, entry_id)
    print('xmpp_pubsub_send_selected_entry',jid_bare)
    print(node_id)
    entry_dict = pack_entry_into_dict(db_file, entry)
    node_item = create_rfc4287_entry(entry_dict)
    entry_url = entry_dict['link']
    item_id = hash_url_to_md5(entry_url)
    iq_create_entry = XmppPubsub.create_entry(
        self, jid_bare, node_id, item_id, node_item)
    await XmppIQ.send(self, iq_create_entry)
    await sqlite.mark_as_read(db_file, entry_id)
    report = entry_url
    return report


async def xmpp_pubsub_send_unread_items(self, jid_bare):
    """

    Parameters
    ----------
    jid_bare : TYPE
        Bare Jabber ID.

    Returns
    -------
    report : dict
        URL and Number of processed entries.

    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: jid_bare: {}'.format(function_name, jid_bare))
    jid_file = jid_bare.replace('/', '_')
    db_file = config.get_pathname_to_database(jid_file)
    report = {}
    subscriptions = sqlite.get_active_feeds_url(db_file)
    for url in subscriptions:
        url = url[0]
        # feed_id = sqlite.get_feed_id(db_file, url)
        # feed_id = feed_id[0]
        # feed_properties = sqlite.get_feed_properties(db_file, feed_id)
        feed_id = sqlite.get_feed_id(db_file, url)
        feed_id = feed_id[0]

        # Publish to node 'urn:xmpp:microblog:0' for own JID
        # Publish to node based on feed identifier for PubSub service.

        if jid_bare == self.boundjid.bare:
            node_id = 'urn:xmpp:microblog:0'
            node_subtitle = None
            node_title = None
        else:
            # node_id = feed_properties[2]
            # node_title = feed_properties[3]
            # node_subtitle = feed_properties[5]
            node_id = sqlite.get_feed_identifier(db_file, feed_id)
            node_id = node_id[0]
            if not node_id:
                counter = 0
                hostname = uri.get_hostname(url)
                hostname = hostname.replace('.','-')
                identifier = hostname + ':' + str(counter)
                while True:
                    if sqlite.check_identifier_exist(db_file, identifier):
                        counter += 1
                        identifier = hostname + ':' + str(counter)
                    else:
                        break
                await sqlite.update_feed_identifier(db_file, feed_id, identifier)
                node_id = sqlite.get_feed_identifier(db_file, feed_id)
                node_id = node_id[0]
            node_title = sqlite.get_feed_title(db_file, feed_id)
            node_title = node_title[0]
            node_subtitle = sqlite.get_feed_subtitle(db_file, feed_id)
            node_subtitle = node_subtitle[0]
        xep = None
        node_exist = await XmppPubsub.get_node_configuration(self, jid_bare, node_id)
        if not node_exist:
            iq_create_node = XmppPubsub.create_node(
                self, jid_bare, node_id, xep, node_title, node_subtitle)
            await XmppIQ.send(self, iq_create_node)
        entries = sqlite.get_unread_entries_of_feed(db_file, feed_id)
        report[url] = len(entries)
        for entry in entries:
            feed_entry = pack_entry_into_dict(db_file, entry)
            node_entry = create_rfc4287_entry(feed_entry)
            entry_url = feed_entry['link']
            item_id = hash_url_to_md5(entry_url)
            print('PubSub node item was sent to', jid_bare, node_id)
            print(entry_url)
            print(item_id)
            iq_create_entry = XmppPubsub.create_entry(
                self, jid_bare, node_id, item_id, node_entry)
            await XmppIQ.send(self, iq_create_entry)
            ix = entry[0]
            await sqlite.mark_as_read(db_file, ix)
    return report


def pack_entry_into_dict(db_file, entry):
    entry_id = entry[0]
    authors = sqlite.get_authors_by_entry_id(db_file, entry_id)
    entry_authors = []
    for author in authors:
        entry_author = {
            'name': author[2],
            'email': author[3],
            'url': author[4]}
        entry_authors.extend([entry_author])

    contributors = sqlite.get_contributors_by_entry_id(db_file, entry_id)
    entry_contributors = []
    for contributor in contributors:
        entry_contributor = {
            'name': contributor[2],
            'email': contributor[3],
            'url': contributor[4]}
        entry_contributors.extend([entry_contributor])

    links = sqlite.get_links_by_entry_id(db_file, entry_id)
    entry_links = []
    for link in links:
        entry_link = {
            'url': link[2],
            'type': link[3],
            'rel': link[4],
            'size': link[5]}
        entry_links.extend([entry_link])
        

    tags = sqlite.get_tags_by_entry_id(db_file, entry_id)
    entry_tags = []
    for tag in tags:
        entry_tag = {
            'term': tag[2],
            'scheme': tag[3],
            'label': tag[4]}
        entry_tags.extend([entry_tag])

    contents = sqlite.get_contents_by_entry_id(db_file, entry_id)
    entry_contents = []
    for content in contents:
        entry_content = {
            'text': content[2],
            'type': content[3],
            'base': content[4],
            'lang': content[5]}
        entry_contents.extend([entry_content])
        
    feed_entry = {
        'authors'      : entry_authors,
        'category'     : entry[10],
        'comments'     : entry[12],
        'contents'     : entry_contents,
        'contributors' : entry_contributors,
        'summary_base' : entry[9],
        'summary_lang' : entry[7],
        'summary_text' : entry[6],
        'summary_type' : entry[8],
        'enclosures'   : entry[13],
        'href'         : entry[11],
        'link'         : entry[3],
        'links'        : entry_links,
        'published'    : entry[14],
        'rating'       : entry[13],
        'tags'         : entry_tags,
        'title'        : entry[4],
        'title_type'   : entry[3],
        'updated'      : entry[15]}
    return feed_entry


# NOTE Warning: Entry might not have a link
# TODO Handle situation error
def hash_url_to_md5(url):
    url_encoded = url.encode()
    url_hashed = hashlib.md5(url_encoded)
    url_digest = url_hashed.hexdigest()
    return url_digest
    

def create_rfc4287_entry(feed_entry):
    node_entry = ET.Element('entry')
    node_entry.set('xmlns', 'http://www.w3.org/2005/Atom')

    # Title
    title = ET.SubElement(node_entry, 'title')
    if feed_entry['title']:
        if feed_entry['title_type']: title.set('type', feed_entry['title_type'])
        title.text = feed_entry['title']
    elif feed_entry['summary_text']:
        if feed_entry['summary_type']: title.set('type', feed_entry['summary_type'])
        title.text = feed_entry['summary_text']
        # if feed_entry['summary_base']: title.set('base', feed_entry['summary_base'])
        # if feed_entry['summary_lang']: title.set('lang', feed_entry['summary_lang'])
    else:
        title.text = feed_entry['published']

    # Some feeds have identical content for contents and summary
    # So if content is present, do not add summary
    if feed_entry['contents']:
        # Content
        for feed_entry_content in feed_entry['contents']:
            content = ET.SubElement(node_entry, 'content')
            # if feed_entry_content['base']: content.set('base', feed_entry_content['base'])
            if feed_entry_content['lang']: content.set('lang', feed_entry_content['lang'])
            if feed_entry_content['type']: content.set('type', feed_entry_content['type'])
            content.text = feed_entry_content['text']
    else:
        # Summary
        summary = ET.SubElement(node_entry, 'summary') # TODO Try 'content'
        # if feed_entry['summary_base']: summary.set('base', feed_entry['summary_base'])
        # TODO Check realization of "lang"
        if feed_entry['summary_type']: summary.set('type', feed_entry['summary_type'])
        if feed_entry['summary_lang']: summary.set('lang', feed_entry['summary_lang'])
        summary.text = feed_entry['summary_text']

    # Authors
    for feed_entry_author in feed_entry['authors']:
        author = ET.SubElement(node_entry, 'author')
        name = ET.SubElement(author, 'name')
        name.text = feed_entry_author['name']
        if feed_entry_author['url']:
            uri = ET.SubElement(author, 'uri')
            uri.text = feed_entry_author['url']
        if feed_entry_author['email']:
            email = ET.SubElement(author, 'email')
            email.text = feed_entry_author['email']

    # Contributors
    for feed_entry_contributor in feed_entry['contributors']:
        contributor = ET.SubElement(node_entry, 'author')
        name = ET.SubElement(contributor, 'name')
        name.text = feed_entry_contributor['name']
        if feed_entry_contributor['url']:
            uri = ET.SubElement(contributor, 'uri')
            uri.text = feed_entry_contributor['url']
        if feed_entry_contributor['email']:
            email = ET.SubElement(contributor, 'email')
            email.text = feed_entry_contributor['email']

    # Category
    category = ET.SubElement(node_entry, "category")
    category.set('category', feed_entry['category'])

    # Tags
    for feed_entry_tag in feed_entry['tags']:
        tag = ET.SubElement(node_entry, 'category')
        tag.set('term', feed_entry_tag['term'])

    # Link
    link = ET.SubElement(node_entry, "link")
    link.set('href', feed_entry['link'])

    # Links
    for feed_entry_link in feed_entry['links']:
        link = ET.SubElement(node_entry, "link")
        link.set('href', feed_entry_link['url'])
        link.set('type', feed_entry_link['type'])
        link.set('rel', feed_entry_link['rel'])

    # Date updated
    if feed_entry['updated']:
        updated = ET.SubElement(node_entry, 'updated')
        updated.text = feed_entry['updated']

    # Date published
    if feed_entry['published']:
        published = ET.SubElement(node_entry, 'published')
        published.text = feed_entry['published']

    return node_entry


async def xmpp_chat_send_unread_items(self, jid, num=None):
    """
    Send news items as messages.

    Parameters
    ----------
    jid : str
        Jabber ID.
    num : str, optional
        Number. The default is None.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: jid: {} num: {}'.format(function_name, jid, num))
    jid_file = jid.replace('/', '_')
    db_file = config.get_pathname_to_database(jid_file)
    show_media = Config.get_setting_value(self.settings, jid, 'media')
    if not num:
        num = Config.get_setting_value(self.settings, jid, 'quantum')
    else:
        num = int(num)
    results = sqlite.get_unread_entries(db_file, num)
    news_digest = ''
    media = None
    chat_type = await get_chat_type(self, jid)
    for result in results:
        ix = result[0]
        title_e = result[1]
        url = result[2]
        summary = result[3]
        feed_id = result[4]
        date = result[5]
        enclosure = sqlite.get_enclosure_by_entry_id(db_file, ix)
        if enclosure: enclosure = enclosure[0]
        title_f = sqlite.get_feed_title(db_file, feed_id)
        title_f = title_f[0]
        news_digest += await list_unread_entries(self, result, title_f, jid)
        # print(db_file)
        # print(result[0])
        # breakpoint()
        await sqlite.mark_as_read(db_file, ix)

        # Find media
        # if url.startswith("magnet:"):
        #     media = action.get_magnet(url)
        # elif enclosure.startswith("magnet:"):
        #     media = action.get_magnet(enclosure)
        # elif enclosure:
        if show_media:
            if enclosure:
                media = enclosure
            else:
                media = await extract_image_from_html(url)
        
        if media and news_digest:
            # Send textual message
            XmppMessage.send(self, jid, news_digest, chat_type)
            news_digest = ''
            # Send media
            XmppMessage.send_oob(self, jid, media, chat_type)
            media = None
            
    if news_digest:
        XmppMessage.send(self, jid, news_digest, chat_type)
            # TODO Add while loop to assure delivery.
            # print(await current_time(), ">>> ACT send_message",jid)
            # NOTE Do we need "if statement"? See NOTE at is_muc.
            # if chat_type in ('chat', 'groupchat'):
            #     # TODO Provide a choice (with or without images)
            #     XmppMessage.send(self, jid, news_digest, chat_type)
        # See XEP-0367
        # if media:
        #     # message = xmpp.Slixfeed.make_message(
        #     #     self, mto=jid, mbody=new, mtype=chat_type)
        #     message = xmpp.Slixfeed.make_message(
        #         self, mto=jid, mbody=media, mtype=chat_type)
        #     message['oob']['url'] = media
        #     message.send()
                
        # TODO Do not refresh task before
        # verifying that it was completed.

        # await start_tasks_xmpp_chat(self, jid, ['status'])
        # await refresh_task(self, jid, send_update, 'interval')

    # interval = await initdb(
    #     jid,
    #     sqlite.is_setting_key,
    #     "interval"
    # )
    # self.task_manager[jid]["interval"] = loop.call_at(
    #     loop.time() + 60 * interval,
    #     loop.create_task,
    #     send_update(jid)
    # )

    # print(await current_time(), "asyncio.get_event_loop().time()")
    # print(await current_time(), asyncio.get_event_loop().time())
    # await asyncio.sleep(60 * interval)

    # loop.call_later(
    #     60 * interval,
    #     loop.create_task,
    #     send_update(jid)
    # )

    # print
    # await handle_event()


def manual(filename, section=None, command=None):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: filename: {}'.format(function_name, filename))
    config_dir = config.get_default_config_directory()
    with open(config_dir + '/' + filename, mode="rb") as commands:
        cmds = tomllib.load(commands)
    if section == 'all':
        cmd_list = ''
        for cmd in cmds:
            for i in cmds[cmd]:
                cmd_list += cmds[cmd][i] + '\n'
    elif command and section:
        try:
            cmd_list = cmds[section][command]
        except KeyError as e:
            logger.error(e)
            cmd_list = None
    elif section:
        try:
            cmd_list = []
            for cmd in cmds[section]:
                cmd_list.extend([cmd])
        except KeyError as e:
            logger.error('KeyError:' + str(e))
            cmd_list = None
    else:
        cmd_list = []
        for cmd in cmds:
            cmd_list.extend([cmd])
    return cmd_list


def log_to_markdown(timestamp, filename, jid, message):
    """
    Log message to file.

    Parameters
    ----------
    timestamp : str
        Time stamp.
    filename : str
        Jabber ID as name of file.
    jid : str
        Jabber ID.
    message : str
        Message content.

    Returns
    -------
    None.
    
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: timestamp: {} filename: {} jid: {} message: {}'.format(function_name, timestamp, filename, jid, message))
    with open(filename + '.md', 'a') as file:
        # entry = "{} {}:\n{}\n\n".format(timestamp, jid, message)
        entry = (
        "## {}\n"
        "### {}\n\n"
        "{}\n\n").format(jid, timestamp, message)
        file.write(entry)


def is_feed_json(document):
    """

    NOTE /kurtmckee/feedparser/issues/103

    Determine whether document is json feed or not.

    Parameters
    ----------
    feed : dict
        Parsed feed.

    Returns
    -------
    val : boolean
        True or False.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}'.format(function_name))
    value = False
    try:
        feed = json.loads(document)
        if not feed['items']:
            if "version" in feed.keys():
                if 'jsonfeed' in feed['version']:
                    value = True
                else: # TODO Test
                    value = False
            # elif 'title' in feed.keys():
            #     value = True
            else:
                value = False
        else:
            value = True
    except:
        pass
    return value


def is_feed(feed):
    """
    Determine whether document is feed or not.

    Parameters
    ----------
    feed : dict
        Parsed feed.

    Returns
    -------
    val : boolean
        True or False.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}'.format(function_name))
    value = False
    # message = None
    if not feed.entries:
        if "version" in feed.keys():
            # feed["version"]
            if feed.version:
                value = True
                # message = (
                #     "Empty feed for {}"
                #     ).format(url)
        elif "title" in feed["feed"].keys():
            value = True
            # message = (
            #     "Empty feed for {}"
            #     ).format(url)
        else:
            value = False
            # message = (
            #     "No entries nor title for {}"
            #     ).format(url)
    elif feed.bozo:
        value = False
        # message = (
        #     "Bozo detected for {}"
        #     ).format(url)
    else:
        value = True
        # message = (
        #     "Good feed for {}"
        #     ).format(url)
    return value


async def list_unread_entries(self, result, feed_title, jid):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: feed_title: {} jid: {}'
                .format(function_name, feed_title, jid))
    # TODO Add filtering
    # TODO Do this when entry is added to list and mark it as read
    # DONE!
    # results = []
    # if sqlite.is_setting_key(db_file, "deny"):
    #     while len(results) < num:
    #         result = cur.execute(sql).fetchone()
    #         blacklist = sqlite.get_setting_value(db_file, "deny").split(",")
    #         for i in blacklist:
    #             if i in result[1]:
    #                 continue
    #                 print("rejected:", result[1])
    #         print("accepted:", result[1])
    #         results.extend([result])

    # news_list = "You've got {} news items:\n".format(num)
    # NOTE Why doesn't this work without list?
    #      i.e. for result in results
    # for result in results.fetchall():
    ix = str(result[0])
    title = str(result[1])
    # # TODO Retrieve summary from feed
    # # See fetch.view_entry
    summary = result[3]
    # Remove HTML tags
    try:
        title = BeautifulSoup(title, "lxml").text
        summary = BeautifulSoup(summary, "lxml").text
    except:
        print('Found issue at action.py')
        print(result[3])
        breakpoint()
    # TODO Limit text length
    # summary = summary.replace("\n\n\n", "\n\n")
    summary = summary.replace('\n', ' ')
    summary = summary.replace('	', ' ')
    summary = summary.replace('  ', ' ')
    length = Config.get_setting_value(self.settings, jid, 'length')
    length = int(length)
    summary = summary[:length] + " […]"
    # summary = summary.strip().split('\n')
    # summary = ["> " + line for line in summary]
    # summary = "\n".join(summary)
    link = result[2]
    link = remove_tracking_parameters(link)
    link = await replace_hostname(link, "link") or link
    # news_item = ("\n{}\n{}\n{} [{}]\n").format(str(title), str(link),
    #                                            str(feed_title), str(ix))
    formatting = Config.get_setting_value(self.settings, jid, 'formatting')
    news_item = formatting.format(feed_title=feed_title,
                                  title=title,
                                  summary=summary,
                                  link=link,
                                  ix=ix)
    # news_item = news_item.replace('\\n', '\n')
    return news_item


def list_search_results(query, results):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: query: {}'
                .format(function_name, query))
    message = ("Search results for '{}':\n\n```"
               .format(query))
    for result in results:
        message += ("\n{}\n{}\n"
                    .format(str(result[0]), str(result[1])))
    if len(results):
        message += "```\nTotal of {} results".format(len(results))
    else:
        message = "No results were found for: {}".format(query)
    return message


def list_feeds_by_query(query, results):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}'.format(function_name))
    message = ('Feeds containing "{}":\n\n```'
               .format(query))
    for result in results:
        message += ('\nName : {} [{}]'
                    '\nURL  : {}'
                    '\n'
                    .format(str(result[0]), str(result[1]), str(result[2])))
    if len(results):
        message += "\n```\nTotal of {} feeds".format(len(results))
    else:
        message = "No feeds were found for: {}".format(query)
    return message


async def list_options(self, jid_bare):
    """
    Print options.

    Parameters
    ----------
    jid_bare : str
        Jabber ID.

    Returns
    -------
    msg : str
        Options as message.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: jid: {}'
                .format(function_name, jid_bare))

    # msg = """You have {} unread news items out of {} from {} news sources.
    #       """.format(unread_entries, entries, feeds)

    # try:
    #     value = cur.execute(sql, par).fetchone()[0]
    # except:
    #     print("Error for key:", key)
    #     value = "Default"
    # values.extend([value])

    value_archive = Config.get_setting_value(self.settings, jid_bare, 'archive')
    value_interval = Config.get_setting_value(self.settings, jid_bare, 'interval')
    value_quantum = Config.get_setting_value(self.settings, jid_bare, 'quantum')
    value_enabled = Config.get_setting_value(self.settings, jid_bare, 'enabled')

    message = ("Options:"
               "\n"
               "```"
               "\n"
               "Items to archive : {}\n"
               "Update interval  : {}\n"
               "Items per update : {}\n"
               "Operation status : {}\n"
               "```").format(value_archive, value_interval, value_quantum,
                             value_enabled)
    return message


async def list_statistics(db_file):
    """
    Print statistics.

    Parameters
    ----------
    db_file : str
        Path to database file.

    Returns
    -------
    msg : str
        Statistics as message.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: db_file: {}'
                .format(function_name, db_file))
    entries_unread = sqlite.get_number_of_entries_unread(db_file)
    entries = sqlite.get_number_of_items(db_file, 'entries_properties')
    feeds_active = sqlite.get_number_of_feeds_active(db_file)
    feeds_all = sqlite.get_number_of_items(db_file, 'feeds_properties')

    # msg = """You have {} unread news items out of {} from {} news sources.
    #       """.format(unread_entries, entries, feeds)

    # try:
    #     value = cur.execute(sql, par).fetchone()[0]
    # except:
    #     print("Error for key:", key)
    #     value = "Default"
    # values.extend([value])

    message = ("Statistics:"
               "\n"
               "```"
               "\n"
               "News items   : {}/{}\n"
               "News sources : {}/{}\n"
               "```").format(entries_unread,
                             entries,
                             feeds_active,
                             feeds_all)
    return message


# FIXME Replace counter by len
def list_last_entries(results, num):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: num: {}'
                .format(function_name, num))
    message = "Recent {} titles:\n\n```".format(num)
    for result in results:
        message += ("\n{}\n{}\n"
                    .format(str(result[0]), str(result[1])))
    if len(results):
        message += "```\n"
    else:
        message = "There are no news at the moment."
    return message


def pick_a_feed(lang=None):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: lang: {}'
                .format(function_name, lang))
    config_dir = config.get_default_config_directory()
    with open(config_dir + '/' + 'feeds.toml', mode="rb") as feeds:
        urls = tomllib.load(feeds)
    import random
    url = random.choice(urls['feeds'])
    return url


def list_feeds(results):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}'.format(function_name))
    message = "\nList of subscriptions:\n\n```\n"
    for result in results:
        message += ("{} [{}]\n"
                    "{}\n"
                    "\n\n"
                    .format(str(result[1]), str(result[0]), str(result[2])))
    if len(results):
        message += ('```\nTotal of {} subscriptions.\n'
                    .format(len(results)))
    else:
        url = pick_a_feed()
        message = ('List of subscriptions is empty. To add a feed, send a URL.'
                   '\n'
                   'Featured news: *{}*\n{}'
                   .format(url['name'], url['link']))
    return message


def list_bookmarks(self, conferences):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}'.format(function_name))
    message = '\nList of groupchats:\n\n```\n'
    for conference in conferences:
        message += ('Name: {}\n'
                    'Room: {}\n'
                    '\n'
                    .format(conference['name'], conference['jid']))
    message += ('```\nTotal of {} groupchats.\n'
                .format(len(conferences)))
    return message


def export_to_markdown(jid, filename, results):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: jid: {} filename: {}'
                .format(function_name, jid, filename))
    with open(filename, 'w') as file:
        file.write('# Subscriptions for {}\n'.format(jid))
        file.write('## Set of feeds exported with Slixfeed\n')
        for result in results:
            file.write('- [{}]({})\n'.format(result[1], result[2]))
        file.write('\n\n* * *\n\nThis list was saved on {} from xmpp:{} using '
                   '[Slixfeed](https://gitgud.io/sjehuda/slixfeed)\n'
                   .format(dt.current_date(), jid))


# TODO Consider adding element jid as a pointer of import
def export_to_opml(jid, filename, results):
    print(jid, filename, results)
    function_name = sys._getframe().f_code.co_name
    logger.debug('{} jid: {} filename: {}'
                .format(function_name, jid, filename))
    root = ETR.Element("opml")
    root.set("version", "1.0")
    head = ETR.SubElement(root, "head")
    ETR.SubElement(head, "title").text = "{}".format(jid)
    ETR.SubElement(head, "description").text = (
        "Set of subscriptions exported by Slixfeed")
    ETR.SubElement(head, "generator").text = "Slixfeed"
    ETR.SubElement(head, "urlPublic").text = (
        "https://gitgud.io/sjehuda/slixfeed")
    time_stamp = dt.current_time()
    ETR.SubElement(head, "dateCreated").text = time_stamp
    ETR.SubElement(head, "dateModified").text = time_stamp
    body = ETR.SubElement(root, "body")
    for result in results:
        outline = ETR.SubElement(body, "outline")
        outline.set("text", result[1])
        outline.set("xmlUrl", result[2])
        # outline.set("type", result[2])
    tree = ETR.ElementTree(root)
    tree.write(filename)


async def import_opml(db_file, result):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: db_file: {}'
                .format(function_name, db_file))
    if not result['error']:
        document = result['content']
        root = ETR.fromstring(document)
        before = sqlite.get_number_of_items(db_file, 'feeds_properties')
        feeds = []
        for child in root.findall(".//outline"):
            url = child.get("xmlUrl")
            title = child.get("text")
            # feed = (url, title)
            # feeds.extend([feed])
            feed = {
                'title' : title,
                'url' : url,
                }
            feeds.extend([feed])
        await sqlite.import_feeds(db_file, feeds)
        await sqlite.add_metadata(db_file)
        after = sqlite.get_number_of_items(db_file, 'feeds_properties')
        difference = int(after) - int(before)
        return difference


async def add_feed(self, jid_bare, db_file, url, identifier):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: db_file: {} url: {}'
                .format(function_name, db_file, url))
    while True:
        feed_id = sqlite.get_feed_id(db_file, url)
        if not feed_id:
            exist_identifier = sqlite.check_identifier_exist(db_file, identifier)
            if not exist_identifier:
                result = await fetch.http(url)
                message = result['message']
                status_code = result['status_code']
                if not result['error']:
                    await sqlite.update_feed_status(db_file, feed_id, status_code)
                    document = result['content']
                    feed = parse(document)
                    # if document and status_code == 200:
                    # if is_feed(url, feed):
                    if is_feed(feed):
                        if "title" in feed["feed"].keys():
                            title = feed["feed"]["title"]
                        else:
                            title = urlsplit(url).netloc
                        if "language" in feed["feed"].keys():
                            language = feed["feed"]["language"]
                        else:
                            language = ''
                        if "encoding" in feed.keys():
                            encoding = feed["encoding"]
                        else:
                            encoding = ''
                        if "updated_parsed" in feed["feed"].keys():
                            updated = feed["feed"]["updated_parsed"]
                            try:
                                updated = dt.convert_struct_time_to_iso8601(updated)
                            except:
                                updated = ''
                        else:
                            updated = ''
                        version = feed.version
                        entries_count = len(feed.entries)
                        await sqlite.insert_feed(db_file,
                                                 url,
                                                 title,
                                                 identifier,
                                                 entries=entries_count,
                                                 version=version,
                                                 encoding=encoding,
                                                 language=language,
                                                 status_code=status_code,
                                                 updated=updated)
                        feed_valid = 0 if feed.bozo else 1
                        await sqlite.update_feed_validity(db_file, feed_id, feed_valid)
                        if feed.has_key('updated_parsed'):
                            feed_updated = feed.updated_parsed
                            try:
                                feed_updated = dt.convert_struct_time_to_iso8601(feed_updated)
                            except:
                                feed_updated = None
                        else:
                            feed_updated = None
                        feed_properties = get_properties_of_feed(db_file,
                                                                 feed_id, feed)
                        await sqlite.update_feed_properties(db_file, feed_id,
                                                            feed_properties)
                        feed_id = sqlite.get_feed_id(db_file, url)
                        feed_id = feed_id[0]
                        new_entries = get_properties_of_entries(
                            jid_bare, db_file, url, feed_id, feed)
                        if new_entries:
                            await sqlite.add_entries_and_update_feed_state(
                                db_file, feed_id, new_entries)
                        old = Config.get_setting_value(self.settings, jid_bare, 'old')
                        if not old: await sqlite.mark_feed_as_read(db_file, feed_id)
                        result_final = {'link' : url,
                                        'index' : feed_id,
                                        'name' : title,
                                        'code' : status_code,
                                        'error' : False,
                                        'message': message,
                                        'exist' : False,
                                        'identifier' : None}
                        break
                    # NOTE This elif statement be unnecessary
                    # when feedparser be supporting json feed.
                    elif is_feed_json(document):
                        feed = json.loads(document)
                        if "title" in feed.keys():
                            title = feed["title"]
                        else:
                            title = urlsplit(url).netloc
                        if "language" in feed.keys():
                            language = feed["language"]
                        else:
                            language = ''
                        if "encoding" in feed.keys():
                            encoding = feed["encoding"]
                        else:
                            encoding = ''
                        if "date_published" in feed.keys():
                            updated = feed["date_published"]
                            try:
                                updated = dt.convert_struct_time_to_iso8601(updated)
                            except:
                                updated = ''
                        else:
                            updated = ''
                        version = 'json' + feed["version"].split('/').pop()
                        entries_count = len(feed["items"])
                        await sqlite.insert_feed(db_file,
                                                 url,
                                                 title,
                                                 identifier,
                                                 entries=entries_count,
                                                 version=version,
                                                 encoding=encoding,
                                                 language=language,
                                                 status_code=status_code,
                                                 updated=updated)
                        await scan_json(self, jid_bare, db_file, url)
                        old = Config.get_setting_value(self.settings, jid_bare, 'old')
                        if not old:
                            feed_id = sqlite.get_feed_id(db_file, url)
                            feed_id = feed_id[0]
                            await sqlite.mark_feed_as_read(db_file, feed_id)
                        result_final = {'link' : url,
                                        'index' : feed_id,
                                        'name' : title,
                                        'code' : status_code,
                                        'error' : False,
                                        'message': message,
                                        'exist' : False,
                                        'identifier' : None}
                        break
                    else:
                        # NOTE Do not be tempted to return a compact dictionary.
                        #      That is, dictionary within dictionary
                        #      Return multiple dictionaries in a list or tuple.
                        result = await crawl.probe_page(url, document)
                        if not result:
                            # Get out of the loop with dict indicating error.
                            result_final = {'link' : url,
                                            'index' : None,
                                            'name' : None,
                                            'code' : status_code,
                                            'error' : True,
                                            'message': message,
                                            'exist' : False,
                                            'identifier' : None}
                            break
                        elif isinstance(result, list):
                            # Get out of the loop and deliver a list of dicts.
                            result_final = result
                            break
                        else:
                            # Go back up to the while loop and try again.
                            url = result['link']
                else:
                    await sqlite.update_feed_status(db_file, feed_id, status_code)
                    result_final = {'link' : url,
                                    'index' : None,
                                    'name' : None,
                                    'code' : status_code,
                                    'error' : True,
                                    'message': message,
                                    'exist' : False,
                                    'identifier' : None}
                    break
            else:
                ix = exist_identifier[1]
                identifier = exist_identifier[2]
                message = ('Identifier "{}" is already allocated.'
                           .format(identifier))
                result_final = {'link' : url,
                                'index' : ix,
                                'name' : None,
                                'code' : None,
                                'error' : False,
                                'message': message,
                                'exist' : False,
                                'identifier' : identifier}
                break
        else:
            feed_id = feed_id[0]
            title = sqlite.get_feed_title(db_file, feed_id)
            title = title[0]
            message = 'URL already exist.'
            result_final = {'link' : url,
                            'index' : feed_id,
                            'name' : title,
                            'code' : None,
                            'error' : False,
                            'message': message,
                            'exist' : True,
                            'identifier' : None}
            break
    return result_final


async def scan_json(self, jid_bare, db_file, url):
    """
    Check feeds for new entries.

    Parameters
    ----------
    db_file : str
        Path to database file.
    url : str, optional
        URL. The default is None.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: db_file: {} url: {}'
                .format(function_name, db_file, url))
    if isinstance(url, tuple): url = url[0]
    result = await fetch.http(url)
    if not result['error']:
        document = result['content']
        status = result['status_code']
        new_entries = []
        if document and status == 200:
            feed = json.loads(document)
            entries = feed["items"]
            await remove_nonexistent_entries_json(self, jid_bare, db_file, url, feed)
            try:
                feed_id = sqlite.get_feed_id(db_file, url)
                feed_id = feed_id[0]
                # await sqlite.update_feed_validity(
                #     db_file, feed_id, valid)
                if "date_published" in feed.keys():
                    updated = feed["date_published"]
                    try:
                        updated = dt.convert_struct_time_to_iso8601(updated)
                    except:
                        updated = ''
                else:
                    updated = ''
                feed_id = sqlite.get_feed_id(db_file, url)
                feed_id = feed_id[0]
                await sqlite.update_feed_properties(
                    db_file, feed_id, len(feed["items"]), updated)
                # await update_feed_status
            except (
                    IncompleteReadError,
                    IncompleteRead,
                    error.URLError
                    ) as e:
                logger.error(e)
                return
            # new_entry = 0
            for entry in entries:
                logger.debug('{}: entry: {}'
                            .format(function_name, entry["title"]))
                if "date_published" in entry.keys():
                    date = entry["date_published"]
                    date = dt.rfc2822_to_iso8601(date)
                elif "date_modified" in entry.keys():
                    date = entry["date_modified"]
                    date = dt.rfc2822_to_iso8601(date)
                else:
                    date = dt.now()
                if "url" in entry.keys():
                    # link = complete_url(source, entry.link)
                    link = join_url(url, entry["url"])
                    link = trim_url(link)
                else:
                    link = url
                # title = feed["feed"]["title"]
                # title = "{}: *{}*".format(feed["feed"]["title"], entry.title)
                title = entry["title"] if "title" in entry.keys() else date
                entry_id = entry["id"] if "id" in entry.keys() else link
                feed_id = sqlite.get_feed_id(db_file, url)
                feed_id = feed_id[0]
                exist = sqlite.check_entry_exist(db_file, feed_id,
                                                 entry_id=entry_id,
                                                 title=title, link=link,
                                                 date=date)
                if not exist:
                    summary = entry["summary"] if "summary" in entry.keys() else ''
                    if not summary:
                        summary = (entry["content_html"]
                                   if "content_html" in entry.keys()
                                   else '')
                    if not summary:
                        summary = (entry["content_text"]
                                   if "content_text" in entry.keys()
                                   else '')
                    read_status = 0
                    pathname = urlsplit(link).path
                    string = (
                        "{} {} {}"
                        ).format(
                            title, summary, pathname)
                    if self.settings['default']['filter']:
                        print('Filter is now processing data.')
                        allow_list = config.is_include_keyword(db_file,
                                                               "allow", string)
                        if not allow_list:
                            reject_list = config.is_include_keyword(db_file,
                                                                    "deny",
                                                                    string)
                            if reject_list:
                                read_status = 1
                                logger.debug('Rejected : {}'
                                             '\n'
                                             'Keyword  : {}'
                                             .format(link, reject_list))
                    if isinstance(date, int):
                        logger.error('Variable "date" is int: {}'.format(date))
                    media_link = ''
                    if "attachments" in entry.keys():
                        for e_link in entry["attachments"]:
                            try:
                                # if (link.rel == "enclosure" and
                                #     (link.type.startswith("audio/") or
                                #      link.type.startswith("image/") or
                                #      link.type.startswith("video/"))
                                #     ):
                                media_type = e_link["mime_type"][:e_link["mime_type"].index("/")]
                                if media_type in ("audio", "image", "video"):
                                    media_link = e_link["url"]
                                    media_link = join_url(url, e_link["url"])
                                    media_link = trim_url(media_link)
                                    break
                            except:
                                logger.error('KeyError: "url"\n'
                                             'Missing "url" attribute for {}'
                                             .format(url))
                                logger.error('Continue scanning for next '
                                             'potential enclosure of {}'
                                             .format(link))
                    entry = {
                        "title": title,
                        "link": link,
                        "enclosure": media_link,
                        "entry_id": entry_id,
                        "date": date,
                        "read_status": read_status
                        }
                    new_entries.extend([entry])
                    # await sqlite.add_entry(
                    #     db_file, title, link, entry_id,
                    #     url, date, read_status)
                    # await sqlite.set_date(db_file, url)
        if len(new_entries):
            feed_id = sqlite.get_feed_id(db_file, url)
            feed_id = feed_id[0]
            await sqlite.add_entries_and_update_feed_state(db_file, feed_id,
                                                           new_entries)


def view_feed(url, feed):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: url: {}'
                 .format(function_name, url))
    if "title" in feed["feed"].keys():
        title = feed["feed"]["title"]
    else:
        title = urlsplit(url).netloc
    entries = feed.entries
    response = "Preview of {}:\n\n```\n".format(title)
    counter = 0
    for entry in entries:
        counter += 1
        if entry.has_key("title"):
            title = entry.title
        else:
            title = "*** No title ***"
        if entry.has_key("link"):
            # link = complete_url(source, entry.link)
            link = join_url(url, entry.link)
            link = trim_url(link)
        else:
            link = "*** No link ***"
        if entry.has_key("published"):
            date = entry.published
            date = dt.rfc2822_to_iso8601(date)
        elif entry.has_key("updated"):
            date = entry.updated
            date = dt.rfc2822_to_iso8601(date)
        else:
            date = "*** No date ***"
        response += ("Title : {}\n"
                     "Date  : {}\n"
                     "Link  : {}\n"
                     "Count : {}\n"
                     "\n"
                     .format(title, date, link, counter))
        if counter > 4:
            break
    response += (
        "```\nSource: {}"
        ).format(url)
    return response


def view_entry(url, feed, num):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: url: {} num: {}'
                .format(function_name, url, num))
    if "title" in feed["feed"].keys():
        title = feed["feed"]["title"]
    else:
        title = urlsplit(url).netloc
    entries = feed.entries
    num = int(num) - 1
    entry = entries[num]
    response = "Preview of {}:\n\n```\n".format(title)
    if entry.has_key("title"):
        title = entry.title
    else:
        title = "*** No title ***"
    if entry.has_key("published"):
        date = entry.published
        date = dt.rfc2822_to_iso8601(date)
    elif entry.has_key("updated"):
        date = entry.updated
        date = dt.rfc2822_to_iso8601(date)
    else:
        date = "*** No date ***"
    if entry.has_key("summary"):
        summary = entry.summary
        # Remove HTML tags
        summary = BeautifulSoup(summary, "lxml").text
        # TODO Limit text length
        summary = summary.replace("\n\n\n", "\n\n")
    else:
        summary = "*** No summary ***"
    if entry.has_key("link"):
        # link = complete_url(source, entry.link)
        link = join_url(url, entry.link)
        link = trim_url(link)
    else:
        link = "*** No link ***"
    response = ("{}\n"
                "\n"
                # "> {}\n"
                "{}\n"
                "\n"
                "{}\n"
                "\n"
                .format(title, summary, link))
    return response


async def download_feed(self, db_file, feed_url):
    """
    Get feed content.

    Parameters
    ----------
    db_file : str
        Path to database file.
    url : str, optional
        URL.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: db_file: {} url: {}'
                .format(function_name, db_file, feed_url))
    if isinstance(feed_url, tuple): feed_url = feed_url[0]
    result = await fetch.http(feed_url)
    feed_id = sqlite.get_feed_id(db_file, feed_url)
    feed_id = feed_id[0]
    status_code = result['status_code']
    await sqlite.update_feed_status(db_file, feed_id, status_code)


def get_properties_of_feed(db_file, feed_id, feed):

    if feed.has_key('updated_parsed'):
        feed_updated = feed.updated_parsed
        try:
            feed_updated = dt.convert_struct_time_to_iso8601(feed_updated)
        except:
            feed_updated = ''
    else:
        feed_updated = ''

    entries_count = len(feed.entries)

    feed_version = feed.version if feed.has_key('version') else ''
    feed_encoding = feed.encoding if feed.has_key('encoding') else ''
    feed_language = feed.feed.language if feed.feed.has_key('language') else ''
    feed_icon = feed.feed.icon if feed.feed.has_key('icon') else ''
    feed_image = feed.feed.image.href if feed.feed.has_key('image') else ''
    feed_logo = feed.feed.logo if feed.feed.has_key('logo') else ''
    feed_ttl = feed.feed.ttl if feed.feed.has_key('ttl') else ''

    feed_properties = {
        "version" : feed_version,
        "encoding" : feed_encoding,
        "language" : feed_language,
        "rating" : '',
        "entries_count" : entries_count,
        "icon" : feed_icon,
        "image" : feed_image,
        "logo" : feed_logo,
        "ttl" : feed_ttl,
        "updated" : feed_updated,
        }

    return feed_properties

# TODO get all active feeds of active accounts and scan the feed with the earliest scanned time
# TODO Rename function name (idea: scan_and_populate)
def get_properties_of_entries(jid_bare, db_file, feed_url, feed_id, feed):
    """
    Get new entries.

    Parameters
    ----------
    db_file : str
        Path to database file.
    url : str, optional
        URL.
    """
    # print('MID', feed_url, jid_bare, 'get_properties_of_entries')
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: feed_id: {} url: {}'
                .format(function_name, feed_id, feed_url))

    new_entries = []
    for entry in feed.entries:
        logger.debug('{}: entry: {}'.format(function_name, entry.link))
        if entry.has_key("published"):
            entry_published = entry.published
            entry_published = dt.rfc2822_to_iso8601(entry_published)
        else:
            entry_published = ''
        if entry.has_key("updated"):
            entry_updated = entry.updated
            entry_updated = dt.rfc2822_to_iso8601(entry_updated)
        else:
            entry_updated = dt.now()
        if entry.has_key("link"):
            # link = complete_url(source, entry.link)
            entry_link = join_url(feed_url, entry.link)
            entry_link = trim_url(entry_link)
        else:
            entry_link = feed_url
        # title = feed["feed"]["title"]
        # title = "{}: *{}*".format(feed["feed"]["title"], entry.title)
        entry_title = entry.title if entry.has_key("title") else entry_published
        entry_id = entry.id if entry.has_key("id") else entry_link
        exist = sqlite.check_entry_exist(db_file, feed_id,
                                         identifier=entry_id,
                                         title=entry_title,
                                         link=entry_link,
                                         published=entry_published)
        if not exist:
            read_status = 0
            # # Filter
            # pathname = urlsplit(link).path
            # string = (
            #     "{} {} {}"
            #     ).format(
            #         title, summary, pathname)
            # if self.settings['default']['filter']:
            #     print('Filter is now processing data.')
            #     allow_list = config.is_include_keyword(db_file,
            #                                            "allow", string)
            #     if not allow_list:
            #         reject_list = config.is_include_keyword(db_file,
            #                                                 "deny",
            #                                                 string)
            #         if reject_list:
            #             read_status = 1
            #             logger.debug('Rejected : {}'
            #                          '\n'
            #                          'Keyword  : {}'
            #                          .format(link, reject_list))
            if isinstance(entry_published, int):
                logger.error('Variable "published" is int: {}'.format(entry_published))
            if isinstance(entry_updated, int):
                logger.error('Variable "updated" is int: {}'.format(entry_updated))

            # Authors
            entry_authors =[]
            if entry.has_key('authors'):
                for author in entry.authors:
                    author_properties = {
                        'name' : author.name if author.has_key('name') else '',
                        'url' : author.href if author.has_key('href') else '',
                        'email' : author.email if author.has_key('email') else '',
                        }
                    entry_authors.extend([author_properties])
            elif entry.has_key('author_detail'):
                author_properties = {
                    'name' : entry.author_detail.name if entry.author_detail.has_key('name') else '',
                    'url' : entry.author_detail.href if entry.author_detail.has_key('href') else '',
                    'email' : entry.author_detail.email if entry.author_detail.has_key('email') else '',
                    }
                entry_authors.extend([author_properties])
            elif entry.has_key('author'):
                author_properties = {
                    'name' : entry.author,
                    'url' : '',
                    'email' : '',
                    }
                entry_authors.extend([author_properties])

            # Contributors
            entry_contributors = []
            if entry.has_key('contributors'):
                for contributor in entry.contributors:
                    contributor_properties = {
                        'name' : contributor.name if contributor.has_key('name') else '',
                        'url' : contributor.href if contributor.has_key('href') else '',
                        'email' : contributor.email if contributor.has_key('email') else '',
                        }
                    entry_contributors.extend([contributor_properties])

            # Tags
            entry_tags = []
            if entry.has_key('tags'):
                for tag in entry.tags:
                    tag_properties = {
                        'term' : tag.term if tag.has_key('term') else '',
                        'scheme' : tag.scheme if tag.has_key('scheme') else '',
                        'label' : tag.label if tag.has_key('label') else '',
                        }
                    entry_tags.extend([tag_properties])

            # Content
            entry_contents = []
            if entry.has_key('content'):
                for content in entry.content:
                    text = content.value if content.has_key('value') else ''
                    type = content.type if content.has_key('type') else ''
                    lang = content.lang if content.has_key('lang') else ''
                    base = content.base if content.has_key('base') else ''
                    entry_content = {
                        'text' : text,
                        'lang' : lang,
                        'type' : type,
                        'base' : base,
                        }
                    entry_contents.extend([entry_content])

            # Links and Enclosures
            entry_links = []
            if entry.has_key('links'):
                for link in entry.links:
                    link_properties = {
                        'url' : link.href if link.has_key('href') else '',
                        'rel' : link.rel if link.has_key('rel') else '',
                        'type' : link.type if link.has_key('type') else '',
                        'length' : '',
                        }
                    entry_links.extend([link_properties])
            # Element media:content is utilized by Mastodon
            if entry.has_key('media_content'):
                for link in entry.media_content:
                    link_properties = {
                        'url' : link['url'] if 'url' in link else '',
                        'rel' : 'enclosure',
                        'type' : link['type'] if 'type' in link else '',
                        # 'medium' : link['medium'] if 'medium' in link else '',
                        'length' : link['filesize'] if 'filesize' in link else '',
                        }
                    entry_links.extend([link_properties])
            if entry.has_key('media_thumbnail'):
                for link in entry.media_thumbnail:
                    link_properties = {
                        'url' : link['url'] if 'url' in link else '',
                        'rel' : 'enclosure',
                        'type' : '',
                        # 'medium' : 'image',
                        'length' : '',
                        }
                    entry_links.extend([link_properties])

            # Category
            entry_category = entry.category if entry.has_key('category') else ''

            # Comments
            entry_comments = entry.comments if entry.has_key('comments') else ''

            # href
            entry_href = entry.href if entry.has_key('href') else ''

            # Link: Same as entry.links[0].href in most if not all cases
            entry_link = entry.link if entry.has_key('link') else ''

            # Rating
            entry_rating = entry.rating if entry.has_key('rating') else ''

            # Summary
            entry_summary_text = entry.summary if entry.has_key('summary') else ''
            if entry.has_key('summary_detail'):
                entry_summary_type = entry.summary_detail.type if entry.summary_detail.has_key('type') else ''
                entry_summary_lang = entry.summary_detail.lang if entry.summary_detail.has_key('lang') else ''
                entry_summary_base = entry.summary_detail.base if entry.summary_detail.has_key('base') else ''
            else:
                entry_summary_type = ''
                entry_summary_lang = ''
                entry_summary_base = ''

            # Title
            entry_title = entry.title if entry.has_key('title') else ''
            if entry.has_key('title_detail'):
                entry_title_type = entry.title_detail.type if entry.title_detail.has_key('type') else ''
            else:
                entry_title_type = ''

            ###########################################################

            # media_type = e_link.type[:e_link.type.index("/")]
            # if (e_link.rel == "enclosure" and
            #     media_type in ("audio", "image", "video")):
            #     media_link = e_link.href
            #     media_link = join_url(url, e_link.href)
            #     media_link = trim_url(media_link)

            ###########################################################

            entry_properties = {
                "identifier": entry_id,
                "link": entry_link,
                "href": entry_href,
                "title": entry_title,
                "title_type": entry_title_type,
                'summary_text' : entry_summary_text,
                'summary_lang' : entry_summary_lang,
                'summary_type' : entry_summary_type,
                'summary_base' : entry_summary_base,
                'category' : entry_category,
                "comments": entry_comments,
                "rating": entry_rating,
                "published": entry_published,
                "updated": entry_updated,
                "read_status": read_status
                }

            new_entries.extend([{
                "entry_properties" : entry_properties,
                "entry_authors" : entry_authors,
                "entry_contributors" : entry_contributors,
                "entry_contents" : entry_contents,
                "entry_links" : entry_links,
                "entry_tags" : entry_tags
                }])
            # await sqlite.add_entry(
            #     db_file, title, link, entry_id,
            #     url, date, read_status)
            # await sqlite.set_date(db_file, url)
    return new_entries


async def extract_image_from_feed(db_file, feed_id, url):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: db_file: {} feed_id: {} url: {}'
                .format(function_name, db_file, feed_id, url))
    feed_url = sqlite.get_feed_url(db_file, feed_id)
    feed_url = feed_url[0]
    result = await fetch.http(feed_url)
    if not result['error']:
        document = result['content']
        feed = parse(document)
        for entry in feed.entries:
            try:
                if entry.link == url:
                    for link in entry.links:
                        if (link.rel == "enclosure" and
                            link.type.startswith("image/")):
                            image_url = link.href
                            return image_url
            except:
                logger.error(url)
                logger.error('AttributeError: object has no attribute "link"')


async def extract_image_from_html(url):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: url: {}'.format(function_name, url))
    result = await fetch.http(url)
    if not result['error']:
        data = result['content']
        tree = html.fromstring(data)
        # TODO Exclude banners, class="share" links etc.
        images = tree.xpath(
            '//img[not('
                'contains(@src, "avatar") or '
                'contains(@src, "emoji") or '
                'contains(@src, "icon") or '
                'contains(@src, "logo") or '
                'contains(@src, "letture") or '
                'contains(@src, "search") or '
                'contains(@src, "share") or '
                'contains(@src, "smiley")'
            ')]/@src')
        if len(images):
            image = images[0]
            image = str(image)
            image_url = complete_url(url, image)
            return image_url


# This works too
# ''.join(xml.etree.ElementTree.fromstring(text).itertext())
def remove_html_tags(data):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}'.format(function_name))
    data = BeautifulSoup(data, "lxml").text
    data = data.replace("\n\n", "\n")
    return data

# TODO Add support for eDonkey, Gnutella, Soulseek
async def get_magnet(link):
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: {}'.format(function_name, link))
    parted_link = urlsplit(link)
    queries = parse_qs(parted_link.query)
    query_xt = queries["xt"][0]
    if query_xt.startswith("urn:btih:"):
        filename = queries["dn"][0]
        checksum = query_xt[len("urn:btih:"):]
        torrent = await fetch.magnet(link)
        logger.debug('Attempting to retrieve {} ({})'
                     .format(filename, checksum))
        if not torrent:
            logger.debug('Attempting to retrieve {} from HTTP caching service'
                         .format(filename))
            urls = [
                'https://watercache.libertycorp.org/get/{}/{}',
                'https://itorrents.org/torrent/{}.torrent?title={}',
                'https://firecache.libertycorp.org/get/{}/{}',
                'http://fcache63sakpihd44kxdduy6kgpdhgejgp323wci435zwy6kiylcnfad.onion/get/{}/{}'
                ]
            for url in urls:
                torrent = fetch.http(url.format(checksum, filename))
                if torrent:
                    break
    return torrent


async def remove_nonexistent_entries(self, jid_bare, db_file, url, feed):
    """
    Remove entries that don't exist in a given parsed feed.
    Check the entries returned from feed and delete read non
    existing entries, otherwise move to table archive, if unread.

    Parameters
    ----------
    db_file : str
        Path to database file.
    url : str
        Feed URL.
    feed : list
        Parsed feed document.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: db_file: {} url: {}'
                .format(function_name, db_file, url))
    feed_id = sqlite.get_feed_id(db_file, url)
    feed_id = feed_id[0]
    items = sqlite.get_entries_of_feed(db_file, feed_id)
    entries = feed.entries
    limit = Config.get_setting_value(self.settings, jid_bare, 'archive')
    for item in items:
        ix = item[0]
        entry_title = item[1]
        entry_link = item[2]
        entry_id = item[3]
        timestamp = item[4]
        read_status = item[5]
        valid = False
        for entry in entries:
            title = None
            link = None
            time = None
            # valid = False
            # TODO better check and don't repeat code
            if entry.has_key("id") and entry_id:
                if entry.id == entry_id:
                    # print("compare1:", entry.id)
                    # print("compare2:", entry_id)
                    # print("============")
                    valid = True
                    break
            else:
                if entry.has_key("title"):
                    title = entry.title
                else:
                    title = feed["feed"]["title"]
                if entry.has_key("link"):
                    link = join_url(url, entry.link)
                else:
                    link = url
                if entry.has_key("published") and timestamp:
                    # print("compare11:", title, link, time)
                    # print("compare22:", entry_title, entry_link, timestamp)
                    # print("============")
                    time = dt.rfc2822_to_iso8601(entry.published)
                    if (entry_title == title and
                        entry_link == link and
                        timestamp == time):
                        valid = True
                        break
                else:
                    if (entry_title == title and
                        entry_link == link):
                        # print("compare111:", title, link)
                        # print("compare222:", entry_title, entry_link)
                        # print("============")
                        valid = True
                        break
            # TODO better check and don't repeat code
        if not valid:
            # print("id:        ", ix)
            # if title:
            #     print("title:     ", title)
            #     print("entry_title:   ", entry_title)
            # if link:
            #     print("link:      ", link)
            #     print("entry_link:   ", entry_link)
            # if entry.id:
            #     print("last_entry:", entry.id)
            #     print("entry_id:   ", entry_id)
            # if time:
            #     print("time:      ", time)
            #     print("timestamp:   ", timestamp)
            # print("read:      ", read_status)
            # breakpoint()

            # TODO Send to table archive
            # TODO Also make a regular/routine check for sources that
            #      have been changed (though that can only happen when
            #      manually editing)
            # ix = item[0]
            # print(">>> SOURCE: ", source)
            # print(">>> INVALID:", entry_title)
            # print("title:", entry_title)
            # print("link :", entry_link)
            # print("id   :", entry_id)
            if read_status == 1:
                await sqlite.delete_entry_by_id(db_file, ix)
                # print(">>> DELETING:", entry_title)
            else:
                # print(">>> ARCHIVING:", entry_title)
                await sqlite.archive_entry(db_file, ix)
        await sqlite.maintain_archive(db_file, limit)



async def remove_nonexistent_entries_json(self, jid_bare, db_file, url, feed):
    """
    Remove entries that don't exist in a given parsed feed.
    Check the entries returned from feed and delete read non
    existing entries, otherwise move to table archive, if unread.

    Parameters
    ----------
    db_file : str
        Path to database file.
    url : str
        Feed URL.
    feed : list
        Parsed feed document.
    """
    function_name = sys._getframe().f_code.co_name
    logger.debug('{}: db_file: {}: url: {}'
                .format(function_name, db_file, url))
    feed_id = sqlite.get_feed_id(db_file, url)
    feed_id = feed_id[0]
    items = sqlite.get_entries_of_feed(db_file, feed_id)
    entries = feed["items"]
    limit = Config.get_setting_value(self.settings, jid_bare, 'archive')
    for item in items:
        ix = item[0]
        entry_title = item[1]
        entry_link = item[2]
        entry_id = item[3]
        timestamp = item[4]
        read_status = item[5]
        valid = False
        for entry in entries:
            title = None
            link = None
            time = None
            # valid = False
            # TODO better check and don't repeat code
            if entry.has_key("id") and entry_id:
                if entry["id"] == entry_id:
                    # print("compare1:", entry.id)
                    # print("compare2:", entry_id)
                    # print("============")
                    valid = True
                    break
            else:
                if entry.has_key("title"):
                    title = entry["title"]
                else:
                    title = feed["title"]
                if entry.has_key("link"):
                    link = join_url(url, entry["link"])
                else:
                    link = url
                # "date_published" "date_modified"
                if entry.has_key("date_published") and timestamp:
                    time = dt.rfc2822_to_iso8601(entry["date_published"])
                    if (entry_title == title and
                        entry_link == link and
                        timestamp == time):
                        valid = True
                        break
                else:
                    if (entry_title == title and
                        entry_link == link):
                        valid = True
                        break
        if not valid:
            print("CHECK ENTRY OF JSON FEED IN ARCHIVE")
            if read_status == 1:
                await sqlite.delete_entry_by_id(db_file, ix)
            else:
                await sqlite.archive_entry(db_file, ix)
        await sqlite.maintain_archive(db_file, limit)