Merge lp:~fenryxo/zim/patches into lp:~jaap.karssenberg/zim/pyzim

[Jiří Janoušek]

1. Loading plugins in per-user site-packages directory.
2. During HTML export spaces in page links have not been converted to underscores causing broken links. Fixed.

[lp:~fenryxo/zim/patches]

301. By Jaap Karssenberg on 2010-09-10

* Fixed bug with unicode handling for file objects
* Added names for pageindex and pageview widgets for use in gtkrc
* Added special case for mid: and cid: uris when parsing links
* Fixed printtobrowser plugin to use proper preference for web browser
* Added checkbox to quicknote dialog to open the new page or not
* Added character count to "Count words" dialog

302. By Jaap Karssenberg on 2010-09-11

* Reworked setdefault a bit so tasklist plugin can have empty string for labels
* Fixed unicode conversion in Path so e.g. tasklist dialog opens non-ascii page names correctly

303. By Jaap Karssenberg on 2010-09-12

Possible fix for unicode in quicknote dialog

304. By Jaap Karssenberg on 2010-09-12

Fix for issues with empty lines automatically inserted after indented
sections. Added a new parsetree element 'div' with a property 'indent'
to handle indenting within paragraphs. Also 'ul' can now have the 'indent'
property. Should fix bug lp:297932.

305. By Jaap Karssenberg on 2010-09-16

Updated file write logic for Windows

[Jaap Karssenberg (jaap.karssenberg)]

Will merge this patch with two changes:
1) will use "zim.plugins.path" instead of "zim.plugins.__path__" -- please note that all double underscore names are in principle reserved for future use by python
2) will make fix for spaces in exported paths more robust by using "encode_filename()" instead of "replace(' ', '_')" -- this way we ensure other encoding stuff is done as well

review: Approve

[lp:~fenryxo/zim/patches]

306. By Jaap Karssenberg on 2010-09-19

Merging path by Jiří Janoušek
* Backport per-user site-packages dir for python 2.5
* Fix bug with spaces in links in exported HTML

[Jiří Janoušek (fenryxo)]

1) I know double underscored names are reserved, but __path__ has to be used, because the function __import__ (in zim.plugins.get_plugin_module) uses __path__ to find a plugin module for import. Rev306 doesn't work for me. I have plugin "jjcms" (directory jjcms with __init__.py and other *.py files) in "~/.local/lib/python2.6/site-packages/zim/plugins/" and Zim rev306 tells me "Failed to load plugin jjcms". (BTW "return mypath" is missing in _check_path()).

$ zim -D --no-daemon
...
ERROR: Could not load plugin jjcms
Traceback (most recent call last):
  File "/home/jirkaxx/dev/prj/zim/trunk/zim/gui/preferencesdialog.py", line 303, in __init__
    klass = zim.plugins.get_plugin(name)
  File "/home/jirkaxx/dev/prj/zim/trunk/zim/plugins/__init__.py", line 75, in get_plugin
    mod = get_plugin_module(pluginname)
  File "/home/jirkaxx/dev/prj/zim/trunk/zim/plugins/__init__.py", line 67, in get_plugin_module
    mod = __import__('zim.plugins.'+pluginname)
ImportError: No module named jjcms
...

The idea of extending __path__ originally comes from plugin system of Sonata <http://sonata.berlios.de/>.

2) Yes, it's the proper solution :-)

[Jaap Karssenberg (jaap.karssenberg)]

2010/9/20 Jiří Janoušek <email address hidden>:
> 1) I know double underscored names are reserved, but __path__ has to be used, because the function __import__ (in  zim.plugins.get_plugin_module) uses __path__ to find a plugin module for import. Rev306 doesn't work for me. I have plugin "jjcms" (directory jjcms with __init__.py and other *.py files) in "~/.local/lib/python2.6/site-packages/zim/plugins/" and Zim rev306 tells me "Failed to load plugin jjcms". (BTW "return mypath" is missing in _check_path()).

OK, that is a consequence I did not foresee. I would have thought
sys.path to be leading for import. Will check python docs and fix it
accordingly.

-- Jaap

[Jaap Karssenberg (jaap.karssenberg)]

Rev 307 should fix usage of __path__ again.

[Jiří Janoušek (fenryxo)]

Everything is OK, thanks.

=== modified file 'tests/plugins.py'
--- tests/plugins.py	2010-07-21 16:25:40 +0000
+++ tests/plugins.py	2010-09-10 13:27:40 +0000
@@ -11,8 +11,8 @@
 
 	def runTest(self):
 		'''Test loading plugins and meta data'''
-
-		plugins = zim.plugins.list_plugins(_path=['.'])
+		plugin_path = [i.path for i in zim.plugins.plugin_dirs(_path=['.'])]
+		plugins = zim.plugins.list_plugins(_path=plugin_path)
 		self.assertTrue(len(plugins) > 0)
 		self.assertTrue('spell' in plugins)
 		self.assertTrue('linkmap' in plugins)

=== modified file 'zim/exporter.py'
--- zim/exporter.py	2010-07-12 21:51:32 +0000
+++ zim/exporter.py	2010-09-10 13:27:40 +0000
@@ -223,7 +223,8 @@
 				path = '../' * uppath.count(':') or './'
 				path += encode_filename(downpath) + self._extension
 			#~ print '>>>', path
-			return url_encode(path)
+			# convert spaces back to underscores
+			return url_encode(path.replace(' ', '_'))
 
 	def file(self, link):
 		if self.document_root_url and link.startswith('/'):

=== modified file 'zim/plugins/__init__.py'
--- zim/plugins/__init__.py	2010-07-21 16:25:40 +0000
+++ zim/plugins/__init__.py	2010-09-10 13:27:40 +0000
@@ -15,6 +15,57 @@
 
 logger = logging.getLogger('zim.plugins')
 
+def user_site_packages():
+	'''
+	In Python 2.6 has been introduced feature "Per-user site-packages Directory"
+	<http://docs.python.org/whatsnew/2.6.html#pep-370-per-user-site-packages-directory>
+	This function backports this feature to Python 2.5.
+	'''
+
+	if sys.version_info[0:2] == (2, 5):
+		if os.name == 'nt':
+			if 'APPDATA' in os.environ:
+				dir = Dir([os.environ['APPDATA'],
+				'Python/Python25/site-packages']).path
+			else:
+				dir = None
+		else:
+			dir = Dir('~/.local/lib/python2.5/site-packages').path;
+
+		if dir and not dir in sys.path: sys.path.append(dir)
+
+
+user_site_packages()
+
+def plugin_dirs(_path=None):
+	'''
+	Generator of possible plugin directories.
+	The _path argument is reserved for testing, it allows to override the
+	search path.
+	'''
+	path = _path or sys.path
+	for dir in path:
+		try:
+			dir = dir.decode(zim.fs.ENCODING)
+		except UnicodeDecodeError:
+			logger.exception('Could not decode path "%s"', dir)
+			continue
+
+		if os.path.basename(dir) == 'zim.exe':
+			# path is an executable, not a folder -- examine containing folder
+			dir = os.path.dirname(dir)
+
+		dir = Dir((dir, 'zim', 'plugins'))
+		if dir.exists(): yield dir
+
+# extend path for importing and searching plugins
+try:
+	for plugin_dir in plugin_dirs():
+		if plugin_dir.path not in __path__:
+			__path__.append(plugin_dir.path)
+except NameError, e:
+	# During test is not __path__ defined?
+	__path__ = [i.path for i in plugin_dirs()]
 
 def get_plugin_module(pluginname):
 	'''Returns the plugin module object for a given name'''
@@ -46,18 +97,14 @@
 	# FIXME how should this work for e.g. for python eggs ??
 	# for windows exe we now package plugins separately
 	plugins = set()
-	path = _path or sys.path
+
+	# We now use __path__ instead of searching "zim/plugin" directories
+	# in sys.path directories. This ensure that found plugins can be
+	# imported.
+	path = _path or __path__
+
 	for dir in path:
-		try:
-			dir = dir.decode(zim.fs.ENCODING)
-		except UnicodeDecodeError:
-			logger.exception('Could not decode path "%s"', dir)
-			continue
-
-		if os.path.basename(dir) == 'zim.exe':
-			# path is an executable, not a folder -- examine containing folder
-			dir = os.path.dirname(dir)
-		dir = Dir((dir, 'zim', 'plugins'))
+		dir = Dir(dir)
 		for candidate in dir.list():
 			if candidate.startswith('_'):
 				continue