2007-09-06 22:24:44 +02:00
|
|
|
# Copyright (C) 2007, Red Hat, Inc.
|
2009-03-03 11:12:05 +01:00
|
|
|
# Copyright (C) 2009 Aleksey Lim
|
2007-09-06 22:24:44 +02:00
|
|
|
#
|
|
|
|
# This library is free software; you can redistribute it and/or
|
|
|
|
# modify it under the terms of the GNU Lesser General Public
|
|
|
|
# License as published by the Free Software Foundation; either
|
|
|
|
# version 2 of the License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# This library 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
|
|
|
|
# Lesser General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU Lesser General Public
|
|
|
|
# License along with this library; if not, write to the
|
|
|
|
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
|
# Boston, MA 02111-1307, USA.
|
|
|
|
|
2008-10-28 14:19:01 +01:00
|
|
|
"""Sugar content bundles
|
|
|
|
|
|
|
|
UNSTABLE.
|
|
|
|
"""
|
2007-09-06 22:24:44 +02:00
|
|
|
|
|
|
|
from ConfigParser import ConfigParser
|
2013-07-03 21:46:46 +02:00
|
|
|
import tempfile
|
2007-09-06 22:24:44 +02:00
|
|
|
import os
|
2008-07-16 18:48:31 +02:00
|
|
|
import urllib
|
2007-09-06 22:24:44 +02:00
|
|
|
|
2011-10-29 15:55:20 +02:00
|
|
|
from sugar3 import env
|
2013-06-06 21:05:06 +02:00
|
|
|
from sugar3.bundle.bundle import Bundle, MalformedBundleException
|
2007-09-06 22:24:44 +02:00
|
|
|
|
2011-10-29 10:44:18 +02:00
|
|
|
from sugar3.bundle.bundleversion import NormalizedVersion
|
|
|
|
from sugar3.bundle.bundleversion import InvalidVersionError
|
2010-11-24 22:40:16 +01:00
|
|
|
|
2009-08-25 21:12:40 +02:00
|
|
|
|
2007-09-06 22:24:44 +02:00
|
|
|
class ContentBundle(Bundle):
|
|
|
|
"""A Sugar content bundle
|
|
|
|
|
|
|
|
See http://wiki.laptop.org/go/Content_bundles for details
|
|
|
|
"""
|
|
|
|
|
|
|
|
MIME_TYPE = 'application/vnd.olpc-content'
|
|
|
|
|
|
|
|
_zipped_extension = '.xol'
|
|
|
|
_unzipped_extension = None
|
|
|
|
_infodir = 'library'
|
|
|
|
|
|
|
|
def __init__(self, path):
|
|
|
|
Bundle.__init__(self, path)
|
|
|
|
|
2008-04-19 11:48:57 +02:00
|
|
|
self._locale = None
|
|
|
|
self._name = None
|
2013-07-03 21:46:46 +02:00
|
|
|
self._icon = None
|
2010-11-24 22:40:16 +01:00
|
|
|
self._library_version = '0'
|
2013-07-03 21:46:46 +02:00
|
|
|
self._activity_start = 'index.html'
|
2009-07-09 13:41:05 +02:00
|
|
|
self._global_name = None
|
2008-04-19 11:48:57 +02:00
|
|
|
|
2008-07-15 17:41:47 +02:00
|
|
|
info_file = self.get_file('library/library.info')
|
2007-09-06 22:24:44 +02:00
|
|
|
if info_file is None:
|
|
|
|
raise MalformedBundleException('No library.info file')
|
|
|
|
self._parse_info(info_file)
|
|
|
|
|
2013-07-03 21:46:46 +02:00
|
|
|
if self.get_file(self._activity_start) is None:
|
2007-09-06 22:24:44 +02:00
|
|
|
raise MalformedBundleException(
|
2013-07-03 21:46:46 +02:00
|
|
|
'Content bundle %s does not have start page %s' %
|
|
|
|
(self._path, self._activity_start))
|
2007-09-06 22:24:44 +02:00
|
|
|
|
|
|
|
def _parse_info(self, info_file):
|
|
|
|
cp = ConfigParser()
|
|
|
|
cp.readfp(info_file)
|
|
|
|
|
|
|
|
section = 'Library'
|
|
|
|
|
|
|
|
if cp.has_option(section, 'name'):
|
|
|
|
self._name = cp.get(section, 'name')
|
|
|
|
else:
|
|
|
|
raise MalformedBundleException(
|
|
|
|
'Content bundle %s does not specify a name' % self._path)
|
|
|
|
|
|
|
|
if cp.has_option(section, 'library_version'):
|
|
|
|
version = cp.get(section, 'library_version')
|
|
|
|
try:
|
2010-11-24 22:40:16 +01:00
|
|
|
NormalizedVersion(version)
|
|
|
|
except InvalidVersionError:
|
2007-09-06 22:24:44 +02:00
|
|
|
raise MalformedBundleException(
|
|
|
|
'Content bundle %s has invalid version number %s' %
|
|
|
|
(self._path, version))
|
2010-11-24 22:40:16 +01:00
|
|
|
self._library_version = version
|
2007-09-06 22:24:44 +02:00
|
|
|
|
|
|
|
if cp.has_option(section, 'locale'):
|
|
|
|
self._locale = cp.get(section, 'locale')
|
|
|
|
|
2009-07-09 13:41:05 +02:00
|
|
|
if cp.has_option(section, 'global_name'):
|
|
|
|
self._global_name = cp.get(section, 'global_name')
|
|
|
|
|
2013-07-03 21:46:46 +02:00
|
|
|
if cp.has_option(section, 'icon'):
|
|
|
|
self._icon = cp.get(section, 'icon')
|
2007-09-06 22:24:44 +02:00
|
|
|
|
2013-07-03 21:46:46 +02:00
|
|
|
# Compatibility with old content bundles
|
|
|
|
if not self._global_name is None \
|
|
|
|
and cp.has_option(section, 'bundle_class'):
|
|
|
|
self._global_name = cp.get(section, 'bundle_class')
|
2007-09-06 22:24:44 +02:00
|
|
|
|
2008-07-16 18:48:31 +02:00
|
|
|
if cp.has_option(section, 'activity_start'):
|
|
|
|
self._activity_start = cp.get(section, 'activity_start')
|
|
|
|
|
2013-07-03 21:46:46 +02:00
|
|
|
if self._global_name is None:
|
2009-07-09 13:41:05 +02:00
|
|
|
raise MalformedBundleException(
|
2013-07-03 21:46:46 +02:00
|
|
|
'Content bundle %s must specify global_name' % self._path)
|
2009-07-09 13:41:05 +02:00
|
|
|
|
2007-09-06 22:24:44 +02:00
|
|
|
def get_name(self):
|
|
|
|
return self._name
|
|
|
|
|
|
|
|
def get_library_version(self):
|
|
|
|
return self._library_version
|
|
|
|
|
|
|
|
def get_locale(self):
|
|
|
|
return self._locale
|
|
|
|
|
2008-07-16 18:48:31 +02:00
|
|
|
def get_activity_start(self):
|
|
|
|
return self._activity_start
|
|
|
|
|
2013-06-06 21:05:06 +02:00
|
|
|
def get_icon(self):
|
2013-07-03 21:46:46 +02:00
|
|
|
if not self._icon:
|
|
|
|
return None
|
2013-06-06 21:05:06 +02:00
|
|
|
|
2013-07-03 21:46:46 +02:00
|
|
|
icon_path = os.path.join('library', self._icon)
|
|
|
|
ext = os.path.splitext(icon_path)[1]
|
|
|
|
if ext == '':
|
|
|
|
ext = '.svg'
|
|
|
|
icon_path += ext
|
2007-09-06 22:24:44 +02:00
|
|
|
|
2013-07-03 21:46:46 +02:00
|
|
|
if self._zip_file is None:
|
|
|
|
return os.path.join(self._path, icon_path)
|
|
|
|
else:
|
|
|
|
icon_data = self.get_file(icon_path).read()
|
|
|
|
temp_file, temp_file_path = tempfile.mkstemp(prefix=self._icon,
|
|
|
|
suffix=ext)
|
|
|
|
os.write(temp_file, icon_data)
|
|
|
|
os.close(temp_file)
|
|
|
|
return temp_file_path
|
2008-07-16 18:48:31 +02:00
|
|
|
|
|
|
|
def get_start_uri(self):
|
2013-07-03 21:46:46 +02:00
|
|
|
path = os.path.join(self.get_path(), self._activity_start)
|
|
|
|
return 'file://' + urllib.pathname2url(path)
|
2008-07-16 18:48:31 +02:00
|
|
|
|
2009-03-03 11:12:05 +01:00
|
|
|
def get_bundle_id(self):
|
2013-07-03 21:46:46 +02:00
|
|
|
return self._global_name
|
2009-03-03 11:12:05 +01:00
|
|
|
|
|
|
|
def get_activity_version(self):
|
|
|
|
return self._library_version
|
|
|
|
|
2013-07-03 21:46:46 +02:00
|
|
|
def get_tags(self):
|
|
|
|
return None
|
|
|
|
|
2011-03-02 18:26:14 +01:00
|
|
|
def install(self):
|
2009-03-03 11:12:05 +01:00
|
|
|
install_path = env.get_user_library_path()
|
|
|
|
self._unzip(install_path)
|
2013-07-03 21:46:46 +02:00
|
|
|
return os.path.join(install_path, self._zip_root_dir)
|
2007-09-06 22:24:44 +02:00
|
|
|
|
2013-06-06 21:05:06 +02:00
|
|
|
def uninstall(self, force=False, delete_profile=False):
|
|
|
|
install_dir = self._path
|
2007-10-04 20:58:43 +02:00
|
|
|
self._uninstall(install_dir)
|
2013-06-06 21:05:06 +02:00
|
|
|
|
|
|
|
def is_user_activity(self):
|
|
|
|
# All content bundles are installed in user storage
|
|
|
|
return True
|