diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | bin/updater/Makefile | 15 | ||||
| -rw-r--r-- | bin/updater/README.rst | 9 | ||||
| -rw-r--r-- | bin/updater/build/lib/owncloud_news/__init__.py | 0 | ||||
| -rw-r--r-- | bin/updater/build/lib/owncloud_news/__main__.py | 3 | ||||
| -rw-r--r-- | bin/updater/build/lib/owncloud_news/application.py | 95 | ||||
| -rw-r--r-- | bin/updater/build/lib/owncloud_news/updater.py | 127 | ||||
| -rw-r--r-- | bin/updater/setup.py | 2 | ||||
| -rw-r--r-- | bin/updater/systemd/owncloud-news-updater.service (renamed from bin/updater/systemd/owncloud-news.service) | 0 |
9 files changed, 247 insertions, 7 deletions
diff --git a/.gitignore b/.gitignore index 1010a20f5..a485e6073 100644 --- a/.gitignore +++ b/.gitignore @@ -13,7 +13,8 @@ PKG-INFO *~ __pycache__ dist/ -ocdev.egg-info +owncloud_news_updater.egg-info +updater/build # just sane ignores .*.sw[po] diff --git a/bin/updater/Makefile b/bin/updater/Makefile index 7822c1a83..80f40509d 100644 --- a/bin/updater/Makefile +++ b/bin/updater/Makefile @@ -14,20 +14,23 @@ preinitsetup: clean cp $(CURDIR)/example-config.ini /etc/owncloud/news/updater.ini python3 setup.py install + install-systemd: preinitsetup cp $(CURDIR)/systemd/owncloud-news-updater.service /etc/systemd/system/ + @echo "" @echo "Installed files. Please edit your config in /etc/owncloud/news/updater.ini and run:" - @echo " systemctl enable owncloud-news-updater" - @echo " systemctl start owncloud-news-updater" + @echo " systemctl enable owncloud-news-updater.service" + @echo " systemctl start owncloud-news-updater.service" @echo "to run the updater on startup and:" - @echo " systemctl restart owncloud-news-updater" + @echo " systemctl restart owncloud-news-updater.service" @echo "to reload the changes if you change the config in /etc/owncloud/news/updater.ini" install-sysvinit: preinitsetup cp $(CURDIR)/sysvinit/owncloud-news-updater /etc/rc.d/ + @echo "" @echo "Installed files. Please edit your config in /etc/owncloud/news/updater.ini and run:" @echo " TBD" @echo " TBD" @@ -35,12 +38,14 @@ install-sysvinit: preinitsetup @echo " TBD" @echo "to reload the changes if you change the config in /etc/owncloud/news/updater.ini" -make uninstall: + +make uninstall: clean rm -rf /etc/owncloud/news/updater.ini rm -rf /etc/systemd/systemd/owncloud-news-updater.service # TBD uninstall sysvinit - python3 setup.py uninstall + pip3 uninstall owncloud_news_updater + @echo "" @echo "Uninstalled files. Please run: " @echo " systemctl disable owncloud-news-updater" @echo "to remove it from boot"
\ No newline at end of file diff --git a/bin/updater/README.rst b/bin/updater/README.rst index bc71b3a06..08ad0b82c 100644 --- a/bin/updater/README.rst +++ b/bin/updater/README.rst @@ -60,6 +60,15 @@ Installation: SysVinit TBD + +Uninstallation +-------------- + +To uninstall the script make sure that pip3 is installed (usually called python3-pip) and run:: + + make uninstall + + Self signed certificates ------------------------ diff --git a/bin/updater/build/lib/owncloud_news/__init__.py b/bin/updater/build/lib/owncloud_news/__init__.py new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/bin/updater/build/lib/owncloud_news/__init__.py diff --git a/bin/updater/build/lib/owncloud_news/__main__.py b/bin/updater/build/lib/owncloud_news/__main__.py new file mode 100644 index 000000000..695c2d19b --- /dev/null +++ b/bin/updater/build/lib/owncloud_news/__main__.py @@ -0,0 +1,3 @@ +from owncloud_news.application import main + +main()
\ No newline at end of file diff --git a/bin/updater/build/lib/owncloud_news/application.py b/bin/updater/build/lib/owncloud_news/application.py new file mode 100644 index 000000000..61eed3146 --- /dev/null +++ b/bin/updater/build/lib/owncloud_news/application.py @@ -0,0 +1,95 @@ +#!/usr/bin/env python3 +""" +Updater script for the news app which allows multiple feeds to be updated at +once to speed up the update process. Built in cron has to be disabled in the +news config, see the README.rst file in the top directory for more information. +""" +__author__ = 'Bernhard Posselt' +__copyright__ = 'Copyright 2012-2014, Bernhard Posselt' +__license__ = 'AGPL3+' +__maintainer__ = 'Bernhard Posselt' +__email__ = 'dev@bernhard-posselt.com' + +import sys +import argparse +import configparser + +from owncloud_news.updater import Updater + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument('--testrun', + help='Run update only once, DO NOT use this in a cron job, only \ + recommended for testing', action='store_true') + parser.add_argument('--threads', '-t', + help='How many feeds should be fetched in parallel, defaults to 10', + default=10, + type=int) + parser.add_argument('--timeout', '-s', + help='Maximum number of seconds for updating a feed, \ + defaults to 5 minutes', + default=5*60, + type=int) + parser.add_argument('--interval', '-i', + help='Update interval between fetching the next round of \ + updates in minutes, defaults to 30 minutes. The update timespan \ + will be subtracted from the interval.', + default=30, + type=int) + parser.add_argument('--config', '-c', + help='Path to config file where all parameters except can be defined \ + as key values pair. An example is in bin/example_config.ini') + parser.add_argument('--user', '-u', + help='Admin username to log into ownCloud. Must be specified on the \ + command line or in the config file.') + parser.add_argument('--password', '-p', + help='Admin password to log into ownCloud') + parser.add_argument('url', + help='The URL where owncloud is installed. Must be specified on the \ + command line or in the config file.', + nargs='?') + args = parser.parse_args() + + # read config file if given + if args.config: + config = configparser.ConfigParser() + files = config.read(args.config) + + if len(files) <= 0: + print('Error: could not find config file %s' % args.config) + exit(1) + + config_values = config['updater'] + if 'user' in config_values: + args.user = config_values['user'] + if 'password' in config_values: + args.password = config_values['password'] + if 'testrun' in config_values: + args.testrun = config_values.getboolean('testrun') + if 'threads' in config_values: + args.threads = int(config_values['threads']) + if 'interval' in config_values: + args.interval = int(config_values['interval']) + if 'url' in config_values: + args.url = config_values['url'] + + # url and user must be specified either from the command line or in the + # config file + if not args.url or not args.user: + parser.print_help() + exit(1) + + # create the updater and run the threads + updater = Updater(args.url, args.threads, args.interval, args.user, + args.password, args.timeout, args.testrun) + updater.run() + + +if __name__ == '__main__': + if sys.version_info < (3, 0): + print('Python 3.0 or higher is required to run this script') + else: + main() + + diff --git a/bin/updater/build/lib/owncloud_news/updater.py b/bin/updater/build/lib/owncloud_news/updater.py new file mode 100644 index 000000000..f59c4f05d --- /dev/null +++ b/bin/updater/build/lib/owncloud_news/updater.py @@ -0,0 +1,127 @@ +#!/usr/bin/env python3 + +import json +import threading +import requests +import time +import logging +import urllib + +def check_status_code(response): + if response.status_code != 200: + raise Exception('Request failed with %i: %s' % (response.status_code, + response.text)) + + +class Updater: + + def __init__(self, base_url, thread_num, interval, user, password, timeout, + run_once): + self.thread_num = thread_num + self.interval = interval + self.base_url = base_url + self.user = user + self.password = password + self.timeout = timeout + self.run_once = run_once + + if self.base_url[-1] != '/': + self.base_url += '/' + self.base_url += 'index.php/apps/news/api/v1-2' + + self.before_cleanup_url = '%s/cleanup/before-update' % self.base_url + self.after_cleanup_url = '%s/cleanup/after-update' % self.base_url + self.all_feeds_url = '%s/feeds/all' % self.base_url + self.update_url = '%s/feeds/update' % self.base_url + + # logging + format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s' + logging.basicConfig(format=format) + self.logger = logging.getLogger('ownCloud News Updater') + self.logger.setLevel(logging.INFO) + + + def run(self): + while True: + self.start_time = time.time() # reset clock + + try: + # run the cleanup request and get all the feeds to update + auth = (self.user, self.password) + + before = requests.get(self.before_cleanup_url, auth=auth) + check_status_code(before) + + feeds_response = requests.get(self.all_feeds_url, auth=auth) + check_status_code(feeds_response) + + feeds_json = feeds_response.text + feeds = json.loads(feeds_json)['feeds'] + + # start thread_num threads which update the feeds + threads = [] + for num in range(0, self.thread_num): + thread = UpdateThread(feeds, self.update_url, self.user, + self.password, self.timeout, self.logger) + thread.start() + threads.append(thread) + + for thread in threads: + thread.join() + + after = requests.get(self.after_cleanup_url, auth=auth) + check_status_code(after) + + if self.run_once: + return + + # wait until the interval finished to run again and subtract + # the update run time from the interval + timeout = self.interval - int((time.time() - self.start_time)) + if timeout > 0: + time.sleep(timeout) + + except (Exception) as e: + self.logger.error('%s: %s Trying again in 30 seconds' % + (self.base_url, e)) + time.sleep(30) + + +class UpdateThread(threading.Thread): + + lock = threading.Lock() + + def __init__(self, feeds, update_url, user, password, timeout, logger): + super().__init__() + self.feeds = feeds + self.update_url = update_url + self.user = user + self.password = password + self.timeout = timeout + self.logger = logger + + def run(self): + while True: + with UpdateThread.lock: + if len(self.feeds) > 0: + feed = self.feeds.pop() + else: + return + + feed['feedId'] = feed['id'] + del feed['id'] + + # call the update method of one feed + data = urllib.parse.urlencode(feed) + headers = { + 'Content-type': 'application/json', + 'Accept': 'text/plain' + } + url = '%s?%s' % (self.update_url, data) + + try: + auth = (self.user, self.password) + request = requests.get(url, auth=auth, timeout=self.timeout) + check_status_code(request) + except (Exception) as e: + self.logger.error('%s: %s' % (url, e)) diff --git a/bin/updater/setup.py b/bin/updater/setup.py index 4fc64a63b..b6475c276 100644 --- a/bin/updater/setup.py +++ b/bin/updater/setup.py @@ -19,7 +19,7 @@ for element in tree.findall('version'): version = element.text setup ( - name = 'owncloud-news-updater', + name = 'owncloud_news_updater', version = version, description = 'ownCloud news updater', long_description = long_description, diff --git a/bin/updater/systemd/owncloud-news.service b/bin/updater/systemd/owncloud-news-updater.service index b9873502f..b9873502f 100644 --- a/bin/updater/systemd/owncloud-news.service +++ b/bin/updater/systemd/owncloud-news-updater.service |