forked from openlp/openlp
517 lines
19 KiB
Python
517 lines
19 KiB
Python
# -*- coding: utf-8 -*-
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4
|
|
|
|
###############################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# --------------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2011 Raoul Snyman #
|
|
# Portions copyright (c) 2008-2011 Tim Bentley, Gerald Britton, Jonathan #
|
|
# Corwin, Michael Gorven, Scott Guerrieri, Matthias Hub, Meinert Jordan, #
|
|
# Armin Köhler, Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias #
|
|
# Põldaru, Christian Richter, Philip Ridout, Jeffrey Smith, Maikel #
|
|
# Stuivenberg, Martin Thompson, Jon Tibble, Frode Woldsund #
|
|
# --------------------------------------------------------------------------- #
|
|
# This program is free software; you can redistribute it and/or modify it #
|
|
# under the terms of the GNU General Public License as published by the Free #
|
|
# Software Foundation; version 2 of the License. #
|
|
# #
|
|
# This program is distributed in the hope that it will be useful, but WITHOUT #
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or #
|
|
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for #
|
|
# more details. #
|
|
# #
|
|
# You should have received a copy of the GNU General Public License along #
|
|
# with this program; if not, write to the Free Software Foundation, Inc., 59 #
|
|
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
|
|
###############################################################################
|
|
"""
|
|
The :mod:`openlp.core.utils` module provides the utility libraries for OpenLP.
|
|
"""
|
|
import logging
|
|
import os
|
|
import re
|
|
import sys
|
|
import time
|
|
import urllib2
|
|
from datetime import datetime
|
|
from subprocess import Popen, PIPE
|
|
|
|
from PyQt4 import QtGui, QtCore
|
|
|
|
if sys.platform != u'win32' and sys.platform != u'darwin':
|
|
try:
|
|
from xdg import BaseDirectory
|
|
XDG_BASE_AVAILABLE = True
|
|
except ImportError:
|
|
XDG_BASE_AVAILABLE = False
|
|
|
|
import openlp
|
|
from openlp.core.lib import Receiver, translate, check_directory_exists
|
|
|
|
log = logging.getLogger(__name__)
|
|
APPLICATION_VERSION = {}
|
|
IMAGES_FILTER = None
|
|
UNO_CONNECTION_TYPE = u'pipe'
|
|
#UNO_CONNECTION_TYPE = u'socket'
|
|
|
|
class VersionThread(QtCore.QThread):
|
|
"""
|
|
A special Qt thread class to fetch the version of OpenLP from the website.
|
|
This is threaded so that it doesn't affect the loading time of OpenLP.
|
|
"""
|
|
def __init__(self, parent):
|
|
QtCore.QThread.__init__(self, parent)
|
|
self.version_splitter = re.compile(
|
|
r'([0-9]+).([0-9]+).([0-9]+)(?:-bzr([0-9]+))?')
|
|
|
|
def run(self):
|
|
"""
|
|
Run the thread.
|
|
"""
|
|
time.sleep(1)
|
|
Receiver.send_message(u'maindisplay_blank_check')
|
|
app_version = get_application_version()
|
|
version = check_latest_version(app_version)
|
|
remote_version = {}
|
|
local_version = {}
|
|
match = self.version_splitter.match(version)
|
|
if match:
|
|
remote_version[u'major'] = int(match.group(1))
|
|
remote_version[u'minor'] = int(match.group(2))
|
|
remote_version[u'release'] = int(match.group(3))
|
|
if len(match.groups()) > 3 and match.group(4):
|
|
remote_version[u'revision'] = int(match.group(4))
|
|
else:
|
|
return
|
|
match = self.version_splitter.match(app_version[u'full'])
|
|
if match:
|
|
local_version[u'major'] = int(match.group(1))
|
|
local_version[u'minor'] = int(match.group(2))
|
|
local_version[u'release'] = int(match.group(3))
|
|
if len(match.groups()) > 3 and match.group(4):
|
|
local_version[u'revision'] = int(match.group(4))
|
|
else:
|
|
return
|
|
if remote_version[u'major'] > local_version[u'major'] or \
|
|
remote_version[u'minor'] > local_version[u'minor'] or \
|
|
remote_version[u'release'] > local_version[u'release']:
|
|
Receiver.send_message(u'openlp_version_check', u'%s' % version)
|
|
elif remote_version.get(u'revision') and \
|
|
local_version.get(u'revision') and \
|
|
remote_version[u'revision'] > local_version[u'revision']:
|
|
Receiver.send_message(u'openlp_version_check', u'%s' % version)
|
|
|
|
|
|
class DelayStartThread(QtCore.QThread):
|
|
"""
|
|
A special Qt thread class to build things after OpenLP has started
|
|
"""
|
|
def __init__(self, parent):
|
|
QtCore.QThread.__init__(self, parent)
|
|
|
|
def run(self):
|
|
"""
|
|
Run the thread.
|
|
"""
|
|
Receiver.send_message(u'openlp_phonon_creation')
|
|
|
|
|
|
class AppLocation(object):
|
|
"""
|
|
The :class:`AppLocation` class is a static class which retrieves a
|
|
directory based on the directory type.
|
|
"""
|
|
AppDir = 1
|
|
ConfigDir = 2
|
|
DataDir = 3
|
|
PluginsDir = 4
|
|
VersionDir = 5
|
|
CacheDir = 6
|
|
LanguageDir = 7
|
|
|
|
@staticmethod
|
|
def get_directory(dir_type=1):
|
|
"""
|
|
Return the appropriate directory according to the directory type.
|
|
|
|
``dir_type``
|
|
The directory type you want, for instance the data directory.
|
|
"""
|
|
if dir_type == AppLocation.AppDir:
|
|
return _get_frozen_path(
|
|
os.path.abspath(os.path.split(sys.argv[0])[0]),
|
|
os.path.split(openlp.__file__)[0])
|
|
elif dir_type == AppLocation.PluginsDir:
|
|
app_path = os.path.abspath(os.path.split(sys.argv[0])[0])
|
|
return _get_frozen_path(os.path.join(app_path, u'plugins'),
|
|
os.path.join(os.path.split(openlp.__file__)[0], u'plugins'))
|
|
elif dir_type == AppLocation.VersionDir:
|
|
return _get_frozen_path(
|
|
os.path.abspath(os.path.split(sys.argv[0])[0]),
|
|
os.path.split(openlp.__file__)[0])
|
|
elif dir_type == AppLocation.LanguageDir:
|
|
app_path = _get_frozen_path(
|
|
os.path.abspath(os.path.split(sys.argv[0])[0]),
|
|
_get_os_dir_path(dir_type))
|
|
return os.path.join(app_path, u'i18n')
|
|
else:
|
|
return _get_os_dir_path(dir_type)
|
|
|
|
@staticmethod
|
|
def get_data_path():
|
|
"""
|
|
Return the path OpenLP stores all its data under.
|
|
"""
|
|
path = AppLocation.get_directory(AppLocation.DataDir)
|
|
check_directory_exists(path)
|
|
return path
|
|
|
|
@staticmethod
|
|
def get_section_data_path(section):
|
|
"""
|
|
Return the path a particular module stores its data under.
|
|
"""
|
|
data_path = AppLocation.get_data_path()
|
|
path = os.path.join(data_path, section)
|
|
check_directory_exists(path)
|
|
return path
|
|
|
|
def _get_os_dir_path(dir_type):
|
|
"""
|
|
Return a path based on which OS and environment we are running in.
|
|
"""
|
|
encoding = sys.getfilesystemencoding()
|
|
if sys.platform == u'win32':
|
|
if dir_type == AppLocation.DataDir:
|
|
return os.path.join(unicode(os.getenv(u'APPDATA'), encoding),
|
|
u'openlp', u'data')
|
|
elif dir_type == AppLocation.LanguageDir:
|
|
return os.path.split(openlp.__file__)[0]
|
|
return os.path.join(unicode(os.getenv(u'APPDATA'), encoding),
|
|
u'openlp')
|
|
elif sys.platform == u'darwin':
|
|
if dir_type == AppLocation.DataDir:
|
|
return os.path.join(unicode(os.getenv(u'HOME'), encoding),
|
|
u'Library', u'Application Support', u'openlp', u'Data')
|
|
elif dir_type == AppLocation.LanguageDir:
|
|
return os.path.split(openlp.__file__)[0]
|
|
return os.path.join(unicode(os.getenv(u'HOME'), encoding),
|
|
u'Library', u'Application Support', u'openlp')
|
|
else:
|
|
if dir_type == AppLocation.LanguageDir:
|
|
return os.path.join(u'/usr', u'share', u'openlp')
|
|
if XDG_BASE_AVAILABLE:
|
|
if dir_type == AppLocation.ConfigDir:
|
|
return os.path.join(unicode(BaseDirectory.xdg_config_home,
|
|
encoding), u'openlp')
|
|
elif dir_type == AppLocation.DataDir:
|
|
return os.path.join(
|
|
unicode(BaseDirectory.xdg_data_home, encoding), u'openlp')
|
|
elif dir_type == AppLocation.CacheDir:
|
|
return os.path.join(unicode(BaseDirectory.xdg_cache_home,
|
|
encoding), u'openlp')
|
|
if dir_type == AppLocation.DataDir:
|
|
return os.path.join(unicode(os.getenv(u'HOME'), encoding),
|
|
u'.openlp', u'data')
|
|
return os.path.join(unicode(os.getenv(u'HOME'), encoding), u'.openlp')
|
|
|
|
def _get_frozen_path(frozen_option, non_frozen_option):
|
|
"""
|
|
Return a path based on the system status.
|
|
"""
|
|
if hasattr(sys, u'frozen') and sys.frozen == 1:
|
|
return frozen_option
|
|
return non_frozen_option
|
|
|
|
def get_application_version():
|
|
"""
|
|
Returns the application version of the running instance of OpenLP::
|
|
|
|
{u'full': u'1.9.4-bzr1249', u'version': u'1.9.4', u'build': u'bzr1249'}
|
|
"""
|
|
global APPLICATION_VERSION
|
|
if APPLICATION_VERSION:
|
|
return APPLICATION_VERSION
|
|
if u'--dev-version' in sys.argv or u'-d' in sys.argv:
|
|
# If we're running the dev version, let's use bzr to get the version.
|
|
try:
|
|
# If bzrlib is available, use it.
|
|
from bzrlib.branch import Branch
|
|
b = Branch.open_containing('.')[0]
|
|
b.lock_read()
|
|
try:
|
|
# Get the branch's latest revision number.
|
|
revno = b.revno()
|
|
# Convert said revision number into a bzr revision id.
|
|
revision_id = b.dotted_revno_to_revision_id((revno,))
|
|
# Get a dict of tags, with the revision id as the key.
|
|
tags = b.tags.get_reverse_tag_dict()
|
|
# Check if the latest
|
|
if revision_id in tags:
|
|
full_version = u'%s' % tags[revision_id][0]
|
|
else:
|
|
full_version = '%s-bzr%s' % \
|
|
(sorted(b.tags.get_tag_dict().keys())[-1], revno)
|
|
finally:
|
|
b.unlock()
|
|
except:
|
|
# Otherwise run the command line bzr client.
|
|
bzr = Popen((u'bzr', u'tags', u'--sort', u'time'), stdout=PIPE)
|
|
output, error = bzr.communicate()
|
|
code = bzr.wait()
|
|
if code != 0:
|
|
raise Exception(u'Error running bzr tags')
|
|
lines = output.splitlines()
|
|
if len(lines) == 0:
|
|
tag = u'0.0.0'
|
|
revision = u'0'
|
|
else:
|
|
tag, revision = lines[-1].split()
|
|
bzr = Popen((u'bzr', u'log', u'--line', u'-r', u'-1'), stdout=PIPE)
|
|
output, error = bzr.communicate()
|
|
code = bzr.wait()
|
|
if code != 0:
|
|
raise Exception(u'Error running bzr log')
|
|
latest = output.split(u':')[0]
|
|
full_version = latest == revision and tag or \
|
|
u'%s-bzr%s' % (tag, latest)
|
|
else:
|
|
# We're not running the development version, let's use the file.
|
|
filepath = AppLocation.get_directory(AppLocation.VersionDir)
|
|
filepath = os.path.join(filepath, u'.version')
|
|
fversion = None
|
|
try:
|
|
fversion = open(filepath, u'r')
|
|
full_version = unicode(fversion.read()).rstrip()
|
|
except IOError:
|
|
log.exception('Error in version file.')
|
|
full_version = u'0.0.0-bzr000'
|
|
finally:
|
|
if fversion:
|
|
fversion.close()
|
|
bits = full_version.split(u'-')
|
|
APPLICATION_VERSION = {
|
|
u'full': full_version,
|
|
u'version': bits[0],
|
|
u'build': bits[1] if len(bits) > 1 else None
|
|
}
|
|
if APPLICATION_VERSION[u'build']:
|
|
log.info(u'Openlp version %s build %s',
|
|
APPLICATION_VERSION[u'version'], APPLICATION_VERSION[u'build'])
|
|
else:
|
|
log.info(u'Openlp version %s' % APPLICATION_VERSION[u'version'])
|
|
return APPLICATION_VERSION
|
|
|
|
def check_latest_version(current_version):
|
|
"""
|
|
Check the latest version of OpenLP against the version file on the OpenLP
|
|
site.
|
|
|
|
``current_version``
|
|
The current version of OpenLP.
|
|
"""
|
|
version_string = current_version[u'full']
|
|
# set to prod in the distribution config file.
|
|
settings = QtCore.QSettings()
|
|
settings.beginGroup(u'general')
|
|
last_test = unicode(settings.value(u'last version test',
|
|
QtCore.QVariant(datetime.now().date())).toString())
|
|
this_test = unicode(datetime.now().date())
|
|
settings.setValue(u'last version test', QtCore.QVariant(this_test))
|
|
settings.endGroup()
|
|
if last_test != this_test:
|
|
if current_version[u'build']:
|
|
req = urllib2.Request(
|
|
u'http://www.openlp.org/files/dev_version.txt')
|
|
else:
|
|
req = urllib2.Request(u'http://www.openlp.org/files/version.txt')
|
|
req.add_header(u'User-Agent', u'OpenLP/%s' % current_version[u'full'])
|
|
remote_version = None
|
|
try:
|
|
remote_version = unicode(urllib2.urlopen(req, None).read()).strip()
|
|
except IOError:
|
|
log.exception(u'Failed to download the latest OpenLP version file')
|
|
if remote_version:
|
|
version_string = remote_version
|
|
return version_string
|
|
|
|
def add_actions(target, actions):
|
|
"""
|
|
Adds multiple actions to a menu or toolbar in one command.
|
|
|
|
``target``
|
|
The menu or toolbar to add actions to.
|
|
|
|
``actions``
|
|
The actions to be added. An action consisting of the keyword ``None``
|
|
will result in a separator being inserted into the target.
|
|
"""
|
|
for action in actions:
|
|
if action is None:
|
|
target.addSeparator()
|
|
else:
|
|
target.addAction(action)
|
|
|
|
def get_filesystem_encoding():
|
|
"""
|
|
Returns the name of the encoding used to convert Unicode filenames into
|
|
system file names.
|
|
"""
|
|
encoding = sys.getfilesystemencoding()
|
|
if encoding is None:
|
|
encoding = sys.getdefaultencoding()
|
|
return encoding
|
|
|
|
def get_images_filter():
|
|
"""
|
|
Returns a filter string for a file dialog containing all the supported
|
|
image formats.
|
|
"""
|
|
global IMAGES_FILTER
|
|
if not IMAGES_FILTER:
|
|
log.debug(u'Generating images filter.')
|
|
formats = [unicode(fmt)
|
|
for fmt in QtGui.QImageReader.supportedImageFormats()]
|
|
visible_formats = u'(*.%s)' % u'; *.'.join(formats)
|
|
actual_formats = u'(*.%s)' % u' *.'.join(formats)
|
|
IMAGES_FILTER = u'%s %s %s' % (translate('OpenLP', 'Image Files'),
|
|
visible_formats, actual_formats)
|
|
return IMAGES_FILTER
|
|
|
|
def split_filename(path):
|
|
"""
|
|
Return a list of the parts in a given path.
|
|
"""
|
|
path = os.path.abspath(path)
|
|
if not os.path.isfile(path):
|
|
return path, u''
|
|
else:
|
|
return os.path.split(path)
|
|
|
|
def delete_file(file_path_name):
|
|
"""
|
|
Deletes a file from the system.
|
|
|
|
``file_path_name``
|
|
The file, including path, to delete.
|
|
"""
|
|
if not file_path_name:
|
|
return False
|
|
try:
|
|
if os.path.exists(file_path_name):
|
|
os.remove(file_path_name)
|
|
return True
|
|
except (IOError, OSError):
|
|
log.exception("Unable to delete file %s" % file_path_name)
|
|
return False
|
|
|
|
def get_web_page(url, header=None, update_openlp=False):
|
|
"""
|
|
Attempts to download the webpage at url and returns that page or None.
|
|
|
|
``url``
|
|
The URL to be downloaded.
|
|
|
|
``header``
|
|
An optional HTTP header to pass in the request to the web server.
|
|
|
|
``update_openlp``
|
|
Tells OpenLP to update itself if the page is successfully downloaded.
|
|
Defaults to False.
|
|
"""
|
|
# TODO: Add proxy usage. Get proxy info from OpenLP settings, add to a
|
|
# proxy_handler, build into an opener and install the opener into urllib2.
|
|
# http://docs.python.org/library/urllib2.html
|
|
if not url:
|
|
return None
|
|
req = urllib2.Request(url)
|
|
if header:
|
|
req.add_header(header[0], header[1])
|
|
page = None
|
|
log.debug(u'Downloading URL = %s' % url)
|
|
try:
|
|
page = urllib2.urlopen(req)
|
|
log.debug(u'Downloaded URL = %s' % page.geturl())
|
|
except urllib2.URLError:
|
|
log.exception(u'The web page could not be downloaded')
|
|
if not page:
|
|
return None
|
|
if update_openlp:
|
|
Receiver.send_message(u'openlp_process_events')
|
|
log.debug(page)
|
|
return page
|
|
|
|
def file_is_unicode(filename):
|
|
"""
|
|
Checks if a file is valid unicode and returns the unicode decoded file or
|
|
None.
|
|
|
|
``filename``
|
|
File to check is valid unicode.
|
|
"""
|
|
if not filename:
|
|
return None
|
|
ucsfile = None
|
|
try:
|
|
ucsfile = filename.decode(u'utf-8')
|
|
except UnicodeDecodeError:
|
|
log.exception(u'Filename "%s" is not valid UTF-8' %
|
|
filename.decode(u'utf-8', u'replace'))
|
|
if not ucsfile:
|
|
return None
|
|
return ucsfile
|
|
|
|
def string_is_unicode(test_string):
|
|
"""
|
|
Makes sure a string is unicode.
|
|
|
|
``test_string``
|
|
The string to confirm is unicode.
|
|
"""
|
|
return_string = u''
|
|
if not test_string:
|
|
return return_string
|
|
if isinstance(test_string, unicode):
|
|
return_string = test_string
|
|
if not isinstance(test_string, unicode):
|
|
try:
|
|
return_string = unicode(test_string, u'utf-8')
|
|
except UnicodeError:
|
|
log.exception("Error encoding string to unicode")
|
|
return return_string
|
|
|
|
def get_uno_command():
|
|
"""
|
|
Returns the UNO command to launch an openoffice.org instance.
|
|
"""
|
|
COMMAND = u'soffice'
|
|
OPTIONS = u'-nologo -norestore -minimized -nodefault -nofirststartwizard'
|
|
if UNO_CONNECTION_TYPE == u'pipe':
|
|
CONNECTION = u'"-accept=pipe,name=openlp_pipe;urp;"'
|
|
else:
|
|
CONNECTION = u'"-accept=socket,host=localhost,port=2002;urp;"'
|
|
return u'%s %s %s' % (COMMAND, OPTIONS, CONNECTION)
|
|
|
|
def get_uno_instance(resolver):
|
|
"""
|
|
Returns a running openoffice.org instance.
|
|
|
|
``resolver``
|
|
The UNO resolver to use to find a running instance.
|
|
"""
|
|
log.debug(u'get UNO Desktop Openoffice - resolve')
|
|
if UNO_CONNECTION_TYPE == u'pipe':
|
|
return resolver.resolve(u'uno:pipe,name=openlp_pipe;' \
|
|
+ u'urp;StarOffice.ComponentContext')
|
|
else:
|
|
return resolver.resolve(u'uno:socket,host=localhost,port=2002;' \
|
|
+ u'urp;StarOffice.ComponentContext')
|
|
|
|
from languagemanager import LanguageManager
|
|
from actions import ActionList
|
|
|
|
__all__ = [u'AppLocation', u'get_application_version', u'check_latest_version',
|
|
u'add_actions', u'get_filesystem_encoding', u'LanguageManager',
|
|
u'ActionList', u'get_web_page', u'file_is_unicode', u'string_is_unicode',
|
|
u'get_uno_command', u'get_uno_instance', u'delete_file']
|